Design Doc
作成日時:2025-07-22
更新日時:2025-07-22
- 何を何のために、どのように作るか。
- システム開発をするにあたっての、大まかな概要。
- 詳細な情報はソースとか設計書を見ろというスタンス
- テンプレート/フォーマット/内容は自由。
- BOSCARとADRを含んでもよろし
フォーマット案
とりあえず自分が書くのならば、下記の感じ。
減らしても、増やしてもよい。
- システム名称
- 目的(Objective)
- 背景(Background)
- やるやら(Scope)
- 制約条件(Constraint)
- 前提条件(Assumption)
- 成果物(Report)
- システム構成図
- ADRまたは代替案を提示し、何故そうしなかったかを記載
- 言語とか技術とか
- 各サブシステムの説明
- ドメイン的な話
- 用語集
- 特殊なフロー
- ゴール条件(終了条件)
- マイルストーン
- 参考文献
- 変更履歴