FreeBSD 日本語ドキュメンテーションプロジェクトの活動は 専用のメーリングリストであるdoc-jp-work メーリングリストで行われています。
プロジェクトでは以下のような作業を行ってくれる方を募集しています。
英語で作成されている文章を、和訳していく作業です。 すでに和訳された文章よりも新しい英文に関しては、更新等の メンテナンスもします。
単に日本語として通るかどうかの簡単なチェックから、 内容の細かなチェックまでどのレベルでも構いません。 複数の方が査読することによって文書の完成度が 高くなっていくのです。
日本固有のものや、マニュアルが確立されていないものに 関して、あらたに文章を作成していきます。
わたしたちの作業に協力してくださる方がいらっしゃいましたら、 以下の方法で参加してください。
doc-jp の作業はすべてこのメーリングリストで行われます。 関係者との連絡や、のちのち出てくる成果物の提出にもこの メーリングリストを使いますので、参加しましょう。
ドキュメントの同期状況のページで、 翻訳作業待ちのファイルを探します。翻訳作業ができるドキュメントは、 非同期ドキュメント、もしくは和訳が存在しないドキュメントです。 ドキュメントの同期状況の各サマリーの ページに行くと、先頭に作業待ちドキュメント一覧が表示されます。 ここにリストが出てこない場合はすべてのドキュメントが同期している為 翻訳の必要がありません。翻訳の対象は、www,FAQ,handbook,article,books の5つのジャンルになります。
未翻訳ドキュメントを発見できたら、 ドキュメントの同期状況のページから翻訳ドキュメント(日本語のファイルと 差分ファイル、場合によっては英語のファイル)をダウンロードして保存してください。 保存形式はテキスト形式、コートは JIS か EUC で保存してください。 このほかの手段として、CVS を使ってドキュメントを直接 CVS リポジトリから 持ってくる方法もあります。(CVS/CVSup に関してはあえてここでは解説しません。)
一つの未翻訳ドキュメントを複数の人が重複して作業しないよう、 doc-jp-work メーリングリストへ翻訳予約をだします。予約の仕方は、メーリングリストへ 「○○というドキュメントの翻訳を始めます」と書いて送ってください。 翻訳量にもよりますが、多い場合は翻訳できた部分から適度に査読にまわして いくと作業効率がよいでしょう。
実際に翻訳作業をします。翻訳は差分ファイルをみて日本語を修正します。
ファイルにはバージョン管理番号という物があります。
<!-- Original revision: 1.20 -->
上記が管理番号で、この場合英語版の1.20と翻訳ドキュメントの内容が おなじであることを意味します。実際のファイルでは、
<!-- $FreeBSD: join.html,v 1.6 2001/11/15 16:02:18 mori Exp $-->
上記のような行がありますが、こちらのバージョン番号は変えてはいけません。 翻訳する際には最初の <!-- Original revision: 1.20 --> のほうの数値を 変更します。バージョン管理情報はきちんと更新しないと、commit(*1) した後の 情報が間違って出てきてしまいます。(*1:commitについては下記参照)
バージョンを変更し終わったら、実際に翻訳をします。 差分ファイルは、英語版のドキュメントが以前とどう変わったかというのを diff (ファイル比較プログラム) にて算出しています。
差分ファイルの一部が、たとえば、以下のようになっていたとします。
-He name is Mikasa. +He name is Misaki.
この場合、"-"のついている行(つまり "He name is Mikasa.") が いままでの内容で、 "+"のついている行(つまり "He name is Misaki.") が、今回新しく変更された部分です。 日本語の文章が「彼の名前はみかさです。」だった場合は、その行の該当部分を削除し、 「彼の名前はみさきです。」に書き換えればよいのです。なお、翻訳上のルールについては こちらに記載されています。
ここからは UNIX(FreeBSD) のコンソールが使える環境が必要になります。 もし、あなたがコンソールを使って diff を起動できる環境にない場合は、 差分を作らないでメーリングリストに流すこともできますが、あまりお勧め 出来る方法ではありません。大きなファイルの場合はメーリングリストや 配信メールサーバ、作業者に多大な受信時間と負担をかけてしまうからです。 小さなファイルであればかまいませんが、大きい場合はメーリングリストの 他の人に頼むか、lha / tar+gzip 等で圧縮してメールに添付しましょう。
diff を利用できる環境にある人は、翻訳前/後で文字コード(JIS/EUC/Shift-JIS等)が 変わっていないことを確認してから
diff -u (翻訳前文章のファイルの名前) (翻訳後文章のファイルの名前) > sabun.diff
こうして出来た sabun.diff というファイルが日本語版の差分になります。
翻訳が完了したら、doc-jp-work メーリングリストへ差分ファイルを提出します。 提出の方法にはいろいろありますが、MIME マルチパートで 添付する方法と、メールに直接差分ファイルの内容を書き込む方法があります。少量であれば 後者でもかまいません。本文には「○○を翻訳完了しました、査読をおねがいします」等と 書いて送信してください。
ここからは、翻訳者がやることが多くも少なくもない領域です。 査読というのは、翻訳した人以外の人が翻訳後のファイルを読んでみて、ニュアンスの違いや 誤訳等が無いかどうかを確認する作業をいいます。ここで問題があれば、メーリングリストで なにかしらの反応があることでしょう。
commit とは、FreeBSD プロジェクトが管理している FreeBSD のソースツリーに 翻訳後のファイルを反映させる作業のことを言います。 この作業はコミッター (committer) と呼ばれる commit 権限を持ったメンバが行ないますので、自分で行なう必要はありません。 翻訳者は、査読完了後にこの作業が完了するのを 待つことになります。もしも査読終了後1週間ぐらいたっても commit されたという 報告がない場合は、コミッターが忘れているかも知れませんので、 遠慮なくメーリングリストまで報告してください。
以上が主な翻訳手順になります。不明な点は doc-jp-work メーリングリストで聞いてみてください。