4
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

俺の超おすすめADRテンプレ+使い方+他のADRテンプレ紹介と比較

Posted at

ADR(Architectural Decision Record)のメリット

ADRを導入・活用することで得られるメリットは以下の通りです。

  • 透明性の向上:意思決定プロセスが記録され共有されることで、決定の透明性が高まる。
  • 再現性・継続性の確保:過去の決定を参照することで同様の状況での再評価が迅速に行える。
  • ナレッジ蓄積:決定プロセスが文書化されることで、新メンバー教育やプロジェクトの引継ぎが円滑になる。
  • 責任範囲の明確化:決定に関与した人物が明記され、責任範囲や合意形成プロセスが明確になる。
  • 意思決定品質の向上:複数の選択肢を比較検討し、メリット・デメリットを評価することで意思決定の質が向上する。
  • 情報量は多い: チーム全員がアーキテクトとしてのスキルを成長させるつもりで使ってほしい。LLMにテンプレを渡すがいい感じに作ってるのでそれを叩き台にしてもいい

マイベストADRテンプレ

これにはこんなメリットがある

  • 意思決定プロセスの網羅性:決定要因、複数の選択肢ごとのメリット・デメリット、最終決定の理由が明確に整理され、議論経緯の全体像が一目でわかる。
  • 参加者情報の明示:意思決定に関わったメンバーを明記することで責任所在が明確化され、後続フォローや問い合わせが容易になる。
  • 評価基準の透明性:「決定要因」の項目が設けられ、評価軸が透明になり決定理由が明確になる。

タイトル:【タイトル(解決する問題や解決策を示す名前】
ステータス: [提案中 | 拒否 | 承認 | 廃止 | … | ADR-0005に置き換えなど]
参加者: [決定に関わる全員のリスト]
日付: [最終更新日 YYYY/MM/DD]
技術的な背景: [説明 | チケット/課題のURL]

コンテキストと問題の説明

[コンテキストと問題の説明を2~3行で記述する。問題は質問形式で明確にすることが望ましいかもしれません。]

決定要因

[意思決定するにあたって重要な制約事項や重視する観点を列挙する。]

  • 要因 1, 例えば、直面する問題、懸念事項、…
  • 要因 2, 例えば、直面する問題、懸念事項、…

検討された選択肢

[考慮した選択肢を列挙する。一見馬鹿馬鹿しい案や古い手法も比較対照として記載することが望ましい]

  • 選択肢 1
  • 選択肢 2
  • 選択肢 3

決定内容

選択された選択肢: "【選択肢 1】"

理由: [正当化、例えば、唯一の選択肢、決定要因を満たす唯一の選択肢 | 問題を解決する選択肢 | … | 下記のように最も優れていると考えられる]。

肯定的な影響

[例えば、品質属性の満足度の向上、後続の決定が必要、…]

否定的な影響

[例えば、品質属性の妥協、後続の決定が必要、…]

選択肢の長所と短所

[良い点と悪い点をグループ化せず、関連のある要素を理解しやすい順序で記述し、Good/Badのラベルをつけるイメージで書くと良い]

【選択肢 1】
[例 | 説明 | 詳細情報へのポインター | …]

Good: [理由 a]
Good: [理由 b]
Bad: [理由 c]

【選択肢 2】
[例 | 説明 | 詳細情報へのポインター | …]

Good: [理由 a]
Good: [理由 b]
Bad: [理由 c]

【選択肢 3】
[例 | 説明 | 詳細情報へのポインター | …]

Good: [理由 a]
Good: [理由 b]
Bad: [理由 c]

リンク

[参考にした資料のリンクは全て記載する]

  • タイトル [記事や他のADRへのリンク]

ADRのテンプレはここまで

このADRの使い方の補足

根拠を書く

コンテキストや比較検討、コストと利益の議論を必ず含める。

具体的に書く

一つのADRは一つの決定に限定。複数の決定を混ぜない。

タイムスタンプ

各項目をいつ記載したかを明示(時間で変化する情報を追跡)。

不変性

既存のADRの情報を変更しない。変更があれば新ADRを作成、または追記で対応。

「コンテキスト」セクションのポイント

組織の現状やビジネス上の優先順位を含める。
チームのスキルや特性、状況を反映した検討要素を明確化。
用語を統一し、目的やニーズと結びつけた長所・短所を記述。

「結果」セクションのポイント

決定がもたらす具体的な影響(成果、フォローアップ)を明示。
ADR間の関連性を示し、後続の決定が必要になる場合は明記。
決定後、実際の効果を検証するレビューの機会(例:1ヶ月後レビュー)を設ける。

ADRを置き換える場合の注意点

以前のADRを修正せず、新しいADRを作成して「置き換え」または「廃止」と明記する。

例外事項

以上はケースバイケースで柔軟に運用すること


他の代表的ADRテンプレートの詳細と特徴比較

1. Michael NygardのADRテンプレート

  • 構成要素:タイトル、ステータス、コンテキスト、決定、結果
  • 特徴:シンプルで焦点を絞った記述
  • メリット:書きやすく迅速に作成可能。負担が少なく導入しやすい。背景や結果が明確。
  • デメリット:代替案の比較検討が弱く、情報の網羅性が不十分になる可能性がある。

2. Joel Parker HendersonのシンプルADRスタイル

  • 構成要素:タイトル、ステータス、コンテキスト、決定、結果
  • 特徴:柔軟性が高く、各チームに合わせてカスタマイズ可能
  • メリット:導入が容易で柔軟性が高く、チーム文化に合わせた運用が可能。記述内容の質を高めるための指針が豊富。
  • デメリット:自由度が高いため、書式や情報の網羅性にばらつきが出る可能性がある。

3. adr-toolsによるADRテンプレート

  • 構成要素:タイトル、日付、ステータス、コンテキスト、決定、結果
  • 特徴:CLIツールでの運用が前提、YAML/Markdownベースの記録
  • メリット:ADR作成・管理が自動化されており、作成が容易で一貫性を保ちやすい。履歴管理や整合性維持が効率的。
  • デメリット:標準のテンプレートは非常に簡素であり、詳細な比較や評価は別途記述・カスタマイズが必要になる。

それはみなさんよきADRライフを

4
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?