# make-documentation

Скилл помогает писать README, архитектурные заметки, changelog, runbook и install-документацию. Он выбирает подходящий процесс и проверяет результат.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1500 установок · ★ 1
- Автор: Callicrate
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/Callicrate/skills/tree/HEAD/make-documentation/SKILL.md
- Обновлён: 2026-06-24
- HTML: https://affpapa.org/nevibecode/skills/make-documentation

## Что делает

Скилл создаёт и обновляет README, заметки об архитектуре, changelog, release notes, runbook, документацию установки, статьи о безопасности и материалы для notebook. Он также работает с инструкциями для агентов и AI-readable workflow docs. Для API-документации и `AGENTS.md` он не предназначен.

Перед крупной правкой или переносом документации скилл запускает `scripts/audit_documentation.py`, затем выбирает руководство по типу документа: от `references/guide-readme.md` до `references/guide-changelog.md`. Для notebook он сверяет исполняемые ячейки, импорты, виджеты, SQL, конфигурации и результаты. Завершает работу проверкой по `references/review-checklist.md`. Диаграммы он создаёт только по явному запросу или при наличии такой практики в проекте. Это значит, что для API docs, `AGENTS.md` и диаграмм по умолчанию нужен другой маршрут.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Callicrate/skills make-documentation
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a opencode
```

### Claude.ai

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

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

## Когда брать
- написать README для проекта
- проверить структуру существующей документации
- собрать runbook для локальной или Docker-установки
- обновить changelog и release notes
- описать notebook с опорой на исполняемые ячейки

## Примеры запросов агенту
- Напиши README для проекта и сначала проверь структуру документации.
- Обнови `CHANGELOG.md`, выбери подходящий процесс и проверь результат по чек-листу.
- Подготовь runbook для установки в Docker, сверяясь с файлами проекта.

## Похожие
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [docs-updater](https://affpapa.org/nevibecode/skills/docs-updater.md) — скилл · 3500 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/code-documentation.md) — скилл · 1900 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок
- [documentation-engineer](https://affpapa.org/nevibecode/skills/documentation-engineer.md) — скилл · 711 установок

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