ドキュメントを公開するまでのプロセス
ja.netbeans.org/docs にドキュメントを公開するまでのプロセスについて説明します。
はじめに
ja プロジェクトのメンバーが、技術情報に関するページの作成もしくは既存の英語ページの翻訳を行った場合には、以下のステップで公開します。
- メーリングリストで作業開始の連絡
- ドキュメントの作成
- できあがった原稿をファイル共有エリアにアップロード
- レビュー
- ドキュメントツリーへのコミット
以下、それぞれのステップについて説明していきます。
メーリングリストで作業開始の連絡
翻訳しようとしているドキュメント、もしくは作成しようとしているドキュメントについてプロジェクトのメーリングリスト (
dev@ja.netbeans.org
) に連絡をしてください。目的は、他のメンバーとの作業と重なってしまわないようにすることです。もし、記述しようとしている内容が重なってしまうようでしたら、それぞれのメンバーで調整していただくことになりますが、プロジェクトオーナーが最終的に調整することもあります。
ドキュメントの作成
ドキュメントを作成する際には以下のページを必ず参照するようにしてください。
原稿をファイル共有エリアにアップロード
他のメンバーによるレビューのために、原稿をファイル共有エリアにアップロードした後にメーリングリスト (
dev@ja.netbeans.org
) に連絡してください。アップロードしたファイルが見えるようになるためにはプロジェクトオーナーの承認が必要ですので、連絡くださればプロジェクトオーナーが承認処理を行います。この時点で承認しないことはまずありません。
プロジェクトオーナーは、ファイル共有エリアにアップロードされたドキュメントを レビュー中のドキュメント ページに追加してレビュー期日を明記します。
レビュー
ja プロジェクトのメンバーによりドキュメントのレビューを行います。気づいた点や付け加えた方が良い点などについて、メーリングリスト (
dev@ja.netbeans.org
) 宛にコメントをください。
寄せていただいたコメントは寄稿者によってドキュメントに反映されます。また、コメントを反映させるか否かの最終的な判断は寄稿者によって行われるものとさせてください。
レビュー期間は 1 週間です。寄稿者もしくは他のメンバーが希望する場合には、レビュー期間をそれより長く設ける場合がありますが、特に断りの無い限り一週間となります。また一週間よりも短くすることはありません。
ドキュメントツリーへのコミット
メーリングリストで特に議論がない限りは、レビュー結果が反映されたドキュメントは公開されます。またレビュー期間中に何もコメントが無かった場合には、ドキュメントは寄稿者が修正しない限り当初の原稿のまま公開されます。
寄稿者が Developer ロールを持っている場合には、レビュー期間がすぎた時点で寄稿者自身がドキュメントツリーへコミットしてください。寄稿者が Observer ロールを持っている場合には、プロジェクトオーナーがドキュメントツリーにコミットします。プロジェクトオーナーがドキュメントをコミットする場合には、寄稿者の知らない間にコミットされてしまうことを防ぐために、プロジェクトオーナーがメーリングリストを通して確認させていただきますので、寄稿者はコミットして良いかどうかプロジェクトオーナーに返信してください。
