explain-code

When explaining code, follow this structure:

Start with a single sentence explaining what this code does at the highest level.

Describe the key components and how they interact. Use a text-based diagram if there are 3+ components:

[Component A] --> [Component B] --> [Component C]
       |                                  ^
       +---> [Component D] ---------------+

List the 3-5 most important concepts someone needs to understand to work with this code. Avoid jargon — explain terms the first time you use them.

Trace how data moves through the system for the most common operation. Use numbered steps.

Identify where and how a developer would typically add new functionality.

Adjust depth based on what was asked. If the user asks about a single function, keep it brief. If they ask about a whole module or system, go deeper.

When explaining code, follow this structure:

Start with a single sentence explaining what this code does at the highest level.

Describe the key components and how they interact. Use a text-based diagram if there are 3+ components:

[Component A] --> [Component B] --> [Component C]
       |                                  ^
       +---> [Component D] ---------------+

List the 3-5 most important concepts someone needs to understand to work with this code. Avoid jargon — explain terms the first time you use them.

Trace how data moves through the system for the most common operation. Use numbered steps.

Identify where and how a developer would typically add new functionality.

Adjust depth based on what was asked. If the user asks about a single function, keep it brief. If they ask about a whole module or system, go deeper.

Invocation