bmad-method 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.bmad-core/agent-teams/team-all.yml +16 -0
- package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
- package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
- package/.bmad-core/agents/analyst.md +65 -0
- package/.bmad-core/agents/architect.md +66 -0
- package/.bmad-core/agents/bmad-master.md +107 -0
- package/.bmad-core/agents/bmad-orchestrator.md +81 -0
- package/.bmad-core/agents/dev.md +69 -0
- package/.bmad-core/agents/pm.md +64 -0
- package/.bmad-core/agents/po.md +60 -0
- package/.bmad-core/agents/qa.md +52 -0
- package/.bmad-core/agents/sm.md +60 -0
- package/.bmad-core/agents/ux-expert.md +66 -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/data/bmad-kb.md +36 -0
- package/.bmad-core/data/technical-preferences.md +3 -0
- package/.bmad-core/schemas/agent-team-schema.yml +153 -0
- package/.bmad-core/tasks/advanced-elicitation.md +92 -0
- package/.bmad-core/tasks/brainstorming-techniques.md +238 -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/core-dump.md +74 -0
- package/.bmad-core/tasks/correct-course.md +73 -0
- package/.bmad-core/tasks/create-agent.md +202 -0
- package/.bmad-core/tasks/create-deep-research-prompt.md +301 -0
- package/.bmad-core/tasks/create-doc.md +74 -0
- package/.bmad-core/tasks/create-expansion-pack.md +425 -0
- package/.bmad-core/tasks/create-next-story.md +206 -0
- package/.bmad-core/tasks/create-team.md +229 -0
- package/.bmad-core/tasks/doc-migration-task.md +198 -0
- package/.bmad-core/tasks/execute-checklist.md +97 -0
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
- package/.bmad-core/tasks/index-docs.md +180 -0
- package/.bmad-core/tasks/shard-doc.md +173 -0
- package/.bmad-core/templates/agent-tmpl.md +58 -0
- package/.bmad-core/templates/architecture-tmpl.md +771 -0
- package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
- package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
- package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
- package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
- package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
- package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
- package/.bmad-core/templates/fullstack-architecture-tmpl.md +1034 -0
- package/.bmad-core/templates/market-research-tmpl.md +261 -0
- package/.bmad-core/templates/prd-tmpl.md +200 -0
- package/.bmad-core/templates/project-brief-tmpl.md +228 -0
- package/.bmad-core/templates/story-tmpl.md +61 -0
- package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
- package/.bmad-core/utils/agent-switcher.ide.md +112 -0
- package/.bmad-core/utils/template-format.md +26 -0
- package/.bmad-core/utils/workflow-management.md +224 -0
- package/.bmad-core/web-bundles/agents/analyst.txt +1679 -0
- package/.bmad-core/web-bundles/agents/architect.txt +3602 -0
- package/.bmad-core/web-bundles/agents/bmad-master.txt +9496 -0
- package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1455 -0
- package/.bmad-core/web-bundles/agents/dev.txt +315 -0
- package/.bmad-core/web-bundles/agents/pm.txt +2196 -0
- package/.bmad-core/web-bundles/agents/po.txt +1489 -0
- package/.bmad-core/web-bundles/agents/qa.txt +129 -0
- package/.bmad-core/web-bundles/agents/sm.txt +663 -0
- package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
- package/.bmad-core/web-bundles/teams/team-all.txt +10315 -0
- package/.bmad-core/web-bundles/teams/team-fullstack.txt +9663 -0
- package/.bmad-core/web-bundles/teams/team-no-ui.txt +8504 -0
- package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
- package/.bmad-core/workflows/brownfield-service.yml +117 -0
- package/.bmad-core/workflows/brownfield-ui.yml +127 -0
- package/.bmad-core/workflows/greenfield-fullstack.yml +177 -0
- package/.bmad-core/workflows/greenfield-service.yml +143 -0
- package/.bmad-core/workflows/greenfield-ui.yml +172 -0
- package/.claude/commands/analyst.md +69 -0
- package/.claude/commands/architect.md +70 -0
- package/.claude/commands/bmad-master.md +111 -0
- package/.claude/commands/bmad-orchestrator.md +85 -0
- package/.claude/commands/dev.md +73 -0
- package/.claude/commands/pm.md +68 -0
- package/.claude/commands/po.md +64 -0
- package/.claude/commands/qa.md +56 -0
- package/.claude/commands/sm.md +64 -0
- package/.claude/commands/ux-expert.md +70 -0
- package/.cursor/rules/analyst.mdc +83 -0
- package/.cursor/rules/architect.mdc +84 -0
- package/.cursor/rules/bmad-master.mdc +125 -0
- package/.cursor/rules/bmad-orchestrator.mdc +99 -0
- package/.cursor/rules/dev.mdc +87 -0
- package/.cursor/rules/pm.mdc +82 -0
- package/.cursor/rules/po.mdc +78 -0
- package/.cursor/rules/qa.mdc +70 -0
- package/.cursor/rules/sm.mdc +78 -0
- package/.cursor/rules/ux-expert.mdc +84 -0
- package/.github/workflows/release.yml +59 -0
- package/.husky/pre-commit +2 -0
- package/.releaserc.json +17 -0
- package/.roo/.roomodes +95 -0
- package/.roo/README.md +38 -0
- package/.vscode/extensions.json +6 -0
- package/.vscode/settings.json +72 -0
- package/.windsurf/rules/analyst.md +77 -0
- package/.windsurf/rules/architect.md +78 -0
- package/.windsurf/rules/bmad-master.md +119 -0
- package/.windsurf/rules/bmad-orchestrator.md +93 -0
- package/.windsurf/rules/dev.md +81 -0
- package/.windsurf/rules/pm.md +76 -0
- package/.windsurf/rules/po.md +72 -0
- package/.windsurf/rules/qa.md +64 -0
- package/.windsurf/rules/sm.md +72 -0
- package/.windsurf/rules/ux-expert.md +78 -0
- package/CHANGELOG.md +22 -0
- package/CONTRIBUTING.md +46 -0
- package/LICENSE +21 -0
- package/README.md +283 -0
- package/docs/versioning-and-releases.md +85 -0
- package/docs/versions.md +49 -0
- package/expansion-packs/README.md +113 -0
- package/expansion-packs/infrastructure-devops/README.md +147 -0
- package/expansion-packs/infrastructure-devops/agents/infra-devops-platform.md +59 -0
- package/expansion-packs/infrastructure-devops/checklists/infrastructure-checklist.md +484 -0
- package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
- package/expansion-packs/infrastructure-devops/tasks/review-infrastructure.md +160 -0
- package/expansion-packs/infrastructure-devops/tasks/validate-infrastructure.md +154 -0
- package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
- package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/package.json +73 -0
- package/tools/bmad-npx-wrapper.js +41 -0
- package/tools/builders/web-builder.js +145 -0
- package/tools/cli.js +119 -0
- package/tools/installer/README.md +58 -0
- package/tools/installer/bin/bmad.js +179 -0
- package/tools/installer/config/install.config.yml +139 -0
- package/tools/installer/lib/config-loader.js +89 -0
- package/tools/installer/lib/file-manager.js +169 -0
- package/tools/installer/lib/ide-setup.js +419 -0
- package/tools/installer/lib/installer.js +534 -0
- package/tools/installer/package-lock.json +704 -0
- package/tools/installer/package.json +43 -0
- package/tools/installer/templates/claude-commands.md +7 -0
- package/tools/installer/templates/cursor-rules.md +22 -0
- package/tools/installer/templates/windsurf-rules.md +22 -0
- package/tools/lib/dependency-resolver.js +179 -0
- package/tools/upgraders/v3-to-v4-upgrader.js +766 -0
- package/tools/version-bump.js +72 -0
- package/tools/yaml-format.js +211 -0
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# Create Team Task
|
|
2
|
+
|
|
3
|
+
This task guides you through creating a new BMAD agent team that conforms to the agent-team schema and effectively combines agents for specific project types.
|
|
4
|
+
|
|
5
|
+
**Note for User-Created Teams**: If creating a custom team for your own use (not part of the core BMAD system), prefix the team name with a period (e.g., `.team-frontend`) to ensure it's gitignored and won't conflict with repository updates.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
1. Load and understand the team schema: `/bmad-core/schemas/agent-team-schema.yml`
|
|
10
|
+
2. Review existing teams in `/bmad-core/agent-teams/` for patterns and naming conventions
|
|
11
|
+
3. List available agents from `/agents/` to understand team composition options
|
|
12
|
+
4. Review workflows in `/bmad-core/workflows/` to align team capabilities
|
|
13
|
+
|
|
14
|
+
## Process
|
|
15
|
+
|
|
16
|
+
### 1. Define Team Purpose and Scope
|
|
17
|
+
|
|
18
|
+
Before selecting agents, clarify the team's mission:
|
|
19
|
+
|
|
20
|
+
- **Team Purpose**: What specific problems will this team solve?
|
|
21
|
+
- **Project Types**: Greenfield, brownfield, or both?
|
|
22
|
+
- **Technical Scope**: UI-focused, backend-only, or full-stack?
|
|
23
|
+
- **Team Size Consideration**: Smaller teams (3-5 agents) for focused work, larger teams (6-8) for comprehensive coverage
|
|
24
|
+
|
|
25
|
+
### 2. Create Team Metadata
|
|
26
|
+
|
|
27
|
+
Based on the schema requirements:
|
|
28
|
+
|
|
29
|
+
- **Team Name**: Must follow pattern `^Team .+$` (e.g., "Team Frontend", "Team Analytics")
|
|
30
|
+
- For user teams: prefix with period (e.g., "Team .MyCustom")
|
|
31
|
+
- **Description**: 20-500 characters explaining team's purpose, capabilities, and use cases
|
|
32
|
+
- **File Name**: `/bmad-core/agent-teams/team-{identifier}.yml`
|
|
33
|
+
- For user teams: `/bmad-core/agent-teams/.team-{identifier}.yml`
|
|
34
|
+
|
|
35
|
+
### 3. Select Agents Based on Purpose
|
|
36
|
+
|
|
37
|
+
#### Discover Available Agents
|
|
38
|
+
|
|
39
|
+
1. List all agents from `/agents/` directory
|
|
40
|
+
2. Review each agent's role and capabilities
|
|
41
|
+
3. Consider agent synergies and coverage
|
|
42
|
+
|
|
43
|
+
#### Agent Selection Guidelines
|
|
44
|
+
|
|
45
|
+
Based on team purpose, recommend agents:
|
|
46
|
+
|
|
47
|
+
**For Planning & Strategy Teams:**
|
|
48
|
+
|
|
49
|
+
- `bmad` (required orchestrator)
|
|
50
|
+
- `analyst` - Requirements gathering and research
|
|
51
|
+
- `pm` - Product strategy and documentation
|
|
52
|
+
- `po` - Validation and approval
|
|
53
|
+
- `architect` - Technical planning (if technical planning needed)
|
|
54
|
+
|
|
55
|
+
**For Design & UX Teams:**
|
|
56
|
+
|
|
57
|
+
- `bmad` (required orchestrator)
|
|
58
|
+
- `ux-expert` - User experience design
|
|
59
|
+
- `architect` - Frontend architecture
|
|
60
|
+
- `pm` - Product requirements alignment
|
|
61
|
+
- `po` - Design validation
|
|
62
|
+
|
|
63
|
+
**For Development Teams:**
|
|
64
|
+
|
|
65
|
+
- `bmad-orchestrator` (required)
|
|
66
|
+
- `sm` - Sprint coordination
|
|
67
|
+
- `dev` - Implementation
|
|
68
|
+
- `qa` - Quality assurance
|
|
69
|
+
- `architect` - Technical guidance
|
|
70
|
+
|
|
71
|
+
**For Full-Stack Teams:**
|
|
72
|
+
|
|
73
|
+
- `bmad-orchestrator` (required)
|
|
74
|
+
- `analyst` - Initial planning
|
|
75
|
+
- `pm` - Product management
|
|
76
|
+
- `ux-expert` - UI/UX design (if UI work included)
|
|
77
|
+
- `architect` - System architecture
|
|
78
|
+
- `po` - Validation
|
|
79
|
+
- Additional agents as needed
|
|
80
|
+
|
|
81
|
+
#### Special Cases
|
|
82
|
+
|
|
83
|
+
- **Using Wildcard**: If team needs all agents, use `["bmad", "*"]`
|
|
84
|
+
- **Validation**: Schema requires `bmad` in all teams
|
|
85
|
+
|
|
86
|
+
### 4. Select Workflows
|
|
87
|
+
|
|
88
|
+
Based on the schema's workflow enum values and team composition:
|
|
89
|
+
|
|
90
|
+
1. **Analyze team capabilities** against available workflows:
|
|
91
|
+
|
|
92
|
+
- `brownfield-fullstack` - Requires full team with UX
|
|
93
|
+
- `brownfield-service` - Backend-focused team
|
|
94
|
+
- `brownfield-ui` - UI/UX-focused team
|
|
95
|
+
- `greenfield-fullstack` - Full team for new projects
|
|
96
|
+
- `greenfield-service` - Backend team for new services
|
|
97
|
+
- `greenfield-ui` - Frontend team for new UIs
|
|
98
|
+
|
|
99
|
+
2. **Match workflows to agents**:
|
|
100
|
+
|
|
101
|
+
- UI workflows require `ux-expert`
|
|
102
|
+
- Service workflows benefit from `architect` and `dev`
|
|
103
|
+
- All workflows benefit from planning agents (`analyst`, `pm`)
|
|
104
|
+
|
|
105
|
+
3. **Apply schema validation rules**:
|
|
106
|
+
- Teams without `ux-expert` shouldn't have UI workflows
|
|
107
|
+
- Teams named "Team No UI" can't have UI workflows
|
|
108
|
+
|
|
109
|
+
### 5. Create Team Configuration
|
|
110
|
+
|
|
111
|
+
Generate the configuration following the schema:
|
|
112
|
+
|
|
113
|
+
```yaml
|
|
114
|
+
bundle:
|
|
115
|
+
name: "{Team Name}" # Must match pattern "^Team .+$"
|
|
116
|
+
description: >-
|
|
117
|
+
{20-500 character description explaining purpose,
|
|
118
|
+
capabilities, and ideal use cases}
|
|
119
|
+
|
|
120
|
+
agents:
|
|
121
|
+
- bmad # Required orchestrator
|
|
122
|
+
- { agent-id-1 }
|
|
123
|
+
- { agent-id-2 }
|
|
124
|
+
# ... additional agents
|
|
125
|
+
|
|
126
|
+
workflows:
|
|
127
|
+
- { workflow-1 } # From enum list
|
|
128
|
+
- { workflow-2 }
|
|
129
|
+
# ... additional workflows
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 6. Validate Team Composition
|
|
133
|
+
|
|
134
|
+
Before finalizing, verify:
|
|
135
|
+
|
|
136
|
+
1. **Role Coverage**: Does the team have all necessary skills for its workflows?
|
|
137
|
+
2. **Size Optimization**:
|
|
138
|
+
- Minimum: 2 agents (bmad + 1)
|
|
139
|
+
- Recommended: 3-7 agents
|
|
140
|
+
- Maximum with wildcard: bmad + "\*"
|
|
141
|
+
3. **Workflow Alignment**: Can the selected agents execute all workflows?
|
|
142
|
+
4. **Schema Compliance**: Configuration matches all schema requirements
|
|
143
|
+
|
|
144
|
+
### 7. Integration Recommendations
|
|
145
|
+
|
|
146
|
+
Document how this team integrates with existing system:
|
|
147
|
+
|
|
148
|
+
1. **Complementary Teams**: Which existing teams complement this one?
|
|
149
|
+
2. **Handoff Points**: Where does this team hand off to others?
|
|
150
|
+
3. **Use Case Scenarios**: Specific project types ideal for this team
|
|
151
|
+
|
|
152
|
+
### 8. Validation and Testing
|
|
153
|
+
|
|
154
|
+
1. **Schema Validation**: Ensure configuration matches agent-team-schema.yml
|
|
155
|
+
2. **Build Validation**: Run `npm run validate`
|
|
156
|
+
3. **Build Team**: Run `npm run build:team -t {team-name}`
|
|
157
|
+
4. **Size Check**: Verify output is appropriate for target platform
|
|
158
|
+
5. **Test Scenarios**: Run sample workflows with the team
|
|
159
|
+
|
|
160
|
+
## Example Team Creation
|
|
161
|
+
|
|
162
|
+
### Example 1: API Development Team
|
|
163
|
+
|
|
164
|
+
```yaml
|
|
165
|
+
bundle:
|
|
166
|
+
name: "Team API"
|
|
167
|
+
description: >-
|
|
168
|
+
Specialized team for API and backend service development. Focuses on
|
|
169
|
+
robust service architecture, implementation, and testing without UI
|
|
170
|
+
components. Ideal for microservices, REST APIs, and backend systems.
|
|
171
|
+
|
|
172
|
+
agents:
|
|
173
|
+
- bmad
|
|
174
|
+
- analyst
|
|
175
|
+
- architect
|
|
176
|
+
- dev
|
|
177
|
+
- qa
|
|
178
|
+
- po
|
|
179
|
+
|
|
180
|
+
workflows:
|
|
181
|
+
- greenfield-service
|
|
182
|
+
- brownfield-service
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Example 2: Rapid Prototyping Team
|
|
186
|
+
|
|
187
|
+
```yaml
|
|
188
|
+
bundle:
|
|
189
|
+
name: "Team Prototype"
|
|
190
|
+
description: >-
|
|
191
|
+
Agile team for rapid prototyping and proof of concept development.
|
|
192
|
+
Combines planning, design, and implementation for quick iterations
|
|
193
|
+
on new ideas and experimental features.
|
|
194
|
+
|
|
195
|
+
agents:
|
|
196
|
+
- bmad
|
|
197
|
+
- pm
|
|
198
|
+
- ux-expert
|
|
199
|
+
- architect
|
|
200
|
+
- dev
|
|
201
|
+
|
|
202
|
+
workflows:
|
|
203
|
+
- greenfield-ui
|
|
204
|
+
- greenfield-fullstack
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## Team Creation Checklist
|
|
208
|
+
|
|
209
|
+
- [ ] Team purpose clearly defined
|
|
210
|
+
- [ ] Name follows schema pattern "Team {Name}"
|
|
211
|
+
- [ ] Description is 20-500 characters
|
|
212
|
+
- [ ] Includes bmad orchestrator
|
|
213
|
+
- [ ] Agents align with team purpose
|
|
214
|
+
- [ ] Workflows match team capabilities
|
|
215
|
+
- [ ] No conflicting validations (e.g., no-UI team with UI workflows)
|
|
216
|
+
- [ ] Configuration validates against schema
|
|
217
|
+
- [ ] Build completes successfully
|
|
218
|
+
- [ ] Output size appropriate for platform
|
|
219
|
+
|
|
220
|
+
## Best Practices
|
|
221
|
+
|
|
222
|
+
1. **Start Focused**: Create teams with specific purposes rather than general-purpose teams
|
|
223
|
+
2. **Consider Workflow**: Order agents by typical workflow sequence
|
|
224
|
+
3. **Avoid Redundancy**: Don't duplicate roles unless needed
|
|
225
|
+
4. **Document Rationale**: Explain why each agent is included
|
|
226
|
+
5. **Test Integration**: Verify team works well with selected workflows
|
|
227
|
+
6. **Iterate**: Refine team composition based on usage
|
|
228
|
+
|
|
229
|
+
This schema-driven approach ensures teams are well-structured, purposeful, and integrate seamlessly with the BMAD ecosystem.
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# Document Migration Task
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Migrate BMAD-METHOD documents to match V4 template structure exactly, preserving all content while enforcing strict template compliance.
|
|
6
|
+
|
|
7
|
+
## Task Requirements
|
|
8
|
+
|
|
9
|
+
1. **Input**: User MUST specify the document to migrate (e.g., `docs/prd.md`)
|
|
10
|
+
2. **Template**: User MUST specify the V4 template to use (e.g., `.bmad-core/templates/prd-tmpl.md`)
|
|
11
|
+
3. **Validation**: Verify document and template are compatible types
|
|
12
|
+
4. **Output**: Creates migrated document with original name, backs up original with `.bak` extension
|
|
13
|
+
|
|
14
|
+
[[LLM: VALIDATION REQUIREMENTS:
|
|
15
|
+
|
|
16
|
+
- Both input document and template paths MUST be provided by the user
|
|
17
|
+
- Do NOT assume or select templates automatically
|
|
18
|
+
- Validate that document type matches template type (e.g., PRD → PRD template)
|
|
19
|
+
- Reject incompatible migrations (e.g., PRD → architecture template)
|
|
20
|
+
|
|
21
|
+
]]
|
|
22
|
+
|
|
23
|
+
## Migration Rules
|
|
24
|
+
|
|
25
|
+
### Strict Template Compliance
|
|
26
|
+
|
|
27
|
+
[[LLM: CRITICAL RULES:
|
|
28
|
+
|
|
29
|
+
1. The ONLY Level 2 headings (##) allowed are EXACTLY those in the V4 template
|
|
30
|
+
2. No additions, no removals, no modifications to Level 2 headings
|
|
31
|
+
3. All user content must be preserved and placed under appropriate template sections
|
|
32
|
+
4. Remove any existing table of contents
|
|
33
|
+
5. Never delete user content - find the most appropriate section
|
|
34
|
+
6. DO NOT add any LLM prompts, placeholders, or "TBD" content
|
|
35
|
+
7. Leave empty sections empty - no instructions or guidance text
|
|
36
|
+
|
|
37
|
+
]]
|
|
38
|
+
|
|
39
|
+
### Content Migration Process
|
|
40
|
+
|
|
41
|
+
1. **Read Template Structure**
|
|
42
|
+
|
|
43
|
+
- Extract all Level 2 headings from the V4 template
|
|
44
|
+
- These are the ONLY Level 2 headings allowed in the final document
|
|
45
|
+
|
|
46
|
+
2. **Analyze Original Document**
|
|
47
|
+
|
|
48
|
+
- Identify all content blocks
|
|
49
|
+
- Note original section organization
|
|
50
|
+
- Flag any custom sections
|
|
51
|
+
|
|
52
|
+
3. **Create Backup First**
|
|
53
|
+
|
|
54
|
+
- Rename original file: `mv filename.md filename.md.bak`
|
|
55
|
+
- This preserves the original completely
|
|
56
|
+
|
|
57
|
+
4. **Create New File**
|
|
58
|
+
|
|
59
|
+
- Create new `filename.md` from scratch
|
|
60
|
+
- Start with template structure (all Level 2 headings)
|
|
61
|
+
- For each content block from original:
|
|
62
|
+
- Find the most appropriate V4 template section
|
|
63
|
+
- If original had Level 2 heading not in template, demote to Level 3
|
|
64
|
+
- Preserve all text, lists, code blocks, diagrams, tables
|
|
65
|
+
- Remove only table of contents sections
|
|
66
|
+
- **IMPORTANT**: Do NOT add any LLM prompts, placeholders, or instructions
|
|
67
|
+
- If a template section has no matching content, leave it empty
|
|
68
|
+
|
|
69
|
+
5. **Validate Content Preservation**
|
|
70
|
+
- For each major content block from original (excluding headings):
|
|
71
|
+
- Use grep or search to verify it exists in new file
|
|
72
|
+
- Report any content that couldn't be verified
|
|
73
|
+
- This ensures no accidental content loss
|
|
74
|
+
|
|
75
|
+
## Example Migration
|
|
76
|
+
|
|
77
|
+
```markdown
|
|
78
|
+
Original (prd.md):
|
|
79
|
+
|
|
80
|
+
## Executive Summary
|
|
81
|
+
|
|
82
|
+
[content...]
|
|
83
|
+
|
|
84
|
+
## Custom Feature Section
|
|
85
|
+
|
|
86
|
+
[content...]
|
|
87
|
+
|
|
88
|
+
## Table of Contents
|
|
89
|
+
|
|
90
|
+
[toc...]
|
|
91
|
+
|
|
92
|
+
Template (prd-tmpl.md):
|
|
93
|
+
|
|
94
|
+
## Goals and Background Context
|
|
95
|
+
|
|
96
|
+
## Functional Requirements
|
|
97
|
+
|
|
98
|
+
## Success Metrics and KPIs
|
|
99
|
+
|
|
100
|
+
Result (prd.md):
|
|
101
|
+
|
|
102
|
+
## Goals and Background Context
|
|
103
|
+
|
|
104
|
+
[executive summary content moved here]
|
|
105
|
+
|
|
106
|
+
### Custom Feature Section
|
|
107
|
+
|
|
108
|
+
[content preserved but demoted to Level 3]
|
|
109
|
+
|
|
110
|
+
## Functional Requirements
|
|
111
|
+
|
|
112
|
+
## Success Metrics and KPIs
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Execution Instructions
|
|
116
|
+
|
|
117
|
+
[[LLM: When executing this task:
|
|
118
|
+
|
|
119
|
+
1. Ask user for BOTH: input file path AND template path (do not assume)
|
|
120
|
+
2. Validate compatibility:
|
|
121
|
+
- Check document title/type (PRD, Architecture, etc.)
|
|
122
|
+
- Ensure template matches document type
|
|
123
|
+
- REJECT if types don't match (e.g., "Cannot migrate PRD to architecture template")
|
|
124
|
+
3. Read both files completely
|
|
125
|
+
4. Rename original to .bak: `mv original.md original.md.bak`
|
|
126
|
+
5. Extract Level 2 headings from template - these are MANDATORY
|
|
127
|
+
6. Create NEW file with original name
|
|
128
|
+
7. Build new content:
|
|
129
|
+
- Start with all template Level 2 sections
|
|
130
|
+
- Map original content to appropriate sections
|
|
131
|
+
- Demote any non-template Level 2 headings to Level 3
|
|
132
|
+
- Leave empty sections empty (no placeholders or instructions)
|
|
133
|
+
8. Validate content preservation:
|
|
134
|
+
- Extract key content snippets from .bak file
|
|
135
|
+
- Use grep to verify each exists in new file
|
|
136
|
+
- Report any missing content
|
|
137
|
+
9. Report migration summary:
|
|
138
|
+
- Sections moved/demoted
|
|
139
|
+
- Content validation results
|
|
140
|
+
- Any manual review needed
|
|
141
|
+
|
|
142
|
+
]]
|
|
143
|
+
|
|
144
|
+
### Document Type Detection
|
|
145
|
+
|
|
146
|
+
[[LLM: Detect document type by examining:
|
|
147
|
+
|
|
148
|
+
- File name (prd.md, architecture.md, etc.)
|
|
149
|
+
- Main title (# Product Requirements Document, # Architecture, etc.)
|
|
150
|
+
- Content patterns (user stories → PRD, technology stack → Architecture)
|
|
151
|
+
|
|
152
|
+
Template compatibility:
|
|
153
|
+
|
|
154
|
+
- prd-tmpl.md → Only for PRD documents
|
|
155
|
+
- architecture-tmpl.md → Only for backend/single architecture
|
|
156
|
+
- full-stack-architecture-tmpl.md → Only for architecture documents (can merge multiple)
|
|
157
|
+
|
|
158
|
+
]]
|
|
159
|
+
|
|
160
|
+
## Common Migrations
|
|
161
|
+
|
|
162
|
+
Valid migrations:
|
|
163
|
+
|
|
164
|
+
- `prd.md` → `.bmad-core/templates/prd-tmpl.md`
|
|
165
|
+
- `architecture.md` → `.bmad-core/templates/architecture-tmpl.md`
|
|
166
|
+
- `architecture.md` + `front-end-architecture.md` → `.bmad-core/templates/full-stack-architecture-tmpl.md`
|
|
167
|
+
|
|
168
|
+
Invalid migrations (MUST REJECT):
|
|
169
|
+
|
|
170
|
+
- `prd.md` → `.bmad-core/templates/architecture-tmpl.md`
|
|
171
|
+
- `architecture.md` → `.bmad-core/templates/prd-tmpl.md`
|
|
172
|
+
- `ux-ui-spec.md` → `.bmad-core/templates/prd-tmpl.md`
|
|
173
|
+
|
|
174
|
+
## Validation
|
|
175
|
+
|
|
176
|
+
After migration verify:
|
|
177
|
+
|
|
178
|
+
- [ ] All Level 2 headings match template exactly
|
|
179
|
+
- [ ] All original content is preserved (use grep validation)
|
|
180
|
+
- [ ] No table of contents remains
|
|
181
|
+
- [ ] Backup file exists with .bak extension
|
|
182
|
+
- [ ] Custom sections demoted to Level 3 or lower
|
|
183
|
+
|
|
184
|
+
### Content Validation Example
|
|
185
|
+
|
|
186
|
+
[[LLM: Example validation approach:
|
|
187
|
+
|
|
188
|
+
1. Extract significant text blocks from .bak file (>20 words)
|
|
189
|
+
2. For each block, grep in new file:
|
|
190
|
+
```bash
|
|
191
|
+
grep -F "first 10-15 words of content block" newfile.md
|
|
192
|
+
```
|
|
193
|
+
3. Track validation results:
|
|
194
|
+
- ✓ Found: content successfully migrated
|
|
195
|
+
- ✗ Missing: needs investigation
|
|
196
|
+
4. Report any content that couldn't be found
|
|
197
|
+
|
|
198
|
+
]]
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# Checklist Validation Task
|
|
2
|
+
|
|
3
|
+
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
|
4
|
+
|
|
5
|
+
## Context
|
|
6
|
+
|
|
7
|
+
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
|
8
|
+
|
|
9
|
+
## Available Checklists
|
|
10
|
+
|
|
11
|
+
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
|
12
|
+
|
|
13
|
+
## Instructions
|
|
14
|
+
|
|
15
|
+
1. **Initial Assessment**
|
|
16
|
+
|
|
17
|
+
- If user or the task being run provides a checklist name:
|
|
18
|
+
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
19
|
+
- If multiple matches found, ask user to clarify
|
|
20
|
+
- Load the appropriate checklist from bmad-core/checklists/
|
|
21
|
+
- If no checklist specified:
|
|
22
|
+
- Ask the user which checklist they want to use
|
|
23
|
+
- Present the available options from the files in the checklists folder
|
|
24
|
+
- Confirm if they want to work through the checklist:
|
|
25
|
+
- Section by section (interactive mode - very time consuming)
|
|
26
|
+
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
27
|
+
|
|
28
|
+
2. **Document and Artifact Gathering**
|
|
29
|
+
|
|
30
|
+
- Each checklist will specify its required documents/artifacts at the beginning
|
|
31
|
+
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
|
|
32
|
+
|
|
33
|
+
3. **Checklist Processing**
|
|
34
|
+
|
|
35
|
+
If in interactive mode:
|
|
36
|
+
|
|
37
|
+
- Work through each section of the checklist one at a time
|
|
38
|
+
- For each section:
|
|
39
|
+
- Review all items in the section following instructions for that section embedded in the checklist
|
|
40
|
+
- Check each item against the relevant documentation or artifacts as appropriate
|
|
41
|
+
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
|
|
42
|
+
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
43
|
+
|
|
44
|
+
If in YOLO mode:
|
|
45
|
+
|
|
46
|
+
- Process all sections at once
|
|
47
|
+
- Create a comprehensive report of all findings
|
|
48
|
+
- Present the complete analysis to the user
|
|
49
|
+
|
|
50
|
+
4. **Validation Approach**
|
|
51
|
+
|
|
52
|
+
For each checklist item:
|
|
53
|
+
|
|
54
|
+
- Read and understand the requirement
|
|
55
|
+
- Look for evidence in the documentation that satisfies the requirement
|
|
56
|
+
- Consider both explicit mentions and implicit coverage
|
|
57
|
+
- Aside from this, follow all checklist llm instructions
|
|
58
|
+
- Mark items as:
|
|
59
|
+
- ✅ PASS: Requirement clearly met
|
|
60
|
+
- ❌ FAIL: Requirement not met or insufficient coverage
|
|
61
|
+
- ⚠️ PARTIAL: Some aspects covered but needs improvement
|
|
62
|
+
- N/A: Not applicable to this case
|
|
63
|
+
|
|
64
|
+
5. **Section Analysis**
|
|
65
|
+
|
|
66
|
+
For each section:
|
|
67
|
+
|
|
68
|
+
- think step by step to calculate pass rate
|
|
69
|
+
- Identify common themes in failed items
|
|
70
|
+
- Provide specific recommendations for improvement
|
|
71
|
+
- In interactive mode, discuss findings with user
|
|
72
|
+
- Document any user decisions or explanations
|
|
73
|
+
|
|
74
|
+
6. **Final Report**
|
|
75
|
+
|
|
76
|
+
Prepare a summary that includes:
|
|
77
|
+
|
|
78
|
+
- Overall checklist completion status
|
|
79
|
+
- Pass rates by section
|
|
80
|
+
- List of failed items with context
|
|
81
|
+
- Specific recommendations for improvement
|
|
82
|
+
- Any sections or items marked as N/A with justification
|
|
83
|
+
|
|
84
|
+
## Checklist Execution Methodology
|
|
85
|
+
|
|
86
|
+
Each checklist now contains embedded LLM prompts and instructions that will:
|
|
87
|
+
|
|
88
|
+
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
|
|
89
|
+
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
|
|
90
|
+
3. **Provide contextual guidance** - Section-specific prompts for better validation
|
|
91
|
+
4. **Generate comprehensive reports** - Final summary with detailed findings
|
|
92
|
+
|
|
93
|
+
The LLM will:
|
|
94
|
+
|
|
95
|
+
- Execute the complete checklist validation
|
|
96
|
+
- Present a final report with pass/fail rates and key findings
|
|
97
|
+
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Create AI Frontend Prompt Task
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
To generate a masterful, comprehensive, and optimized prompt that can be used with AI-driven frontend development tools (e.g., Lovable, Vercel v0, or similar) to scaffold or generate significant portions of the frontend application.
|
|
6
|
+
|
|
7
|
+
## Inputs
|
|
8
|
+
|
|
9
|
+
- Completed UI/UX Specification (`front-end-spec-tmpl`)
|
|
10
|
+
- Completed Frontend Architecture Document (`front-end-architecture`)
|
|
11
|
+
- Main System Architecture Document (`architecture` - for API contracts and tech stack)
|
|
12
|
+
- Primary Design Files (Figma, Sketch, etc. - for visual context if the tool can accept it or if descriptions are needed)
|
|
13
|
+
|
|
14
|
+
## Key Activities & Instructions
|
|
15
|
+
|
|
16
|
+
1. **Confirm Target AI Generation Platform:**
|
|
17
|
+
|
|
18
|
+
- Ask the user to specify which AI frontend generation tool/platform they intend to use (e.g., "Lovable.ai", "Vercel v0", "GPT-4 with direct code generation instructions", etc.).
|
|
19
|
+
- Explain that prompt optimization might differ slightly based on the platform's capabilities and preferred input format.
|
|
20
|
+
|
|
21
|
+
2. **Synthesize Inputs into a Structured Prompt:**
|
|
22
|
+
|
|
23
|
+
- **Overall Project Context:**
|
|
24
|
+
- Briefly state the project's purpose (from brief/PRD).
|
|
25
|
+
- Specify the chosen frontend framework, core libraries, and UI component library (from `front-end-architecture` and main `architecture`).
|
|
26
|
+
- Mention the styling approach (e.g., Tailwind CSS, CSS Modules).
|
|
27
|
+
- **Design System & Visuals:**
|
|
28
|
+
- Reference the primary design files (e.g., Figma link).
|
|
29
|
+
- If the tool doesn't directly ingest design files, describe the overall visual style, color palette, typography, and key branding elements (from `front-end-spec-tmpl`).
|
|
30
|
+
- List any global UI components or design tokens that should be defined or adhered to.
|
|
31
|
+
- **Application Structure & Routing:**
|
|
32
|
+
- Describe the main pages/views and their routes (from `front-end-architecture` - Routing Strategy).
|
|
33
|
+
- Outline the navigation structure (from `front-end-spec-tmpl`).
|
|
34
|
+
- **Key User Flows & Page-Level Interactions:**
|
|
35
|
+
- For a few critical user flows (from `front-end-spec-tmpl`):
|
|
36
|
+
- Describe the sequence of user actions and expected UI changes on each relevant page.
|
|
37
|
+
- Specify API calls to be made (referencing API endpoints from the main `architecture`) and how data should be displayed or used.
|
|
38
|
+
- **Component Generation Instructions (Iterative or Key Components):**
|
|
39
|
+
- Based on the chosen AI tool's capabilities, decide on a strategy:
|
|
40
|
+
- **Option 1 (Scaffolding):** Prompt for the generation of main page structures, layouts, and placeholders for components.
|
|
41
|
+
- **Option 2 (Key Component Generation):** Select a few critical or complex components from the `front-end-architecture` (Component Breakdown) and provide detailed specifications for them (props, state, basic behavior, key UI elements).
|
|
42
|
+
- **Option 3 (Holistic, if tool supports):** Attempt to describe the entire application structure and key components more broadly.
|
|
43
|
+
- <important_note>Advise the user that generating an entire complex application perfectly in one go is rare. Iterative prompting or focusing on sections/key components is often more effective.</important_note>
|
|
44
|
+
- **State Management (High-Level Pointers):**
|
|
45
|
+
- Mention the chosen state management solution (e.g., "Use Redux Toolkit").
|
|
46
|
+
- For key pieces of data, indicate if they should be managed in global state.
|
|
47
|
+
- **API Integration Points:**
|
|
48
|
+
- For pages/components that fetch or submit data, clearly state the relevant API endpoints (from `architecture`) and the expected data shapes (can reference schemas in `data-models` or `api-reference` sections of the architecture doc).
|
|
49
|
+
- **Critical "Don'ts" or Constraints:**
|
|
50
|
+
- e.g., "Do not use deprecated libraries." "Ensure all forms have basic client-side validation."
|
|
51
|
+
- **Platform-Specific Optimizations:**
|
|
52
|
+
- If the chosen AI tool has known best practices for prompting (e.g., specific keywords, structure, level of detail), incorporate them. (This might require the agent to have some general knowledge or to ask the user if they know any such specific prompt modifiers for their chosen tool).
|
|
53
|
+
|
|
54
|
+
3. **Present and Refine the Master Prompt:**
|
|
55
|
+
- Output the generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
56
|
+
- Explain the structure of the prompt and why certain information was included.
|
|
57
|
+
- Work with the user to refine the prompt based on their knowledge of the target AI tool and any specific nuances they want to emphasize.
|
|
58
|
+
- <important_note>Remind the user that the generated code from the AI tool will likely require review, testing, and further refinement by developers.</important_note>
|