架构决策记录（ADR）模板

迭是 EdgeX Foundry ADR 个模板。

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

提交者

列出 ADR 个提交者。

格式：

• 姓名（组织）

变更日志

列出文件个变更，包括状态、日期搭 PR 个 URL。

状态是下底之一：待定、已批准、已修订、已弃用。

日期是 ISO 8601（YYYY-MM-DD）字符串。

PR 是提交迭个变更个 pull request，里向有差异、贡献者搭评审者等信息。

格式：

• [ADR 个状态，比方已批准、已修订等等](pull request 个 URL) YYYY-MM-DD

引用个用例

列出所有相关个用例／需求文档。

ADR 起码需要一个相关、已批准个用例。

格式：

• [用例名称](URL)

要是 ADR 勿是处理一个用例个全部需求，加上说明。

背景

描述：

• 迭个设计辣架构上哪能重要，值得写 ADR（而弗是简单个 issue 搭 PR 来修复问题）

• 高层设计办法（细节辣下底建议个设计里描述）

建议个设计

设计个细节（尽可能勿深入实现）。

概要：

• 会受影响（被更改）个服务／模块

• 要新增个服务／模块

• 模型搭 DTO 个影响（更改／新增／删除）

• API 个影响（更改／新增／删除）

• 一般配置个影响（建立新章节、更改／新增／删除）

• devops 个影响

考虑事项

记下备选方案、顾虑、附带或者相关个问题，还有辣 ADR 辩论当中提出个问题。

讲明伊拉有勿有解决或者缓和，哪能解决或者缓和个。

决策

记下任何一致同意个重要实现细节、注意事项、以后个考虑，还有剩下或者推迟个设计问题。

记下建议个设计呒没满足个需求个任何部分。

其他相关个 ADR

列出任何相关个 ADR，比方某个功能个子组件个设计决策、因为迭个设计而被弃用个设计等等。

格式：

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

参考资料

列出其他参考资料。

格式：

• [标题](URL)