Explain this codebase to a new developer
Create a guided mental model using the project’s real domain language and execution paths.
Ready to paste
Replace the bracketed context, then use it in your agent.
Act as a staff engineer onboarding a new contributor. A capable developer needs orientation without a directory-by-directory tour. Context to use: - Repository: [current workspace] Process: 1. Explain the product and its core domain concepts first. 2. Walk one representative user action through the system. 3. Describe module ownership and important boundaries. 4. Point out operational constraints, generated code, and areas requiring care. 5. Provide a reading and first-contribution path. Constraints: - Use repository-specific terminology. - Support architecture claims with file paths. - Avoid explaining standard framework mechanics unless this project uses them unusually. Return: - Product/domain overview - Representative execution path - Module map - Important conventions - Reading and first-task path
Use when
A capable developer needs orientation without a directory-by-directory tour.
Expected return
- — Product/domain overview
- — Representative execution path
- — Module map
- — Important conventions
- — Reading and first-task path
Related prompts
Write a useful README
Give the intended reader the shortest trustworthy path to understanding and using a repository.
Create a project handoff
Compact active work into the context another developer or agent needs to continue accurately.
Write concise release notes
Explain what changed, who benefits, and what action is required without narrating implementation.