OKWAVEのAI「あい」が美容・健康の悩みに最適な回答をご提案!
-PR-
解決
済み

ドキメントの手直し

  • すぐに回答を!
  • 質問No.160596
  • 閲覧数67
  • ありがとう数0
  • 気になる数0
  • 回答数1
  • コメント数0

お礼率 32% (29/90)

最近やっていたプロジェクトのドキメント作成に関わっていたのですが、そのPGを「パッケージ化出来ないか?」といわれ、まずドキメントを手直しするようにと言われました。まずは何から手をつけていけばいいものでしょうか?今のところはまったくわからないので宜しくお願いします。
通報する
  • 回答数1
  • 気になる
    質問をブックマークします。
    マイページでまとめて確認できます。

質問者が選んだベストアンサー

  • 回答No.1
レベル14

ベストアンサー率 50% (1122/2211)

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

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

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

例えば、関数ライブラリみたいなものであれば、ソースを読んだり、テストプログラムを
書いていろいろ動かしてみたりしなくても、どういう条件なら正常に動作し、どういう
場合なら、どのようにエラーを返す、ということがドキュメントだけで分かる、と
いうことが求められます。
-PR-
-PR-
このQ&Aで解決しましたか?
関連するQ&A
-PR-
-PR-
こんな書き方もあるよ!この情報は知ってる?あなたの知識を教えて!
このQ&Aにはまだコメントがありません。
あなたの思ったこと、知っていることをここにコメントしてみましょう。

その他の関連するQ&A、テーマをキーワードで探す

キーワードでQ&A、テーマを検索する
-PR-
-PR-
-PR-

特集


いま みんなが気になるQ&A

関連するQ&A

-PR-

ピックアップ

-PR-
ページ先頭へ