bmad-method 4.43.0 → 4.44.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.
Files changed (96) hide show
  1. package/CONTRIBUTING.md +2 -9
  2. package/README.md +0 -80
  3. package/bmad-core/tasks/validate-next-story.md +1 -1
  4. package/dist/agents/dev.txt +1 -1
  5. package/dist/agents/po.txt +1 -1
  6. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +1 -1
  7. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +1 -1
  8. package/dist/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.txt +1513 -0
  9. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-analyst.txt +3190 -0
  10. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-architect.txt +4499 -0
  11. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-designer.txt +3925 -0
  12. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-developer.txt +666 -0
  13. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-pm.txt +2381 -0
  14. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-po.txt +1612 -0
  15. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-qa.txt +1745 -0
  16. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-sm.txt +1208 -0
  17. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.txt +958 -0
  18. package/dist/expansion-packs/bmad-godot-game-dev/teams/godot-game-team.txt +27721 -0
  19. package/dist/teams/team-all.txt +1 -1
  20. package/dist/teams/team-fullstack.txt +1 -1
  21. package/dist/teams/team-ide-minimal.txt +1 -1
  22. package/dist/teams/team-no-ui.txt +1 -1
  23. package/docs/GUIDING-PRINCIPLES.md +3 -3
  24. package/docs/flattener.md +91 -0
  25. package/docs/versions.md +1 -1
  26. package/docs/working-in-the-brownfield.md +15 -6
  27. package/expansion-packs/bmad-godot-game-dev/README.md +244 -0
  28. package/expansion-packs/bmad-godot-game-dev/agent-teams/godot-game-team.yaml +18 -0
  29. package/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.md +147 -0
  30. package/expansion-packs/bmad-godot-game-dev/agents/game-analyst.md +84 -0
  31. package/expansion-packs/bmad-godot-game-dev/agents/game-architect.md +146 -0
  32. package/expansion-packs/bmad-godot-game-dev/agents/game-designer.md +78 -0
  33. package/expansion-packs/bmad-godot-game-dev/agents/game-developer.md +124 -0
  34. package/expansion-packs/bmad-godot-game-dev/agents/game-pm.md +82 -0
  35. package/expansion-packs/bmad-godot-game-dev/agents/game-po.md +115 -0
  36. package/expansion-packs/bmad-godot-game-dev/agents/game-qa.md +160 -0
  37. package/expansion-packs/bmad-godot-game-dev/agents/game-sm.md +66 -0
  38. package/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.md +75 -0
  39. package/expansion-packs/bmad-godot-game-dev/checklists/game-architect-checklist.md +377 -0
  40. package/expansion-packs/bmad-godot-game-dev/checklists/game-change-checklist.md +250 -0
  41. package/expansion-packs/bmad-godot-game-dev/checklists/game-design-checklist.md +225 -0
  42. package/expansion-packs/bmad-godot-game-dev/checklists/game-po-checklist.md +448 -0
  43. package/expansion-packs/bmad-godot-game-dev/checklists/game-story-dod-checklist.md +202 -0
  44. package/expansion-packs/bmad-godot-game-dev/config.yaml +30 -0
  45. package/expansion-packs/bmad-godot-game-dev/data/bmad-kb.md +811 -0
  46. package/expansion-packs/bmad-godot-game-dev/data/brainstorming-techniques.md +36 -0
  47. package/expansion-packs/bmad-godot-game-dev/data/development-guidelines.md +893 -0
  48. package/expansion-packs/bmad-godot-game-dev/data/elicitation-methods.md +156 -0
  49. package/expansion-packs/bmad-godot-game-dev/data/technical-preferences.md +3 -0
  50. package/expansion-packs/bmad-godot-game-dev/tasks/advanced-elicitation.md +110 -0
  51. package/expansion-packs/bmad-godot-game-dev/tasks/apply-qa-fixes.md +224 -0
  52. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-epic.md +162 -0
  53. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-story.md +149 -0
  54. package/expansion-packs/bmad-godot-game-dev/tasks/correct-course-game.md +159 -0
  55. package/expansion-packs/bmad-godot-game-dev/tasks/create-deep-research-prompt.md +278 -0
  56. package/expansion-packs/bmad-godot-game-dev/tasks/create-doc.md +103 -0
  57. package/expansion-packs/bmad-godot-game-dev/tasks/create-game-story.md +202 -0
  58. package/expansion-packs/bmad-godot-game-dev/tasks/document-project.md +343 -0
  59. package/expansion-packs/bmad-godot-game-dev/tasks/execute-checklist.md +88 -0
  60. package/expansion-packs/bmad-godot-game-dev/tasks/facilitate-brainstorming-session.md +136 -0
  61. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-epic.md +160 -0
  62. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-story.md +147 -0
  63. package/expansion-packs/bmad-godot-game-dev/tasks/game-design-brainstorming.md +290 -0
  64. package/expansion-packs/bmad-godot-game-dev/tasks/game-risk-profile.md +368 -0
  65. package/expansion-packs/bmad-godot-game-dev/tasks/game-test-design.md +219 -0
  66. package/expansion-packs/bmad-godot-game-dev/tasks/generate-ai-frontend-prompt.md +51 -0
  67. package/expansion-packs/bmad-godot-game-dev/tasks/kb-mode-interaction.md +77 -0
  68. package/expansion-packs/bmad-godot-game-dev/tasks/review-game-story.md +364 -0
  69. package/expansion-packs/bmad-godot-game-dev/tasks/shard-doc.md +187 -0
  70. package/expansion-packs/bmad-godot-game-dev/tasks/validate-game-story.md +208 -0
  71. package/expansion-packs/bmad-godot-game-dev/templates/brainstorming-output-tmpl.yaml +156 -0
  72. package/expansion-packs/bmad-godot-game-dev/templates/brownfield-prd-tmpl.yaml +281 -0
  73. package/expansion-packs/bmad-godot-game-dev/templates/competitor-analysis-tmpl.yaml +306 -0
  74. package/expansion-packs/bmad-godot-game-dev/templates/game-architecture-tmpl.yaml +1111 -0
  75. package/expansion-packs/bmad-godot-game-dev/templates/game-brief-tmpl.yaml +356 -0
  76. package/expansion-packs/bmad-godot-game-dev/templates/game-design-doc-tmpl.yaml +724 -0
  77. package/expansion-packs/bmad-godot-game-dev/templates/game-prd-tmpl.yaml +209 -0
  78. package/expansion-packs/bmad-godot-game-dev/templates/game-qa-gate-tmpl.yaml +186 -0
  79. package/expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml +406 -0
  80. package/expansion-packs/bmad-godot-game-dev/templates/game-ui-spec-tmpl.yaml +601 -0
  81. package/expansion-packs/bmad-godot-game-dev/templates/level-design-doc-tmpl.yaml +620 -0
  82. package/expansion-packs/bmad-godot-game-dev/templates/market-research-tmpl.yaml +418 -0
  83. package/expansion-packs/bmad-godot-game-dev/utils/bmad-doc-template.md +327 -0
  84. package/expansion-packs/bmad-godot-game-dev/utils/workflow-management.md +71 -0
  85. package/expansion-packs/bmad-godot-game-dev/workflows/game-dev-greenfield.yaml +245 -0
  86. package/expansion-packs/bmad-godot-game-dev/workflows/game-prototype.yaml +213 -0
  87. package/package.json +1 -1
  88. package/release_notes.md +11 -2
  89. package/tools/flattener/ignoreRules.js +2 -0
  90. package/tools/installer/bin/bmad.js +2 -1
  91. package/tools/installer/config/install.config.yaml +16 -7
  92. package/tools/installer/lib/ide-setup.js +192 -80
  93. package/tools/installer/package.json +1 -1
  94. package/tools/upgraders/v3-to-v4-upgrader.js +1 -0
  95. package/test.md +0 -1
  96. /package/{implement-fork-friendly-ci.sh → tools/implement-fork-friendly-ci.sh} +0 -0
@@ -0,0 +1,208 @@
1
+ # Validate Game Story Task
2
+
3
+ ## Purpose
4
+
5
+ To comprehensively validate a Godot game development story draft before implementation begins, ensuring it contains all necessary Godot-specific technical context (node architecture, GDScript/C# language strategy, 60+ FPS performance targets), TDD requirements (GUT/GoDotTest), and implementation details. This specialized validation prevents hallucinations, ensures Godot development readiness, and validates game-specific acceptance criteria and testing approaches.
6
+
7
+ ## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
8
+
9
+ ### 0. Load Core Configuration and Inputs
10
+
11
+ - Load `.bmad-godot-game-dev/config.yaml` from the project root
12
+ - If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story validation."
13
+ - Extract key configurations: `devStoryLocation`, `gdd.*`, `gamearchitecture.*`, `workflow.*`
14
+ - Identify and load the following inputs:
15
+ - **Story file**: The drafted game story to validate (provided by user or discovered in `devStoryLocation`)
16
+ - **Parent epic**: The epic containing this story's requirements from GDD
17
+ - **Architecture documents**: Based on configuration (sharded or monolithic)
18
+ - **Game story template**: `expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml` for completeness validation
19
+
20
+ ### 1. Game Story Template Completeness Validation
21
+
22
+ - Load `expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml` and extract all required sections
23
+ - **Missing sections check**: Compare story sections against game story template sections to verify all Godot-specific sections are present:
24
+ - Godot Technical Context
25
+ - Node Architecture & Signal Flow
26
+ - Scene (.tscn) & Resource (.tres) Requirements
27
+ - Language Strategy (GDScript vs C#)
28
+ - Performance Requirements (60+ FPS target)
29
+ - Platform Export Settings
30
+ - Integration Points
31
+ - TDD Testing Strategy (GUT for GDScript, GoDotTest for C#)
32
+ - **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{StoryNum}}`, `{{GameMechanic}}`, `_TBD_`)
33
+ - **Game-specific sections**: Verify presence of Godot development specific sections
34
+ - **Structure compliance**: Verify story follows game story template structure and formatting
35
+
36
+ ### 2. Godot Project Structure and Resource Validation
37
+
38
+ - **Godot file paths clarity**: Are Godot-specific paths clearly specified (res://, scenes/, scripts/, resources/, etc.)?
39
+ - **Plugin dependencies**: Are required GDExtensions or addons identified and documented?
40
+ - **Scene structure relevance**: Is relevant node hierarchy and scene tree structure included?
41
+ - **Scene organization**: Are scene instancing and inheritance patterns clearly specified?
42
+ - **Resource pipeline**: Are texture imports, AnimationPlayer resources, and AudioStream assets properly planned?
43
+ - **Directory structure**: Do new Godot resources follow project structure according to architecture docs?
44
+ - **Custom Resource requirements**: Are Resource classes and export presets identified?
45
+ - **Language compliance**: Are GDScript static typing and C# optimization patterns enforced?
46
+
47
+ ### 3. Godot Node Architecture Validation
48
+
49
+ - **Node class specifications**: Are custom node classes (extending Node2D, Control, etc.) sufficiently detailed?
50
+ - **Node dependencies**: Are node relationships and signal connections clearly mapped?
51
+ - **Godot lifecycle usage**: Are \_ready(), \_process(), \_physics_process() methods appropriately planned?
52
+ - **Signal system integration**: Are signal emissions, connections, and custom signals specified?
53
+ - **Export variable requirements**: Are @export variables and inspector settings clear?
54
+ - **Node interfaces**: Are required node groups and inheritance patterns defined?
55
+ - **Performance considerations**: Are process modes optimized (\_process vs \_physics_process, static typing enforced)?
56
+
57
+ ### 4. Game Mechanics and Systems Validation
58
+
59
+ - **Core loop integration**: Does the story properly integrate with established game core loop?
60
+ - **Player input handling**: Are InputMap actions and device handling requirements specified?
61
+ - **Game state management**: Are state transitions and save/load system requirements clear?
62
+ - **UI/UX integration**: Are Control nodes, anchoring, and theme system requirements defined?
63
+ - **Audio integration**: Are AudioStreamPlayer nodes, bus routing, and sound pooling specified?
64
+ - **Animation systems**: Are AnimationPlayer, AnimationTree, and transition requirements clear?
65
+ - **Physics integration**: Are RigidBody2D/3D, collision layers, and physics settings specified?
66
+ - **Object pooling**: Are pooling strategies defined for frequently spawned entities?
67
+
68
+ ### 5. Godot-Specific Acceptance Criteria Assessment
69
+
70
+ - **TDD testing**: Are GUT (GDScript) and GoDotTest (C#) tests defined for all criteria?
71
+ - **Visual validation**: Are visual/aesthetic acceptance criteria measurable and testable?
72
+ - **Performance criteria**: Is 60+ FPS target specified with frame time <16.67ms?
73
+ - **Platform compatibility**: Are export template requirements for different platforms addressed?
74
+ - **Input validation**: Are InputMap actions for keyboard, gamepad, and touch covered?
75
+ - **Audio criteria**: Are audio bus levels, stream players, and audio pooling specified?
76
+ - **Animation validation**: Are AnimationPlayer smoothness, timing, and blend requirements defined?
77
+
78
+ ### 6. Godot Testing and Validation Instructions Review
79
+
80
+ - **TDD Framework**: Are GUT and GoDotTest approaches with Red-Green-Refactor cycle specified?
81
+ - **Performance profiling**: Are Godot Profiler usage and 60+ FPS validation steps defined?
82
+ - **Export testing**: Are export template validation steps for target platforms specified?
83
+ - **Scene testing**: Are scene instancing, transitions, and signal flow testing approaches clear?
84
+ - **Resource validation**: Are texture compression, import settings, and pooling tests defined?
85
+ - **Platform testing**: Are platform-specific export settings and input methods specified?
86
+ - **Memory leak testing**: Are signal cleanup and node lifecycle validation steps included?
87
+
88
+ ### 7. Godot Performance and Optimization Validation
89
+
90
+ - **Frame rate targets**: Is 60+ FPS minimum clearly specified for all platforms?
91
+ - **Memory budgets**: Are scene memory, resource memory, and pooling limits defined?
92
+ - **Draw call optimization**: Are rendering batches and viewport optimization approaches specified?
93
+ - **Mobile performance**: Are mobile export settings and touch optimization addressed?
94
+ - **Resource optimization**: Are import settings, compression, and preloading strategies clear?
95
+ - **Language optimization**: Are static typing (GDScript) and C# patterns (no LINQ) specified?
96
+ - **Loading time targets**: Are scene transitions <3 seconds and resource streaming defined?
97
+
98
+ ### 8. Godot Platform and Export Considerations
99
+
100
+ - **Export templates**: Are platform-specific export templates and settings documented?
101
+ - **Platform features**: Are platform-specific Godot features properly configured?
102
+ - **Data persistence**: Are user:// path usage and save system requirements specified?
103
+ - **Input handling**: Are InputMap configurations for each platform defined?
104
+ - **Performance targets**: Are platform-specific 60+ FPS optimizations addressed?
105
+ - **Export security**: Are release vs debug export settings properly configured?
106
+
107
+ ### 9. Godot Development Task Sequence Validation
108
+
109
+ - **TDD workflow order**: Do tasks follow TDD cycle (write tests first, then implement, then refactor)?
110
+ - **Node hierarchy dependencies**: Are parent nodes created before child nodes?
111
+ - **Resource dependencies**: Are resources created before scenes that use them?
112
+ - **Signal connections**: Are signal emitters created before receivers?
113
+ - **Testing integration**: Are GUT/GoDotTest creation tasks before implementation?
114
+ - **Export integration**: Are export preset configurations properly sequenced?
115
+ - **Performance validation**: Are profiling checkpoints placed throughout development?
116
+
117
+ ### 10. Godot Anti-Hallucination Verification
118
+
119
+ - **Godot API accuracy**: Every Godot API reference must be verified against current Godot documentation
120
+ - **Plugin verification**: All GDExtension and addon references must be valid
121
+ - **Node architecture alignment**: Node relationships must match architecture specifications
122
+ - **Performance claims verification**: 60+ FPS targets must be realistic for target platforms
123
+ - **Resource pipeline accuracy**: All import settings and resource configurations must be valid
124
+ - **Language strategy verification**: GDScript vs C# choices must align with performance needs
125
+
126
+ ### 11. Godot Development Agent Implementation Readiness
127
+
128
+ - **Godot context completeness**: Can the story be implemented without consulting external Godot documentation?
129
+ - **Language specification clarity**: Are GDScript/C# choices and patterns unambiguous?
130
+ - **Resource requirements clarity**: Are all resources, scenes, and import settings defined?
131
+ - **Node relationship clarity**: Are all node interactions and signal flows explicitly defined?
132
+ - **TDD approach completeness**: Are GUT/GoDotTest approaches fully specified?
133
+ - **Performance validation readiness**: Are 60+ FPS validation approaches clearly defined?
134
+
135
+ ### 12. Generate Godot Game Story Validation Report
136
+
137
+ Provide a structured validation report including:
138
+
139
+ #### Game Story Template Compliance Issues
140
+
141
+ - Missing Godot-specific sections from game story template
142
+ - Unfilled placeholders or template variables specific to game development
143
+ - Missing node specifications or resource requirements
144
+ - Missing TDD test specifications (GUT/GoDotTest)
145
+ - Language strategy gaps (GDScript vs C# decisions)
146
+
147
+ #### Critical Godot Issues (Must Fix - Story Blocked)
148
+
149
+ - Missing essential Godot technical information for implementation
150
+ - No TDD test specifications (GUT/GoDotTest)
151
+ - Performance targets not meeting 60+ FPS requirement
152
+ - Missing language strategy (GDScript vs C# choices)
153
+ - Incomplete node architecture or signal flow
154
+ - Missing object pooling for spawned entities
155
+
156
+ #### Godot-Specific Should-Fix Issues (Important Quality Improvements)
157
+
158
+ - Unclear node hierarchy or signal connection patterns
159
+ - Missing static typing in GDScript specifications
160
+ - Incomplete resource pipeline or import settings
161
+ - Task sequencing not following TDD cycle
162
+ - Missing platform export template specifications
163
+ - Inadequate performance profiling checkpoints
164
+
165
+ #### Game Development Nice-to-Have Improvements (Optional Enhancements)
166
+
167
+ - Additional Godot performance optimization context
168
+ - Enhanced resource creation guidance and best practices
169
+ - Clarifications for Godot-specific patterns (signals, groups)
170
+ - Additional platform export considerations
171
+ - Enhanced profiler usage guidance
172
+
173
+ #### Godot Anti-Hallucination Findings
174
+
175
+ - Unverifiable Godot API claims or outdated references
176
+ - Wrong language choice justifications (GDScript vs C#)
177
+ - Inconsistencies with Godot project architecture documents
178
+ - Invented nodes, signals, or development patterns
179
+ - Performance claims not achieving 60+ FPS
180
+ - Missing static typing or optimization patterns
181
+
182
+ #### Godot Platform and Performance Validation
183
+
184
+ - **Performance Assessment**: 60+ FPS validation, frame time <16.67ms
185
+ - **Platform Compatibility Check**: Export templates, InputMap, platform features
186
+ - **Resource Pipeline Validation**: Import settings, compression, pooling strategies
187
+ - **Godot Version Compliance**: Compatibility with Godot 4.x or 3.x LTS
188
+ - **Language Performance**: Static typing enforcement, C# optimization patterns
189
+
190
+ #### Final Godot Game Development Assessment
191
+
192
+ - **GO**: Story ready for Godot implementation with TDD and 60+ FPS targets
193
+ - **NO-GO**: Story requires Godot-specific fixes before implementation
194
+ - **TDD Readiness Score**: 1-10 scale based on test coverage planning
195
+ - **Performance Readiness**: Can maintain 60+ FPS? Yes/No/Unknown
196
+ - **Language Strategy Score**: 1-10 scale for GDScript/C# appropriateness
197
+ - **Platform Export Readiness**: Assessment of export template preparedness
198
+
199
+ #### Recommended Next Steps
200
+
201
+ Based on validation results, provide specific recommendations for:
202
+
203
+ - Godot technical documentation improvements needed
204
+ - TDD test specifications (GUT/GoDotTest) to add
205
+ - Language strategy clarifications (GDScript vs C#)
206
+ - Performance profiling setup for 60+ FPS validation
207
+ - Platform export template configuration needs
208
+ - Object pooling implementation requirements
@@ -0,0 +1,156 @@
1
+ template:
2
+ id: brainstorming-output-template-v2
3
+ name: Brainstorming Session Results
4
+ version: 2.0
5
+ output:
6
+ format: markdown
7
+ filename: docs/brainstorming-session-results.md
8
+ title: "Brainstorming Session Results"
9
+
10
+ workflow:
11
+ mode: non-interactive
12
+
13
+ sections:
14
+ - id: header
15
+ content: |
16
+ **Session Date:** {{date}}
17
+ **Facilitator:** {{agent_role}} {{agent_name}}
18
+ **Participant:** {{user_name}}
19
+
20
+ - id: executive-summary
21
+ title: Executive Summary
22
+ sections:
23
+ - id: summary-details
24
+ template: |
25
+ **Topic:** {{session_topic}}
26
+
27
+ **Session Goals:** {{stated_goals}}
28
+
29
+ **Techniques Used:** {{techniques_list}}
30
+
31
+ **Total Ideas Generated:** {{total_ideas}}
32
+ - id: key-themes
33
+ title: "Key Themes Identified:"
34
+ type: bullet-list
35
+ template: "- {{theme}}"
36
+
37
+ - id: technique-sessions
38
+ title: Technique Sessions
39
+ repeatable: true
40
+ sections:
41
+ - id: technique
42
+ title: "{{technique_name}} - {{duration}}"
43
+ sections:
44
+ - id: description
45
+ template: "**Description:** {{technique_description}}"
46
+ - id: ideas-generated
47
+ title: "Ideas Generated:"
48
+ type: numbered-list
49
+ template: "{{idea}}"
50
+ - id: insights
51
+ title: "Insights Discovered:"
52
+ type: bullet-list
53
+ template: "- {{insight}}"
54
+ - id: connections
55
+ title: "Notable Connections:"
56
+ type: bullet-list
57
+ template: "- {{connection}}"
58
+
59
+ - id: idea-categorization
60
+ title: Idea Categorization
61
+ sections:
62
+ - id: immediate-opportunities
63
+ title: Immediate Opportunities
64
+ content: "*Ideas ready to implement now*"
65
+ repeatable: true
66
+ type: numbered-list
67
+ template: |
68
+ **{{idea_name}}**
69
+ - Description: {{description}}
70
+ - Why immediate: {{rationale}}
71
+ - Resources needed: {{requirements}}
72
+ - id: future-innovations
73
+ title: Future Innovations
74
+ content: "*Ideas requiring development/research*"
75
+ repeatable: true
76
+ type: numbered-list
77
+ template: |
78
+ **{{idea_name}}**
79
+ - Description: {{description}}
80
+ - Development needed: {{development_needed}}
81
+ - Timeline estimate: {{timeline}}
82
+ - id: moonshots
83
+ title: Moonshots
84
+ content: "*Ambitious, transformative concepts*"
85
+ repeatable: true
86
+ type: numbered-list
87
+ template: |
88
+ **{{idea_name}}**
89
+ - Description: {{description}}
90
+ - Transformative potential: {{potential}}
91
+ - Challenges to overcome: {{challenges}}
92
+ - id: insights-learnings
93
+ title: Insights & Learnings
94
+ content: "*Key realizations from the session*"
95
+ type: bullet-list
96
+ template: "- {{insight}}: {{description_and_implications}}"
97
+
98
+ - id: action-planning
99
+ title: Action Planning
100
+ sections:
101
+ - id: top-priorities
102
+ title: Top 3 Priority Ideas
103
+ sections:
104
+ - id: priority-1
105
+ title: "#1 Priority: {{idea_name}}"
106
+ template: |
107
+ - Rationale: {{rationale}}
108
+ - Next steps: {{next_steps}}
109
+ - Resources needed: {{resources}}
110
+ - Timeline: {{timeline}}
111
+ - id: priority-2
112
+ title: "#2 Priority: {{idea_name}}"
113
+ template: |
114
+ - Rationale: {{rationale}}
115
+ - Next steps: {{next_steps}}
116
+ - Resources needed: {{resources}}
117
+ - Timeline: {{timeline}}
118
+ - id: priority-3
119
+ title: "#3 Priority: {{idea_name}}"
120
+ template: |
121
+ - Rationale: {{rationale}}
122
+ - Next steps: {{next_steps}}
123
+ - Resources needed: {{resources}}
124
+ - Timeline: {{timeline}}
125
+
126
+ - id: reflection-followup
127
+ title: Reflection & Follow-up
128
+ sections:
129
+ - id: what-worked
130
+ title: What Worked Well
131
+ type: bullet-list
132
+ template: "- {{aspect}}"
133
+ - id: areas-exploration
134
+ title: Areas for Further Exploration
135
+ type: bullet-list
136
+ template: "- {{area}}: {{reason}}"
137
+ - id: recommended-techniques
138
+ title: Recommended Follow-up Techniques
139
+ type: bullet-list
140
+ template: "- {{technique}}: {{reason}}"
141
+ - id: questions-emerged
142
+ title: Questions That Emerged
143
+ type: bullet-list
144
+ template: "- {{question}}"
145
+ - id: next-session
146
+ title: Next Session Planning
147
+ template: |
148
+ - **Suggested topics:** {{followup_topics}}
149
+ - **Recommended timeframe:** {{timeframe}}
150
+ - **Preparation needed:** {{preparation}}
151
+
152
+ - id: footer
153
+ content: |
154
+ ---
155
+
156
+ *Session facilitated using the BMAD-METHOD brainstorming framework*
@@ -0,0 +1,281 @@
1
+ # <!-- Powered by BMAD™ Core -->
2
+ template:
3
+ id: brownfield-prd-template-v2
4
+ name: Brownfield Enhancement PRD
5
+ version: 2.0
6
+ output:
7
+ format: markdown
8
+ filename: docs/prd.md
9
+ title: "{{project_name}} Brownfield Enhancement PRD"
10
+
11
+ workflow:
12
+ mode: interactive
13
+ elicitation: advanced-elicitation
14
+
15
+ sections:
16
+ - id: intro-analysis
17
+ title: Intro Project Analysis and Context
18
+ instruction: |
19
+ IMPORTANT - SCOPE ASSESSMENT REQUIRED:
20
+
21
+ This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
22
+
23
+ 1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
24
+
25
+ 2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
26
+
27
+ 3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.
28
+
29
+ Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
30
+
31
+ CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
32
+
33
+ Do not proceed with any recommendations until the user has validated your understanding of the existing system.
34
+ sections:
35
+ - id: existing-project-overview
36
+ title: Existing Project Overview
37
+ instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.
38
+ sections:
39
+ - id: analysis-source
40
+ title: Analysis Source
41
+ instruction: |
42
+ Indicate one of the following:
43
+ - Document-project output available at: {{path}}
44
+ - IDE-based fresh analysis
45
+ - User-provided information
46
+ - id: current-state
47
+ title: Current Project State
48
+ instruction: |
49
+ - If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
50
+ - Otherwise: Brief description of what the project currently does and its primary purpose
51
+ - id: documentation-analysis
52
+ title: Available Documentation Analysis
53
+ instruction: |
54
+ If document-project was run:
55
+ - Note: "Document-project analysis available - using existing technical documentation"
56
+ - List key documents created by document-project
57
+ - Skip the missing documentation check below
58
+
59
+ Otherwise, check for existing documentation:
60
+ sections:
61
+ - id: available-docs
62
+ title: Available Documentation
63
+ type: checklist
64
+ items:
65
+ - Tech Stack Documentation [[LLM: If from document-project, check ✓]]
66
+ - Source Tree/Architecture [[LLM: If from document-project, check ✓]]
67
+ - Coding Standards [[LLM: If from document-project, may be partial]]
68
+ - API Documentation [[LLM: If from document-project, check ✓]]
69
+ - External API Documentation [[LLM: If from document-project, check ✓]]
70
+ - UX/UI Guidelines [[LLM: May not be in document-project]]
71
+ - Technical Debt Documentation [[LLM: If from document-project, check ✓]]
72
+ - "Other: {{other_docs}}"
73
+ instruction: |
74
+ - If document-project was already run: "Using existing project analysis from document-project output."
75
+ - If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
76
+ - id: enhancement-scope
77
+ title: Enhancement Scope Definition
78
+ instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.
79
+ sections:
80
+ - id: enhancement-type
81
+ title: Enhancement Type
82
+ type: checklist
83
+ instruction: Determine with user which applies
84
+ items:
85
+ - New Feature Addition
86
+ - Major Feature Modification
87
+ - Integration with New Systems
88
+ - Performance/Scalability Improvements
89
+ - UI/UX Overhaul
90
+ - Technology Stack Upgrade
91
+ - Bug Fix and Stability Improvements
92
+ - "Other: {{other_type}}"
93
+ - id: enhancement-description
94
+ title: Enhancement Description
95
+ instruction: 2-3 sentences describing what the user wants to add or change
96
+ - id: impact-assessment
97
+ title: Impact Assessment
98
+ type: checklist
99
+ instruction: Assess the scope of impact on existing codebase
100
+ items:
101
+ - Minimal Impact (isolated additions)
102
+ - Moderate Impact (some existing code changes)
103
+ - Significant Impact (substantial existing code changes)
104
+ - Major Impact (architectural changes required)
105
+ - id: goals-context
106
+ title: Goals and Background Context
107
+ sections:
108
+ - id: goals
109
+ title: Goals
110
+ type: bullet-list
111
+ instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful
112
+ - id: background
113
+ title: Background Context
114
+ type: paragraphs
115
+ instruction: 1-2 short paragraphs explaining why this enhancement is needed, what problem it solves, and how it fits with the existing project
116
+ - id: changelog
117
+ title: Change Log
118
+ type: table
119
+ columns: [Change, Date, Version, Description, Author]
120
+
121
+ - id: requirements
122
+ title: Requirements
123
+ instruction: |
124
+ Draft functional and non-functional requirements based on your validated understanding of the existing project. Before presenting requirements, confirm: "These requirements are based on my understanding of your existing system. Please review carefully and confirm they align with your project's reality."
125
+ elicit: true
126
+ sections:
127
+ - id: functional
128
+ title: Functional
129
+ type: numbered-list
130
+ prefix: FR
131
+ instruction: Each Requirement will be a bullet markdown with identifier starting with FR
132
+ examples:
133
+ - "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality."
134
+ - id: non-functional
135
+ title: Non Functional
136
+ type: numbered-list
137
+ prefix: NFR
138
+ instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system
139
+ examples:
140
+ - "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%."
141
+ - id: compatibility
142
+ title: Compatibility Requirements
143
+ instruction: Critical for brownfield - what must remain compatible
144
+ type: numbered-list
145
+ prefix: CR
146
+ template: "{{requirement}}: {{description}}"
147
+ items:
148
+ - id: cr1
149
+ template: "CR1: {{existing_api_compatibility}}"
150
+ - id: cr2
151
+ template: "CR2: {{database_schema_compatibility}}"
152
+ - id: cr3
153
+ template: "CR3: {{ui_ux_consistency}}"
154
+ - id: cr4
155
+ template: "CR4: {{integration_compatibility}}"
156
+
157
+ - id: ui-enhancement-goals
158
+ title: User Interface Enhancement Goals
159
+ condition: Enhancement includes UI changes
160
+ instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems
161
+ sections:
162
+ - id: existing-ui-integration
163
+ title: Integration with Existing UI
164
+ instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries
165
+ - id: modified-screens
166
+ title: Modified/New Screens and Views
167
+ instruction: List only the screens/views that will be modified or added
168
+ - id: ui-consistency
169
+ title: UI Consistency Requirements
170
+ instruction: Specific requirements for maintaining visual and interaction consistency with existing application
171
+
172
+ - id: technical-constraints
173
+ title: Technical Constraints and Integration Requirements
174
+ instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.
175
+ sections:
176
+ - id: existing-tech-stack
177
+ title: Existing Technology Stack
178
+ instruction: |
179
+ If document-project output available:
180
+ - Extract from "Actual Tech Stack" table in High Level Architecture section
181
+ - Include version numbers and any noted constraints
182
+
183
+ Otherwise, document the current technology stack:
184
+ template: |
185
+ **Languages**: {{languages}}
186
+ **Frameworks**: {{frameworks}}
187
+ **Database**: {{database}}
188
+ **Infrastructure**: {{infrastructure}}
189
+ **External Dependencies**: {{external_dependencies}}
190
+ - id: integration-approach
191
+ title: Integration Approach
192
+ instruction: Define how the enhancement will integrate with existing architecture
193
+ template: |
194
+ **Database Integration Strategy**: {{database_integration}}
195
+ **API Integration Strategy**: {{api_integration}}
196
+ **Frontend Integration Strategy**: {{frontend_integration}}
197
+ **Testing Integration Strategy**: {{testing_integration}}
198
+ - id: code-organization
199
+ title: Code Organization and Standards
200
+ instruction: Based on existing project analysis, define how new code will fit existing patterns
201
+ template: |
202
+ **File Structure Approach**: {{file_structure}}
203
+ **Naming Conventions**: {{naming_conventions}}
204
+ **Coding Standards**: {{coding_standards}}
205
+ **Documentation Standards**: {{documentation_standards}}
206
+ - id: deployment-operations
207
+ title: Deployment and Operations
208
+ instruction: How the enhancement fits existing deployment pipeline
209
+ template: |
210
+ **Build Process Integration**: {{build_integration}}
211
+ **Deployment Strategy**: {{deployment_strategy}}
212
+ **Monitoring and Logging**: {{monitoring_logging}}
213
+ **Configuration Management**: {{config_management}}
214
+ - id: risk-assessment
215
+ title: Risk Assessment and Mitigation
216
+ instruction: |
217
+ If document-project output available:
218
+ - Reference "Technical Debt and Known Issues" section
219
+ - Include "Workarounds and Gotchas" that might impact enhancement
220
+ - Note any identified constraints from "Critical Technical Debt"
221
+
222
+ Build risk assessment incorporating existing known issues:
223
+ template: |
224
+ **Technical Risks**: {{technical_risks}}
225
+ **Integration Risks**: {{integration_risks}}
226
+ **Deployment Risks**: {{deployment_risks}}
227
+ **Mitigation Strategies**: {{mitigation_strategies}}
228
+
229
+ - id: epic-structure
230
+ title: Epic and Story Structure
231
+ instruction: |
232
+ For brownfield projects, favor a single comprehensive epic unless the user is clearly requesting multiple unrelated enhancements. Before presenting the epic structure, confirm: "Based on my analysis of your existing project, I believe this enhancement should be structured as [single epic/multiple epics] because [rationale based on actual project analysis]. Does this align with your understanding of the work required?"
233
+ elicit: true
234
+ sections:
235
+ - id: epic-approach
236
+ title: Epic Approach
237
+ instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features
238
+ template: "**Epic Structure Decision**: {{epic_decision}} with rationale"
239
+
240
+ - id: epic-details
241
+ title: "Epic 1: {{enhancement_title}}"
242
+ instruction: |
243
+ Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
244
+
245
+ CRITICAL STORY SEQUENCING FOR BROWNFIELD:
246
+ - Stories must ensure existing functionality remains intact
247
+ - Each story should include verification that existing features still work
248
+ - Stories should be sequenced to minimize risk to existing system
249
+ - Include rollback considerations for each story
250
+ - Focus on incremental integration rather than big-bang changes
251
+ - Size stories for AI agent execution in existing codebase context
252
+ - MANDATORY: Present the complete story sequence and ask: "This story sequence is designed to minimize risk to your existing system. Does this order make sense given your project's architecture and constraints?"
253
+ - Stories must be logically sequential with clear dependencies identified
254
+ - Each story must deliver value while maintaining system integrity
255
+ template: |
256
+ **Epic Goal**: {{epic_goal}}
257
+
258
+ **Integration Requirements**: {{integration_requirements}}
259
+ sections:
260
+ - id: story
261
+ title: "Story 1.{{story_number}} {{story_title}}"
262
+ repeatable: true
263
+ template: |
264
+ As a {{user_type}},
265
+ I want {{action}},
266
+ so that {{benefit}}.
267
+ sections:
268
+ - id: acceptance-criteria
269
+ title: Acceptance Criteria
270
+ type: numbered-list
271
+ instruction: Define criteria that include both new functionality and existing system integrity
272
+ item_template: "{{criterion_number}}: {{criteria}}"
273
+ - id: integration-verification
274
+ title: Integration Verification
275
+ instruction: Specific verification steps to ensure existing functionality remains intact
276
+ type: numbered-list
277
+ prefix: IV
278
+ items:
279
+ - template: "IV1: {{existing_functionality_verification}}"
280
+ - template: "IV2: {{integration_point_verification}}"
281
+ - template: "IV3: {{performance_impact_verification}}"