| name | documentation-discipline |
| description | Дисциплина документации: только относительные пути, синхронизация ссылок через grep, doc-before-code, закрытые спринты не трогаем, источник истины — код. |
Skill: documentation-discipline
Правила работы с документацией проекта. Источник истины — _docs/instructions.md §9 и _board/process.md §8.
Когда использовать
- Меняешь поведение системы — нужно обновить профильный документ в
_docs/ до или вместе с кодовым коммитом.
- Правишь
_docs/, _board/, README.md, .env.example, app/prompts/, app/skills/, .agents/.
- Переименовываешь или переносишь файл либо раздел — нужно поправить ссылки.
Не использовать для правок кода без изменения поведения (рефакторинг, не добавляющий новых фактов в документацию).
Алгоритм
- Только относительные пути. Запрещены абсолютные пути ФС (
/home/..., /Users/..., C:\...). Все ссылки — от корня проекта (_docs/..., app/..., ./architecture.md).
- Язык — по §1 (
_docs/instructions.md): по умолчанию русский; технические идентификаторы (имена модулей, функций, env, путей) — латиницей.
- Doc-before-code. Поведение сначала описывается в профильном документе (
requirements.md / commands.md / agent-loop.md / tools.md / memory.md / skills.md), затем меняется код. Кодовый коммит, меняющий поведение, без обновления документации не принимается (§9; _board/process.md §8).
- Синхронизация ссылок. При переименовании/удалении файла или смене номера/названия раздела —
grep -rn по репозиторию и починить все живые ссылки.
- Закрытые спринты — архив. Файлы
_board/sprints/<NN>-*.md со статусом Closed не трогаем (_board/process.md §2 п.5).
- Источник истины — код. При расхождении документ приводится к коду отдельным
docs(...)-коммитом.
Чего избегать
- Абсолютных путей ФС в любой документации.
- «Висячих» ссылок после переименования — всегда проверяй
grep -rn.
- Правок закрытых спринтов.
- Кодового коммита, меняющего поведение, без обновления документации.
