[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [bep] TODO

n高橋です。

WATANABE Takayuki writes:

> 南谷版への追加です。

> *ドキュメント類

これまでのフリーソフト開発経験から自信を持って断言できますが、ドキュメ
ントは非常に大事です。プログラムそのものと同じくらい大事です。またプロ
グラマが自分で全部書くよりも、骨子だけのメモを作り、それを元に別の人が
プログラマにインタビューしながら書き上げた方がいいドキュメントができる
ようです。プログラマに書かせると、自分が苦労したところや工夫したところ
だけをこまごまと記述し、ユーザが本当に知りたい部分は自明としてすっとば
してしまう傾向がありますから。^_^;;

またドキュメントがちゃんと書けているかを検証するため、まだシステムを使っ
たことのない人にそのドキュメントを渡して、本当にそれだけで使えるかどう
かを試した方がいいと思います。

あと、詳しすぎるドキュメント (リファレンスマニュアル) しかないのはだめ
です。リファレンスマニュアルしかないくらいなら、FAQ だけがあった方がま
しです。FAQ に加えて Getting started があれば、かなりの部分をカバーで
きます。それ以上難しい質問になれば数もぐっと減りますから、プログラマが
一つ一つ答えることもできます。

とにかく、利用者を増やすためにはドキュメントが必要です。

-- 
TAKAHASHI Naoto
ntakahas@...
http://www.m17n.org/ntakahas/