Doku-Verifikation: Zweiten Review-Pass als Pflicht ergänzt
Schritt 4 prüft Korrektheit/Konsistenz (Links, Diagramme, Querverweise, Abhängigkeiten) unabhängig von Schritt 3 (Vollständigkeit). Verhindert, dass Fehler erst bei User-Nachfrage auffallen. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
21
CLAUDE.md
21
CLAUDE.md
@@ -510,7 +510,26 @@ Nach Abschluss der Dokumentationsarbeit, erstelle eine Vergleichstabelle:
|
||||
|
||||
3. Bestätige: **"X/X Abschnitte vollständig dokumentiert. Keine Inhalte wurden vergessen."**
|
||||
|
||||
**Dieser Prozess ist nicht optional.** Dokumentationsverlust durch unvollständige Arbeit ist inakzeptabel.
|
||||
#### Schritt 4: Zweiter unabhängiger Review-Pass (PFLICHT)
|
||||
|
||||
**Nach Schritt 3 MUSS ein zweiter, komplett unabhängiger Review-Pass erfolgen.** Dieser Schritt existiert, weil erfahrungsgemäß beim ersten Durchgang Fehler übersehen werden, die erst bei einer Nachfrage auffallen. Der User soll NICHT nachfragen müssen.
|
||||
|
||||
**Vorgehen:**
|
||||
|
||||
1. Alle bearbeiteten Dateien nochmals KOMPLETT lesen (nicht überfliegen)
|
||||
2. Gezielt prüfen — andere Perspektive als Schritt 3:
|
||||
- **Links:** Sind alle Markdown-Links gültig? Anker korrekt (keine Leerzeichen, Sonderzeichen)?
|
||||
- **Diagramme:** Spiegeln Mermaid-Diagramme den aktuellen Stand wider? Neue Knoten/Kanten nötig?
|
||||
- **Querverweise:** Stimmen Referenz-Tabellen nach Diagrammen mit den tatsächlichen Knoten überein?
|
||||
- **Abhängigkeiten:** Sind alle neuen Abhängigkeiten in `dependencies.md` eingetragen (Mermaid + Impact-Tabelle)?
|
||||
- **Konsistenz:** Stimmen Angaben (IPs, Ports, Hostnamen, Netze) zwischen README und dependencies.md überein?
|
||||
- **Vollständigkeit:** Gibt es Erkenntnisse aus der Session, die NICHT dokumentiert sind? (Pitfalls, Workarounds, TODOs)
|
||||
3. Gefundene Fehler sofort fixen und committen
|
||||
4. Bestätige: **"Zweiter Review-Pass abgeschlossen. X Fehler gefunden und behoben."** (oder: "Keine weiteren Fehler gefunden.")
|
||||
|
||||
**Dieser zweite Pass ist NICHT optional und NICHT identisch mit Schritt 3.** Schritt 3 prüft Vollständigkeit (sind alle Abschnitte da?). Schritt 4 prüft Korrektheit und Konsistenz (sind die Inhalte richtig, Links gültig, Diagramme aktuell?).
|
||||
|
||||
**Dieser Prozess ist nicht optional.** Dokumentationsverlust oder fehlerhafte Dokumentation durch unvollständige Arbeit ist inakzeptabel.
|
||||
|
||||
### Wiki-Prinzip: Verlinkte Dokumentation (PFLICHT)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user