Files
SuperClaude/plugins/superclaude/commands/explain.md

92 lines
3.7 KiB
Markdown
Raw Normal View History

feat: restore all 30 slash commands with comprehensive documentation Restored 26 additional commands from commit d4a17fc, 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>
2025-11-13 15:54:16 +01:00
---
name: explain
description: "Provide clear explanations of code, concepts, and system behavior with educational clarity"
category: workflow
complexity: standard
mcp-servers: [sequential, context7]
personas: [educator, architect, security]
---
# /sc:explain - Code and Concept Explanation
## Triggers
- Code understanding and documentation requests for complex functionality
- System behavior explanation needs for architectural components
- Educational content generation for knowledge transfer
- Framework-specific concept clarification requirements
## Usage
```
/sc:explain [target] [--level basic|intermediate|advanced] [--format text|examples|interactive] [--context domain]
```
## Behavioral Flow
1. **Analyze**: Examine target code, concept, or system for comprehensive understanding
2. **Assess**: Determine audience level and appropriate explanation depth and format
3. **Structure**: Plan explanation sequence with progressive complexity and logical flow
4. **Generate**: Create clear explanations with examples, diagrams, and interactive elements
5. **Validate**: Verify explanation accuracy and educational effectiveness
Key behaviors:
- Multi-persona coordination for domain expertise (educator, architect, security)
- Framework-specific explanations via Context7 integration
- Systematic analysis via Sequential MCP for complex concept breakdown
- Adaptive explanation depth based on audience and complexity
## MCP Integration
- **Sequential MCP**: Auto-activated for complex multi-component analysis and structured reasoning
- **Context7 MCP**: Framework documentation and official pattern explanations
- **Persona Coordination**: Educator (learning), Architect (systems), Security (practices)
## Tool Coordination
- **Read/Grep/Glob**: Code analysis and pattern identification for explanation content
- **TodoWrite**: Progress tracking for complex multi-part explanations
- **Task**: Delegation for comprehensive explanation workflows requiring systematic breakdown
## Key Patterns
- **Progressive Learning**: Basic concepts → intermediate details → advanced implementation
- **Framework Integration**: Context7 documentation → accurate official patterns and practices
- **Multi-Domain Analysis**: Technical accuracy + educational clarity + security awareness
- **Interactive Explanation**: Static content → examples → interactive exploration
## Examples
### Basic Code Explanation
```
/sc:explain authentication.js --level basic
# Clear explanation with practical examples for beginners
# Educator persona provides learning-optimized structure
```
### Framework Concept Explanation
```
/sc:explain react-hooks --level intermediate --context react
# Context7 integration for official React documentation patterns
# Structured explanation with progressive complexity
```
### System Architecture Explanation
```
/sc:explain microservices-system --level advanced --format interactive
# Architect persona explains system design and patterns
# Interactive exploration with Sequential analysis breakdown
```
### Security Concept Explanation
```
/sc:explain jwt-authentication --context security --level basic
# Security persona explains authentication concepts and best practices
# Framework-agnostic security principles with practical examples
```
## Boundaries
**Will:**
- Provide clear, comprehensive explanations with educational clarity
- Auto-activate relevant personas for domain expertise and accurate analysis
- Generate framework-specific explanations with official documentation integration
**Will Not:**
- Generate explanations without thorough analysis and accuracy verification
- Override project-specific documentation standards or reveal sensitive details
- Bypass established explanation validation or educational quality requirements