Architecture Decision Record
← Erabaki-erregistroen txantiloiak

Arkitektura-erabakien erregistroaren (ADR) txantiloia

Hau EdgeX Foundry-ren ADR-arentzako txantiloia da.

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

Aurkezleak

Zerrendatu ADR-aren aurkezleak.

Formatua:

  • Izena (Erakundea)

Aldaketen egunkaria

Zerrendatu dokumentuaren aldaketak, egoera, data eta PR URL-a barne.

Egoera hauetako bat da: zain, onartua, aldatua, zaharkitua.

Data ISO 8601 (YYYY-MM-DD) kate bat da.

PR aldaketa aurkeztu zuen pull request-a da, diff, laguntzaile eta berrikusle bezalako informazioa barne.

Formatua:

  • [ADR-aren egoera, adibidez onartua, aldatua, eta abar](pull request-aren URL-a) YYYY-MM-DD

Erreferentziatutako erabilera-kasuak

Zerrendatu garrantzitsuak diren erabilera-kasu / eskakizun-dokumentu guztiak.

ADR-ak erabilera-kasu garrantzitsu eta onartu bat behar du gutxienez.

Formatua:

  • [Erabilera-kasuaren izena](URL-a)

Gehitu azalpenak ADR-ak erabilera-kasu baten eskakizun guztiei erantzuten ez badie.

Testuingurua

Deskribatu:

  • diseinua nola den arkitekturaren ikuspegitik esanguratsua - ADR bat justifikatzen duena (arazo bat konpontzeko issue eta PR sinple baten aurrean)

  • goi-mailako diseinu-ikuspegia (xehetasunak jarraian proposatutako diseinuan deskribatzen dira)

Proposatutako diseinua

Diseinuaren xehetasunak (ahal denean ezarpenean sartu gabe).

Eskema:

  • eragindako (aldatutako) zerbitzuak/moduluak

  • gehitu beharreko zerbitzu/modulu berriak

  • ereduen eta DTO-en gaineko eragina (aldaketak/gehiketak/ezabaketak)

  • API-aren gaineko eragina (aldaketak/gehiketak/ezabaketak)

  • konfigurazio orokorraren gaineko eragina (atal berriak ezartzea, aldaketak/gehiketak/ezabaketak)

  • devops-aren gaineko eragina

Kontuan hartzekoak

Dokumentatu ADR-aren eztabaidan sortutako alternatibak, kezkak, gai osagarri edo lotuak eta galderak.

Adierazi horiek konpondu edo leundu diren eta nola.

Erabakia

Dokumentatu adostutako ezarpen-xehetasun garrantzitsuak, abisuak, etorkizuneko kontuan hartzekoak, geratzen diren edo atzeratutako diseinu-gaiak.

Dokumentatu proposatutako diseinuak betetzen ez duen eskakizunen edozein zati.

Lotutako beste ADR batzuk

Zerrendatu garrantzitsuak diren ADR-ak - esaterako ezaugarri baten azpiosagai baten diseinu-erabakia, diseinu honen ondorioz zaharkitutako diseinua, eta abar.

Formatua:

  • [ADR-aren izenburua](URL-a) - Garrantzia

Erreferentziak

Zerrendatu erreferentzia gehigarriak.

Formatua:

  • [Izenburua](URL-a)