Architecture Decision Record
← Virlage fir Decisiounsopzeechnungen

Virlag fir Architektur-Decisiounsopzeechnung (ADR)

Dëst ass e Virlag fir en EdgeX-Foundry-ADR.

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

Ageruecht vun

Lëscht d'Persoune op, déi den ADR agereecht hunn.

Format:

  • Numm (Organisatioun)

Ännerungsprotokoll

Lëscht d'Ännerungen um Dokument op, inklusiv Zoustand, Datum an URL vum PR.

De Zoustand ass ee vun: pending, approved, amended, deprecated.

D'Datum ass en ISO-8601-String (YYYY-MM-DD).

De PR ass de Pull Request, deen d'Ännerung agereecht huet, mat Informatioune wéi dem Diff, de Contributeuren an de Reviewer.

Format:

  • [Status of ADR e.g. approved, amended, etc.](URL of pull request) YYYY-MM-DD

Referenzéiert Use Cases

Lëscht all relevant Use-Case-/Ufuerderungsdokumenter op.

En ADR erfuerdert op d'mannst ee relevanten, genehmegten Use Case.

Format:

  • [Use Case Name](URL)

Füügt Erklärungen derbäi, wann den ADR net all Ufuerderunge vun engem Use Case adresséiert.

Kontext

Beschreift:

  • wéi d'Design architekturrelevant ass - wat en ADR rechtfäerdegt (am Géigesaz zu engem einfachen Issue an PR fir e Problem ze léisen)

  • den High-Level-Designusaz (Detailer si am virgeschloene Design ënnen beschriwwen)

Virgeschloent Design

Detailer vum Design (ouni, wa méiglech, an d'Ëmsetzung ze goen).

Gliederung:

  • Servicer/Moduler, déi betraff sinn (geännert ginn)

  • nei Servicer/Moduler, déi derbäikommen

  • Impakt op Modell an DTO (Ännerungen/Ergänzungen/Läschungen)

  • Impakt op d'API (Ännerungen/Ergänzungen/Läschungen)

  • Impakt op déi allgemeng Konfiguratioun (nei Rubriken, Ännerungen/Ergänzungen/Läschungen)

  • Devops-Impakt

Iwwerleeungen

Dokumentéiert Alternativen, Bedenken, Nieweproblemer oder verwandte Problemer, Froen, déi an der Debatt iwwer den ADR opkoumen.

Gitt un, ob/wéi si geléist oder ofgeschwächt goufen.

Decisioun

Dokumentéiert all vereinbart wichteg Ëmsetzungsdetailer, Virbehalter, zukünfteg Iwwerleeungen, verbleiwend oder verschuebe Designproblemer.

Dokumentéiert all Deel vun den Ufuerderungen, deen net duerch dat virgeschloent Design erfëllt gëtt.

Aner verwandten ADR

Lëscht all relevant ADR op - zum Beispill eng Designdecisioun fir eng Subkomponent vun engem Feature, e Design, dat duerch dëst Design als deprecated gëtt, asw.

Format:

  • [ADR Title](URL) - Relevanz

Referenzen

Lëscht zousätzlech Referenzen op.

Format:

  • [Title](URL)