Notre avis
Explique les flux de données, les fonctionnalités et les chemins de code dans une base de code en traçant les points d'entrée et en fournissant des diagrammes ASCII visuels et des analyses étape par étape.
Points forts
- Produit des diagrammes ASCII clairs pour visualiser les flux de données.
- Fournit des explications détaillées étape par étape avec des références fichier:ligne.
- Couvre plusieurs types d'explications (flux de données, fonctionnalités, composants, intégrations).
- Trace les chemins complets de bout en bout, de l'entrée à la sortie.
Limites
- Les diagrammes ASCII peuvent devenir complexes pour des flux très volumineux.
- Nécessite que l'agent ait un accès en lecture à tous les fichiers pertinents.
- Les explications ne sont aussi précises que le code et la capacité de l'agent à l'analyser.
À utiliser lorsque vous avez besoin d'une compréhension approfondie du fonctionnement d'une partie spécifique du système, en particulier pour l'intégration ou le débogage.
Évitez pour les questions simples qui peuvent être résolues par un aperçu rapide, car l'analyse complète peut être excessive.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.