2.0 KiB
2.0 KiB
Architecture Decision Records (ADRs)
ADRs dokumentieren signifikante Architektur-Entscheidungen mit Kontext, Optionen und Konsequenzen. Format inspiriert von Michael Nygard.
Workflow
- Neue Entscheidung steht an → Kopie von
template.mdmit nächster freier Nummer (NNNN-kebap-titel.md). - Status
proposed→ diskutiert in Issue/PR → bei Akzeptanz aufaccepted. - Niemals editieren nach
accepted. Wenn eine Entscheidung sich ändert, neuer ADR mitSupersedes: NNNN-…im Header und der alte ADR bekommtSuperseded by: MMMM-…. - Status
deprecatedfür Entscheidungen, die ohne Nachfolger auslaufen.
Index
| ID | Titel | Status | Datum |
|---|---|---|---|
| 0001 | LLM-Citations server-seitig binden statt prompt-seitig | accepted | 2026-04-10 |
| 0002 | Adapter-Pattern mit ParlamentAdapter-Basisklasse + Registry | accepted | 2026-04-10 |
| 0003 | Sub-D Property-Verification: Zitate als Substring der zitierten PDF-Seite | accepted | 2026-04-10 |
| 0004 | Docker Compose Deploy mit DB-/Reports-Volume und SN-XML-Sonderpfad | accepted | 2026-04-10 |
| 0005 | Keycloak SSO mit Dev-Bypass für Read/Write-Trennung | accepted | 2026-04-10 |
Wann ADR, wann nicht
| ADR-würdig | nicht ADR-würdig |
|---|---|
| Wahl zwischen mehreren plausiblen Architekturen mit Trade-offs | Bug-Fix |
| Strukturelle Konsequenzen für mehrere Module | Refactoring innerhalb eines Moduls |
| Reverse-Engineering-Findings die andere Adapter beeinflussen | Stiländerungen, Linting-Konventionen |
| Neue externe Abhängigkeiten oder APIs | Dependency-Bumps ohne API-Änderung |
| Workflow-Konventionen die mehrere Sessions überdauern müssen | Tagesgeschäft, Issue-Tracking |
Faustregel: Wenn ein neuer Kollege (oder eine neue Session) die Entscheidung sonst rückgängig machen würde, gehört sie in einen ADR.