Skip to content
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
bad856c
Make workflow references platform-agnostic
dickymoore Feb 5, 2026
405e60c
Convert remaining Phase 1 workflows to MD
dickymoore Feb 5, 2026
8d07025
Add advanced-elicitation MD workflow and guard
dickymoore Feb 5, 2026
c769f1b
Convert Phase 2/3 workflows to MD
dickymoore Feb 5, 2026
1a1d4be
Migrate workflow runner references to workflow.md
dickymoore Feb 5, 2026
de63874
Remove workflow.xml runner and update CLI wording
dickymoore Feb 5, 2026
2224eda
Drop YAML workflow support from CLI tooling
dickymoore Feb 5, 2026
b9bc4c3
Fix remaining workflow.yaml/xml references
dickymoore Feb 6, 2026
cdddf77
Remove reintroduced TEA/excalidraw artifacts
dickymoore Feb 6, 2026
1a30dd7
Update validate-workflow references
dickymoore Feb 6, 2026
68c78ef
Migrate QA automate workflow to workflow.md
dickymoore Feb 6, 2026
5ca6922
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 7, 2026
5744bea
Migrate remaining workflows to workflow.md and fix CLI/test regressions
dickymoore Feb 7, 2026
f41430e
Finish step-flow migration for dev workflows and fix installer regres…
dickymoore Feb 7, 2026
76df097
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 7, 2026
0b3023c
fix: harden install XML guard and remove no-op placeholder replacement
dickymoore Feb 7, 2026
9b98cc1
fix: correct workflow command defaults and bmm document config paths
dickymoore Feb 7, 2026
d8e9caa
fix: add workflow loader fallback guidance and guards
dickymoore Feb 7, 2026
cc141b9
fix: resolve workflow guardrails and installer regressions
dickymoore Feb 8, 2026
bd20d75
fix: restore runtime workflow paths and standalone parsing
dickymoore Feb 8, 2026
d7a5539
fix: define installed workflow paths in qa and create-story
dickymoore Feb 8, 2026
00a2334
fix: align workflow path guidance with installed runtime
dickymoore Feb 8, 2026
40787c5
fix: restore help routing and external module install tolerance
dickymoore Feb 8, 2026
129f2d4
fix: hide internal workflow task from codex exports
dickymoore Feb 8, 2026
5042a89
Make workflow references platform-agnostic
dickymoore Feb 5, 2026
ba91d9c
Convert remaining Phase 1 workflows to MD
dickymoore Feb 5, 2026
730ba6b
Add advanced-elicitation MD workflow and guard
dickymoore Feb 5, 2026
a1bc1a3
Convert Phase 2/3 workflows to MD
dickymoore Feb 5, 2026
9054719
Migrate workflow runner references to workflow.md
dickymoore Feb 5, 2026
2212d92
Remove workflow.xml runner and update CLI wording
dickymoore Feb 5, 2026
0c34f52
Drop YAML workflow support from CLI tooling
dickymoore Feb 5, 2026
052cc83
Fix remaining workflow.yaml/xml references
dickymoore Feb 6, 2026
21efe68
Remove reintroduced TEA/excalidraw artifacts
dickymoore Feb 6, 2026
3aba7f0
Update validate-workflow references
dickymoore Feb 6, 2026
c636042
Migrate QA automate workflow to workflow.md
dickymoore Feb 6, 2026
7fc8318
Migrate remaining workflows to workflow.md and fix CLI/test regressions
dickymoore Feb 7, 2026
87c4292
Finish step-flow migration for dev workflows and fix installer regres…
dickymoore Feb 7, 2026
454ae91
fix: harden install XML guard and remove no-op placeholder replacement
dickymoore Feb 7, 2026
cfdb2db
fix: correct workflow command defaults and bmm document config paths
dickymoore Feb 7, 2026
2a9b447
fix: add workflow loader fallback guidance and guards
dickymoore Feb 7, 2026
3feb0d3
fix: resolve workflow guardrails and installer regressions
dickymoore Feb 8, 2026
e86fa2e
fix: restore runtime workflow paths and standalone parsing
dickymoore Feb 8, 2026
9883169
fix: define installed workflow paths in qa and create-story
dickymoore Feb 8, 2026
9604f6d
fix: align workflow path guidance with installed runtime
dickymoore Feb 8, 2026
5caf92c
fix: restore help routing and external module install tolerance
dickymoore Feb 8, 2026
f74f604
fix: hide internal workflow task from codex exports
dickymoore Feb 8, 2026
25354fc
Merge remote-tracking branch 'origin/phase1-md-workflows-clean' into …
dickymoore Feb 8, 2026
e7d7bbc
docs(correct-course): clarify installed vs source workflow paths
dickymoore Feb 8, 2026
a1c0540
refine workflow contracts for review findings, halt protocol, and spr…
dickymoore Feb 8, 2026
45a9f3b
test: remove redundant validate-workflow exclusion in guard scan
dickymoore Feb 8, 2026
bff2808
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 8, 2026
3a7d893
fix(kiro): migrate yaml workflow template runner to workflow.md
dickymoore Feb 8, 2026
80328a6
fix: restore help grounding and align installer defaults
dickymoore Feb 8, 2026
e0cfff5
fix: tighten workflow routing and validation consistency
dickymoore Feb 8, 2026
d87d654
fix(document-project): gate resume completion on subworkflow success
dickymoore Feb 8, 2026
c1484c3
fix: restore workflow input contracts after md migration
dickymoore Feb 8, 2026
c916b78
chore: acknowledge migration scope and request focused review
dickymoore Feb 8, 2026
a94df6d
fix: address latest coderabbit workflow guidance issues
dickymoore Feb 8, 2026
197c0f1
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 8, 2026
ee7f5a8
fix: harden document workflow choices and config path handling
dickymoore Feb 8, 2026
c108ae4
fix: remove stale xml docs reference and tighten workflow wording
dickymoore Feb 8, 2026
dde139a
fix: restore installer edge-case handling and path normalization
dickymoore Feb 8, 2026
0a3f48f
fix: address coderabbit workflow migration follow-ups
dickymoore Feb 8, 2026
3aaa371
fix: route IDE workflow templates through workflow runner
dickymoore Feb 8, 2026
5e8289f
test: expand workflow reference guard to scan installer JS
dickymoore Feb 8, 2026
95b4370
fix: clarify create-story context extraction and state age handling
dickymoore Feb 8, 2026
3c1df00
Merge remote-tracking branch 'upstream/main' into phase1-md-workflows…
dickymoore Feb 8, 2026
9987a25
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 9, 2026
0ba1167
fix: normalize custom bmad workflow paths in command generation
dickymoore Feb 9, 2026
988bb07
test: guard workflow template paths for custom bmad folders
dickymoore Feb 9, 2026
7c498a9
Merge remote-tracking branch 'upstream/main' into phase1-md-workflows…
dickymoore Feb 9, 2026
02a43f9
Merge remote-tracking branch 'upstream/main' into phase1-md-workflows…
dickymoore Feb 10, 2026
4409df7
Merge remote-tracking branch 'upstream/main' into phase1-md-workflows…
dickymoore Feb 10, 2026
79648df
Merge branch 'main' into phase1-md-workflows-clean
dickymoore Feb 11, 2026
096305f
Merge remote-tracking branch 'upstream/main' into phase1-md-workflows…
dickymoore Feb 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 36 additions & 40 deletions docs/tutorials/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,7 @@ The installer creates two folders:
- `_bmad/` — agents, workflows, tasks, and configuration
- `_bmad-output/` — empty for now, but this is where your artifacts will be saved

Open your AI IDE in the project folder. Run the `help` workflow (`/bmad-help`) to see what to do next — it detects what you've completed and recommends the next step.

:::note[How to Load Agents and Run Workflows]
Each workflow has a **slash command** you run in your IDE (e.g., `/bmad-bmm-create-prd`). Running a workflow command automatically loads the appropriate agent — you don't need to load agents separately. You can also load an agent directly for general conversation (e.g., `/bmad-agent-bmm-pm` for the PM agent).
:::
Open your AI IDE in the project folder. Run the `help` workflow (`bmad-help` on most platforms) to see what to do next — it detects what you've completed and recommends the next step.

:::caution[Fresh Chats]
Always start a fresh chat for each workflow. This prevents context limitations from causing issues.
Expand All @@ -82,29 +78,29 @@ Work through phases 1-3. **Use fresh chats for each workflow.**
### Phase 1: Analysis (Optional)

All workflows in this phase are optional:
- **brainstorming** (`/bmad-brainstorming`) — Guided ideation
- **research** (`/bmad-bmm-research`) — Market and technical research
- **create-product-brief** (`/bmad-bmm-create-product-brief`) — Recommended foundation document
- **brainstorming** — Guided ideation
- **research** — Market and technical research
- **create-product-brief** — Recommended foundation document

### Phase 2: Planning (Required)

**For BMad Method and Enterprise tracks:**
1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
2. Run the `prd` workflow (`/bmad-bmm-create-prd`)
1. Load the **PM agent** in a new chat
2. Run the `prd` workflow
3. Output: `PRD.md`

**For Quick Flow track:**
- Use the `quick-spec` workflow (`/bmad-bmm-quick-spec`) instead of PRD, then skip to implementation
- Use the `quick-spec` workflow instead of PRD, then skip to implementation

:::note[UX Design (Optional)]
If your project has a user interface, load the **UX-Designer agent** (`/bmad-agent-bmm-ux-designer`) and run the UX design workflow (`/bmad-bmm-create-ux-design`) after creating your PRD.
If your project has a user interface, load the **UX-Designer agent** and run the UX design workflow after creating your PRD.
:::

### Phase 3: Solutioning (BMad Method/Enterprise)

**Create Architecture**
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
2. Run `create-architecture` (`/bmad-bmm-create-architecture`)
1. Load the **Architect agent** in a new chat
2. Run `create-architecture`
3. Output: Architecture document with technical decisions

**Create Epics and Stories**
Expand All @@ -113,13 +109,13 @@ If your project has a user interface, load the **UX-Designer agent** (`/bmad-age
Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down.
:::

1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
2. Run `create-epics-and-stories` (`/bmad-bmm-create-epics-and-stories`)
1. Load the **PM agent** in a new chat
2. Run `create-epics-and-stories`
3. The workflow uses both PRD and Architecture to create technically-informed stories

**Implementation Readiness Check** *(Highly Recommended)*
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
2. Run `check-implementation-readiness` (`/bmad-bmm-check-implementation-readiness`)
1. Load the **Architect agent** in a new chat
2. Run `check-implementation-readiness`
3. Validates cohesion across all planning documents

## Step 2: Build Your Project
Expand All @@ -128,19 +124,19 @@ Once planning is complete, move to implementation. **Each workflow should run in

### Initialize Sprint Planning

Load the **SM agent** (`/bmad-agent-bmm-sm`) and run `sprint-planning` (`/bmad-bmm-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories.

### The Build Cycle

For each story, repeat this cycle with fresh chats:

| Step | Agent | Workflow | Command | Purpose |
| ---- | ----- | -------------- | -------------------------- | ---------------------------------- |
| 1 | SM | `create-story` | `/bmad-bmm-create-story` | Create story file from epic |
| 2 | DEV | `dev-story` | `/bmad-bmm-dev-story` | Implement the story |
| 3 | DEV | `code-review` | `/bmad-bmm-code-review` | Quality validation *(recommended)* |
| Step | Agent | Workflow | Purpose |
| ---- | ----- | -------------- | ---------------------------------- |
| 1 | SM | `create-story` | Create story file from epic |
| 2 | DEV | `dev-story` | Implement the story |
| 3 | DEV | `code-review` | Quality validation *(recommended)* |

After completing all stories in an epic, load the **SM agent** (`/bmad-agent-bmm-sm`) and run `retrospective` (`/bmad-bmm-retrospective`).
After completing all stories in an epic, load the **SM agent** and run `retrospective`.

## What You've Accomplished

Expand All @@ -166,28 +162,28 @@ your-project/

## Quick Reference

| Workflow | Command | Agent | Purpose |
| -------------------------------- | ------------------------------------------ | --------- | ------------------------------------ |
| `help` | `/bmad-help` | Any | Get guidance on what to do next |
| `prd` | `/bmad-bmm-create-prd` | PM | Create Product Requirements Document |
| `create-architecture` | `/bmad-bmm-create-architecture` | Architect | Create architecture document |
| `create-epics-and-stories` | `/bmad-bmm-create-epics-and-stories` | PM | Break down PRD into epics |
| `check-implementation-readiness` | `/bmad-bmm-check-implementation-readiness` | Architect | Validate planning cohesion |
| `sprint-planning` | `/bmad-bmm-sprint-planning` | SM | Initialize sprint tracking |
| `create-story` | `/bmad-bmm-create-story` | SM | Create a story file |
| `dev-story` | `/bmad-bmm-dev-story` | DEV | Implement a story |
| `code-review` | `/bmad-bmm-code-review` | DEV | Review implemented code |
| Workflow | Agent | Purpose |
| -------------------------------- | --------- | ------------------------------------ |
| `help` | Any | Get guidance on what to do next |
| `prd` | PM | Create Product Requirements Document |
| `create-architecture` | Architect | Create architecture document |
| `create-epics-and-stories` | PM | Break down PRD into epics |
| `check-implementation-readiness` | Architect | Validate planning cohesion |
| `sprint-planning` | SM | Initialize sprint tracking |
| `create-story` | SM | Create a story file |
| `dev-story` | DEV | Implement a story |
| `code-review` | DEV | Review implemented code |

## Common Questions

**Do I always need architecture?**
Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.

**Can I change my plan later?**
Yes. The SM agent has a `correct-course` workflow (`/bmad-bmm-correct-course`) for handling scope changes.
Yes. The SM agent has a `correct-course` workflow for handling scope changes.

**What if I want to brainstorm first?**
Load the Analyst agent (`/bmad-agent-bmm-analyst`) and run `brainstorming` (`/bmad-brainstorming`) before starting your PRD.
Load the Analyst agent and run `brainstorming` before starting your PRD.

**Do I need to follow a strict order?**
Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.
Expand All @@ -196,14 +192,14 @@ Not strictly. Once you learn the flow, you can run workflows directly using the

- **During workflows** — Agents guide you with questions and explanations
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Stuck?** — Run `help` (`/bmad-help`) to see what to do next
- **Stuck?** — Run `help` to see what to do next

## Key Takeaways

:::tip[Remember These]
- **Always use fresh chats** — Start a new chat for each workflow
- **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture
- **Use `help` (`/bmad-help`) when stuck** — It detects your progress and suggests next steps
- **Use `help` when stuck** — It detects your progress and suggests next steps
:::

Ready to start? Install BMad and let the agents guide you through your first project.
2 changes: 1 addition & 1 deletion src/bmm/agents/qa.agent.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ agent:

menu:
- trigger: QA or fuzzy match on qa-automate
workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml"
workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.md"
description: "[QA] Automate - Generate tests for existing features (simplified)"

prompts:
Expand Down
Loading
Loading