Design Doc
概要
- プロジェクトの導入資料的な位置付け
・プロジェクトの目的・背景
・おおまかな設計
・依存しているライブラリとバージョン
・考察事項,todo,今後の課題など
項目
- 背景、目的 (Why?)
- 検討した別の方法 (alternatives considered)
- トレードオフ (Why not?: なぜ別の方法にしなかったのか?)
- 設計、アーキテクチャ (How?)
- メンバー (担当者やレビュワー) (Who?)
- セキュリティやプライバシーについての考察など
- 他プロジェクトとの関連性
- テスト,モニタプランなど
参考資料
- 「Design Doc」って何なのか?
- デザインドックで学ぶデザインドック | フライウィール
- デザインドック(Design Doc)について - snowlongの日記
- Googleのデザインドックのマークダウンサンプルらしい
- 残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門:プロジェクト成功確率向上の近道とは?(3)(1/3 ページ) - @IT
- Google の Design Doc について - Please Sleep
- 良いDesign Docs(Software Design Document)を書くためのリソース集
- Design Docs の逡巡- Message Passing