bmad-method 4.27.0 → 4.27.2

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 (99) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/bmad-core/agent-teams/team-all.yaml +6 -6
  3. package/bmad-core/agent-teams/team-fullstack.yaml +6 -6
  4. package/bmad-core/agent-teams/team-no-ui.yaml +2 -2
  5. package/bmad-core/agents/analyst.md +17 -20
  6. package/bmad-core/agents/architect.md +15 -18
  7. package/bmad-core/agents/bmad-master.md +55 -56
  8. package/bmad-core/agents/bmad-orchestrator.md +24 -23
  9. package/bmad-core/agents/dev.md +10 -10
  10. package/bmad-core/agents/pm.md +17 -20
  11. package/bmad-core/agents/po.md +12 -15
  12. package/bmad-core/agents/qa.md +7 -8
  13. package/bmad-core/agents/sm.md +8 -13
  14. package/bmad-core/agents/ux-expert.md +7 -11
  15. package/bmad-core/core-config.yaml +1 -1
  16. package/bmad-core/templates/architecture-tmpl.yaml +650 -0
  17. package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
  18. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
  19. package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
  20. package/bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
  21. package/bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
  22. package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
  23. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +805 -0
  24. package/bmad-core/templates/market-research-tmpl.yaml +252 -0
  25. package/bmad-core/templates/{prd-tmpl2.yaml → prd-tmpl.yaml} +3 -3
  26. package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
  27. package/bmad-core/templates/story-tmpl.yaml +137 -0
  28. package/common/tasks/create-doc.md +55 -67
  29. package/common/utils/bmad-doc-template.md +29 -0
  30. package/dist/agents/analyst.txt +1004 -1061
  31. package/dist/agents/architect.txt +2460 -2872
  32. package/dist/agents/bmad-master.txt +3842 -4354
  33. package/dist/agents/bmad-orchestrator.txt +211 -87
  34. package/dist/agents/dev.txt +4 -8
  35. package/dist/agents/pm.txt +557 -587
  36. package/dist/agents/po.txt +149 -102
  37. package/dist/agents/qa.txt +145 -35
  38. package/dist/agents/sm.txt +145 -100
  39. package/dist/agents/ux-expert.txt +413 -522
  40. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +1258 -1236
  41. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +623 -573
  42. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +263 -248
  43. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +9135 -4942
  44. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +288 -251
  45. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +1123 -1145
  46. package/dist/teams/team-all.txt +4583 -4837
  47. package/dist/teams/team-fullstack.txt +5276 -5520
  48. package/dist/teams/team-ide-minimal.txt +375 -185
  49. package/dist/teams/team-no-ui.txt +4875 -5051
  50. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +2 -2
  51. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +17 -15
  52. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +13 -11
  53. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +13 -11
  54. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  55. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +613 -0
  56. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +356 -0
  57. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +343 -0
  58. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +253 -0
  59. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
  60. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +14 -12
  61. package/expansion-packs/bmad-creator-tools/config.yaml +1 -1
  62. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +178 -0
  63. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +154 -0
  64. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +120 -0
  65. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +14 -14
  66. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  67. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +424 -0
  68. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +629 -0
  69. package/package.json +1 -1
  70. package/tools/builders/web-builder.js +65 -85
  71. package/tools/installer/package.json +1 -1
  72. package/tools/lib/dependency-resolver.js +8 -19
  73. package/zoo/docs/architecture.md +812 -0
  74. package/zoo/docs/brief.md +253 -0
  75. package/zoo/docs/prd.md +500 -0
  76. package/zoo/docs/stories/1.1.story.md +278 -0
  77. package/bmad-core/templates/architecture-tmpl.md +0 -776
  78. package/bmad-core/templates/brainstorming-output-tmpl.md +0 -149
  79. package/bmad-core/templates/brownfield-architecture-tmpl.md +0 -544
  80. package/bmad-core/templates/brownfield-prd-tmpl.md +0 -266
  81. package/bmad-core/templates/competitor-analysis-tmpl.md +0 -291
  82. package/bmad-core/templates/front-end-architecture-tmpl.md +0 -175
  83. package/bmad-core/templates/front-end-spec-tmpl.md +0 -413
  84. package/bmad-core/templates/fullstack-architecture-tmpl.md +0 -1018
  85. package/bmad-core/templates/market-research-tmpl.md +0 -263
  86. package/bmad-core/templates/prd-tmpl.md +0 -202
  87. package/bmad-core/templates/project-brief-tmpl.md +0 -232
  88. package/bmad-core/templates/story-tmpl.md +0 -58
  89. package/common/tasks/create-doc2.md +0 -65
  90. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md +0 -560
  91. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md +0 -345
  92. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md +0 -331
  93. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.md +0 -235
  94. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md +0 -470
  95. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.md +0 -154
  96. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.md +0 -143
  97. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +0 -91
  98. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +0 -415
  99. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
@@ -1,149 +0,0 @@
1
- ---
2
- defaultOutput: docs/brainstorming-session-results.md
3
- ---
4
-
5
- # Brainstorming Session Results
6
-
7
- **Session Date:** [DATE]
8
- **Facilitator:** [Agent Role] [Agent Name]
9
- **Participant:** [USER NAME]
10
-
11
- ## Executive Summary
12
-
13
- **Topic:** [SESSION TOPIC]
14
-
15
- **Session Goals:** [STATED GOALS]
16
-
17
- **Techniques Used:** [LIST OF TECHNIQUES AND DURATION]
18
-
19
- **Total Ideas Generated:** [NUMBER]
20
-
21
- **Key Themes Identified:**
22
-
23
- - [THEME 1]
24
- - [THEME 2]
25
- - [THEME 3]
26
-
27
- ---
28
-
29
- ## Technique Sessions
30
-
31
- ### [TECHNIQUE NAME 1] - [DURATION]
32
-
33
- **Description:** [BRIEF DESCRIPTION OF TECHNIQUE]
34
-
35
- **Ideas Generated:**
36
-
37
- 1. [USER IDEA 1]
38
- 2. [USER IDEA 2]
39
- 3. [USER IDEA 3]
40
- [etc.]
41
-
42
- **Insights Discovered:**
43
-
44
- - [INSIGHT 1]
45
- - [INSIGHT 2]
46
-
47
- **Notable Connections:**
48
-
49
- - [CONNECTION OR PATTERN IDENTIFIED]
50
-
51
- ---
52
-
53
- ### [TECHNIQUE NAME 2] - [DURATION]
54
-
55
- [Repeat format for each technique used]
56
-
57
- ---
58
-
59
- ## Idea Categorization
60
-
61
- ### Immediate Opportunities
62
-
63
- *Ideas ready to implement now*
64
-
65
- 1. **[IDEA NAME]**
66
- - Description: [BRIEF DESCRIPTION]
67
- - Why immediate: [RATIONALE]
68
- - Resources needed: [BASIC REQUIREMENTS]
69
-
70
- ### Future Innovations
71
-
72
- *Ideas requiring development/research*
73
-
74
- 1. **[IDEA NAME]**
75
- - Description: [BRIEF DESCRIPTION]
76
- - Development needed: [WHAT'S REQUIRED]
77
- - Timeline estimate: [ROUGH TIMEFRAME]
78
-
79
- ### Moonshots
80
-
81
- *Ambitious, transformative concepts*
82
-
83
- 1. **[IDEA NAME]**
84
- - Description: [BRIEF DESCRIPTION]
85
- - Transformative potential: [WHY IT'S A MOONSHOT]
86
- - Challenges to overcome: [MAJOR OBSTACLES]
87
-
88
- ### Insights & Learnings
89
-
90
- *Key realizations from the session*
91
-
92
- - [INSIGHT 1]: [DESCRIPTION AND IMPLICATIONS]
93
- - [INSIGHT 2]: [DESCRIPTION AND IMPLICATIONS]
94
-
95
- ---
96
-
97
- ## Action Planning
98
-
99
- ### Top 3 Priority Ideas
100
-
101
- **#1 Priority: [IDEA NAME]**
102
-
103
- - Rationale: [WHY THIS IS TOP PRIORITY]
104
- - Next steps: [SPECIFIC ACTIONS TO TAKE]
105
- - Resources needed: [WHAT'S REQUIRED]
106
- - Timeline: [WHEN TO START/COMPLETE]
107
-
108
- **#2 Priority: [IDEA NAME]**
109
-
110
- - [Same format]
111
-
112
- **#3 Priority: [IDEA NAME]**
113
-
114
- - [Same format]
115
-
116
- ---
117
-
118
- ## Reflection & Follow-up
119
-
120
- ### What Worked Well
121
-
122
- - [SUCCESSFUL ASPECT 1]
123
- - [SUCCESSFUL ASPECT 2]
124
-
125
- ### Areas for Further Exploration
126
-
127
- - [AREA 1]: [WHY IT NEEDS MORE EXPLORATION]
128
- - [AREA 2]: [WHY IT NEEDS MORE EXPLORATION]
129
-
130
- ### Recommended Follow-up Techniques
131
-
132
- - [TECHNIQUE 1]: [WHY IT WOULD BE HELPFUL]
133
- - [TECHNIQUE 2]: [WHY IT WOULD BE HELPFUL]
134
-
135
- ### Questions That Emerged
136
-
137
- - [QUESTION 1]
138
- - [QUESTION 2]
139
- - [QUESTION 3]
140
-
141
- ### Next Session Planning
142
-
143
- - **Suggested topics:** [FOLLOW-UP TOPICS]
144
- - **Recommended timeframe:** [WHEN TO RECONVENE]
145
- - **Preparation needed:** [WHAT TO RESEARCH/PREPARE]
146
-
147
- ---
148
-
149
- *Session facilitated using the BMAD-METHOD brainstorming framework*
@@ -1,544 +0,0 @@
1
- # {{Project Name}} Brownfield Enhancement Architecture
2
-
3
- [[LLM: The default path and filename unless specified is docs/architecture.md]]
4
-
5
- [[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
6
-
7
- This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
8
-
9
- 1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
10
-
11
- 2. **REQUIRED INPUTS**:
12
-
13
- - Completed brownfield-prd.md
14
- - Existing project technical documentation (from docs folder or user-provided)
15
- - Access to existing project structure (IDE or uploaded files)
16
-
17
- 3. **DEEP ANALYSIS MANDATE**: You MUST conduct thorough analysis of the existing codebase, architecture patterns, and technical constraints before making ANY architectural recommendations. Every suggestion must be based on actual project analysis, not assumptions.
18
-
19
- 4. **CONTINUOUS VALIDATION**: Throughout this process, explicitly validate your understanding with the user. For every architectural decision, confirm: "Based on my analysis of your existing system, I recommend [decision] because [evidence from actual project]. Does this align with your system's reality?"
20
-
21
- If any required inputs are missing, request them before proceeding.]]
22
-
23
- ## Introduction
24
-
25
- [[LLM: This section establishes the document's purpose and scope for brownfield enhancements. Keep the content below but ensure project name and enhancement details are properly substituted.
26
-
27
- After presenting this section, apply `tasks#advanced-elicitation` protocol]]
28
-
29
- This document outlines the architectural approach for enhancing {{Project Name}} with {{Enhancement Description}}. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development of new features while ensuring seamless integration with the existing system.
30
-
31
- **Relationship to Existing Architecture:**
32
- This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements.
33
-
34
- ### Existing Project Analysis
35
-
36
- [[LLM: Analyze the existing project structure and architecture:
37
-
38
- 1. Review existing documentation in docs folder
39
- 2. Examine current technology stack and versions
40
- 3. Identify existing architectural patterns and conventions
41
- 4. Note current deployment and infrastructure setup
42
- 5. Document any constraints or limitations
43
-
44
- CRITICAL: After your analysis, explicitly validate your findings: "Based on my analysis of your project, I've identified the following about your existing system: [key findings]. Please confirm these observations are accurate before I proceed with architectural recommendations."
45
-
46
- Present findings and apply `tasks#advanced-elicitation` protocol]]
47
-
48
- **Current Project State:**
49
-
50
- - **Primary Purpose:** {{existing_project_purpose}}
51
- - **Current Tech Stack:** {{existing_tech_summary}}
52
- - **Architecture Style:** {{existing_architecture_style}}
53
- - **Deployment Method:** {{existing_deployment_approach}}
54
-
55
- **Available Documentation:**
56
-
57
- - {{existing_docs_summary}}
58
-
59
- **Identified Constraints:**
60
-
61
- - {{constraint_1}}
62
- - {{constraint_2}}
63
- - {{constraint_3}}
64
-
65
- ### Change Log
66
-
67
- | Change | Date | Version | Description | Author |
68
- | ------ | ---- | ------- | ----------- | ------ |
69
-
70
- ## Enhancement Scope and Integration Strategy
71
-
72
- [[LLM: Define how the enhancement will integrate with the existing system:
73
-
74
- 1. Review the brownfield PRD enhancement scope
75
- 2. Identify integration points with existing code
76
- 3. Define boundaries between new and existing functionality
77
- 4. Establish compatibility requirements
78
-
79
- VALIDATION CHECKPOINT: Before presenting the integration strategy, confirm: "Based on my analysis, the integration approach I'm proposing takes into account [specific existing system characteristics]. These integration points and boundaries respect your current architecture patterns. Is this assessment accurate?"
80
-
81
- Present complete integration strategy and apply `tasks#advanced-elicitation` protocol]]
82
-
83
- ### Enhancement Overview
84
-
85
- **Enhancement Type:** {{enhancement_type}}
86
- **Scope:** {{enhancement_scope}}
87
- **Integration Impact:** {{integration_impact_level}}
88
-
89
- ### Integration Approach
90
-
91
- **Code Integration Strategy:** {{code_integration_approach}}
92
- **Database Integration:** {{database_integration_approach}}
93
- **API Integration:** {{api_integration_approach}}
94
- **UI Integration:** {{ui_integration_approach}}
95
-
96
- ### Compatibility Requirements
97
-
98
- - **Existing API Compatibility:** {{api_compatibility}}
99
- - **Database Schema Compatibility:** {{db_compatibility}}
100
- - **UI/UX Consistency:** {{ui_compatibility}}
101
- - **Performance Impact:** {{performance_constraints}}
102
-
103
- ## Tech Stack Alignment
104
-
105
- [[LLM: Ensure new components align with existing technology choices:
106
-
107
- 1. Use existing technology stack as the foundation
108
- 2. Only introduce new technologies if absolutely necessary
109
- 3. Justify any new additions with clear rationale
110
- 4. Ensure version compatibility with existing dependencies
111
-
112
- Present complete tech stack alignment and apply `tasks#advanced-elicitation` protocol]]
113
-
114
- ### Existing Technology Stack
115
-
116
- [[LLM: Document the current stack that must be maintained or integrated with]]
117
-
118
- | Category | Current Technology | Version | Usage in Enhancement | Notes |
119
- | :----------------- | :----------------- | :---------- | :------------------- | :-------- |
120
- | **Language** | {{language}} | {{version}} | {{usage}} | {{notes}} |
121
- | **Runtime** | {{runtime}} | {{version}} | {{usage}} | {{notes}} |
122
- | **Framework** | {{framework}} | {{version}} | {{usage}} | {{notes}} |
123
- | **Database** | {{database}} | {{version}} | {{usage}} | {{notes}} |
124
- | **API Style** | {{api_style}} | {{version}} | {{usage}} | {{notes}} |
125
- | **Authentication** | {{auth}} | {{version}} | {{usage}} | {{notes}} |
126
- | **Testing** | {{test_framework}} | {{version}} | {{usage}} | {{notes}} |
127
- | **Build Tool** | {{build_tool}} | {{version}} | {{usage}} | {{notes}} |
128
-
129
- ### New Technology Additions
130
-
131
- [[LLM: Only include if new technologies are required for the enhancement]]
132
-
133
- ^^CONDITION: has_new_tech^^
134
-
135
- | Technology | Version | Purpose | Rationale | Integration Method |
136
- | :----------- | :---------- | :---------- | :------------ | :----------------- |
137
- | {{new_tech}} | {{version}} | {{purpose}} | {{rationale}} | {{integration}} |
138
-
139
- ^^/CONDITION: has_new_tech^^
140
-
141
- ## Data Models and Schema Changes
142
-
143
- [[LLM: Define new data models and how they integrate with existing schema:
144
-
145
- 1. Identify new entities required for the enhancement
146
- 2. Define relationships with existing data models
147
- 3. Plan database schema changes (additions, modifications)
148
- 4. Ensure backward compatibility
149
-
150
- Present data model changes and apply `tasks#advanced-elicitation` protocol]]
151
-
152
- ### New Data Models
153
-
154
- <<REPEAT: new_data_model>>
155
-
156
- ### {{model_name}}
157
-
158
- **Purpose:** {{model_purpose}}
159
- **Integration:** {{integration_with_existing}}
160
-
161
- **Key Attributes:**
162
-
163
- - {{attribute_1}}: {{type_1}} - {{description_1}}
164
- - {{attribute_2}}: {{type_2}} - {{description_2}}
165
-
166
- **Relationships:**
167
-
168
- - **With Existing:** {{existing_relationships}}
169
- - **With New:** {{new_relationships}}
170
-
171
- <</REPEAT>>
172
-
173
- ### Schema Integration Strategy
174
-
175
- **Database Changes Required:**
176
-
177
- - **New Tables:** {{new_tables_list}}
178
- - **Modified Tables:** {{modified_tables_list}}
179
- - **New Indexes:** {{new_indexes_list}}
180
- - **Migration Strategy:** {{migration_approach}}
181
-
182
- **Backward Compatibility:**
183
-
184
- - {{compatibility_measure_1}}
185
- - {{compatibility_measure_2}}
186
-
187
- ## Component Architecture
188
-
189
- [[LLM: Define new components and their integration with existing architecture:
190
-
191
- 1. Identify new components required for the enhancement
192
- 2. Define interfaces with existing components
193
- 3. Establish clear boundaries and responsibilities
194
- 4. Plan integration points and data flow
195
-
196
- MANDATORY VALIDATION: Before presenting component architecture, confirm: "The new components I'm proposing follow the existing architectural patterns I identified in your codebase: [specific patterns]. The integration interfaces respect your current component structure and communication patterns. Does this match your project's reality?"
197
-
198
- Present component architecture and apply `tasks#advanced-elicitation` protocol]]
199
-
200
- ### New Components
201
-
202
- <<REPEAT: new_component>>
203
-
204
- ### {{component_name}}
205
-
206
- **Responsibility:** {{component_description}}
207
- **Integration Points:** {{integration_points}}
208
-
209
- **Key Interfaces:**
210
-
211
- - {{interface_1}}
212
- - {{interface_2}}
213
-
214
- **Dependencies:**
215
-
216
- - **Existing Components:** {{existing_dependencies}}
217
- - **New Components:** {{new_dependencies}}
218
-
219
- **Technology Stack:** {{component_tech_details}}
220
-
221
- <</REPEAT>>
222
-
223
- ### Component Interaction Diagram
224
-
225
- [[LLM: Create Mermaid diagram showing how new components interact with existing ones]]
226
-
227
- ```mermaid
228
- {{component_interaction_diagram}}
229
- ```
230
-
231
- ## API Design and Integration
232
-
233
- [[LLM: Define new API endpoints and integration with existing APIs:
234
-
235
- 1. Plan new API endpoints required for the enhancement
236
- 2. Ensure consistency with existing API patterns
237
- 3. Define authentication and authorization integration
238
- 4. Plan versioning strategy if needed
239
-
240
- Present API design and apply `tasks#advanced-elicitation` protocol]]
241
-
242
- ### New API Endpoints
243
-
244
- ^^CONDITION: has_new_api^^
245
-
246
- **API Integration Strategy:** {{api_integration_strategy}}
247
- **Authentication:** {{auth_integration}}
248
- **Versioning:** {{versioning_approach}}
249
-
250
- <<REPEAT: new_endpoint>>
251
-
252
- #### {{endpoint_name}}
253
-
254
- - **Method:** {{http_method}}
255
- - **Endpoint:** {{endpoint_path}}
256
- - **Purpose:** {{endpoint_purpose}}
257
- - **Integration:** {{integration_with_existing}}
258
-
259
- **Request:**
260
-
261
- ```json
262
- {{request_schema}}
263
- ```
264
-
265
- **Response:**
266
-
267
- ```json
268
- {{response_schema}}
269
- ```
270
-
271
- <</REPEAT>>
272
-
273
- ^^/CONDITION: has_new_api^^
274
-
275
- ## External API Integration
276
-
277
- [[LLM: Document new external API integrations required for the enhancement]]
278
-
279
- ^^CONDITION: has_new_external_apis^^
280
-
281
- <<REPEAT: external_api>>
282
-
283
- ### {{api_name}} API
284
-
285
- - **Purpose:** {{api_purpose}}
286
- - **Documentation:** {{api_docs_url}}
287
- - **Base URL:** {{api_base_url}}
288
- - **Authentication:** {{auth_method}}
289
- - **Integration Method:** {{integration_approach}}
290
-
291
- **Key Endpoints Used:**
292
-
293
- - `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
294
-
295
- **Error Handling:** {{error_handling_strategy}}
296
-
297
- <</REPEAT>>
298
-
299
- ^^/CONDITION: has_new_external_apis^^
300
-
301
- ## Source Tree Integration
302
-
303
- [[LLM: Define how new code will integrate with existing project structure:
304
-
305
- 1. Follow existing project organization patterns
306
- 2. Identify where new files/folders will be placed
307
- 3. Ensure consistency with existing naming conventions
308
- 4. Plan for minimal disruption to existing structure
309
-
310
- Present integration plan and apply `tasks#advanced-elicitation` protocol]]
311
-
312
- ### Existing Project Structure
313
-
314
- [[LLM: Document relevant parts of current structure]]
315
-
316
- ```plaintext
317
- {{existing_structure_relevant_parts}}
318
- ```
319
-
320
- ### New File Organization
321
-
322
- [[LLM: Show only new additions to existing structure]]
323
-
324
- ```plaintext
325
- {{project-root}}/
326
- ├── {{existing_structure_context}}
327
- │ ├── {{new_folder_1}}/ # {{purpose_1}}
328
- │ │ ├── {{new_file_1}}
329
- │ │ └── {{new_file_2}}
330
- │ ├── {{existing_folder}}/ # Existing folder with additions
331
- │ │ ├── {{existing_file}} # Existing file
332
- │ │ └── {{new_file_3}} # New addition
333
- │ └── {{new_folder_2}}/ # {{purpose_2}}
334
- ```
335
-
336
- ### Integration Guidelines
337
-
338
- - **File Naming:** {{file_naming_consistency}}
339
- - **Folder Organization:** {{folder_organization_approach}}
340
- - **Import/Export Patterns:** {{import_export_consistency}}
341
-
342
- ## Infrastructure and Deployment Integration
343
-
344
- [[LLM: Define how the enhancement will be deployed alongside existing infrastructure:
345
-
346
- 1. Use existing deployment pipeline and infrastructure
347
- 2. Identify any infrastructure changes needed
348
- 3. Plan deployment strategy to minimize risk
349
- 4. Define rollback procedures
350
-
351
- Present deployment integration and apply `tasks#advanced-elicitation` protocol]]
352
-
353
- ### Existing Infrastructure
354
-
355
- **Current Deployment:** {{existing_deployment_summary}}
356
- **Infrastructure Tools:** {{existing_infrastructure_tools}}
357
- **Environments:** {{existing_environments}}
358
-
359
- ### Enhancement Deployment Strategy
360
-
361
- **Deployment Approach:** {{deployment_approach}}
362
- **Infrastructure Changes:** {{infrastructure_changes}}
363
- **Pipeline Integration:** {{pipeline_integration}}
364
-
365
- ### Rollback Strategy
366
-
367
- **Rollback Method:** {{rollback_method}}
368
- **Risk Mitigation:** {{risk_mitigation}}
369
- **Monitoring:** {{monitoring_approach}}
370
-
371
- ## Coding Standards and Conventions
372
-
373
- [[LLM: Ensure new code follows existing project conventions:
374
-
375
- 1. Document existing coding standards from project analysis
376
- 2. Identify any enhancement-specific requirements
377
- 3. Ensure consistency with existing codebase patterns
378
- 4. Define standards for new code organization
379
-
380
- Present coding standards and apply `tasks#advanced-elicitation` protocol]]
381
-
382
- ### Existing Standards Compliance
383
-
384
- **Code Style:** {{existing_code_style}}
385
- **Linting Rules:** {{existing_linting}}
386
- **Testing Patterns:** {{existing_test_patterns}}
387
- **Documentation Style:** {{existing_doc_style}}
388
-
389
- ### Enhancement-Specific Standards
390
-
391
- [[LLM: Only include if new patterns are needed for the enhancement]]
392
-
393
- <<REPEAT: enhancement_standard>>
394
-
395
- - **{{standard_name}}:** {{standard_description}}
396
-
397
- <</REPEAT>>
398
-
399
- ### Critical Integration Rules
400
-
401
- - **Existing API Compatibility:** {{api_compatibility_rule}}
402
- - **Database Integration:** {{db_integration_rule}}
403
- - **Error Handling:** {{error_handling_integration}}
404
- - **Logging Consistency:** {{logging_consistency}}
405
-
406
- ## Testing Strategy
407
-
408
- [[LLM: Define testing approach for the enhancement:
409
-
410
- 1. Integrate with existing test suite
411
- 2. Ensure existing functionality remains intact
412
- 3. Plan for testing new features
413
- 4. Define integration testing approach
414
-
415
- Present testing strategy and apply `tasks#advanced-elicitation` protocol]]
416
-
417
- ### Integration with Existing Tests
418
-
419
- **Existing Test Framework:** {{existing_test_framework}}
420
- **Test Organization:** {{existing_test_organization}}
421
- **Coverage Requirements:** {{existing_coverage_requirements}}
422
-
423
- ### New Testing Requirements
424
-
425
- #### Unit Tests for New Components
426
-
427
- - **Framework:** {{test_framework}}
428
- - **Location:** {{test_location}}
429
- - **Coverage Target:** {{coverage_target}}
430
- - **Integration with Existing:** {{test_integration}}
431
-
432
- #### Integration Tests
433
-
434
- - **Scope:** {{integration_test_scope}}
435
- - **Existing System Verification:** {{existing_system_verification}}
436
- - **New Feature Testing:** {{new_feature_testing}}
437
-
438
- #### Regression Testing
439
-
440
- - **Existing Feature Verification:** {{regression_test_approach}}
441
- - **Automated Regression Suite:** {{automated_regression}}
442
- - **Manual Testing Requirements:** {{manual_testing_requirements}}
443
-
444
- ## Security Integration
445
-
446
- [[LLM: Ensure security consistency with existing system:
447
-
448
- 1. Follow existing security patterns and tools
449
- 2. Ensure new features don't introduce vulnerabilities
450
- 3. Maintain existing security posture
451
- 4. Define security testing for new components
452
-
453
- Present security integration and apply `tasks#advanced-elicitation` protocol]]
454
-
455
- ### Existing Security Measures
456
-
457
- **Authentication:** {{existing_auth}}
458
- **Authorization:** {{existing_authz}}
459
- **Data Protection:** {{existing_data_protection}}
460
- **Security Tools:** {{existing_security_tools}}
461
-
462
- ### Enhancement Security Requirements
463
-
464
- **New Security Measures:** {{new_security_measures}}
465
- **Integration Points:** {{security_integration_points}}
466
- **Compliance Requirements:** {{compliance_requirements}}
467
-
468
- ### Security Testing
469
-
470
- **Existing Security Tests:** {{existing_security_tests}}
471
- **New Security Test Requirements:** {{new_security_tests}}
472
- **Penetration Testing:** {{pentest_requirements}}
473
-
474
- ## Risk Assessment and Mitigation
475
-
476
- [[LLM: Identify and plan for risks specific to brownfield development:
477
-
478
- 1. Technical integration risks
479
- 2. Deployment and operational risks
480
- 3. User impact and compatibility risks
481
- 4. Mitigation strategies for each risk
482
-
483
- Present risk assessment and apply `tasks#advanced-elicitation` protocol]]
484
-
485
- ### Technical Risks
486
-
487
- <<REPEAT: technical_risk>>
488
-
489
- **Risk:** {{risk_description}}
490
- **Impact:** {{impact_level}}
491
- **Likelihood:** {{likelihood}}
492
- **Mitigation:** {{mitigation_strategy}}
493
-
494
- <</REPEAT>>
495
-
496
- ### Operational Risks
497
-
498
- <<REPEAT: operational_risk>>
499
-
500
- **Risk:** {{risk_description}}
501
- **Impact:** {{impact_level}}
502
- **Likelihood:** {{likelihood}}
503
- **Mitigation:** {{mitigation_strategy}}
504
-
505
- <</REPEAT>>
506
-
507
- ### Monitoring and Alerting
508
-
509
- **Enhanced Monitoring:** {{monitoring_additions}}
510
- **New Alerts:** {{new_alerts}}
511
- **Performance Monitoring:** {{performance_monitoring}}
512
-
513
- ## Checklist Results Report
514
-
515
- [[LLM: Execute the architect-checklist and populate results here, focusing on brownfield-specific validation]]
516
-
517
- ## Next Steps
518
-
519
- [[LLM: After completing the brownfield architecture:
520
-
521
- 1. Review integration points with existing system
522
- 2. Begin story implementation with Dev agent
523
- 3. Set up deployment pipeline integration
524
- 4. Plan rollback and monitoring procedures]]
525
-
526
- ### Story Manager Handoff
527
-
528
- [[LLM: Create a brief prompt for Story Manager to work with this brownfield enhancement. Include:
529
-
530
- - Reference to this architecture document
531
- - Key integration requirements validated with user
532
- - Existing system constraints based on actual project analysis
533
- - First story to implement with clear integration checkpoints
534
- - Emphasis on maintaining existing system integrity throughout implementation]]
535
-
536
- ### Developer Handoff
537
-
538
- [[LLM: Create a brief prompt for developers starting implementation. Include:
539
-
540
- - Reference to this architecture and existing coding standards analyzed from actual project
541
- - Integration requirements with existing codebase validated with user
542
- - Key technical decisions based on real project constraints
543
- - Existing system compatibility requirements with specific verification steps
544
- - Clear sequencing of implementation to minimize risk to existing functionality]]