| name | onboard |
| description | Поднять первичный канон документации существующего проекта при переходе на Огород — из артефактов и кода, человек-SME последним. Используй, когда проект уже есть (легаси, brownfield), а доки по канону нет; триггеры — «заведи проект X по существующему репозиторию», «onboard», «собери доку по проекту». |
| user_invocable | true |
onboard
Brownfield-вход: проект уже существует (код, заметки, тикеты), но канона документации Огорода нет. onboard собирает первичный канон из того, что уже зафиксировано, а не выдумывает. Самодостаточно: можно дать любому агенту.
Отличие от наивной «ИИ-генерации доки»: APC задаёт честную границу — документ существует только при ясных Audience и Purpose, а догадка помечается как догадка. Агент не выдаёт предположение за факт.
Шаг 0 — прочитай правила и канон
Прочитай в корне vault: _rules.md (методология), docs/doc-canon.md (какие документы обязательны по зрелости проекта и карта APC), docs/styleguide.md (как писать — без воды, под агента). Канон, который ты собираешь, — это то, что описано в doc-canon.md.
Принцип: приоритет источников (Collaboration из APC)
Собирай знание строго в этом порядке — раньше по списку важнее:
- Артефакты проекта — ТЗ, заметки встреч, тикеты, переписки, старые доки, дизайны, README. Отсюда: Purpose (зачем продукт), Audience (для кого), требования, принятые решения, домен-термины.
- Код — стек, структура, точки входа, скрипты, CI, зависимости, модели данных. Отсюда: архитектура, команды, reference.
- Человек-SME — последним, только чтобы закрыть пробелы и развести противоречия между артефактами и кодом. Не начинай с интервью: сначала вытяни всё, что уже записано, чтобы не тратить время человека на известное.
Всё сгенерированное помечается «> ⚠️ черновик — проверь» (гейт «как проверено» из _rules.md). Чего не нашёл в источниках — не придумывай: оставь явный пробел > TODO(SME): <вопрос> и собери такие вопросы для человека.
Шаги
- Определи зрелость проекта (
status: идея / разработка / прод) — от неё зависит, какие документы канон требует (см. doc-canon.md; с проекта-идеи runbook не требуется).
- Просканируй артефакты. Собери всё, что дал пользователь или лежит в репо/папке (ТЗ, заметки, тикеты, старые доки, дизайны). Извлеки: Purpose, Audience, требования, решения, термины. Конфликты между источниками — фиксируй, не сглаживай.
- Просканируй код (язык-нейтрально, v1): манифест зависимостей (
package.json/pyproject/go.mod/…) → стек и команды; скрипты и CI-конфиг → команды сборки/тестов/деплоя для AGENTS.md; структура каталогов и точки входа → архитектура; публичные API/экспорты и зависимости → reference. Не парси глубоко — собери карту, не пересказ кода.
- Собери первичный канон под
status проекта, по карте doc-canon.md: карточка проекта (Суть/ЦА/боль/Видение из артефактов), AGENTS.md (контракт: команды/структура/конвенции из кода), docs/architecture.md (стек/модули/потоки), при наличии прода — docs/ запуск-и-деплой (из CI/скриптов, помечен как требующий проверки), CHANGELOG (стартовая запись). Каждый документ — по APC: нет ясных Audience и Purpose → документ не пишется.
- Пометь черновики. Всё, что выведено, а не подтверждено, — «черновик, проверь». Каждый документ начинается с такой пометки, пока техписатель/человек не снял её.
- Собери вопросы для SME (последним): пробелы (
TODO(SME)) и противоречия между артефактами и кодом — единым списком в карточку проекта (раздел «Вопросы»/«Пробелы онбординга»), не в чат. Человек отвечает — ты дополняешь канон и снимаешь пометки «черновик».
- Заведи проект в vault (если ещё нет): папка
projects/<slug>/, карточка, roadmap.md, tasks/. Найденные дыры и доделки канона — задачами через backlog. Передай канон техписателю на доводку (роль из roles.md).
Границы v1
- Авто-сканирование кода — язык-нейтральное: манифесты, CI/скрипты, структура каталогов, точки входа. Без языково-специфичных парсеров (доводятся по мере спроса).
onboard поднимает первичный канон-черновик, а не финальную доку: его задача — снять «с чего начать», дальше работает обычный цикл (техписатель, инкрементальное ведение по doc-canon.md).
Самопроверка
