開発
アーキテクチャ決定記録(ADR)テンプレート
半年後、誰かがなぜシステムがこの形になっているのかを尋ねます。アーキテクチャ決定記録は、それを1〜2ページで答えます。このテンプレートは背景、検討した選択肢、決定事項、その影響、今後の対応、見直しの条件をまとめています。
このテンプレートをエディターで開く- カテゴリー
- 開発
- デフォルトスタイル
- テクニカル
使う場面
データベース、フレームワーク、ホスティング方式、APIの形式など、後から変更しにくい技術的な選択をしたときにADRを書きます。将来の担当者や新しいメンバー、レビュアーはこれを読み、当時どんな制約があったのかを理解します。議論の記憶が新しいうちに書き、提案が進むにつれて状態の行を更新しておきましょう。
含まれる内容
- プロジェクト名、作成者、日付を入力する欄と状態の行を含む、番号付きのADRタイトル。
- 現状維持の行も含めて、利点と費用を比較する選択肢の表。
- 決定事項、良い影響と悪い影響、実施のチェックリスト、見直しの契機。
より良い文書にするヒント
- 決定事項を一文で述べ、最も強い理由をひとつ挙げましょう。理由が5つ必要になる場合、背景の項目がまだ足りていない可能性があります。
- 悪い影響については率直に書きましょう。図で説明したほうが伝わる変更があれば、Mermaidのブロックを追加すればPDFにもそのまま表示されます。
テンプレートのプレビュー
ADR-001: プロジェクトまたはテーマ
作成者: お名前 · 日付: 日付
状態: 提案中
背景
この決定を形作る問題、制約、要因を説明してください。
検討した選択肢
| 選択肢 | メリット | コスト |
|---|---|---|
| 選択肢A | 主な利点 | 主なトレードオフ |
| 選択肢B | 主な利点 | 主なトレードオフ |
| 現状維持 | 移行不要 | 既存の制約 |
決定
採用するアプローチと、選んだ最も重要な理由を記載してください。
影響
プラス面: 何が容易になるか。
マイナス面: 何が難しく、あるいは高コストになるか。
実装
- 担当者を割り当てる
- 移行とロールバックを計画する
- ドキュメントを更新する
再検討のきっかけ
この決定を見直す根拠となる証拠や変化を明記してください。
氏名や日付などの入力欄は、エディターでテンプレートを開くと置き換えられます。