Turn a GitHub repo, local codebase, or current project into an operator-friendly brief. Use when the user wants to understand what a codebase does, how it is structured, where to edit specific features, what the main risks are, or how to hand off / review / maintain a project without reading every file. Best for founders, PMs, operators, and vibe coders who need practical codebase understanding rather than a programming course.
Turn a codebase into a practical operating brief.
Do not optimize for classroom-style teaching. Optimize for decision support, handoff, maintenance, and fast understanding.
Accept:
If the codebase is large, identify the smallest meaningful scope first:
Do not pretend to read everything when the repo is large. State the scope you actually analyzed.
Extract these six things:
Read references/output-frames.md to choose the right output frame.
Choose the most useful default for the user request:
Use for founders, PMs, or operators. Output:
Use when the user asks "where do I edit X" or wants implementation guidance. Output:
Use when the user needs to transfer ownership, review a repo, or onboard another person. Output:
Ground every major claim in repo evidence:
Do not say "the app likely" unless confidence is truly low.
A useful brief answers:
A useless brief is long, generic, and reads like an auto-generated tutorial.
Every brief should include:
Include "Read first" when useful:
Look for:
Look for:
Look for: