什么是ADR?

什么是ADR?

ADR是“Architecture Decision Record(架构决策记录)”的缩写。它是一种用于记录软件系统设计和架构决策的文档或方法。ADR旨在记录团队在开发过程中所做的重要技术决策,以及这些决策背后的考虑因素、理由和影响。

ADR通常包含以下内容:

  1. 标题和标识符:每个ADR有一个唯一的标识符或编号,以及描述性的标题,以便于识别和检索。

  2. 背景和上下文:解释为什么需要做出这个技术决策,涉及到的问题是什么,以及这个决策对系统或项目的重要性。

  3. 决策:明确描述所做的决策,包括采用的具体方法、工具、模式或技术。

  4. 原因:解释为什么选择了这个决策,列出了影响决策的考虑因素、优势和劣势。

  5. 备选方案:记录其他考虑过的方案或选项,并解释为什么最终选择了当前的决策。

  6. 实施:描述决策的具体实施步骤和计划。

  7. 结果和影响:记录决策的实施对系统或项目的预期影响,包括潜在的风险、改进和可能的问题。

ADR的目的在于帮助团队成员更好地理解为何某个决策被做出,并为日后的参考提供依据。它有助于团队避免重复讨论已经作出的决策,促进了团队之间的知识共享和沟通,提高了整体的透明度和决策质量。

https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions