w3m ドキュメント整備の方針
Yoshinobu Sakane February 15, 2001

#
1. 方針

w3mに関するドキュメント類を以下の方針で整備したいと考えています。

- 現時点(w3m-0.1.11-pre)で散文しているドキュメントを一定のルールのもとにまとめる
- 入門程度のドキュメントと深みにはめる:-)ためのドキュメントを用意する
- HTML版とプレインテキスト版を用意する。ただし、ソースとなるドキュメントは一つ

#
2. 骨組みドキュメントの説明

《コンテンツ》
w3mdoc.pl | 坂本さんご謹製のperlスクリプト
mkdocs | ドキュメント整形用シェルスクリプト
README.html | このファイル
*.html.in | 各章／節毎のドキュメントソース
*.wd | 各種定義ファイル

w3mdoc.plの使い方については、坂本さんが書かれたREADME、及び、サンプルソースを参照してください。

#
3. ドキュメント整備の進め方

- 有志(以降、w3m-docメンバと記す)による分割作業
- 分割の単位はw3m-docメンバ間で調整
- 今回示す骨組みはあくまで指針。状況／都合によりw3m-docメンバ間で調整し変更する
- まずは日本語版のドキュメントを作り、状況を見て英訳する
- ある程度できたところから、逐次、w3m-dev MLメンバのレビューを受ける

と、考えています。