mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
feat: restore all 30 slash commands with comprehensive documentation
Restored 26 additional commands from commitd4a17fc, bringing total from 5 to 30 commands. ## New Commands Added (26): - /analyze - Code and architecture analysis - /brainstorm - Structured brainstorming sessions - /build - Build and compilation workflows - /business-panel - Multi-expert business analysis - /cleanup - Code cleanup and refactoring - /design - System design and architecture - /document - Documentation generation - /estimate - Effort and time estimation - /explain - Code explanation - /git - Git operations and workflows - /help - Command help and usage - /implement - Implementation workflows - /improve - Code improvement suggestions - /index - Project indexing (alias for index-repo) - /load - Load saved sessions - /pm - Project management workflows - /reflect - Reflection and retrospectives - /save - Save current session - /select-tool - Tool selection guidance - /spawn - Spawn parallel tasks - /spec-panel - Multi-expert specification analysis - /task - Task management - /test - Testing workflows - /troubleshoot - Debugging and troubleshooting - /workflow - Custom workflow automation ## Documentation Updates: - Created docs/reference/commands-list.md with categorized command reference - Updated README.md with expandable 30-command list - Updated README-zh.md with Chinese translations - Updated README-ja.md with Japanese translations - Updated README-kr.md with Korean translations - Changed statistics: "3 plugins" → "30 commands" - Added command categories: Planning & Design, Development, Testing & Quality, Documentation, Version Control, Project Management, Research & Analysis, Utilities ## Files Changed: - 60 files changed, 7930 insertions(+), 267 deletions(-) - Added 26 commands to plugins/superclaude/commands/ - Added 26 commands to src/superclaude/commands/ - Created comprehensive command documentation Commands restored from:d4a17fc(superclaude/commands/) Total: 30 commands now available 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
88
plugins/superclaude/commands/document.md
Normal file
88
plugins/superclaude/commands/document.md
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
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
|
||||
Reference in New Issue
Block a user