Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 5.32 KB

File metadata and controls

179 lines (125 loc) · 5.32 KB

Quickstart

Pick your flow, run the commands.


What Do I Need To Do?

I want to... Flow Jump to
Build a new product from scratch Full Lifecycle New Product
Add a large feature (new epic) Mini-PRD Large Feature
Add a small feature (1-3 stories) Ad-Hoc Dev Small Feature
Fix a bug Bugfix Bug Fix
Handle a mid-sprint change Course Correct Mid-Sprint Change
Check sprint progress Status Check Sprint Status
Make a trivial tweak Just do it Direct edit + git commit

New Product

Full lifecycle. Run these in order:

/bmad-bmm-create-product-brief     # 1. Define the product idea
/bmad-bmm-create-prd               # 2. Write requirements (PRD)
/bmad-bmm-create-ux-design         # 3. Design the UX (optional)
/bmad-bmm-create-architecture      # 4. Make architecture decisions
/bmad-bmm-create-epics-and-stories # 5. Break into epics & stories
/bmad-bmm-check-implementation-readiness  # 6. Validate everything aligns
/init-sprint                        # 7. Initialize sprint tracking
/make-stories                       # 8. Prepare stories for dev
/ship-story                         # 9. Implement, review, commit (repeat)

Outputs: planning_artifacts/ gets brief, PRD, UX spec, architecture, and epics. sprint-status.yaml tracks progress. Story files land in implementation_artifacts/.


Large Feature

New epic-sized work added to an existing project.

/bmad-bmm-edit-prd                  # 1. Add requirements to existing PRD
/bmad-bmm-create-architecture       # 2. Update architecture if needed (or edit manually)
/bmad-bmm-create-epics-and-stories  # 3. Generate new epics/stories from updated PRD
/init-sprint                        # 4. Refresh sprint tracking
/make-stories                       # 5. Prepare stories
/ship-story                         # 6. Implement (repeat per story)

Skip step 2 if no new architectural decisions are needed.


Small Feature

1-3 stories, no PRD update needed.

Option A: Use the story generator

/make-stories                       # 1. Create story files
/ship-story                         # 2. Implement, review, commit

Option B: Write a quick story manually

Create a file in implementation_artifacts/ using the minimal template:

# ad-hoc-1: Short descriptive title

Status: ready-for-dev

## Story
As a <role>, I want <goal>, so that <benefit>.

## Acceptance Criteria
1. Given <context> When <action> Then <outcome>

## Tasks
- [ ] Task 1
- [ ] Task 2

Then ship it:

/ship-story                         # Dev → test → review → commit

Update sprint-status.yaml to include the new story if you're tracking sprint progress.


Bug Fix

/bugfix <path-to-story-file>

The story file should describe the bug/failing tests. The agent will: investigate root cause, fix the code, run the auditor, and commit when tests pass.

Commit format: [story-id] fix: description

If you don't have a story file yet, create a minimal one describing the bug, then run /bugfix on it.


Mid-Sprint Change

When something disrupts the current plan (new requirements, failed approach, technical limitation):

/bmad-bmm-correct-course

This analyzes impact across PRD, architecture, UX, and epics, then produces a Sprint Change Proposal routed by scope:

  • Minor - Dev team handles directly
  • Moderate - Backlog reorg needed
  • Major - Fundamental replan with PM/Architect

When to use this vs. just adding a story:

  • Change conflicts with existing work → Correct Course
  • Change is additive and independent → Just add a story
  • Change represents an uncaptured requirement → Update PRD first, then add stories

Sprint Status

/bmad-bmm-sprint-status             # Summary, risks, next action recommendation
/init-sprint                        # Regenerate sprint-status.yaml from current state

Story lifecycle: backlogready-for-devin-progressreviewdone


Other Useful Commands

Command What it does
/bmad-bmm-validate-prd Check PRD quality against BMAD standards
/bmad-bmm-code-review Run adversarial code review on a story
/test-review Score test quality across 5 dimensions
/document Scan and document the project
/understand-context Load context for a specific topic
/create-component Scaffold a new component

Minimum Viable Process

How much ceremony does your change actually need?

Change Artifacts Commands
Config tweak None Edit + git commit
Bug fix Bug story file /bugfix
1 story Story file /ship-story
2-5 stories Updated PRD + stories /bmad-bmm-edit-prd/make-stories/ship-story
New epic PRD + architecture + epic Full Large Feature flow
New product Everything Full New Product flow

Key Paths

planning_artifacts/          # PRD, architecture, epics, UX spec, brief
implementation_artifacts/    # Story files
sprint-status.yaml           # Sprint tracking
AGENTS.md                    # Root project context (auto-updated by ship-story)
_bmad/bmm/templates/         # Story templates