実際に書き始めるにあたり、事前にアウトラインを作成してください。 アウトラインを準備しておくと、主題についての明確なイメージを持つことが できるようになりますし、その時々で、HOWTO の細かな部分に集中できます。
極端に短い HOWTO でない限り、アウトラインはおそらく何段階かのレベルに わかれるはずです。階層を持ったアウトラインを作成する場合は、主題に関する 一般的な事柄が最上位に含まれ、サブセクションに特定の詳しい事柄が来るように してください。個々のアウトラインのレベルを個別に眺めて、主題についての主要 領域がすべてカバーされているかどうかを確認してください。サブセクション全体 で、セクションに含まれるべきすべての主要領域がカバーされるようにしてください。
アウトラインの個々の項目は、前の項目を受け、後の項目を導くような 論理関係になるようにしてください。たとえば、特定のプログラムに関する HOWTO の場合、あらかじめインストール のセクションを書かずに、 いきなり設定のセクションを作らないようにしてください。
アウトラインができたら、今度は、それを批判的な目でもう一度眺めてくださ い。すべての関連トピックを適当な詳しさでカバーしているでしょうか？ HOWTO の 射程外のことが書かれていませんか？ それを誰かに見せて、意見を求めるといいかも しれません。書き始めた後よりも、アウトラインの段階の方が自分の HOWTO の全体像 を掴みやすいものです。多くのフィードバックが欲しいときは、アウトラインを ldp-discuss メーリングリストに投稿することも考えてください。
Note: ここで述べようとしているテーマにもう気付いた方もいらっしゃるでしょう。 フリーソフトウェアと同様に、フリードキュメントも、"はやめのリリース、 しょっちゅうリリース (release early, release often)" がベスト です。 ldp-discuss メーリングリストには、LDP 文書作成の経験者が大勢いますから、 HOWTO 作成時に迷うことがあったら、アドバイスを求めるといいかもしれません。
Linus の法則を思い出しましょう。
| --Eric S. Raymond | ||
(Mr. Raymond ごめんなさい。)
FIXME: クレジットやライセンス、コピーライトなどなどのトピックに関する "標準的" なレイアウトを提示すること。
| [1] | 上記 2 つの quotation は、山形浩生さんの翻訳からお借りしました。 |