<h1>GlassFish v3 ドキュメント品質保証</h1>

内容に関する要件

• 修正対象としてコミットされたバグはリリース前に修正されること。リリース後のバグ修正には、開発中に比べて高いコストがかかってしまいます。レビューアには、レビューコメントの提出にバグレポートを使用しないよう依頼してください。
• required （必須）に分類されているトピックは修正対象となる。
• man ページにあるようなコマンドオプションについては完全に説明されていること。
• オプションのデフォルト値について説明されていること。整合性を保つため、オプションについて述べた後でデフォルト値について説明してください。

編集標準

• 文書の作成は、常に Sun style のルールに従って行うこと。
• 代名詞を使う場合は、その内容について事前に言及しておくこと。
• 操作手順は命令形で記述すること。
• 参照情報の大部分は第三者によって書かれたものである。
• 実例はリテラル文字で記述し、プレースホルダーを*使わない*こと。
• 見出しはスタイル・ガイド内のコンテンツ要件、および書式に従って作成すること。
• 活字体規約に従うこと。*特に*コンピュータ用語とプレースホルダーを周囲のテキストから区別することが重要です。
• プレースホルダーは < と > の山括弧ではなく、表記上の規則を使って他の文字と区別すること。

SolBoook のタグ付け

• タスクは task 要素に含まれること。
• 操作手順のうち、ユーザーがタイプする必要のあるものは screen 内の userinput に含まれること。
• スタイルガイドに指示されたとおりの正しいインライン要素が使われていること。

ドキュメントの品質検証

• レビューメンバーと編集者が、スタイルシートに従ってレビューを実施する。
• 執筆者はすべてのピア、あるいは編集者による指摘をドキュメントに反映させること。反映させない場合、なぜそうしないのかをレビューアに説明してください。
• 執筆者は技術面におけるすべての指摘をドキュメントに反映させること。反映させない場合、なぜそうしないのかをレビューアに説明してください。
• 指摘への対応が完了したら、執筆者はそのことをレビューアに伝えること。
• ドキュメントが docs.sun.com^SM^ のサイト上に公開されたら、執筆者はすぐに内容を確認すること。
• 執筆者には要求を順守する責任が課されます。

日本語翻訳: Kana. Kotake

英文 (翻訳したバージョン: 12)