# {project_name} — Developer Onboarding Guide

> Generated: {date}

---

## 1. Project Overview

<!-- PLACEHOLDER: project_overview -->
<!-- Fill with: project name, description/purpose, version, license -->
<!-- Include a tech stack summary table:
| Category | Technology |
|----------|-----------|
| Language | ... |
| Framework | ... |
| Database | ... |
| Test Framework | ... |
| Build Tool | ... |
-->

---

## 2. Project Structure

<!-- PLACEHOLDER: project_structure -->
<!-- Fill with: 2-level directory tree with descriptions -->
<!-- Example format:
```
project-root/
├── src/           — Source code
├── tests/         — Test suites
└── docs/          — Documentation
```
-->

---

## 3. Development Environment Setup

### Prerequisites

<!-- PLACEHOLDER: prerequisites -->
<!-- Fill with: required tools and versions (Node.js, Python, Docker, etc.) -->

### Getting Started

<!-- PLACEHOLDER: getting_started -->
<!-- Fill with: step-by-step commands to set up and run the project -->
<!-- Example format:
```bash
# Clone the repository
git clone <repo-url>
cd <project-name>

# Install dependencies
npm install

# Run development server
npm run dev

# Run tests
npm test
```
-->

---

## 4. Development Workflow

### Git Workflow

<!-- PLACEHOLDER: git_workflow -->
<!-- Fill with: branch strategy, commit conventions, PR process -->

### Code Standards

<!-- PLACEHOLDER: code_standards -->
<!-- Fill with: linter/formatter config, key coding rules from CLAUDE.md -->

### Testing

<!-- PLACEHOLDER: testing -->
<!-- Fill with: test framework, how to run tests, coverage requirements -->

### CI/CD

<!-- PLACEHOLDER: cicd -->
<!-- Fill with: pipeline descriptions, deployment process -->

---

## 5. Current Project Status

### Planning Documents

<!-- PLACEHOLDER: planning_documents -->
<!-- Fill with: list of existing planning artifacts (PRD, Architecture, UX, etc.) with file paths -->

### Epic & Story Progress

<!-- PLACEHOLDER: epic_story_progress -->
<!-- Fill with: sprint status summary — epic/story counts, completion rates, current focus -->
<!-- If no epics exist, note that the project is in pre-implementation or uses a different tracking method -->

---

## 6. BMAD Workflow Guide

<!-- PLACEHOLDER: bmad_section -->
<!-- If BMAD is not installed, replace this entire section with a note that BMAD is not configured for this project -->

### What is BMAD?

<!-- PLACEHOLDER: bmad_intro -->
<!-- Brief 2-3 sentence explanation of BMAD Method and what it provides -->

### Daily Commands (Top 6)

<!-- PLACEHOLDER: bmad_daily_commands -->
<!-- Fill with table:
| Command | Description |
|---------|-----------|
| `/bmad-help` | Get unstuck — shows next steps and answers questions |
| `/bmad-bmm-quick-dev` | Quick one-off tasks without full planning |
| `/bmad-bmm-sprint-status` | View current sprint progress |
| `/bmad-bmm-dev-story` | Execute the next story implementation |
| `/bmad-bmm-document-project` | Generate project documentation |
| `/bmad-bmm-onboarding` | Regenerate this onboarding guide |
-->

### Full Workflow Phases

<!-- PLACEHOLDER: bmad_workflow_phases -->
<!-- Fill with the phase-ordered workflow from bmad-help.csv:
1. Analysis — Brainstorm, Research, Create Brief
2. Planning — PRD, UX Design
3. Solutioning — Architecture, Epics & Stories, Readiness Check
4. Implementation — Sprint Planning, Create Story, Dev Story, Code Review
-->

---

## 7. Reference Documents

<!-- PLACEHOLDER: reference_documents -->
<!-- Fill with: links to existing documentation files -->
<!-- Example format:
- [Project Overview](./project-overview.md)
- [Source Tree](./source-tree.md)
- [Architecture](./architecture.md)
-->
<!-- If no documents exist, note that documentation can be generated with `/bmad-bmm-document-project` -->

---

## 8. Quick Start Checklist

<!-- PLACEHOLDER: quick_start_checklist -->
<!-- Fill with actionable checklist. Example:
- [ ] Clone repo and install dependencies
- [ ] Run the project locally
- [ ] Run the test suite
- [ ] Read CLAUDE.md for project rules
- [ ] Check sprint status: `/bmad-bmm-sprint-status`
- [ ] Review current epic/story assignments
- [ ] Pick up your first story: `/bmad-bmm-create-story`
-->