------------------------------------------------------------------------
FreeBSD でのドキュメント整備
============================
今野 元之 (motoyuki@jp.FreeBSD.ORG)
1. はじめに
============
ちょっと前までは FreeBSD の日本語ドキュメントは皆無に近く、ユーザは
*BSD の解説本などを参考にしつつ英語のドキュメントやソースを参照しながら
FreeBSD を使用していたのが実情だった。そのような状態を嘆いたユーザ有志が
ドキュメント翻訳を始めたのが 1996 年の 2 月、以後 FreeBSD の日本語ドキュ
メントは順調に整備されてきている。
2. FreeBSD のドキュメントの現状
================================
FreeBSD の日本語ドキュメントの作業は作業用メーリングリスト (以下 ML と
略す) で行なわれている。まずはこの ML ごとに現在までの経緯を簡単に説明し
たい。
a) jpman プロジェクト
----------------------
FreeBSD のオンラインマニュアル (/usr/share/man/ 以下にあるもの) を翻訳
するプロジェクト。 1996 年 3 月に作業を開始し、現在はセクション 1, 8 の
翻訳を完了してセクション 6, 7 を行なっている。
jpman プロジェクトの成果物は現在 FreeBSD の本家の配布物の中に含まれて
いて ports / packages の形でインストール可能である。
b) FreeBSD 日本語ドキュメンテーションプロジェクト (doc-jp)
-----------------------------------------------------------
FreeBSD の公式ドキュメンテーションの翻訳を行なうプロジェクト。 1996 年
の 2 月に作業を開始し、現在までに
o FreeBSD ハンドブック
o FreeBSD FAQ
o FreeBSD WWW ページ
の翻訳を終えてこれらの保守を行なっている。これらは全て FreeBSD の本家の
配布物の中に含まれている。
現在翻訳中のものは
o FreeBSD Tutorials
o FreeBSD NewsLetter
がある。後者は FreeBSD を紹介するパンフレットで、第一版 (英語版のみ) は
Walnut Creekにユーザ登録した人に郵送されたのでご存じの方も多いだろう。ま
もなく発行される第二版の翻訳がほぼ完了し、英語版とほぼ同時に発行されるは
ずである。日本国内ではパシフィック・ハイテックのご厚意で印刷されたものが
PC UNIX 系に強いショップ・書店を中心に配布される予定。
c) FreeBSD QandA プロジェクト
------------------------------
FreeBSD のユーザ層が広がった結果いわゆる「初心者」が FreeBSD のメーリ
ングリスト FreeBSD-users-jp@jp.freebsd.org で同じような質問を繰り返すこ
とを嘆いた東工大の飯島氏が個人的に始めたプロジェクト。 1997 年 10 月に
有志を募集してプロジェクトが始まった。
メーリングリスト (以下 ML と略す) や NetNews でよく繰り返される質問と
その答えをまとめている。現在までのところ日本独自のドキュメント整備として
は唯一のプロジェクト。
当初は FAQ-J という名称だったが doc-jp が行なっている英語版 FAQ の翻訳
との混同を避けるために QandA と変更された。
d) 日本語インストーラのドキュメント翻訳
----------------------------------------
プロジェクトではないが、 FreeBSD の新しいリリースが出る際に日本語イン
ストーラのドキュメントの翻訳が行なわれている。たいていの場合はリリースが
でる毎に FreeBSD-users-jp ML で翻訳を行なう有志が募集されている。
e) LINT の翻訳
---------------
FreeBSD のカーネルのコンフィグレーションファイルの説明である LINT を翻
訳したもの。 doc-jp や jpman プロジェクトで活躍されている岩崎氏が個人的
に翻訳している。
3. ドキュメント作業の実際
==========================
次に FreeBSD でのドキュメント整備の作業について簡単に説明する。
a) 英語版ドキュメントの翻訳 (jpman, doc-jp)
--------------------------------------------
1. 翻訳
基本的には翻訳者が翻訳した後で他のメンバーによってチェックを行なうよ
うにしている。翻訳上のミスはかなり少なくなっているように思える。
翻訳にあたっては英語版の大元のソースファイルを翻訳するようにしている。
jpman の場合はマニュアルのソースである roff 形式、 doc-jp で翻訳している
ハンドブック, FAQ, WWW の場合は SGML のソースファイルを翻訳している。こ
れらのソースファイルから各種ツールを用いて実際に表示されるものが生成され
るのである。ツール (jpman では groff、 doc-jp では sgmlformat, jade) の
都合上、文字コードには現在のところ日本語 EUC が使われている。
FreeBSD では全てのファイルがアメリカの freefall というマシンにある CVS
リポジトリで集中的に管理されている。 jpman と doc-jp の成果物は FreeBSD
の本家の配布物の中に入っているので、翻訳されたファイルはこの CVS リポジ
トリに commit される。
2. 翻訳管理
英語版は FreeBSD の開発の進展にともなってかなり頻繁に更新されている。
日本語版を英語版に同期させる作業はけっこう大変である。
jpman ではまとめ役をしている堀川氏が定期的に更新状況を把握して作業用
ML に投稿されている。
doc-jp では英語版と日本語版がともに CVS で管理されていることを利用して
管理用スクリプトを作成し doc-jp の WWW ページで公開している。
b) QandA プロジェクト
----------------------
QandA では広く一般から「よくある質問とその答え」を募集している。投稿さ
れたものを QandA に登録するまでの作業を QandA プロジェクトのメンバーが分
担して行なっている。作業は次のように行なわれている。
1. 査読
メンバーの一人が「自分が査読する」と立候補して査読を行なう。で
きれば技術的にチェックすることが望ましいのだが、現状ではチェック
しきれないものも多いため、なかなか査読されないものについては「日
本語として読みやすいか」レベルのチェックに終わることもある。査読
結果は作業用 ML に投稿される。
2. 承認
査読内容を他のメンバーがチェックし必要に応じて修正を行なう。内
容が適切ならば承認のメールを投稿する。査読結果のメールが投稿され
てから 48 時間以内に異議がでなかった場合は承認とみなすようにして
いる。
3. 登録
登録担当の龍池氏が登録作業を行なう。
4. ドキュメント整備での問題点
==============================
a) メンバーの不足
------------------
FreeBSD 関連のドキュメント整備プロジェクトはどこもメンバー不足に悩んで
いる。ある時点でアクティブに活動されている方は各プロジェクトとも十人以下
ではないか、というのが実感である。おまけに複数のプロジェクトに重複して参
加されている方も多い。
もっと多くの方が気軽に参加して欲しい。ちょっとした暇な時間に小さいファ
イル一つを翻訳したり、 QandA の査読を一つ行なっていただけるだけで OK な
のである。ボランティアベースの作業なので、多くの方が少しずつ協力しあって
いくのが理想であろう。
b) 特定メンバーへの依存
------------------------
とりまとめを担当されている方にはかなりの負担がかかっているのが実情であ
る。数人で共同管理を行なうような体制を作って一人あたりの負担を軽減すると
ともに、あるメンバーが仕事の都合で突然作業ができなくなっても他のメンバー
で肩代わりできるようにしておくのが重要である。
c) ドキュメントの質の向上
--------------------------
複数のメンバーで共同作業しているため、ドキュメントの文体や用語に統一が
とれていない面がある。用語表やガイドラインを整備してできるだけ統一してい
く必要があるだろう。
FreeBSD の開発は急速に進んでいるため、ドキュメントの内容を定期的にチェ
ックしていくのも重要である。特に日本独自に整備している QandA では QandA
のメンバーが自分でチェックを行なう必要がある。このチェックについてはまだ
試行錯誤の段階であり、まだまだ機能していない。
d) 新プロジェクト (bookshelf-jp)
---------------------------------
FreeBSD 関係のプロジェクトが管理しているもの以外にも Internet 上には数
多くの日本語ドキュメントが存在している。これらはあちこちに分散しているた
め、特に初心者の方々にはその存在すら知られていないと思われる。
一方、「こういうドキュメントを翻訳したので FreeBSD プロジェクトに寄付
したいのですが」という声が時々聞かれるようになってきた。 FreeBSD の既存
のドキュメント整備プロジェクトでは、主にメンバーの人数的な制約のために寄
付されたドキュメントまで管理できるだけの余裕がない。
これらのドキュメントを収集するだけのプロジェクトを立ち上げようという意
見がでてきた。現在、作業用の ML (bookshelf-jp@jp.freebsd.org) を立ち上げ
て運営方針の検討を行なっている段階である。
e) 本家へのフィードバック
--------------------------
FreeBSD がサーバー目的だけでなく一般のユーザにも広く使われているという
面では、日本は FreeBSD 界では世界一かもしれない。この日本での成果を本家
にフィードバックしていくことも重要になってくる。
事実、日本のドキュメンテーション整備に触発されてスペイン語圏や韓国でも
ドキュメント翻訳を進める動きが出始めている。
f) 書籍化による問題
--------------------
昨年暮れに FreeBSD ハンドブックがアスキーによって出版された。最新版が
Internet 上で容易に入手できるとはいえ、書籍版にはそれなりの利点があり協
力してくれる出版社があれば書籍化をしていくだけの価値がある。
書籍化に伴って様々な問題が生じてきている。
1. フリーに再配布可能なテキストを出版することによる問題。
2. 書籍化に伴う編集結果をどう反映させるか。
3. 出版にともなう作業。
5. さいごに
============
FreeBSD のユーザ数は急速に増えてきているようである。特にいわゆる初心者
の裾野部分がかなり拡大してきているように思える。 FreeBSD における日本語
ドキュメントの整備がこれらユーザ層の拡大に大きく寄与してきたことは間違い
ない。
一人でも多くの方がプロジェクトに協力してくださり、これら日本語ドキュメ
ントの整備がさらに進むことを願いたい。
------------------------------------------------------------------------