document

A command for writing focused documentation about specific code, such as a component, function, API, or feature.

In plain words
What is it for?
Use it to create inline comments, external documentation, API references, or user guides in brief or detailed styles.
Why use it?
It turns code structure and usage patterns into consistent material that other developers or users can follow.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/superclaude-org/superclaude_framework/document
Clone the repo
git clone --depth 1 https://github.com/SuperClaude-Org/SuperClaude_Framework
Per session 14 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 612 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00014 $0.00612
Opus 5 $0.00007 $0.00306
Sonnet 5 $0.00003 $0.00122
Haiku 4.5 $0.00001 $0.00061

Measured 2d ago against content hash 10270e4522b7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

document scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

  • document — 94% identical, 12 lines differ
plugins/superclaude/commands/document.md · 88 lines

How it starts

The opening of the file, as written. The whole thing — 88 lines — stays where its author put it; the contents beside it link to each section on GitHub.

/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

Read the full file on GitHub · 88 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 88 lines · 14 tokens per session scan A 10270e4522b7

Subscribe to this mod's changes

document is a command published in the GitHub repository SuperClaude-Org/SuperClaude_Framework (23,856 stars, last pushed 12d ago), licensed MIT. It adds 14 tokens to every session and 612 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.