<!doctype linuxdoc system>

<article>

<title>JFにおける文書作成の手順
<author>Y. Hiro YAMAZAKI <tt/&lt hiro@linux.or.jp &gt/
<date>v1.1, June 20, 1997

<abstract> 
この文書は、JFプロジェクトの文書作成作業で慣用的に使われている
構想準備から公開までの手順を示したものです。JFプロジェクトには
組織として強要する手順や規則はありません。ここで紹介するのは、
効率の良い文書作成を願って自然に確立されてきた典型的手順です。
</abstract>

<toc>

<sect>JFと文書作成活動
<p>
JFプロジェクトでは、Linuxユーザに役立つ文書の整備をしています。
具体的には、文書の作成および整理・文書整備ツールの開発および
維持です。メンバーに必要なのはJFプロジェクトを推進するための
具体的な活動をしようとする意志で、組織としてはこれをサポート
するメーリングリストやWebサイト等を用意しています。実際には、
和気合い合いと雑談を交えながら作業をすすめています。

具体的な作業としては、各メンバーが自主的な活動を行うのが基本
で、<em>組織として強要する手順や規則はありません</em>。しかし、
効率の良い文書作成のために使われている慣用的手順があります。
この文書ではそれを紹介することにします。

<sect>文書作成の実際
<p>
JFで作成される文書は、新規文書と翻訳文書に分類できるでしょう。
新規文書はよくある質問と回答集や初心者向けの解説、ワンポイント
アドバイス集などが作られています。翻訳は、実際にはLDPで作成さ
れたHOWTO文書群やフリーの書籍などの英語の文書を日本語訳する作
業が大半です。LinuxカーネルやLinux関連ソフトウェアに附属の文書
の翻訳や補充も行っています。


いずれにせよ基本的な文書作成の手順は同じで、翻訳の場合には原
著者との連絡が加わるだけです。具体的には以下のようになります。
<enum>
        <item> 下調べ
        <item> 構想の発表
        <item> 原著者への連絡(翻訳の場合)
        <item> ドラフトの作成
        <item> 校正
        <item> 正式版の登録
        <item> 完成披露
</enum>

<sect1>下調べ
<p>
Linux関連文書はUNIX関連の文書としては豊富とは言え、決して十分
とはいえません。そこでJFでは、作業の無駄をなくすために極力分業
をする努力をしています。とくに、翻訳の場合にはなるべく他のメン
バーと努力が重複しないようにと翻訳済み文書の一覧が用意されてい
ます。新規文書作成の場合にも、どのような分野の解説が欠けている
のかを考えてから作成にかかるのがよいと思います。そこで、なるべ
く既存のJF文書一覧を見るようにしてください。

いずれの場合にも、
    <url url="http://jf.linux.or.jp/JF/WhatisJF.html"
        name="JFの文書">
からたどると良いでしょう。

<sect1>構想の発表
<p>
Linux関連の文書作成の気持ちが強まってきたら、JFメーリングリスト
のメンバーになって自分の構想を発表しましょう。JFメーリングリス
トにはLinuxやコンピュータネットワークに詳しい人も、翻訳や文書
作成に詳しい人も沢山います。基本的にはメンバーが趣味で文書作成
をやっているのですが、色々な“プロ”もいるので、Linux出版に向
けての大がかりな文書の相談さえもできるでしょう。<em>遠慮せずに
どんどんと構想を発表してみましょう</em>。
<p>

具体的なメールとしては、新規文書作成の場合には、
<tscreen>
<verb>
    新しくJFに加わった中谷といいます。
    Linux起動のしくみの解説を書いてみようかと思うんだけど、
    どう思います？
</verb>
</tscreen>
などとメールすれば良いでしょうし、翻訳の場合には、
<tscreen>
<verb>
    低気圧の研究をしている山崎といいます。
    Coffee-mini-HOWTOを訳してみようと思うんですけど誰か
    やってますか？
</verb>
</tscreen>
というメールを送ってみればよいでしょう。

メンバーの反応は、最低でも1週間程度は様子をみてください。全て
のメンバーがメールを毎日読めるわけでもありませんから。


<sect1>原著者への連絡
<p>
翻訳の場合には、原著者と連絡して著作権関係の話をつけておきます。
ちょっと恐そうに聞こえるかも知れませんが、実際にはフリーの文書
を書くような著者は配布を望んでいるものですから、メールを送ると
喜んで返事をくれるものです。翻訳に問題がないことが原文の著作権
声明から明かな場合でも、挨拶のつもりでメールを送っておきましょ
う。「日本語は読めないけど、どんな感じになるのか興味があるから、
完成したら送ってね」という返事が来ることもあるようです。

翻訳と配布の許可をもらうためのメールは、簡単でカジュアルなもの
で問題ないでしょう。ついでにJFの活動にも触れておくと良いかと思
います。例えばこんな感じです。

<tscreen>
<verb>
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)

</verb>
</tscreen>


<sect1>ドラフトの作成
<p>
この段階はあなた次第です。進行状況を報告するのもよし、作業中に
出くわした分からないことを質問してみるのもよいでしょう。

新規文書作成の場合は、見出しなどの大枠から決めてゆきましょう。
全体のバランスを考えながら話題を絞ることも必要です。目次を意識
して書くようにすると良いでしょう。

翻訳の場合は、なるべく原文を残しながら作業しましょう。普通は原
文のファイルに日本語を書き込む形で作業を進めます。こうすると訳
し忘れなどもなくなり、読み返した場合にも便利です。

自分が悩んだ場所には、目立つような印を残しておくと良いでしょう。
これは、次の校正にも役立ちます。

わかりやすく説得・説明するような文書の書き方に興味があれば、
以下の２冊を参考にすると良いと思います。
<itemize>
     <item>「理科系の作文技術」 木下是雄著 中公新書
     <item>「日本語の作文技術」 本多勝一著 朝日新聞社(朝日文庫)
</itemize>


<sect1>校正
<p>
とりあえずドラフトが出来たら、JFのメーリングリストに送ってみま
しょう。メンバーが気楽に読めるように、なるべく圧縮しないテキス
トファイルのままで送りましょう。MIMEの添付ファイルにしても構い
ませんが、不要なエンコーディングをしないように気を付けましょう。
復元が面倒な形式であるほど読んでくれる人が減ります。誰もが気楽
に読めるのは普通のテキストです。

100kバイトを越えるような場合には、適当に分割して送ってください。
書籍のような巨大な物を送る場合にメールが不適当と考えたら、Web
サイトやftpサイトに置くのが良いでしょう。JFには非公開文書をメ
ンバーだけに読んでもらうための非公開作業ディレクトリもあります。
このディレクトリに文書を置いたら、小野さんに個人メールで連絡し
ます。すると、メンバーだけがメールで取得できるようにする手続き
をしてくれます。

具体的に不明な点や質問がある場合には、ドラフトメールの先頭にま
とめておきます。ドラフト本文が長い場合には質問を別メールにする
のも良いでしょう。質問などを分けておくと、多くの人がコメントを
くれる可能性が高くなります。忙しい人でもメールのサブジェクトや
本文の先頭には目を通すことが多いものです。また、翻訳の場合には
原文を残してあると校正者が楽になります。

ドラフトに対するコメントは、10日程度で出そろうのが普通です。もっ
ともドラフトをきっかけに話題が盛り上がることもあるので一概には
言えません。反応がなければ「誰か見て〜」という強い要望のメール
を送ってもよいですが、いずれにせよ1週間程度は様子をみてください。

ドラフトに対する意見をどう扱うかは文書作成者が決めることです。
その意味で、校正というよりはコメントやアドバイスをもらうと考え
れば良いでしょう。この段階でディスカッションになることもよくあ
ります。話題が逸れていない限り積極的に参加しましょう。

<sect1>正式版の登録
<p>
自分で満足のゆく文書が出来たら、正式に登録してもらいましょう。
具体的には正式版であるとすぐ分かるようにして、JFのメーリング
リストに送ればOKです。例えば、メールのSubjectに
<tscreen>
<verb>
[final] Coffee-mini-HOWTO
</verb>
</tscreen>
として、本文の最初に、
<tscreen>
<verb>
山崎です。とりあえず珈琲のミニHOWTOが出来あがりましたので、
登録をお願いします。なお、コメントは引続き大歓迎です。
</verb>
</tscreen>
などと書いておくと完璧ですね。

最終版の形式は、なるべくSGMLを使うのが良いでしょう。LDPで作成し
たものをJFで日本語化したSGMLツール、
「<url url="http://jf.linux.or.jp/JF/sgml/"
         name="日本語版 Linuxdoc-SGML">」がありますのでこれを使
います。その場合には、LaTeX・roff・プレインテキスト・PostScript
の各版が自動作成できます。

ちなみに、形式に係わらず本文中にあなたの名前と連絡先(メールアド
レス)を書くのを忘れないでください。翻訳の場合には原文の著作権表
示がそのまま残されていることも確認してください。

<sect1>完成披露
<p>
新しい文書が出来て登録されたら、NetNewsのfj.os.linuxなどでアナウ
ンスするのが良いでしょう。あなたの文書を待ちわびている人がいるに
違いありません。

さらに、翻訳の場合には原著者に登録された文書のURLを連絡したり、
完成した文書を送ってあげたりするのも良いでしょう。紙に打ち出して
郵便で送っても良いですし、日本語フォントを図として埋め込んだ
PostScriptファイルをWebページなどから入手できるように用意してお
いて電子メールで連絡しても良いでしょう。メールで直接送らないのは、
日本語を組み込んだPostScriptファイルは大きいからです。PostScript
ファイルを作る場合には、日本語フォントを埋め込むことだけでなく、
相手のプリンタに合わせた紙のサイズを指定することも忘れないように
します。日本やヨーロッパではA4が使われますが、北米ではA4は使われ
ずLetterサイズです。dvi2psのオプションなどを確認してください。

おつかれさまでした。

<sect>この文書
<p>
この文書の著作権は私こと山崎康宏(hiro@linux.or.jp)にあります。
大規模な再配布の場合には私まで連絡して頂けると嬉しく思います
が、GNU General Public Licence ver.2 に従う限り利用や再配布を
していただいて構いません。

この文書の記述に関しての分かりにくい点や誤りの指摘は私宛に連絡
してください。この文書の内容は、あくまでも現在のJFプロジェクト
での慣例です。よりよい手順を思い付いた人はぜひ、JFのメーリング
リストで提案してください。その手順が一般的になればこの文書も更
新されるはずです。
</article>
