bmad-method 6.0.0-alpha.4 → 6.0.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/bmad/bmm/agents/architect.md +0 -1
- package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
- package/.claude/commands/bmad/bmm/agents/tech-writer.md +82 -0
- package/.claude/commands/bmad/bmm/workflows/README.md +1 -1
- package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
- package/.claude/commands/bmad/core/workflows/README.md +10 -0
- package/.claude/settings.local.json +4 -8
- package/CHANGELOG.md +305 -0
- package/README.md +88 -39
- package/bmad/_cfg/agent-manifest.csv +2 -1
- package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +42 -0
- package/bmad/_cfg/files-manifest.csv +40 -62
- package/bmad/_cfg/ides/claude-code.yaml +1 -1
- package/bmad/_cfg/manifest.yaml +4 -3
- package/bmad/_cfg/task-manifest.csv +4 -1
- package/bmad/_cfg/tool-manifest.csv +1 -0
- package/bmad/_cfg/workflow-manifest.csv +3 -1
- package/bmad/bmb/config.yaml +2 -2
- package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/bmad/bmm/README.md +79 -120
- package/bmad/bmm/README.md.bak +169 -0
- package/bmad/bmm/agents/analyst.md.bak +67 -0
- package/bmad/bmm/agents/architect.md +0 -1
- package/bmad/bmm/agents/architect.md.bak +73 -0
- package/bmad/bmm/agents/dev.md.bak +69 -0
- package/bmad/bmm/agents/pm.md.bak +76 -0
- package/bmad/bmm/agents/sm.md +1 -1
- package/bmad/bmm/agents/sm.md.bak +85 -0
- package/bmad/bmm/agents/tea.md.bak +72 -0
- package/bmad/bmm/agents/tech-writer.md +82 -0
- package/bmad/bmm/agents/ux-designer.md.bak +71 -0
- package/bmad/bmm/config.yaml +2 -2
- package/bmad/bmm/docs/README.md +235 -0
- package/bmad/bmm/docs/agents-guide.md +1057 -0
- package/bmad/bmm/docs/brownfield-guide.md +471 -972
- package/bmad/bmm/docs/enterprise-agentic-development.md +680 -0
- package/bmad/bmm/docs/faq.md +589 -0
- package/bmad/bmm/docs/glossary.md +321 -0
- package/bmad/bmm/docs/party-mode.md +224 -0
- package/bmad/bmm/docs/quick-spec-flow.md +64 -57
- package/bmad/bmm/docs/quick-start.md +72 -47
- package/bmad/bmm/docs/scale-adaptive-system.md +332 -778
- package/bmad/bmm/docs/troubleshooting.md +680 -0
- package/bmad/bmm/{workflows/3-solutioning/architecture/README.md → docs/workflow-architecture-reference.md} +130 -77
- package/bmad/bmm/{workflows/document-project/README.md → docs/workflow-document-project-reference.md} +45 -2
- package/bmad/bmm/docs/workflows-analysis.md +670 -0
- package/bmad/bmm/docs/workflows-implementation.md +1758 -0
- package/bmad/bmm/docs/workflows-planning.md +1086 -0
- package/bmad/bmm/docs/workflows-solutioning.md +726 -0
- package/bmad/bmm/tasks/daily-standup.xml +1 -1
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml.bak +60 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/bmad/bmm/workflows/techdoc/documentation-standards.md +2 -1
- package/bmad/bmm/workflows/techdoc/documentation-standards.md.bak +238 -0
- package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/bmad/bmm/workflows/workflow-status/init/workflow.yaml.bak +27 -0
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
- package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
- package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/bmad/cis/agents/brainstorming-coach.md.bak +62 -0
- package/bmad/cis/agents/creative-problem-solver.md.bak +62 -0
- package/bmad/cis/agents/design-thinking-coach.md.bak +62 -0
- package/bmad/cis/agents/innovation-strategist.md.bak +62 -0
- package/bmad/cis/agents/storyteller.md.bak +59 -0
- package/bmad/cis/config.yaml +2 -2
- package/bmad/core/agents/bmad-master.md.bak +15 -13
- package/bmad/core/config.yaml +2 -2
- package/bmad/core/tasks/workflow.xml +1 -11
- package/package.json +1 -1
- package/src/core/tasks/workflow.xml +1 -11
- package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/src/modules/bmm/README.md +1 -1
- package/src/modules/bmm/agents/architect.agent.yaml +0 -4
- package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
- package/src/modules/bmm/agents/sm.agent.yaml +1 -1
- package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
- package/src/modules/bmm/docs/README.md +9 -9
- package/src/modules/bmm/docs/agents-guide.md +46 -98
- package/src/modules/bmm/docs/brownfield-guide.md +211 -90
- package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
- package/src/modules/bmm/docs/faq.md +10 -10
- package/src/modules/bmm/docs/glossary.md +36 -42
- package/src/modules/bmm/docs/party-mode.md +110 -1122
- package/src/modules/bmm/docs/quick-spec-flow.md +33 -33
- package/src/modules/bmm/docs/quick-start.md +29 -29
- package/src/modules/bmm/docs/scale-adaptive-system.md +303 -453
- package/src/modules/bmm/docs/troubleshooting.md +1 -1
- package/src/modules/bmm/docs/workflows-implementation.md +20 -21
- package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
- package/src/modules/bmm/tasks/daily-standup.xml +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
- package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
- package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/techdoc/documentation-standards.md +1 -1
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
- package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
- package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/bmad/bmm/tasks/retrospective.xml +0 -104
- package/bmad/bmm/testarch/README.md +0 -311
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
- package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
- package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
- package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
- package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
- package/bmad/bmm/workflows/4-implementation/README.md +0 -221
- package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
- package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
- package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
- package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
- package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
- package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
- package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
- package/bmad/bmm/workflows/README.md +0 -256
- package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
- package/bmad/bmm/workflows/testarch/README.md +0 -26
- package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
- package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
- package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
- package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
- package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
- package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
- package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
- package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
- package/bmad/bmm/workflows/workflow-status/README.md +0 -260
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
- package/src/modules/bmm/docs/workflows-testing.md +0 -1572
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- /package/bmad/bmm/agents/{paige.md → paige.md.bak} +0 -0
|
@@ -1,256 +0,0 @@
|
|
|
1
|
-
# BMM Workflows - Complete v6 Guide
|
|
2
|
-
|
|
3
|
-
Master guide for BMM's four-phase methodology that adapts to project scale (Level 0-4) and context (greenfield/brownfield).
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
|
|
7
|
-
- [Core Innovations](#core-innovations)
|
|
8
|
-
- [Universal Entry Point](#universal-entry-point)
|
|
9
|
-
- [Four Phases Overview](#four-phases-overview)
|
|
10
|
-
- [Phase Details](#phase-details)
|
|
11
|
-
- [Documentation Prerequisite](#documentation-prerequisite)
|
|
12
|
-
- [Phase 1: Analysis](#phase-1-analysis)
|
|
13
|
-
- [Phase 2: Planning](#phase-2-planning)
|
|
14
|
-
- [Phase 3: Solutioning](#phase-3-solutioning)
|
|
15
|
-
- [Phase 4: Implementation](#phase-4-implementation)
|
|
16
|
-
- [Scale Levels](#scale-levels)
|
|
17
|
-
- [Greenfield vs Brownfield](#greenfield-vs-brownfield)
|
|
18
|
-
- [Critical Rules](#critical-rules)
|
|
19
|
-
|
|
20
|
-
## Core Innovations
|
|
21
|
-
|
|
22
|
-
- **Scale-Adaptive Planning** - Automatic routing based on complexity (Level 0-4)
|
|
23
|
-
- **Just-In-Time Design** - Tech specs created per epic during implementation
|
|
24
|
-
- **Dynamic Expertise Injection** - Story-specific technical guidance
|
|
25
|
-
- **Continuous Learning Loop** - Retrospectives improve each cycle
|
|
26
|
-
- **Document Sharding Support** - All workflows handle whole or sharded documents for efficiency
|
|
27
|
-
|
|
28
|
-
## Universal Entry Point
|
|
29
|
-
|
|
30
|
-
**Always start with `workflow-status` or `workflow-init`**
|
|
31
|
-
|
|
32
|
-
### workflow-status
|
|
33
|
-
|
|
34
|
-
- Checks for existing workflow status file
|
|
35
|
-
- Displays current phase and progress
|
|
36
|
-
- Routes to appropriate next workflow
|
|
37
|
-
- Shows Phase 4 implementation state
|
|
38
|
-
|
|
39
|
-
### workflow-init
|
|
40
|
-
|
|
41
|
-
- Creates initial bmm-workflow-status.md
|
|
42
|
-
- Detects greenfield vs brownfield
|
|
43
|
-
- Routes undocumented brownfield to document-project
|
|
44
|
-
- Sets up workflow tracking
|
|
45
|
-
|
|
46
|
-
## Four Phases Overview
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
PREREQUISITE: document-project (brownfield without docs)
|
|
50
|
-
↓
|
|
51
|
-
PHASE 1: Analysis (optional)
|
|
52
|
-
brainstorm → research → brief
|
|
53
|
-
↓
|
|
54
|
-
PHASE 2: Planning (required, scale-adaptive)
|
|
55
|
-
Level 0-1: tech-spec only
|
|
56
|
-
Level 2-4: PRD + epics
|
|
57
|
-
↓
|
|
58
|
-
PHASE 3: Solutioning (Level 2-4 only)
|
|
59
|
-
architecture → validation → gate-check
|
|
60
|
-
↓
|
|
61
|
-
PHASE 4: Implementation (iterative)
|
|
62
|
-
sprint-planning → epic-context → story cycle
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## Phase Details
|
|
66
|
-
|
|
67
|
-
### Documentation Prerequisite
|
|
68
|
-
|
|
69
|
-
**When:** Brownfield projects without documentation OR post-completion cleanup
|
|
70
|
-
|
|
71
|
-
| Workflow | Purpose | Output |
|
|
72
|
-
| ---------------- | ----------------------------- | ------------------ |
|
|
73
|
-
| document-project | Analyze and document codebase | Comprehensive docs |
|
|
74
|
-
|
|
75
|
-
**Use Cases:**
|
|
76
|
-
|
|
77
|
-
1. **Pre-Phase 1**: Understand existing brownfield code
|
|
78
|
-
2. **Post-Phase 4**: Create clean documentation replacing scattered artifacts
|
|
79
|
-
|
|
80
|
-
### Phase 1: Analysis
|
|
81
|
-
|
|
82
|
-
**Optional workflows for discovery and requirements gathering**
|
|
83
|
-
|
|
84
|
-
| Workflow | Agent | Purpose | Output |
|
|
85
|
-
| ------------------ | ------------- | --------------------- | ---------------------- |
|
|
86
|
-
| brainstorm-project | Analyst | Software ideation | Architecture proposals |
|
|
87
|
-
| brainstorm-game | Game Designer | Game concept ideation | Concept proposals |
|
|
88
|
-
| research | Analyst | Multi-mode research | Research artifacts |
|
|
89
|
-
| product-brief | Analyst | Strategic planning | Product brief |
|
|
90
|
-
| game-brief | Game Designer | Game foundation | Game brief |
|
|
91
|
-
|
|
92
|
-
### Phase 2: Planning
|
|
93
|
-
|
|
94
|
-
**Required phase with scale-adaptive routing**
|
|
95
|
-
|
|
96
|
-
| Workflow | Agent | Output | Levels |
|
|
97
|
-
| ---------------- | ------------- | -------------- | ----------- |
|
|
98
|
-
| prd | PM | PRD.md + epics | 2-4 |
|
|
99
|
-
| tech-spec | PM | tech-spec.md | 0-1 |
|
|
100
|
-
| gdd | Game Designer | GDD.md | Games |
|
|
101
|
-
| create-ux-design | UX | ux-design.md | Conditional |
|
|
102
|
-
|
|
103
|
-
### Phase 3: Solutioning
|
|
104
|
-
|
|
105
|
-
**Architecture phase for Level 2-4 projects**
|
|
106
|
-
|
|
107
|
-
| Workflow | Agent | Purpose | Output |
|
|
108
|
-
| ---------------------- | --------- | ----------------- | ---------------------- |
|
|
109
|
-
| create-architecture | Architect | System design | architecture.md + ADRs |
|
|
110
|
-
| validate-architecture | Architect | Design validation | Validation report |
|
|
111
|
-
| solutioning-gate-check | Architect | PRD/UX/arch check | Gate report |
|
|
112
|
-
|
|
113
|
-
### Phase 4: Implementation
|
|
114
|
-
|
|
115
|
-
**Sprint-based development cycle**
|
|
116
|
-
|
|
117
|
-
#### Sprint Status System
|
|
118
|
-
|
|
119
|
-
**Epic Flow:** `backlog → contexted`
|
|
120
|
-
|
|
121
|
-
**Story Flow:** `backlog → drafted → ready-for-dev → in-progress → review → done`
|
|
122
|
-
|
|
123
|
-
#### Implementation Workflows
|
|
124
|
-
|
|
125
|
-
| Workflow | Agent | Purpose | Status Updates |
|
|
126
|
-
| ----------------- | ----- | ----------------------- | ------------------------------------------- |
|
|
127
|
-
| sprint-planning | SM | Initialize tracking | Creates sprint-status.yaml |
|
|
128
|
-
| epic-tech-context | SM | Epic technical context | Epic: backlog → contexted |
|
|
129
|
-
| create-story | SM | Draft story files | Story: backlog → drafted |
|
|
130
|
-
| story-context | SM | Implementation guidance | Story: drafted → ready-for-dev |
|
|
131
|
-
| dev-story | DEV | Implement | Story: ready-for-dev → in-progress → review |
|
|
132
|
-
| code-review | DEV | Quality validation | No auto update |
|
|
133
|
-
| retrospective | SM | Capture learnings | Retrospective: optional → completed |
|
|
134
|
-
| correct-course | SM | Handle issues | Adaptive |
|
|
135
|
-
|
|
136
|
-
#### Implementation Loop
|
|
137
|
-
|
|
138
|
-
```
|
|
139
|
-
sprint-planning (creates sprint-status.yaml)
|
|
140
|
-
↓
|
|
141
|
-
For each epic:
|
|
142
|
-
epic-tech-context
|
|
143
|
-
↓
|
|
144
|
-
For each story:
|
|
145
|
-
create-story → story-context → dev-story → code-review
|
|
146
|
-
↓
|
|
147
|
-
Mark done in sprint-status.yaml
|
|
148
|
-
↓
|
|
149
|
-
retrospective (epic complete)
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Scale Levels
|
|
153
|
-
|
|
154
|
-
| Level | Scope | Documentation | Path |
|
|
155
|
-
| ----- | ------------- | --------------------- | --------------- |
|
|
156
|
-
| 0 | Single change | tech-spec only | Phase 2 → 4 |
|
|
157
|
-
| 1 | 1-10 stories | tech-spec only | Phase 2 → 4 |
|
|
158
|
-
| 2 | 5-15 stories | PRD + architecture | Phase 2 → 3 → 4 |
|
|
159
|
-
| 3 | 12-40 stories | PRD + full arch | Phase 2 → 3 → 4 |
|
|
160
|
-
| 4 | 40+ stories | PRD + enterprise arch | Phase 2 → 3 → 4 |
|
|
161
|
-
|
|
162
|
-
## Greenfield vs Brownfield
|
|
163
|
-
|
|
164
|
-
### Greenfield (New Projects)
|
|
165
|
-
|
|
166
|
-
```
|
|
167
|
-
Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
- Clean slate for design
|
|
171
|
-
- No existing constraints
|
|
172
|
-
- Direct to planning
|
|
173
|
-
|
|
174
|
-
### Brownfield (Existing Code)
|
|
175
|
-
|
|
176
|
-
```
|
|
177
|
-
document-project (if needed) → Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
- Must understand existing patterns
|
|
181
|
-
- Documentation prerequisite if undocumented
|
|
182
|
-
- Consider technical debt in planning
|
|
183
|
-
|
|
184
|
-
## Critical Rules
|
|
185
|
-
|
|
186
|
-
### Phase Transitions
|
|
187
|
-
|
|
188
|
-
1. **Check workflow-status** before any Phase 1-3 workflow
|
|
189
|
-
2. **Document brownfield** before planning if undocumented
|
|
190
|
-
3. **Complete planning** before solutioning
|
|
191
|
-
4. **Complete architecture** (L2-4) before implementation
|
|
192
|
-
|
|
193
|
-
### Implementation Rules
|
|
194
|
-
|
|
195
|
-
1. **Epic context first** - Must context epic before drafting stories
|
|
196
|
-
2. **Sequential by default** - Work stories in order within epic
|
|
197
|
-
3. **Learning transfer** - Draft next story after previous done
|
|
198
|
-
4. **Manual status updates** - Update sprint-status.yaml as needed
|
|
199
|
-
|
|
200
|
-
### Story Management
|
|
201
|
-
|
|
202
|
-
1. **Single source of truth** - sprint-status.yaml tracks everything
|
|
203
|
-
2. **No story search** - Agents read exact story from status file
|
|
204
|
-
3. **Context injection** - Each story gets specific technical guidance
|
|
205
|
-
4. **Retrospective learning** - Capture improvements per epic
|
|
206
|
-
|
|
207
|
-
### Best Practices
|
|
208
|
-
|
|
209
|
-
1. **Trust the process** - Let workflows guide you
|
|
210
|
-
2. **Respect scale** - Don't over-document small projects
|
|
211
|
-
3. **Use status tracking** - Always know where you are
|
|
212
|
-
4. **Iterate and learn** - Each epic improves the next
|
|
213
|
-
5. **Consider sharding** - Split large documents (PRD, epics, architecture) for efficiency
|
|
214
|
-
|
|
215
|
-
## Document Sharding
|
|
216
|
-
|
|
217
|
-
For large multi-epic projects, consider sharding planning documents to improve workflow efficiency.
|
|
218
|
-
|
|
219
|
-
### What is Sharding?
|
|
220
|
-
|
|
221
|
-
Splits large markdown files into smaller section-based files:
|
|
222
|
-
|
|
223
|
-
- PRD with 15 epics → `prd/epic-1.md`, `prd/epic-2.md`, etc.
|
|
224
|
-
- Large epics file → Individual epic files
|
|
225
|
-
- Architecture layers → Separate layer files
|
|
226
|
-
|
|
227
|
-
### Benefits
|
|
228
|
-
|
|
229
|
-
**Phase 1-3 Workflows:**
|
|
230
|
-
|
|
231
|
-
- Workflows load entire sharded documents (transparent to user)
|
|
232
|
-
- Better organization for large projects
|
|
233
|
-
|
|
234
|
-
**Phase 4 Workflows:**
|
|
235
|
-
|
|
236
|
-
- **Selective loading** - Only load the epic/section needed
|
|
237
|
-
- **Massive efficiency** - 90%+ token reduction for 10+ epic projects
|
|
238
|
-
- Examples: `epic-tech-context`, `create-story`, `story-context`, `code-review`
|
|
239
|
-
|
|
240
|
-
### Usage
|
|
241
|
-
|
|
242
|
-
```
|
|
243
|
-
Load bmad-master or analyst agent:
|
|
244
|
-
/shard-doc
|
|
245
|
-
|
|
246
|
-
Source: docs/PRD.md
|
|
247
|
-
Destination: docs/prd/
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
**All BMM workflows automatically support both whole and sharded documents.**
|
|
251
|
-
|
|
252
|
-
**[→ Complete Sharding Guide](../../../docs/document-sharding-guide.md)**
|
|
253
|
-
|
|
254
|
-
---
|
|
255
|
-
|
|
256
|
-
For specific workflow details, see individual workflow READMEs in their respective directories.
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# Document Project Workflow Templates
|
|
2
|
-
|
|
3
|
-
This directory contains template files for the `document-project` workflow.
|
|
4
|
-
|
|
5
|
-
## Template Files
|
|
6
|
-
|
|
7
|
-
- **index-template.md** - Master index template (adapts for single/multi-part projects)
|
|
8
|
-
- **project-overview-template.md** - Executive summary and high-level overview
|
|
9
|
-
- **source-tree-template.md** - Annotated directory structure
|
|
10
|
-
|
|
11
|
-
## Template Usage
|
|
12
|
-
|
|
13
|
-
The workflow dynamically selects and populates templates based on:
|
|
14
|
-
|
|
15
|
-
1. **Project structure** (single part vs multi-part)
|
|
16
|
-
2. **Project type** (web, backend, mobile, etc.)
|
|
17
|
-
3. **Documentation requirements** (from documentation-requirements.csv)
|
|
18
|
-
|
|
19
|
-
## Variable Naming Convention
|
|
20
|
-
|
|
21
|
-
Templates use Handlebars-style variables:
|
|
22
|
-
|
|
23
|
-
- `{{variable_name}}` - Simple substitution
|
|
24
|
-
- `{{#if condition}}...{{/if}}` - Conditional blocks
|
|
25
|
-
- `{{#each collection}}...{{/each}}` - Iteration
|
|
26
|
-
|
|
27
|
-
## Additional Templates
|
|
28
|
-
|
|
29
|
-
Architecture-specific templates are dynamically loaded from:
|
|
30
|
-
`/bmad/bmm/workflows/3-solutioning/templates/`
|
|
31
|
-
|
|
32
|
-
Based on the matched architecture type from the registry.
|
|
33
|
-
|
|
34
|
-
## Notes
|
|
35
|
-
|
|
36
|
-
- Templates support both simple and complex project structures
|
|
37
|
-
- Multi-part projects get part-specific file naming (e.g., `architecture-{part_id}.md`)
|
|
38
|
-
- Single-part projects use simplified naming (e.g., `architecture.md`)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# Test Architect Workflows
|
|
2
|
-
|
|
3
|
-
This directory houses the per-command workflows used by the Test Architect agent (`tea`). Each workflow wraps the standalone instructions that used to live under `testarch/` so they can run through the standard BMAD workflow runner.
|
|
4
|
-
|
|
5
|
-
## Available workflows
|
|
6
|
-
|
|
7
|
-
- `framework` – scaffolds Playwright/Cypress harnesses.
|
|
8
|
-
- `atdd` – generates failing acceptance tests before coding.
|
|
9
|
-
- `automate` – expands regression coverage after implementation.
|
|
10
|
-
- `ci` – bootstraps CI/CD pipelines aligned with TEA practices.
|
|
11
|
-
- `test-design` – combines risk assessment and coverage planning.
|
|
12
|
-
- `trace` – maps requirements to tests (Phase 1) and makes quality gate decisions (Phase 2).
|
|
13
|
-
- `nfr-assess` – evaluates non-functional requirements.
|
|
14
|
-
- `test-review` – reviews test quality using knowledge base patterns and generates quality score.
|
|
15
|
-
|
|
16
|
-
**Note**: The `gate` workflow has been merged into `trace` as Phase 2. The `*trace` command now performs both requirements-to-tests traceability mapping AND quality gate decision (PASS/CONCERNS/FAIL/WAIVED) in a single atomic operation.
|
|
17
|
-
|
|
18
|
-
Each subdirectory contains:
|
|
19
|
-
|
|
20
|
-
- `README.md` – comprehensive workflow documentation with usage, inputs, outputs, and integration notes.
|
|
21
|
-
- `instructions.md` – detailed workflow steps in pure markdown v4.0 format.
|
|
22
|
-
- `workflow.yaml` – metadata, variables, and configuration for BMAD workflow runner.
|
|
23
|
-
- `checklist.md` – validation checklist for quality assurance and completeness verification.
|
|
24
|
-
- `template.md` – output template for workflow deliverables (where applicable).
|
|
25
|
-
|
|
26
|
-
The TEA agent now invokes these workflows via `run-workflow` rather than executing instruction files directly.
|