Skip to content
Apothem
Comandos del pipeline

/docs-review

/docs-review — Pasada de revisión de documentación frente a las convenciones de prosa y los estándares de calidad de diez dimensiones.

Rol: Revisor de documentación Posición en el pipeline: fortaleza

Pasada de revisión de documentación frente a las convenciones de prosa y los estándares de calidad de diez dimensiones.

Invocación canónica

/docs-review

Con argumentos:

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

Entradas

Superficie de documentación del repositorio anfitrión

Salidas

Hallazgos de documentación + REPORT.md

Aguas abajo

La etapa de revisión de documentación de la Secuencia de Revisión de Auditoría

Fases del flujo de trabajo

El comando sigue el flujo de trabajo estándar del pipeline /plan:

  1. Cargar contexto — Lee la suite de plan, las reglas y el Contrato de Reanudación.
  2. Verificar prerrequisitos — Confirma que las fases de dependencia están completas.
  3. Ejecutar tareas — Cumple la misión del comando.
  4. Verificar salidas — Confirma que todas las salidas declaradas existen y pasan las compuertas de calidad.
  5. Actualizar PROGRESS.md — Registra las salidas verificadas en el Registro de Salidas de Fase.
  6. Emitir REPORT.md — Queda registrada la prueba de liberación de la compuerta de pre-emisión.

Modos de fallo

SíntomaCausaRecuperación
Prerrequisito incompletoFase dependiente no terminadaCompleta primero la fase aguas arriba
Compuerta de calidad FAILLa salida no cumple los estándaresCorrige la salida y reejecuta
Falta un archivo de entradaArchivo de la suite de plan ausenteEjecuta /plan-generate para crearlo

Ejemplos

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

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

Referencias cruzadas

On this page