Skip to content
Apothem
Perintah pipeline

/docs-review

/docs-review — Pass tinjauan dokumentasi terhadap konvensi prosa dan standar kualitas sepuluh dimensi.

Peran: Peninjau dokumentasi Posisi pipeline: benteng

Pass tinjauan dokumentasi terhadap konvensi prosa dan standar kualitas sepuluh dimensi.

Pemanggilan kanonik

/docs-review

Dengan argumen:

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

Masukan

Permukaan dokumentasi repositori host

Keluaran

Temuan dokumentasi + REPORT.md

Hilir

Tahap tinjauan dokumentasi dari Urutan Tinjauan Audit

Fase alur kerja

Perintah ini mengikuti alur kerja pipeline /plan standar:

  1. Memuat konteks — Membaca suite plan, aturan, dan Kontrak Pelanjutan.
  2. Memverifikasi prasyarat — Memastikan fase dependensi telah selesai.
  3. Mengeksekusi tugas — Menjalankan misi perintah.
  4. Memverifikasi keluaran — Memastikan semua keluaran yang dideklarasikan ada dan lulus gerbang kualitas.
  5. Memperbarui PROGRESS.md — Mencatat keluaran terverifikasi di Registri Keluaran Fase.
  6. Memancarkan REPORT.md — Bukti rilis gerbang pra-emisi dicatat.

Mode kegagalan

GejalaPenyebabPemulihan
Prasyarat tidak lengkapFase dependen belum selesaiSelesaikan dulu fase hulu
Gerbang kualitas FAILKeluaran tidak memenuhi standarPerbaiki keluaran dan jalankan ulang
File masukan hilangFile suite plan tidak adaJalankan /plan-generate untuk membuatnya

Contoh

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

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

Referensi silang

On this page