Skip to content
Apothem
Pipeline-Befehle

/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-review

Mit Argumenten:

/docs-review [path/to/plan-suite/] [phase-id] [--dry-run]

Eingaben

Dokumentationsfläche des Host-Repositorys

Ausgaben

Dokumentationsbefunde + REPORT.md

Nachgelagert

Die Dokumentations-Review-Stufe der Audit-Prüfsequenz

Workflow-Phasen

Der Befehl folgt dem standardmäßigen /plan-Pipeline-Workflow:

  1. Kontext laden — Liest die Plan-Suite, die Regeln und den Wiederaufnahme-Vertrag.
  2. Voraussetzungen prüfen — Bestätigt, dass die Abhängigkeitsphasen abgeschlossen sind.
  3. Aufgaben ausführen — Erfüllt die Mission des Befehls.
  4. Ausgaben verifizieren — Bestätigt, dass alle deklarierten Ausgaben existieren und die Qualitätstore bestehen.
  5. PROGRESS.md aktualisieren — Verzeichnet die verifizierten Ausgaben im Phasen-Ausgaberegister.
  6. REPORT.md ausgeben — Der Freigabenachweis des Pre-Emission-Tors wird verzeichnet.

Fehlermodi

SymptomUrsacheBehebung
Voraussetzung unvollständigAbhängige Phase nicht abgeschlossenSchließe zuerst die vorgelagerte Phase ab
Qualitätstor FAILDie Ausgabe erfüllt die Standards nichtBehebe die Ausgabe und führe erneut aus
Fehlende EingabedateiPlan-Suite-Datei fehltFühre /plan-generate aus, um sie zu erstellen

Beispiele

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a named plan suite
/docs-review path/to/plan-suite/

Querverweise

On this page