documentation — скилл для Claude Code: README, API-доки, ранбуки
Скилл для технического письма: собирает README, справочник по API, ранбук, архитектурный документ или гайд для новичков. Пригодится, когда код есть, а описания к нему нет.
npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-codeЧто делает documentation
Скилл задаёт структуру под каждый тип документа. Для README это краткая суть проекта и быстрый старт, для API — эндпоинты с примерами запросов и ответов, коды ошибок и лимиты, для ранбука — шаги процедуры и откат, для архитектурного документа — контекст, схема и принятые решения.
Внутри пять принципов: писать для читателя, выносить полезное в начало, показывать примерами, держать текст в актуальном состоянии и ссылаться на другие документы вместо копирования. Скилл срабатывает на фразы вроде «document this» или «create a README» — отдельной команды запускать не нужно.
Ограничение простое: скилл не проверяет ваш код и не знает, что уже описано в соседних файлах. Если документация разошлась с реальностью, он этого не заметит, поэтому перед генерацией стоит убедиться, что структура проекта и эндпоинты у вас под рукой.
Какие задачи решает
- написать README с быстрым стартом
- описать эндпоинты API с примерами запросов
- собрать ранбук с шагами отката
- задокументировать архитектуру и принятые решения
- сделать гайд по окружению для нового разработчика
Примеры запросов агенту
- document this модуль авторизации
- create a README для этого репозитория
- write a runbook для деплоя сервиса
Как установить documentation
1Через Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-code2Вручную: положить файлы
~/.claude/skills/documentation/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/documentation/
1Через Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a codex2Вручную: положить файлы
.agents/skills/documentation/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a cursor2Вручную: положить файлы
.cursor/skills/documentation/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install anthropics/knowledge-work-plugins documentation2Вручную: положить файлы
.github/skills/documentation/SKILL.md1Через Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a gemini-cli2Командой платформы
gemini skills install https://github.com/anthropics/knowledge-work-plugins --path engineering/skills/documentationВручную: положить файлы
.devin/skills/documentation/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
Из того же набора89
Весь набор →Похожие
Вопросы о documentation
Как установить documentation в Claude?
Выполните npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-code. После этого файл скилла появится по пути ~/.claude/skills/documentation/SKILL.md.
Что делает скилл documentation?
Помогает писать и поддерживать техническую документацию: README, справочник по API, ранбуки, архитектурные документы и гайды для онбординга.
На каких платформах работает documentation?
Кроме Claude есть установка для Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Для GitHub Copilot команда другая: gh skill install anthropics/knowledge-work-plugins documentation.
Исходный текст
SKILL.md · Apache-2.0
--- name: documentation description: Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks. --- # Technical Documentation Write clear, maintainable technical documentation for different audiences and purposes. ## Document Types ### README - What this is and why it exists - Quick start (< 5 minutes to first success) - Configuration and usage - Contributing guide ### API Documentation - Endpoint reference with request/response examples - Authentication and error codes - Rate limits and pagination - SDK examples ### Runbook - When to use this runbook - Prerequisites and access needed - Step-by-step procedure - Rollback steps - Escalation path ### Architecture Doc - Context and goals - High-level design with diagrams - Key decisions and trade-offs - Data flow and integration points ### Onboarding Guide - Environment setup - Key systems and how they connect - Common tasks with walkthroughs - Who to ask for what ## Principles 1. **Write for the reader** — Who is reading this and what do they need? 2. **Start with the most useful information** — Don't bury the lede 3. **Show, don't tell** — Code examples, commands, screenshots 4. **Keep it current** — Outdated docs are worse than no docs 5. **Link, don't duplicate** — Reference other docs instead of copying
© anthropics · Apache-2.0 · anthropics/knowledge-work-plugins