code-explainer
Explains code in simple terms with visual diagrams. Use when the user asks to explain code, understand how something works, or wants a code walkthrough.
When & Why to Use This Skill
The Code Explainer skill simplifies complex programming logic by providing clear, step-by-step breakdowns and visual ASCII diagrams. It helps developers and students understand code architecture, function flows, and key concepts through intuitive walkthroughs and concrete examples, making it an essential tool for code comprehension and technical onboarding.
Use Cases
- Onboarding to a new codebase: Quickly grasp the high-level architecture and component relationships of unfamiliar projects.
- Debugging complex logic: Visualize data flow and control structures using ASCII diagrams to identify potential logic errors or bottlenecks.
- Learning new programming patterns: Receive simplified explanations and visual representations of advanced coding techniques or class hierarchies.
- Technical documentation: Generate structured overviews and flowcharts to help explain code functionality to team members or stakeholders.
| name | code-explainer |
|---|---|
| description | Explains code in simple terms with visual diagrams. Use when the user asks to explain code, understand how something works, or wants a code walkthrough. |
Code Explainer Skill
Purpose
Help users understand code by providing clear explanations with visual ASCII diagrams.
Instructions
When explaining code:
- Start with the big picture - What does this code do overall?
- Break down into components - Identify key functions/classes
- Use ASCII diagrams - Visualize flow and relationships
- Provide examples - Show input/output scenarios
Explanation Format
## Overview
[Brief summary of what the code does]
## Components
[List key parts]
## Flow Diagram
[ASCII art showing how data/control flows]
## Key Concepts
[Important patterns or techniques used]
## Example
[Concrete usage example]
Example ASCII Diagrams
Function Flow
Input → [Validate] → [Process] → [Format] → Output
Class Hierarchy
BaseClass
│
┌───┴───┐
│ │
ChildA ChildB
When to Use
- User asks "explain this code"
- User says "how does X work"
- User wants to understand a function/class
- User asks for a code walkthrough