架構決策記錄（ADR）範本

呢個係 EdgeX Foundry ADR 嘅範本。

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

提交者

列出 ADR 嘅提交者。

格式：

• 姓名（組織）

變更日誌

列出文件嘅變更，包括狀態、日期同 PR 網址。

狀態係以下其中一個：pending（待處理）、approved（已批准）、amended（已修訂）、deprecated（已棄用）。

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

PR 係提交該變更嘅 pull request，包含差異、貢獻者同審閱者等資料。

格式：

• [Status of ADR e.g. approved, amended, etc.](URL of pull request) YYYY-MM-DD

引用嘅用例

列出所有相關嘅用例／需求文件。

ADR 需要至少一個相關而且已獲批准嘅用例。

格式：

• [Use Case Name](URL)

如果 ADR 冇處理某個用例嘅所有需求，請加上解釋。

背景

描述：

• 呢個設計喺架構上點樣具重大意義，值得寫 ADR（而唔係簡單用 issue 同 PR 去修正問題）

• 高層次嘅設計做法（細節喺下面嘅建議設計入面描述）

建議設計

設計嘅細節（盡量唔好深入到實施層面）。

大綱：

• 會受影響（有更改）嘅服務／模組

• 要新增嘅服務／模組

• 對模型同 DTO 嘅影響（更改／新增／刪除）

• 對 API 嘅影響（更改／新增／刪除）

• 對一般配置嘅影響（建立新區段、更改／新增／刪除）

• 對 devops 嘅影響

考慮事項

記錄喺 ADR 討論中出現嘅其他方案、疑慮、附帶或者相關問題同疑問。

說明佢哋有冇解決或者緩和，以及點樣解決或者緩和。

決策

記錄任何已達成共識嘅重要實施細節、注意事項、日後考慮、剩餘或者押後嘅設計問題。

記錄建議設計未能滿足嘅任何需求部分。

其他相關 ADR

列出任何相關嘅 ADR，例如某個功能嘅子組件嘅設計決策、因呢個設計而棄用嘅設計等等。

格式：

• [ADR Title](URL) - 相關性

參考資料

列出其他參考資料。

格式：

• [Title](URL)