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

document — слэш-команда для Claude Code: что делает и как установить

Команда document генерирует документацию по коду: docstring, спецификации API, руководства пользователя и описания компонентов.

MIT ★ 23 950 обновлён 2026-09-27

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/commands/document.md
Открыть на GitHub

Что делает document

Команда анализирует код и собирает целевую документацию под конкретный файл, папку или модуль. Она считывает сигнатуры функций, схемы интерфейсов и существующие комментарии, используя встроенные инструменты чтения и поиска (Read, Grep, Glob), а затем сохраняет результат через Write.

Поведение настраивается флагами: --type принимает значения inline, external, api или guide, а --style переключает формат между brief и detailed. Для JavaScript и TypeScript создаются блоки JSDoc, а для отдельных директорий — внешние справочники с примерами вызовов.

Команда не выдумывает структуру из воздуха: если контекста кода недостаточно для анализа, генерация блокируется, чтобы исключить показ закрытых деталей реализации.

Какие задачи решает

  • добавить комментарии JSDoc и docstring к методам или классам
  • составить API-справочник с эндпоинтами и схемами данных
  • написать руководство пользователя с практическими примерами
  • оформить внешнее описание библиотеки компонентов со свойствами

Примеры запросов агенту

  • /sc:document src/auth/login.js --type inline
  • /sc:document src/api --type api --style detailed
  • /sc:document payment-module --type guide --style brief

Как установить document

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

.claude/commands/document.md

Вызов — /document. Для всех проектов — ~/.claude/commands/

Вопросы о document

Как установить document в Claude Code?

Сохраните файл команды по пути .claude/commands/document.md в корне вашего проекта.

Что делает команда document?

Она исследует указанный файл или каталог, определяет параметры и возвращаемые типы, после чего генерирует комментарии в коде, справочные файлы API или краткие руководства.

Нужны ли внешние MCP-серверы для запуска?

Нет, конфигурация команды содержит пустой список mcp-servers и использует базовые инструменты файловых операций платформы.

Исходный текст

document.md · MIT
---
name: document
description: "Generate focused documentation for components, functions, APIs, and features"
category: utility
complexity: basic
mcp-servers: []
personas: []
---

# /sc:document - Focused Documentation Generation

## Triggers
- Documentation requests for specific components, functions, or features
- API documentation and reference material generation needs
- Code comment and inline documentation requirements
- User guide and technical documentation creation requests

## Usage
```
/sc:document [target] [--type inline|external|api|guide] [--style brief|detailed]
```

## Behavioral Flow
1. **Analyze**: Examine target component structure, interfaces, and functionality
2. **Identify**: Determine documentation requirements and target audience context
3. **Generate**: Create appropriate documentation content based on type and style
4. **Format**: Apply consistent structure and organizational patterns
5. **Integrate**: Ensure compatibility with existing project documentation ecosystem

Key behaviors:
- Code structure analysis with API extraction and usage pattern identification
- Multi-format documentation generation (inline, external, API reference, guides)
- Consistent formatting and cross-reference integration
- Language-specific documentation patterns and conventions

## Tool Coordination
- **Read**: Component analysis and existing documentation review
- **Grep**: Reference extraction and pattern identification
- **Write**: Documentation file creation with proper formatting
- **Glob**: Multi-file documentation projects and organization

## Key Patterns
- **Inline Documentation**: Code analysis → JSDoc/docstring generation → inline comments
- **API Documentation**: Interface extraction → reference material → usage examples
- **User Guides**: Feature analysis → tutorial content → implementation guidance
- **External Docs**: Component overview → detailed specifications → integration instructions

## Examples

### Inline Code Documentation
```
/sc:document src/auth/login.js --type inline
# Generates JSDoc comments with parameter and return descriptions
# Adds comprehensive inline documentation for functions and classes
```

### API Reference Generation
```
/sc:document src/api --type api --style detailed
# Creates comprehensive API documentation with endpoints and schemas
# Generates usage examples and integration guidelines
```

### User Guide Creation
```
/sc:document payment-module --type guide --style brief
# Creates user-focused documentation with practical examples
# Focuses on implementation patterns and common use cases
```

### Component Documentation
```
/sc:document components/ --type external
# Generates external documentation files for component library
# Includes props, usage examples, and integration patterns
```

## Boundaries

**Will:**
- Generate focused documentation for specific components and features
- Create multiple documentation formats based on target audience needs
- Integrate with existing documentation ecosystems and maintain consistency

**Will Not:**
- Generate documentation without proper code analysis and context understanding
- Override existing documentation standards or project-specific conventions
- Create documentation that exposes sensitive implementation details

© SuperClaude-Org · MIT · SuperClaude-Org/SuperClaude_Framework

Похожие слэш-команды

Все слэш-команды по теме «Тексты и документация» →
code-documentation aj-geddes Скилл code-documentation для Claude Code пишет документацию по стандартам языка: JSDoc, Python docstrings, JavaDoc и встроенные комментарии. За один запрос документирует функции, классы, типы и API. CX Codex +1 502установок documentation-templates davila7 Скилл documentation-templates для Claude Code, который предоставляет структуру и шаблоны для README, API-документации, комментариев и других проектных записей. Помогает оформить документацию с нуля или привести её к единому стилю. CX Codex +1 305установок technical-writer josstei Субагент technical-writer пишет README, API-документацию, ADR и JSDoc, предварительно читая код, чтобы описывать реальное поведение, а не то, что задумывалось. CX Codex ★ 489звёзд репо update-docs NeoLabHQ Скилл update-docs анализирует изменения в коде через git и обновляет README, файлы docs/ или JSDoc. Помогает поддерживать документацию проекта без ручного переписывания. CX Codex +1 1 400установок api-docs ruvnet Скилл api-docs собирает документацию по исходникам на TypeScript и JavaScript: находит публичные экспорты, разбирает JSDoc, дописывает недостающие комментарии и выдаёт OpenAPI 3.0 для HTTP-эндпоинтов. CX Codex +1 893установок code-documenter https://github.com/Jeffallan Скилл code-documenter создаёт и проверяет документацию к коду, API и руководства. Нужен при добавлении docstring, JSDoc или спецификации OpenAPI. CX Codex +1 6 200установок

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

Весь набор →
root-cause-analyst Субагент root-cause-analyst для Claude Code систематически расследует сбои и системные ошибки, собирая логи и проверяя гипотезы. Помогает найти первопричины сложных багов вместо борьбы с симптомами. CX Codex ★ 23 950звёзд репо security-engineer Субагент security-engineer для Claude Code ищет уязвимости, моделирует угрозы и проверяет код по security-стандартам. Проводит аудит и разбирает риски. CX Codex ★ 23 950звёзд репо test Команда test для запуска unit-, integration- и e2e-тестов с анализом покрытия и отчётами о качестве. Работает с автоопределением фреймворка и поддерживает watch-режим для разработки. CX Codex +1 ★ 23 950звёзд репо python-expert Субагент python-expert для Claude Code. Пишет production-код на Python по принципам SOLID и clean architecture, требует покрытие тестами от 95% и аудит уязвимостей по OWASP. CX Codex ★ 23 950звёзд репо build Команда build для автоматической сборки, компиляции и упаковки проектов с анализом ошибок и оптимизацией артефактов. Запускается из Claude Code с выбором окружения и типа сборки. CX Codex +1 ★ 23 950звёзд репо analyze Команда analyze проверяет код по качеству, безопасности, производительности и архитектуре. Подходит для ревью проекта или отдельной папки. CX Codex +1 ★ 23 950звёзд репо load Команда load для Claude Code, которая загружает контекст проекта через интеграцию с Serena MCP и восстанавливает данные между сессиями. Запускается при старте сессии или после переключения между проектами. CX Codex +1 ★ 23 950звёзд репо design Команда design проектирует архитектуру систем, схемы баз данных и спецификации API перед написанием кода. Пригодится на этапе планирования сервисов. CX Codex +1 ★ 23 950звёзд репо

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

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