sc-document
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
More from htlin222/dotfiles
cpp
Write modern C++ with RAII, smart pointers, and STL. Use for C++ development, memory safety, or performance optimization.
130refactor
Refactor code for quality and maintainability. Use for cleanup and tech debt reduction.
74data-science
Data analysis, SQL queries, BigQuery operations, and data insights. Use for data analysis tasks and queries.
52c-lang
Write efficient C code with proper memory management and system calls. Use for C optimization, memory issues, or system programming.
46quarto-book
Generate Quarto Book project structure with chapters, configuration, and output settings. Use when user wants to create a book, multi-chapter document, technical manual, or asks about Quarto book setup.
45scientific-figure-assembly
Assemble multi-panel scientific figures with panel labels (A, B, C) at publication quality (300 DPI) using R. Use when combining individual plots into journal-ready figures.
43