Architecture Decision Record
← Lēmuma ierakstu veidnes

Arhitektūras lēmuma ieraksta (ADR) veidne

Šī ir EdgeX Foundry ADR veidne.

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

Iesniedzēji

Norādiet ADR iesniedzējus.

Formāts:

  • Vārds (organizācija)

Izmaiņu žurnāls

Norādiet dokumenta izmaiņas, tostarp stāvokli, datumu un izmaiņu pieprasījuma (PR) URL.

Stāvoklis ir viens no: pending (gaida), approved (apstiprināts), amended (grozīts), deprecated (novecojis).

Datums ir ISO 8601 (YYYY-MM-DD) virkne.

PR ir izmaiņu pieprasījums (pull request), kas iesniedza izmaiņu, ietverot tādu informāciju kā atšķirības (diff), līdzautori un pārskatītāji.

Formāts:

  • [ADR stāvoklis, piem., approved, amended utt.](izmaiņu pieprasījuma URL) YYYY-MM-DD

Atsauces uz lietošanas gadījumiem

Norādiet visus attiecīgos lietošanas gadījumu / prasību dokumentus.

ADR nepieciešams vismaz viens attiecīgs, apstiprināts lietošanas gadījums.

Formāts:

  • [Lietošanas gadījuma nosaukums](URL)

Pievienojiet paskaidrojumus, ja ADR neatbilst visām lietošanas gadījuma prasībām.

Konteksts

Aprakstiet:

  • kā projekts ir arhitektūriski nozīmīgs – kas attaisno ADR (nevis vienkāršu problēmas ziņojumu un PR problēmas novēršanai)

  • augsta līmeņa projektēšanas pieeju (detaļas aprakstītas tālāk esošajā ierosinātajā projektā)

Ierosinātais projekts

Projekta detaļas (pēc iespējas neiedziļinoties īstenošanā).

Pārskats:

  • ietekmējamie (mainījamie) pakalpojumi/moduļi

  • pievienojamie jaunie pakalpojumi/moduļi

  • ietekme uz modeli un DTO (izmaiņas/papildinājumi/dzēšanas)

  • ietekme uz API (izmaiņas/papildinājumi/dzēšanas)

  • ietekme uz vispārējo konfigurāciju (jaunu sadaļu izveide, izmaiņas/papildinājumi/dzēšanas)

  • ietekme uz DevOps

Apsvērumi

Dokumentējiet alternatīvas, bažas, palīgjautājumus vai saistītos jautājumus, kas radušies ADR debatēs.

Norādiet, vai un kā tie tika atrisināti vai mīkstināti.

Lēmums

Dokumentējiet jebkuras saskaņotas svarīgas īstenošanas detaļas, brīdinājumus, turpmākos apsvērumus, atlikušos vai atliktos projektēšanas jautājumus.

Dokumentējiet jebkuru prasību daļu, ko ierosinātais projekts neapmierina.

Citi saistītie ADR

Norādiet jebkurus attiecīgos ADR – piemēram, funkcijas apakškomponenta projektēšanas lēmumu, projektu, kas šī projekta rezultātā kļuvis novecojis, utt.

Formāts:

  • [ADR nosaukums](URL) - Atbilstība

Atsauces

Norādiet papildu atsauces.

Formāts:

  • [Nosaukums](URL)