Design Docとは

プロジェクト成功確率向上の近道とは？（3）：残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門 (1/3) - ＠IT

http://www.atmarkit.co.jp/ait/articles/1606/21/news016.html

表　Design Docに含み得る項目一覧

	項目名	内容
1	＊タイトル	このソフトウェアの名称
2	＊著者名	このDocを書いた人
3	プロジェクトメンバー	開発に参加するメンバー
4	＊目的	このソフトウェアの目的
5	要求仕様	要求仕様書、機能仕様書などへのリンク（要求仕様の要点を書く場合もある）
6	＊背景	このソフトウェアを開発する背景・経緯など
7	既存のものとの相違点	既存品があるなら、それとの違いを書く
8	関連システム・仕様など	関連システムやその仕様書へのリンク
9	＊ハイレベルアーキテクチャ（アーキテクチャ概要）	システム全体を俯瞰した構成図など
10	＊各パート（モジュール・クラス）の概要	各パートの概要・責務・目的など
11	＊各パート（モジュール・クラス）の内部仕様・処理フローなど	データ構造、アルゴリズムなど
12	各パート（モジュール・クラス）の実装場所	ソース・ファイル名、実行形式の名称など
13	使用例	モジュールの利用例が分かるサンプルコードなど
14	セキュリティ仕様・考慮事項など	想定される問題と、その対処方法などについて
15	既知の問題	事前に判明している問題・課題などを書く
16	＊テスト方案	どういう観点で何をテストすればよいか、どのようにテストすればよいか
17	運用方法	運用時のポイント、監視の方法など
18	参考文献	参考文献へのリンク
19	このDocの格納場所	リポジトリのパス、ファイルサーバのパスなど
20	メモ	設計のヒントや気付いた点、関連情報など何でも
21	変更履歴	このDocについて、いつ・誰が・どのような変更をしたのか履歴を記述