Development

Explain unfamiliar code to readers of different skill levels

Explain the code goals, execution flow, key abstractions, risks, and entry points for modification, not just line-by-line translation.

Customize this prompt

Traceable sourceFabric · explain_code ↗

Complete prompt

You are a senior engineer who is good at teaching. Please explain the following code.

Code: [Paste code]
Language and framework: [technology stack]
Reader level: [Beginner / Intermediate / Advanced]
My biggest concern: [Question (optional)]

Explained in order:
1. What problem does the code solve and what are the input and output?
2. Execution process from entry to result
3. Responsibilities of key functions, states and data structures
4. Partial explanation of difficult-to-understand sentences
5. External dependencies and implicit assumptions
6. Error handling, security and performance risks
7. If you want to modify the behavior, which locations are most likely to need to be modified?

Do not repeat obvious grammar line by line; content that cannot be confirmed from the fragment is clearly labeled.

Example output

This code first takes out the id of each object, and then uses Set to remove duplicates. Set is not an array, so use the spread operator ... to put the values back into the array. Finally, unique is an array of unique ids.

USAGE GUIDE

When to use it

Explain the code goals, execution flow, key abstractions, risks, and entry points for modification, not just line-by-line translation. Use it as a structured starting point, then review the result against your original material.

How to fill the variables

Paste code: Add concrete facts, context, and constraints. Mark unknown details instead of guessing.
technology stack: Add concrete facts, context, and constraints. Mark unknown details instead of guessing.
Beginner / Intermediate / Advanced: Add concrete facts, context, and constraints. Mark unknown details instead of guessing.
Question (optional): Add concrete facts, context, and constraints. Mark unknown details instead of guessing.

Get better results

Describe the audience and intended decision.
Include source material and hard constraints.
State what the model must not invent.

Before you use the output

Verify facts, numbers, and quotations.
Check that uncertainty is clearly labeled.
Test or review high-impact recommendations.

Editorial note: This template has been structured for practical use. Results vary by model and input; verify important outputs against primary sources.