Šablóna záznamu architektonického rozhodnutia (ADR)

Toto je šablóna pre ADR EdgeX Foundry.

Uveďte predkladateľov ADR.

Formát:

Záznam zmien

Uveďte zmeny dokumentu vrátane stavu, dátumu a URL pull requestu.

Stav je jeden z: pending, approved, amended, deprecated.

Dátum je reťazec podľa ISO 8601 (YYYY-MM-DD).

PR je pull request, ktorým bola zmena predložená, vrátane informácií ako rozdiely, prispievatelia a recenzenti.

Formát:

Uveďte všetky relevantné dokumenty prípadov použitia / požiadaviek.

ADR vyžaduje aspoň jeden relevantný, schválený prípad použitia.

Formát:

Pridajte vysvetlenia, ak ADR nerieši všetky požiadavky prípadu použitia.

Opíšte:

v čom je návrh architektonicky významný – čo odôvodňuje ADR (oproti jednoduchému problému a PR na jeho opravu)
prístup k návrhu na vysokej úrovni (podrobnosti sú opísané v navrhovanom návrhu nižšie)

Podrobnosti návrhu (bez zachádzania do implementácie, kde je to možné).

Prehľad:

služby/moduly, ktoré budú ovplyvnené (zmenené)
nové služby/moduly, ktoré sa majú pridať
vplyv na model a DTO (zmeny/pridania/odstránenia)
vplyv na API (zmeny/pridania/odstránenia)
vplyv na všeobecnú konfiguráciu (zavedenie nových sekcií, zmeny/pridania/odstránenia)
vplyv na devops

Zdokumentujte alternatívy, obavy, pomocné alebo súvisiace otázky a otázky, ktoré vznikli v diskusii o ADR.

Uveďte, či a ako boli vyriešené alebo zmiernené.

Zdokumentujte všetky dohodnuté dôležité implementačné detaily, upozornenia, budúce úvahy, zostávajúce alebo odložené otázky návrhu.

Zdokumentujte každú časť požiadaviek, ktorú navrhovaný návrh nespĺňa.

Uveďte všetky relevantné ADR – napríklad rozhodnutie o návrhu podkomponentu funkcie, návrh zastaraný v dôsledku tohto návrhu atď..

Formát:

Uveďte ďalšie referencie.

Formát: