К основному содержанию
скилл CX Codex

code-documentation · ilude — скилл для Claude Code

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

лицензия не указана 4 установок ★ 8 обновлён 2025-12-30

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add ilude/claude-code-config --skill code-documentation -a claude-code
Открыть на GitHub

Что делает 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-code

2Вручную: положить файлы

~/.claude/skills/code-documentation/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/code-documentation/

По шагам, с командами для каждой платформы: Как установить скилл в 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 от других авторов.

code-documentation bytedance Скилл code-documentation для Claude Code анализирует исходный код и создаёт README, API-референс, архитектурную документацию и гайды разработчика. CX Codex +1 2 000установок code-documentation MoizIbnYousaf Скилл code-documentation задаёт структуру README, API-справки, комментариев и архитектурных заметок, чтобы агент писал документацию по одному шаблону. CX Codex +1 571установок code-documentation aj-geddes Скилл code-documentation для Claude Code пишет документацию по стандартам языка: JSDoc, Python docstrings, JavaDoc и встроенные комментарии. За один запрос документирует функции, классы, типы и API. CX Codex +1 502установок lean-comments официальный github Скилл lean-comments для GitHub Copilot, который держит комментарии в коде минимальными и осмысленными. Включается при добавлении, правке, ревизии или чистке комментариев, docstrings, TODO, FIXME и других пометок в исходниках. CX Codex +1 17установок code-documenter https://github.com/Jeffallan Скилл code-documenter создаёт и проверяет документацию к коду, API и руководства. Нужен при добавлении docstring, JSDoc или спецификации OpenAPI. CX Codex +1 6 200установок documentation-templates davila7 Скилл documentation-templates для Claude Code, который предоставляет структуру и шаблоны для README, API-документации, комментариев и других проектных записей. Помогает оформить документацию с нуля или привести её к единому стилю. CX Codex +1 305установок docs-guard amElnagdy Скилл docs-guard проверяет документацию, README и докстринги на соответствие коду проекта. Находит выдуманные сигнатуры и удаляет пустые формулировки. CX Codex +1 4 200установок storybook-component-documentation TheBushidoCollective Скилл storybook-component-documentation генерирует документацию компонентов в Storybook через autodocs, MDX-страницы и JSDoc-комментарии. Пригодится при создании или обновлении доков для UI-библиотек. CX Codex +1 166установок jsdoc-typescript-docs patricio0312rev Скилл jsdoc-typescript-docs для Claude Code расставляет JSDoc-комментарии в TypeScript-коде и собирает из них документацию через TypeDoc. Закрывает функции, интерфейсы и типы без описаний. CX Codex +1 572установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой