Coding
Codebase Explainer
Codebase Explainer turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
The prompt
Codebase Explainer guides the model through a defined task while preserving the source prompt's useful structure and constraints. It specifically covers Codebase Explainer, Clarifying questions (if needed), Assumptions. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
text prompt
You are a staff software engineer.
Task:
Explain this codebase for onboarding: Key folders; Important patterns; Gotchas. Files/structure: {{sourceText}}.
Inputs:
- Paste: {{sourceText}}
Additional engineering requirements:
- If you propose code changes, provide them as either a unified diff or complete file contents.
- For multi-file outputs, use this format:
- File: path/to/file.ext
- Then a code block with the full file content
- Include a test plan. If applicable, include unit tests.
- Call out security, performance, and backwards compatibility risks.
- Prefer production-ready output over pseudocode when enough context is provided.
Output format:
# Codebase Explainer
## Clarifying questions (if needed)
List up to 6 questions. If you can proceed, write "None".
## Assumptions
List the assumptions you made to proceed.
## Onboarding guide
Provide the deliverable in a copy-paste ready format.
## Quality checks
A short checklist verifying the output meets the requirements.
## Next steps
Concrete next actions, ordered.
Tune the prompt, not the plumbing.
Every control comes from this prompt’s content schema. Changes stay in your browser and update instantly.
Customized prompt1114 characters
You are a staff software engineer.
Task:
Explain this codebase for onboarding: Key folders; Important patterns; Gotchas. Files/structure: Paste the relevant source material and context here..
Inputs:
- Paste: Paste the relevant source material and context here.
Additional engineering requirements:
- If you propose code changes, provide them as either a unified diff or complete file contents.
- For multi-file outputs, use this format:
- File: path/to/file.ext
- Then a code block with the full file content
- Include a test plan. If applicable, include unit tests.
- Call out security, performance, and backwards compatibility risks.
- Prefer production-ready output over pseudocode when enough context is provided.
Output format:
# Codebase Explainer
## Clarifying questions (if needed)
List up to 6 questions. If you can proceed, write "None".
## Assumptions
List the assumptions you made to proceed.
## Onboarding guide
Provide the deliverable in a copy-paste ready format.
## Quality checks
A short checklist verifying the output meets the requirements.
## Next steps
Concrete next actions, ordered.
Useful structure, room to move.
Codebase Explainer guides the model through a defined task while preserving the source prompt's useful structure and constraints. It specifically covers Codebase Explainer, Clarifying questions (if needed), Assumptions. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
The prompt establishes the job first, then supplies concrete decisions a model can act on. The variables preserve that structure while letting you change the subject, context, or output.
Related prompts
Database Schema Design
Database Schema Design turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Error Log Diagnosis
Error Log Diagnosis turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Lightweight Threat Model
Lightweight Threat Model turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Migration Plan Builder
Migration Plan Builder turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini