# docs

Правило docs регламентирует структуру документации, шаблонов и спецификаций агентов. Следит за версионированием, ссылками по якорям и манифестом публикации.

- правило · `type=rule` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline · ★ 121 у репозитория
- Автор: yahor-punko
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/yahor-punko/mavericks-os/tree/HEAD/.claude/rules/docs.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/rules/docs

## Что делает

Правило задаёт жёсткие границы для файлов в `docs/`, `templates/`, `CLAUDE.md`, `.claude/agents/` и чейнджлогов. Оно запрещает встраивать текст документации напрямую в `CLAUDE.md`, требуя импорта через директиву `@path`. Документы разделены на три слоя: системный базовый слой 0, контекстный слой 1 по путям и архивный слой 2. Устаревший текст не исправляется постскриптумами, а переносится в `docs/archive/` без удаления истории.

При добавлении любых отслеживаемых файлов в репозиторий с `scripts/publish-manifest.json` правило обязывает классифицировать их статусом `ship` или `exclude`. Запрещено менять замороженные версии в `CHANGELOG.md`, уже опубликованные в публичном зеркале. Ссылки между живыми документами должны вестись строго по именованным якорям, а не по номерам строк. Номера строк быстро устаревают.

Без классификации нового файла в манифесте хук `.claude/hooks/pre-commit` полностью заблокирует коммит. Для спецификаций агентов обязательна проверка скриптом `scripts/test-agent-spec-sync.js`: имена моделей указываются только семействами, без номеров версий.

## Установка

### Claude Code (родная платформа)

**Вручную: положить файлы**
- Файл: `.claude/rules/docs.md` — Поле paths во frontmatter ограничивает файлы

### Codex

**AGENTS.md**
- Codex читает AGENTS.md: вставьте текст правила туда

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/rules/docs.mdc` — Во frontmatter: description, globs, alwaysApply

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/instructions/docs.instructions.md` — Поле applyTo задаёт, к каким файлам применять

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/rules/docs.md`

### Cline

**Вручную: положить файлы**
- Файл: `.clinerules/docs.md`

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/yahor-punko/mavericks-os/tree/HEAD/.claude/rules/docs.md

## Когда брать
- упорядочить хранение системной документации и шаблонов по слоям
- предотвратить коммит файлов без классификации в `scripts/publish-manifest.json`
- защитить опубликованные секции `CHANGELOG.md` от случайных правок
- сохранить точность перекрёстных ссылок с помощью именованных якорей

## Примеры запросов агенту
- Обнови `docs/core/ORCHESTRATION_RULES.md` и проверь перекрёстные ссылки на `docs/AGENT_SPEC.md`
- Зарегистрируй новый файл в `scripts/publish-manifest.json` со статусом exclude
- Перенеси устаревший раздел `CLAUDE.md` в `docs/archive/` по правилам архивации

## Похожие
- [docs-updater](https://affpapa.org/nevibecode/skills/docs-updater.md) — скилл · 3700 установок
- [docs-sync-audit](https://affpapa.org/nevibecode/skills/docs-sync-audit.md) — скилл · 68 установок
- [docs-sync](https://affpapa.org/nevibecode/commands/docs-sync.md) — команда · ★ 6091 у репозитория
- [skillshare-update-docs](https://affpapa.org/nevibecode/skills/skillshare-update-docs.md) — скилл · ★ 3269 у репозитория
- [update-docs](https://affpapa.org/nevibecode/skills/rerun-build-update-docs.md) — скилл · ★ 1120 у репозитория
- [oma-docs](https://affpapa.org/nevibecode/skills/oma-docs.md) — скилл · ★ 1472 у репозитория

Из того же набора: [yahor-punko/mavericks-os](https://affpapa.org/nevibecode/by/yahor-punko/mavericks-os.md) — 16 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
