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

このQ&Aに関連する最新のQ&A

A 回答 (1件)

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



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

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

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

お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!


人気Q&Aランキング