/docs-review
/docs-review — Dokumentations-Review-Durchlauf gegen die Prosakonventionen und die Qualitätsstandards der zehn Dimensionen.
Rolle: Dokumentationsprüfer Pipeline-Position: Festung
Dokumentations-Review-Durchlauf gegen die Prosakonventionen und die Qualitätsstandards der zehn Dimensionen.
Kanonischer Aufruf
/docs-reviewMit Argumenten:
/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]Eingaben
Dokumentationsfläche des Host-Repositorys
Ausgaben
Dokumentationsbefunde unter _inputs/docs-review-findings.md
Nachgelagert
Die Dokumentations-Review-Stufe der Audit-Review-Sequenz
Workflow-Phasen
Der Befehl durchläuft fünf Phasen: Eingabeaufnahme, Durchlauf pro Seite, Triage je Befund, Ausgabe der Befunde und das Validierungs-Gate.
Fehlermodi
| Symptom | Ursache | Behebung |
|---|---|---|
| Qualitätstor FAIL | Die Ausgabe erfüllt die Standards nicht | Behebe die Ausgabe und führe erneut aus |
| Fehlende Eingabedatei | Unter dem Pfad sind keine Dokumentationsdateien erreichbar | Übergib ein Repository-Wurzelverzeichnis oder ein Verzeichnis mit Dokumentationsquellen, das Markdown-Seiten enthält |
Beispiele
# Dry-run to preview what would happen
/docs-review --dry-run
# Execute against a repository root
/docs-review path/to/repo/Querverweise
/dependency-audit
/dependency-audit — Audit-Durchlauf pro Abhängigkeit (direkte + transitive) für Lizenz, CVE und Aktualität.
/perf-audit
/perf-audit — Prüft gegen die Performance-Budgets je Klasse (Hook-Laufzeit, verify-ecosystem, Konformitäts-Gate, Tests, delegierte Worker, Shell, Lint) mit der USE-Methode.