Spec: Doku-System
Das Doku-System ist die kanonische öffentliche Projektfläche in GitHub Pages. Hier werden Regeln, Bereichsdoku, Runbooks, Arbeitsdokus und Specs veröffentlicht.
Was es ist
- das Repo
lebenslauf-web-vorlage-docs - die öffentliche Dokumentation unter
/de/...und/en/... - der kanonische Ort für öffentliche Projektregeln und stabile Erklärseiten
Was es nicht ist
- nicht Jira selbst
- nicht das Rohnotizsystem
- nicht das Produkt-Repo
Warum
- das Projekt braucht einen öffentlichen, statischen und kanonischen Doku-Ort
- Skills und Leser sollen Projektwissen nicht aus verstreuten Einzelquellen zusammensuchen müssen
Aufbau
areas/policies/operations/decisions/work/specs/
Rollen
- Leser orientieren sich hier öffentlich
- Autoren pflegen stabile Regeln und Erklärungen
- Jira-Arbeitsdokus machen Arbeitsschritte öffentlich nachvollziehbar
Schnittstellen
- spiegelt Arbeitsstände aus dem Jira-System
- verweist auf Repos im GitHub- und PR-System
- nutzt
tagebuchnur als Provenienzquelle
Ist und Zielbild
- Ist:
- öffentliche Doku, Jira-Fläche und Regeln existieren
- Zielbild:
- zusätzlich klare Projekt-, System- und Ablauf-Specs als Landkarte
Übergeordnete Systeme
Untergeordnete Systeme
- Bereichsdoku
- Richtlinien und Runbooks
- öffentliche Jira-Arbeitsdokus
- Specs
Verwandte Systeme
Quellen
- Doku-Richtlinie
- KI-Projektkarte
- Jira
lebenslauf-web-vorlage-docs/README.md