# documentation-standards

Скилл documentation-standards задаёт правила оформления Markdown для чтения моделями и экспорта в PDF через Pandoc. Спасает от поломанной нумерации глав и хаоса в структуре.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 161 установка · ★ 3 у репозитория
- Автор: terrylica
- Лицензия: MIT · policy=mirror · лицензия открытая, файл — в исходнике
- Исходник: https://github.com/terrylica/cc-skills/tree/HEAD/plugins/doc-tools/skills/documentation-standards/SKILL.md
- Обновлён: 2026-10-25
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/terrylica-documentation-standards

## Что делает

Скилл внедряет строгие правила разметки документации в репозитории. Главный запрет касается ручной нумерации заголовков вроде `## 1. Введение`. Pandoc при вызове с флагом `--number-sections` нумерует разделы сам. Если проставить цифры руками, в итоговом документе получится `1. 1. Введение`. Скилл требует опираться только на уровни заголовков `##` и `###`.

Архитектура опирается на принцип hub-and-spoke. Центральный документ `CLAUDE.md` содержит базовые ориентиры, а подробности выносятся в отдельные файлы каталогов `references/` или `skills/`. При этом машиночитаемые спецификации OpenAPI 3.1.1 и схемы JSON Schema имеют приоритет перед текстовыми описаниями: человек читает Markdown, который ссылается на канонический контракт в YAML.

Для проверки разметки агенту разрешены только три инструмента: `Read`, `Glob` и `Grep`. Без установленного Pandoc в системе скомпилировать сам PDF не выйдет, но скилл отвечает именно за чистоту разметки исходников перед сборкой.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add terrylica/cc-skills --skill documentation-standards -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/documentation-standards/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/documentation-standards/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add terrylica/cc-skills --skill documentation-standards -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/documentation-standards/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add terrylica/cc-skills --skill documentation-standards -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/documentation-standards/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install terrylica/cc-skills plugins/doc-tools/skills/documentation-standards
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/documentation-standards/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add terrylica/cc-skills --skill documentation-standards -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/terrylica/cc-skills --path plugins/doc-tools/skills/documentation-standards
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/documentation-standards/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add terrylica/cc-skills --skill documentation-standards -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/terrylica/cc-skills/tree/HEAD/plugins/doc-tools/skills/documentation-standards/SKILL.md

## Когда брать
- исключить дублирование номеров разделов при компиляции PDF через Pandoc
- разделить документацию на центральный хаб и детальные справочники
- привязать пояснительный Markdown к спецификациям OpenAPI 3.1.1 и JSON Schema
- проверить разметку на наличие языковых тегов у блоков кода и формат ссылок

## Примеры запросов агенту
- Проверь `docs/guide.md` по правилам documentation-standards перед экспортом в PDF.
- Оформи документацию нового модуля по схеме hub-and-spoke с ссылками на спецификацию OpenAPI.
- Убери ручную нумерацию глав в `README.md`, чтобы подготовить файл к сборке через Pandoc.

## Похожие
- [documentation-tools](https://affpapa.org/nevibecode/plugins/documentation-tools.md) — плагин · ★ 96 у репозитория
- [Technical Documentation taste](https://affpapa.org/nevibecode/prompts/technical-documentation-taste.md) — промпт · ★ 178201 у репозитория
- [academic-writing-standards](https://affpapa.org/nevibecode/skills/academic-writing-standards.md) — скилл · 130 установок
- [translate-book](https://affpapa.org/nevibecode/skills/translate-book.md) — скилл · 2100 установок
- [whitepaper](https://affpapa.org/nevibecode/skills/whitepaper.md) — скилл · 1600 установок
- [doc-to-markdown](https://affpapa.org/nevibecode/skills/doc-to-markdown.md) — скилл · 945 установок

## Другие версии с тем же именем
- [documentation-standards · pr-pm](https://affpapa.org/nevibecode/skills/documentation-standards.md) — 1 установка

Из того же набора: [terrylica/cc-skills](https://affpapa.org/nevibecode/by/terrylica/cc-skills.md) — 79 карточек

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