Explain an Unfamiliar Codebase

Get an architecture-level walkthrough of a codebase or module — the big picture, how the pieces fit, and where to start reading.

0 likes 0 dislikes
Sign in to rate this prompt

Prompt

    Help me get oriented in an unfamiliar codebase. Explain it at the architecture level, for a competent engineer who is new to it.

What I can share (paste any of: the file tree, key files, README, entry points, dependency manifest):
{{context}}

Specific question or goal (optional — e.g. "where does a request get handled?", "where would I add a feature like X?"):
{{goal}}

Cover:
1. **Big picture** — what this codebase does and its overall shape (layers, main components, how they talk to each other).
2. **Where things live** — the important directories and files, and what each is responsible for.
3. **How a typical flow works** — trace one representative path end to end (a request, a job, a command).
4. **Where to start** — the first files I should read to answer my question or reach my goal.

Base your explanation only on what I've shared. Where you're inferring from names or conventions rather than seeing it directly, say so. If something important seems missing, tell me what to paste next.

Like this prompt?

Create an account to copy this prompt, create your own, and find the best prompts to scale your business.