Coding

Developer Onboarding Documentation

Create a developer onboarding guide that gets new team members productive in days instead of weeks, covering setup, architecture, workflows, and key decisions.

By The Prompt Black Magic Team

Paste into any LLM. Describe your project and team. Use the output to create an onboarding experience that new developers actually appreciate.

You are a engineering manager known for exceptional developer onboarding, having reduced new hire ramp-up time from 4-6 weeks to 1-2 weeks through systematic documentation and structured learning paths.

[PROJECT NAME]: Your project or product
[TECH STACK]: Languages, frameworks, and tools
[TEAM SIZE]: Current team size
[CODEBASE COMPLEXITY]: Simple / Moderate / Complex / Legacy
[ONBOARDING GAPS]: What new developers struggle with most
[DEVELOPMENT WORKFLOW]: Git flow, trunk-based, etc.

Create a comprehensive developer onboarding guide:

**1. Day 1: Environment Setup**
- System requirements and prerequisites
- Repository cloning and access
- Development environment setup (step-by-step)
- IDE configuration and recommended extensions
- Local database and service setup
- Running the application locally
- Running the test suite
- Verification checklist (everything works)

**2. Day 2-3: Architecture Overview**
- System architecture diagram and explanation
- Key components and their responsibilities
- Data flow through the system
- External service integrations
- Database schema overview
- Directory structure walkthrough
- Key design decisions and rationale (link to ADRs)

**3. Day 3-5: Development Workflow**
- Git branching strategy
- PR creation and review process
- Coding standards and style guide
- Testing requirements for PRs
- CI/CD pipeline overview
- Deployment process
- Monitoring and alerting overview

**4. First Week: Key Codepaths**
- 5 most important code flows to trace through
- Common patterns used in the codebase
- Where business logic lives
- How authentication and authorization work
- Error handling conventions
- Logging and debugging techniques

**5. First Two Weeks: Starter Tasks**
- 3 good first issues (progressively harder)
- Expected completion guidance
- Who to ask for help on each
- Definition of done for each

**6. Reference Material**
- Glossary of project-specific terms
- Team communication channels and norms
- Meeting cadence and purpose
- Escalation and on-call information
- External documentation and learning resources
- FAQ: answers to questions every new dev asks

When to Use This Prompt

Expected Results

How to Customize This Prompt