 |
 |
|
Gentoo Linux Documentation Policy 1. イントロダクション Gentoo Linux ドキュメンテーションチームは、エンドユーザーにとってすぐさま明瞭で簡潔な非常に専門的なドキュメンテーションを作ることを願っています。この目的を達成するため、私たちの Web サイトなどで発表する前に全てのドキュメンテーションに対して適用しなくてはいけない、ある特別なルールとガイドラインを定めました。 このポリシーは次のトピックをカバーしています：
先に進める前に、全てのドキュメンテーション作成者は[email protected]メーリングリストにに参加する必要があります。そして#gentoo-doc(訳注：IRCチャンネルです)にすぐに参加できます。 加えて、ドキュメンテーションチームの義務と責任の概略を説明するために、ある機能上の取り決めが必要になります。 オフィシャル Gentoo Linux ドキュメンテーションとはエンドユーザーのために Gentoo Linux からリリースされるあらゆるドキュメントというように定義されます。例外は Gentoo WeeklyNewsletter とgentoo.org Webサイトです。これらは各チームによりメンテナンスされています。 Gentoo Linux ドキュメンテーションは二つのカテゴリーに分けられます。一つは critical 、もう一つは non-critical です。 critical ドキュメンテーションはインストール作業やGentoo Linux システムの基本構成に直接関係するものです。現在のところ、critical ドキュメントは以下の通りです:
non-critical ドキュメンテーションは critical ドキュ メンテーション以外のものすべてを含みます。 2. ドキュメンテーションチーム編成 Gentoo Linux ドキュメンテーションチームは3つの小チームに分かれ、それぞれが互いに協力しあいます。ドキュメンテーションチームは次のようなカテゴリーに分けられます。テクニカルライター:は Gentoo Linux の様々な面をきちんと文書化することがテクニカルライターの作業です。ライターは定期的にシニアデベロッパーからアサインされます。そして、これらのアサインは他の Gentoo Linux 開発作業よりも優先されます。ライターは自身の作業内容を [email protected]メーリングリストと編集チームに投稿するまえに当然ながら確認しますが、ドキュメントは最終的にはEditing Teamにより検証されます。テクニカルライターは全員[email protected]メーリングリストに参加しなければなりません。 編集者/査読者: 編集者は Gentoo Linux ドキュメンテーションへの全ての変更と査読を担当します。 編集者により文法的、構文的に正しいと確認されないと変更はできません。編集者はウェブサイトに置かれる予定のすべてのドキュメンテーションが絶対に専門的かつ文法的に正しいことを確認しなければいけません。編集者は全員 [email protected]メーリングリストに参加する必要があります。 翻訳者: 翻訳の特別な性質のため、翻訳者はそれぞれのチームに分かれます。各言語には編集者兼 CVS コミット権をもつ翻訳リーダーがいます。一旦、翻訳リーダーが翻訳完了と判断したならば、ドキュメンテーションインデックスページに掲載します。翻訳を掲載したあとに、その旨を[email protected] に連絡しなければいけません。 3. 英語版作成者ガイドライン すべての翻訳物が私たちの英語版を基にしているため、英語版の作成者の任務は非常に重要です。そのため、以下にあるプロセスを形式的に守ることがどうしても必要です。 もし、まだ下記のドキュメントを読まれていないときは、先に目を通してください。 Gentoo Linux ドキュメンテーションプロセスはいくつかに分かれます: 新しいドキュメントか既存ドキュメントの更新をする最初のステップは bugzillaに登録することです。これにより、同様の作業をしている他の開発者やユーザーに知らせることができます。もし、すでにドキュメンテーションへの更新申請がバグとしてデータベースの中にある場合は、登録する必要はありません。新しいドキュメント提案か更新提案が完了したら次の選択肢は二つあります: もし、更新/バグフィクスが技術的な内容であった場合は、改訂したドキュメントを関連するバグナンバーと共にテクニカルレビューのため [email protected] メーリングリストに投稿しなくてはいけません。ドキュメントの技術的な正確さのために、このステップはものすごく大切です。レビューが完了せず、ドキュメントが議論されている間は CVS へコミットされません。 もし、更新/バグフィクスが文法や構文上のものであれば、[email protected]宛への修正と該当のバグ番号が明記された短いメモだけで十分です。 ドキュメントが CVS におかれるとシニアデベロッパーに知らされ、ドキュメントは現在のドキュメントインデックスページに載せられます。 4. 翻訳者ガイドライン 翻訳者も英語版の作成者の QA プロセスに従うことになるでしょうが、次の例外があります: それぞれの言語にはオフィシャル Gentoo Linux 翻訳者を代表とした翻訳チームがおかれることになるでしょう。すべての翻訳物はこのリーダーを通すことになります。翻訳者のリーダーは翻訳されたドキュメントが文法的、構文的に正しいことを確認します。リーダーは適宜、ドキュメントを CVS にコミットできる限定的な権限を持つことになるでしょう。 もし、まだ下記のドキュメントを読まれていないときは、先に目を通してください。 翻訳者の QA プロセスは次のようになります: 新しいドキュメントか既存ドキュメントの更新をする最初のステップは bugzillaに登録することです。これにより、同様の作業をしている他の開発者やユーザーに知らせることができます。もし、すでにドキュメンテーションへの更新申請がバグとしてデータベースの中にある場合は、登録する必要はありません。新しいドキュメント提案か更新提案が完了したら翻訳のリーダーに連絡がいきます。リーダーは積極的に翻訳物を完全なものにする手配をしなくてはなりません。 ドキュメントもしくは更新が翻訳リーダーにより慎重に編集されたならば CVS へ移動させることが可能になります。 ドキュメントが CVS におかれたならばシニアデベロッパーに知らされ、ドキュメントは現在のドキュメントインデックスページに載せられます。 5. ドキュメンテーションコンタクトリスト もし、なにか疑問があれば、適任者へ相談してください。
|
|
