決定記録(ADR)とは
本プロジェクトでは、あとから覆すとコストが大きい意思決定を ADR(Architecture Decision Record) として記録し、このセクションで公開します。
なぜ公開するのか
Section titled “なぜ公開するのか”- 決定の「なぜ」を残すことで、あとから参加した人が経緯を追える
- 決定に至る検討過程そのものが、本プロジェクトの成果物(プロセス検討の実例)になる
- 公開しておけば、Issue や Discussion で決定自体への異議・再検討の提案を受けられる
- 対象は「あとから変えにくい決定」: 技術選定、ライセンス、調査・表現の方針、プロセス上の原則など
- 起票のタイミングは決定の直後。決定前の検討は Issue / research メモで行う
- ステータスは「採用 / 廃止 / 置き換え(→ 後継 ADR へリンク)」の3種
- 一度採用した ADR の本文は書き換えない。決定を変えるときは新しい ADR で置き換える
テンプレート
Section titled “テンプレート”---title: "ADR-NNNN: 決定の要約(動詞で終わる短文)"description: 1文の説明sidebar: order: NNNN---
## ステータス
採用(YYYY-MM-DD)
## コンテキスト
<!-- どんな課題・制約があったか。なぜ今決める必要があったか -->
## 決定
<!-- 何をどうすると決めたか。明確に -->
## 検討した選択肢
<!-- 採らなかった案と、採らなかった理由 -->
## 影響
<!-- この決定で何が変わるか。トレードオフ・リスクも正直に -->