mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
refactor: Standardize @include reference system across all command files
- Fix @include references to use underscore format (Universal_Legend, Standard_Messages_Templates) - Add missing ultracompressed.yml shared pattern file - Update broken reference paths in all 18 command files - Ensure consistent template naming across command system - Optimize command file structure with standardized includes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -1,113 +1,35 @@
|
||||
# /explain - Provide detailed technical explanations
|
||||
|
||||
## Legend
|
||||
@include shared/universal-constants.yml#Universal_Legend
|
||||
|
||||
## Purpose
|
||||
Provide comprehensive explanations of concepts, code, or systems specified in $ARGUMENTS with appropriate depth and visual aids.
|
||||
## Command Execution
|
||||
Execute: immediate. --plan→show plan first
|
||||
Legend: Generated based on symbols used in command
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
## Syntax
|
||||
`/explain [flags] [concept/topic]`
|
||||
Provide comprehensive explanations of concepts, code, or systems specified in $ARGUMENTS.
|
||||
|
||||
@include shared/flag-inheritance.yml#Universal_Always
|
||||
|
||||
## Core Flags
|
||||
Examples:
|
||||
- `/explain --depth beginner --style tutorial "React hooks"` - Explain React hooks for beginners
|
||||
- `/explain --depth advanced --visual "B-tree indexes"` - Deep dive into database indexing
|
||||
- `/explain --depth expert --think "quicksort optimization"` - Algorithm explanation w/ complexity
|
||||
|
||||
--depth flag:
|
||||
- beginner: Basic concepts, simple language
|
||||
- intermediate: Standard technical depth
|
||||
- advanced: Deep technical details
|
||||
- expert: Cutting-edge & internals
|
||||
Explanation modes:
|
||||
|
||||
--style flag:
|
||||
- tutorial: Step-by-step learning
|
||||
- reference: Quick lookup format
|
||||
- conversational: Natural dialogue
|
||||
- academic: Formal & thorough
|
||||
**--depth:** Explanation depth level
|
||||
- beginner: Basic concepts, simple language | intermediate: Standard technical depth
|
||||
- advanced: Deep technical details | expert: Cutting-edge & internals
|
||||
|
||||
--visual flag:
|
||||
- Include diagrams & flowcharts
|
||||
- Code examples with annotations
|
||||
- Architecture visualizations
|
||||
- Sequence diagrams for flows
|
||||
**--style:** Explanation style
|
||||
- tutorial: Step-by-step learning | reference: Quick lookup format
|
||||
- conversational: Natural dialogue | academic: Formal & thorough
|
||||
|
||||
## Explanation Types
|
||||
**--visual:** Include visual aids
|
||||
- Diagrams & flowcharts | Code examples w/ annotations
|
||||
- Architecture visualizations | Sequence diagrams for flows
|
||||
|
||||
Code Explanation:
|
||||
- Line-by-line breakdown
|
||||
- Algorithm walkthrough
|
||||
- Design pattern usage
|
||||
- Performance implications
|
||||
- Edge cases & limitations
|
||||
@include shared/research-patterns.yml#Explanation_Methodology
|
||||
|
||||
Concept Explanation:
|
||||
- Core principles
|
||||
- Real-world applications
|
||||
- Common misconceptions
|
||||
- Related concepts
|
||||
- Best practices
|
||||
@include shared/docs-patterns.yml#Standard_Notifications
|
||||
|
||||
System Explanation:
|
||||
- Architecture overview
|
||||
- Component interactions
|
||||
- Data flow analysis
|
||||
- Scalability factors
|
||||
- Security considerations
|
||||
|
||||
## Methodology
|
||||
|
||||
Structure:
|
||||
1. Overview - What & why
|
||||
2. Core concepts - Building blocks
|
||||
3. Deep dive - How it works
|
||||
4. Examples - Practical usage
|
||||
5. Gotchas - Common pitfalls
|
||||
6. Resources - Further learning
|
||||
|
||||
Techniques:
|
||||
- Analogies for complex concepts
|
||||
- Progressive complexity
|
||||
- Interactive examples
|
||||
- Visual representations
|
||||
- Real-world scenarios
|
||||
|
||||
## Best Practices
|
||||
|
||||
Clarity:
|
||||
- Define terms before use
|
||||
- Build on prior knowledge
|
||||
- Use consistent terminology
|
||||
- Provide context
|
||||
- Summarize key points
|
||||
|
||||
Engagement:
|
||||
- Start with "why it matters"
|
||||
- Use relatable examples
|
||||
- Address common questions
|
||||
- Provide hands-on exercises
|
||||
- Link to resources
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Explain React hooks for beginners
|
||||
/explain --depth beginner --style tutorial "React hooks"
|
||||
|
||||
# Deep dive into database indexing
|
||||
/explain --depth advanced --visual "B-tree indexes"
|
||||
|
||||
# System architecture explanation
|
||||
/explain --style reference --visual "microservices communication"
|
||||
|
||||
# Algorithm explanation with complexity
|
||||
/explain --depth expert --think "quicksort optimization"
|
||||
```
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Comprehensive explanation document
|
||||
- Code examples & snippets
|
||||
- Visual diagrams if requested
|
||||
- Practice exercises
|
||||
- Resource links & references
|
||||
- Summary & key takeaways
|
||||
@include shared/universal-constants.yml#Standard_Messages_Templates
|
||||
Reference in New Issue
Block a user