# docs-style

Скилл docs-style задаёт правила редполитики для технической документации: выбор формата по Diataxis, активный залог и структура для людей и нейросетей.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 180 установок · ★ 89 у репозитория
- Автор: existential-birds
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-docs/skills/docs-style/SKILL.md
- Обновлён: 2026-09-15
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/docs-style

## Что делает

Скилл внедряет базовый стайлгайд для написания и ревью документации. Сначала он требует определить тип материала по системе Diataxis: туториал, инструкция, справочник или объяснение концепции. Смешивать эти типы в одном тексте руководство прямо запрещает, чтобы не путать читателя.

Внутри собраны требования к стилю: обращение на «вы» или «ты» во втором лице вместо обезличенных конструкций, активный залог, чистка канцелярита и однозначная терминология. Отдельный блок посвящён адаптации текста под языковые модели: обязательное перечисление предварительных требований (prerequisites), расшифровка аббревиатур при первом упоминании и самодостаточные примеры кода с импортами.

Параметр `user-invocable: false` указывает, что скилл не предназначен для прямого запуска пользователем как отдельная команда. Ассистент подтягивает эти правила автоматически при составлении или проверке текстов.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill docs-style -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill docs-style -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill docs-style -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install existential-birds/beagle plugins/beagle-docs/skills/docs-style
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill docs-style -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/existential-birds/beagle --path plugins/beagle-docs/skills/docs-style
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill docs-style -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-docs/skills/docs-style/SKILL.md

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

## Примеры запросов агенту
- Проверь этот черновик руководства по API на соответствие правилам документации
- Напиши инструкцию по настройке вебхуков с чётким списком предварительных требований
- Перепиши раздел с частыми ошибками короткими тезисами для быстрого сканирования

## Похожие
- [developer-docs-structure-audit](https://affpapa.org/nevibecode/skills/developer-docs-structure-audit.md) — скилл · 13700 установок
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [technical-writing](https://affpapa.org/nevibecode/skills/backnotprop-technical-writing.md) — скилл · 10700 установок
- [docs-writer](https://affpapa.org/nevibecode/skills/docs-writer.md) — скилл · ★ 7191 у репозитория
- [google-dev-docs](https://affpapa.org/nevibecode/skills/google-dev-docs.md) — скилл · ★ 57 у репозитория
- [documentation](https://affpapa.org/nevibecode/skills/mcollina-documentation.md) — скилл · 2000 установок

Из того же набора: [existential-birds/beagle](https://affpapa.org/nevibecode/by/existential-birds/beagle.md) — 68 карточек

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

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