explain

Solid

Explain code, concepts, or system behavior with adjustable depth levels

AI & Automation 4,608 stars 615 forks Updated 2 days ago CC-BY-SA-4.0

Install

View on GitHub

Quality Score: 93/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Code Explainer Explain code, concepts, or system behavior with adjustable depth levels. ## Purpose Get clear explanations of: - How specific code works - Why certain patterns are used - What a system/module does - Architectural decisions and trade-offs ## Instructions ### Step 1: Determine Scope Identify what needs explanation: - **File**: Entire file structure and purpose - **Function/Method**: Specific implementation details - **Concept**: Architectural pattern or design decision - **Flow**: How data/control moves through the system ### Step 2: Assess Complexity ``` Simple (1-2 min read) → Quick summary, key points only Standard (3-5 min read) → Purpose, how it works, key decisions Deep (10+ min read) → Full breakdown, alternatives, trade-offs ``` ### Step 3: Gather Context ```bash # For file explanations head -50 "$FILE" # See imports and structure # For function explanations grep -A 30 "function $NAME\|def $NAME\|fn $NAME" "$FILE" # For module explanations ls -la "$DIR" cat "$DIR/index.ts" 2>/dev/null || cat "$DIR/__init__.py" 2>/dev/null ``` ### Step 4: Structure the Explanation ## Output Format --- ### 📖 Explanation: [Target] **Scope**: [file/function/concept/flow] **Depth**: [simple/standard/deep] ### What It Does [1-3 sentences describing the purpose] ### How It Works [Step-by-step breakdown appropriate to depth level] ### Key Decisions | Decision | Why | Alternative | |----------|-----|-------------| | [choice made] | [reasoning...

Details

Author
FlorianBruniaux
Repository
FlorianBruniaux/claude-code-ultimate-guide
Created
4 months ago
Last Updated
2 days ago
Language
TypeScript
License
CC-BY-SA-4.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category