К основному содержанию
скилл Claude Code CX Codex Cursor GitHub Copilot официальный · Anthropic

documentation — скилл для Claude Code: README, API-доки, ранбуки

Скилл для технического письма: собирает README, справочник по API, ранбук, архитектурный документ или гайд для новичков. Пригодится, когда код есть, а описания к нему нет.

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

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

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

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

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

Из того же набора89

Весь набор →
data-visualization официальный anthropics Подбирает подходящие типы графиков под структуру данных и генерирует код на Python с matplotlib, seaborn и plotly. Пригодится при подготовке отчётов. Claude Code CX Codex Cursor +1 13 700установок build-dashboard официальный anthropics Генерирует автономный HTML-дашборд с графиками Chart.js, карточками KPI и таблицами. Помогает быстро оформить результаты запроса или сырые данные в один файл для браузера. Claude Code CX Codex Cursor +1 9 100установок memory-management официальный anthropics Скилл раскладывает рабочие сокращения, имена и термины по файлам памяти, чтобы агент учитывал их в запросах. Пригодится для проектов с внутренним словарём и множеством контекстных деталей. Claude Code CX Codex Cursor +1 7 400установок task-management официальный anthropics Ведёт список задач в локальном файле TASKS.md и показывает интерактивный дашборд. Пригодится, чтобы фиксировать дедлайны и поручения прямо во время диалога с агентом. Claude Code CX Codex Cursor +1 7 200установок architecture официальный anthropics Помогает оформить Architecture Decision Record или разобрать чужой дизайн системы: варианты, компромиссы, последствия. Пригодится, когда выбираете между технологиями. Claude Code CX Codex Cursor +1 6 700установок knowledge-synthesis официальный anthropics Скилл объединяет результаты корпоративного поиска из чатов, почты и документов в один связный ответ. Убирает дубли, выставляет уровень доверия и сохраняет ссылки на источники. Claude Code CX Codex Cursor +1 6 400установок testing-strategy официальный anthropics Скилл помогает спроектировать стратегию тестирования и план проверок для проекта. Пригодится, когда нужно выбрать типы тестов и найти пробелы в покрытии. Claude Code CX Codex Cursor +1 6 400установок view-pdf официальный anthropics Открывает PDF в интерактивном просмотрщике и помогает размечать документ, заполнять формы и размещать подписи. Подходит для совместной работы по экрану. Claude Code CX Codex Cursor +1 6 300установок

Похожие

bmad-deep-recon bmad-code-org Скилл для глубокого ресёрча: готовит промпт, обрабатывает отчёт или сам собирает данные по теме и по вашему репозиторию. Claude Code CX Codex Cursor +1 11 200установок nature-paper-card Yuan1z0825 Собирает из одной научной статьи карточку глубокого чтения: методы, связь экспериментов с выводами, ограничения. Пригодится, когда нужно разобрать статью по частям, а не пересказать абстракт. Claude Code CX Codex Cursor +1 10 400установок bmad-customize bmad-code-org Скилл создаёт и обновляет переопределения для скиллов BMad. Он пригодится, когда нужно изменить поведение агента или отдельного рабочего процесса. Claude Code CX Codex Cursor +1 11 100установок agent-development официальный Anthropic Скилл объясняет, как создавать агентов для плагинов Claude Code: от условий запуска до системного промпта и набора инструментов. Пригодится, когда нужно добавить субагента в проект. Claude Code 7 353установок skill-development официальный Anthropic Помогает проектировать скиллы для плагинов Claude Code: от разбора примеров использования до структуры файлов и подсказок для агента. Пригодится, если вы создаёте скилл или правите существующий. Claude Code 7 219установок article-writing affaan-m Помогает писать статьи, гайды и рассылки в заданном авторском тоне. Пригодится для длинных текстов, когда важны структура и опора на факты. Claude Code CX Codex Cursor +1 5 200установок grill-with-docs Matt Pocock Скилл проводит жёсткое интервью по плану или дизайну и по ходу создаёт ADR и глоссарий. Подойдёт перед началом сложной разработки. Claude Code 1 219 756установок skill-creator официальный anthropics Помогает создать новый скилл, доработать существующий и проверить результат через тестовые промпты и оценки. Claude Code Claude.ai 414 180установок

Вопросы о 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

Смотрите также

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

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