ソフトウエア開発に関連したドキュメンテーション技術についてまとめた、ソフトウエア開発者必携のテキストです。
- 弊社の商品は、書店では扱っておりません。弊社に直接お問合せください。
特徴
ソフトウエア開発は、仕様書や設計書などのドキュメントを作成しながら進めます。適切なドキュメントを作ることで、品質や保守性が向上し、最終的にコスト低減に結びつきます。しかし、今まで、ソフトウエアのドキュメンテーション技術についてはなおざりにされていました。論文の書き方などの教本はありましたが、ソフトウエアドキュメンテーションに関して体系的にまとめた本がありませんでした。 本書は、ソフトウエアドキュメンテーション技術をまとめた初めての本です。
- ソフトウエア開発者を対象としています。
- ソフトウエアドキュメントの種類、役割、内容を各ドキュメントを作成する立場から整理しています。
- 仕様書や設計書の記述項目の例を紹介しています。
- 分かりやすい文章にするためのテクニカルライティングの注意事項も紹介しています。
- ソフトウエア設計者やプログラマーの教育用テキストとしてもお使いいただけます。
詳細情報
形ばかりのドキュメントは不要です。内容の濃い、開発や保守の効率アップにつながるソフトウエアドキュメンテーションをご希望の方は、ぜひお読みください。
| <目次> | |
|---|---|
| 第1章 | 開発用ドキュメントとは |
| 第2章 | 要求仕様書 |
| 第3章 | 外部仕様書 |
| 第4章 | プログラム設計書 |
| 第5章 | プログラム |
| 第6章 | テスト仕様書 |
| 第7章 | テスト報告書 |
| 第8章 | ユーザドキュメントとは |
| 第9章 | ユーザーズガイド |
| 第10章 | リファレンスマニュアル |
| 第11章 | ドキュメンテーションの作法とは |
| 第12章 | 日本語文法 |
| 第13章 | 表現方法 |
| 第14章 | 技術用語 |
| 付録A | 開発用ドキュメンテーションのテンプレート |
| 付録B | 開発用ドキュメンテーションの記述例 |
| 付録C | ユーザドキュメンテーションの記述例 |
| 付録D | データ関連用語(入れ物を示す用語) |



