docs: update for v6-alpha workflow changes

- Replace *plan-project with *prd, *tech-spec, and *gdd across 15 files
  - Add sprint-status documentation for Level 4 projects
  - Update workflow diagrams and examples throughout
  - Document two-tier status tracking system (workflow-status vs sprint-status)
  - Add consistency for prd/tech-spec alternatives in testarch docs

  Closes #811

  Resolves documentation discrepancies introduced in commits:
  - b8db080 (architecture name standardization)
  - 419043e (sprint planning)
  - ddaefa3 (sprint plan for level 4)
This commit is contained in:
Gabriel Tauber 2025-10-22 15:20:17 -03:00
parent ddaefa3284
commit 4fe225feac
15 changed files with 72 additions and 39 deletions

View File

@ -201,7 +201,9 @@ The BMM module follows a comprehensive four-phase methodology. Each phase adapts
**PM Agent**: **PM Agent**:
- `plan-project` - Creates scale-adaptive PRD or GDD - `prd` - Creates Product Requirements Document for Level 2-4 projects
- `tech-spec` - Creates Technical Specification for Level 0-1 projects
- `gdd` - Creates Game Design Document for game projects (via Game Designer agent)
The planning workflow adapts to: The planning workflow adapts to:
@ -239,10 +241,18 @@ The planning workflow adapts to:
**Scrum Master (SM) Agent**: **Scrum Master (SM) Agent**:
Before development starts, the SM prepares each story: Before development starts:
1. `create-story` - Generates story from tech spec and context 1. **Level 4 Projects Only**: Run `sprint-planning` workflow
2. `story-context` - **🎉 NEW!** Game-changing contextual preparation - Generates `sprint-status.yaml` from epic files
- Tracks all epics and stories through implementation
- Auto-detects current status based on files
- Provides single source of truth for Phase 4 progress
Then, for each story, the SM prepares:
2. `create-story` - Generates story from tech spec and context
3. `story-context` - **🎉 NEW!** Game-changing contextual preparation
- Real-time context gathering for the specific story - Real-time context gathering for the specific story
- No more generic file lists - No more generic file lists
- Supercharged, specialized development context - Supercharged, specialized development context

View File

@ -31,14 +31,30 @@ The heart of BMM - structured workflows for the four development phases:
- `product-brief` - Product strategy - `product-brief` - Product strategy
2. **Planning Phase** (Required) 2. **Planning Phase** (Required)
- `plan-project` - Scale-adaptive project planning - `prd` - Product Requirements Document (Level 2-4)
- `tech-spec` - Technical Specification (Level 0-1)
- Routes to appropriate documentation based on project complexity - Routes to appropriate documentation based on project complexity
3. **Solutioning Phase** (Level 3-4 projects) 3. **Solutioning Phase** (Level 3-4 projects)
- `3-solutioning` - Architecture design - `3-solutioning` - Architecture design
- `tech-spec` - Epic-specific technical specifications - `tech-spec` - Epic-specific technical specifications
4. **Implementation Phase** (Iterative) ### Status Tracking in BMM
BMM uses two complementary status systems:
1. **workflow-status.md** (Phases 1-3)
- Tracks progress through Analysis, Planning, and Solutioning
- Used by `*workflow-init` and `*workflow-status` commands
- Single source of truth for project configuration
2. **sprint-status.yaml** (Phase 4 - Level 4 only)
- Tracks implementation progress for complex projects
- Generated by `*sprint-planning` workflow
- Maintains epic and story status throughout development
- Auto-detects status based on file existence
3. **Implementation Phase** (Iterative)
- `create-story` - Story drafting (SM agent) - `create-story` - Story drafting (SM agent)
- `story-ready` - Approve story for development (SM agent) - `story-ready` - Approve story for development (SM agent)
- `story-context` - Expertise injection (SM agent) - `story-context` - Expertise injection (SM agent)
@ -68,8 +84,13 @@ Test architecture and quality assurance components. The **[Test Architect (TEA)
```bash ```bash
# Load the PM agent - either via slash command or drag and drop or @ the agent file. # Load the PM agent - either via slash command or drag and drop or @ the agent file.
# Once loaded, the agent should greet you and offer a menu of options. You can enter: # Once loaded, the agent should greet you and offer a menu of options.
`*plan-project`
# For Level 2-4 projects:
`*prd`
# For Level 0-1 projects:
`*tech-spec`
``` ```
## Key Concepts ## Key Concepts

View File

@ -1,5 +1,5 @@
--- ---
last-redoc-date: 2025-10-14 last-redoc-date: 2025-10-22
--- ---
# Test Architect (TEA) Agent Guide # Test Architect (TEA) Agent Guide
@ -18,7 +18,7 @@ TEA integrates across the entire BMad development lifecycle, providing quality a
┌──────────────────────────────────────────────────────────┐ ┌──────────────────────────────────────────────────────────┐
│ BMM Phase 2: PLANNING │ │ BMM Phase 2: PLANNING │
│ │ │ │
│ PM: *plan-project │ PM: *prd or *tech-spec
│ ↓ │ │ ↓ │
│ TEA: *framework ──→ *ci ──→ *test-design │ │ TEA: *framework ──→ *ci ──→ *test-design │
│ └─────────┬─────────────┘ │ │ └─────────┬─────────────┘ │
@ -105,7 +105,7 @@ This complexity **requires specialized documentation** (this guide), **extensive
1. Run the core planning workflows first: 1. Run the core planning workflows first:
- Analyst `*product-brief` - Analyst `*product-brief`
- Product Manager `*plan-project` - Product Manager `*prd` (Level 2-4) or `*tech-spec` (Level 0-1)
- Architect `*create-architecture` - Architect `*create-architecture`
2. Confirm `bmad/bmm/config.yaml` defines `project_name`, `output_folder`, `dev_story_location`, and language settings. 2. Confirm `bmad/bmm/config.yaml` defines `project_name`, `output_folder`, `dev_story_location`, and language settings.
3. Ensure a test test framework setup exists; if not, use `*framework` command to create a test framework setup, prior to development. 3. Ensure a test test framework setup exists; if not, use `*framework` command to create a test framework setup, prior to development.
@ -116,14 +116,14 @@ This complexity **requires specialized documentation** (this guide), **extensive
### Greenfield Feature Launch (Level 2) ### Greenfield Feature Launch (Level 2)
| Phase | Test Architect | Dev / Team | Outputs | | Phase | Test Architect | Dev / Team | Outputs |
| ------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | | ------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Setup | - | Analyst `*product-brief`, PM `*plan-project`, Architect `*create-architecture` | `{output_folder}/product-brief*.md`, `PRD.md`, `epics.md`, `architecture.md` | | Setup | - | Analyst `*product-brief`, PM `*prd` or `*tech-spec`, Architect `*create-architecture` | `{output_folder}/product-brief*.md`, `PRD.md`/`tech-spec.md`, `epics.md`, `architecture.md` |
| Pre-Implementation | Run `*framework` (if harness missing), `*ci`, and `*test-design` | Review risk/design/CI guidance, align backlog | Test scaffold, CI pipeline, risk and coverage strategy | | Pre-Implementation | Run `*framework` (if harness missing), `*ci`, and `*test-design` | Review risk/design/CI guidance, align backlog | Test scaffold, CI pipeline, risk and coverage strategy |
| Story Prep | - | Scrum Master `*create-story`, `*story-context` | Story markdown + context XML | | Story Prep | - | Scrum Master `*create-story`, `*story-context` | Story markdown + context XML |
| Implementation | (Optional) Trigger `*atdd` before dev to supply failing tests + checklist | Implement story guided by ATDD checklist | Failing acceptance tests + implementation checklist | | Implementation | (Optional) Trigger `*atdd` before dev to supply failing tests + checklist | Implement story guided by ATDD checklist | Failing acceptance tests + implementation checklist |
| Post-Dev | Execute `*automate`, (Optional) `*test-review`, re-run `*trace` | Address recommendations, update code/tests | Regression specs, quality report, refreshed coverage matrix | | Post-Dev | Execute `*automate`, (Optional) `*test-review`, re-run `*trace` | Address recommendations, update code/tests | Regression specs, quality report, refreshed coverage matrix |
| Release | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary (owners, waivers) | | Release | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary (owners, waivers) |
<details> <details>
<summary>Execution Notes</summary> <summary>Execution Notes</summary>
@ -139,7 +139,7 @@ This complexity **requires specialized documentation** (this guide), **extensive
<details> <details>
<summary>Worked Example “Nova CRM” Greenfield Feature</summary> <summary>Worked Example “Nova CRM” Greenfield Feature</summary>
1. **Planning:** Analyst runs `*product-brief`; PM executes `*plan-project` to produce PRD and epics; Architect completes `*create-architecture` for the new module. 1. **Planning:** Analyst runs `*product-brief`; PM executes `*prd` (or `*tech-spec` for simpler projects) to produce PRD and epics; Architect completes `*create-architecture` for the new module.
2. **Setup:** TEA checks harness via `*framework`, configures `*ci`, and runs `*test-design` to capture risk/coverage plans. 2. **Setup:** TEA checks harness via `*framework`, configures `*ci`, and runs `*test-design` to capture risk/coverage plans.
3. **Story Prep:** Scrum Master generates the story via `*create-story`; PO validates using `*solutioning-gate-check`. 3. **Story Prep:** Scrum Master generates the story via `*create-story`; PO validates using `*solutioning-gate-check`.
4. **Implementation:** TEA optionally runs `*atdd`; Dev implements with guidance from failing tests and the plan. 4. **Implementation:** TEA optionally runs `*atdd`; Dev implements with guidance from failing tests and the plan.
@ -174,7 +174,7 @@ This complexity **requires specialized documentation** (this guide), **extensive
<details> <details>
<summary>Worked Example “Atlas Payments” Brownfield Story</summary> <summary>Worked Example “Atlas Payments” Brownfield Story</summary>
1. **Context Refresh:** Analyst reruns `*product-brief`; PM executes `*plan-project` to update PRD, analysis, and `epics.md`; Architect triggers `*create-architecture` capturing legacy payment flows. 1. **Context Refresh:** Analyst reruns `*product-brief`; PM executes `*prd` (or `*tech-spec`) to update PRD, analysis, and `epics.md`; Architect triggers `*create-architecture` capturing legacy payment flows.
2. **Baseline Coverage:** TEA executes `*trace` to record current coverage in `docs/qa/assessments/atlas-payment-trace.md`. 2. **Baseline Coverage:** TEA executes `*trace` to record current coverage in `docs/qa/assessments/atlas-payment-trace.md`.
3. **Risk and Design:** `*test-design` flags settlement edge cases, plans mitigations, and allocates new API/E2E scenarios with P0 priorities. 3. **Risk and Design:** `*test-design` flags settlement edge cases, plans mitigations, and allocates new API/E2E scenarios with P0 priorities.
4. **Story Prep:** Scrum Master generates `stories/story-1.1.md` via `*create-story`, automatically pulling updated context. 4. **Story Prep:** Scrum Master generates `stories/story-1.1.md` via `*create-story`, automatically pulling updated context.

View File

@ -100,7 +100,7 @@
2. Consider running: 2. Consider running:
- `research` workflow for market/game research - `research` workflow for market/game research
- `game-brief` workflow to formalize game vision - `game-brief` workflow to formalize game vision
- Or proceed directly to `plan-project` if ready - Or proceed directly to `gdd` workflow if ready
{{#if standalone_mode != true}} {{#if standalone_mode != true}}
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`

View File

@ -79,7 +79,7 @@
2. Consider running: 2. Consider running:
- `research` workflow for market/technical research - `research` workflow for market/technical research
- `product-brief` workflow to formalize product vision - `product-brief` workflow to formalize product vision
- Or proceed directly to `plan-project` if ready - Or proceed directly to `prd` (Level 2-4) or `tech-spec` (Level 0-1) if ready
{{#if standalone_mode != true}} {{#if standalone_mode != true}}
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`

View File

@ -43,7 +43,7 @@
<check if="warning != ''"> <check if="warning != ''">
<output>{{warning}}</output> <output>{{warning}}</output>
<output>Note: This may be auto-invoked by plan-project for brownfield documentation.</output> <output>Note: This may be auto-invoked by prd or tech-spec for brownfield documentation.</output>
<ask>Continue with documentation? (y/n)</ask> <ask>Continue with documentation? (y/n)</ask>
<check if="n"> <check if="n">
<output>{{suggestion}}</output> <output>{{suggestion}}</output>

View File

@ -340,7 +340,7 @@ This brief will serve as the primary input for creating the Game Design Document
1. Review the game brief document 1. Review the game brief document
2. Consider creating a prototype of core mechanic 2. Consider creating a prototype of core mechanic
3. Run `plan-project` workflow to create GDD from this brief 3. Run `gdd` workflow to create GDD from this brief
4. Validate assumptions with target players 4. Validate assumptions with target players
{{#if standalone_mode != true}} {{#if standalone_mode != true}}

View File

@ -304,7 +304,7 @@ This brief will serve as the primary input for creating the Product Requirements
1. Review the product brief document 1. Review the product brief document
2. Gather any additional stakeholder input 2. Gather any additional stakeholder input
3. Run `plan-project` workflow to create PRD from this brief 3. Run `prd` workflow to create PRD from this brief (Level 2-4 projects)
{{#if standalone_mode != true}} {{#if standalone_mode != true}}
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`

View File

@ -405,7 +405,7 @@ Select option (1-4):</ask>
1. Execute the research prompt with your chosen AI platform 1. Execute the research prompt with your chosen AI platform
2. Gather and analyze findings 2. Gather and analyze findings
3. Run `plan-project` to incorporate findings 3. Run `prd` or `tech-spec` to incorporate findings
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`
</output> </output>
@ -423,7 +423,7 @@ Note: Running in standalone mode (no status file).
**Next Steps:** **Next Steps:**
1. Execute the research prompt with AI platform 1. Execute the research prompt with AI platform
2. Run plan-project workflow 2. Run prd or tech-spec workflow
</output> </output>
</check> </check>
</step> </step>

View File

@ -587,7 +587,7 @@ Create compelling executive summary with:
2. Share with stakeholders 2. Share with stakeholders
3. Consider running: 3. Consider running:
- `product-brief` or `game-brief` to formalize vision - `product-brief` or `game-brief` to formalize vision
- `plan-project` if ready to create PRD/GDD - `prd` (software Level 2-4) or `gdd` (games) if ready to create PRD/GDD
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`
</output> </output>
@ -607,7 +607,7 @@ To track progress across workflows, run `workflow-status` first.
**Next Steps:** **Next Steps:**
1. Review research findings 1. Review research findings
2. Run product-brief or plan-project workflows 2. Run product-brief, prd, or gdd workflows
</output> </output>
</check> </check>
</step> </step>

View File

@ -473,7 +473,7 @@ Select option (1-5):</ask>
1. Review technical research findings 1. Review technical research findings
2. Share with architecture team 2. Share with architecture team
3. Run `plan-project` to incorporate findings into PRD 3. Run `prd` workflow to incorporate findings into PRD (Level 2-4)
Check status anytime with: `workflow-status` Check status anytime with: `workflow-status`
</output> </output>
@ -491,7 +491,7 @@ Note: Running in standalone mode (no status file).
**Next Steps:** **Next Steps:**
1. Review technical research findings 1. Review technical research findings
2. Run plan-project workflow 2. Run prd or tech-spec workflow
</output> </output>
</check> </check>
</step> </step>

View File

@ -6,7 +6,7 @@
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical> <critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
<critical>Generate all documents in {document_output_language}</critical> <critical>Generate all documents in {document_output_language}</critical>
<critical>This workflow creates comprehensive UX/UI specifications - can run standalone or as part of plan-project</critical> <critical>This workflow creates comprehensive UX/UI specifications - can run standalone or as part of prd workflow</critical>
<critical>Uses ux-spec-template.md for structured output generation</critical> <critical>Uses ux-spec-template.md for structured output generation</critical>
<critical>Can optionally generate AI Frontend Prompts for tools like Vercel v0, Lovable.ai</critical> <critical>Can optionally generate AI Frontend Prompts for tools like Vercel v0, Lovable.ai</critical>

View File

@ -1,5 +1,5 @@
--- ---
last-redoc-date: 2025-10-12 last-redoc-date: 2025-10-22
--- ---
# BMM Workflows - The Complete v6 Flow # BMM Workflows - The Complete v6 Flow
@ -32,7 +32,7 @@ The BMM (BMAD Method Module) orchestrates software development through four dist
│ PHASE 2: PLANNING │ │ PHASE 2: PLANNING │
│ (Scale-Adaptive Router - by type) │ │ (Scale-Adaptive Router - by type) │
├──────────────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────────────┤
│ SOFTWARE: plan-project GAMES: gdd │ SOFTWARE: prd (L2-4) / tech-spec (L0-1) GAMES: gdd
│ ├──→ Level 0: tech-spec only ├──→ GDD (all levels) │ │ ├──→ Level 0: tech-spec only ├──→ GDD (all levels) │
│ ├──→ Level 1: tech-spec only └──→ Narrative design │ │ ├──→ Level 1: tech-spec only └──→ Narrative design │
│ ├──→ Level 2: PRD + tech-spec │ │ ├──→ Level 2: PRD + tech-spec │
@ -52,6 +52,8 @@ The BMM (BMAD Method Module) orchestrates software development through four dist
│ PHASE 4: IMPLEMENTATION │ │ PHASE 4: IMPLEMENTATION │
│ (Iterative Cycle) │ │ (Iterative Cycle) │
├──────────────────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────────────────┤
│ [Level 4 only] sprint-planning ──→ creates sprint-status.yaml│
│ ↓ │
│ ┌─→ create-story ──→ story-context ──→ dev-story ──┐ │ │ ┌─→ create-story ──→ story-context ──→ dev-story ──┐ │
│ │ ↓ │ │ │ ↓ │
│ │ retrospective ←── [epic done] ←────── review-story │ │ │ retrospective ←── [epic done] ←────── review-story │
@ -358,7 +360,7 @@ Status: Done (User approved via story-done, DoD complete)
### Brownfield Projects ### Brownfield Projects
``` ```
plan-project (Phase 2) Phase 2 Planning (prd or tech-spec based on level)
├─→ Check: Is existing codebase documented? ├─→ Check: Is existing codebase documented?
│ ├─→ YES: Proceed with planning │ ├─→ YES: Proceed with planning
│ └─→ NO: HALT with message: │ └─→ NO: HALT with message:
@ -454,7 +456,7 @@ plan-project (Phase 2)
| Creating all tech specs upfront | Use JIT approach - one epic at a time | | Creating all tech specs upfront | Use JIT approach - one epic at a time |
| Skipping story-context generation | Always run after create-story | | Skipping story-context generation | Always run after create-story |
| Batching story creation | Create one story at a time | | Batching story creation | Create one story at a time |
| Ignoring scale levels | Let plan-project determine level | | Ignoring scale levels | Use prd for L2-4, tech-spec for L0-1 |
| Planning brownfield without docs | Run brownfield-analysis first | | Planning brownfield without docs | Run brownfield-analysis first |
| Not running retrospectives | Schedule after every epic | | Not running retrospectives | Schedule after every epic |

View File

@ -130,7 +130,7 @@ Automatically consults TEA knowledge base:
**Before framework:** **Before framework:**
- **plan-project** (Phase 2): Determines project scope and testing needs - **prd** or **tech-spec** (Phase 2): Determines project scope and testing needs
- **workflow-status**: Verifies project readiness - **workflow-status**: Verifies project readiness
**After framework:** **After framework:**

View File

@ -304,7 +304,7 @@ Automatically consults TEA knowledge base:
**Before test-design:** **Before test-design:**
- **plan-project** (Phase 2): Creates PRD and epics - **prd** or **tech-spec** (Phase 2): Creates PRD/epics (Level 2-4) or tech-spec (Level 0-1)
- **architecture** (Phase 3): Defines technical approach - **architecture** (Phase 3): Defines technical approach
- **tech-spec** (Phase 3): Implementation details - **tech-spec** (Phase 3): Implementation details