ドキメントの手直し

質問

最近やっていたプロジェクトのドキメント作成に関わっていたのですが、そのPGを「パッケージ化出来ないか？」といわれ、まずドキメントを手直しするようにと言われました。まずは何から手をつけていけばいいものでしょうか？今のところはまったくわからないので宜しくお願いします。

回答No.1

a-kuma · ベストアンサー

どういうプログラムを、どういうパッケージにするのかが良く分からないですが、

・ソースを読まなくても、ドキュメントだけを読めば使える
・ドキュメントを読めば、実際に「もの」を動かさなくても、何をどうすれば良いか分かる

というところが、基本です。

例えば、関数ライブラリみたいなものであれば、ソースを読んだり、テストプログラムを
書いていろいろ動かしてみたりしなくても、どういう条件なら正常に動作し、どういう
場合なら、どのようにエラーを返す、ということがドキュメントだけで分かる、と
いうことが求められます。