Our review
Explains data flows, features, and code paths within a codebase by tracing entry points and providing visual ASCII diagrams and step-by-step breakdowns.
Strengths
- Produces clear ASCII diagrams for visualizing data flow.
- Provides detailed step-by-step explanations with file:line references.
- Covers multiple types of explanations (data flows, features, components, integrations).
- Traces complete end-to-end paths from entry to output.
Limitations
- ASCII diagrams can become complex for very large flows.
- Requires the agent to have read access to all relevant files.
- Explanations are only as accurate as the code and the agent's ability to parse it.
Use when you need a deep understanding of how a specific part of the system works, especially for onboarding or debugging.
Avoid for simple questions that can be answered with a quick overview, as the full breakdown may be overkill.
Security analysis
SafeThe skill only describes a process for analyzing and explaining codebases using standard development tools (Glob, Grep, Read, LSP). It does not instruct the AI to execute any code, modify files, access external services, or handle sensitive data. There are no destructive or exfiltrating actions.
No concerns found
Examples
How do forecasts get from Windguru to the frontend?How does the favorites system work?How does the spot data flow from JSON to API response?name: explain description: Explain data flows, features, and code paths in the varun.surf application with visual diagrams and step-by-step breakdowns
Explain Skill
Explain how data flows through the system, how features work, and trace code paths with clear visualizations and step-by-step breakdowns.
Instructions
When the user asks to explain something (a feature, data flow, or component), follow this process:
1. Identify What to Explain
Parse the user's request to determine:
- Data flow: How data moves from source to destination (e.g., "explain how forecasts get to the frontend")
- Feature: How a specific feature works end-to-end (e.g., "explain favorites system")
- Component: How a specific service or class works internally (e.g., "explain AggregatorService")
- Integration: How external APIs are integrated (e.g., "explain Windguru integration")
2. Gather Context
Use the following tools to understand the code:
Globto find relevant filesGrepto search for specific patterns, method calls, and referencesReadto examine source codeLSPfor finding definitions, references, and call hierarchies
3. Trace the Flow
For data flows and features, trace the complete path:
Entry Point → Processing Steps → Output
Identify:
- Entry points (API endpoints, scheduled tasks, user actions)
- Service layer processing
- Data transformations
- External API calls
- Caching layers
- Response formatting
4. Create Visual Diagrams
Use ASCII diagrams to visualize:
For data flows:
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Source │────▶│ Transform │────▶│ Destination │
└─────────────┘ └─────────────┘ └─────────────┘
For component interactions:
┌──────────────────┐
│ Controller │
└────────┬─────────┘
│
┌────────────┼────────────┐
▼ ▼ ▼
┌─────────┐ ┌─────────┐ ┌─────────┐
│Service A│ │Service B│ │Service C│
└─────────┘ └─────────┘ └─────────┘
For state transitions:
[State A] ──(action)──▶ [State B] ──(action)──▶ [State C]
5. Provide Step-by-Step Breakdown
Structure the explanation as:
- Overview: High-level summary (2-3 sentences)
- Entry Point: Where the flow begins
- Step-by-Step Flow: Each processing step with file:line references
- Key Code Snippets: Important code sections (keep concise)
- Data Transformations: How data shape changes
- External Dependencies: APIs, databases, caches involved
- Error Handling: How errors are managed
- Related Components: Other parts of the system that interact
6. Include Code References
Always include file paths with line numbers for easy navigation:
src/main/java/.../SpotsController.java:45- endpoint definitionsrc/main/java/.../AggregatorService.java:120- data aggregation
Output Format
# Explaining: [Topic]
## Overview
[2-3 sentence summary]
## Visual Diagram
[ASCII diagram showing the flow]
## Step-by-Step Flow
### 1. [Step Name]
**File**: `path/to/file.java:line`
[Description of what happens]
```java
// Key code snippet (if helpful)
2. [Next Step]
...
Data Transformations
| Stage | Data Shape | Example | |-------|------------|---------| | Input | Type | {...} | | Output| Type | {...} |
Key Files Involved
path/to/file1.java- [purpose]path/to/file2.java- [purpose]
Related Features
- [Feature 1]: [brief relation]
- [Feature 2]: [brief relation]
## Example Topics
Common explanations users might request:
### Data Flows
- "How do forecasts get from Windguru to the frontend?"
- "How are live conditions fetched and displayed?"
- "How does the caching system work?"
- "How does the spot data flow from JSON to API response?"
### Features
- "How does the favorites system work?"
- "How does country filtering work?"
- "How does the search functionality work?"
- "How does theme switching work?"
- "How does the kite size calculator work?"
### Components
- "How does AggregatorService orchestrate data fetching?"
- "How do the FetchCurrentConditionsStrategy implementations work?"
- "How does the ForecastService parse Windguru data?"
- "How does the frontend manage state?"
### Integrations
- "How is Windguru integrated?"
- "How is Google Maps integration working?"
- "How does the AI analysis feature work?"
## Notes
- Keep explanations concise but complete
- Use diagrams to make complex flows understandable
- Always include file:line references for code navigation
- Focus on the specific topic, don't over-explain tangential concerns
- If the topic is ambiguous, ask clarifying questions
- Reference CLAUDE.md, docs/BACKEND.md, and docs/FRONTEND.md for architectural context
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Documentation Maintenance
Documentation
This skill provides a structured workflow for updating project documentation including CLAUDE.md, README, and CHANGELOG. It walks through phases like inventorying existing docs, analyzing git history for needed changes, optimizing for AI readability, and ensuring cross-document consistency. Use it when synchronizing documentation with code changes or improving documentation effectiveness for AI coding agents.