# api-documentation

Набор правил, по которым агент пишет докстринги, JSDoc, Godoc и описания эндпоинтов. Пригодится, когда API документируют в нескольких агентах и текст расползается.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 379 установок · ★ 78
- Автор: bobmatnyc
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/bobmatnyc/claude-mpm-skills/tree/HEAD/universal/web/api-documentation/SKILL.md
- Обновлён: 2026-07-18
- HTML: https://affpapa.org/nevibecode/skills/bobmatnyc-api-documentation

## Что делает

Скилл задаёт пять принципов: объяснять зачем, а не только что; держать документацию рядом с кодом; описывать контракт, а не реализацию; давать примеры; обновлять доки вместе с кодом. Дальше идут готовые образцы под конкретные языки и форматы — Python-докстринги, JSDoc, Godoc, OpenAPI, GraphQL SDL, описание класса с примером вызова.

Внутри только текст с примерами. Никаких скриптов и внешних вызовов, ставить нечего кроме самого файла скилла. Автор заявляет, что это убирает примерно 100–150 строк одинаковых указаний по документации в каждом агенте — если у вас несколько агентов дублируют одни и те же требования к докам, это повод проверить, не пора ли свести их в один скилл.

Скилл помечен как `user-invocable: false` и `disable-model-invocation: true`, то есть вызвать его вручную слэш-командой не получится: он подхватывается как справочный материал, когда агент пишет или правит документацию. Примеры в файле построены вокруг функции расчёта скидки, так что за основу берите структуру разделов, а не сам код.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bobmatnyc/claude-mpm-skills --skill api-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bobmatnyc/claude-mpm-skills --skill api-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install bobmatnyc/claude-mpm-skills api-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bobmatnyc/claude-mpm-skills --skill api-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/bobmatnyc/claude-mpm-skills --path universal/web/api-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add bobmatnyc/claude-mpm-skills --skill api-documentation -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Задокументируй функцию `calculate_discount` по образцу из скилла api-documentation: аргументы, возврат, исключения, примеры.
- Опиши эндпоинт `GET /users/{userId}` в OpenAPI 3.0 с ответами 200, 404 и 401.
- Добавь к классу `UserManager` докстринг с примером вызова и разделом про потокобезопасность.

## Похожие
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 494 установки
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [api-recon-and-docs](https://affpapa.org/nevibecode/skills/api-recon-and-docs.md) — скилл · 3800 установок
- [api-documenter](https://affpapa.org/nevibecode/skills/api-documenter.md) — скилл · 717 установок
- [spring-boot-openapi-documentation](https://affpapa.org/nevibecode/skills/spring-boot-openapi-documentation.md) — скилл · 4000 установок
- [documentation-engineer](https://affpapa.org/nevibecode/agents/documentation-engineer.md) — субагент · 735 установок

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

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

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