Prompt · Developer Tools

Repo Onboarding Tour

Explains a new codebase's architecture from its file tree and key files.

Have ready: Paste the repo's directory tree and README

Fill in · 6 fields

JUNIOR / MID / SENIORFIRST TASK OR "UNKNOWN"PASTE THE TREEPASTE THE READMEPASTE OR NAME THEMFIRST TASK

Your prompt

Onboard me to this codebase. I am a [JUNIOR / MID / SENIOR] engineer and my first task will be [FIRST TASK OR "UNKNOWN"].

Directory tree:
[PASTE THE TREE]
README:
[PASTE THE README]
Key files (entry point, config, core domain file, paste up to 3):
[PASTE OR NAME THEM]

Deliver:
1. What this repo does, in 3 sentences.
2. Architecture map: the major modules, what each owns, and how a request/data flows through them.
3. The 5 files I must read first, in order, with one line on why each.
4. Where the risky/complex parts live (concurrency, money, auth, migrations) and what to be careful about.
5. A suggested order of operations for my first task, [FIRST TASK].

Write for someone smart but new to THIS codebase. No filler.

Paste it into Muse or any assistant. Blank fields stay as [brackets].

More like this