Back to prompt library

Write a codebase tour for the next developer

New people take a long time to get going, and you end up explaining it yourself.

When to use it Before someone new joins

What you get

An onboarding tour backed by real files.

Before you start

  • Creating one doc file is allowed

Steps

  1. Find the build and run entry points
  2. Trace one representative request
  3. Explain the data and permission boundaries
  4. List safe changes and dangerous shortcuts

Deliverables

  • Architecture diagram
  • Key file index
  • Suggested first change

Done when

  • Every section links to real files
  • It clearly says what shouldn't be changed directly

Paste this into your agent

Write a codebase tour for someone new to this project. Trace the entry points, one end-to-end flow, data boundaries, config, tests and deployment; cite real files, and list safe first changes, dangerous shortcuts and unknowns. Show me the outline first, and only after I approve, create a single doc file. Stop once you've produced the above; don't go on to anything else.