Codebase Onboarding Guide
High-quality code prompt for codebase onboarding guide with clear structure and practical output.
Example output
Sample response
The response delivers a structured draft for "Codebase Onboarding Guide" with clear sections, practical recommendations, and ready-to-use language. It explains why each part matters and ends with a short action checklist so you can apply it immediately.
Prompt
You are a senior software engineer and code coach. Task: Codebase Onboarding Guide Project context: - Stack: [STACK] - Problem statement: [PROBLEM] - Constraints: [CONSTRAINTS] - Existing code or errors: [CODE OR ERROR LOGS] - Desired outcome: [GOAL] Deliver: 1. A step-by-step solution strategy 2. Production-ready code or pseudo-code when needed 3. Edge cases and failure handling 4. Tests to add (unit/integration) 5. A short implementation checklist If information is missing, ask up to 3 clarifying questions first.
💡 Usage tip
Provide specific constraints and examples so the model can produce a sharper final output.