Документировщик кода
Документирует код и API: docstring, OpenAPI/Swagger, JSDoc и сайты документации на Docusaurus. Генерирует отчёты о покрытии документацией.
Ставится на компьютере
С телефона скилл не поставить: Claude Code работает на Windows, macOS и Linux. Отправьте ссылку себе и откройте её на компьютере.
Способ установки
Откройте Терминал и вставьте команду:
curl -fsSL https:/ / claudeskills.ru/ install/ code-documenter | bashСкилл ляжет в папку ~/.claude/skills/code-documenter/. Если Claude Code уже открыт, а папки skills раньше не было, наберите в нём /reload-skills. Посмотреть скрипт
Карточка
code-documenter- Jeffallan
- на английском, задачу ставите по-русски
- SKILL.md
- references/ · 8 файлов
Похожие скиллы
- РазработкаСпециалист по защите кода
Для разработчиков: защита кода от уязвимостей и взломов
secure-code-guardian· Jeffallan - РазработкаСовместное редактирование документов
Для авторов: совместное создание docs с этапами сбора контекста, структурирования и тестирования
doc-coauthoring· anthropics - РазработкаРевьюер кода
Для ревью pull request, проверки качества кода и поиска уязвимостей.
code-reviewer· Jeffallan - РазработкаРевью кода по стандартам и ТЗ
Ревью изменений по двум осям: соблюдены ли стандарты репозитория и сделано ли то, что просили в задаче.
code-review· mattpocock - РазработкаКак принимать код-ревью
Перед внесением правок по ревью кода, особенно если комментарии непонятны
receiving-code-review· obra - РазработкаДопрос плана с документацией
Жёсткое интервью по плану или дизайну, по ходу которого Claude пишет глоссарий и ADR.
grill-with-docs· mattpocock
Статьи по теме
- 10 приёмов Claude Code, которые экономят часы работыCLAUDE.md, Plan Mode, MCP-серверы, worktrees, хуки и скиллы — продвинутые приёмы Claude Code для тех, кто хочет работать быстрее.
- Что такое Claude Skills и зачем они нужныClaude Skills — модульные навыки для ИИ-ассистента Claude. Узнайте, что это, как установить, создать свой skill и использовать в Claude Code. Примеры и инструкции.
- Настройка скиллов Claude: как устроен SKILL.md и где хранить скиллыНастройка скиллов Claude: из чего состоит SKILL.md, куда класть папку, как написать description и проверить, что скилл срабатывает. CLAUDE.md — отдельно.
Текст инструкции · SKILL.md
Оригинал инструкции (англ.)
Это оригинал автора на английском. Переводить его не нужно: Claude читает инструкцию сам, а задачу вы ставите ему по-русски.
Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.
When to Use This Skill
- Adding docstrings to functions, classes, and modules
- Writing OpenAPI/Swagger specs or JSDoc annotations
- Creating API documentation for REST or GraphQL endpoints
- Building documentation sites or developer portals
- Writing getting-started guides, tutorials, and user guides
Core Workflow
- Discover - Ask for format preference and exclusions
- Detect - Identify language and framework
- Analyze - Find undocumented code
- Document - Apply consistent format
- Validate - Test all code examples compile/run:
- Python:
python -m doctest file.pyfor doctest blocks;pytest --doctest-modulesfor module-wide checks - TypeScript/JavaScript:
tsc --noEmitto confirm typed examples compile - OpenAPI: validate spec with
npx @redocly/cli lint openapi.yaml - If validation fails: fix examples and re-validate before proceeding to the Report step
- Python:
- Report - Generate coverage summary
Quick-Reference Examples
Google-style Docstring (Python)
def fetch_user(user_id: int, active_only: bool = True) -> dict:
"""Fetch a single user record by ID.
Args:
user_id: Unique identifier for the user.
active_only: When True, raise an error for inactive users.
Returns:
A dict containing user fields (id, name, email, created_at).
Raises:
ValueError: If user_id is not a positive integer.
UserNotFoundError: If no matching user exists.
"""
NumPy-style Docstring (Python)
def compute_similarity(vec_a: np.ndarray, vec_b: np.ndarray) -> float:
"""Compute cosine similarity between two vectors.
Parameters
----------
vec_a : np.ndarray
First input vector, shape (n,).
vec_b : np.ndarray
Second input vector, shape (n,).
Returns
-------
float
Cosine similarity in the range [-1, 1].
Raises
------
ValueError
If vectors have different lengths.
"""
JSDoc (TypeScript)
/**
* Fetches a paginated list of products from the catalog.
*
* @param {string} categoryId - The category to filter by.
* @param {number} [page=1] - Page number (1-indexed).
* @param {number} [limit=20] - Maximum items per page.
* @returns {Promise<ProductPage>} Resolves to a page of product records.
* @throws {NotFoundError} If the category does not exist.
*
* @example
* const page = await fetchProducts('electronics', 2, 10);
* console.log(page.items);
*/
async function fetchProducts(
categoryId: string,
page = 1,
limit = 20
): Promise<ProductPage> { ... }
Reference Guide
Load detailed guidance based on context:
| Topic | Reference | Load When |
|---|---|---|
| Python Docstrings | references/python-docstrings.md | Google, NumPy, Sphinx styles |
| TypeScript JSDoc | references/typescript-jsdoc.md | JSDoc patterns, TypeScript |
| FastAPI/Django API | references/api-docs-fastapi-django.md | Python API documentation |
| NestJS/Express API | references/api-docs-nestjs-express.md | Node.js API documentation |
| Coverage Reports | references/coverage-reports.md | Generating documentation reports |
| Documentation Systems | references/documentation-systems.md | Doc sites, static generators, search, testing |
| Interactive API Docs | references/interactive-api-docs.md | OpenAPI 3.1, portals, GraphQL, WebSocket, gRPC, SDKs |
| User Guides & Tutorials | references/user-guides-tutorials.md | Getting started, tutorials, troubleshooting, FAQs |
Constraints
MUST DO
- Ask for format preference before starting
- Detect framework for correct API doc strategy
- Document all public functions/classes
- Include parameter types and descriptions
- Document exceptions/errors
- Test code examples in documentation
- Generate coverage report
MUST NOT DO
- Assume docstring format without asking
- Apply wrong API doc strategy for framework
- Write inaccurate or untested documentation
- Skip error documentation
- Document obvious getters/setters verbosely
- Create documentation that's hard to maintain
Output Formats
Depending on the task, provide:
- Code Documentation: Documented files + coverage report
- API Docs: OpenAPI specs + portal configuration
- Doc Sites: Site configuration + content structure + build instructions
- Guides/Tutorials: Structured markdown with examples + diagrams
Knowledge Reference
Google/NumPy/Sphinx docstrings, JSDoc, OpenAPI 3.0/3.1, AsyncAPI, gRPC/protobuf, FastAPI, Django, NestJS, Express, GraphQL, Docusaurus, MkDocs, VitePress, Swagger UI, Redoc, Stoplight
Maintained by @jeffallan (откроется в новой вкладке), Principal Consultant at Synergetic Solutions (откроется в новой вкладке)