软件规划、IT领导力的架构决策记录(ADR)示例

架构决策记录(ADR)是捕获所做的重要架构决策及其上下文和结果的文档。

架构决策记录(ADR)是捕获所做的重要架构决策及其上下文和结果的文档。

架构决策日志(ADL)是为特定项目(或组织)创建和维护的所有ADR的集合。

体系结构上的重要需求(ASR)是对软件系统的体系结构有可度量影响的需求。

本文档的目标是快速概述ADR、如何创建ADR以及在哪里查找更多信息。

它是必须现在就做，还是可以等到更多的信息被知道之后再做呢？

个人和集体经验，以及公认的设计方法和实践，都可以帮助决策识别。

存在许多决策技术，既有通用的，也有特定于软件体系结构的，例如，对话映射。

广告在软件设计中使用；因此，它们必须传达给资助、开发和运营它的系统的利益相关者，并被他们接受。

架构上显而易见的编码风格和关注架构关注点和决策的代码审查是两个相关的实践。

因此，在采用明确的知识管理策略时，过去决策的经验，无论是好的还是坏的，都可能是有价值的可重用资产。

查看传统的软件工程和架构设计流程，例如IBMUMF和CapitalOne的Tyree和Akerman建议的表格布局。

存在许多决策技术，既有通用的，也有软件和软件体系结构特定的，例如对话映射。

如果你喜欢使用Google Drive和在线编辑，那么你可以创建一个Google文档或Google工作表。

如果您喜欢使用源代码版本控制(如GIT)，则可以为每个ADR创建一个文件。

如果您喜欢使用项目计划工具，如Atlassian Jira，那么您可以使用该工具的计划跟踪器。

如果您喜欢使用维基，比如MediaWiki，那么您可以创建一个ADR维基。

如果你喜欢使用git版本控制，那么对于一个典型的带有源代码的软件项目，我们希望开始使用带有git的ADR。

在美国存托凭证上写任何你想要的东西。有关想法，请参阅此存储库中的模板。

如果您选择使用典型的文本文件创建ADR，那么您可能需要制定您自己的ADR文件名约定。

这个名字有一个现在时态的祈使动词短语。这有助于提高可读性，并与我们的提交消息格式相匹配。

名称使用小写和下划线(与此回购相同)。这是可读性和系统可用性之间的平衡。

不可变记录-在以前发布的ADR中做出的决定不应更改。

错误的方法-没有从制作特定广告的"；优点&34；和"；缺点&34；来解释广告

当制作替换或使以前的ADR无效的AD时，应创建新的ADR