Sniðmát arkitektúrákvörðunarskrár (ADR)

Þetta er sniðmát fyrir ADR hjá EdgeX Foundry.

Skráðu þá sem leggja ADR fram.

Snið:

Breytingaskrá

Skráðu breytingar á skjalinu, þar á meðal stöðu, dagsetningu og vefslóð PR.

Staða er ein af: pending, approved, amended, deprecated.

Dagsetning er ISO 8601 strengur (YYYY-MM-DD).

PR er pull request sem lagði breytinguna fram, með upplýsingum eins og mismun, þátttakendum og rýnendum.

Snið:

Skráðu öll viðeigandi skjöl um notkunartilvik / kröfur.

ADR krefst að minnsta kosti eins viðeigandi, samþykkts notkunartilviks.

Snið:

Bættu við skýringum ef ADR tekur ekki á öllum kröfum notkunartilviks.

Lýstu:

hvernig hönnunin er arkitektúrlega mikilvæg - svo að hún réttlæti ADR (í stað einfaldrar villuskýrslu og PR til að laga vandamál)
nálguninni í hönnun á háu stigi (smáatriði eru lýst í tillögu að hönnun hér að neðan)

Smáatriði hönnunarinnar (án þess að fara út í útfærslu þar sem hægt er).

Útlínur:

þjónustur/einingar sem verða fyrir áhrifum (breytast)
nýjar þjónustur/einingar sem bætast við
áhrif á líkan og DTO (breytingar/viðbætur/brottfall)
áhrif á API (breytingar/viðbætur/brottfall)
áhrif á almenna uppsetningu (stofnun nýrra kafla, breytingar/viðbætur/brottfall)
áhrif á devops

Skjalfestu valkosti, áhyggjur, hliðarmál eða skyld mál og spurningar sem komu upp í umræðu um ADR.

Taktu fram hvort/hvernig þau voru leyst eða milduð.

Skjalfestu allar samþykktar mikilvægar útfærsluupplýsingar, fyrirvara, framtíðarsjónarmið og hönnunarmál sem eru enn óleyst eða frestað.

Skjalfestu alla hluta krafnanna sem tillagan að hönnun uppfyllir ekki.

Skráðu viðeigandi ADR - svo sem hönnunarákvörðun fyrir undireiningu eiginleika, hönnun sem er úrelt vegna þessarar hönnunar o.s.frv.

Snið:

Skráðu frekari heimildir.

Snið: