# code-documentation

Скилл code-documentation для Claude Code учит ИИ-агента писать самодостаточный код и комментировать только причины решений. Используется при рефакторинге и документировании API.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 4 установки · ★ 8 у репозитория
- Автор: ilude
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/ilude/claude-code-config/tree/HEAD/skills/code-documentation/SKILL.md
- Обновлён: 2025-12-30
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/ilude-code-documentation

## Что делает

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

Перед тем как что-то комментировать, агент проходит четыре шага: понятен ли код, спасёт ли переименование, объясняет ли заметка «почему», поможет ли она тому, кто откроет файл позже. Шаблоны docstring и JSDoc даны с примерами на Python и JavaScript/TypeScript: параметры, возвращаемое значение, исключения, пример вызова.

Внутри только текст правил, отдельных скриптов нет. Поэтому меняется то, что агент напишет, а не появится отчёт по готовому файлу. Запускать вручную ничего не нужно: скилл включается, когда в разговоре всплывают комментарии, docstring, JSDoc или документация API.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install ilude/claude-code-config skills/code-documentation
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add ilude/claude-code-config --skill code-documentation -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Разбери комментарии в `billing.py`: где они повторяют код, а где объясняют причину.
- Напиши docstring к `calculate_fee` — с параметрами, возвращаемым значением и исключениями.
- Добавь JSDoc к `loadProfile` и опиши контракт функции.

## Похожие
- [lean-comments](https://affpapa.org/nevibecode/skills/lean-comments.md) — скилл · 17 установок
- [code-documenter](https://affpapa.org/nevibecode/skills/code-documenter.md) — скилл · 6200 установок
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [docs-guard](https://affpapa.org/nevibecode/skills/docs-guard.md) — скилл · 4200 установок
- [storybook-component-documentation](https://affpapa.org/nevibecode/skills/storybook-component-documentation.md) — скилл · 166 установок
- [jsdoc-typescript-docs](https://affpapa.org/nevibecode/skills/jsdoc-typescript-docs.md) — скилл · 572 установки

## Другие версии с тем же именем
- [code-documentation · bytedance](https://affpapa.org/nevibecode/skills/code-documentation.md) — 2000 установок
- [code-documentation · moizibnyousaf](https://affpapa.org/nevibecode/skills/moizibnyousaf-code-documentation.md) — 571 установка
- [code-documentation · aj-geddes](https://affpapa.org/nevibecode/skills/aj-geddes-code-documentation.md) — 502 установки

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