Architecture Decision Record
← Vorlagen für Entscheidungsprotokolle

Vorlage für Architecture Decision Records (ADR)

Dies ist eine Vorlage für ADRs von EdgeX Foundry.

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

Einreicher

Führen Sie die Einreicher des ADRs auf.

Format:

  • Name (Organisation)

Änderungsprotokoll

Führen Sie die Änderungen am Dokument auf, einschließlich Status, Datum und PR-URL.

Der Status ist einer von: pending, approved, amended, deprecated.

Das Datum ist eine ISO-8601-Zeichenfolge (YYYY-MM-DD).

Der PR ist der Pull Request, der die Änderung eingereicht hat, einschließlich Informationen wie Diff, Mitwirkende und Prüfer.

Format:

  • [Status des ADRs, z. B. approved, amended usw.](URL des Pull Requests) YYYY-MM-DD

Referenzierte Anwendungsfälle

Führen Sie alle relevanten Anwendungsfall-/Anforderungsdokumente auf.

Ein ADR erfordert mindestens einen relevanten, genehmigten Anwendungsfall.

Format:

  • [Name des Anwendungsfalls](URL)

Fügen Sie Erläuterungen hinzu, wenn der ADR nicht alle Anforderungen eines Anwendungsfalls abdeckt.

Kontext

Beschreiben Sie:

  • wie der Entwurf architektonisch bedeutsam ist – sodass ein ADR gerechtfertigt ist (gegenüber einem einfachen Issue und PR zur Behebung eines Problems)

  • den übergeordneten Entwurfsansatz (Details werden im vorgeschlagenen Entwurf unten beschrieben)

Vorgeschlagener Entwurf

Details des Entwurfs (möglichst ohne auf die Implementierung einzugehen).

Gliederung:

  • betroffene (geänderte) Dienste/Module

  • neu hinzuzufügende Dienste/Module

  • Auswirkungen auf Modell und DTO (Änderungen/Ergänzungen/Entfernungen)

  • Auswirkungen auf die API (Änderungen/Ergänzungen/Entfernungen)

  • Auswirkungen auf die allgemeine Konfiguration (Einrichtung neuer Abschnitte, Änderungen/Ergänzungen/Entfernungen)

  • Auswirkungen auf DevOps

Überlegungen

Dokumentieren Sie Alternativen, Bedenken, Nebenaspekte oder verwandte Themen und Fragen, die in der Debatte über den ADR aufkamen.

Geben Sie an, ob und wie sie gelöst oder abgemildert wurden.

Entscheidung

Dokumentieren Sie alle vereinbarten wichtigen Implementierungsdetails, Vorbehalte, künftigen Überlegungen sowie verbleibende oder zurückgestellte Entwurfsfragen.

Dokumentieren Sie alle Teile der Anforderungen, die vom vorgeschlagenen Entwurf nicht erfüllt werden.

Weitere zugehörige ADRs

Führen Sie alle relevanten ADRs auf – etwa eine Entwurfsentscheidung für eine Unterkomponente eines Features, einen Entwurf, der infolge dieses Entwurfs veraltet ist usw..

Format:

  • [ADR-Titel](URL) - Relevanz

Referenzen

Führen Sie weitere Referenzen auf.

Format:

  • [Titel](URL)