# document

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

- команда · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 23950 у репозитория
- Автор: SuperClaude-Org
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/SuperClaude-Org/SuperClaude_Framework/tree/HEAD/plugins/superclaude/commands/document.md
- Обновлён: 2026-09-27
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/commands/document

## Что делает

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

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

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

## Установка

### Claude Code (родная платформа)

**Вручную: положить файлы**
- Файл: `.claude/commands/document.md` — Вызов — /document. Для всех проектов — ~/.claude/commands/

### Codex

**Вручную: положить файлы**
- Файл: `~/.codex/prompts/document.md` — Вызов — /prompts:document. В Codex этот формат помечен устаревшим, замена — скиллы

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/prompts/document.prompt.md`

### Gemini CLI

**Вручную: положить файлы**
- Файл: `.gemini/commands/document.toml` — Gemini хранит команды в TOML: текст запроса — в поле prompt

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/SuperClaude-Org/SuperClaude_Framework/tree/HEAD/plugins/superclaude/commands/document.md

## Когда брать
- добавить комментарии 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`

## Похожие
- [code-documentation](https://affpapa.org/nevibecode/skills/aj-geddes-code-documentation.md) — скилл · 502 установки
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [technical-writer](https://affpapa.org/nevibecode/agents/josstei-technical-writer.md) — субагент · ★ 489 у репозитория
- [update-docs](https://affpapa.org/nevibecode/skills/update-docs.md) — скилл · 1400 установок
- [api-docs](https://affpapa.org/nevibecode/skills/api-docs.md) — скилл · 893 установки
- [code-documenter](https://affpapa.org/nevibecode/skills/code-documenter.md) — скилл · 6200 установок

Из того же набора: [superclaude-org/superclaude_framework](https://affpapa.org/nevibecode/by/superclaude-org/superclaude_framework.md) — 56 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
