refactoring Dokumentation
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
---
|
||||
owner: project-maintainers
|
||||
status: active
|
||||
last_reviewed: 2025-10-15
|
||||
review_cycle: 90d
|
||||
summary: Anleitung zur Nutzung der Now-Page (Initiativen-One‑Pager) als zentraler Steuerungs- und Übersichtspunkt.
|
||||
---
|
||||
|
||||
# Now-Page – Nutzung & Workflow
|
||||
|
||||
Die Now-Page ist ein schlanker One‑Pager für dein aktuelles Vorhaben. Sie beantwortet stets fünf Fragen: Was, Warum, Wie, Was ist zu tun, und Was ist als Nächstes dran.
|
||||
|
||||
## Struktur
|
||||
- Aktive Seite: `docs/now/current.md`
|
||||
- Vorlage: `docs/now/TEMPLATE.md`
|
||||
- Archiv (optional): `docs/now/archive/` (einfach Dateien hinein verschieben)
|
||||
|
||||
## So verwendest du die Now-Page
|
||||
1. Neue Initiative starten: Kopiere `TEMPLATE.md` nach `current.md` und fülle sie aus.
|
||||
2. Kurz halten: 1 Seite, maximal 5–10 Tasks. Große Aufgaben in kleinere Schneiden.
|
||||
3. Pflege-Ritual: Bei Änderung von Fokus/Status/Plan kurz aktualisieren, `last_reviewed` anpassen.
|
||||
4. Abschluss: `status: done` setzen, 3 Bulletpoints „Lessons Learned“ ergänzen und Datei nach `now/archive/` verschieben.
|
||||
5. Dauerhafte Entscheidungen: Als ADR in `docs/architecture/adr/` festhalten und aus der Now‑Page verlinken.
|
||||
|
||||
## Tipps
|
||||
- Verlinke nur, was du beim Arbeiten wirklich brauchst (PRs, Issues, wichtige How‑Tos).
|
||||
- Nutze die Now‑Page als Daily/Nächstes‑To‑Do‑Quelle statt vieler verstreuter Notizen.
|
||||
- Optional in CI: Einen „Stale‑Check“ einführen, der warnt, wenn `current.md` länger als `review_cycle` nicht aktualisiert wurde.
|
||||
|
||||
## Navigation
|
||||
- Die Startseite (docs/index.md) verlinkt direkt auf `now/current.md`, damit du jederzeit mit einem Klick am aktuellen Fokus bist.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
owner: <dein-name-oder-team>
|
||||
status: active # active | blocked | done
|
||||
timeframe: YYYY-MM-DD → YYYY-MM-DD
|
||||
last_reviewed: YYYY-MM-DD
|
||||
review_cycle: 7d # erinnert dich wöchentlich ans Aktualisieren
|
||||
summary: One-Pager-Template für das aktuell wichtigste Vorhaben (Now-Page).
|
||||
---
|
||||
|
||||
# Aktuelle Initiative: <Titel>
|
||||
|
||||
## 1) Vision (Was?)
|
||||
Ein Satz Zielbild. Was soll am Ende anders/besser sein? Optional: In/Out of Scope.
|
||||
- In Scope: …
|
||||
- Out of Scope: …
|
||||
|
||||
## 2) Why (Warum so?)
|
||||
Problem, Zielmetriken/Erfolgskriterien, Alternativen/Trade-offs.
|
||||
- Erfolg messbar an: <Metriken/Kriterien>
|
||||
- Falls dauerhaft relevant: verweise auf ADR (`docs/adr/...`).
|
||||
|
||||
## 3) How (Wie umsetzen?)
|
||||
Kurzarchitektur, Ansatz, Risiken/Abhängigkeiten. 5–10 Zeilen genügen.
|
||||
- Ansatz: …
|
||||
- Risiken: …
|
||||
- Abhängigkeiten: …
|
||||
|
||||
## 4) Plan (Was ist jetzt zu tun?)
|
||||
Milestones + nächste konkrete Schritte. Max. 5–10 Tasks, sonst zu groß schneiden.
|
||||
- [ ] Schritt 1 (heute)
|
||||
- [ ] Schritt 2 (diese Woche)
|
||||
- [ ] Schritt 3 (nächste Woche)
|
||||
|
||||
## 5) Status & Nächster Fokus
|
||||
- Status: active | blocked | done
|
||||
- Nächster Fokus (heute): <1–2 Sätze>
|
||||
|
||||
## 6) Referenzen
|
||||
Links zu PRs, Issues, Diagrammen, Konfigs (nur die, die man wirklich braucht).
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
owner: stefan
|
||||
status: active
|
||||
timeframe: 2025-10-15 → 2025-10-29
|
||||
last_reviewed: 2025-10-15
|
||||
review_cycle: 7d
|
||||
summary: Minimal‑Doku + Now‑Page etablieren, um Übersicht zurückzugewinnen.
|
||||
---
|
||||
|
||||
# Aktuelle Initiative: Doku verschlanken & Now‑Page einführen
|
||||
|
||||
## 1) Vision (Was?)
|
||||
Eine verlässliche, minimale Doku (≤5 Seiten) + ein stets aktueller One‑Pager 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 Now‑Page 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 (Link‑Check optional), später Stale‑Check für Now‑Page ergänzen
|
||||
|
||||
## 4) Plan (Was ist jetzt zu tun?)
|
||||
- [ ] Index minimalisieren und nur auf Kernseiten verlinken
|
||||
- [ ] System Overview anlegen und Ports/Health bündeln
|
||||
- [ ] Now‑Page Template + current.md erstellen
|
||||
- [ ] Alte Indizes und Tagebuch entfernen
|
||||
- [ ] Validierung laufen lassen und etwaige Links reparieren
|
||||
- [ ] Nächste Initiative vorbereiten: Git‑Flow & GitHub Actions Strategy
|
||||
|
||||
## 5) Status & Nächster Fokus
|
||||
- Status: active
|
||||
- Nächster Fokus: Validierung ausführen und offene Link‑Themen bereinigen; danach Git‑Flow/GitHub‑Actions 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`
|
||||
Reference in New Issue
Block a user