2025-06-24 21:24:14 +02:00
|
|
|
# /explain - Provide detailed technical explanations
|
|
|
|
|
|
|
|
|
|
## Legend
|
2025-06-24 22:46:52 +02:00
|
|
|
@include shared/universal-constants.yml#Universal_Legend
|
2025-06-24 21:24:14 +02:00
|
|
|
|
|
|
|
|
## Purpose
|
|
|
|
|
Provide comprehensive explanations of concepts, code, or systems specified in $ARGUMENTS with appropriate depth and visual aids.
|
|
|
|
|
|
|
|
|
|
## Syntax
|
|
|
|
|
`/explain [flags] [concept/topic]`
|
|
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
@include shared/flag-inheritance.yml#Universal_Always
|
|
|
|
|
|
|
|
|
|
## Core Flags
|
|
|
|
|
|
|
|
|
|
--depth flag:
|
|
|
|
|
- beginner: Basic concepts, simple language
|
|
|
|
|
- intermediate: Standard technical depth
|
|
|
|
|
- advanced: Deep technical details
|
|
|
|
|
- expert: Cutting-edge & internals
|
|
|
|
|
|
|
|
|
|
--style flag:
|
|
|
|
|
- tutorial: Step-by-step learning
|
|
|
|
|
- reference: Quick lookup format
|
|
|
|
|
- conversational: Natural dialogue
|
|
|
|
|
- academic: Formal & thorough
|
|
|
|
|
|
|
|
|
|
--visual flag:
|
|
|
|
|
- Include diagrams & flowcharts
|
|
|
|
|
- Code examples with annotations
|
|
|
|
|
- Architecture visualizations
|
|
|
|
|
- Sequence diagrams for flows
|
|
|
|
|
|
|
|
|
|
## Explanation Types
|
|
|
|
|
|
|
|
|
|
Code Explanation:
|
|
|
|
|
- Line-by-line breakdown
|
|
|
|
|
- Algorithm walkthrough
|
|
|
|
|
- Design pattern usage
|
|
|
|
|
- Performance implications
|
|
|
|
|
- Edge cases & limitations
|
|
|
|
|
|
|
|
|
|
Concept Explanation:
|
|
|
|
|
- Core principles
|
|
|
|
|
- Real-world applications
|
|
|
|
|
- Common misconceptions
|
|
|
|
|
- Related concepts
|
|
|
|
|
- Best practices
|
|
|
|
|
|
|
|
|
|
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
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
## Best Practices
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
Clarity:
|
|
|
|
|
- Define terms before use
|
|
|
|
|
- Build on prior knowledge
|
|
|
|
|
- Use consistent terminology
|
|
|
|
|
- Provide context
|
|
|
|
|
- Summarize key points
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
Engagement:
|
|
|
|
|
- Start with "why it matters"
|
|
|
|
|
- Use relatable examples
|
|
|
|
|
- Address common questions
|
|
|
|
|
- Provide hands-on exercises
|
|
|
|
|
- Link to resources
|
2025-06-24 21:24:14 +02:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
```bash
|
|
|
|
|
# Explain React hooks for beginners
|
|
|
|
|
/explain --depth beginner --style tutorial "React hooks"
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
# Deep dive into database indexing
|
|
|
|
|
/explain --depth advanced --visual "B-tree indexes"
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
# System architecture explanation
|
|
|
|
|
/explain --style reference --visual "microservices communication"
|
2025-06-24 21:24:14 +02:00
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
# Algorithm explanation with complexity
|
|
|
|
|
/explain --depth expert --think "quicksort optimization"
|
|
|
|
|
```
|
2025-06-24 21:24:14 +02:00
|
|
|
|
|
|
|
|
## Deliverables
|
|
|
|
|
|
2025-06-24 22:46:52 +02:00
|
|
|
- Comprehensive explanation document
|
|
|
|
|
- Code examples & snippets
|
|
|
|
|
- Visual diagrams if requested
|
|
|
|
|
- Practice exercises
|
|
|
|
|
- Resource links & references
|
|
|
|
|
- Summary & key takeaways
|