Architecture Decision Record

Active theme: Light

← dokumendid

Soovitused heade ADR-ide kirjutamiseks

Hea ADR-i tunnused:

  • Põhjendus: selgita, miks AD-d tehakse. See võib sisaldada konteksti (vt allpool), erinevate võimalike valikute plusse ja miinuseid, funktsioonide võrdlusi, kulu-tulu arutelusid ja nii edasi.

  • Konkreetne: iga ADR peaks käsitlema ühte AD-d, mitte mitut AD-d.

  • Ajatempliga: märgi, millal iga ADR-i kirje kirjutati. See on eriti oluline aspektide puhul, mis võivad aja jooksul muutuda, nagu kulud, ajakava, laiendamine ja nii edasi.

  • Muutumatu: ära muuda ADR-is olemasolevat teavet. Muuda selle asemel ADR-i uue teabe lisamisega või asenda ADR uue ADR-i loomisega.

Hea "Konteksti" jaotise tunnused ADR-is:

  • Kirjeldab organisatsiooni olukorda ja ärilisi prioriteete.

  • Sisaldab põhjendust ja kaalutlusi, mis põhinevad meeskonna sotsiaalsel ja tehnilisel koosseisul.

  • Sisaldab asjakohaseid kompromisse, väljendatuna vajaduste ja eesmärkidega sobivates terminites.

Hea "Tagajärgede" jaotise tunnused ADR-is:

  • Kirjeldab, mis otsuse tegemisest järgneb. See võib sisaldada mõjusid, tulemusi, tulemeid, järeltegevusi ja nii edasi.

  • Sisaldab teavet järgnevate ADR-ide kohta. On suhteliselt tavaline, et üks ADR tekitab vajaduse veel ADR-ide järele. Näiteks kui ADR teeb suure, ülekaaluka valiku, võib see tekitada vajaduse väiksemate otsuste järele.

  • Sisaldab tagantjärele läbivaatuse protsessi. On tavaline, et meeskonnad vaatavad iga ADR-i üle kuu aja pärast, võrdlevad ADR-i teavet sellega, mis tegelikult juhtus, ning õpivad ja arenevad sellest.

Uus ADR võib asendada eelmise ADR-i:

  • Kui tehakse AD, mis asendab või muudab kehtetuks eelmise ADR-i, tuleks kirjutada uus ADR