# reference-docs

Скилл reference-docs помогает писать справочные страницы для API и функций: таблицы параметров, возвращаемые значения, ошибки, запускаемые примеры.

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

## Что делает

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

Главный принцип — только описание. Никаких объяснений «зачем» и пошаговых инструкций: для этого есть другие типы документации, и скилл отсылает к `docs-style`. Проза заменяется таблицами, у похожих страниц одинаковый порядок разделов, в примерах стоят реалистичные значения вместо `foo` и `test@test.com`.

Вручную его не вызвать: во фронтматтере стоит `user-invocable: false`, так что скилл подхватывается, когда агент берётся за справочную страницу. Рассчитан он на пару с `docs-style`: внутри есть ссылка на `../docs-style/references/diataxis-compass.md`, и без установленного `docs-style` она не откроется.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

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

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- собрать таблицу параметров с типами и значениями по умолчанию
- описать возвращаемое значение функции и её ошибки
- привести примеры к одному формату на всех страницах
- заменить прозу таблицами, по которым быстро ищут
- документировать HTTP-эндпоинт с path-параметрами

## Примеры запросов агенту
- Напиши справочную страницу для функции `getUser`: таблица параметров, возвращаемое значение, запускаемый пример.
- Оформи API-референс для `GET /api/v1/users/{userId}` в том же порядке разделов, что и остальные страницы.
- Перепиши этот раздел как reference: убери объяснения, оставь таблицы и один полный пример.

## Похожие
- [docs-writer](https://affpapa.org/nevibecode/skills/docs-writer.md) — скилл · ★ 7191 у репозитория
- [google-dev-docs](https://affpapa.org/nevibecode/skills/google-dev-docs.md) — скилл · ★ 57 у репозитория
- [code-documentation-docs-architect](https://affpapa.org/nevibecode/agents/code-documentation-docs-architect.md) — субагент · ★ 42780 у репозитория
- [tech-docs-writer](https://affpapa.org/nevibecode/agents/tech-docs-writer.md) — субагент · ★ 1064 у репозитория
- [backend-to-frontend-handoff-docs](https://affpapa.org/nevibecode/skills/backend-to-frontend-handoff-docs.md) — скилл · 164 установки
- [absolute-docs](https://affpapa.org/nevibecode/skills/absolute-docs.md) — скилл · 171 установка

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

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

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