# documentation-engineer

Скилл для написания технической документации: README, описания API, комментарии к коду и архитектурные заметки. Пригодится, когда проект оброс кодом, а доки к нему нет.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 711 установок · ★ 84
- Автор: zhaono1
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/zhaono1/agent-playbook/tree/HEAD/skills/documentation-engineer/SKILL.md
- Обновлён: 2026-09-15
- HTML: https://affpapa.org/nevibecode/skills/documentation-engineer

## Что делает

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

Внутри есть скрипты на Python: `scripts/generate_docs.py` собирает структуру документации по имени сервиса, `scripts/validate_docs.py` проверяет готовый файл. Плюс справочники — шаблоны README и API, стайлгайд. Для работы нужен Python 3, потому что оба скрипта запускаются через `python3`.

Отдельная деталь — правило комментировать «почему», а не «что»: `count = 0` с пояснением про новый цикл измерений полезнее, чем пересказ самой строки. Скилл прописан под Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, так что один и тот же набор шаблонов переносится между редакторами.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill documentation-engineer -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill documentation-engineer -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill documentation-engineer -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install zhaono1/agent-playbook documentation-engineer
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill documentation-engineer -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/zhaono1/agent-playbook --path skills/documentation-engineer
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill documentation-engineer -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- напиши README для этого проекта
- задокументируй публичные функции в `src/api.ts`
- сгенерируй структуру документации для сервиса `billing`

## Похожие
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок
- [codebase-documenter](https://affpapa.org/nevibecode/skills/codebase-documenter.md) — скилл · 1500 установок
- [170-java-documentation](https://affpapa.org/nevibecode/skills/170-java-documentation.md) — скилл · 359 установок

Из того же набора: [zhaono1/agent-playbook](https://affpapa.org/nevibecode/by/zhaono1/agent-playbook.md) — 21 карточка

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

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