refactoring Dokumentation

This commit is contained in:
2025-10-15 12:48:00 +02:00
parent e8f33e465c
commit be464f2ac0
42 changed files with 1155 additions and 13101 deletions
+43
View File
@@ -0,0 +1,43 @@
---
owner: stefan
status: active
timeframe: 2025-10-15 → 2025-10-29
last_reviewed: 2025-10-15
review_cycle: 7d
summary: MinimalDoku + NowPage etablieren, um Übersicht zurückzugewinnen.
---
# Aktuelle Initiative: Doku verschlanken & NowPage einführen
## 1) Vision (Was?)
Eine verlässliche, minimale Doku (≤5 Seiten) + ein stets aktueller OnePager für das laufende Vorhaben.
- In Scope: Start/Overview/API/Prod-HowTo/Now-Page
- Out of Scope: Vollständige Übersetzungen, alte Berichte/Prosa
## 2) Why (Warum so?)
Zu viele, verstreute Dokumente erzeugen Drift und Entscheidungsunsicherheit. Ziel: Orientierung in <2 Min. wiederfinden.
- Erfolg messbar an: 1 Einstiegspunkt, 0 Broken Links, Validierung grün
- Dauerhaft relevante Entscheidungen künftig als ADR, aus NowPage verlinkt
## 3) How (Wie umsetzen?)
- Behalten: `docs/index.md`, `overview/system-overview.md`, `how-to/*`, `api/README.md`, `now/current.md`
- Entfernen/Archivieren: `Tagebuch/`, alte Indizes
- CI beibehalten (LinkCheck optional), später StaleCheck für NowPage ergänzen
## 4) Plan (Was ist jetzt zu tun?)
- [ ] Index minimalisieren und nur auf Kernseiten verlinken
- [ ] System Overview anlegen und Ports/Health bündeln
- [ ] NowPage Template + current.md erstellen
- [ ] Alte Indizes und Tagebuch entfernen
- [ ] Validierung laufen lassen und etwaige Links reparieren
- [ ] Nächste Initiative vorbereiten: GitFlow & GitHub Actions Strategy
## 5) Status & Nächster Fokus
- Status: active
- Nächster Fokus: Validierung ausführen und offene LinkThemen bereinigen; danach GitFlow/GitHubActions planen
## 6) Referenzen
- Start lokal: `docs/how-to/start-local.md`
- Übersicht: `docs/overview/system-overview.md`
- Produktion/Nginx: `docs/how-to/deploy-proxmox-nginx.md`
- API: `docs/api/README.md`