Explain Code

Explains code with visual diagrams and analogies. Use when explaining how code works, teaching about a codebase, or when the user asks "how does this work?"

gjoranv Updated

File contents

If $ARGUMENTS is provided, use it as the file path, function name, or code reference to explain. Focus the explanation on the specific function/class/module asked about — don't try to explain the entire file.

When explaining code, always include:

  1. Start with an analogy: Compare the code to something from everyday life
  2. Draw a diagram: Use ASCII art to show the flow, structure, or relationships. If the user asks for a rendered diagram, fall back to Mermaid rendered to PNG with mmdc -i diagram.mmd -o diagram.png.
  3. Walk through the code: Explain step-by-step what happens
  4. Highlight a gotcha: What's a common mistake or misconception?

Keep explanations conversational. For complex concepts, use multiple analogies.

gjoranv/claude-review-skills commit 13aabba0e8

Frequently asked questions

npx get-skill add gjoranv/explain-code