架构决策记录(ADR)模板

这是 EdgeX Foundry 的 ADR 模板。

来源:https://docs.edgexfoundry.org/2.3/design/adr/template/

提交者

列出 ADR 的提交者。

格式:

• 姓名(组织)

变更日志

列出对文档的变更,包括状态、日期和 PR URL。

状态为以下之一:待定(pending)、已批准(approved)、已修订(amended)、已弃用(deprecated)。

日期为 ISO 8601(YYYY-MM-DD)字符串。

PR 是提交该变更的拉取请求,包含差异、贡献者和评审者等信息。

格式:

• [ADR 的状态,例如 approved、amended 等](拉取请求的 URL) YYYY-MM-DD

引用的用例

列出所有相关的用例/需求文档。

ADR 至少需要一个相关且已批准的用例。

格式:

• [用例名称](URL)

如果 ADR 没有满足某个用例的全部需求,请补充说明。

背景

描述:

• 该设计在架构上为何重要——值得为其撰写 ADR(而不是仅用一个简单的 issue 和 PR 来解决问题)

• 高层设计思路(详细内容见下文的拟议设计)

拟议设计

设计的详细内容(尽可能不涉及实现)。

概要:

• 将受影响(被更改)的服务/模块

• 将新增的服务/模块

• 模型和 DTO 的影响(更改/新增/移除)

• API 的影响(更改/新增/移除)

• 通用配置的影响(新建章节、更改/新增/移除)

• DevOps 的影响

考量

记录在 ADR 讨论中出现的备选方案、顾虑、附带或相关的问题以及疑问。

说明这些问题是否已解决或缓解,以及如何解决或缓解。

决策

记录任何已达成一致的重要实现细节、注意事项、未来考虑、遗留或推迟的设计问题。

记录拟议设计未能满足的任何需求部分。

其他相关 ADR

列出任何相关的 ADR——例如某个功能的子组件的设计决策、因本设计而被弃用的设计等。

格式:

• [ADR 标题](URL) - 相关性

参考资料

列出其他参考资料。

格式:

• [标题](URL)