Entwicklung
Vorlage für Architekturentscheidung (ADR)
In sechs Monaten wird jemand fragen, warum das System so funktioniert, wie es funktioniert. Eine Architekturentscheidung beantwortet das auf ein bis zwei Seiten. Diese Vorlage deckt Kontext, abgewogene Optionen, Entscheidung, Konsequenzen, Folgearbeiten und die Bedingungen für eine spätere Überprüfung ab.
Diese Vorlage im Editor öffnen- Kategorie
- Entwicklung
- Standardstil
- Technisch
Wann du sie brauchst
Schreibe eine Architekturentscheidung, wenn eine technische Wahl teuer umzukehren ist: eine Datenbank, ein Framework, ein Hosting-Modell, ein API-Stil. Künftige Betreuerinnen, neue Teammitglieder und Reviewer lesen sie, um die Zwänge von damals zu verstehen. Schreib sie, solange die Diskussion frisch ist, und halte die Statuszeile aktuell, während der Vorschlag sich entwickelt.
Was enthalten ist
- Ein nummerierter Titel mit Ausfüllfeldern für Projekt, Autorin und Datum, plus eine Statuszeile.
- Eine Optionstabelle, die Vorteile und Kosten vergleicht, inklusive einer Zeile für die Beibehaltung des aktuellen Ansatzes.
- Entscheidung, positive und negative Konsequenzen, eine Checkliste zur Umsetzung und ein Auslöser für die Überprüfung.
Tipps für ein besseres Dokument
- Formuliere die Entscheidung in einem Satz und nenne den einen stärksten Grund. Wenn du fünf Gründe brauchst, braucht der Kontextabschnitt wahrscheinlich mehr Arbeit.
- Sei ehrlich bei den negativen Konsequenzen. Wenn ein Diagramm die Änderung besser erklärt als Fließtext, füge einen Mermaid-Block ein, er wird im PDF gerendert.
Vorlagenvorschau
ADR-001: Projekt oder Thema
Autor:in: Dein Name · Datum: Datum
Status: Vorgeschlagen
Kontext
Beschreibe das Problem, die Rahmenbedingungen und die Kräfte, die diese Entscheidung prägen.
Betrachtete Optionen
| Option | Vorteile | Kosten |
|---|---|---|
| Option A | Hauptvorteil | Hauptabwägung |
| Option B | Hauptvorteil | Hauptabwägung |
| Aktuellen Ansatz beibehalten | Keine Migration | Bestehende Einschränkung |
Entscheidung
Nenne den gewählten Ansatz und den wichtigsten Grund für die Wahl.
Konsequenzen
Positiv: Was dadurch einfacher wird.
Negativ: Was dadurch schwieriger oder teurer wird.
Umsetzung
- Verantwortliche Person benennen
- Migration und Rollback planen
- Dokumentation aktualisieren
Anlass zur Überprüfung
Gib an, welche Erkenntnisse oder Änderungen diese Entscheidung erneut infrage stellen würden.
Ausfüllfelder wie dein Name und das Datum werden ersetzt, sobald du die Vorlage im Editor öffnest.