■レンタルサーバご利用参考資料
サーバご利用の参考にJF Project によるJF (Japanese FAQ)を掲載しています。
Linux JF(Japanese FAQ)Project.
JF は, Linux に関する解説文書・FAQ などを作成・収集・配布するプロジェクトです.
グリーンネット・トップページへ戻る
一覧に戻る
JFにおける文書作成の手順
Y. Hiro YAMAZAKI < hiro@linux.or.jp >
v1.1, June 20, 1997
この文書は、JFプロジェクトの文書作成作業で慣用的に使われている構想準備
から公開までの手順を示したものです。JFプロジェクトには組織として強要す
る手順や規則はありません。ここで紹介するのは、効率の良い文書作成を願っ
て自然に確立されてきた典型的手順です。
______________________________________________________________________
目次
1. JFと文書作成活動
2. 文書作成の実際
2.1 下調べ
2.2 構想の発表
2.3 原著者への連絡
2.4 ドラフトの作成
2.5 校正
2.6 正式版の登録
2.7 完成披露
3. この文書
______________________________________________________________________
1. JFと文書作成活動
JFプロジェクトでは、Linuxユーザに役立つ文書の整備をしています。具体的
には、文書の作成および整理・文書整備ツールの開発および維持です。メンバ
ーに必要なのはJFプロジェクトを推進するための具体的な活動をしようとする
意志で、組織としてはこれをサポートするメーリングリストやWebサイト等を
用意しています。実際には、和気合い合いと雑談を交えながら作業をすすめて
います。
具体的な作業としては、各メンバーが自主的な活動を行うのが基本で、組織と
して強要する手順や規則はありません。しかし、効率の良い文書作成のために
使われている慣用的手順があります。この文書ではそれを紹介することにしま
す。
2. 文書作成の実際
JFで作成される文書は、新規文書と翻訳文書に分類できるでしょう。新規文書
はよくある質問と回答集や初心者向けの解説、ワンポイントアドバイス集など
が作られています。翻訳は、実際にはLDPで作成されたHOWTO文書群やフリーの
書籍などの英語の文書を日本語訳する作業が大半です。Linuxカーネル
やLinux関連ソフトウェアに附属の文書の翻訳や補充も行っています。
いずれにせよ基本的な文書作成の手順は同じで、翻訳の場合には原著者との連
絡が加わるだけです。具体的には以下のようになります。
1. 下調べ
2. 構想の発表
3. 原著者への連絡(翻訳の場合)
4. ドラフトの作成
5. 校正
6. 正式版の登録
7. 完成披露
2.1. 下調べ
Linux関連文書はUNIX関連の文書としては豊富とは言え、決して十分とはいえ
ません。そこでJFでは、作業の無駄をなくすために極力分業をする努力をして
います。とくに、翻訳の場合にはなるべく他のメンバーと努力が重複しないよ
うにと翻訳済み文書の一覧が用意されています。新規文書作成の場合にも、ど
のような分野の解説が欠けているのかを考えてから作成にかかるのがよいと思
います。そこで、なるべく既存のJF文書一覧を見るようにしてください。
いずれの場合にも、 JFの文書
からたどると良いでしょう。
2.2. 構想の発表
Linux関連の文書作成の気持ちが強まってきたら、JFメーリングリストのメン
バーになって自分の構想を発表しましょう。JFメーリングリストにはLinuxや
コンピュータネットワークに詳しい人も、翻訳や文書作成に詳しい人も沢山い
ます。基本的にはメンバーが趣味で文書作成をやっているのですが、色々な“
プロ”もいるので、Linux出版に向けての大がかりな文書の相談さえもできる
でしょう。遠慮せずにどんどんと構想を発表してみましょう。
具体的なメールとしては、新規文書作成の場合には、
新しくJFに加わった中谷といいます。
Linux起動のしくみの解説を書いてみようかと思うんだけど、
どう思います？
などとメールすれば良いでしょうし、翻訳の場合には、
低気圧の研究をしている山崎といいます。
Coffee-mini-HOWTOを訳してみようと思うんですけど誰か
やってますか？
というメールを送ってみればよいでしょう。
メンバーの反応は、最低でも1週間程度は様子をみてください。全てのメンバ
ーがメールを毎日読めるわけでもありませんから。
2.3. 原著者への連絡
翻訳の場合には、原著者と連絡して著作権関係の話をつけておきます。ちょっ
と恐そうに聞こえるかも知れませんが、実際にはフリーの文書を書くような著
者は配布を望んでいるものですから、メールを送ると喜んで返事をくれるもの
です。翻訳に問題がないことが原文の著作権声明から明かな場合でも、挨拶の
つもりでメールを送っておきましょう。「日本語は読めないけど、どんな感じ
になるのか興味があるから、完成したら送ってね」という返事が来ることもあ
るようです。
翻訳と配布の許可をもらうためのメールは、簡単でカジュアルなもので問題な
いでしょう。ついでにJFの活動にも触れておくと良いかと思います。例えばこ
んな感じです。
Hi Matt,
How do you do. I am Hiro, a Japanese Linux user. May I translate
your document of Coffee-mini-HOWTO into Japanese, and distribute
it ?
I am a member of "JF project", Japanese documentation/FAQ project
for Linux users. My translation will be made available at our
Web page (http://jf.linux.or.jp/JF/), and at our official ftp site
(ftp://ftp.kuis.kyoto-u.ac.jp/JF/), which is mirrored by SunSite
and others. Please note that it may also be "sold" as a part of
commercial CD-ROMs, or books from various publishers. I will keep
your original copyright notice as it is.
Hoping to hear from you soon.
Happy Linux,
Hiro Yamazaki (hiro@linux.or.jp)
2.4. ドラフトの作成
この段階はあなた次第です。進行状況を報告するのもよし、作業中に出くわし
た分からないことを質問してみるのもよいでしょう。
新規文書作成の場合は、見出しなどの大枠から決めてゆきましょう。全体のバ
ランスを考えながら話題を絞ることも必要です。目次を意識して書くようにす
ると良いでしょう。
翻訳の場合は、なるべく原文を残しながら作業しましょう。普通は原文のファ
イルに日本語を書き込む形で作業を進めます。こうすると訳し忘れなどもなく
なり、読み返した場合にも便利です。
自分が悩んだ場所には、目立つような印を残しておくと良いでしょう。これ
は、次の校正にも役立ちます。
わかりやすく説得・説明するような文書の書き方に興味があれば、以下の２冊
を参考にすると良いと思います。
o 「理科系の作文技術」 木下是雄著 中公新書
o 「日本語の作文技術」 本多勝一著 朝日新聞社(朝日文庫)
2.5. 校正
とりあえずドラフトが出来たら、JFのメーリングリストに送ってみましょう。
メンバーが気楽に読めるように、なるべく圧縮しないテキストファイルのまま
で送りましょう。MIMEの添付ファイルにしても構いませんが、不要なエンコー
ディングをしないように気を付けましょう。復元が面倒な形式であるほど読ん
でくれる人が減ります。誰もが気楽に読めるのは普通のテキストです。
100kバイトを越えるような場合には、適当に分割して送ってください。書籍の
ような巨大な物を送る場合にメールが不適当と考えたら、Web サイトやftpサ
イトに置くのが良いでしょう。JFには非公開文書をメンバーだけに読んでもら
うための非公開作業ディレクトリもあります。このディレクトリに文書を置い
たら、小野さんに個人メールで連絡します。すると、メンバーだけがメールで
取得できるようにする手続きをしてくれます。
具体的に不明な点や質問がある場合には、ドラフトメールの先頭にまとめてお
きます。ドラフト本文が長い場合には質問を別メールにするのも良いでしょ
う。質問などを分けておくと、多くの人がコメントをくれる可能性が高くなり
ます。忙しい人でもメールのサブジェクトや本文の先頭には目を通すことが多
いものです。また、翻訳の場合には原文を残してあると校正者が楽になりま
す。
ドラフトに対するコメントは、10日程度で出そろうのが普通です。もっともド
ラフトをきっかけに話題が盛り上がることもあるので一概には言えません。反
応がなければ「誰か見て〜」という強い要望のメールを送ってもよいですが、
いずれにせよ1週間程度は様子をみてください。
ドラフトに対する意見をどう扱うかは文書作成者が決めることです。その意味
で、校正というよりはコメントやアドバイスをもらうと考えれば良いでしょ
う。この段階でディスカッションになることもよくあります。話題が逸れてい
ない限り積極的に参加しましょう。
2.6. 正式版の登録
自分で満足のゆく文書が出来たら、正式に登録してもらいましょう。具体的に
は正式版であるとすぐ分かるようにして、JFのメーリングリストに送ればOKで
す。例えば、メールのSubjectに
[final] Coffee-mini-HOWTO
として、本文の最初に、
山崎です。とりあえず珈琲のミニHOWTOが出来あがりましたので、
登録をお願いします。なお、コメントは引続き大歓迎です。
などと書いておくと完璧ですね。
最終版の形式は、なるべくSGMLを使うのが良いでしょう。LDPで作成したもの
をJFで日本語化したSGMLツール、「日本語版 Linuxdoc-SGML
」がありますのでこれを使います。その場
合には、LaTeX・roff・プレインテキスト・PostScript の各版が自動作成でき
ます。
ちなみに、形式に係わらず本文中にあなたの名前と連絡先(メールアドレス)を
書くのを忘れないでください。翻訳の場合には原文の著作権表示がそのまま残
されていることも確認してください。
2.7. 完成披露
新しい文書が出来て登録されたら、NetNewsのfj.os.linuxなどでアナウンスす
るのが良いでしょう。あなたの文書を待ちわびている人がいるに違いありませ
ん。
さらに、翻訳の場合には原著者に登録された文書のURLを連絡したり、完成し
た文書を送ってあげたりするのも良いでしょう。紙に打ち出して郵便で送って
も良いですし、日本語フォントを図として埋め込んだ PostScriptファイル
をWebページなどから入手できるように用意しておいて電子メールで連絡して
も良いでしょう。メールで直接送らないのは、日本語を組み込ん
だPostScriptファイルは大きいからです。PostScript ファイルを作る場合に
は、日本語フォントを埋め込むことだけでなく、相手のプリンタに合わせた紙
のサイズを指定することも忘れないようにします。日本やヨーロッパではA4が
使われますが、北米ではA4は使われずLetterサイズです。dvi2psのオプション
などを確認してください。
おつかれさまでした。
3. この文書
この文書の著作権は私こと山崎康宏(hiro@linux.or.jp)にあります。大規模な
再配布の場合には私まで連絡して頂けると嬉しく思いますが、GNU General
Public Licence ver.2 に従う限り利用や再配布をしていただいて構いませ
ん。
この文書の記述に関しての分かりにくい点や誤りの指摘は私宛に連絡してくだ
さい。この文書の内容は、あくまでも現在のJFプロジェクトでの慣例です。よ
りよい手順を思い付いた人はぜひ、JFのメーリングリストで提案してくださ
い。その手順が一般的になればこの文書も更新されるはずです。
一覧に戻る
グリーンネット・トップページへ戻る
|
