Was ist ein Architecture Decision Record (ADR)?
Ein Architecture Decision Record (ADR) ist ein kurzes Dokument, das eine wichtige technische Entscheidung festhält: Kontext, getroffene Wahl und Folgen.
So funktioniert es
Michael Nygard schlug das Format 2011 vor: Titel, Status, Kontext, Entscheidung und Folgen, fortlaufend nummeriert. Ein ADR wird nicht umgeschrieben, wenn sich die Meinung ändert: Ein neuer ersetzt ihn.
Die Sammlung wird zum Gedächtnis des Projekts. Neue Entwickler lesen, warum das System so ist, wie es ist, und niemand öffnet eine geklärte Frage, ohne die Gründe vor Augen zu haben.
Ein Beispiel
ADR 14 hält die Wahl von PostgreSQL statt einer Dokumentendatenbank fest: Die Daten sind relational, das Team kann SQL, und Berichte brauchen Joins. Zwei Jahre später ersetzt ADR 31 einen Teil davon für die Suche und verlinkt zurück.
Typische Fehler
- Entscheidungen lange danach festhalten, ohne den Kontext, der damals auf dem Tisch lag.
- Einen alten ADR umschreiben, statt ihn zu ersetzen.
- ADRs dort ablegen, wo die, die sie brauchen, nie nachsehen.
In Nodary
Nodary hat eine eingebaute ADR-Vorlage. Eine Entscheidung kann als durch den nachfolgenden Datensatz ersetzt markiert werden, Links sagen, wovon sie abhängt, und der Verlauf des Dokuments behält seine jüngsten Fassungen zum Vergleichen und Wiederherstellen.
Was Nodary nicht tut: Es hält ADRs nicht in Ihrem Code-Repository: Exportieren Sie sie als Markdown, wenn sie neben dem Code liegen müssen.
Aus Nodary exportieren · Entscheidungsprotokoll-Vorlage mit ADRs
Probieren Sie es mit Ihren eigenen Dokumenten. Der Free-Tarif braucht keine Karte.
Kostenlosen Arbeitsbereich erstellen