架構決策記錄(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)