bmad-method 4.32.0 → 4.33.0
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 +10 -5
- package/README.md +10 -3
- package/bmad-core/checklists/architect-checklist.md +0 -5
- package/bmad-core/checklists/pm-checklist.md +0 -5
- package/bmad-core/checklists/po-master-checklist.md +0 -9
- package/bmad-core/checklists/story-dod-checklist.md +0 -7
- package/bmad-core/checklists/story-draft-checklist.md +0 -3
- package/bmad-core/data/bmad-kb.md +0 -7
- package/bmad-core/tasks/advanced-elicitation.md +0 -2
- package/bmad-core/tasks/create-brownfield-story.md +0 -9
- package/bmad-core/tasks/create-deep-research-prompt.md +0 -11
- package/bmad-core/tasks/document-project.md +0 -4
- package/bmad-core/tasks/index-docs.md +0 -5
- package/bmad-core/tasks/review-story.md +0 -8
- package/bmad-core/tasks/shard-doc.md +0 -2
- package/bmad-core/working-in-the-brownfield.md +2 -2
- package/common/tasks/execute-checklist.md +0 -7
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -4
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -4
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -18
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -5
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -8
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -7
- package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -4
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -1
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -10
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -18
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -3
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -1
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -1
- package/package.json +79 -79
- package/tools/bmad-npx-wrapper.js +5 -7
- package/tools/cli.js +0 -9
- package/tools/flattener/main.js +19 -8
- package/tools/installer/bin/bmad.js +14 -0
- package/tools/installer/lib/installer.js +28 -2
- package/tools/installer/package-lock.json +89 -89
- package/tools/installer/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,15 +1,20 @@
|
|
|
1
|
-
# [4.
|
|
1
|
+
# [4.33.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.32.0...v4.33.0) (2025-07-28)
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
###
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* version bump ([e9dd4e7](https://github.com/bmadcode/BMAD-METHOD/commit/e9dd4e7beb46d0c80df0cd65ae02d1867a56d7c1))
|
|
5
7
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
+
# [4.32.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.31.0...v4.32.0) (2025-07-27)
|
|
9
|
+
|
|
10
|
+
### Bug Fixes
|
|
8
11
|
|
|
12
|
+
- Add package-lock.json to fix GitHub Actions dependency resolution ([cce7a75](https://github.com/bmadcode/BMAD-METHOD/commit/cce7a758a632053e26d143b678eb7963599b432d))
|
|
13
|
+
- GHA fix ([62ccccd](https://github.com/bmadcode/BMAD-METHOD/commit/62ccccdc9e85f8621f63f99bd1ce0d14abe09783))
|
|
9
14
|
|
|
10
15
|
### Features
|
|
11
16
|
|
|
12
|
-
|
|
17
|
+
- Overhaul and Enhance 2D Unity Game Dev Expansion Pack ([#350](https://github.com/bmadcode/BMAD-METHOD/issues/350)) ([a7038d4](https://github.com/bmadcode/BMAD-METHOD/commit/a7038d43d18246f6aef175aa89ba059b7c94f61f))
|
|
13
18
|
|
|
14
19
|
# [4.31.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.30.4...v4.31.0) (2025-07-20)
|
|
15
20
|
|
package/README.md
CHANGED
|
@@ -126,11 +126,18 @@ The BMad-Method includes a powerful codebase flattener tool designed to prepare
|
|
|
126
126
|
|
|
127
127
|
```bash
|
|
128
128
|
# Basic usage - creates flattened-codebase.xml in current directory
|
|
129
|
-
|
|
129
|
+
npx bmad-method flatten
|
|
130
|
+
|
|
131
|
+
# Specify custom input directory
|
|
132
|
+
npx bmad-method flatten --input /path/to/source/directory
|
|
133
|
+
npx bmad-method flatten -i /path/to/source/directory
|
|
130
134
|
|
|
131
135
|
# Specify custom output file
|
|
132
|
-
|
|
133
|
-
|
|
136
|
+
npx bmad-method flatten --output my-project.xml
|
|
137
|
+
npx bmad-method flatten -o /path/to/output/codebase.xml
|
|
138
|
+
|
|
139
|
+
# Combine input and output options
|
|
140
|
+
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
|
|
134
141
|
```
|
|
135
142
|
|
|
136
143
|
### Example Output
|
|
@@ -403,33 +403,28 @@ Ask the user if they want to work through the checklist:
|
|
|
403
403
|
Now that you've completed the checklist, generate a comprehensive validation report that includes:
|
|
404
404
|
|
|
405
405
|
1. Executive Summary
|
|
406
|
-
|
|
407
406
|
- Overall architecture readiness (High/Medium/Low)
|
|
408
407
|
- Critical risks identified
|
|
409
408
|
- Key strengths of the architecture
|
|
410
409
|
- Project type (Full-stack/Frontend/Backend) and sections evaluated
|
|
411
410
|
|
|
412
411
|
2. Section Analysis
|
|
413
|
-
|
|
414
412
|
- Pass rate for each major section (percentage of items passed)
|
|
415
413
|
- Most concerning failures or gaps
|
|
416
414
|
- Sections requiring immediate attention
|
|
417
415
|
- Note any sections skipped due to project type
|
|
418
416
|
|
|
419
417
|
3. Risk Assessment
|
|
420
|
-
|
|
421
418
|
- Top 5 risks by severity
|
|
422
419
|
- Mitigation recommendations for each
|
|
423
420
|
- Timeline impact of addressing issues
|
|
424
421
|
|
|
425
422
|
4. Recommendations
|
|
426
|
-
|
|
427
423
|
- Must-fix items before development
|
|
428
424
|
- Should-fix items for better quality
|
|
429
425
|
- Nice-to-have improvements
|
|
430
426
|
|
|
431
427
|
5. AI Implementation Readiness
|
|
432
|
-
|
|
433
428
|
- Specific concerns for AI agent implementation
|
|
434
429
|
- Areas needing additional clarification
|
|
435
430
|
- Complexity hotspots to address
|
|
@@ -304,7 +304,6 @@ Ask the user if they want to work through the checklist:
|
|
|
304
304
|
Create a comprehensive validation report that includes:
|
|
305
305
|
|
|
306
306
|
1. Executive Summary
|
|
307
|
-
|
|
308
307
|
- Overall PRD completeness (percentage)
|
|
309
308
|
- MVP scope appropriateness (Too Large/Just Right/Too Small)
|
|
310
309
|
- Readiness for architecture phase (Ready/Nearly Ready/Not Ready)
|
|
@@ -312,26 +311,22 @@ Create a comprehensive validation report that includes:
|
|
|
312
311
|
|
|
313
312
|
2. Category Analysis Table
|
|
314
313
|
Fill in the actual table with:
|
|
315
|
-
|
|
316
314
|
- Status: PASS (90%+ complete), PARTIAL (60-89%), FAIL (<60%)
|
|
317
315
|
- Critical Issues: Specific problems that block progress
|
|
318
316
|
|
|
319
317
|
3. Top Issues by Priority
|
|
320
|
-
|
|
321
318
|
- BLOCKERS: Must fix before architect can proceed
|
|
322
319
|
- HIGH: Should fix for quality
|
|
323
320
|
- MEDIUM: Would improve clarity
|
|
324
321
|
- LOW: Nice to have
|
|
325
322
|
|
|
326
323
|
4. MVP Scope Assessment
|
|
327
|
-
|
|
328
324
|
- Features that might be cut for true MVP
|
|
329
325
|
- Missing features that are essential
|
|
330
326
|
- Complexity concerns
|
|
331
327
|
- Timeline realism
|
|
332
328
|
|
|
333
329
|
5. Technical Readiness
|
|
334
|
-
|
|
335
330
|
- Clarity of technical constraints
|
|
336
331
|
- Identified technical risks
|
|
337
332
|
- Areas needing architect investigation
|
|
@@ -8,12 +8,10 @@ PROJECT TYPE DETECTION:
|
|
|
8
8
|
First, determine the project type by checking:
|
|
9
9
|
|
|
10
10
|
1. Is this a GREENFIELD project (new from scratch)?
|
|
11
|
-
|
|
12
11
|
- Look for: New project initialization, no existing codebase references
|
|
13
12
|
- Check for: prd.md, architecture.md, new project setup stories
|
|
14
13
|
|
|
15
14
|
2. Is this a BROWNFIELD project (enhancing existing system)?
|
|
16
|
-
|
|
17
15
|
- Look for: References to existing codebase, enhancement/modification language
|
|
18
16
|
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
|
19
17
|
|
|
@@ -347,7 +345,6 @@ Ask the user if they want to work through the checklist:
|
|
|
347
345
|
Generate a comprehensive validation report that adapts to project type:
|
|
348
346
|
|
|
349
347
|
1. Executive Summary
|
|
350
|
-
|
|
351
348
|
- Project type: [Greenfield/Brownfield] with [UI/No UI]
|
|
352
349
|
- Overall readiness (percentage)
|
|
353
350
|
- Go/No-Go recommendation
|
|
@@ -357,42 +354,36 @@ Generate a comprehensive validation report that adapts to project type:
|
|
|
357
354
|
2. Project-Specific Analysis
|
|
358
355
|
|
|
359
356
|
FOR GREENFIELD:
|
|
360
|
-
|
|
361
357
|
- Setup completeness
|
|
362
358
|
- Dependency sequencing
|
|
363
359
|
- MVP scope appropriateness
|
|
364
360
|
- Development timeline feasibility
|
|
365
361
|
|
|
366
362
|
FOR BROWNFIELD:
|
|
367
|
-
|
|
368
363
|
- Integration risk level (High/Medium/Low)
|
|
369
364
|
- Existing system impact assessment
|
|
370
365
|
- Rollback readiness
|
|
371
366
|
- User disruption potential
|
|
372
367
|
|
|
373
368
|
3. Risk Assessment
|
|
374
|
-
|
|
375
369
|
- Top 5 risks by severity
|
|
376
370
|
- Mitigation recommendations
|
|
377
371
|
- Timeline impact of addressing issues
|
|
378
372
|
- [BROWNFIELD] Specific integration risks
|
|
379
373
|
|
|
380
374
|
4. MVP Completeness
|
|
381
|
-
|
|
382
375
|
- Core features coverage
|
|
383
376
|
- Missing essential functionality
|
|
384
377
|
- Scope creep identified
|
|
385
378
|
- True MVP vs over-engineering
|
|
386
379
|
|
|
387
380
|
5. Implementation Readiness
|
|
388
|
-
|
|
389
381
|
- Developer clarity score (1-10)
|
|
390
382
|
- Ambiguous requirements count
|
|
391
383
|
- Missing technical details
|
|
392
384
|
- [BROWNFIELD] Integration point clarity
|
|
393
385
|
|
|
394
386
|
6. Recommendations
|
|
395
|
-
|
|
396
387
|
- Must-fix before development
|
|
397
388
|
- Should-fix for quality
|
|
398
389
|
- Consider for improvement
|
|
@@ -25,14 +25,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
25
25
|
1. **Requirements Met:**
|
|
26
26
|
|
|
27
27
|
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
28
|
-
|
|
29
28
|
- [ ] All functional requirements specified in the story are implemented.
|
|
30
29
|
- [ ] All acceptance criteria defined in the story are met.
|
|
31
30
|
|
|
32
31
|
2. **Coding Standards & Project Structure:**
|
|
33
32
|
|
|
34
33
|
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
35
|
-
|
|
36
34
|
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
37
35
|
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
38
36
|
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
@@ -44,7 +42,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
44
42
|
3. **Testing:**
|
|
45
43
|
|
|
46
44
|
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
47
|
-
|
|
48
45
|
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
49
46
|
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
50
47
|
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
@@ -53,14 +50,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
53
50
|
4. **Functionality & Verification:**
|
|
54
51
|
|
|
55
52
|
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
56
|
-
|
|
57
53
|
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
58
54
|
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
59
55
|
|
|
60
56
|
5. **Story Administration:**
|
|
61
57
|
|
|
62
58
|
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
63
|
-
|
|
64
59
|
- [ ] All tasks within the story file are marked as complete.
|
|
65
60
|
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
66
61
|
- [ ] The story wrap up section has been completed with notes of changes or information relevant to the next story or overall project, the agent model that was primarily used during development, and the changelog of any changes is properly updated.
|
|
@@ -68,7 +63,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
68
63
|
6. **Dependencies, Build & Configuration:**
|
|
69
64
|
|
|
70
65
|
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
71
|
-
|
|
72
66
|
- [ ] Project builds successfully without errors.
|
|
73
67
|
- [ ] Project linting passes
|
|
74
68
|
- [ ] Any new dependencies added were either pre-approved in the story requirements OR explicitly approved by the user during development (approval documented in story file).
|
|
@@ -79,7 +73,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
79
73
|
7. **Documentation (If Applicable):**
|
|
80
74
|
|
|
81
75
|
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
82
|
-
|
|
83
76
|
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
84
77
|
- [ ] User-facing documentation updated, if changes impact users.
|
|
85
78
|
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
@@ -117,19 +117,16 @@ Note: We don't need every file listed - just the important ones.]]
|
|
|
117
117
|
Generate a concise validation report:
|
|
118
118
|
|
|
119
119
|
1. Quick Summary
|
|
120
|
-
|
|
121
120
|
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
122
121
|
- Clarity score (1-10)
|
|
123
122
|
- Major gaps identified
|
|
124
123
|
|
|
125
124
|
2. Fill in the validation table with:
|
|
126
|
-
|
|
127
125
|
- PASS: Requirements clearly met
|
|
128
126
|
- PARTIAL: Some gaps but workable
|
|
129
127
|
- FAIL: Critical information missing
|
|
130
128
|
|
|
131
129
|
3. Specific Issues (if any)
|
|
132
|
-
|
|
133
130
|
- List concrete problems to fix
|
|
134
131
|
- Suggest specific improvements
|
|
135
132
|
- Identify any blocking dependencies
|
|
@@ -477,7 +477,6 @@ that can handle [specific requirements]."
|
|
|
477
477
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
478
478
|
|
|
479
479
|
1. **Document Sharding** (CRITICAL STEP):
|
|
480
|
-
|
|
481
480
|
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
|
482
481
|
- Two methods to shard:
|
|
483
482
|
a) **Manual**: Drag `shard-doc` task + document file into chat
|
|
@@ -500,20 +499,17 @@ Resulting Folder Structure:
|
|
|
500
499
|
1. **Development Cycle** (Sequential, one story at a time):
|
|
501
500
|
|
|
502
501
|
**CRITICAL CONTEXT MANAGEMENT**:
|
|
503
|
-
|
|
504
502
|
- **Context windows matter!** Always use fresh, clean context windows
|
|
505
503
|
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
|
506
504
|
- **ALWAYS start new chat between SM, Dev, and QA work**
|
|
507
505
|
|
|
508
506
|
**Step 1 - Story Creation**:
|
|
509
|
-
|
|
510
507
|
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
|
511
508
|
- SM executes create-next-story task
|
|
512
509
|
- Review generated story in `docs/stories/`
|
|
513
510
|
- Update status from "Draft" to "Approved"
|
|
514
511
|
|
|
515
512
|
**Step 2 - Story Implementation**:
|
|
516
|
-
|
|
517
513
|
- **NEW CLEAN CHAT** → `@dev`
|
|
518
514
|
- Agent asks which story to implement
|
|
519
515
|
- Include story file content to save dev agent lookup time
|
|
@@ -522,7 +518,6 @@ Resulting Folder Structure:
|
|
|
522
518
|
- Dev marks story as "Review" when complete with all tests passing
|
|
523
519
|
|
|
524
520
|
**Step 3 - Senior QA Review**:
|
|
525
|
-
|
|
526
521
|
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
|
527
522
|
- QA performs senior developer code review
|
|
528
523
|
- QA can refactor and improve code directly
|
|
@@ -574,11 +569,9 @@ Each status change requires user verification and approval before proceeding.
|
|
|
574
569
|
1. **Upload project to Gemini Web**
|
|
575
570
|
2. **Document everything**: `@analyst` → `*document-project`
|
|
576
571
|
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
|
577
|
-
|
|
578
572
|
- More thorough but can create excessive documentation
|
|
579
573
|
|
|
580
574
|
4. **Requirements Gathering**:
|
|
581
|
-
|
|
582
575
|
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
|
583
576
|
- **Analyzes**: Existing system, constraints, integration points
|
|
584
577
|
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
|
@@ -41,14 +41,12 @@ User can request advanced elicitation on any agent output:
|
|
|
41
41
|
**Method Selection Strategy**:
|
|
42
42
|
|
|
43
43
|
1. **Always Include Core Methods** (choose 3-4):
|
|
44
|
-
|
|
45
44
|
- Expand or Contract for Audience
|
|
46
45
|
- Critique and Refine
|
|
47
46
|
- Identify Potential Risks
|
|
48
47
|
- Assess Alignment with Goals
|
|
49
48
|
|
|
50
49
|
2. **Context-Specific Methods** (choose 4-5):
|
|
51
|
-
|
|
52
50
|
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
|
53
51
|
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
|
54
52
|
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
|
@@ -27,20 +27,16 @@ Create detailed, implementation-ready stories for brownfield projects where trad
|
|
|
27
27
|
Check for available documentation in this order:
|
|
28
28
|
|
|
29
29
|
1. **Sharded PRD/Architecture** (docs/prd/, docs/architecture/)
|
|
30
|
-
|
|
31
30
|
- If found, recommend using create-next-story task instead
|
|
32
31
|
|
|
33
32
|
2. **Brownfield Architecture Document** (docs/brownfield-architecture.md or similar)
|
|
34
|
-
|
|
35
33
|
- Created by document-project task
|
|
36
34
|
- Contains actual system state, technical debt, workarounds
|
|
37
35
|
|
|
38
36
|
3. **Brownfield PRD** (docs/prd.md)
|
|
39
|
-
|
|
40
37
|
- May contain embedded technical details
|
|
41
38
|
|
|
42
39
|
4. **Epic Files** (docs/epics/ or similar)
|
|
43
|
-
|
|
44
40
|
- Created by brownfield-create-epic task
|
|
45
41
|
|
|
46
42
|
5. **User-Provided Documentation**
|
|
@@ -179,19 +175,16 @@ Example task structure for brownfield:
|
|
|
179
175
|
## Tasks / Subtasks
|
|
180
176
|
|
|
181
177
|
- [ ] Task 1: Analyze existing {{component/feature}} implementation
|
|
182
|
-
|
|
183
178
|
- [ ] Review {{specific files}} for current patterns
|
|
184
179
|
- [ ] Document integration points
|
|
185
180
|
- [ ] Identify potential impacts
|
|
186
181
|
|
|
187
182
|
- [ ] Task 2: Implement {{new functionality}}
|
|
188
|
-
|
|
189
183
|
- [ ] Follow pattern from {{example file}}
|
|
190
184
|
- [ ] Integrate with {{existing component}}
|
|
191
185
|
- [ ] Maintain compatibility with {{constraint}}
|
|
192
186
|
|
|
193
187
|
- [ ] Task 3: Verify existing functionality
|
|
194
|
-
|
|
195
188
|
- [ ] Test {{existing feature 1}} still works
|
|
196
189
|
- [ ] Verify {{integration point}} behavior unchanged
|
|
197
190
|
- [ ] Check performance impact
|
|
@@ -234,14 +227,12 @@ Add section for brownfield-specific risks:
|
|
|
234
227
|
Before finalizing:
|
|
235
228
|
|
|
236
229
|
1. **Completeness Check**:
|
|
237
|
-
|
|
238
230
|
- [ ] Story has clear scope and acceptance criteria
|
|
239
231
|
- [ ] Technical context is sufficient for implementation
|
|
240
232
|
- [ ] Integration approach is defined
|
|
241
233
|
- [ ] Risks are identified with mitigation
|
|
242
234
|
|
|
243
235
|
2. **Safety Check**:
|
|
244
|
-
|
|
245
236
|
- [ ] Existing functionality protection included
|
|
246
237
|
- [ ] Rollback plan is feasible
|
|
247
238
|
- [ ] Testing covers both new and existing features
|
|
@@ -21,63 +21,54 @@ CRITICAL: First, help the user select the most appropriate research focus based
|
|
|
21
21
|
Present these numbered options to the user:
|
|
22
22
|
|
|
23
23
|
1. **Product Validation Research**
|
|
24
|
-
|
|
25
24
|
- Validate product hypotheses and market fit
|
|
26
25
|
- Test assumptions about user needs and solutions
|
|
27
26
|
- Assess technical and business feasibility
|
|
28
27
|
- Identify risks and mitigation strategies
|
|
29
28
|
|
|
30
29
|
2. **Market Opportunity Research**
|
|
31
|
-
|
|
32
30
|
- Analyze market size and growth potential
|
|
33
31
|
- Identify market segments and dynamics
|
|
34
32
|
- Assess market entry strategies
|
|
35
33
|
- Evaluate timing and market readiness
|
|
36
34
|
|
|
37
35
|
3. **User & Customer Research**
|
|
38
|
-
|
|
39
36
|
- Deep dive into user personas and behaviors
|
|
40
37
|
- Understand jobs-to-be-done and pain points
|
|
41
38
|
- Map customer journeys and touchpoints
|
|
42
39
|
- Analyze willingness to pay and value perception
|
|
43
40
|
|
|
44
41
|
4. **Competitive Intelligence Research**
|
|
45
|
-
|
|
46
42
|
- Detailed competitor analysis and positioning
|
|
47
43
|
- Feature and capability comparisons
|
|
48
44
|
- Business model and strategy analysis
|
|
49
45
|
- Identify competitive advantages and gaps
|
|
50
46
|
|
|
51
47
|
5. **Technology & Innovation Research**
|
|
52
|
-
|
|
53
48
|
- Assess technology trends and possibilities
|
|
54
49
|
- Evaluate technical approaches and architectures
|
|
55
50
|
- Identify emerging technologies and disruptions
|
|
56
51
|
- Analyze build vs. buy vs. partner options
|
|
57
52
|
|
|
58
53
|
6. **Industry & Ecosystem Research**
|
|
59
|
-
|
|
60
54
|
- Map industry value chains and dynamics
|
|
61
55
|
- Identify key players and relationships
|
|
62
56
|
- Analyze regulatory and compliance factors
|
|
63
57
|
- Understand partnership opportunities
|
|
64
58
|
|
|
65
59
|
7. **Strategic Options Research**
|
|
66
|
-
|
|
67
60
|
- Evaluate different strategic directions
|
|
68
61
|
- Assess business model alternatives
|
|
69
62
|
- Analyze go-to-market strategies
|
|
70
63
|
- Consider expansion and scaling paths
|
|
71
64
|
|
|
72
65
|
8. **Risk & Feasibility Research**
|
|
73
|
-
|
|
74
66
|
- Identify and assess various risk factors
|
|
75
67
|
- Evaluate implementation challenges
|
|
76
68
|
- Analyze resource requirements
|
|
77
69
|
- Consider regulatory and legal implications
|
|
78
70
|
|
|
79
71
|
9. **Custom Research Focus**
|
|
80
|
-
|
|
81
72
|
- User-defined research objectives
|
|
82
73
|
- Specialized domain investigation
|
|
83
74
|
- Cross-functional research needs
|
|
@@ -246,13 +237,11 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
|
|
|
246
237
|
### 5. Review and Refinement
|
|
247
238
|
|
|
248
239
|
1. **Present Complete Prompt**
|
|
249
|
-
|
|
250
240
|
- Show the full research prompt
|
|
251
241
|
- Explain key elements and rationale
|
|
252
242
|
- Highlight any assumptions made
|
|
253
243
|
|
|
254
244
|
2. **Gather Feedback**
|
|
255
|
-
|
|
256
245
|
- Are the objectives clear and correct?
|
|
257
246
|
- Do the questions address all concerns?
|
|
258
247
|
- Is the scope appropriate?
|
|
@@ -27,7 +27,6 @@ Ask the user:
|
|
|
27
27
|
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
|
28
28
|
|
|
29
29
|
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
|
30
|
-
|
|
31
30
|
- 'Adding payment processing to the user service'
|
|
32
31
|
- 'Refactoring the authentication module'
|
|
33
32
|
- 'Integrating with a new third-party API'
|
|
@@ -63,7 +62,6 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
63
62
|
CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
|
|
64
63
|
|
|
65
64
|
1. **Explore Key Areas**:
|
|
66
|
-
|
|
67
65
|
- Entry points (main files, index files, app initializers)
|
|
68
66
|
- Configuration files and environment setup
|
|
69
67
|
- Package dependencies and versions
|
|
@@ -71,7 +69,6 @@ CRITICAL: Before generating documentation, conduct extensive analysis of the exi
|
|
|
71
69
|
- Test suites and coverage
|
|
72
70
|
|
|
73
71
|
2. **Ask Clarifying Questions**:
|
|
74
|
-
|
|
75
72
|
- "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
|
|
76
73
|
- "What are the most critical/complex parts of this system that developers struggle with?"
|
|
77
74
|
- "Are there any undocumented 'tribal knowledge' areas I should capture?"
|
|
@@ -298,7 +295,6 @@ npm run seed # Seed test data
|
|
|
298
295
|
### 4. Document Delivery
|
|
299
296
|
|
|
300
297
|
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
|
301
|
-
|
|
302
298
|
- Present the entire document in one response (or multiple if too long)
|
|
303
299
|
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
|
304
300
|
- Mention it can be sharded later in IDE if needed
|
|
@@ -11,14 +11,12 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
11
11
|
### Required Steps
|
|
12
12
|
|
|
13
13
|
1. First, locate and scan:
|
|
14
|
-
|
|
15
14
|
- The `docs/` directory and all subdirectories
|
|
16
15
|
- The existing `docs/index.md` file (create if absent)
|
|
17
16
|
- All markdown (`.md`) and text (`.txt`) files in the documentation structure
|
|
18
17
|
- Note the folder structure for hierarchical organization
|
|
19
18
|
|
|
20
19
|
2. For the existing `docs/index.md`:
|
|
21
|
-
|
|
22
20
|
- Parse current entries
|
|
23
21
|
- Note existing file references and descriptions
|
|
24
22
|
- Identify any broken links or missing files
|
|
@@ -26,7 +24,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
26
24
|
- Preserve existing folder sections
|
|
27
25
|
|
|
28
26
|
3. For each documentation file found:
|
|
29
|
-
|
|
30
27
|
- Extract the title (from first heading or filename)
|
|
31
28
|
- Generate a brief description by analyzing the content
|
|
32
29
|
- Create a relative markdown link to the file
|
|
@@ -35,7 +32,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
35
32
|
- If missing or outdated, prepare an update
|
|
36
33
|
|
|
37
34
|
4. For any missing or non-existent files found in index:
|
|
38
|
-
|
|
39
35
|
- Present a list of all entries that reference non-existent files
|
|
40
36
|
- For each entry:
|
|
41
37
|
- Show the full entry details (title, path, description)
|
|
@@ -156,7 +152,6 @@ For each file referenced in the index but not found in the filesystem:
|
|
|
156
152
|
### Special Cases
|
|
157
153
|
|
|
158
154
|
1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
|
|
159
|
-
|
|
160
155
|
- Use the folder's `index.md` title as the section title
|
|
161
156
|
- List the folder's documents as subsections
|
|
162
157
|
- Note in the description that this is a multi-part document
|
|
@@ -11,13 +11,11 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
|
|
|
11
11
|
## Review Process
|
|
12
12
|
|
|
13
13
|
1. **Read the Complete Story**
|
|
14
|
-
|
|
15
14
|
- Review all acceptance criteria
|
|
16
15
|
- Understand the dev notes and requirements
|
|
17
16
|
- Note any completion notes from the developer
|
|
18
17
|
|
|
19
18
|
2. **Verify Implementation Against Dev Notes Guidance**
|
|
20
|
-
|
|
21
19
|
- Review the "Dev Notes" section for specific technical guidance provided to the developer
|
|
22
20
|
- Verify the developer's implementation follows the architectural patterns specified in Dev Notes
|
|
23
21
|
- Check that file locations match the project structure guidance in Dev Notes
|
|
@@ -25,13 +23,11 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
|
|
|
25
23
|
- Validate that security considerations mentioned in Dev Notes were implemented
|
|
26
24
|
|
|
27
25
|
3. **Focus on the File List**
|
|
28
|
-
|
|
29
26
|
- Verify all files listed were actually created/modified
|
|
30
27
|
- Check for any missing files that should have been updated
|
|
31
28
|
- Ensure file locations align with the project structure guidance from Dev Notes
|
|
32
29
|
|
|
33
30
|
4. **Senior Developer Code Review**
|
|
34
|
-
|
|
35
31
|
- Review code with the eye of a senior developer
|
|
36
32
|
- If changes form a cohesive whole, review them together
|
|
37
33
|
- If changes are independent, review incrementally file by file
|
|
@@ -44,7 +40,6 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
|
|
|
44
40
|
- Best practices and patterns
|
|
45
41
|
|
|
46
42
|
5. **Active Refactoring**
|
|
47
|
-
|
|
48
43
|
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
|
49
44
|
- When refactoring:
|
|
50
45
|
- Make the changes directly in the files
|
|
@@ -54,20 +49,17 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
|
|
|
54
49
|
- Update the File List if you modify additional files
|
|
55
50
|
|
|
56
51
|
6. **Standards Compliance Check**
|
|
57
|
-
|
|
58
52
|
- Verify adherence to `docs/coding-standards.md`
|
|
59
53
|
- Check compliance with `docs/unified-project-structure.md`
|
|
60
54
|
- Validate testing approach against `docs/testing-strategy.md`
|
|
61
55
|
- Ensure all guidelines mentioned in the story are followed
|
|
62
56
|
|
|
63
57
|
7. **Acceptance Criteria Validation**
|
|
64
|
-
|
|
65
58
|
- Verify each AC is fully implemented
|
|
66
59
|
- Check for any missing functionality
|
|
67
60
|
- Validate edge cases are handled
|
|
68
61
|
|
|
69
62
|
8. **Test Coverage Review**
|
|
70
|
-
|
|
71
63
|
- Ensure unit tests cover edge cases
|
|
72
64
|
- Add missing tests if critical coverage is lacking
|
|
73
65
|
- Verify integration tests (if required) are comprehensive
|
|
@@ -91,13 +91,11 @@ CRITICAL: Use proper parsing that understands markdown context. A ## inside a co
|
|
|
91
91
|
For each extracted section:
|
|
92
92
|
|
|
93
93
|
1. **Generate filename**: Convert the section heading to lowercase-dash-case
|
|
94
|
-
|
|
95
94
|
- Remove special characters
|
|
96
95
|
- Replace spaces with dashes
|
|
97
96
|
- Example: "## Tech Stack" → `tech-stack.md`
|
|
98
97
|
|
|
99
98
|
2. **Adjust heading levels**:
|
|
100
|
-
|
|
101
99
|
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
102
100
|
- All subsection levels decrease by 1:
|
|
103
101
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
> Gemini Web's 1M+ token context window or Gemini CLI (when it's working) can analyze your ENTIRE codebase, or critical sections of it, all at once (obviously within reason):
|
|
6
6
|
>
|
|
7
7
|
> - Upload via GitHub URL or use gemini cli in the project folder
|
|
8
|
-
> - If working in the web: use
|
|
8
|
+
> - If working in the web: use `npx bmad-method flatten` to flatten your project into a single file, then upload that file to your web agent.
|
|
9
9
|
|
|
10
10
|
## What is Brownfield Development?
|
|
11
11
|
|
|
@@ -27,7 +27,7 @@ If you have just completed an MVP with BMad, and you want to continue with post-
|
|
|
27
27
|
## The Complete Brownfield Workflow
|
|
28
28
|
|
|
29
29
|
1. **Follow the [<ins>User Guide - Installation</ins>](user-guide.md#installation) steps to setup your agent in the web.**
|
|
30
|
-
2. **Generate a 'flattened' single file of your entire codebase** run: `
|
|
30
|
+
2. **Generate a 'flattened' single file of your entire codebase** run: `npx bmad-method flatten`
|
|
31
31
|
|
|
32
32
|
### Choose Your Approach
|
|
33
33
|
|
|
@@ -9,7 +9,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
9
9
|
## Instructions
|
|
10
10
|
|
|
11
11
|
1. **Initial Assessment**
|
|
12
|
-
|
|
13
12
|
- If user or the task being run provides a checklist name:
|
|
14
13
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
15
14
|
- If multiple matches found, ask user to clarify
|
|
@@ -22,14 +21,12 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
22
21
|
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
23
22
|
|
|
24
23
|
2. **Document and Artifact Gathering**
|
|
25
|
-
|
|
26
24
|
- Each checklist will specify its required documents/artifacts at the beginning
|
|
27
25
|
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
|
|
28
26
|
|
|
29
27
|
3. **Checklist Processing**
|
|
30
28
|
|
|
31
29
|
If in interactive mode:
|
|
32
|
-
|
|
33
30
|
- Work through each section of the checklist one at a time
|
|
34
31
|
- For each section:
|
|
35
32
|
- Review all items in the section following instructions for that section embedded in the checklist
|
|
@@ -38,7 +35,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
38
35
|
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
39
36
|
|
|
40
37
|
If in YOLO mode:
|
|
41
|
-
|
|
42
38
|
- Process all sections at once
|
|
43
39
|
- Create a comprehensive report of all findings
|
|
44
40
|
- Present the complete analysis to the user
|
|
@@ -46,7 +42,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
46
42
|
4. **Validation Approach**
|
|
47
43
|
|
|
48
44
|
For each checklist item:
|
|
49
|
-
|
|
50
45
|
- Read and understand the requirement
|
|
51
46
|
- Look for evidence in the documentation that satisfies the requirement
|
|
52
47
|
- Consider both explicit mentions and implicit coverage
|
|
@@ -60,7 +55,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
60
55
|
5. **Section Analysis**
|
|
61
56
|
|
|
62
57
|
For each section:
|
|
63
|
-
|
|
64
58
|
- think step by step to calculate pass rate
|
|
65
59
|
- Identify common themes in failed items
|
|
66
60
|
- Provide specific recommendations for improvement
|
|
@@ -70,7 +64,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
70
64
|
6. **Final Report**
|
|
71
65
|
|
|
72
66
|
Prepare a summary that includes:
|
|
73
|
-
|
|
74
67
|
- Overall checklist completion status
|
|
75
68
|
- Pass rates by section
|
|
76
69
|
- List of failed items with context
|