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? Use when this capability is needed.

tomevault-io Updated

File contents

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
  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.

Arguments

  • $0: The file or code to explain

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/liliang-cn--skills-go--explain-code commit c30e6b57b3

Frequently asked questions

npx skillmds@latest add tomevault-io/explain-code-5