アイディアを思いついて、作成する前に記述する。
何も知らない人が見ても概観がわかる物。
- background
- そのシステムを作成する背景や目的
なぜそのシステムを作るの?どうやって作るの?
- architecture
- 設計思想、コードを読んでもわからない「思い」を書く
- member
- そのプロジェクトに関わる人
- security
- どんなセキュリティの脅威があるの?
プライバシーに関する方針は?
- monitoring
- システムが停止した時にどうやって感知する?
ダウンタイムを減らす為の考慮は?
どうやってテストする?
- repository
- コードはどこのリポジトリにあるの?
- server
- どのサーバで開発する?テストする?本番運用する?
- authentication
- システムの作成に必要な認証は?(開発サーバのアカウントとか)