code-documentation · ilude — скилл для Claude Code
Скилл code-documentation для Claude Code учит ИИ-агента писать самодостаточный код и комментировать только причины решений. Используется при рефакторинге и документировании API.
лицензия не указана 4 установок ★ 8 обновлён 2025-12-30
npx skills add ilude/claude-code-config --skill code-documentation -a claude-codeЧто делает code-documentation
Скилл задаёт агенту правила про комментарии и документацию. Главная мысль одна: код должен читаться сам, а комментарий нужен там, где надо объяснить причину, а не пересказать строку. Дальше идёт разбор типичных провалов — очевидные комментарии, повторы кода, устаревшие заметки и закомментированный код с историей правок в файле.
Перед тем как что-то комментировать, агент проходит четыре шага: понятен ли код, спасёт ли переименование, объясняет ли заметка «почему», поможет ли она тому, кто откроет файл позже. Шаблоны docstring и JSDoc даны с примерами на Python и JavaScript/TypeScript: параметры, возвращаемое значение, исключения, пример вызова.
Внутри только текст правил, отдельных скриптов нет. Поэтому меняется то, что агент напишет, а не появится отчёт по готовому файлу. Запускать вручную ничего не нужно: скилл включается, когда в разговоре всплывают комментарии, docstring, JSDoc или документация API.
Какие задачи решает
- отбить у агента привычку комментировать каждую строку
- объяснить в коде, почему выбран такой расчёт
- оформить docstring для публичной функции
- вычистить из файла закомментированный код и заметки о правках
- договориться с командой, когда комментарий уместен
Примеры запросов агенту
- Разбери комментарии в
billing.py: где они повторяют код, а где объясняют причину. - Напиши docstring к
calculate_fee— с параметрами, возвращаемым значением и исключениями. - Добавь JSDoc к
loadProfileи опиши контракт функции.
Как установить code-documentation
1Через Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a claude-code2Вручную: положить файлы
~/.claude/skills/code-documentation/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/code-documentation/
1Через Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a codex2Вручную: положить файлы
.agents/skills/code-documentation/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a cursor2Вручную: положить файлы
.cursor/skills/code-documentation/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install ilude/claude-code-config skills/code-documentation2Вручную: положить файлы
.github/skills/code-documentation/SKILL.md1Через Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a gemini-cli2Командой платформы
gemini skills install https://github.com/ilude/claude-code-config --path skills/code-documentationВручную: положить файлы
.devin/skills/code-documentation/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о code-documentation
Как установить code-documentation в Claude Code?
Выполните npx skills add ilude/claude-code-config --skill code-documentation -a claude-code. Файл скилла появится по пути ~/.claude/skills/code-documentation/SKILL.md.
Что делает code-documentation?
Задаёт агенту правила про комментарии и документацию: объяснять в коде причины, а не пересказывать строки, и не плодить шум. Внутри разбор антипаттернов, схема решения из четырёх шагов и примеры docstring и JSDoc.
Когда скилл включается?
Сам, когда в разговоре появляются комментарии, docstring, JSDoc, документация API или вопросы про читаемость кода.
Похожие скиллы
Все скиллы по теме «Тексты и документация» →Сначала — code-documentation от других авторов.