Architecture Decision Record
← Sprendimo įrašo šablonai

Architektūros sprendimo įrašo (ADR) šablonas

Tai EdgeX Foundry ADR šablonas.

Šaltinis: https://docs.edgexfoundry.org/2.3/design/adr/template/

Teikėjai

Išvardykite ADR teikėjus.

Formatas:

  • Vardas (organizacija)

Pakeitimų žurnalas

Išvardykite dokumento pakeitimus, įskaitant būseną, datą ir PR URL.

Būsena yra viena iš: laukiama, patvirtinta, pataisyta, nebenaudotina.

Data yra ISO 8601 (YYYY-MM-DD) eilutė.

PR yra pull request, kuriuo pateiktas pakeitimas, įskaitant tokią informaciją kaip skirtumai, prisidėjusieji ir peržiūrėtojai.

Formatas:

  • [ADR būsena, pvz., patvirtinta, pataisyta ir pan.](pull request URL) YYYY-MM-DD

Nurodyti naudojimo atvejai

Išvardykite visus svarbius naudojimo atvejų / reikalavimų dokumentus.

ADR reikalauja bent vieno svarbaus, patvirtinto naudojimo atvejo.

Formatas:

  • [Naudojimo atvejo pavadinimas](URL)

Pridėkite paaiškinimų, jei ADR neaprėpia visų naudojimo atvejo reikalavimų.

Kontekstas

Aprašykite:

  • kuo projektas yra architektūriškai reikšmingas ir dėl ko reikalingas ADR (o ne paprasta problema ir PR jai išspręsti)

  • aukšto lygio projektavimo požiūrį (išsamiau aprašyta toliau pateiktame siūlomame projekte)

Siūlomas projektas

Projekto detalės (kai įmanoma, neinant į įgyvendinimą).

Apibūdinkite:

  • paslaugas / modulius, kuriuos paveiks (pakeis)

  • naujas paslaugas / modulius, kuriuos reikės pridėti

  • modelio ir DTO poveikį (pakeitimai / papildymai / pašalinimai)

  • API poveikį (pakeitimai / papildymai / pašalinimai)

  • bendros konfigūracijos poveikį (naujų skyrių įvedimas, pakeitimai / papildymai / pašalinimai)

  • devops poveikį

Svarstymai

Dokumentuokite alternatyvas, susirūpinimą keliančius dalykus, papildomus ar susijusius klausimus, kurie iškilo diskutuojant dėl ADR.

Nurodykite, ar ir kaip jie buvo išspręsti ar sušvelninti.

Sprendimas

Dokumentuokite visas sutartas svarbias įgyvendinimo detales, išlygas, būsimus svarstymus, likusius ar atidėtus projektavimo klausimus.

Dokumentuokite visas reikalavimų dalis, kurių siūlomas projektas netenkina.

Kiti susiję ADR

Išvardykite visus svarbius ADR – pavyzdžiui, funkcijos antrinio komponento projektavimo sprendimą, dėl šio projekto nebenaudotiną projektą ir pan..

Formatas:

  • [ADR pavadinimas](URL) – svarba

Nuorodos

Išvardykite papildomas nuorodas.

Formatas:

  • [Pavadinimas](URL)