作業の進めかた
わからないこと、疑問点がある時は気軽にメーリングリストで質問してください。
- 一般的な注意
- 翻訳の進めかた
- 査読の進めかた
- 日本語版の更新
- 新たな文書の作成
作業には doc-jp-work メーリングリスト
が使われます。その際には以下の点に留意してください。
- メーリングリストに流れた内容は、
一般にも公開されています。
不特定多数に閲覧されると困るようなことはなるべく書かないでください。
- 作業結果は短いものならそのままの形で、長ければ gzip + uuencode して
(ファイルが複数あれば tar + gzip + uuencode して)
メールに添付してください。
- 翻訳の更新などで差分を出すときは、できるだけ (diff -u で作成した)
unified diff の形で出してください。
- 日本語の文字コードは、特に指定がない限り日本語 EUC でお願いします。
ただし、メールにテキストの形で出すときは当然 JIS コードとなります。
- オリジナルの英語版文書の入手
Handbook, FAQ, Articles の場合、最新版は FreeBSD の FTP
サイトから入手できます。それぞれ
Handbook,
FAQ,
Articles
にあります。
CVSweb
のシステムを使って Web 上で英語版オリジナルの更新履歴をみることも
できます。それぞれ
Handbook,
FAQ,
WWW,
Articles
にあります。
- 翻訳するファイルは
基本的にはドキュメントのソースファイルを翻訳します。以下のような
ものがあります。必要なツールのインストール方法については
ここ を見てください。
- .html
- Web ページ記述言語として有名な HTML です。
- .sgml
- SGML 文書です。FreeBSD Documentation Project が提供するドキュメントでは、
DocBook や HTML といった DTD が使われています。
Jade や sgmlnorm などのツールで、他の可読形式に変換されます。
- .xml
- XML 文書です。文書以外にも、さまざまな情報を格納するために使われており、
xsltproc などのツールで処理されます。
ファイルには、翻訳の必要があるものと、
翻訳の必要がないものの両方があります。
詳しくは、doc-jp-work メーリングリストまでお問い合わせください。
- 翻訳上の注意
- 文体は「ですます調」でお願いします。
- ASCII 文字セットにある文字はそれを使ってください。
- いわゆる「半角カナ」や「全角英数字」は使わないでください。
- 句読点は「、」「。」を使ってください
(以前は 1 バイト文字の「,」「.」が利用されていました)。
また、既存の文書の句読点を変換するときは、
次のことを目安に臨機応変に対応してください。
- チェックする人の負担を減らすために、diff には句読点の
変換のみを含めるようにしてください。
- コマンドの出力メッセージ、会社名や単位、英文の参考文献の
タイトルや引用の部分はそのままにしておいてください。
- 英単語区切りには「,」を使ってください。
- 日本語ドキュメントのファイル名は英語ドキュメントと
同じにしてください。英語版と日本語版は別のディレクトリに入れるので
ファイル名で区別する必要はありません。
- SGML や HTML のタグ (不等号 <> で囲まれた部分) の中には
通常訳さずにそのままにしておくべきところがあります。
例えば
<ref id="nutshell" name="FreeBSD in a nutshell">
という文の場合、 id="" の中は訳さずにおいてください。
- 翻訳の管理は基本的に CVS の revision で行なっています。
例えば、ファイルのコメント行に
<!-- $FreeBSD: guide.html,v 1.7 1998/01/03 16:04:13 motoyuki Exp $ -->
というのがあった場合、
1.7 というのがこのファイルの revision です。
この部分を
<!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: 1.7 -->
<!-- $FreeBSD$ -->
と書き換えるようにしてください。ちなみに <!--, -->
で囲まれる部分は HTML や SGML のコメントです。ただし、和文を
更新する場合には書き換える必要はありません。
- $FreeBSD$ 以外の RCS ID 文字列
($Date$など) は、
基本的にはそのままにしてください。
- 翻訳する上で参考になるもの
査読とは翻訳のチェックのことです。
チェックというと難しく考えてしまうかも知れませんが、
自分がわかる範囲・できる範囲で気軽に参加してください。
- メーリングリストに翻訳結果や査読を必要とするファイル名が出ます。
この中から自分が査読するファイルを選んでください。
- 翻訳者以外にできるだけ複数の方で査読を行ないます。
「原文と照らし合わせて綿密にチェック」
「日本語として通るかどうか簡単なチェック」など、
どこまで査読するかは査読者の方にお任せします。
- 査読の結果はメーリングリストに出してください。
- 査読の結果をどう反映するかは基本的に翻訳者の方が決めます。
翻訳者の方は翻訳をどう変更するか決めてメーリングリストで
発表してください。
- 翻訳が終了したドキュメントでも、
英語版にあわせて随時更新していく必要があります。
現在の状況 のページを時々チェックして
日本語版の更新状況をチェックするようにしてください。
- 日本語版の更新は基本的には翻訳した方にお願いしています。
自分の担当したファイルで更新すべきものを見つけたら、
翻訳上の注意 に留意しながら
日本語訳を更新してください。
日本語訳のファイルに
<!-- Original revision: 1.7 -->
というような行がある場合は、
ここの revision の数字を忘れずに変更してください。
$Date$ など他の RCS ID 文字列は元の日本語版ファイルのまま
変更しないでください。
- 元の担当者が多忙などの理由により日本語訳の更新ができない場合も
多々あると思われます。
そうした場合は「その時にできる人、やりたい人」が日本語訳の更新に
どんどん参加してください。
「こんな英語版文書があるけど翻訳したらどうか」
「こういう文書を新しく作成したいけどどうか」というような
新しい提案がある場合は是非メーリングリストに相談してください。
www@jp.FreeBSD.org
Copyright (C) 1997-2004 The FreeBSD Project (Japan).
All rights reserved.
$Date: 2004/09/03 17:35:41 $
