プロジェクト文書の書き方

Question

私はちょうど比較的小さなプロジェクト（いくつかのモジュールで〜3000行のコード）を完成させました。プロジェクト用の文書を作成するように求められました。これまで私は他のプログラマーのためのコードを主に書いてきたので、これについてどうやって行くのか分かりません。すべてのモジュールを記述したり、オブジェクトごとにUML図を作成したり、コメントを展開するだけですか？これに使用できるテンプレートはありますか？誰かが標準的な文書を書いていなければならない場合は、私はあなたの助け/ポインタに感謝します。

Answer 1

「標準」ドキュメントの方法はあまりありません。 「Javadoc」スタイルのAPIドキュメントは、あなたが手に入れたものと同じくらい近づいています。より強固な要件を得る。あなたの顧客はどんな種類の文書を必要としていますか？すべてのクラスのUMLダイアグラムはうまくいきますが、時には役立ちますが、将来のプロジェクトに費やす時間が増えることがあります。

Answer 2

最低でも、あなたは

• は、ソフトウェアを構築する方法を
• が、それはファイルやツールの「マニフェスト」は
• リリースノートを参照して必要な
• インストールする方法を文書化する必要がありますから変更するもの以前にリリースされたバージョン
• ライセンスおよび著作権情報

その後

、ソフトウェアの使用方法に応じて、あなたはあなたがDOD-STD-2178Aのデータ項目の説明を見直しより多くのより悪い行うことができ

• ユーザーマニュアル
• APIドキュメント

Answer 3

をお勧めしますソフトウェア設計文書とバージョン記述文書については、

SDDは、ソフトウェアの設計について説明しています。 VDDはパッケージのインストール方法（解凍、コンパイル、ロード、セットアップ）を含むパッケージングを記述します。