bmad-method 4.37.0-beta.6 → 5.0.0-beta.1

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.
Files changed (85) hide show
  1. package/.github/workflows/promote-to-stable.yml +144 -0
  2. package/CHANGELOG.md +27 -2
  3. package/bmad-core/agents/analyst.md +1 -1
  4. package/bmad-core/agents/architect.md +2 -3
  5. package/bmad-core/agents/bmad-master.md +0 -1
  6. package/bmad-core/agents/bmad-orchestrator.md +9 -10
  7. package/bmad-core/agents/dev.md +9 -10
  8. package/bmad-core/agents/po.md +1 -1
  9. package/bmad-core/agents/qa.md +38 -19
  10. package/bmad-core/agents/sm.md +1 -1
  11. package/bmad-core/agents/ux-expert.md +1 -1
  12. package/bmad-core/checklists/architect-checklist.md +0 -5
  13. package/bmad-core/checklists/pm-checklist.md +0 -5
  14. package/bmad-core/checklists/po-master-checklist.md +0 -9
  15. package/bmad-core/checklists/story-dod-checklist.md +0 -7
  16. package/bmad-core/checklists/story-draft-checklist.md +0 -3
  17. package/bmad-core/data/bmad-kb.md +5 -2
  18. package/bmad-core/data/elicitation-methods.md +20 -0
  19. package/bmad-core/data/test-levels-framework.md +146 -0
  20. package/bmad-core/data/test-priorities-matrix.md +172 -0
  21. package/bmad-core/tasks/create-brownfield-story.md +11 -3
  22. package/bmad-core/tasks/create-deep-research-prompt.md +0 -11
  23. package/bmad-core/tasks/document-project.md +15 -13
  24. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  25. package/bmad-core/tasks/index-docs.md +0 -6
  26. package/bmad-core/tasks/kb-mode-interaction.md +3 -3
  27. package/bmad-core/tasks/nfr-assess.md +343 -0
  28. package/bmad-core/tasks/qa-gate.md +159 -0
  29. package/bmad-core/tasks/review-story.md +243 -74
  30. package/bmad-core/tasks/risk-profile.md +353 -0
  31. package/bmad-core/tasks/shard-doc.md +0 -2
  32. package/bmad-core/tasks/test-design.md +174 -0
  33. package/bmad-core/tasks/trace-requirements.md +264 -0
  34. package/bmad-core/templates/qa-gate-tmpl.yaml +102 -0
  35. package/common/tasks/execute-checklist.md +0 -7
  36. package/dist/agents/analyst.txt +20 -26
  37. package/dist/agents/architect.txt +14 -35
  38. package/dist/agents/bmad-master.txt +40 -70
  39. package/dist/agents/bmad-orchestrator.txt +28 -5
  40. package/dist/agents/dev.txt +0 -14
  41. package/dist/agents/pm.txt +0 -25
  42. package/dist/agents/po.txt +0 -18
  43. package/dist/agents/qa.txt +2079 -135
  44. package/dist/agents/sm.txt +0 -10
  45. package/dist/agents/ux-expert.txt +0 -7
  46. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -37
  47. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +3 -12
  48. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -7
  49. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +44 -90
  50. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +14 -49
  51. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +0 -46
  52. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -15
  53. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +0 -17
  54. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +38 -142
  55. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2
  56. package/dist/teams/team-all.txt +2181 -261
  57. package/dist/teams/team-fullstack.txt +43 -57
  58. package/dist/teams/team-ide-minimal.txt +2064 -125
  59. package/dist/teams/team-no-ui.txt +43 -57
  60. package/docs/enhanced-ide-development-workflow.md +220 -15
  61. package/docs/user-guide.md +271 -18
  62. package/docs/working-in-the-brownfield.md +265 -32
  63. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +14 -14
  64. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -4
  65. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +3 -5
  66. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -1
  67. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -18
  68. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -5
  69. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -8
  70. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -7
  71. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -4
  72. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -1
  73. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -10
  74. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -18
  75. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -3
  76. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -1
  77. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -1
  78. package/package.json +1 -1
  79. package/tools/installer/bin/bmad.js +33 -32
  80. package/tools/installer/config/install.config.yaml +11 -1
  81. package/tools/installer/lib/file-manager.js +1 -1
  82. package/tools/installer/lib/ide-base-setup.js +1 -1
  83. package/tools/installer/lib/ide-setup.js +197 -83
  84. package/tools/installer/lib/installer.js +3 -3
  85. package/tools/installer/package.json +1 -1
@@ -542,7 +542,7 @@ Each status change requires user verification and approval before proceeding.
542
542
  #### Greenfield Development
543
543
 
544
544
  - Business analysis and market research
545
- - Product requirements and feature definition
545
+ - Product requirements and feature definition
546
546
  - System architecture and design
547
547
  - Development execution
548
548
  - Testing and deployment
@@ -651,8 +651,11 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
651
651
 
652
652
  ```markdown
653
653
  ## Goals and Background Context
654
- ## Requirements
654
+
655
+ ## Requirements
656
+
655
657
  ## User Interface Design Goals
658
+
656
659
  ## Success Metrics
657
660
  ```
658
661
 
@@ -3,16 +3,19 @@
3
3
  ## Core Reflective Methods
4
4
 
5
5
  **Expand or Contract for Audience**
6
+
6
7
  - Ask whether to 'expand' (add detail, elaborate) or 'contract' (simplify, clarify)
7
8
  - Identify specific target audience if relevant
8
9
  - Tailor content complexity and depth accordingly
9
10
 
10
11
  **Explain Reasoning (CoT Step-by-Step)**
12
+
11
13
  - Walk through the step-by-step thinking process
12
14
  - Reveal underlying assumptions and decision points
13
15
  - Show how conclusions were reached from current role's perspective
14
16
 
15
17
  **Critique and Refine**
18
+
16
19
  - Review output for flaws, inconsistencies, or improvement areas
17
20
  - Identify specific weaknesses from role's expertise
18
21
  - Suggest refined version reflecting domain knowledge
@@ -20,12 +23,14 @@
20
23
  ## Structural Analysis Methods
21
24
 
22
25
  **Analyze Logical Flow and Dependencies**
26
+
23
27
  - Examine content structure for logical progression
24
28
  - Check internal consistency and coherence
25
29
  - Identify and validate dependencies between elements
26
30
  - Confirm effective ordering and sequencing
27
31
 
28
32
  **Assess Alignment with Overall Goals**
33
+
29
34
  - Evaluate content contribution to stated objectives
30
35
  - Identify any misalignments or gaps
31
36
  - Interpret alignment from specific role's perspective
@@ -34,12 +39,14 @@
34
39
  ## Risk and Challenge Methods
35
40
 
36
41
  **Identify Potential Risks and Unforeseen Issues**
42
+
37
43
  - Brainstorm potential risks from role's expertise
38
44
  - Identify overlooked edge cases or scenarios
39
45
  - Anticipate unintended consequences
40
46
  - Highlight implementation challenges
41
47
 
42
48
  **Challenge from Critical Perspective**
49
+
43
50
  - Adopt critical stance on current content
44
51
  - Play devil's advocate from specified viewpoint
45
52
  - Argue against proposal highlighting weaknesses
@@ -48,12 +55,14 @@
48
55
  ## Creative Exploration Methods
49
56
 
50
57
  **Tree of Thoughts Deep Dive**
58
+
51
59
  - Break problem into discrete "thoughts" or intermediate steps
52
60
  - Explore multiple reasoning paths simultaneously
53
61
  - Use self-evaluation to classify each path as "sure", "likely", or "impossible"
54
62
  - Apply search algorithms (BFS/DFS) to find optimal solution paths
55
63
 
56
64
  **Hindsight is 20/20: The 'If Only...' Reflection**
65
+
57
66
  - Imagine retrospective scenario based on current content
58
67
  - Identify the one "if only we had known/done X..." insight
59
68
  - Describe imagined consequences humorously or dramatically
@@ -62,6 +71,7 @@
62
71
  ## Multi-Persona Collaboration Methods
63
72
 
64
73
  **Agile Team Perspective Shift**
74
+
65
75
  - Rotate through different Scrum team member viewpoints
66
76
  - Product Owner: Focus on user value and business impact
67
77
  - Scrum Master: Examine process flow and team dynamics
@@ -69,12 +79,14 @@
69
79
  - QA: Identify testing scenarios and quality concerns
70
80
 
71
81
  **Stakeholder Round Table**
82
+
72
83
  - Convene virtual meeting with multiple personas
73
84
  - Each persona contributes unique perspective on content
74
85
  - Identify conflicts and synergies between viewpoints
75
86
  - Synthesize insights into actionable recommendations
76
87
 
77
88
  **Meta-Prompting Analysis**
89
+
78
90
  - Step back to analyze the structure and logic of current approach
79
91
  - Question the format and methodology being used
80
92
  - Suggest alternative frameworks or mental models
@@ -83,24 +95,28 @@
83
95
  ## Advanced 2025 Techniques
84
96
 
85
97
  **Self-Consistency Validation**
98
+
86
99
  - Generate multiple reasoning paths for same problem
87
100
  - Compare consistency across different approaches
88
101
  - Identify most reliable and robust solution
89
102
  - Highlight areas where approaches diverge and why
90
103
 
91
104
  **ReWOO (Reasoning Without Observation)**
105
+
92
106
  - Separate parametric reasoning from tool-based actions
93
107
  - Create reasoning plan without external dependencies
94
108
  - Identify what can be solved through pure reasoning
95
109
  - Optimize for efficiency and reduced token usage
96
110
 
97
111
  **Persona-Pattern Hybrid**
112
+
98
113
  - Combine specific role expertise with elicitation pattern
99
114
  - Architect + Risk Analysis: Deep technical risk assessment
100
115
  - UX Expert + User Journey: End-to-end experience critique
101
116
  - PM + Stakeholder Analysis: Multi-perspective impact review
102
117
 
103
118
  **Emergent Collaboration Discovery**
119
+
104
120
  - Allow multiple perspectives to naturally emerge
105
121
  - Identify unexpected insights from persona interactions
106
122
  - Explore novel combinations of viewpoints
@@ -109,18 +125,21 @@
109
125
  ## Game-Based Elicitation Methods
110
126
 
111
127
  **Red Team vs Blue Team**
128
+
112
129
  - Red Team: Attack the proposal, find vulnerabilities
113
130
  - Blue Team: Defend and strengthen the approach
114
131
  - Competitive analysis reveals blind spots
115
132
  - Results in more robust, battle-tested solutions
116
133
 
117
134
  **Innovation Tournament**
135
+
118
136
  - Pit multiple alternative approaches against each other
119
137
  - Score each approach across different criteria
120
138
  - Crowd-source evaluation from different personas
121
139
  - Identify winning combination of features
122
140
 
123
141
  **Escape Room Challenge**
142
+
124
143
  - Present content as constraints to work within
125
144
  - Find creative solutions within tight limitations
126
145
  - Identify minimum viable approach
@@ -129,6 +148,7 @@
129
148
  ## Process Control
130
149
 
131
150
  **Proceed / No Further Actions**
151
+
132
152
  - Acknowledge choice to finalize current work
133
153
  - Accept output as-is or move to next step
134
154
  - Prepare to continue without additional elicitation
@@ -0,0 +1,146 @@
1
+ # Test Levels Framework
2
+
3
+ Comprehensive guide for determining appropriate test levels (unit, integration, E2E) for different scenarios.
4
+
5
+ ## Test Level Decision Matrix
6
+
7
+ ### Unit Tests
8
+
9
+ **When to use:**
10
+
11
+ - Testing pure functions and business logic
12
+ - Algorithm correctness
13
+ - Input validation and data transformation
14
+ - Error handling in isolated components
15
+ - Complex calculations or state machines
16
+
17
+ **Characteristics:**
18
+
19
+ - Fast execution (immediate feedback)
20
+ - No external dependencies (DB, API, file system)
21
+ - Highly maintainable and stable
22
+ - Easy to debug failures
23
+
24
+ **Example scenarios:**
25
+
26
+ ```yaml
27
+ unit_test:
28
+ component: "PriceCalculator"
29
+ scenario: "Calculate discount with multiple rules"
30
+ justification: "Complex business logic with multiple branches"
31
+ mock_requirements: "None - pure function"
32
+ ```
33
+
34
+ ### Integration Tests
35
+
36
+ **When to use:**
37
+
38
+ - Component interaction verification
39
+ - Database operations and transactions
40
+ - API endpoint contracts
41
+ - Service-to-service communication
42
+ - Middleware and interceptor behavior
43
+
44
+ **Characteristics:**
45
+
46
+ - Moderate execution time
47
+ - Tests component boundaries
48
+ - May use test databases or containers
49
+ - Validates system integration points
50
+
51
+ **Example scenarios:**
52
+
53
+ ```yaml
54
+ integration_test:
55
+ components: ["UserService", "AuthRepository"]
56
+ scenario: "Create user with role assignment"
57
+ justification: "Critical data flow between service and persistence"
58
+ test_environment: "In-memory database"
59
+ ```
60
+
61
+ ### End-to-End Tests
62
+
63
+ **When to use:**
64
+
65
+ - Critical user journeys
66
+ - Cross-system workflows
67
+ - Visual regression testing
68
+ - Compliance and regulatory requirements
69
+ - Final validation before release
70
+
71
+ **Characteristics:**
72
+
73
+ - Slower execution
74
+ - Tests complete workflows
75
+ - Requires full environment setup
76
+ - Most realistic but most brittle
77
+
78
+ **Example scenarios:**
79
+
80
+ ```yaml
81
+ e2e_test:
82
+ journey: "Complete checkout process"
83
+ scenario: "User purchases with saved payment method"
84
+ justification: "Revenue-critical path requiring full validation"
85
+ environment: "Staging with test payment gateway"
86
+ ```
87
+
88
+ ## Test Level Selection Rules
89
+
90
+ ### Favor Unit Tests When:
91
+
92
+ - Logic can be isolated
93
+ - No side effects involved
94
+ - Fast feedback needed
95
+ - High cyclomatic complexity
96
+
97
+ ### Favor Integration Tests When:
98
+
99
+ - Testing persistence layer
100
+ - Validating service contracts
101
+ - Testing middleware/interceptors
102
+ - Component boundaries critical
103
+
104
+ ### Favor E2E Tests When:
105
+
106
+ - User-facing critical paths
107
+ - Multi-system interactions
108
+ - Regulatory compliance scenarios
109
+ - Visual regression important
110
+
111
+ ## Anti-patterns to Avoid
112
+
113
+ - E2E testing for business logic validation
114
+ - Unit testing framework behavior
115
+ - Integration testing third-party libraries
116
+ - Duplicate coverage across levels
117
+
118
+ ## Duplicate Coverage Guard
119
+
120
+ **Before adding any test, check:**
121
+
122
+ 1. Is this already tested at a lower level?
123
+ 2. Can a unit test cover this instead of integration?
124
+ 3. Can an integration test cover this instead of E2E?
125
+
126
+ **Coverage overlap is only acceptable when:**
127
+
128
+ - Testing different aspects (unit: logic, integration: interaction, e2e: user experience)
129
+ - Critical paths requiring defense in depth
130
+ - Regression prevention for previously broken functionality
131
+
132
+ ## Test Naming Conventions
133
+
134
+ - Unit: `test_{component}_{scenario}`
135
+ - Integration: `test_{flow}_{interaction}`
136
+ - E2E: `test_{journey}_{outcome}`
137
+
138
+ ## Test ID Format
139
+
140
+ `{EPIC}.{STORY}-{LEVEL}-{SEQ}`
141
+
142
+ Examples:
143
+
144
+ - `1.3-UNIT-001`
145
+ - `1.3-INT-002`
146
+ - `1.3-E2E-001`
@@ -0,0 +1,172 @@
1
+ # Test Priorities Matrix
2
+
3
+ Guide for prioritizing test scenarios based on risk, criticality, and business impact.
4
+
5
+ ## Priority Levels
6
+
7
+ ### P0 - Critical (Must Test)
8
+
9
+ **Criteria:**
10
+
11
+ - Revenue-impacting functionality
12
+ - Security-critical paths
13
+ - Data integrity operations
14
+ - Regulatory compliance requirements
15
+ - Previously broken functionality (regression prevention)
16
+
17
+ **Examples:**
18
+
19
+ - Payment processing
20
+ - Authentication/authorization
21
+ - User data creation/deletion
22
+ - Financial calculations
23
+ - GDPR/privacy compliance
24
+
25
+ **Testing Requirements:**
26
+
27
+ - Comprehensive coverage at all levels
28
+ - Both happy and unhappy paths
29
+ - Edge cases and error scenarios
30
+ - Performance under load
31
+
32
+ ### P1 - High (Should Test)
33
+
34
+ **Criteria:**
35
+
36
+ - Core user journeys
37
+ - Frequently used features
38
+ - Features with complex logic
39
+ - Integration points between systems
40
+ - Features affecting user experience
41
+
42
+ **Examples:**
43
+
44
+ - User registration flow
45
+ - Search functionality
46
+ - Data import/export
47
+ - Notification systems
48
+ - Dashboard displays
49
+
50
+ **Testing Requirements:**
51
+
52
+ - Primary happy paths required
53
+ - Key error scenarios
54
+ - Critical edge cases
55
+ - Basic performance validation
56
+
57
+ ### P2 - Medium (Nice to Test)
58
+
59
+ **Criteria:**
60
+
61
+ - Secondary features
62
+ - Admin functionality
63
+ - Reporting features
64
+ - Configuration options
65
+ - UI polish and aesthetics
66
+
67
+ **Examples:**
68
+
69
+ - Admin settings panels
70
+ - Report generation
71
+ - Theme customization
72
+ - Help documentation
73
+ - Analytics tracking
74
+
75
+ **Testing Requirements:**
76
+
77
+ - Happy path coverage
78
+ - Basic error handling
79
+ - Can defer edge cases
80
+
81
+ ### P3 - Low (Test if Time Permits)
82
+
83
+ **Criteria:**
84
+
85
+ - Rarely used features
86
+ - Nice-to-have functionality
87
+ - Cosmetic issues
88
+ - Non-critical optimizations
89
+
90
+ **Examples:**
91
+
92
+ - Advanced preferences
93
+ - Legacy feature support
94
+ - Experimental features
95
+ - Debug utilities
96
+
97
+ **Testing Requirements:**
98
+
99
+ - Smoke tests only
100
+ - Can rely on manual testing
101
+ - Document known limitations
102
+
103
+ ## Risk-Based Priority Adjustments
104
+
105
+ ### Increase Priority When:
106
+
107
+ - High user impact (affects >50% of users)
108
+ - High financial impact (>$10K potential loss)
109
+ - Security vulnerability potential
110
+ - Compliance/legal requirements
111
+ - Customer-reported issues
112
+ - Complex implementation (>500 LOC)
113
+ - Multiple system dependencies
114
+
115
+ ### Decrease Priority When:
116
+
117
+ - Feature flag protected
118
+ - Gradual rollout planned
119
+ - Strong monitoring in place
120
+ - Easy rollback capability
121
+ - Low usage metrics
122
+ - Simple implementation
123
+ - Well-isolated component
124
+
125
+ ## Test Coverage by Priority
126
+
127
+ | Priority | Unit Coverage | Integration Coverage | E2E Coverage |
128
+ | -------- | ------------- | -------------------- | ------------------ |
129
+ | P0 | >90% | >80% | All critical paths |
130
+ | P1 | >80% | >60% | Main happy paths |
131
+ | P2 | >60% | >40% | Smoke tests |
132
+ | P3 | Best effort | Best effort | Manual only |
133
+
134
+ ## Priority Assignment Rules
135
+
136
+ 1. **Start with business impact** - What happens if this fails?
137
+ 2. **Consider probability** - How likely is failure?
138
+ 3. **Factor in detectability** - Would we know if it failed?
139
+ 4. **Account for recoverability** - Can we fix it quickly?
140
+
141
+ ## Priority Decision Tree
142
+
143
+ ```
144
+ Is it revenue-critical?
145
+ ├─ YES → P0
146
+ └─ NO → Does it affect core user journey?
147
+ ├─ YES → Is it high-risk?
148
+ │ ├─ YES → P0
149
+ │ └─ NO → P1
150
+ └─ NO → Is it frequently used?
151
+ ├─ YES → P1
152
+ └─ NO → Is it customer-facing?
153
+ ├─ YES → P2
154
+ └─ NO → P3
155
+ ```
156
+
157
+ ## Test Execution Order
158
+
159
+ 1. Execute P0 tests first (fail fast on critical issues)
160
+ 2. Execute P1 tests second (core functionality)
161
+ 3. Execute P2 tests if time permits
162
+ 4. P3 tests only in full regression cycles
163
+
164
+ ## Continuous Adjustment
165
+
166
+ Review and adjust priorities based on:
167
+
168
+ - Production incident patterns
169
+ - User feedback and complaints
170
+ - Usage analytics
171
+ - Test failure history
172
+ - Business priority changes
@@ -128,7 +128,7 @@ Critical: For brownfield, ALWAYS include criteria about maintaining existing fun
128
128
  Standard structure:
129
129
 
130
130
  1. New functionality works as specified
131
- 2. Existing {{affected feature}} continues to work unchanged
131
+ 2. Existing {{affected feature}} continues to work unchanged
132
132
  3. Integration with {{existing system}} maintains current behavior
133
133
  4. No regression in {{related area}}
134
134
  5. Performance remains within acceptable bounds
@@ -139,16 +139,19 @@ Critical: This is where you'll need to be interactive with the user if informati
139
139
 
140
140
  Create Dev Technical Guidance section with available information:
141
141
 
142
- ```markdown
142
+ ````markdown
143
143
  ## Dev Technical Guidance
144
144
 
145
145
  ### Existing System Context
146
+
146
147
  [Extract from available documentation]
147
148
 
148
149
  ### Integration Approach
150
+
149
151
  [Based on patterns found or ask user]
150
152
 
151
153
  ### Technical Constraints
154
+
152
155
  [From documentation or user input]
153
156
 
154
157
  ### Missing Information
@@ -191,6 +194,7 @@ Example task structure for brownfield:
191
194
  - [ ] Integration test for {{integration point}}
192
195
  - [ ] Update existing tests if needed
193
196
  ```
197
+ ````
194
198
 
195
199
  ### 5. Risk Assessment and Mitigation
196
200
 
@@ -202,14 +206,17 @@ Add section for brownfield-specific risks:
202
206
  ## Risk Assessment
203
207
 
204
208
  ### Implementation Risks
209
+
205
210
  - **Primary Risk**: {{main risk to existing system}}
206
211
  - **Mitigation**: {{how to address}}
207
212
  - **Verification**: {{how to confirm safety}}
208
213
 
209
214
  ### Rollback Plan
215
+
210
216
  - {{Simple steps to undo changes if needed}}
211
217
 
212
218
  ### Safety Checks
219
+
213
220
  - [ ] Existing {{feature}} tested before changes
214
221
  - [ ] Changes can be feature-flagged or isolated
215
222
  - [ ] Rollback procedure documented
@@ -252,6 +259,7 @@ Include header noting documentation context:
252
259
  <!-- Context: Brownfield enhancement to {{existing system}} -->
253
260
 
254
261
  ## Status: Draft
262
+
255
263
  [Rest of story content...]
256
264
  ```
257
265
 
@@ -272,7 +280,7 @@ Key Integration Points Identified:
272
280
  Risks Noted:
273
281
  - {{primary risk}}
274
282
 
275
- {{If missing info}}:
283
+ {{If missing info}}:
276
284
  Note: Some technical details were unclear. The story includes exploration tasks to gather needed information during implementation.
277
285
 
278
286
  Next Steps:
@@ -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?
@@ -111,9 +111,9 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
111
111
 
112
112
  ### Change Log
113
113
 
114
- | Date | Version | Description | Author |
115
- |------|---------|-------------|--------|
116
- | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
114
+ | Date | Version | Description | Author |
115
+ | ------ | ------- | --------------------------- | --------- |
116
+ | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
117
117
 
118
118
  ## Quick Reference - Key Files and Entry Points
119
119
 
@@ -136,11 +136,11 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
136
136
 
137
137
  ### Actual Tech Stack (from package.json/requirements.txt)
138
138
 
139
- | Category | Technology | Version | Notes |
140
- |----------|------------|---------|--------|
141
- | Runtime | Node.js | 16.x | [Any constraints] |
142
- | Framework | Express | 4.18.2 | [Custom middleware?] |
143
- | Database | PostgreSQL | 13 | [Connection pooling setup] |
139
+ | Category | Technology | Version | Notes |
140
+ | --------- | ---------- | ------- | -------------------------- |
141
+ | Runtime | Node.js | 16.x | [Any constraints] |
142
+ | Framework | Express | 4.18.2 | [Custom middleware?] |
143
+ | Database | PostgreSQL | 13 | [Connection pooling setup] |
144
144
 
145
145
  etc...
146
146
 
@@ -179,6 +179,7 @@ project-root/
179
179
  ### Data Models
180
180
 
181
181
  Instead of duplicating, reference actual model files:
182
+
182
183
  - **User Model**: See `src/models/User.js`
183
184
  - **Order Model**: See `src/models/Order.js`
184
185
  - **Related Types**: TypeScript definitions in `src/types/`
@@ -208,10 +209,10 @@ Instead of duplicating, reference actual model files:
208
209
 
209
210
  ### External Services
210
211
 
211
- | Service | Purpose | Integration Type | Key Files |
212
- |---------|---------|------------------|-----------|
213
- | Stripe | Payments | REST API | `src/integrations/stripe/` |
214
- | SendGrid | Emails | SDK | `src/services/emailService.js` |
212
+ | Service | Purpose | Integration Type | Key Files |
213
+ | -------- | -------- | ---------------- | ------------------------------ |
214
+ | Stripe | Payments | REST API | `src/integrations/stripe/` |
215
+ | SendGrid | Emails | SDK | `src/services/emailService.js` |
215
216
 
216
217
  etc...
217
218
 
@@ -256,6 +257,7 @@ npm run test:integration # Runs integration tests (requires local DB)
256
257
  ### Files That Will Need Modification
257
258
 
258
259
  Based on the enhancement requirements, these files will be affected:
260
+
259
261
  - `src/services/userService.js` - Add new user fields
260
262
  - `src/models/User.js` - Update schema
261
263
  - `src/routes/userRoutes.js` - New endpoints
@@ -338,4 +340,4 @@ Apply the advanced elicitation task after major sections to refine based on user
338
340
  - References actual files rather than duplicating content when possible
339
341
  - Documents technical debt, workarounds, and constraints honestly
340
342
  - For brownfield projects with PRD: Provides clear enhancement impact analysis
341
- - The goal is PRACTICAL documentation for AI agents doing real work
343
+ - The goal is PRACTICAL documentation for AI agents doing real work