私はちょうど比較的小さなプロジェクト(いくつかのモジュールで〜3000行のコード)を完成させました。プロジェクト用の文書を作成するように求められました。これまで私は他のプログラマーのためのコードを主に書いてきたので、これについてどうやって行くのか分かりません。すべてのモジュールを記述したり、オブジェクトごとにUML図を作成したり、コメントを展開するだけですか?これに使用できるテンプレートはありますか?誰かが標準的な文書を書いていなければならない場合は、私はあなたの助け/ポインタに感謝します。プロジェクト文書の書き方
8
A
答えて
2
「標準」ドキュメントの方法はあまりありません。 「Javadoc」スタイルのAPIドキュメントは、あなたが手に入れたものと同じくらい近づいています。より強固な要件を得る。あなたの顧客はどんな種類の文書を必要としていますか?すべてのクラスのUMLダイアグラムはうまくいきますが、時には役立ちますが、将来のプロジェクトに費やす時間が増えることがあります。
4
最低でも、あなたは
- は、ソフトウェアを構築する方法を
- が、それはファイルやツールの「マニフェスト」は
- リリースノートを参照して必要な
- インストールする方法を文書化する必要がありますから変更するもの以前にリリースされたバージョン
- ライセンスおよび著作権情報
、ソフトウェアの使用方法に応じて、あなたはあなたがDOD-STD-2178Aのデータ項目の説明を見直しより多くのより悪い行うことができ
- ユーザーマニュアル
- APIドキュメント
0
をお勧めしますソフトウェア設計文書とバージョン記述文書については、
SDDは、ソフトウェアの設計について説明しています。 VDDはパッケージのインストール方法(解凍、コンパイル、ロード、セットアップ)を含むパッケージングを記述します。
関連する問題
- 1. $(文書)対$( "文書")
- 2. 文字列の書き込み方向
- 3. Pythonプロジェクトを文書化するには?
- 4. jQueryアンカータグのテキスト書き直しプロジェクト
- 5. Javaプロジェクト(DMS)で文書をアーカイブする方法
- 6. 文書の作成方法
- 7. Word文書を別の文書にコピー
- 8. 処理大きな文書
- 9. 書き込みUnicode文字 -
- 10. 書き込み文字列
- 11. コンセプトを理解するためのプロジェクトの読み書きプロジェクト
- 12. 深い学習でOCRの手書き文書にアプローチする方法は?
- 13. 文書管理アプリケーションで文書の重複や類似した文書のチェック
- 14. IE7のエラー文書への書き込み
- 15. Word文書を含む文書ファイルサイズ
- 16. 文書を文書に挿入する
- 17. 、文書
- 18. プロジェクト構造の辞書
- 19. JavaScriptで文書にテキストフィールドの値を書き込む
- 20. Word文書にフォームのテキストボックス値を書き込めません。
- 21. jQueryの$(文書)
- 22. のCouchDB - 文書
- 23. lwuitのラジオボタンコードの書き方
- 24. テンプレートクラスのコピーコンストラクタの書き方
- 25. Javadocのコメントの書き方
- 26. Cプログラミング - 文字に文字を書き込む方法*
- 27. asp.net箇条書きのリストコントロール - 箇条書きを隠す方法?
- 28. .htaccess 301リダイレクトルールの書き方?
- 29. chiptune musicの書き方は?
- 30. PDFエディタの書き方は?
誰がドキュメントを読んでいますか(つまり、誰がオーディエンスですか)?その目的は何ですか? – bitFlipper