Architecture Decision Record
← Otsusekirjete mallid

Arhitektuuriotsuse kirje (ADR) mall

See on EdgeX Foundry ADR-ide mall.

Allikas: https://docs.edgexfoundry.org/2.3/design/adr/template/

Esitajad

Loetle ADR-i esitajad.

Vorming:

  • Nimi (organisatsioon)

Muudatuste logi

Loetle dokumendi muudatused, sealhulgas olek, kuupäev ja pull requesti URL.

Olek on üks järgmistest: pending, approved, amended, deprecated.

Kuupäev on ISO 8601 string (YYYY-MM-DD).

PR on pull request, mis muudatuse esitas, ja sisaldab teavet nagu diffid, kaasautorid ja ülevaatajad.

Vorming:

  • [ADR-i olek, nt approved, amended jne](pull requesti URL) YYYY-MM-DD

Viidatud kasutusjuhud

Loetle kõik asjakohased kasutusjuhtude / nõuete dokumendid.

ADR vajab vähemalt ühte asjakohast ja heakskiidetud kasutusjuhtu.

Vorming:

  • [Kasutusjuhu nimi](URL)

Lisa selgitus, kui ADR ei kata kõiki kasutusjuhu nõudeid.

Kontekst

Kirjelda:

  • Miks disain on arhitektuuriliselt oluline - miks on vaja ADR-i (selle asemel, et probleemi lahendamiseks piisaks lihtsalt issue'st ja PR-ist)

  • Kõrgetasemeline disainilähenemine (üksikasjad tulevad allpool pakutud disainis)

Pakutud disain

Disaini üksikasjad (võimalusel teostusse laskumata).

Ülevaade:

  • Teenused/moodulid, mida mõjutatakse (muudetakse)

  • Uued teenused/moodulid, mis lisatakse

  • Mõju mudelitele ja DTO-dele (muuta/lisada/eemaldada)

  • Mõju API-dele (muuta/lisada/eemaldada)

  • Mõju ühisele seadistusele (uus jaotis, muuta/lisada/eemaldada)

  • Mõju devopsile

Kaalutlused

Dokumenteeri ADR-i arutelus esile tõstetud alternatiivid, mured, kõrvalised või seotud probleemid ja küsimused.

Märgi, kas ja kuidas need on lahendatud või leevendatud.

Otsus

Dokumenteeri kokku lepitud olulised teostuse üksikasjad, hoiatused, tulevased kaalutlused ning allesjäänud või edasilükatud disainiküsimused.

Dokumenteeri nõuete osad, mida pakutud disain ei täida.

Muud seotud ADR-id

Loetle seotud ADR-id, näiteks funktsiooni alamkomponentide disainiotsused, selle disaini tulemusel vananenud disainid jne..

Vorming:

  • [ADR-i pealkiri](URL) - asjakohasus

Viited

Loetle täiendavad viited.

Vorming:

  • [Pealkiri](URL)