bmad-method 4.16.0 → 4.17.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 (66) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/package.json +1 -1
  3. package/tools/installer/lib/ide-setup.js +3 -0
  4. package/tools/installer/package.json +1 -1
  5. package/.bmad-core/agent-teams/team-all.yml +0 -14
  6. package/.bmad-core/agent-teams/team-fullstack.yml +0 -18
  7. package/.bmad-core/agent-teams/team-ide-minimal.yml +0 -10
  8. package/.bmad-core/agent-teams/team-no-ui.yml +0 -13
  9. package/.bmad-core/agents/analyst.md +0 -64
  10. package/.bmad-core/agents/architect.md +0 -64
  11. package/.bmad-core/agents/bmad-master.md +0 -101
  12. package/.bmad-core/agents/bmad-orchestrator.md +0 -126
  13. package/.bmad-core/agents/dev.md +0 -65
  14. package/.bmad-core/agents/pm.md +0 -61
  15. package/.bmad-core/agents/po.md +0 -63
  16. package/.bmad-core/agents/qa.md +0 -50
  17. package/.bmad-core/agents/sm.md +0 -51
  18. package/.bmad-core/agents/ux-expert.md +0 -63
  19. package/.bmad-core/checklists/architect-checklist.md +0 -443
  20. package/.bmad-core/checklists/change-checklist.md +0 -182
  21. package/.bmad-core/checklists/pm-checklist.md +0 -375
  22. package/.bmad-core/checklists/po-master-checklist.md +0 -441
  23. package/.bmad-core/checklists/story-dod-checklist.md +0 -101
  24. package/.bmad-core/checklists/story-draft-checklist.md +0 -156
  25. package/.bmad-core/core-config.yml +0 -20
  26. package/.bmad-core/data/bmad-kb.md +0 -814
  27. package/.bmad-core/data/technical-preferences.md +0 -3
  28. package/.bmad-core/install-manifest.yml +0 -196
  29. package/.bmad-core/tasks/advanced-elicitation.md +0 -92
  30. package/.bmad-core/tasks/brainstorming-techniques.md +0 -238
  31. package/.bmad-core/tasks/brownfield-create-epic.md +0 -160
  32. package/.bmad-core/tasks/brownfield-create-story.md +0 -147
  33. package/.bmad-core/tasks/core-dump.md +0 -74
  34. package/.bmad-core/tasks/correct-course.md +0 -73
  35. package/.bmad-core/tasks/create-deep-research-prompt.md +0 -301
  36. package/.bmad-core/tasks/create-doc.md +0 -74
  37. package/.bmad-core/tasks/create-next-story.md +0 -242
  38. package/.bmad-core/tasks/doc-migration-task.md +0 -151
  39. package/.bmad-core/tasks/document-project.md +0 -350
  40. package/.bmad-core/tasks/execute-checklist.md +0 -97
  41. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  42. package/.bmad-core/tasks/index-docs.md +0 -178
  43. package/.bmad-core/tasks/kb-mode-interaction.md +0 -77
  44. package/.bmad-core/tasks/review-story.md +0 -153
  45. package/.bmad-core/tasks/shard-doc.md +0 -191
  46. package/.bmad-core/templates/architecture-tmpl.md +0 -776
  47. package/.bmad-core/templates/brownfield-architecture-tmpl.md +0 -544
  48. package/.bmad-core/templates/brownfield-prd-tmpl.md +0 -242
  49. package/.bmad-core/templates/competitor-analysis-tmpl.md +0 -291
  50. package/.bmad-core/templates/front-end-architecture-tmpl.md +0 -175
  51. package/.bmad-core/templates/front-end-spec-tmpl.md +0 -413
  52. package/.bmad-core/templates/fullstack-architecture-tmpl.md +0 -1018
  53. package/.bmad-core/templates/market-research-tmpl.md +0 -263
  54. package/.bmad-core/templates/prd-tmpl.md +0 -202
  55. package/.bmad-core/templates/project-brief-tmpl.md +0 -230
  56. package/.bmad-core/templates/story-tmpl.md +0 -69
  57. package/.bmad-core/utils/file-resolution-context.md +0 -10
  58. package/.bmad-core/utils/template-format.md +0 -26
  59. package/.bmad-core/utils/web-agent-startup-instructions.md +0 -39
  60. package/.bmad-core/utils/workflow-management.md +0 -223
  61. package/.bmad-core/workflows/brownfield-fullstack.yml +0 -112
  62. package/.bmad-core/workflows/brownfield-service.yml +0 -113
  63. package/.bmad-core/workflows/brownfield-ui.yml +0 -123
  64. package/.bmad-core/workflows/greenfield-fullstack.yml +0 -166
  65. package/.bmad-core/workflows/greenfield-service.yml +0 -132
  66. package/.bmad-core/workflows/greenfield-ui.yml +0 -161
@@ -1,69 +0,0 @@
1
- # Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
2
-
3
- ## Status: {{ Draft | Approved | InProgress | Review | Done }}
4
-
5
- ## Story
6
-
7
- - As a {{role}}
8
- - I want {{action}}
9
- - so that {{benefit}}
10
-
11
- ## Acceptance Criteria (ACs)
12
-
13
- {{ Copy of Acceptance Criteria numbered list }}
14
-
15
- ## Tasks / Subtasks
16
-
17
- - [ ] Task 1 (AC: # if applicable)
18
- - [ ] Subtask1.1...
19
- - [ ] Task 2 (AC: # if applicable)
20
- - [ ] Subtask 2.1...
21
- - [ ] Task 3 (AC: # if applicable)
22
- - [ ] Subtask 3.1...
23
-
24
- ## Dev Notes
25
-
26
- [[LLM: populates relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story. Do not invent information. Critical: If known add Relevant Source Tree info that relates to this story. If there were important notes from previous story that are relevant to this one, also include them here if it will help the dev agent. You do NOT need to repeat anything from coding standards or test standards as the dev agent is already aware of those. The dev agent should NEVER need to read the PRD or architecture documents or child documents though to complete this self contained story, because your critical mission is to share the specific items needed here extremely concisely for the Dev Agent LLM to comprehend with the least about of context overhead token usage needed.]]
27
-
28
- ### Testing
29
-
30
- [[LLM: Scrum Master use `test-strategy-and-standards.md` to leave instruction for developer agent in the following concise format, leave unchecked if no specific test requirement of that type]]
31
- Dev Note: Story Requires the following tests:
32
-
33
- - [ ] {{type f.e. Jest}} Unit Tests: (nextToFile: {{true|false}}), coverage requirement: {{from strategy or default 80%}}
34
- - [ ] {{type f.e. Jest with in memory db}} Integration Test (Test Location): location: {{Integration test location f.e. `/tests/story-name/foo.spec.cs` or `next to handler`}}
35
- - [ ] {{type f.e. Cypress}} E2E: location: {{f.e. `/e2e/{epic-name/bar.test.ts`}}
36
-
37
- Manual Test Steps: [[LLM: Include how if possible the user can manually test the functionality when story is Ready for Review, if any]]
38
-
39
- {{ f.e. `- dev will create a script with task 3 above that you can run with "npm run test-initiate-launch-sequence" and validate Armageddon is initiated`}}
40
-
41
- ## Dev Agent Record
42
-
43
- ### Agent Model Used: {{Agent Model Name/Version}}
44
-
45
- ### Debug Log References
46
-
47
- [[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
48
- [[LLM: (Dev Agent) If the debug is logged to during the current story progress, create a table with the debug log and the specific task section in the debug log - do not repeat all the details in the story]]
49
-
50
- ### Completion Notes List
51
-
52
- [[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
53
- [[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
54
-
55
- ### File List
56
-
57
- [[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
58
-
59
- ### Change Log
60
-
61
- [[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
62
- [[LLM: (Dev Agent) Track document versions and changes during development that deviate from story dev start]]
63
-
64
- | Date | Version | Description | Author |
65
- | :--- | :------ | :---------- | :----- |
66
-
67
- ## QA Results
68
-
69
- [[LLM: QA Agent Results]]
@@ -1,10 +0,0 @@
1
- # File Resolution Context
2
-
3
- Update the installer/upgrader so that when agents are added to a project (under Add these two lines to any agent's `activation-instructions` for ide installation:
4
-
5
- ```yaml
6
- - IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
7
- - REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
8
- ```
9
-
10
- and add `root: .bmad-core` as the first root yml property.
@@ -1,26 +0,0 @@
1
- # Template Format Conventions
2
-
3
- Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
4
-
5
- ## Template Markup Elements
6
-
7
- - **{{placeholders}}**: Variables to be replaced with actual content
8
- - **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
9
- - **REPEAT** sections: Content blocks that may be repeated as needed
10
- - **^^CONDITION^^** blocks: Conditional content included only if criteria are met
11
- - **@{examples}**: Example content for guidance (never output to users)
12
-
13
- ## Processing Rules
14
-
15
- - Replace all {{placeholders}} with project-specific content
16
- - Execute all [[LLM: instructions]] internally without showing users
17
- - Process conditional and repeat blocks as specified
18
- - Use examples for guidance but never include them in final output
19
- - Present only clean, formatted content to users
20
-
21
- ## Critical Guidelines
22
-
23
- - **NEVER display template markup, LLM instructions, or examples to users**
24
- - Template elements are for AI processing only
25
- - Focus on faithful template execution and clean output
26
- - All template-specific instructions are embedded within templates
@@ -1,39 +0,0 @@
1
- # Web Agent Bundle Instructions
2
-
3
- You are now operating as a specialized AI agent from the BMAD-METHOD framework. This is a bundled web-compatible version containing all necessary resources for your role.
4
-
5
- ## Important Instructions
6
-
7
- 1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
8
-
9
- 2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
10
-
11
- - `==================== START: folder#filename ====================`
12
- - `==================== END: folder#filename ====================`
13
-
14
- When you need to reference a resource mentioned in your instructions:
15
-
16
- - Look for the corresponding START/END tags
17
- - The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
18
- - If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
19
-
20
- **Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
21
-
22
- ```yaml
23
- dependencies:
24
- utils:
25
- - template-format
26
- tasks:
27
- - create-story
28
- ```
29
-
30
- These references map directly to bundle sections:
31
-
32
- - `utils: template-format` → Look for `==================== START: utils#template-format ====================`
33
- - `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
34
-
35
- 3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
36
-
37
- 4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMAD-METHOD framework.
38
-
39
- ---
@@ -1,223 +0,0 @@
1
- # Workflow Management
2
-
3
- This utility enables the BMAD orchestrator to manage and execute team workflows.
4
-
5
- ## Important: Dynamic Workflow Loading
6
-
7
- The BMAD orchestrator MUST read the available workflows from the current team configuration's `workflows` field. Do not use hardcoded workflow lists. Each team bundle defines its own set of supported workflows based on the agents it includes.
8
-
9
- **Critical Distinction**:
10
-
11
- - When asked "what workflows are available?", show ONLY the workflows defined in the current team bundle's configuration
12
- - Use `/agent-list` to show agents in the current bundle
13
- - Use `/workflows` to show workflows in the current bundle, NOT any creation tasks
14
-
15
- ### Workflow Descriptions
16
-
17
- When displaying workflows, use these descriptions based on the workflow ID:
18
-
19
- - **greenfield-fullstack**: Build a new full-stack application from concept to development
20
- - **brownfield-fullstack**: Enhance an existing full-stack application with new features
21
- - **greenfield-service**: Build a new backend service or API from concept to development
22
- - **brownfield-service**: Enhance an existing backend service or API
23
- - **greenfield-ui**: Build a new frontend/UI application from concept to development
24
- - **brownfield-ui**: Enhance an existing frontend/UI application
25
-
26
- ## Workflow Commands
27
-
28
- ### /workflows
29
-
30
- Lists all available workflows for the current team. The available workflows are determined by the team configuration and may include workflows such as:
31
-
32
- - greenfield-fullstack
33
- - brownfield-fullstack
34
- - greenfield-service
35
- - brownfield-service
36
- - greenfield-ui
37
- - brownfield-ui
38
-
39
- The actual list depends on which team bundle is loaded. When responding to this command, display the workflows that are configured in the current team's `workflows` field.
40
-
41
- Example response format:
42
-
43
- ```text
44
- Available workflows for [Team Name]:
45
- 1. [workflow-id] - [Brief description based on workflow type]
46
- 2. [workflow-id] - [Brief description based on workflow type]
47
- [... etc. ...]
48
-
49
- Use /workflow-start {number or id} to begin a workflow.
50
- ```
51
-
52
- ### /workflow-start {workflow-id}
53
-
54
- Starts a specific workflow and transitions to the first agent.
55
-
56
- Example: `/workflow-start greenfield-fullstack`
57
-
58
- ### /workflow-status
59
-
60
- Shows current workflow progress, completed artifacts, and next steps.
61
-
62
- Example response:
63
-
64
- ```text
65
- Current Workflow: Greenfield Full-Stack Development
66
- Stage: Product Planning (2 of 6)
67
- Completed:
68
- ✓ Discovery & Requirements
69
- - project-brief (completed by Mary)
70
-
71
- In Progress:
72
- ⚡ Product Planning
73
- - Create PRD (John) - awaiting input
74
-
75
- Next: Technical Architecture
76
- ```
77
-
78
- ### /workflow-resume
79
-
80
- Resumes a workflow from where it left off, useful when starting a new chat.
81
-
82
- User can provide completed artifacts:
83
-
84
- ```text
85
- User: /workflow-resume greenfield-fullstack
86
- I have completed: project-brief, PRD
87
- BMad: I see you've completed Discovery and part of Product Planning.
88
- Based on the greenfield-fullstack workflow, the next step is:
89
- - UX Strategy with Sally (ux-expert)
90
-
91
- Would you like me to load Sally to continue?
92
- ```
93
-
94
- ### /workflow-next
95
-
96
- Shows the next recommended agent and action in the current workflow.
97
-
98
- ## Workflow Execution Flow
99
-
100
- ### 1. Starting a Workflow
101
-
102
- When a workflow is started:
103
-
104
- 1. Load the workflow definition
105
- 2. Identify the first stage and step
106
- 3. Transition to the required agent
107
- 4. Provide context about expected inputs/outputs
108
- 5. Guide artifact creation
109
-
110
- ### 2. Stage Transitions
111
-
112
- After each artifact is completed:
113
-
114
- 1. Mark the step as complete
115
- 2. Check transition conditions
116
- 3. If stage is complete, move to next stage
117
- 4. Load the appropriate agent
118
- 5. Pass relevant artifacts as context
119
-
120
- ### 3. Artifact Tracking
121
-
122
- Track all created artifacts:
123
-
124
- ```yaml
125
- workflow_state:
126
- current_workflow: greenfield-fullstack
127
- current_stage: planning
128
- current_step: 2
129
- artifacts:
130
- project-brief:
131
- status: completed
132
- created_by: analyst
133
- timestamp: 2024-01-15T10:30:00.000Z
134
- prd:
135
- status: in-progress
136
- created_by: pm
137
- started: 2024-01-15T11:00:00.000Z
138
- ```
139
-
140
- ### 4. Workflow Interruption Handling
141
-
142
- When user returns after interruption:
143
-
144
- 1. Ask if continuing previous workflow
145
- 2. Request any completed artifacts
146
- 3. Analyze provided artifacts
147
- 4. Determine workflow position
148
- 5. Suggest next appropriate step
149
-
150
- Example:
151
-
152
- ```text
153
- User: I'm working on a new app. Here's my PRD and architecture doc.
154
- BMad: I see you have a PRD and architecture document. Based on these artifacts,
155
- it looks like you're following the greenfield-fullstack workflow and have completed
156
- stages 1-3. The next recommended step would be:
157
-
158
- Stage 4: Validation & Refinement
159
- - Load Sarah (Product Owner) to validate all artifacts
160
-
161
- Would you like to continue with this workflow?
162
- ```
163
-
164
- ## Workflow Context Passing
165
-
166
- When transitioning between agents, pass:
167
-
168
- 1. Previous artifacts created
169
- 2. Current workflow stage
170
- 3. Expected outputs
171
- 4. Any decisions or constraints identified
172
-
173
- Example transition:
174
-
175
- ```text
176
- BMad: Great! John has completed the PRD. According to the greenfield-fullstack workflow,
177
- the next step is UX Strategy with Sally.
178
-
179
- /ux-expert
180
-
181
- Sally: I see we're in the Product Planning stage of the greenfield-fullstack workflow.
182
- I have access to:
183
- - Project Brief from Mary
184
- - PRD from John
185
-
186
- Let's create the UX strategy and UI specifications. First, let me review
187
- the PRD to understand the features we're designing for...
188
- ```
189
-
190
- ## Multi-Path Workflows
191
-
192
- Some workflows may have multiple paths:
193
-
194
- ```yaml
195
- conditional_paths:
196
- - condition: project_type == 'mobile'
197
- next_stage: mobile-specific-design
198
- - condition: project_type == 'web'
199
- next_stage: web-architecture
200
- - default: fullstack-architecture
201
- ```
202
-
203
- Handle these by asking clarifying questions when needed.
204
-
205
- ## Workflow Best Practices
206
-
207
- 1. **Always show progress** - Users should know where they are
208
- 2. **Explain transitions** - Why moving to next agent
209
- 3. **Preserve context** - Pass relevant information forward
210
- 4. **Allow flexibility** - Users can skip or modify steps
211
- 5. **Track everything** - Maintain complete workflow state
212
-
213
- ## Integration with Agents
214
-
215
- Each agent should be workflow-aware:
216
-
217
- - Know which workflow is active
218
- - Understand their role in the workflow
219
- - Access previous artifacts
220
- - Know expected outputs
221
- - Guide toward workflow goals
222
-
223
- This creates a seamless experience where the entire team works together toward the workflow's objectives.
@@ -1,112 +0,0 @@
1
- workflow:
2
- id: brownfield-fullstack
3
- name: Brownfield Full-Stack Enhancement
4
- description: >-
5
- Agent workflow for enhancing existing full-stack applications with new features,
6
- modernization, or significant changes. Handles existing system analysis and safe integration.
7
- type: brownfield
8
- project_types:
9
- - feature-addition
10
- - refactoring
11
- - modernization
12
- - integration-enhancement
13
-
14
- sequence:
15
- - step: project_analysis
16
- agent: architect
17
- action: analyze existing project and use task document-project
18
- creates: multiple documents per the document-project template
19
- notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
20
-
21
- - agent: pm
22
- creates: brownfield-prd.md
23
- uses: brownfield-prd-tmpl
24
- requires: existing_project_analysis
25
- notes: "Creates comprehensive brownfield PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
26
-
27
- - agent: architect
28
- creates: brownfield-architecture.md
29
- uses: brownfield-architecture-tmpl
30
- requires: brownfield-prd.md
31
- notes: "Creates brownfield architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
32
-
33
- - agent: po
34
- validates: all_artifacts
35
- uses: po-master-checklist
36
- notes: "Validates all brownfield documents for integration safety and completeness. May require updates to any document."
37
-
38
- - agent: various
39
- updates: any_flagged_documents
40
- condition: po_checklist_issues
41
- notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
42
-
43
- - workflow_end:
44
- action: move_to_ide
45
- notes: |
46
- Planning phase complete! Now transition to IDE Development:
47
-
48
- 1. ENSURE DOCUMENTS ARE IN PROJECT:
49
- - Copy final prd.md to project's docs/prd.md
50
- - Copy final architecture.md to project's docs/architecture.md
51
- - All documents must be in the project before proceeding
52
-
53
- 2. SHARD DOCUMENTS (in IDE):
54
- - Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
55
- - Option B: Manual: Drag shard-doc task + docs/prd.md into chat
56
- - This creates docs/prd/ and docs/architecture/ folders with sharded content
57
-
58
- 3. START DEVELOPMENT CYCLE:
59
- a. SM Agent (New Chat): @sm → *create
60
- - Creates next story from sharded docs
61
- - Review and approve story (Draft → Approved)
62
-
63
- b. Dev Agent (New Chat): @dev
64
- - Implements approved story
65
- - Updates File List with all changes
66
- - Marks story as "Review" when complete
67
-
68
- c. QA Agent (New Chat): @qa → review-story
69
- - Senior dev review with refactoring ability
70
- - Fixes small issues directly
71
- - Leaves checklist for remaining items
72
- - Updates story status (Review → Done or stays Review)
73
-
74
- d. If QA left unchecked items:
75
- - Dev Agent (New Chat): Address remaining items
76
- - Return to QA for final approval
77
-
78
- 4. REPEAT: Continue cycle for all epic stories
79
-
80
- Reference: data#bmad-kb:IDE Development Workflow
81
-
82
- flow_diagram: |
83
- ```mermaid
84
- graph TD
85
- A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
86
- B --> C[pm: brownfield-prd.md]
87
- C --> D[architect: brownfield-architecture.md]
88
- D --> E[po: validate with po-master-checklist]
89
- E --> F{PO finds issues?}
90
- F -->|Yes| G[Return to relevant agent for fixes]
91
- F -->|No| H[Move to IDE Environment]
92
- G --> E
93
-
94
- style H fill:#90EE90
95
- style C fill:#FFE4B5
96
- style D fill:#FFE4B5
97
- ```
98
-
99
- decision_guidance:
100
- when_to_use:
101
- - Enhancement requires coordinated stories
102
- - Architectural changes are needed
103
- - Significant integration work required
104
- - Risk assessment and mitigation planning necessary
105
- - Multiple team members will work on related changes
106
-
107
- handoff_prompts:
108
- analyst_to_pm: "Existing project analysis complete. Create comprehensive brownfield PRD with integration strategy."
109
- pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the integration architecture."
110
- architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for integration safety."
111
- po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
112
- complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
@@ -1,113 +0,0 @@
1
- workflow:
2
- id: brownfield-service
3
- name: Brownfield Service/API Enhancement
4
- description: >-
5
- Agent workflow for enhancing existing backend services and APIs with new features,
6
- modernization, or performance improvements. Handles existing system analysis and safe integration.
7
- type: brownfield
8
- project_types:
9
- - service-modernization
10
- - api-enhancement
11
- - microservice-extraction
12
- - performance-optimization
13
- - integration-enhancement
14
-
15
- sequence:
16
- - step: service_analysis
17
- agent: architect
18
- action: analyze existing project and use task document-project
19
- creates: multiple documents per the document-project template
20
- notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
21
-
22
- - agent: pm
23
- creates: brownfield-prd.md
24
- uses: brownfield-prd-tmpl
25
- requires: existing_service_analysis
26
- notes: "Creates comprehensive brownfield PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
27
-
28
- - agent: architect
29
- creates: brownfield-architecture.md
30
- uses: brownfield-architecture-tmpl
31
- requires: brownfield-prd.md
32
- notes: "Creates brownfield architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
33
-
34
- - agent: po
35
- validates: all_artifacts
36
- uses: po-master-checklist
37
- notes: "Validates all brownfield documents for service integration safety and API compatibility. May require updates to any document."
38
-
39
- - agent: various
40
- updates: any_flagged_documents
41
- condition: po_checklist_issues
42
- notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
43
-
44
- - workflow_end:
45
- action: move_to_ide
46
- notes: |
47
- Planning phase complete! Now transition to IDE Development:
48
-
49
- 1. ENSURE DOCUMENTS ARE IN PROJECT:
50
- - Copy final prd.md to project's docs/prd.md
51
- - Copy final architecture.md to project's docs/architecture.md
52
- - All documents must be in the project before proceeding
53
-
54
- 2. SHARD DOCUMENTS (in IDE):
55
- - Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
56
- - Option B: Manual: Drag shard-doc task + docs/prd.md into chat
57
- - This creates docs/prd/ and docs/architecture/ folders with sharded content
58
-
59
- 3. START DEVELOPMENT CYCLE:
60
- a. SM Agent (New Chat): @sm → *create
61
- - Creates next story from sharded docs
62
- - Review and approve story (Draft → Approved)
63
-
64
- b. Dev Agent (New Chat): @dev
65
- - Implements approved story
66
- - Updates File List with all changes
67
- - Marks story as "Review" when complete
68
-
69
- c. QA Agent (New Chat): @qa → review-story
70
- - Senior dev review with refactoring ability
71
- - Fixes small issues directly
72
- - Leaves checklist for remaining items
73
- - Updates story status (Review → Done or stays Review)
74
-
75
- d. If QA left unchecked items:
76
- - Dev Agent (New Chat): Address remaining items
77
- - Return to QA for final approval
78
-
79
- 4. REPEAT: Continue cycle for all epic stories
80
-
81
- Reference: data#bmad-kb:IDE Development Workflow
82
-
83
- flow_diagram: |
84
- ```mermaid
85
- graph TD
86
- A[Start: Service Enhancement] --> B[analyst: analyze existing service]
87
- B --> C[pm: brownfield-prd.md]
88
- C --> D[architect: brownfield-architecture.md]
89
- D --> E[po: validate with po-master-checklist]
90
- E --> F{PO finds issues?}
91
- F -->|Yes| G[Return to relevant agent for fixes]
92
- F -->|No| H[Move to IDE Environment]
93
- G --> E
94
-
95
- style H fill:#90EE90
96
- style C fill:#FFE4B5
97
- style D fill:#FFE4B5
98
- ```
99
-
100
- decision_guidance:
101
- when_to_use:
102
- - Service enhancement requires coordinated stories
103
- - API versioning or breaking changes needed
104
- - Database schema changes required
105
- - Performance or scalability improvements needed
106
- - Multiple integration points affected
107
-
108
- handoff_prompts:
109
- analyst_to_pm: "Service analysis complete. Create comprehensive brownfield PRD with service integration strategy."
110
- pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the service architecture."
111
- architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for service integration safety."
112
- po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
113
- complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."