@posx/core 5.5.165 → 5.5.166
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.bmad-core/agent-teams/team-all.yaml +14 -0
- package/.bmad-core/agent-teams/team-fullstack.yaml +18 -0
- package/.bmad-core/agent-teams/team-ide-minimal.yaml +10 -0
- package/.bmad-core/agent-teams/team-no-ui.yaml +13 -0
- package/.bmad-core/agents/analyst.md +81 -0
- package/.bmad-core/agents/architect.md +83 -0
- package/.bmad-core/agents/bmad-master.md +107 -0
- package/.bmad-core/agents/bmad-orchestrator.md +149 -0
- package/.bmad-core/agents/dev.md +75 -0
- package/.bmad-core/agents/pm.md +81 -0
- package/.bmad-core/agents/po.md +76 -0
- package/.bmad-core/agents/qa.md +69 -0
- package/.bmad-core/agents/sm.md +62 -0
- package/.bmad-core/agents/ux-expert.md +66 -0
- package/.bmad-core/bmad-core/user-guide.md +0 -0
- package/.bmad-core/checklists/architect-checklist.md +443 -0
- package/.bmad-core/checklists/change-checklist.md +182 -0
- package/.bmad-core/checklists/pm-checklist.md +375 -0
- package/.bmad-core/checklists/po-master-checklist.md +441 -0
- package/.bmad-core/checklists/story-dod-checklist.md +101 -0
- package/.bmad-core/checklists/story-draft-checklist.md +156 -0
- package/.bmad-core/core-config.yaml +20 -0
- package/.bmad-core/data/bmad-kb.md +813 -0
- package/.bmad-core/data/brainstorming-techniques.md +36 -0
- package/.bmad-core/data/elicitation-methods.md +154 -0
- package/.bmad-core/data/technical-preferences.md +3 -0
- package/.bmad-core/enhanced-ide-development-workflow.md +43 -0
- package/.bmad-core/install-manifest.yaml +207 -0
- package/.bmad-core/tasks/advanced-elicitation.md +119 -0
- package/.bmad-core/tasks/brownfield-create-epic.md +160 -0
- package/.bmad-core/tasks/brownfield-create-story.md +147 -0
- package/.bmad-core/tasks/correct-course.md +70 -0
- package/.bmad-core/tasks/create-brownfield-story.md +321 -0
- package/.bmad-core/tasks/create-deep-research-prompt.md +289 -0
- package/.bmad-core/tasks/create-doc.md +101 -0
- package/.bmad-core/tasks/create-next-story.md +112 -0
- package/.bmad-core/tasks/document-project.md +347 -0
- package/.bmad-core/tasks/execute-checklist.md +93 -0
- package/.bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
- package/.bmad-core/tasks/index-docs.md +178 -0
- package/.bmad-core/tasks/kb-mode-interaction.md +75 -0
- package/.bmad-core/tasks/review-story.md +162 -0
- package/.bmad-core/tasks/shard-doc.md +187 -0
- package/.bmad-core/tasks/validate-next-story.md +134 -0
- package/.bmad-core/templates/architecture-tmpl.yaml +650 -0
- package/.bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/.bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
- package/.bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
- package/.bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
- package/.bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
- package/.bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
- package/.bmad-core/templates/fullstack-architecture-tmpl.yaml +805 -0
- package/.bmad-core/templates/market-research-tmpl.yaml +252 -0
- package/.bmad-core/templates/prd-tmpl.yaml +202 -0
- package/.bmad-core/templates/project-brief-tmpl.yaml +221 -0
- package/.bmad-core/templates/story-tmpl.yaml +137 -0
- package/.bmad-core/user-guide.md +251 -0
- package/.bmad-core/utils/bmad-doc-template.md +325 -0
- package/.bmad-core/utils/workflow-management.md +69 -0
- package/.bmad-core/workflows/brownfield-fullstack.yaml +297 -0
- package/.bmad-core/workflows/brownfield-service.yaml +187 -0
- package/.bmad-core/workflows/brownfield-ui.yaml +197 -0
- package/.bmad-core/workflows/greenfield-fullstack.yaml +240 -0
- package/.bmad-core/workflows/greenfield-service.yaml +206 -0
- package/.bmad-core/workflows/greenfield-ui.yaml +235 -0
- package/.bmad-core/working-in-the-brownfield.md +364 -0
- package/.claude/commands/BMad/agents/analyst.md +85 -0
- package/.claude/commands/BMad/agents/architect.md +87 -0
- package/.claude/commands/BMad/agents/bmad-master.md +111 -0
- package/.claude/commands/BMad/agents/bmad-orchestrator.md +153 -0
- package/.claude/commands/BMad/agents/dev.md +79 -0
- package/.claude/commands/BMad/agents/pm.md +85 -0
- package/.claude/commands/BMad/agents/po.md +80 -0
- package/.claude/commands/BMad/agents/qa.md +73 -0
- package/.claude/commands/BMad/agents/sm.md +66 -0
- package/.claude/commands/BMad/agents/ux-expert.md +70 -0
- package/.claude/commands/BMad/tasks/advanced-elicitation.md +123 -0
- package/.claude/commands/BMad/tasks/brownfield-create-epic.md +164 -0
- package/.claude/commands/BMad/tasks/brownfield-create-story.md +151 -0
- package/.claude/commands/BMad/tasks/correct-course.md +74 -0
- package/.claude/commands/BMad/tasks/create-brownfield-story.md +325 -0
- package/.claude/commands/BMad/tasks/create-deep-research-prompt.md +293 -0
- package/.claude/commands/BMad/tasks/create-doc.md +105 -0
- package/.claude/commands/BMad/tasks/create-next-story.md +116 -0
- package/.claude/commands/BMad/tasks/document-project.md +351 -0
- package/.claude/commands/BMad/tasks/execute-checklist.md +97 -0
- package/.claude/commands/BMad/tasks/facilitate-brainstorming-session.md +140 -0
- package/.claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +55 -0
- package/.claude/commands/BMad/tasks/index-docs.md +182 -0
- package/.claude/commands/BMad/tasks/kb-mode-interaction.md +79 -0
- package/.claude/commands/BMad/tasks/review-story.md +166 -0
- package/.claude/commands/BMad/tasks/shard-doc.md +191 -0
- package/.claude/commands/BMad/tasks/validate-next-story.md +138 -0
- package/.cursor/rules/analyst.mdc +95 -0
- package/.cursor/rules/architect.mdc +97 -0
- package/.cursor/rules/bmad-master.mdc +121 -0
- package/.cursor/rules/bmad-orchestrator.mdc +163 -0
- package/.cursor/rules/dev.mdc +89 -0
- package/.cursor/rules/pm.mdc +95 -0
- package/.cursor/rules/po.mdc +90 -0
- package/.cursor/rules/qa.mdc +83 -0
- package/.cursor/rules/sm.mdc +76 -0
- package/.cursor/rules/ux-expert.mdc +80 -0
- package/build/index.js +1 -1
- package/package.json +1 -1
- package/package.publish.json +1 -1
- package/web-bundles/agents/analyst.txt +2882 -0
- package/web-bundles/agents/architect.txt +3543 -0
- package/web-bundles/agents/bmad-master.txt +8756 -0
- package/web-bundles/agents/bmad-orchestrator.txt +1490 -0
- package/web-bundles/agents/dev.txt +428 -0
- package/web-bundles/agents/pm.txt +2229 -0
- package/web-bundles/agents/po.txt +1364 -0
- package/web-bundles/agents/qa.txt +386 -0
- package/web-bundles/agents/sm.txt +668 -0
- package/web-bundles/agents/ux-expert.txt +701 -0
- package/web-bundles/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2408 -0
- package/web-bundles/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +1631 -0
- package/web-bundles/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +822 -0
- package/web-bundles/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +10989 -0
- package/web-bundles/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4047 -0
- package/web-bundles/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +3744 -0
- package/web-bundles/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +465 -0
- package/web-bundles/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +990 -0
- package/web-bundles/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +15467 -0
- package/web-bundles/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2077 -0
- package/web-bundles/teams/team-all.txt +11062 -0
- package/web-bundles/teams/team-fullstack.txt +10392 -0
- package/web-bundles/teams/team-ide-minimal.txt +3507 -0
- package/web-bundles/teams/team-no-ui.txt +8951 -0
|
@@ -0,0 +1,364 @@
|
|
|
1
|
+
# Working in the Brownfield: A Complete Guide
|
|
2
|
+
|
|
3
|
+
> **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation Generation!**
|
|
4
|
+
>
|
|
5
|
+
> Gemini Web's 1M+ token context window or Gemini CLI (when it's working) can analyze your ENTIRE codebase, or critical sections of it, all at once (obviously within reason):
|
|
6
|
+
>
|
|
7
|
+
> - Upload via GitHub URL or use gemini cli in the project folder
|
|
8
|
+
> - If working in the web: use the flattener-tool to flatten your project into a single file, then upload that file to your web agent.
|
|
9
|
+
|
|
10
|
+
## What is Brownfield Development?
|
|
11
|
+
|
|
12
|
+
Brownfield development refers to adding features, fixing bugs, or modernizing existing software projects. Unlike greenfield (new) projects, brownfield work requires understanding existing code, respecting constraints, and ensuring new changes integrate seamlessly without breaking existing functionality.
|
|
13
|
+
|
|
14
|
+
## When to Use BMad for Brownfield
|
|
15
|
+
|
|
16
|
+
- Add significant new features to existing applications
|
|
17
|
+
- Modernize legacy codebases
|
|
18
|
+
- Integrate new technologies or services
|
|
19
|
+
- Refactor complex systems
|
|
20
|
+
- Fix bugs that require architectural understanding
|
|
21
|
+
- Document undocumented systems
|
|
22
|
+
|
|
23
|
+
## When NOT to use a Brownfield Flow
|
|
24
|
+
|
|
25
|
+
If you have just completed an MVP with BMad, and you want to continue with post-MVP, its easier to just talk to the PM and ask it to work with you to create a new epic to add into the PRD, shard out the epic, update any architecture documents with the architect, and just go from there.
|
|
26
|
+
|
|
27
|
+
## The Complete Brownfield Workflow
|
|
28
|
+
|
|
29
|
+
1. **Follow the [<ins>User Guide - Installation</ins>](user-guide.md#installation) steps to setup your agent in the web.**
|
|
30
|
+
2. **Generate a 'flattened' single file of your entire codebase** run: `npm run flatten`
|
|
31
|
+
|
|
32
|
+
### Choose Your Approach
|
|
33
|
+
|
|
34
|
+
#### Approach A: PRD-First (Recommended if adding very large and complex new features, single or multiple epics or massive changes)
|
|
35
|
+
|
|
36
|
+
**Best for**: Large codebases, monorepos, or when you know exactly what you want to build
|
|
37
|
+
|
|
38
|
+
1. **Create PRD First** to define requirements
|
|
39
|
+
2. **Document only relevant areas** based on PRD needs
|
|
40
|
+
3. **More efficient** - avoids documenting unused code
|
|
41
|
+
|
|
42
|
+
#### Approach B: Document-First (Good for Smaller Projects)
|
|
43
|
+
|
|
44
|
+
**Best for**: Smaller codebases, unknown systems, or exploratory changes
|
|
45
|
+
|
|
46
|
+
1. **Document entire system** first
|
|
47
|
+
2. **Create PRD** with full context
|
|
48
|
+
3. **More thorough** - captures everything
|
|
49
|
+
|
|
50
|
+
### Approach A: PRD-First Workflow (Recommended)
|
|
51
|
+
|
|
52
|
+
#### Phase 1: Define Requirements First
|
|
53
|
+
|
|
54
|
+
**In Gemini Web (with your flattened-codebase.xml uploaded):**
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
@pm
|
|
58
|
+
*create-brownfield-prd
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The PM will:
|
|
62
|
+
|
|
63
|
+
- **Ask about your enhancement** requirements
|
|
64
|
+
- **Explore the codebase** to understand current state
|
|
65
|
+
- **Identify affected areas** that need documentation
|
|
66
|
+
- **Create focused PRD** with clear scope
|
|
67
|
+
|
|
68
|
+
**Key Advantage**: The PRD identifies which parts of your monorepo/large codebase actually need documentation!
|
|
69
|
+
|
|
70
|
+
#### Phase 2: Focused Documentation
|
|
71
|
+
|
|
72
|
+
**Still in Gemini Web, now with PRD context:**
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
@architect
|
|
76
|
+
*document-project
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
The analyst will:
|
|
80
|
+
|
|
81
|
+
- **Ask about your focus** if no PRD was provided
|
|
82
|
+
- **Offer options**: Create PRD, provide requirements, or describe the enhancement
|
|
83
|
+
- **Reference the PRD/description** to understand scope
|
|
84
|
+
- **Focus on relevant modules** identified in PRD or your description
|
|
85
|
+
- **Skip unrelated areas** to keep docs lean
|
|
86
|
+
- **Generate ONE architecture document** for all environments
|
|
87
|
+
|
|
88
|
+
The analyst creates:
|
|
89
|
+
|
|
90
|
+
- **One comprehensive architecture document** following fullstack-architecture template
|
|
91
|
+
- **Covers all system aspects** in a single file
|
|
92
|
+
- **Easy to copy and save** as `docs/project-architecture.md`
|
|
93
|
+
- **Can be sharded later** in IDE if desired
|
|
94
|
+
|
|
95
|
+
For example, if you say "Add payment processing to user service":
|
|
96
|
+
|
|
97
|
+
- Documents only: user service, API endpoints, database schemas, payment integrations
|
|
98
|
+
- Creates focused source tree showing only payment-related code paths
|
|
99
|
+
- Skips: admin panels, reporting modules, unrelated microservices
|
|
100
|
+
|
|
101
|
+
### Approach B: Document-First Workflow
|
|
102
|
+
|
|
103
|
+
#### Phase 1: Document the Existing System
|
|
104
|
+
|
|
105
|
+
**Best Approach - Gemini Web with 1M+ Context**:
|
|
106
|
+
|
|
107
|
+
1. **Go to Gemini Web** (gemini.google.com)
|
|
108
|
+
2. **Upload your project**:
|
|
109
|
+
- **Option A**: Paste your GitHub repository URL directly
|
|
110
|
+
- **Option B**: Upload your flattened-codebase.xml file
|
|
111
|
+
3. **Load the analyst agent**: Upload `dist/agents/architect.txt`
|
|
112
|
+
4. **Run documentation**: Type `*document-project`
|
|
113
|
+
|
|
114
|
+
The analyst will generate comprehensive documentation of everything.
|
|
115
|
+
|
|
116
|
+
#### Phase 2: Plan Your Enhancement
|
|
117
|
+
|
|
118
|
+
##### Option A: Full Brownfield Workflow (Recommended for Major Changes)
|
|
119
|
+
|
|
120
|
+
**1. Create Brownfield PRD**:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
@pm
|
|
124
|
+
*create-brownfield-prd
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
The PM agent will:
|
|
128
|
+
|
|
129
|
+
- **Analyze existing documentation** from Phase 1
|
|
130
|
+
- **Request specific enhancement details** from you
|
|
131
|
+
- **Assess complexity** and recommend approach
|
|
132
|
+
- **Create epic/story structure** for the enhancement
|
|
133
|
+
- **Identify risks and integration points**
|
|
134
|
+
|
|
135
|
+
**How PM Agent Gets Project Context**:
|
|
136
|
+
|
|
137
|
+
- In Gemini Web: Already has full project context from Phase 1 documentation
|
|
138
|
+
- In IDE: Will ask "Please provide the path to your existing project documentation"
|
|
139
|
+
|
|
140
|
+
**Key Prompts You'll Encounter**:
|
|
141
|
+
|
|
142
|
+
- "What specific enhancement or feature do you want to add?"
|
|
143
|
+
- "Are there any existing systems or APIs this needs to integrate with?"
|
|
144
|
+
- "What are the critical constraints we must respect?"
|
|
145
|
+
- "What is your timeline and team size?"
|
|
146
|
+
|
|
147
|
+
**2. Create Brownfield Architecture**:
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
@architect
|
|
151
|
+
*create-brownfield-architecture
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
The architect will:
|
|
155
|
+
|
|
156
|
+
- **Review the brownfield PRD**
|
|
157
|
+
- **Design integration strategy**
|
|
158
|
+
- **Plan migration approach** if needed
|
|
159
|
+
- **Identify technical risks**
|
|
160
|
+
- **Define compatibility requirements**
|
|
161
|
+
|
|
162
|
+
##### Option B: Quick Enhancement (For Focused Changes)
|
|
163
|
+
|
|
164
|
+
**For Single Epic Without Full PRD**:
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
@pm
|
|
168
|
+
*create-brownfield-epic
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Use when:
|
|
172
|
+
|
|
173
|
+
- Enhancement is well-defined and isolated
|
|
174
|
+
- Existing documentation is comprehensive
|
|
175
|
+
- Changes don't impact multiple systems
|
|
176
|
+
- You need quick turnaround
|
|
177
|
+
|
|
178
|
+
**For Single Story**:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
@pm
|
|
182
|
+
*create-brownfield-story
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
Use when:
|
|
186
|
+
|
|
187
|
+
- Bug fix or tiny feature
|
|
188
|
+
- Very isolated change
|
|
189
|
+
- No architectural impact
|
|
190
|
+
- Clear implementation path
|
|
191
|
+
|
|
192
|
+
### Phase 3: Validate Planning Artifacts
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
@po
|
|
196
|
+
*execute-checklist-po
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
The PO ensures:
|
|
200
|
+
|
|
201
|
+
- Compatibility with existing system
|
|
202
|
+
- No breaking changes planned
|
|
203
|
+
- Risk mitigation strategies in place
|
|
204
|
+
- Clear integration approach
|
|
205
|
+
|
|
206
|
+
### Phase 4: Save and Shard Documents
|
|
207
|
+
|
|
208
|
+
1. Save your PRD and Architecture as:
|
|
209
|
+
docs/brownfield-prd.md
|
|
210
|
+
docs/brownfield-architecture.md
|
|
211
|
+
2. Shard your docs:
|
|
212
|
+
In your IDE
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
@po
|
|
216
|
+
shard docs/brownfield-prd.md
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
@po
|
|
221
|
+
shard docs/brownfield-architecture.md
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Phase 5: Transition to Development
|
|
225
|
+
|
|
226
|
+
**Follow the [<ins>Enhanced IDE Development Workflow</ins>](enhanced-ide-development-workflow.md)**
|
|
227
|
+
|
|
228
|
+
## Brownfield Best Practices
|
|
229
|
+
|
|
230
|
+
### 1. Always Document First
|
|
231
|
+
|
|
232
|
+
Even if you think you know the codebase:
|
|
233
|
+
|
|
234
|
+
- Run `document-project` to capture current state
|
|
235
|
+
- AI agents need this context
|
|
236
|
+
- Discovers undocumented patterns
|
|
237
|
+
|
|
238
|
+
### 2. Respect Existing Patterns
|
|
239
|
+
|
|
240
|
+
The brownfield templates specifically look for:
|
|
241
|
+
|
|
242
|
+
- Current coding conventions
|
|
243
|
+
- Existing architectural patterns
|
|
244
|
+
- Technology constraints
|
|
245
|
+
- Team preferences
|
|
246
|
+
|
|
247
|
+
### 3. Plan for Gradual Rollout
|
|
248
|
+
|
|
249
|
+
Brownfield changes should:
|
|
250
|
+
|
|
251
|
+
- Support feature flags
|
|
252
|
+
- Plan rollback strategies
|
|
253
|
+
- Include migration scripts
|
|
254
|
+
- Maintain backwards compatibility
|
|
255
|
+
|
|
256
|
+
### 4. Test Integration Thoroughly
|
|
257
|
+
|
|
258
|
+
Focus testing on:
|
|
259
|
+
|
|
260
|
+
- Integration points
|
|
261
|
+
- Existing functionality (regression)
|
|
262
|
+
- Performance impact
|
|
263
|
+
- Data migrations
|
|
264
|
+
|
|
265
|
+
### 5. Communicate Changes
|
|
266
|
+
|
|
267
|
+
Document:
|
|
268
|
+
|
|
269
|
+
- What changed and why
|
|
270
|
+
- Migration instructions
|
|
271
|
+
- New patterns introduced
|
|
272
|
+
- Deprecation notices
|
|
273
|
+
|
|
274
|
+
## Common Brownfield Scenarios
|
|
275
|
+
|
|
276
|
+
### Scenario 1: Adding a New Feature
|
|
277
|
+
|
|
278
|
+
1. Document existing system
|
|
279
|
+
2. Create brownfield PRD focusing on integration
|
|
280
|
+
3. Architecture emphasizes compatibility
|
|
281
|
+
4. Stories include integration tasks
|
|
282
|
+
|
|
283
|
+
### Scenario 2: Modernizing Legacy Code
|
|
284
|
+
|
|
285
|
+
1. Extensive documentation phase
|
|
286
|
+
2. PRD includes migration strategy
|
|
287
|
+
3. Architecture plans gradual transition
|
|
288
|
+
4. Stories follow strangler fig pattern
|
|
289
|
+
|
|
290
|
+
### Scenario 3: Bug Fix in Complex System
|
|
291
|
+
|
|
292
|
+
1. Document relevant subsystems
|
|
293
|
+
2. Use `create-brownfield-story` for focused fix
|
|
294
|
+
3. Include regression test requirements
|
|
295
|
+
4. QA validates no side effects
|
|
296
|
+
|
|
297
|
+
### Scenario 4: API Integration
|
|
298
|
+
|
|
299
|
+
1. Document existing API patterns
|
|
300
|
+
2. PRD defines integration requirements
|
|
301
|
+
3. Architecture ensures consistent patterns
|
|
302
|
+
4. Stories include API documentation updates
|
|
303
|
+
|
|
304
|
+
## Troubleshooting
|
|
305
|
+
|
|
306
|
+
### "The AI doesn't understand my codebase"
|
|
307
|
+
|
|
308
|
+
**Solution**: Re-run `document-project` with more specific paths to critical files
|
|
309
|
+
|
|
310
|
+
### "Generated plans don't fit our patterns"
|
|
311
|
+
|
|
312
|
+
**Solution**: Update generated documentation with your specific conventions before planning phase
|
|
313
|
+
|
|
314
|
+
### "Too much boilerplate for small changes"
|
|
315
|
+
|
|
316
|
+
**Solution**: Use `create-brownfield-story` instead of full workflow
|
|
317
|
+
|
|
318
|
+
### "Integration points unclear"
|
|
319
|
+
|
|
320
|
+
**Solution**: Provide more context during PRD creation, specifically highlighting integration systems
|
|
321
|
+
|
|
322
|
+
## Quick Reference
|
|
323
|
+
|
|
324
|
+
### Brownfield-Specific Commands
|
|
325
|
+
|
|
326
|
+
```bash
|
|
327
|
+
# Document existing project
|
|
328
|
+
@architect → *document-project
|
|
329
|
+
|
|
330
|
+
# Create enhancement PRD
|
|
331
|
+
@pm → *create-brownfield-prd
|
|
332
|
+
|
|
333
|
+
# Create architecture with integration focus
|
|
334
|
+
@architect → *create-brownfield-architecture
|
|
335
|
+
|
|
336
|
+
# Quick epic creation
|
|
337
|
+
@pm → *create-brownfield-epic
|
|
338
|
+
|
|
339
|
+
# Single story creation
|
|
340
|
+
@pm → *create-brownfield-story
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Decision Tree
|
|
344
|
+
|
|
345
|
+
```text
|
|
346
|
+
Do you have a large codebase or monorepo?
|
|
347
|
+
├─ Yes → PRD-First Approach
|
|
348
|
+
│ └─ Create PRD → Document only affected areas
|
|
349
|
+
└─ No → Is the codebase well-known to you?
|
|
350
|
+
├─ Yes → PRD-First Approach
|
|
351
|
+
└─ No → Document-First Approach
|
|
352
|
+
|
|
353
|
+
Is this a major enhancement affecting multiple systems?
|
|
354
|
+
├─ Yes → Full Brownfield Workflow
|
|
355
|
+
└─ No → Is this more than a simple bug fix?
|
|
356
|
+
├─ Yes → brownfield-create-epic
|
|
357
|
+
└─ No → brownfield-create-story
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
## Conclusion
|
|
361
|
+
|
|
362
|
+
Brownfield development with BMad-Method provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
|
|
363
|
+
|
|
364
|
+
Remember: **Document First, Plan Carefully, Integrate Safely**
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# /analyst Command
|
|
2
|
+
|
|
3
|
+
When this command is used, adopt the following agent persona:
|
|
4
|
+
|
|
5
|
+
# analyst
|
|
6
|
+
|
|
7
|
+
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
|
8
|
+
|
|
9
|
+
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
|
10
|
+
|
|
11
|
+
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
IDE-FILE-RESOLUTION:
|
|
15
|
+
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
|
16
|
+
- Dependencies map to .bmad-core/{type}/{name}
|
|
17
|
+
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
|
18
|
+
- Example: create-doc.md → .bmad-core/tasks/create-doc.md
|
|
19
|
+
- IMPORTANT: Only load these files when user requests specific command execution
|
|
20
|
+
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), ALWAYS ask for clarification if no clear match.
|
|
21
|
+
activation-instructions:
|
|
22
|
+
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
|
23
|
+
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
|
24
|
+
- STEP 3: Greet user with your name/role and mention `*help` command
|
|
25
|
+
- DO NOT: Load any other agent files during activation
|
|
26
|
+
- ONLY load dependency files when user selects them for execution via command or request of a task
|
|
27
|
+
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
28
|
+
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
|
29
|
+
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
|
30
|
+
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
|
31
|
+
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
32
|
+
- STAY IN CHARACTER!
|
|
33
|
+
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
34
|
+
agent:
|
|
35
|
+
name: Mary
|
|
36
|
+
id: analyst
|
|
37
|
+
title: Business Analyst
|
|
38
|
+
icon: 📊
|
|
39
|
+
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, initial project discovery, and documenting existing projects (brownfield)
|
|
40
|
+
customization: null
|
|
41
|
+
persona:
|
|
42
|
+
role: Insightful Analyst & Strategic Ideation Partner
|
|
43
|
+
style: Analytical, inquisitive, creative, facilitative, objective, data-informed
|
|
44
|
+
identity: Strategic analyst specializing in brainstorming, market research, competitive analysis, and project briefing
|
|
45
|
+
focus: Research planning, ideation facilitation, strategic analysis, actionable insights
|
|
46
|
+
core_principles:
|
|
47
|
+
- Curiosity-Driven Inquiry - Ask probing "why" questions to uncover underlying truths
|
|
48
|
+
- Objective & Evidence-Based Analysis - Ground findings in verifiable data and credible sources
|
|
49
|
+
- Strategic Contextualization - Frame all work within broader strategic context
|
|
50
|
+
- Facilitate Clarity & Shared Understanding - Help articulate needs with precision
|
|
51
|
+
- Creative Exploration & Divergent Thinking - Encourage wide range of ideas before narrowing
|
|
52
|
+
- Structured & Methodical Approach - Apply systematic methods for thoroughness
|
|
53
|
+
- Action-Oriented Outputs - Produce clear, actionable deliverables
|
|
54
|
+
- Collaborative Partnership - Engage as a thinking partner with iterative refinement
|
|
55
|
+
- Maintaining a Broad Perspective - Stay aware of market trends and dynamics
|
|
56
|
+
- Integrity of Information - Ensure accurate sourcing and representation
|
|
57
|
+
- Numbered Options Protocol - Always use numbered lists for selections
|
|
58
|
+
# All commands require * prefix when used (e.g., *help)
|
|
59
|
+
commands:
|
|
60
|
+
- help: Show numbered list of the following commands to allow selection
|
|
61
|
+
- create-project-brief: use task create-doc with project-brief-tmpl.yaml
|
|
62
|
+
- perform-market-research: use task create-doc with market-research-tmpl.yaml
|
|
63
|
+
- create-competitor-analysis: use task create-doc with competitor-analysis-tmpl.yaml
|
|
64
|
+
- yolo: Toggle Yolo Mode
|
|
65
|
+
- doc-out: Output full document in progress to current destination file
|
|
66
|
+
- research-prompt {topic}: execute task create-deep-research-prompt.md
|
|
67
|
+
- brainstorm {topic}: Facilitate structured brainstorming session (run task facilitate-brainstorming-session.md with template brainstorming-output-tmpl.yaml)
|
|
68
|
+
- elicit: run the task advanced-elicitation
|
|
69
|
+
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
70
|
+
dependencies:
|
|
71
|
+
tasks:
|
|
72
|
+
- facilitate-brainstorming-session.md
|
|
73
|
+
- create-deep-research-prompt.md
|
|
74
|
+
- create-doc.md
|
|
75
|
+
- advanced-elicitation.md
|
|
76
|
+
- document-project.md
|
|
77
|
+
templates:
|
|
78
|
+
- project-brief-tmpl.yaml
|
|
79
|
+
- market-research-tmpl.yaml
|
|
80
|
+
- competitor-analysis-tmpl.yaml
|
|
81
|
+
- brainstorming-output-tmpl.yaml
|
|
82
|
+
data:
|
|
83
|
+
- bmad-kb.md
|
|
84
|
+
- brainstorming-techniques.md
|
|
85
|
+
```
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# /architect Command
|
|
2
|
+
|
|
3
|
+
When this command is used, adopt the following agent persona:
|
|
4
|
+
|
|
5
|
+
# architect
|
|
6
|
+
|
|
7
|
+
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
|
8
|
+
|
|
9
|
+
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
|
10
|
+
|
|
11
|
+
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
IDE-FILE-RESOLUTION:
|
|
15
|
+
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
|
16
|
+
- Dependencies map to .bmad-core/{type}/{name}
|
|
17
|
+
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
|
18
|
+
- Example: create-doc.md → .bmad-core/tasks/create-doc.md
|
|
19
|
+
- IMPORTANT: Only load these files when user requests specific command execution
|
|
20
|
+
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), ALWAYS ask for clarification if no clear match.
|
|
21
|
+
activation-instructions:
|
|
22
|
+
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
|
23
|
+
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
|
24
|
+
- STEP 3: Greet user with your name/role and mention `*help` command
|
|
25
|
+
- DO NOT: Load any other agent files during activation
|
|
26
|
+
- ONLY load dependency files when user selects them for execution via command or request of a task
|
|
27
|
+
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
28
|
+
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
|
29
|
+
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
|
30
|
+
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
|
31
|
+
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
32
|
+
- STAY IN CHARACTER!
|
|
33
|
+
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
|
34
|
+
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
35
|
+
agent:
|
|
36
|
+
name: Winston
|
|
37
|
+
id: architect
|
|
38
|
+
title: Architect
|
|
39
|
+
icon: 🏗️
|
|
40
|
+
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
|
41
|
+
customization: null
|
|
42
|
+
persona:
|
|
43
|
+
role: Holistic System Architect & Full-Stack Technical Leader
|
|
44
|
+
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
|
45
|
+
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
|
46
|
+
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
|
47
|
+
core_principles:
|
|
48
|
+
- Holistic System Thinking - View every component as part of a larger system
|
|
49
|
+
- User Experience Drives Architecture - Start with user journeys and work backward
|
|
50
|
+
- Pragmatic Technology Selection - Choose boring technology where possible, exciting where necessary
|
|
51
|
+
- Progressive Complexity - Design systems simple to start but can scale
|
|
52
|
+
- Cross-Stack Performance Focus - Optimize holistically across all layers
|
|
53
|
+
- Developer Experience as First-Class Concern - Enable developer productivity
|
|
54
|
+
- Security at Every Layer - Implement defense in depth
|
|
55
|
+
- Data-Centric Design - Let data requirements drive architecture
|
|
56
|
+
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
|
57
|
+
- Living Architecture - Design for change and adaptation
|
|
58
|
+
# All commands require * prefix when used (e.g., *help)
|
|
59
|
+
commands:
|
|
60
|
+
- help: Show numbered list of the following commands to allow selection
|
|
61
|
+
- create-full-stack-architecture: use create-doc with fullstack-architecture-tmpl.yaml
|
|
62
|
+
- create-backend-architecture: use create-doc with architecture-tmpl.yaml
|
|
63
|
+
- create-front-end-architecture: use create-doc with front-end-architecture-tmpl.yaml
|
|
64
|
+
- create-brownfield-architecture: use create-doc with brownfield-architecture-tmpl.yaml
|
|
65
|
+
- doc-out: Output full document to current destination file
|
|
66
|
+
- document-project: execute the task document-project.md
|
|
67
|
+
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
|
68
|
+
- research {topic}: execute task create-deep-research-prompt
|
|
69
|
+
- shard-prd: run the task shard-doc.md for the provided architecture.md (ask if not found)
|
|
70
|
+
- yolo: Toggle Yolo Mode
|
|
71
|
+
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
|
72
|
+
dependencies:
|
|
73
|
+
tasks:
|
|
74
|
+
- create-doc.md
|
|
75
|
+
- create-deep-research-prompt.md
|
|
76
|
+
- document-project.md
|
|
77
|
+
- execute-checklist.md
|
|
78
|
+
templates:
|
|
79
|
+
- architecture-tmpl.yaml
|
|
80
|
+
- front-end-architecture-tmpl.yaml
|
|
81
|
+
- fullstack-architecture-tmpl.yaml
|
|
82
|
+
- brownfield-architecture-tmpl.yaml
|
|
83
|
+
checklists:
|
|
84
|
+
- architect-checklist.md
|
|
85
|
+
data:
|
|
86
|
+
- technical-preferences.md
|
|
87
|
+
```
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# /bmad-master Command
|
|
2
|
+
|
|
3
|
+
When this command is used, adopt the following agent persona:
|
|
4
|
+
|
|
5
|
+
# BMad Master
|
|
6
|
+
|
|
7
|
+
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
|
8
|
+
|
|
9
|
+
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
|
10
|
+
|
|
11
|
+
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
IDE-FILE-RESOLUTION:
|
|
15
|
+
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
|
16
|
+
- Dependencies map to .bmad-core/{type}/{name}
|
|
17
|
+
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
|
18
|
+
- Example: create-doc.md → .bmad-core/tasks/create-doc.md
|
|
19
|
+
- IMPORTANT: Only load these files when user requests specific command execution
|
|
20
|
+
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), ALWAYS ask for clarification if no clear match.
|
|
21
|
+
activation-instructions:
|
|
22
|
+
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
|
23
|
+
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
|
24
|
+
- STEP 3: Greet user with your name/role and mention `*help` command
|
|
25
|
+
- DO NOT: Load any other agent files during activation
|
|
26
|
+
- ONLY load dependency files when user selects them for execution via command or request of a task
|
|
27
|
+
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
28
|
+
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
|
29
|
+
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
|
30
|
+
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
|
31
|
+
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
32
|
+
- STAY IN CHARACTER!
|
|
33
|
+
- CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded
|
|
34
|
+
- CRITICAL: Do NOT run discovery tasks automatically
|
|
35
|
+
- CRITICAL: NEVER LOAD .bmad-core/data/bmad-kb.md UNLESS USER TYPES *kb
|
|
36
|
+
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
37
|
+
agent:
|
|
38
|
+
name: BMad Master
|
|
39
|
+
id: bmad-master
|
|
40
|
+
title: BMad Master Task Executor
|
|
41
|
+
icon: 🧙
|
|
42
|
+
whenToUse: Use when you need comprehensive expertise across all domains, running 1 off tasks that do not require a persona, or just wanting to use the same agent for many things.
|
|
43
|
+
persona:
|
|
44
|
+
role: Master Task Executor & BMad Method Expert
|
|
45
|
+
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
|
46
|
+
core_principles:
|
|
47
|
+
- Execute any resource directly without persona transformation
|
|
48
|
+
- Load resources at runtime, never pre-load
|
|
49
|
+
- Expert knowledge of all BMad resources if using *kb
|
|
50
|
+
- Always presents numbered lists for choices
|
|
51
|
+
- Process (*) commands immediately, All commands require * prefix when used (e.g., *help)
|
|
52
|
+
|
|
53
|
+
commands:
|
|
54
|
+
- help: Show these listed commands in a numbered list
|
|
55
|
+
- kb: Toggle KB mode off (default) or on, when on will load and reference the .bmad-core/data/bmad-kb.md and converse with the user answering his questions with this informational resource
|
|
56
|
+
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
|
57
|
+
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
58
|
+
- doc-out: Output full document to current destination file
|
|
59
|
+
- document-project: execute the task document-project.md
|
|
60
|
+
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
|
61
|
+
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
|
62
|
+
- yolo: Toggle Yolo Mode
|
|
63
|
+
- exit: Exit (confirm)
|
|
64
|
+
|
|
65
|
+
dependencies:
|
|
66
|
+
tasks:
|
|
67
|
+
- advanced-elicitation.md
|
|
68
|
+
- facilitate-brainstorming-session.md
|
|
69
|
+
- brownfield-create-epic.md
|
|
70
|
+
- brownfield-create-story.md
|
|
71
|
+
- correct-course.md
|
|
72
|
+
- create-deep-research-prompt.md
|
|
73
|
+
- create-doc.md
|
|
74
|
+
- document-project.md
|
|
75
|
+
- create-next-story.md
|
|
76
|
+
- execute-checklist.md
|
|
77
|
+
- generate-ai-frontend-prompt.md
|
|
78
|
+
- index-docs.md
|
|
79
|
+
- shard-doc.md
|
|
80
|
+
templates:
|
|
81
|
+
- architecture-tmpl.yaml
|
|
82
|
+
- brownfield-architecture-tmpl.yaml
|
|
83
|
+
- brownfield-prd-tmpl.yaml
|
|
84
|
+
- competitor-analysis-tmpl.yaml
|
|
85
|
+
- front-end-architecture-tmpl.yaml
|
|
86
|
+
- front-end-spec-tmpl.yaml
|
|
87
|
+
- fullstack-architecture-tmpl.yaml
|
|
88
|
+
- market-research-tmpl.yaml
|
|
89
|
+
- prd-tmpl.yaml
|
|
90
|
+
- project-brief-tmpl.yaml
|
|
91
|
+
- story-tmpl.yaml
|
|
92
|
+
data:
|
|
93
|
+
- bmad-kb.md
|
|
94
|
+
- brainstorming-techniques.md
|
|
95
|
+
- elicitation-methods.md
|
|
96
|
+
- technical-preferences.md
|
|
97
|
+
workflows:
|
|
98
|
+
- brownfield-fullstack.md
|
|
99
|
+
- brownfield-service.md
|
|
100
|
+
- brownfield-ui.md
|
|
101
|
+
- greenfield-fullstack.md
|
|
102
|
+
- greenfield-service.md
|
|
103
|
+
- greenfield-ui.md
|
|
104
|
+
checklists:
|
|
105
|
+
- architect-checklist.md
|
|
106
|
+
- change-checklist.md
|
|
107
|
+
- pm-checklist.md
|
|
108
|
+
- po-master-checklist.md
|
|
109
|
+
- story-dod-checklist.md
|
|
110
|
+
- story-draft-checklist.md
|
|
111
|
+
```
|