Skip to content
Apothem
Команды конвейера

/docs-review

/docs-review — Проход обзора документации относительно соглашений по прозе и стандартов качества из десяти измерений.

Роль: Рецензент документации Позиция в пайплайне: крепость

Проход обзора документации относительно соглашений по прозе и стандартов качества из десяти измерений.

Каноническое обращение

/docs-review

С аргументами:

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

Входы

Поверхность документации хост-репозитория

Выходы

Находки документации + REPORT.md

Ниже по потоку

Стадия обзора документации Последовательности рецензирования аудита

Фазы рабочего процесса

Команда следует стандартному рабочему процессу пайплайна /plan:

  1. Загрузить контекст — Читает набор плана, правила и Контракт возобновления.
  2. Проверить предпосылки — Подтверждает, что фазы-зависимости завершены.
  3. Выполнить задачи — Исполняет миссию команды.
  4. Верифицировать выходы — Подтверждает, что все объявленные выходы существуют и проходят ворота качества.
  5. Обновить PROGRESS.md — Записывает верифицированные выходы в Реестр выходов фазы.
  6. Выпустить REPORT.md — Записывается доказательство релиза ворот пред-эмиссии.

Режимы отказа

СимптомПричинаВосстановление
Предпосылка не выполненаЗависимая фаза не завершенаСначала завершите фазу выше по потоку
Ворота качества FAILВыход не соответствует стандартамИсправьте выход и перезапустите
Отсутствует входной файлФайл набора плана отсутствуетВыполните /plan-generate, чтобы создать его

Примеры

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

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

Перекрёстные ссылки

On this page