Skip to content
Apothem
Command pipeline

/docs-review

/docs-review — Documentation review pass against prose-conventions and ten-dimension quality standards.

Role: Docs reviewer Pipeline position: fortress

Documentation review pass against prose-conventions and ten-dimension quality standards.

Canonical invocation

/docs-review

With arguments:

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

Inputs

Host repository documentation surface

Outputs

Docs findings + REPORT.md

Downstream

The documentation-review stage of the Audit Review Sequence

Workflow phases

The command follows the standard /plan pipeline workflow:

  1. Load context — Read plan suite, rules, and Resumption Contract.
  2. Verify prerequisites — Confirm dependency phases complete.
  3. Execute tasks — Perform the command mission.
  4. Verify outputs — Confirm all declared outputs exist and pass quality gates.
  5. Update PROGRESS.md — Record verified outputs in the Phase Output Registry.
  6. Emit REPORT.md — Pre-emission gate release proof recorded.

Failure modes

SymptomCauseRecovery
Prerequisite incompleteDependent phase not finishedComplete upstream phase first
Quality gate FAILOutput does not meet standardsFix the output and re-run
Missing input filePlan suite file absentRun /plan-generate to create it

Examples

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

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

Cross-references

On this page