Architecture Decision Record

Active theme: Light

← 文件

寫好 ADR 嘅建議

好 ADR 嘅特點:

  • 理據:解釋做呢個 AD 嘅原因。可以包括背景(見下文)、各個潛在選擇嘅利弊、功能比較、成本效益討論等等。

  • 具體:每份 ADR 應該只講一個 AD,唔好同時講多個 AD。

  • 時間戳記:標明 ADR 入面每個項目係幾時寫嘅。對於可能隨時間改變嘅方面,例如成本、時間表、擴展等等,呢點尤其重要。

  • 不可更改:唔好改動 ADR 入面現有嘅資料。要補充新資料就修訂 ADR,要取代就另外建立一份新 ADR。

ADR 入面好嘅「背景」部分嘅特點:

  • 說明你組織嘅處境同業務優先次序。

  • 包括基於團隊嘅社交同技能組合所作出嘅理據同考慮。

  • 包括相關嘅利弊,並且用配合你需要同目標嘅方式去描述。

ADR 入面好嘅「後果」部分嘅特點:

  • 說明做咗決策之後會有咩跟進。可以包括影響、結果、產出、跟進工作等等。

  • 包括任何後續 ADR 嘅資料。一份 ADR 觸發需要更多 ADR 係相當普遍嘅,例如一份 ADR 作出咗重大嘅整體選擇,繼而衍生出更多較細嘅決策需求。

  • 包括任何事後檢討流程。團隊通常會喺一個月後檢討每份 ADR,將 ADR 嘅資料同實際情況比較,從而學習同進步。

新 ADR 可以取代之前嘅 ADR:

  • 如果作出嘅 AD 取代或者令之前嘅 ADR 失效,就應該建立新 ADR