documentation-templates — скилл для Claude Code: документация
Скилл даёт структуру и шаблоны для README, API-документации, комментариев и других проектных записей. Пригодится, когда нужно оформить документацию с нуля или привести её к общему виду.
npx claude-code-templates@latest --skill document-processing/documentation-templatesЧто делает documentation-templates
Внутри есть шаблоны для README, описания API-эндпоинтов, комментариев JSDoc/TSDoc, changelog и ADR. Для README предложены разделы от краткого описания и быстрого старта до конфигурации и лицензии; в API-шаблоне предусмотрены параметры, ответы и пример запроса. Скилл также описывает, когда комментарий объясняет важную логику, а когда лишь повторяет очевидное из кода.
Отдельный раздел посвящён материалам для AI-инструментов: структуре llms.txt и подготовке документации для RAG-индексации. В рекомендациях есть иерархия заголовков, примеры JSON/YAML, диаграммы Mermaid и самостоятельные разделы. Шаблоны служат основой, которую нужно подстроить под проект. Для работы с файлами скиллу разрешены Read, Glob и Grep, поэтому он ориентирован на чтение и поиск, а не на инструменты записи.
Какие задачи решает
- составить README с разделами для запуска и конфигурации
- описать API-эндпоинт с параметрами и вариантами ответа
- добавить комментарии к сложной логике и контрактам API
- оформить changelog или запись ADR
- подготовить документацию к AI-поиску и RAG-индексации
Примеры запросов агенту
- Составь структуру README для этого проекта по шаблону скилла.
- Оформи документацию для API-эндпоинтов: добавь параметры, ответы и примеры.
- Проверь комментарии в коде и предложи, где нужно объяснить логику, а где комментарии лишние.
Как установить documentation-templates
1Через claude-code-templates
npx claude-code-templates@latest --skill document-processing/documentation-templates2Через Skills CLI (Vercel)
npx skills add davila7/claude-code-templates --skill documentation-templates -a claude-code3Вручную: положить файлы
~/.claude/skills/documentation-templates/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/documentation-templates/
Вручную: положить файлы
.agents/skills/documentation-templates/SKILL.mdДля всех проектов — ~/.agents/skills/
Вручную: положить файлы
.cursor/skills/documentation-templates/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install davila7/claude-code-templates documentation-templates2Вручную: положить файлы
.github/skills/documentation-templates/SKILL.mdКомандой платформы
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/document-processing/documentation-templatesВручную: положить файлы
.devin/skills/documentation-templates/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о documentation-templates
Как установить documentation-templates в Claude Code?
Выполните npx claude-code-templates@latest --skill document-processing/documentation-templates. Это один из способов установки скилла.
Что делает documentation-templates?
Предлагает структуры и заготовки для README, API-документации, комментариев JSDoc/TSDoc, changelog и ADR. Также содержит рекомендации для llms.txt и документов, предназначенных для RAG-индексации.
Какие инструменты доступны скиллу в Claude Code?
Скиллу разрешены Read, Glob и Grep. Это инструменты чтения и поиска по файлам, поэтому доступ к записи в этом списке не предусмотрен.
