# documentation-standards

Скилл documentation-standards задаёт правила структуры документации: разделяет внутренние инструкции для контрибьюторов, пользовательские руководства в docs/ и скиллы в .claude/skills/.

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

## Что делает

Скилл регламентирует раскладку документации в репозитории PRPM. Внутренние руководства разработчиков по CI/CD, сборкам и Docker отправляются в `development/docs/`, материалы для пользователей и справочники CLI — в каталог `docs/`, а файлы первого знакомства (`README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`) остаются в корне проекта.

Для markdown-файлов установлены чёткие требования: названия в kebab-case, оглавление при объёме более 200 строк и относительные пути в ссылках. Для проверки синтаксиса и битых ссылок используются `markdownlint` и `markdown-link-check`.

Скилл жёстко привязан к структуре каталогов PRPM, поэтому перенос в другой проект потребует адаптации путей.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pr-pm/prpm --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 pr-pm/prpm --skill documentation-standards -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pr-pm/prpm --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 pr-pm/prpm .claude/skills/documentation-standards
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/pr-pm/prpm --path .claude/skills/documentation-standards
```

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- разложить внутренние и пользовательские инструкции по нужным папкам репозитория
- проверить синтаксис markdown и относительные ссылки через линтеры
- структурировать длинные документы с оглавлением и примерами кода
- перенести файлы по чек-листу миграции без поломки связей

## Примеры запросов агенту
- Куда положить инструкцию по настройке Docker для разработчиков?
- Оформи структуру нового пользовательского гайда по стандартам проекта
- Проверь markdown-документ длиннее 200 строк на соответствие правилам

## Похожие
- [markdown](https://affpapa.org/nevibecode/rules/microsoft-markdown.md) — правило · ★ 1627 у репозитория
- [documentation-and-adrs](https://affpapa.org/nevibecode/skills/documentation-and-adrs.md) — скилл · 80700 установок
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [oo-component-documentation](https://affpapa.org/nevibecode/skills/oo-component-documentation.md) — скилл · 1800 установок
- [catalog-documentation-creator](https://affpapa.org/nevibecode/skills/catalog-documentation-creator.md) — скилл · 1400 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок

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

Из того же набора: [pr-pm/prpm](https://affpapa.org/nevibecode/by/pr-pm/prpm.md) — 3 карточки

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

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