27 lines
2.1 KiB
Markdown
27 lines
2.1 KiB
Markdown
 
|
# Dokumentation – Wegweiser
|
|||
|
|
|
|||
|
|
| Ordner | Charakter | Wann lesen |
|
|||
|
|
|---|---|---|
|
|||
|
|
| `status/STATUS.md` | lebend, kurz | **immer zuerst** – aktueller Stand, Baustellen |
|
|||
|
|
| `architektur/modulkarte.md` | lebend | vor dem Lesen von Code: welche Datei, wie groß |
|
|||
|
|
| `architektur/schnittstellen.md` | lebend | vor Änderungen an `sn_basis`, Projektvariablen, Docks, Release |
|
|||
|
|
| `wissen/fallstricke.md` | lebend | bei Überraschungen; vor Arbeiten an WFS, Release, Qt |
|
|||
|
|
| `wissen/glossar.md` | lebend | Fachbegriffe |
|
|||
|
|
| `wissen/externe_dienste.md` | lebend | URLs, Abhängigkeiten |
|
|||
|
|
| `entscheidungen/` | append-only (ADR) | warum etwas so ist; neue Entscheidung = neue Datei |
|
|||
|
|
| `leitfaden/03_arbeitsweise.md` | stabil | Einstieg für Entwickler, Arbeitszyklus, Checklisten |
|
|||
|
|
| `leitfaden/04_werkzeuge_einrichten.md` | stabil | Einrichtung: Claude Code als CLI und in VS Code; von null zur ersten Aufgabe |
|
|||
|
|
| `leitfaden/05_git_arbeitsweise.md` | **verbindlich** | Branches, Fix-Einstieg, Rückführung, Tags, was der Agent darf |
|
|||
|
|
| `leitfaden/06_tests.md` | **verbindlich** | Testebenen, Testpflicht, Katalog, wie man Tests fachlich beurteilt |
|
|||
|
|
| `tests/testkatalog.md` | generiert | was die Suite prüft – erzeugt von `scripts/testkatalog.py` |
|
|||
|
|
| `tests/*.md` | lebend | Testkonzepte je Fachablauf, mit Mermaid; Vorlage in `vorlagen/` |
|
|||
|
|
| `konzept/07_qgis_tests_plan.md` | Vorschlag | Stufenplan für Tests gegen echtes QGIS |
|
|||
|
|
| `konzept/08_repo_einrichten.md` | Prüfliste | Repo auf Gitea anlegen, `stable` und Branch-Schutz |
|
|||
|
|
| `konzept/02_zusammenarbeit_ki_agenten.md` | stabil | Begründung und Aufbau der Zusammenarbeit |
|
|||
|
|
| `analyse/01_projektanalyse.md` | Momentaufnahme 09/2026 | Zusammenspiel der Komponenten, Qualitätsbefund, Risiken |
|
|||
|
|
| `analyse/00_*` | Momentaufnahme 09/2026 | Gesamtüberblick, Vergleich Alternativansatz (Vorarbeiten) |
|
|||
|
|
| `vorlagen/` | Vorlagen | Issue, PR, Übergabe, Testkonzept, Repo-`AGENTS.md`, CI-Workflow |
|
|||
|
|
|
|||
|
|
Regel: **Lebende** Dokumente werden mit jeder Änderung gepflegt, **Momentaufnahmen** nicht nachträglich geändert
|
|||
|
|
(neue Analyse = neue Datei mit Datum).
|