Content Consistency Validator (Inhaltskonsistenz-Prüfer)
Überblick
Prüft Inhalte auf Konsistenz in Ton, Terminologie, Formatierung und Struktur über mehrere Dokumentationsquellen hinweg (Websites, GitHub-Repositories, lokale Dokumentationen). Erstellt schreibgeschützte Abweichungsberichte mit nach Schweregrad klassifizierten Ergebnissen und umsetzbaren Korrekturvorschlägen inklusive Dateipfaden und Zeilennummern.
Beispiele
- Pre-Release-Audit: Vor dem Taggen einer neuen Version den Validator ausführen, um Versionskonflikte zwischen der README, der Dokumentationsseite und der Changelog-Datei zu erkennen – z. B. die Website zeigt v2.1.0, aber die GitHub-README verweist noch auf v2.0.0.
- Post-Rebranding-Prüfung: Nach der Umbenennung eines Produkts oder der Aktualisierung von Begriffen (z. B. von „plugin“ zu „extension“) prüfen, ob alle Dokumentationen, Zielseiten und Mitwirkungsleitfäden den neuen Begriff einheitlich verwenden.
- Onboarding-Review: Wenn ein neuer Mitwirkender auf verwirrende Dokumentationen stößt, eine Konsistenzprüfung ausführen, um widersprüchliche Funktionsbeschreibungen, veraltete Kontaktinformationen oder fehlende Abschnitte in den Dokumentationsquellen zu identifizieren.
Voraussetzungen
- Zugriff auf mindestens zwei Inhaltsquellen (Website, GitHub-Repository oder lokales Dokumentationsverzeichnis)
- WebFetch-Berechtigungen für entfernte URLs (bereitgestellte Seiten, GitHub-Rohinhalte) konfiguriert
- Lokale Dokumentation in erkennbaren Pfaden gespeichert (
docs/,claudes-docs/,internal/)
Anleitung
- Quellen entdecken – nach Build-Verzeichnissen (
dist/,build/,public/,out/,_site/), GitHub-README/CONTRIBUTING-Dateien und lokalen Dokumentationsordnern suchen:find . -maxdepth 3 -name "README*" -o -name "CONTRIBUTING*" | head -20 ls -d docs/ claudes-docs/ internal/ 2>/dev/null - Strukturierte Daten extrahieren aus jeder Quelle: Versionsnummern, Funktionsbeschreibungen, Produktnamen, Schlagzeilen, Kontaktinformationen, URLs und technische Anforderungen:
grep -rn 'v[0-9]\+\.[0-9]\+' docs/ README.md grep -rn -i 'features\|capabilities' docs/ README.md - Extraktion überprüfen – mindestens 3 Datenpunkte pro Quelle bestätigen. Falls eine Quelle leer bleibt, vor dem Fortfahren die Fehlerbehandlungstabelle prüfen.
- Vergleichsmatrix erstellen, die jede Quelle mit jeder anderen paarweise vergleicht (Website vs. GitHub, Website vs. lokale Dokumentation, GitHub vs. lokale Dokumentation):
diff <(grep -i 'version' README.md) <(grep -i 'version' docs/overview.md) - Abweichungen klassifizieren nach Schweregrad:
- Kritisch: widersprüchliche Versionsnummern, sich widersprechende Funktionslisten, nicht übereinstimmende Kontaktinformationen, defekte Querverweise
- Warnung: inkonsistente Terminologie (z. B. „plugin“ vs. „extension“), fehlende Informationen in einer Quelle, veraltete Daten
- Informativ: stilistische Unterschiede, plattformspezifische Formulierungen, unterschiedliche Detailtiefe
- Vertrauenspriorität anwenden: Website (maßgeblichste) > GitHub (entwicklerorientiert) > lokale Dokumentation (interne Nutzung).
- Bericht generieren als Markdown mit: Zusammenfassung, paarweisen Vergleichstabellen, Terminologie-Konsistenzmatrix und priorisierten Maßnahmen mit Dateipfaden und Zeilennummern.
- Speichern unter
consistency-reports/YYYY-MM-DD-HH-MM-SS.md.
Berichtsformat
# Konsistenzbericht — YYYY-MM-DD
## Zusammenfassung
| Schweregrad | Anzahl |
|-------------|--------|
| Kritisch | 2 |
| Warnung | 5 |
| Info | 3 |
## Website vs. GitHub
| Feld | Website | GitHub | Schweregrad |
|-------------|---------------|---------------|-------------|
| Version | v2.1.0 | v2.0.0 | Kritisch |
| Funktion X | aufgeführt | fehlend | Warnung |
## Maßnahmen
1. **Kritisch** — `README.md:14` Version von v2.0.0 → v2.1.0 aktualisieren
2. **Warnung** — „Funktion X“ zur Funktionsliste in `README.md` hinzufügen
Fehlerbehandlung
| Fehler | Ursache | Lösung |
|---|---|---|
| Website-Inhalt nicht erreichbar | URL gibt 4xx/5xx aus oder Build-Verzeichnis fehlt | Überprüfen, ob die Website bereitgestellt ist, oder lokalen Build ausführen; WebFetch-Berechtigungen prüfen |
| GitHub-API-Ratenlimit | Zu viele Abfragen in kurzer Zeit | Pause einlegen und nach dem Zurücksetzen des Fensters erneut versuchen; authentifizierte Anfragen verwenden |
| Kein Dokumentationsverzeichnis | Erwartete Pfade existieren nicht | Arbeitsverzeichnis bestätigen; Dokumentationspfad explizit angeben |
| Leere Extraktion | Client-seitiges Rendering für Fetch nicht sichtbar | Statt der Live-URL das lokale Build-Ausgabeverzeichnis verwenden |
| Diff-Befehl fehlgeschlagen | Dateipfade enthalten Sonderzeichen | Alle an diff und grep übergebenen Dateipfade in Anführungszeichen setzen |
Ressourcen
- Logik zur Quellenentdeckung:
${CLAUDE_SKILL_DIR}/references/how-it-works.md - Vertrauenspriorität und Validierungszeitpunkt:
${CLAUDE_SKILL_DIR}/references/best-practices.md - Anwendungsbeispiele:
${CLAUDE_SKILL_DIR}/references/example-use-cases.md