bmad-enhanced 1.6.4 → 1.6.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/CHANGELOG.md +1 -1
- package/INSTALLATION.md +21 -6
- package/README.md +75 -31
- package/UPDATE-GUIDE.md +30 -3
- package/_bmad/bme/_vortex/guides/EMMA-USER-GUIDE.md +82 -295
- package/_bmad/bme/_vortex/guides/WADE-USER-GUIDE.md +101 -322
- package/_bmad/bme/_vortex/workflows/contextualize-scope/steps/step-06-synthesize.md +3 -0
- package/_bmad/bme/_vortex/workflows/lean-persona/steps/step-06-synthesize.md +3 -0
- package/_bmad/bme/_vortex/workflows/product-vision/steps/step-06-synthesize.md +3 -0
- package/_bmad-output/feedback-template.md +20 -0
- package/_bmad-output/implementation-artifacts/p2-1-1-build-programmatic-docs-audit-tool.md +222 -0
- package/_bmad-output/implementation-artifacts/p2-1-2-execute-docs-fix-pass-1-stale-references-broken-links.md +219 -0
- package/_bmad-output/implementation-artifacts/p2-1-3-add-forward-compatibility-extension-guidance.md +217 -0
- package/_bmad-output/implementation-artifacts/p2-1-4-validate-pass-1-completeness-document-inter-pass-checkpoint.md +209 -0
- package/_bmad-output/implementation-artifacts/p2-2-1-build-registry-driven-p0-test-framework.md +305 -0
- package/_bmad-output/implementation-artifacts/p2-2-2-p0-activation-workflow-tests-for-emma.md +247 -0
- package/_bmad-output/implementation-artifacts/p2-2-3-p0-activation-workflow-tests-for-wade.md +278 -0
- package/_bmad-output/implementation-artifacts/p2-3-1-p0-content-only-tests-for-remaining-5-agents.md +311 -0
- package/_bmad-output/implementation-artifacts/p2-3-2-voice-consistency-validation-full-p0-confidence-gate.md +224 -0
- package/_bmad-output/implementation-artifacts/p2-3-3-handoff-contract-validation-tests.md +249 -0
- package/_bmad-output/implementation-artifacts/p2-3-4-ci-content-correctness-vortex-compass-validation.md +294 -0
- package/_bmad-output/implementation-artifacts/p2-4-1-create-7-agent-journey-example-with-real-artifacts.md +322 -0
- package/_bmad-output/implementation-artifacts/p2-4-2-add-handoff-annotations-self-contained-sections.md +224 -0
- package/_bmad-output/implementation-artifacts/p2-4-3-journey-quality-verification-editorial-review.md +176 -0
- package/_bmad-output/implementation-artifacts/p2-5-1-bmad-update-js-automated-tests-at-85-coverage.md +239 -0
- package/_bmad-output/implementation-artifacts/p2-5-2-bmad-version-js-automated-tests-at-85-coverage.md +175 -0
- package/_bmad-output/implementation-artifacts/p2-5-3-readme-landing-page-value-proposition-visual-overview.md +221 -0
- package/_bmad-output/implementation-artifacts/p2-5-4-readme-landing-page-output-previews-journey-link.md +212 -0
- package/_bmad-output/implementation-artifacts/p2-5-5-structured-user-feedback-mechanism.md +267 -0
- package/_bmad-output/implementation-artifacts/p2-6-1-scope-adjacent-improvements-backlog-convention.md +173 -0
- package/_bmad-output/implementation-artifacts/p2-6-2-execute-docs-fix-pass-2-post-release-review-template.md +226 -0
- package/_bmad-output/implementation-artifacts/p2-6-3-scripted-end-to-end-rayas-journey-acceptance-test.md +269 -0
- package/_bmad-output/implementation-artifacts/p2-epic-1-inter-pass-checkpoint.md +250 -0
- package/_bmad-output/implementation-artifacts/p2-epic-1-retro-2026-02-28.md +214 -0
- package/_bmad-output/implementation-artifacts/p2-epic-2-retro-2026-02-28.md +225 -0
- package/_bmad-output/implementation-artifacts/p2-epic-3-retro-2026-03-01.md +215 -0
- package/_bmad-output/implementation-artifacts/p2-epic-4-retro-2026-03-01.md +175 -0
- package/_bmad-output/implementation-artifacts/p2-epic-5-retro-2026-03-02.md +175 -0
- package/_bmad-output/implementation-artifacts/p2-epic-6-retro-2026-03-02.md +194 -0
- package/_bmad-output/implementation-artifacts/sprint-status.yaml +52 -2
- package/_bmad-output/journey-examples/busy-parents-7-agent-journey.md +944 -0
- package/_bmad-output/planning-artifacts/epics-phase2.md +641 -0
- package/_bmad-output/planning-artifacts/implementation-readiness-report-2026-02-28.md +224 -0
- package/_bmad-output/planning-artifacts/prd-phase2.md +563 -0
- package/_bmad-output/post-release-review-template.md +85 -0
- package/_bmad-output/rayas-journey-acceptance-test.md +513 -0
- package/_bmad-output/scope-adjacent-backlog.md +50 -0
- package/_bmad-output/vortex-artifacts/hc1-empathy-busy-parents-2026-03-01.md +106 -0
- package/_bmad-output/vortex-artifacts/hc2-problem-definition-busy-parents-2026-03-01.md +82 -0
- package/_bmad-output/vortex-artifacts/hc3-hypothesis-contract-busy-parents-2026-03-01.md +100 -0
- package/_bmad-output/vortex-artifacts/hc4-experiment-context-busy-parents-2026-03-01.md +96 -0
- package/_bmad-output/vortex-artifacts/hc5-signal-report-busy-parents-2026-03-01.md +74 -0
- package/_bmad-output/vortex-artifacts/lean-persona-busy-parents-2026-03-01.md +178 -0
- package/_bmad-output/vortex-artifacts/learning-card-busy-parents-2026-03-01.md +62 -0
- package/package.json +7 -4
- package/scripts/docs-audit.js +430 -0
- package/scripts/update/lib/refresh-installation.js +26 -9
- package/_bmad-output/design-artifacts/EMMA-USER-GUIDE.md +0 -710
- package/_bmad-output/design-artifacts/WADE-USER-GUIDE.md +0 -1191
- package/_bmad-output/vortex-artifacts/EMMA-USER-GUIDE.md +0 -450
- package/_bmad-output/vortex-artifacts/ISLA-USER-GUIDE.md +0 -213
- package/_bmad-output/vortex-artifacts/MAX-USER-GUIDE.md +0 -218
- package/_bmad-output/vortex-artifacts/WADE-USER-GUIDE.md +0 -471
package/CHANGELOG.md
CHANGED
|
@@ -834,4 +834,4 @@ No changes to installation flow. Reinstallation will fix the Wade workflow bug.
|
|
|
834
834
|
- [README.md](README.md) - Project overview
|
|
835
835
|
- [INSTALLATION.md](INSTALLATION.md) - Installation guide
|
|
836
836
|
- [BMAD-METHOD-COMPATIBILITY.md](BMAD-METHOD-COMPATIBILITY.md) - Integration details
|
|
837
|
-
- User guides in `_bmad
|
|
837
|
+
- User guides in `_bmad/bme/_vortex/guides/`
|
package/INSTALLATION.md
CHANGED
|
@@ -20,7 +20,7 @@ BMAD-Enhanced works **standalone** or as an extension to [BMAD Method](https://g
|
|
|
20
20
|
npm install bmad-enhanced && npx bmad-install-vortex-agents
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
All
|
|
23
|
+
All 7 Vortex agents (Emma, Isla, Mila, Liam, Wade, Noah, Max) with 22 workflows are installed and ready to use.
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
@@ -62,8 +62,11 @@ your-project/
|
|
|
62
62
|
│ │ ├── agents/
|
|
63
63
|
│ │ │ ├── contextualization-expert.md # Emma
|
|
64
64
|
│ │ │ ├── discovery-empathy-expert.md # Isla
|
|
65
|
-
│ │ │ ├──
|
|
66
|
-
│ │ │
|
|
65
|
+
│ │ │ ├── research-convergence-specialist.md # Mila
|
|
66
|
+
│ │ │ ├── hypothesis-engineer.md # Liam
|
|
67
|
+
│ │ │ ├── lean-experiments-specialist.md # Wade
|
|
68
|
+
│ │ │ ├── production-intelligence-specialist.md # Noah
|
|
69
|
+
│ │ │ └── learning-decision-expert.md # Max
|
|
67
70
|
│ │ ├── workflows/
|
|
68
71
|
│ │ │ ├── lean-persona/ # Emma workflows
|
|
69
72
|
│ │ │ ├── product-vision/
|
|
@@ -71,10 +74,19 @@ your-project/
|
|
|
71
74
|
│ │ │ ├── empathy-map/ # Isla workflows
|
|
72
75
|
│ │ │ ├── user-interview/
|
|
73
76
|
│ │ │ ├── user-discovery/
|
|
77
|
+
│ │ │ ├── research-convergence/ # Mila workflows
|
|
78
|
+
│ │ │ ├── pivot-resynthesis/
|
|
79
|
+
│ │ │ ├── pattern-mapping/
|
|
80
|
+
│ │ │ ├── hypothesis-engineering/ # Liam workflows
|
|
81
|
+
│ │ │ ├── assumption-mapping/
|
|
82
|
+
│ │ │ ├── experiment-design/
|
|
74
83
|
│ │ │ ├── mvp/ # Wade workflows
|
|
75
84
|
│ │ │ ├── lean-experiment/
|
|
76
85
|
│ │ │ ├── proof-of-concept/
|
|
77
86
|
│ │ │ ├── proof-of-value/
|
|
87
|
+
│ │ │ ├── signal-interpretation/ # Noah workflows
|
|
88
|
+
│ │ │ ├── behavior-analysis/
|
|
89
|
+
│ │ │ ├── production-monitoring/
|
|
78
90
|
│ │ │ ├── learning-card/ # Max workflows
|
|
79
91
|
│ │ │ ├── pivot-patch-persevere/
|
|
80
92
|
│ │ │ └── vortex-navigation/
|
|
@@ -85,17 +97,20 @@ your-project/
|
|
|
85
97
|
└── vortex-artifacts/
|
|
86
98
|
├── EMMA-USER-GUIDE.md
|
|
87
99
|
├── ISLA-USER-GUIDE.md
|
|
100
|
+
├── MILA-USER-GUIDE.md
|
|
101
|
+
├── LIAM-USER-GUIDE.md
|
|
88
102
|
├── WADE-USER-GUIDE.md
|
|
103
|
+
├── NOAH-USER-GUIDE.md
|
|
89
104
|
├── MAX-USER-GUIDE.md
|
|
90
105
|
└── (your generated artifacts)
|
|
91
106
|
```
|
|
92
107
|
|
|
93
108
|
### Summary
|
|
94
109
|
|
|
95
|
-
- **
|
|
96
|
-
- **
|
|
110
|
+
- **7 agent definitions** in `_bmad/bme/_vortex/agents/`
|
|
111
|
+
- **22 workflows** (169 files) — each with steps, templates, and validation
|
|
97
112
|
- **Configuration** in `_bmad/bme/_vortex/config.yaml`
|
|
98
|
-
- **
|
|
113
|
+
- **7 user guides** in `_bmad/bme/_vortex/guides/`
|
|
99
114
|
|
|
100
115
|
---
|
|
101
116
|
|
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
E N H A N C E D
|
|
11
11
|
</pre>
|
|
12
12
|
|
|
13
|
-
**
|
|
13
|
+
**Validate your product ideas before writing a single line of code**
|
|
14
14
|
|
|
15
15
|
[](https://github.com/amalik/BMAD-Enhanced)
|
|
16
16
|
[](docs/agents.md)
|
|
@@ -19,38 +19,38 @@
|
|
|
19
19
|
|
|
20
20
|
</div>
|
|
21
21
|
|
|
22
|
-
BMAD-Enhanced
|
|
22
|
+
Most teams skip validation and build on assumptions. BMAD-Enhanced guides you through seven discovery streams — from understanding your users to testing your riskiest assumptions — so you can make evidence-based decisions before committing to code. Each stream builds on the previous one's findings, and when gaps appear, the system routes you back to fill them.
|
|
23
23
|
|
|
24
24
|
```
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
│
|
|
29
|
-
│
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
│
|
|
36
|
-
│
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
25
|
+
7 Streams · 7 Agents
|
|
26
|
+
|
|
27
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
28
|
+
│ Isla 🔍 │──▶│ Mila 🔬 │──▶│ Liam 💡 │──▶│ Wade 🧪 │
|
|
29
|
+
│ Empathize │ │ Synthesize │ │ Hypothesize │ │ Externalize │
|
|
30
|
+
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
|
31
|
+
▲ │
|
|
32
|
+
│ │
|
|
33
|
+
│ ▼
|
|
34
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
|
|
35
|
+
│ Emma 🎯 │◀──│ Max 🧭 │◀──│ Noah 📡 │◀──────────┘
|
|
36
|
+
│Contextualize│ │ Systematize │ │ Sensitize │
|
|
37
|
+
└─────────────┘ └─────────────┘ └─────────────┘
|
|
38
|
+
│ │ │
|
|
39
|
+
└─────────────────┴─────────────────┘
|
|
40
|
+
▶ Start at Emma · back to any stream
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
+
Each agent above runs one of these streams. You don't follow a fixed path — the system guides you to whichever stream needs attention based on what you've learned so far.
|
|
44
|
+
|
|
43
45
|
| Agent | Stream | What they do |
|
|
44
46
|
|-------|--------|-------------|
|
|
45
|
-
| **Emma** 🎯 | Contextualize | Frame the right problem —
|
|
47
|
+
| **Emma** 🎯 | Contextualize | Frame the right problem — personas, product vision, scope |
|
|
46
48
|
| **Isla** 🔍 | Empathize | Understand users — empathy maps, interviews, discovery research |
|
|
47
|
-
| **Mila** 🔬 | Synthesize | Converge research into problem definitions
|
|
48
|
-
| **Liam** 💡 | Hypothesize |
|
|
49
|
-
| **Wade** 🧪 | Externalize | Test assumptions
|
|
50
|
-
| **Noah** 📡 | Sensitize | Interpret production signals
|
|
51
|
-
| **Max** 🧭 | Systematize | Capture learnings
|
|
52
|
-
|
|
53
|
-
Every workflow ends with a **Vortex Compass** — evidence-driven routing that creates non-linear loops across all streams. Ten handoff contracts (HC1-HC10) ensure structured information flows between agents.
|
|
49
|
+
| **Mila** 🔬 | Synthesize | Converge research into clear problem definitions |
|
|
50
|
+
| **Liam** 💡 | Hypothesize | Turn problems into testable hypotheses and experiments |
|
|
51
|
+
| **Wade** 🧪 | Externalize | Test assumptions with MVPs, experiments, and prototypes |
|
|
52
|
+
| **Noah** 📡 | Sensitize | Interpret production signals and user behavior |
|
|
53
|
+
| **Max** 🧭 | Systematize | Capture learnings and decide: pivot, patch, or persevere |
|
|
54
54
|
|
|
55
55
|
---
|
|
56
56
|
|
|
@@ -92,7 +92,7 @@ your-project/
|
|
|
92
92
|
├── _bmad/bme/_vortex/
|
|
93
93
|
│ ├── agents/ # 7 agent definition files
|
|
94
94
|
│ ├── workflows/ # 22 workflows
|
|
95
|
-
│ ├── contracts/ #
|
|
95
|
+
│ ├── contracts/ # Artifact contract schemas
|
|
96
96
|
│ ├── guides/ # User guides (all 7 agents)
|
|
97
97
|
│ └── config.yaml # Configuration
|
|
98
98
|
└── _bmad-output/
|
|
@@ -119,6 +119,48 @@ Your data in `_bmad-output/` is never touched. Automatic backups are created bef
|
|
|
119
119
|
|
|
120
120
|
See [UPDATE-GUIDE.md](UPDATE-GUIDE.md) for migration paths and troubleshooting.
|
|
121
121
|
|
|
122
|
+
## What Agents Produce
|
|
123
|
+
|
|
124
|
+
Here's a sample of real output from a busy parents meal planning project — each excerpt is from the [full 7-agent journey example](_bmad-output/journey-examples/busy-parents-7-agent-journey.md).
|
|
125
|
+
|
|
126
|
+
### Emma 🎯 Contextualize
|
|
127
|
+
|
|
128
|
+
Emma frames the right problem. Here's the Job-to-be-Done she produced:
|
|
129
|
+
|
|
130
|
+
> **Job-to-be-Done:** Eliminate the daily 5:30 PM dinner decision so I can feed my family well without the mental load of planning, shopping, and deciding under time pressure.
|
|
131
|
+
>
|
|
132
|
+
> **Riskiest Assumptions:**
|
|
133
|
+
> 1. Decision fatigue — not cooking skill or ingredient access — is the primary barrier to weeknight dinner success
|
|
134
|
+
> 2. Parents would trust and act on an externally-provided dinner suggestion rather than needing to choose themselves
|
|
135
|
+
> 3. "Good enough" nutrition is an acceptable standard — parents aren't seeking perfection, they're seeking relief from guilt
|
|
136
|
+
|
|
137
|
+
### Liam 💡 Hypothesize
|
|
138
|
+
|
|
139
|
+
Liam turns problems into testable ideas. Here's one of three hypotheses he produced:
|
|
140
|
+
|
|
141
|
+
> **Hypothesis 1: The Pre-Commute Decision Eliminator**
|
|
142
|
+
>
|
|
143
|
+
> We believe that busy parents will act on a single dinner suggestion delivered at 4:00 PM within 3 minutes because the decision burden — not cooking — is their primary barrier, and an earlier intervention catches them before the anxiety spiral begins.
|
|
144
|
+
>
|
|
145
|
+
> **Riskiest Assumption:** Parents will trust and act on an automated suggestion without second-guessing. Research shows they want "someone to tell me what to make" — but "someone" may need to be a trusted person, not an algorithm.
|
|
146
|
+
|
|
147
|
+
### Max 🧭 Systematize
|
|
148
|
+
|
|
149
|
+
Max captures what you learned and decides what to do next:
|
|
150
|
+
|
|
151
|
+
> **Recommendation: PATCH** (iterate on timing, don't pivot direction)
|
|
152
|
+
>
|
|
153
|
+
> The core hypothesis is validated. The product direction (decision elimination via single suggestion) is correct. The timing mechanism needs refinement — shift from fixed 4:00 PM delivery to adaptive delivery based on each user's observed engagement pattern.
|
|
154
|
+
>
|
|
155
|
+
> **Three Actions:**
|
|
156
|
+
> 1. **Implement adaptive timing** — shift the push notification to match each user's observed engagement window. Engineering effort: 1-2 sprints.
|
|
157
|
+
> 2. **Route to Isla for timing investigation** — qualitative research on why users engage at 3:15 PM. Is it anxiety relief, logistical planning, or habit?
|
|
158
|
+
> 3. **Test willingness to pay immediately** — the mechanism works, but we have no commercial validation. Run a landing page test with pricing before further product investment.
|
|
159
|
+
|
|
160
|
+
Want to see the complete walkthrough of all 7 agents applied to the example above?
|
|
161
|
+
|
|
162
|
+
**📖 [See the full 7-agent journey example →](_bmad-output/journey-examples/busy-parents-7-agent-journey.md)**
|
|
163
|
+
|
|
122
164
|
---
|
|
123
165
|
|
|
124
166
|
## Using the Agents
|
|
@@ -133,7 +175,7 @@ Each agent can be used independently or as part of the full Vortex flow:
|
|
|
133
175
|
6. **Noah (Sensitize)** — Start here when experiments have graduated to production
|
|
134
176
|
7. **Max (Systematize)** — Start here when you have results and need to decide next steps
|
|
135
177
|
|
|
136
|
-
Max's **Vortex Navigation** workflow helps identify which stream needs attention based on evidence gaps — you don't have to follow a linear path. Every workflow ends with a **Vortex Compass** that routes you to the right next agent based on what you learned.
|
|
178
|
+
Max's **Vortex Navigation** workflow helps identify which stream needs attention based on evidence gaps — you don't have to follow a linear path. Every workflow ends with a **Vortex Compass** that routes you to the right next agent based on what you learned. Ten handoff contracts (HC1-HC10) ensure structured information flows between agents, so each agent gets exactly the data it needs from the previous one.
|
|
137
179
|
|
|
138
180
|
For detailed workflow descriptions and usage examples, see the [Agent Guide](docs/agents.md) and the individual user guides:
|
|
139
181
|
|
|
@@ -181,8 +223,8 @@ BMAD-Enhanced works standalone or as an extension — no BMAD Method installatio
|
|
|
181
223
|
|
|
182
224
|
## Roadmap
|
|
183
225
|
|
|
184
|
-
- **v1.1.0–v1.5.x** — Waves 1-2: Foundation (Emma, Isla, Wade, Max —
|
|
185
|
-
- **v1.6.
|
|
226
|
+
- **v1.1.0–v1.5.x** — Waves 1-2: Foundation (Emma, Isla, Wade, Max — agent definitions, workflows, update system, CI/CD)
|
|
227
|
+
- **v1.6.x** — Wave 3: Complete 7-stream Vortex (added Mila, Liam, Noah — 7 agents, 22 workflows, handoff contracts, Compass routing)
|
|
186
228
|
- **v2.0.0+** — Multi-agent collaboration, cross-agent workflows, analytics
|
|
187
229
|
|
|
188
230
|
---
|
|
@@ -196,6 +238,8 @@ We welcome contributions in these areas:
|
|
|
196
238
|
- **Documentation** — Tutorials, translations, video walkthroughs
|
|
197
239
|
- **Integration** — IDE plugins, third-party tools
|
|
198
240
|
|
|
241
|
+
**Have feedback?** Found a quality issue, want a missing capability, or have a general comment about an agent? Open an issue and select the **Agent/Workflow Feedback** template — takes under 30 seconds.
|
|
242
|
+
|
|
199
243
|
See the [Development Guide](docs/development.md) for architecture details and agent development patterns.
|
|
200
244
|
|
|
201
245
|
---
|
|
@@ -257,7 +301,7 @@ Every agent below contributed to the design, implementation, testing, or documen
|
|
|
257
301
|
|
|
258
302
|
<div align="center">
|
|
259
303
|
|
|
260
|
-
**Vortex Pattern** — *
|
|
304
|
+
**Innovation Vortex Pattern** — *Discover what has to be discovered, deliver what has to be delivered*
|
|
261
305
|
|
|
262
306
|
[Get Started](#quick-start) | [Agents](docs/agents.md) | [Docs](#documentation) | [Roadmap](#roadmap)
|
|
263
307
|
|
package/UPDATE-GUIDE.md
CHANGED
|
@@ -78,7 +78,7 @@ What happens:
|
|
|
78
78
|
- Agent files and workflows refreshed
|
|
79
79
|
- Isla + Max agents added with 6 new workflows
|
|
80
80
|
|
|
81
|
-
### From v1.0.x to v1.
|
|
81
|
+
### From v1.0.x to v1.6.x
|
|
82
82
|
|
|
83
83
|
**Breaking changes:**
|
|
84
84
|
- Workflow renamed: `empathy-map` → `lean-persona` (for Emma)
|
|
@@ -87,9 +87,9 @@ What happens:
|
|
|
87
87
|
|
|
88
88
|
What happens:
|
|
89
89
|
- Old workflows preserved in `_bmad/bme/_vortex/workflows/_deprecated/`
|
|
90
|
-
- All
|
|
90
|
+
- All 22 Vortex workflows installed
|
|
91
91
|
- Config structure updated (preferences preserved)
|
|
92
|
-
-
|
|
92
|
+
- 7 agents installed (Emma, Isla, Mila, Liam, Wade, Noah, Max)
|
|
93
93
|
|
|
94
94
|
```bash
|
|
95
95
|
npm install bmad-enhanced@latest
|
|
@@ -125,6 +125,33 @@ Every update creates a backup before making changes:
|
|
|
125
125
|
|
|
126
126
|
---
|
|
127
127
|
|
|
128
|
+
## Forward Compatibility
|
|
129
|
+
|
|
130
|
+
### Your Artifacts Survive Updates
|
|
131
|
+
|
|
132
|
+
All user-generated content in `_bmad-output/` (planning artifacts, implementation artifacts, vortex artifacts) works with updated agents **without regeneration**. When you update from v1.5.x to v1.6.x, your existing artifacts remain valid inputs to both original and new agents.
|
|
133
|
+
|
|
134
|
+
Artifacts created with earlier agents (Emma, Isla, Wade, Max) were not designed specifically for the newer agents (Mila, Liam, Noah), but the handoff contracts are backward-compatible by design. A product vision created with v1.5.x works as input to Mila after updating to v1.6.x — the required fields are present.
|
|
135
|
+
|
|
136
|
+
### What Is Backward-Compatible
|
|
137
|
+
|
|
138
|
+
- **Artifact content** — Everything in `_bmad-output/` (planning artifacts, implementation artifacts, vortex artifacts)
|
|
139
|
+
- **Handoff contract fields** — The fields agents produce and consume (HC1-HC5 schemas) are stable across versions
|
|
140
|
+
- **Workflow outputs** — Templates and generated documents maintain their structure
|
|
141
|
+
|
|
142
|
+
### What Is Managed by the Update System
|
|
143
|
+
|
|
144
|
+
These change between versions but are handled automatically by `npx bmad-update`:
|
|
145
|
+
|
|
146
|
+
- **Agent definition files** — Persona, menu, and instruction content in `_bmad/bme/_vortex/agents/`
|
|
147
|
+
- **Workflow step files** — Step content, templates, and validation in `_bmad/bme/_vortex/workflows/`
|
|
148
|
+
- **Internal file structure** — The layout of `_bmad/bme/` may change between versions
|
|
149
|
+
- **User guides** — Updated guides are installed in `_bmad/bme/_vortex/guides/`
|
|
150
|
+
|
|
151
|
+
You do not need to manually update these — the update system replaces them while preserving your preferences and artifacts.
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
128
155
|
## Troubleshooting
|
|
129
156
|
|
|
130
157
|
### "Migration already in progress"
|