45379a2639
Architektur-Entscheidung aus Issue #62: Diátaxis-Framework für Doku- Pflege ohne Drift. Pflege im Repo, ADRs immutable, Stale-Snapshots explizit als Archiv markiert. Phase 1 — Architecture Decision Records: - docs/README.md — Diátaxis-Index, Erklärung was wo dokumentiert wird - docs/adr/README.md — ADR-Workflow + Index - docs/adr/template.md — Vorlage für neue ADRs - docs/adr/0001-llm-citation-binding.md — Issue #60 Doppel-Fix-Story (A=ENUM-Anker, B=server-seitige Rekonstruktion, warum Option C verworfen) - docs/adr/0002-adapter-architecture.md — ParlamentAdapter-Basisklasse + Registry, Klassen vs. Strategy vs. Modul-pro-Adapter - docs/adr/0003-citation-property-tests.md — Sub-D Strategie, warum Property-Test gegen echte PDFs statt Schema-Tests oder Online-Verify - docs/adr/0004-deployment-workflow.md — Docker-Compose + Volumes Standard-Workflow + SN-XML-Sonderpfad + Container-UTC-Gotcha Phase 3 — Stale Doku archiviert: - DOKUMENTATION.md (24.März, Skript-Architektur vor Webapp-Migrate) → docs/archive/DOKUMENTATION-2026-03-24.md - STATUS-2026-03-28.md (Tagesstand-Snapshot) → docs/archive/STATUS-2026-03-28.md - README.md (28.März, listet nur NRW-Adapter, vor 16 weiteren BLs) → docs/archive/README-2026-03-28.md - docs/archive/README.md erklärt warum die Files da sind und warum niemand sie überschreiben oder ersetzen sollte Plus neue Top-Level-README.md im Project-Root (außerhalb git, da project-root kein Repo ist) als Folder-Index für den User. CLAUDE.md ergänzt um Doku-Sektion mit Verweis auf docs/adr/. Phase 2 (mkdocs Setup) folgt separat — braucht eine Docker-Image- Erweiterung, die ich nicht autark einrollen will ohne Decision. Tests: 194/194 grün (keine Code-Änderung). Refs: #62
49 lines
1022 B
Markdown
49 lines
1022 B
Markdown
# NNNN — Titel der Entscheidung
|
|
|
|
| | |
|
|
|---|---|
|
|
| **Status** | proposed / accepted / deprecated / superseded |
|
|
| **Datum** | YYYY-MM-DD |
|
|
| **Supersedes** | (optional) link auf vorherigen ADR |
|
|
| **Superseded by** | (optional) link auf neueren ADR |
|
|
| **Refs** | Issues, PRs, Commits |
|
|
|
|
## Kontext
|
|
|
|
Welches Problem hat zu der Entscheidung geführt? Was ist der Stand vorher,
|
|
welche Constraints sind im Spiel, welche Stakeholder sind betroffen?
|
|
|
|
## Optionen
|
|
|
|
Welche Alternativen wurden ernsthaft erwogen? Mindestens 2, gerne mehr.
|
|
|
|
### Option A — …
|
|
|
|
Beschreibung. Vor- und Nachteile.
|
|
|
|
### Option B — …
|
|
|
|
Beschreibung. Vor- und Nachteile.
|
|
|
|
## Entscheidung
|
|
|
|
Welche Option wurde gewählt und warum? Konkret und unmissverständlich, sodass
|
|
ein neuer Kollege ohne Diskussion weitermachen kann.
|
|
|
|
## Konsequenzen
|
|
|
|
Was wird leichter / schwerer durch diese Entscheidung? Welche Folge-Arbeiten
|
|
fallen an? Welche Teile des Systems werden berührt?
|
|
|
|
### Positiv
|
|
|
|
- …
|
|
|
|
### Negativ
|
|
|
|
- …
|
|
|
|
### Folgen für andere ADRs
|
|
|
|
- …
|