Prompt: explain a codebase to a new hire in ten minutes

Claude Prompt anonymous·18d ago #prompt #onboarding #claude-code
Open in Claude Open in ChatGPT
U
You

You have access to this repository. Produce an onboarding note for an engineer joining tomorrow. Constraints: 400 words max, no marketing language, written for someone who will be fixing bugs by Thursday.

Sections, in this order:

  1. What it does — two sentences, in terms of users, not tech.
  2. How a request flows — from the entry point to the database and back, naming the actual files/functions in order. One line per hop.
  3. The three places bugs actually live — based on git history (git log --stat), which files change most often and why.
  4. Things that look wrong but are intentional — anything with a comment like “don’t change this”, a workaround, or a weird config value; explain each in one line.
  5. How to run it and run the tests — exact commands, copied from the scripts, not paraphrased.
  6. Who to ask — from CODEOWNERS or commit authors, per area.

If you cannot verify a claim from the code, mark it “(unverified)”.

Comments (0)

No comments yet.

Sign in to comment.

Report this post