1 line
71 KiB
JSON
1 line
71 KiB
JSON
|
{"config":{"lang":["de"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"GW\u00d6-Antragspr\u00fcfer \u2014 Dokumentation","text":"<p>Diese Dokumentation folgt dem Di\u00e1taxis-Framework und ist nach Funktion (nicht nach Themen) organisiert. Drift-immun durch klare Trennung: Reference wird aus dem Code generiert, ADRs sind immutable, Tutorials/How-to sind manuell gepflegt aber knapp.</p>"},{"location":"#struktur","title":"Struktur","text":"<pre><code>docs/\n\u251c\u2500\u2500 README.md \u2190 du bist hier\n\u251c\u2500\u2500 adr/ Architecture Decision Records (immutable)\n\u2502 \u251c\u2500\u2500 README.md ADR-Index + Workflow\n\u2502 \u251c\u2500\u2500 template.md Template f\u00fcr neue ADRs\n\u2502 \u2514\u2500\u2500 NNNN-titel.md Eine Datei pro Entscheidung\n\u2514\u2500\u2500 archive/ Historische Snapshots, nicht autoritativ\n</code></pre> <p>Geplant f\u00fcr sp\u00e4ter (siehe Issue #62):</p> <pre><code>docs/\n\u251c\u2500\u2500 reference/ \u2190 mkdocs autodoc-Output (nicht eingecheckt)\n\u251c\u2500\u2500 tutorials/ \u2190 Erst-Schritt-Anleitungen\n\u251c\u2500\u2500 how-to/ \u2190 Aufgaben-orientiert, \"wie deploye ich\"\n\u2514\u2500\u2500 explanation/ \u2190 Hintergr\u00fcnde, Konzepte\n</code></pre>"},{"location":"#nicht-hier-dokumentiert-bewusst","title":"Nicht hier dokumentiert (bewusst)","text":"Was Wo API-Reference (Endpoints, Models, Schemas) Auto-generiert aus FastAPI/Pydantic, nicht in docs/ einchecken Code-Reference (Klassen, Funktionen) mkdocstrings aus den Docstrings (geplant Phase 2) Aktueller Projekt-Stand / Issues Gitea Issues \u2014 <code>repo.toppyr.de/tobias/gwoe-antragspruefer/issues</code> Onboarding f\u00fcr KI-assisted Coder <code>CLAUDE.md</code> im Repo-Root Live-System-Status <code>https://gwoe.toppyr.de/auswertungen</code> (dynamisches Dashboard) Memory der KI-Sessions <code>~/.claude/projects/<projekt>/memory/</code> (privat)"},{"location":"#gegen-drift","title":"Gegen Drift","text":"<ul> <li>ADRs sind immutable: nie \u00fcberschreiben, sondern bei \u00c4nderung mit einem neuen ADR superseden, der den alten in seinem Header referenziert.</li> <li>Reference wird aus dem Code generiert, nie von Hand gepflegt.</li> <li><code>docs/archive/</code> enth\u00e4lt historische Status-Files. Werden gelesen aber nicht aktualisiert. Wenn etwas davon noch wahr ist, geh\u00f6rt es in einen ADR oder in die generierte Reference, nicht in einen neuen Status-Snapshot.</li> </ul>"},{"location":"adr/","title":"Architecture Decision Records (ADRs)","text":"<p>ADRs dokumentieren signifikante Architektur-Entscheidungen mit Kontext, Optionen und Konsequenzen. Format inspiriert von Michael Nygard.</p>"},{"location":"adr/#workflow","title":"Workflow","text":"<ol> <li>Neue Entscheidung steht an \u2192 Kopie von <code>template.md</code> mit n\u00e4chster freier Nummer (<code>NNNN-kebap-titel.md</code>).</li> <li>Status <code>proposed</code> \u2192 diskutiert in Issue/PR \u2192 bei Akzeptanz auf <code>accepted</code>.</li> <li>Niemals editieren nach <code>accepted</code>. Wenn eine Entscheidung sich \u00e4ndert, neuer ADR mit <code>Supersedes: NNNN-\u2026</code> im Header und der alte ADR bekommt <code>Superseded by: MMMM-\u2026</code>.</li> <li>Status <code>deprecated</code> f\u00fcr Entscheidungen, die ohne Nachfolger auslaufen.</li> </ol>"},{"location":"adr/#index","title":"Index","text":"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"},{"location":"adr/#wann-adr-wann-nicht","title":"Wann ADR, wann nicht","text":"ADR-w\u00fc
|