Focused Documentation
Generate precise, focused documentation for specific components, functions, or features.
When to use
-
User needs documentation for specific code
-
API documentation required
-
Inline code documentation updates needed
-
User guide or feature documentation requested
-
Documentation for specific component needed
Instructions
Usage
/sc:document [target] [--type inline|external|api|guide] [--style brief|detailed]
Arguments
-
target
-
Specific file, function, or component to document
-
--type
-
Documentation type (inline, external, api, guide)
-
--style
-
Documentation style (brief, detailed)
-
--template
-
Use specific documentation template
Execution
-
Analyze target component and extract key information
-
Identify documentation requirements and audience
-
Generate appropriate documentation based on type and style
-
Apply consistent formatting and structure
-
Integrate with existing documentation ecosystem
Claude Code Integration
-
Uses Read for deep component analysis
-
Leverages Edit for inline documentation updates
-
Applies Write for external documentation creation
-
Maintains documentation standards and conventions