アーキテクチャディシジョンレコード (ADR)

決定履歴の見える化
Contributed by
Published April 06, 2021
Collection
0

概要

概要

ソフトウェアを設計する際、機能要件や非機能要件に対応する上でアーキテクチャ観点で重要な設計の判断をすることがあります。このアーキテクチャ観点で重要な判断をアーキテクチャディシジョン (Architectural Decision, AD) と呼びます。 例えばJavaかJavaScriptかといった技術の選択であったり、IntelliJかEclipse IDEかといったIDEの選択であったり、SLF4Jjava.util.logging かといったライブラリの選択であったり、Undoを何度実行できるようにしておくかといった機能実装上の判断などです。厳密に「アーキテクチャ」に関する決定と捉えがちですが、それより意味は広く、上記の例に挙げたような、何らかの形でアーキテクチャへの影響の可能性がある決定はアーキテクチャディシジョンと呼びます。 アーキテクチャディシジョンレコードはアーキテクチャディシジョンの履歴を取るために行われます。できるだけ簡単に実施できるべきもので、a) 決定を記録する b) 決定のバージョンを管理する ことができるようにします。

ADRはどのようなフォーマットか

以下にアーキテクチャディシジョンレコードのサンプルを、「アーキテクチャディシジョンレコードをマークダウンで記録することを決定する」シナリオで記述してみます。

# マークダウン形式のアーキテクチャディシジョンレコードを使用する

## コンテキストと課題

このプロジェクトで決定されたアーキテクチャディシジョンを記録することにしたい。
どのようなフォーマットと構造で記録するべきか。

## 検討した選択肢

* [MADR](https://adr.github.io/madr/) 2.1.2 – マークダウンアーキテクチャディシジョンレコード
* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – "ADR" の用語が初めて使われたのはこちら
* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
* その他のテンプレートはこちらにリストされています <https://github.com/joelparkerhenderson/architecture_decision_record>
* 型式の指定なし – ファイルフォーマットや構造の指定なし

## 決定事項

採用した選択肢: "MADR 2.1.2" 理由:

* 暗黙の前提は明確にする必要がある
  設計ドキュメントは後日になっても決定事項を理解できるようにするために重要である
  [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940) も参照のこと。
* MADRのフォーマットは無駄がなく、我々の開発スタイルにあっている
* MADRの構造は理解しやすく、利用やメンテナンスが容易
* MADRプロジェクトは活発である
* 我々がADRを記録し始めた時にバージョン 2.1.2が利用可能な最新である

メリット

このプラクティスを使う理由:

  • 過去に何を実施したかがわかるクイックリファレンスとなる
  • どのような考えに基づいて何をしたのかをステークホルダーと共有できる
  • オープンで透明性の高いコミュニケーションをチーム内外で実現することができる

実施方法

まずは利用可能なテンプレートを読んでみてください。以下のリンクにある既存のテンプレートを使うか、あるいは組織やチームが使いやすいテンプレートを自分で作ることもできます。

参考

アーキテクチャディシジョンレコード (ADR) をチームや顧客、ステークホルダーと実施するにあたりより詳細にお知りになりたい場合は、以下のリンクを参照してください。


Except where noted, content on this site is licensed under a Creative Commons Attribution 4.0 International license. This site is graciously hosted by Netlify