ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

Fix phase numbering throughout documentation 

- Removed all references to Phase 0 (should be Documentation prerequisite)
- Updated phase transitions from 'Phase 3→4' to 'Phase 3 to Phase 4'
- Ensured all phases are numbered 1-4 consistently
- Documentation for brownfield projects is now correctly referred to as 'Documentation prerequisite' rather than Phase 0
This commit is contained in:
Brian Madison 2025-11-26 20:59:46 -06:00
parent 04b328bd2a
commit dcaf02f665
6 changed files with 36 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/modules/bmm/docs/README.md
View File

@ -104,7 +104,7 @@ Essential reference materials:
**Work with existing codebase (brownfield)**
→ Read [Brownfield Development Guide](./brownfield-guide.md)
→ Pay special attention to Phase 0 documentation requirements
→ Pay special attention to documentation requirements for brownfield projects
**Understand planning tracks and methodology**
→ See [Scale Adaptive System](./scale-adaptive-system.md)

11
src/modules/bmm/docs/agents-guide.md
View File

@ -103,7 +103,6 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age
- Creating product briefs for strategic planning
- Conducting research (market, technical, competitive)
- Documenting existing projects (brownfield)
- Phase 0 documentation needs
**Primary Phase:** Phase 1 (Analysis)
@ -137,7 +136,7 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age
- Creating system architecture for Level 2-4 projects
- Making technical design decisions
- Validating architecture documents
- Validating readiness for implementation phase (Phase 3→4 transition)
- Validating readiness for implementation phase (Phase 3 to Phase 4 transition)
- Course correction during implementation
**Primary Phase:** Phase 3 (Solutioning)
@ -348,7 +347,7 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age
**When to Use:**
- Documenting brownfield projects (Phase 0)
- Documenting brownfield projects (Documentation prerequisite)
- Creating API documentation
- Generating architecture documentation
- Writing user guides and tutorials
@ -492,7 +491,7 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age
- `workflow-status` - Check what to do next
- `create-architecture` - Game systems architecture
- `implementation-readiness` - Validate Phase 3→4 transition
- `implementation-readiness` - Validate Phase 3 to Phase 4 transition
- `correct-course` - Handle technical changes
**Communication Style:** Calm and measured. Systematic thinking about complex systems. Uses chess metaphors and military strategy. Emphasizes balance and elegance.
@ -958,8 +957,8 @@ Agent analyzes project state → recommends next workflow
```
Each phase has validation gates:
- Phase 2→3: validate-prd, validate-tech-spec
- Phase 3→4: implementation-readiness
- Phase 2 to 3: validate-prd, validate-tech-spec
- Phase 3 to 4: implementation-readiness
Run validation before advancing
```

19
src/modules/bmm/docs/brownfield-guide.md
View File

@ -89,7 +89,7 @@ You: "Yes"
---
## Phase 0: Documentation (Critical First Step)
## Documentation: Critical First Step
🚨 **For brownfield projects: Always ensure adequate AI-usable documentation before planning**
@ -159,7 +159,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
| **A** | No documentation | `document-project` | Only option - generate from scratch |
| **B** | Docs exist but massive/outdated/incomplete | `document-project` | Safer to regenerate than trust bad docs |
| **C** | Good docs but no structure | `shard-doc` → `index-docs` | Structure existing content for AI |
| **D** | Confirmed AI-optimized docs with index.md | Skip Phase 0 | Rare - only if you're 100% confident |
| **D** | Confirmed AI-optimized docs with index.md | Skip Documentation | Rare - only if you're 100% confident |
### Scenario A: No Documentation (Most Common)
@ -231,7 +231,7 @@ If you have **good, current documentation** but it's in massive files:
### Scenario D: Confirmed AI-Optimized Documentation (Rare)
**Action: Skip Phase 0**
**Action: Skip Documentation**
Only skip if ALL conditions met:
@ -619,7 +619,7 @@ Document in tech-spec/architecture:
### Commands by Phase
```bash
# Phase 0: Documentation (If Needed)
# Documentation (If Needed)
# Analyst agent:
document-project # Create comprehensive docs (10-30min)
# OR load index-docs task for existing docs (2-5min)
@ -637,16 +637,14 @@ prd # BMad Method/Enterprise tracks
# Phase 3: Solutioning (BMad Method/Enterprise)
# Architect agent:
create-architecture # Extend architecture
architecture # Create/extend architecture
create-epics-and-stories # Create epics and stories (after architecture)
implementation-readiness # Final validation
# Phase 4: Implementation (All Tracks)
# SM agent:
sprint-planning # Initialize tracking
epic-tech-context # Epic context
create-story # Draft story
story-context # Story context
create-story # Create story
# DEV agent:
dev-story # Implement
@ -659,14 +657,14 @@ correct-course # If issues
### Key Files
**Phase 0 Output:**
**Documentation Output:**
- `docs/index.md` - **Master AI entry point (REQUIRED)**
- `docs/project-overview.md`
- `docs/architecture.md`
- `docs/source-tree-analysis.md`
**Phase 1-3 Tracking:**
**Phase 1-4 Tracking:**
- `docs/bmm-workflow-status.yaml` - Progress tracker
@ -682,6 +680,7 @@ correct-course # If issues
**Phase 3 Architecture:**
- `docs/architecture.md` (BMad Method/Enterprise tracks)
- `docs/epics.md` + epic folders (from create-epics-and-stories)
**Phase 4 Implementation:**

10
src/modules/bmm/docs/glossary.md
View File

@ -101,10 +101,6 @@ Game development equivalent of PRD, created by Game Designer agent for game proj
## Workflow and Phases
### Phase 0: Documentation (Prerequisite)
**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents.
### Phase 1: Analysis (Optional)
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method.
@ -119,7 +115,11 @@ Architecture design phase. Required for BMad Method and Enterprise Method tracks
### Phase 4: Implementation (Required)
Sprint-based development through story-by-story iteration. Uses sprint-planning, epic-tech-context, create-story, story-context, dev-story, code-review, and retrospective workflows.
Sprint-based development through story-by-story iteration. Uses sprint-planning, create-story, dev-story, code-review, and retrospective workflows.
### Documentation (Prerequisite for Brownfield)
**Conditional prerequisite for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents. Uses the `document-project` workflow.
### Quick Spec Flow

30
src/modules/bmm/docs/test-architecture.md
View File

@ -88,9 +88,9 @@ graph TB
style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000
```
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 0/1:
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and documentation prerequisite:
- **Phase 0** (Optional): Documentation (brownfield prerequisite - `*document-project`)
- **Documentation** (Optional for brownfield): Prerequisite using `*document-project`
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
@ -98,7 +98,7 @@ graph TB
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` runs per-epic in Phase 4. Output: `test-design-epic-N.md`.
Quick Flow track skips Phases 0, 1, and 3. BMad Method and Enterprise use all phases based on project needs.
Quick Flow track skips Phase 1 and 3. BMad Method and Enterprise use all phases based on project needs.
### Why TEA is Different from Other BMM Agents
@ -259,22 +259,22 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
**🔄 Brownfield Deltas from Greenfield:**
- ➕ Phase 0 (Documentation) - Document existing codebase if undocumented
- ➕ Documentation (Prerequisite) - Document existing codebase if undocumented
- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning
- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks
- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier
| Workflow Stage | Test Architect | Dev / Team | Outputs |
| ----------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| **Phase 0**: Documentation ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
| Workflow Stage | Test Architect | Dev / Team | Outputs |
| ---------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
<details>
<summary>Execution Notes</summary>

35
src/modules/bmm/docs/workflows-analysis.md
View File

@ -40,7 +40,6 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
| ---------------------- | ------- | ----------- | -------------------------------------------------------------- | ---------------------------- |
| **brainstorm-project** | Analyst | No | Explore solution approaches and architectures | Solution options + rationale |
| **research** | Analyst | No | Multi-type research (market/technical/competitive/user/domain) | Research reports |
| **domain-research** | Analyst | No | Industry-specific deep dive research | Domain analysis report |
| **product-brief** | Analyst | Recommended | Define product vision and strategy (interactive) | Product Brief document |
---
@ -99,38 +98,6 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
---
### domain-research
**Purpose:** Industry-specific deep dive research to understand domain context, regulations, standards, and patterns relevant to complex projects.
**Agent:** Analyst
**When to Use:**
- Entering new industry verticals
- Highly regulated domains (healthcare, finance, education)
- Complex business domains with specialized terminology
- Need to understand industry standards and compliance requirements
**Key Features:**
- Industry analysis and trends
- Regulatory landscape
- Standards and compliance requirements
- Domain-specific patterns and best practices
- Key players and ecosystem analysis
**Key Outputs:**
- Domain analysis report
- Compliance checklist
- Standards reference guide
- Risk assessment for domain-specific challenges
**Example:** "Healthcare application" → HIPAA compliance requirements, FDA regulations, HL7/FHIR standards, healthcare ecosystem players, domain-specific data patterns.
---
### product-brief
**Purpose:** Interactive product brief creation that guides strategic product vision definition.
@ -292,7 +259,7 @@ A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Mov
A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment.
**Q: Should brownfield projects do Analysis?**
A: Usually no. Start with `document-project` (Phase 0), then skip to Planning (Phase 2).
A: Usually no. Start with `document-project` (Documentation prerequisite), then skip to Planning (Phase 2).
---