bmad-method 4.2.0 → 4.4.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/.claude/commands/analyst.md +14 -20
- package/.claude/commands/architect.md +15 -20
- package/.claude/commands/bmad-master.md +18 -26
- package/.claude/commands/bmad-orchestrator.md +80 -33
- package/.claude/commands/dev.md +5 -4
- package/.claude/commands/pm.md +11 -16
- package/.claude/commands/sm.md +20 -25
- package/.cursor/rules/analyst.mdc +13 -19
- package/.cursor/rules/architect.mdc +14 -19
- package/.cursor/rules/bmad-master.mdc +18 -26
- package/.cursor/rules/bmad-orchestrator.mdc +80 -33
- package/.cursor/rules/dev.mdc +5 -4
- package/.cursor/rules/pm.mdc +11 -16
- package/.cursor/rules/sm.mdc +19 -24
- package/.releaserc.json +2 -1
- package/.roo/README.md +0 -11
- package/.vscode/settings.json +4 -0
- package/.windsurf/rules/analyst.md +13 -19
- package/.windsurf/rules/architect.md +14 -19
- package/.windsurf/rules/bmad-master.md +18 -26
- package/.windsurf/rules/bmad-orchestrator.md +80 -33
- package/.windsurf/rules/dev.md +5 -4
- package/.windsurf/rules/pm.md +11 -16
- package/.windsurf/rules/sm.md +19 -24
- package/CHANGELOG.md +126 -2
- package/CONTRIBUTING.md +2 -0
- package/README.md +20 -2
- package/{.bmad-core → bmad-core}/agent-teams/team-all.yml +1 -3
- package/bmad-core/agent-teams/team-fullstack.yml +18 -0
- package/{.bmad-core → bmad-core}/agent-teams/team-no-ui.yml +0 -2
- package/{.bmad-core → bmad-core}/agents/analyst.md +14 -20
- package/{.bmad-core → bmad-core}/agents/architect.md +15 -20
- package/{.bmad-core → bmad-core}/agents/bmad-master.md +18 -26
- package/bmad-core/agents/bmad-orchestrator.md +128 -0
- package/{.bmad-core → bmad-core}/agents/dev.md +5 -4
- package/{.bmad-core → bmad-core}/agents/pm.md +11 -16
- package/{.bmad-core → bmad-core}/agents/qa.md +11 -17
- package/bmad-core/agents/sm.md +55 -0
- package/{.bmad-core → bmad-core}/agents/ux-expert.md +14 -20
- package/bmad-core/bmad-core-config.yml +60 -0
- package/bmad-core/data/bmad-kb.md +47 -0
- package/bmad-core/tasks/doc-migration-task.md +143 -0
- package/bmad-core/tasks/document-project.md +389 -0
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
- package/{.bmad-core → bmad-core}/tasks/index-docs.md +8 -3
- package/{.bmad-core → bmad-core}/tasks/shard-doc.md +5 -3
- package/{.bmad-core → bmad-core}/templates/architecture-tmpl.md +16 -13
- package/{.bmad-core → bmad-core}/templates/brownfield-architecture-tmpl.md +6 -6
- package/{.bmad-core → bmad-core}/templates/front-end-spec-tmpl.md +6 -6
- package/{.bmad-core → bmad-core}/templates/fullstack-architecture-tmpl.md +85 -103
- package/{.bmad-core → bmad-core}/templates/prd-tmpl.md +1 -1
- package/bmad-core/templates/simple-project-prd-tmpl.md +461 -0
- package/{.bmad-core → bmad-core}/templates/story-tmpl.md +2 -2
- package/{.bmad-core → bmad-core}/utils/agent-switcher.ide.md +6 -6
- package/{.bmad-core → bmad-core}/utils/workflow-management.md +14 -15
- package/{.bmad-core → bmad-core}/web-bundles/agents/analyst.txt +26 -21
- package/{.bmad-core → bmad-core}/web-bundles/agents/architect.txt +608 -236
- package/{.bmad-core → bmad-core}/web-bundles/agents/bmad-master.txt +467 -1049
- package/bmad-core/web-bundles/agents/bmad-orchestrator.txt +647 -0
- package/{.bmad-core → bmad-core}/web-bundles/agents/dev.txt +5 -4
- package/{.bmad-core → bmad-core}/web-bundles/agents/pm.txt +477 -18
- package/{.bmad-core → bmad-core}/web-bundles/agents/po.txt +3 -3
- package/{.bmad-core → bmad-core}/web-bundles/agents/qa.txt +11 -17
- package/{.bmad-core → bmad-core}/web-bundles/agents/sm.txt +22 -27
- package/{.bmad-core → bmad-core}/web-bundles/agents/ux-expert.txt +57 -70
- package/{.bmad-core → bmad-core}/workflows/greenfield-fullstack.yml +3 -3
- package/{.bmad-core → creator-tools}/tasks/create-agent.md +10 -12
- package/{.bmad-core/tasks/create-expansion-pack.md → creator-tools/tasks/generate-expansion-pack.md} +8 -6
- package/docs/bmad-workflow-guide.md +161 -0
- package/docs/claude-code-guide.md +119 -0
- package/docs/core-architecture.md +213 -0
- package/docs/cursor-guide.md +127 -0
- package/docs/how-to-contribute-with-pull-requests.md +141 -0
- package/docs/roo-code-guide.md +140 -0
- package/docs/user-guide.md +1044 -0
- package/docs/versioning-and-releases.md +4 -4
- package/docs/windsurf-guide.md +127 -0
- package/expansion-packs/README.md +1 -111
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/team-game-dev.yml +12 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +58 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +66 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +51 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +201 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +160 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +254 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +631 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/manifest.yml +45 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +111 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +216 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +308 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md +560 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md +345 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md +331 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.md +235 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md +451 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-designer.txt +1758 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-developer.txt +1444 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-sm.txt +674 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/team-game-dev.txt +4395 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/teams/team-game-dev.txt +4395 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yml +183 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yml +175 -0
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/README.md +5 -5
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/agents/infra-devops-platform.md +3 -3
- package/expansion-packs/bmad-infrastructure-devops/manifest.yml +23 -0
- package/expansion-packs/bmad-infrastructure-devops/tasks/create-doc.md +74 -0
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/expansion-packs/bmad-infrastructure-devops/web-bundles/agents/infra-devops-platform.txt +2021 -0
- package/package.json +20 -14
- package/tools/builders/web-builder.js +207 -17
- package/tools/cli.js +55 -7
- package/tools/installer/README.md +2 -2
- package/tools/installer/bin/bmad.js +107 -28
- package/tools/installer/config/install.config.yml +43 -43
- package/tools/installer/lib/config-loader.js +39 -2
- package/tools/installer/lib/file-manager.js +20 -3
- package/tools/installer/lib/ide-setup.js +11 -1
- package/tools/installer/lib/installer.js +275 -29
- package/tools/installer/package-lock.json +538 -336
- package/tools/installer/package.json +8 -8
- package/tools/lib/dependency-resolver.js +2 -2
- package/tools/semantic-release-sync-installer.js +31 -0
- package/tools/sync-installer-version.js +34 -0
- package/tools/upgraders/v3-to-v4-upgrader.js +18 -13
- package/tools/version-bump.js +33 -26
- package/tools/yaml-format.js +54 -25
- package/.bmad-core/agent-teams/team-fullstack.yml +0 -26
- package/.bmad-core/agents/bmad-orchestrator.md +0 -81
- package/.bmad-core/agents/sm.md +0 -60
- package/.bmad-core/data/bmad-kb.md +0 -36
- package/.bmad-core/schemas/agent-team-schema.yml +0 -153
- package/.bmad-core/tasks/create-team.md +0 -229
- package/.bmad-core/tasks/doc-migration-task.md +0 -198
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -58
- package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +0 -1455
- package/.bmad-core/web-bundles/teams/team-all.txt +0 -10315
- package/.bmad-core/web-bundles/teams/team-fullstack.txt +0 -9663
- package/.bmad-core/web-bundles/teams/team-no-ui.txt +0 -8504
- package/.claude/settings.local.json +0 -22
- package/expansion-packs/infrastructure-devops/manifest.yml +0 -38
- /package/{.bmad-core → bmad-core}/agents/po.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/architect-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/change-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/pm-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/po-master-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/story-dod-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/checklists/story-draft-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/data/technical-preferences.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/advanced-elicitation.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/brainstorming-techniques.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/brownfield-create-epic.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/brownfield-create-story.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/core-dump.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/correct-course.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/create-deep-research-prompt.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/create-doc.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/create-next-story.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/execute-checklist.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/agent-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/brownfield-prd-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/competitor-analysis-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/expansion-pack-plan-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/front-end-architecture-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/market-research-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/project-brief-tmpl.md +0 -0
- /package/{.bmad-core → bmad-core}/templates/web-agent-startup-instructions-template.md +0 -0
- /package/{.bmad-core → bmad-core}/utils/template-format.md +0 -0
- /package/{.bmad-core → bmad-core}/workflows/brownfield-fullstack.yml +0 -0
- /package/{.bmad-core → bmad-core}/workflows/brownfield-service.yml +0 -0
- /package/{.bmad-core → bmad-core}/workflows/brownfield-ui.yml +0 -0
- /package/{.bmad-core → bmad-core}/workflows/greenfield-service.yml +0 -0
- /package/{.bmad-core → bmad-core}/workflows/greenfield-ui.yml +0 -0
- /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/checklists/infrastructure-checklist.md +0 -0
- /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/review-infrastructure.md +0 -0
- /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/validate-infrastructure.md +0 -0
- /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/templates/infrastructure-architecture-tmpl.md +0 -0
|
@@ -43,51 +43,46 @@ These references map directly to bundle sections:
|
|
|
43
43
|
|
|
44
44
|
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
45
45
|
|
|
46
|
-
```
|
|
46
|
+
```yaml
|
|
47
47
|
activation-instructions:
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
48
|
+
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
49
|
+
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
50
|
+
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
51
|
+
- 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
|
|
53
52
|
agent:
|
|
54
53
|
name: Bob
|
|
55
54
|
id: sm
|
|
56
55
|
title: Scrum Master
|
|
57
56
|
icon: 🏃
|
|
58
|
-
whenToUse:
|
|
59
|
-
customization:
|
|
60
|
-
|
|
57
|
+
whenToUse: Use for story creation, epic management, retrospectives in party-mode, and agile process guidance
|
|
58
|
+
customization: null
|
|
61
59
|
persona:
|
|
62
60
|
role: Technical Scrum Master - Story Preparation Specialist
|
|
63
61
|
style: Task-oriented, efficient, precise, focused on clear developer handoffs
|
|
64
62
|
identity: Story creation expert who prepares detailed, actionable stories for AI developers
|
|
65
63
|
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
|
|
66
|
-
|
|
67
64
|
core_principles:
|
|
68
65
|
- Task Adherence - Rigorously follow create-next-story procedures
|
|
69
66
|
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
|
|
70
67
|
- Clarity for Developer Handoff - Stories must be immediately actionable
|
|
71
68
|
- Focus on One Story at a Time - Complete one before starting next
|
|
72
69
|
- Numbered Options Protocol - Always use numbered lists for selections
|
|
73
|
-
|
|
74
70
|
startup:
|
|
75
71
|
- Greet the user with your name and role, and inform of the *help command.
|
|
76
|
-
-
|
|
77
|
-
-
|
|
78
|
-
-
|
|
79
|
-
-
|
|
80
|
-
|
|
72
|
+
- CRITICAL: Do NOT automatically execute create-next-story tasks during startup
|
|
73
|
+
- CRITICAL: Do NOT create or modify any files during startup
|
|
74
|
+
- Offer to help with story preparation but wait for explicit user confirmation
|
|
75
|
+
- Only execute tasks when user explicitly requests them
|
|
76
|
+
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent'
|
|
81
77
|
commands:
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
|
|
78
|
+
- '*help" - Show: numbered list of the following commands to allow selection'
|
|
79
|
+
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
|
|
80
|
+
- '*create" - Execute all steps in Create Next Story Task document'
|
|
81
|
+
- '*pivot" - Run correct-course task (ensure no story already created first)'
|
|
82
|
+
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
|
|
83
|
+
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
|
|
84
|
+
- '*index-docs" - Update documentation index in /docs/index.md'
|
|
85
|
+
- '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
|
|
91
86
|
dependencies:
|
|
92
87
|
tasks:
|
|
93
88
|
- create-next-story
|
|
@@ -462,12 +457,12 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
462
457
|
|
|
463
458
|
### Completion Notes List
|
|
464
459
|
|
|
465
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
|
|
460
|
+
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
466
461
|
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
467
462
|
|
|
468
463
|
### Change Log
|
|
469
464
|
|
|
470
|
-
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update]]
|
|
465
|
+
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
471
466
|
[[LLM: (Dev Agent) Track document versions and changes during development that deviate from story dev start]]
|
|
472
467
|
|
|
473
468
|
| Date | Version | Description | Author |
|
|
@@ -43,27 +43,24 @@ These references map directly to bundle sections:
|
|
|
43
43
|
|
|
44
44
|
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
45
45
|
|
|
46
|
-
```
|
|
46
|
+
```yaml
|
|
47
47
|
activation-instructions:
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
48
|
+
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
49
|
+
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
50
|
+
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
51
|
+
- 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
|
|
53
52
|
agent:
|
|
54
53
|
name: Sally
|
|
55
54
|
id: ux-expert
|
|
56
55
|
title: UX Expert
|
|
57
56
|
icon: 🎨
|
|
58
|
-
whenToUse:
|
|
59
|
-
customization:
|
|
60
|
-
|
|
57
|
+
whenToUse: Use for UI/UX design, wireframes, prototypes, front-end specifications, and user experience optimization
|
|
58
|
+
customization: null
|
|
61
59
|
persona:
|
|
62
60
|
role: User Experience Designer & UI Specialist
|
|
63
61
|
style: Empathetic, creative, detail-oriented, user-obsessed, data-informed
|
|
64
62
|
identity: UX Expert specializing in user experience design and creating intuitive interfaces
|
|
65
63
|
focus: User research, interaction design, visual design, accessibility, AI-powered UI generation
|
|
66
|
-
|
|
67
64
|
core_principles:
|
|
68
65
|
- User-Centricity Above All - Every design decision must serve user needs
|
|
69
66
|
- Evidence-Based Design - Base decisions on research and testing, not assumptions
|
|
@@ -78,20 +75,17 @@ persona:
|
|
|
78
75
|
- You have a keen eye for detail and a deep empathy for users.
|
|
79
76
|
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
|
80
77
|
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
|
81
|
-
|
|
82
78
|
startup:
|
|
83
79
|
- Greet the user with your name and role, and inform of the *help command.
|
|
84
80
|
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
|
85
|
-
|
|
86
81
|
commands:
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
|
|
82
|
+
- '*help" - Show: numbered list of the following commands to allow selection'
|
|
83
|
+
- '*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions'
|
|
84
|
+
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
|
85
|
+
- '*generate-ui-prompt" - Create AI frontend generation prompt'
|
|
86
|
+
- '*research {topic}" - Generate deep research prompt for UX investigation'
|
|
87
|
+
- '*execute-checklist {checklist}" - Run design validation checklist'
|
|
88
|
+
- '*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona'
|
|
95
89
|
dependencies:
|
|
96
90
|
tasks:
|
|
97
91
|
- generate-ai-frontend-prompt
|
|
@@ -112,60 +106,53 @@ dependencies:
|
|
|
112
106
|
|
|
113
107
|
## Purpose
|
|
114
108
|
|
|
115
|
-
To generate a masterful, comprehensive, and optimized prompt that can be used with AI-driven frontend development
|
|
109
|
+
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
|
116
110
|
|
|
117
111
|
## Inputs
|
|
118
112
|
|
|
119
|
-
- Completed UI/UX Specification (`front-end-spec
|
|
120
|
-
- Completed Frontend Architecture Document (`front-end-architecture`)
|
|
121
|
-
- Main System Architecture Document (`architecture` - for API contracts and tech stack)
|
|
122
|
-
- Primary Design Files (Figma, Sketch, etc. - for visual context if the tool can accept it or if descriptions are needed)
|
|
113
|
+
- Completed UI/UX Specification (`front-end-spec`)
|
|
114
|
+
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
|
115
|
+
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
|
123
116
|
|
|
124
117
|
## Key Activities & Instructions
|
|
125
118
|
|
|
126
|
-
1.
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
3. **Present and Refine the Master Prompt:**
|
|
165
|
-
- Output the generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
166
|
-
- Explain the structure of the prompt and why certain information was included.
|
|
167
|
-
- 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.
|
|
168
|
-
- <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>
|
|
119
|
+
### 1. Core Prompting Principles
|
|
120
|
+
|
|
121
|
+
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
|
122
|
+
|
|
123
|
+
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
|
124
|
+
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
|
125
|
+
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
|
126
|
+
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
|
127
|
+
|
|
128
|
+
### 2. The Structured Prompting Framework
|
|
129
|
+
|
|
130
|
+
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
|
131
|
+
|
|
132
|
+
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
|
133
|
+
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
|
134
|
+
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
|
135
|
+
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
|
136
|
+
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
|
137
|
+
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
|
138
|
+
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
|
139
|
+
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
|
140
|
+
|
|
141
|
+
### 3. Assembling the Master Prompt
|
|
142
|
+
|
|
143
|
+
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
|
144
|
+
|
|
145
|
+
1. **Gather Foundational Context**:
|
|
146
|
+
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
|
147
|
+
2. **Describe the Visuals**:
|
|
148
|
+
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
|
149
|
+
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
|
150
|
+
3. **Build the Prompt using the Structured Framework**:
|
|
151
|
+
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
|
152
|
+
4. **Present and Refine**:
|
|
153
|
+
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
154
|
+
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
|
155
|
+
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
|
169
156
|
==================== END: tasks#generate-ai-frontend-prompt ====================
|
|
170
157
|
|
|
171
158
|
==================== START: tasks#create-deep-research-prompt ====================
|
|
@@ -728,7 +715,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|
|
728
715
|
|
|
729
716
|
```mermaid
|
|
730
717
|
{{sitemap_diagram}}
|
|
731
|
-
```
|
|
718
|
+
```text
|
|
732
719
|
|
|
733
720
|
@{example: sitemap}
|
|
734
721
|
|
|
@@ -783,7 +770,7 @@ Create subsections for each major flow. After presenting all flows, apply `tasks
|
|
|
783
770
|
|
|
784
771
|
```mermaid
|
|
785
772
|
{{flow_diagram}}
|
|
786
|
-
```
|
|
773
|
+
```text
|
|
787
774
|
|
|
788
775
|
**Edge Cases & Error Handling:**
|
|
789
776
|
|
|
@@ -91,10 +91,10 @@ workflow:
|
|
|
91
91
|
notes: "Creates focused project brief for simple project. SAVE OUTPUT: Copy final project-brief.md to your project's docs/ folder."
|
|
92
92
|
|
|
93
93
|
- agent: pm
|
|
94
|
-
creates:
|
|
95
|
-
uses: create-epic OR create-story
|
|
94
|
+
creates: simple-project-prd.md
|
|
95
|
+
uses: create doc simple-project-prd OR create-epic OR create-story
|
|
96
96
|
requires: project-brief.md
|
|
97
|
-
notes: "Create simple epic or story instead of full PRD for rapid development. Choose based on scope."
|
|
97
|
+
notes: "Create simple prd, simple epic or story instead of full PRD for rapid development. Choose based on scope."
|
|
98
98
|
|
|
99
99
|
- workflow_end:
|
|
100
100
|
action: move_to_ide
|
|
@@ -55,7 +55,7 @@ Determine:
|
|
|
55
55
|
|
|
56
56
|
**Track Created Items:**
|
|
57
57
|
|
|
58
|
-
```
|
|
58
|
+
```text
|
|
59
59
|
Created during agent setup:
|
|
60
60
|
- Tasks:
|
|
61
61
|
- [ ] task-name-1.md
|
|
@@ -104,7 +104,7 @@ Ensure:
|
|
|
104
104
|
|
|
105
105
|
Present to the user:
|
|
106
106
|
|
|
107
|
-
```
|
|
107
|
+
```text
|
|
108
108
|
✅ Agent Created: [agent-name]
|
|
109
109
|
Location: .bmad-core/agents/[agent-id].md
|
|
110
110
|
|
|
@@ -136,23 +136,21 @@ The agent template structure:
|
|
|
136
136
|
|
|
137
137
|
## Example Usage
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
````yaml
|
|
140
140
|
agent:
|
|
141
141
|
name: Data Analyst
|
|
142
142
|
id: data-analyst
|
|
143
143
|
title: Data Analysis Specialist
|
|
144
|
-
|
|
145
144
|
persona:
|
|
146
145
|
role: Expert in data analysis, visualization, and insights extraction
|
|
147
146
|
style: analytical, data-driven, clear, methodical
|
|
148
147
|
identity: I am a seasoned data analyst who transforms raw data into actionable insights
|
|
149
148
|
focus: data exploration, statistical analysis, visualization, reporting
|
|
150
|
-
|
|
151
149
|
core_principles:
|
|
152
150
|
- Data integrity and accuracy above all
|
|
153
151
|
- Clear communication of complex findings
|
|
154
152
|
- Actionable insights over raw numbers
|
|
155
|
-
```
|
|
153
|
+
```text
|
|
156
154
|
|
|
157
155
|
## Creating Missing Dependencies
|
|
158
156
|
|
|
@@ -185,13 +183,13 @@ When a required task or template doesn't exist:
|
|
|
185
183
|
```yaml
|
|
186
184
|
dependencies:
|
|
187
185
|
tasks:
|
|
188
|
-
- create-doc # Required if agent creates any documents
|
|
189
|
-
- analyze-requirements # Custom task for this agent
|
|
190
|
-
- generate-report # Another custom task
|
|
186
|
+
- 'create-doc # Required if agent creates any documents'
|
|
187
|
+
- 'analyze-requirements # Custom task for this agent'
|
|
188
|
+
- 'generate-report # Another custom task'
|
|
191
189
|
templates:
|
|
192
|
-
- requirements-doc # Template for requirements documents
|
|
193
|
-
- analysis-report # Template for analysis reports
|
|
194
|
-
|
|
190
|
+
- 'requirements-doc # Template for requirements documents'
|
|
191
|
+
- 'analysis-report # Template for analysis reports'
|
|
192
|
+
````
|
|
195
193
|
|
|
196
194
|
## Notes
|
|
197
195
|
|
package/{.bmad-core/tasks/create-expansion-pack.md → creator-tools/tasks/generate-expansion-pack.md}
RENAMED
|
@@ -43,7 +43,7 @@ IMPORTANT: STOP HERE AND CREATE PLAN FIRST
|
|
|
43
43
|
|
|
44
44
|
Create `expansion-packs/{pack-name}/plan.md` with:
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
````markdown
|
|
47
47
|
# {Pack Name} Expansion Pack Plan
|
|
48
48
|
|
|
49
49
|
## Overview
|
|
@@ -83,7 +83,8 @@ Create `expansion-packs/{pack-name}/plan.md` with:
|
|
|
83
83
|
## Approval
|
|
84
84
|
|
|
85
85
|
User approval received: [ ] Yes
|
|
86
|
-
|
|
86
|
+
|
|
87
|
+
````text
|
|
87
88
|
|
|
88
89
|
Important: Wait for user approval before proceeding to Phase 2
|
|
89
90
|
|
|
@@ -167,13 +168,14 @@ expansion-packs/
|
|
|
167
168
|
└── ide-agents/
|
|
168
169
|
├── {pack-name}-orchestrator.ide.md (REQUIRED)
|
|
169
170
|
└── {agent-id}.ide.md
|
|
170
|
-
|
|
171
|
+
````
|
|
172
|
+
````
|
|
171
173
|
|
|
172
174
|
#### 3.2 Create Manifest
|
|
173
175
|
|
|
174
176
|
Create `manifest.yml`:
|
|
175
177
|
|
|
176
|
-
|
|
178
|
+
````yaml
|
|
177
179
|
name: {pack-name}
|
|
178
180
|
version: 1.0.0
|
|
179
181
|
description: >-
|
|
@@ -223,7 +225,7 @@ post_install_message: |
|
|
|
223
225
|
- {data-file}.{ext}: {description}
|
|
224
226
|
|
|
225
227
|
To use: npm run agent {pack-name}-orchestrator
|
|
226
|
-
```
|
|
228
|
+
```text
|
|
227
229
|
|
|
228
230
|
### Phase 4: Content Creation
|
|
229
231
|
|
|
@@ -306,7 +308,7 @@ For each required data file:
|
|
|
306
308
|
- **Format**: {file format and structure}
|
|
307
309
|
- **Location**: Place in `bmad-core/data/`
|
|
308
310
|
- **Example**:
|
|
309
|
-
|
|
311
|
+
````
|
|
310
312
|
|
|
311
313
|
## Example: Healthcare Expansion Pack
|
|
312
314
|
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# BMAD Method Universal Workflow Guide
|
|
2
|
+
|
|
3
|
+
This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The BMAD Method follows a structured approach to AI-assisted software development:
|
|
8
|
+
|
|
9
|
+
1. **Install BMAD** in your project
|
|
10
|
+
2. **Plan with Gemini** using team-fullstack
|
|
11
|
+
3. **Organize with bmad-master** (document sharding)
|
|
12
|
+
4. **Develop iteratively** with SM → Dev cycles
|
|
13
|
+
|
|
14
|
+
## The Complete Workflow
|
|
15
|
+
|
|
16
|
+
### Phase 1: Project Setup
|
|
17
|
+
|
|
18
|
+
1. **Install BMAD in your project**:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx bmad-method install
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
- Choose "Complete installation"
|
|
25
|
+
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
|
26
|
+
|
|
27
|
+
2. **Verify installation**:
|
|
28
|
+
- `.bmad-core/` folder created with all agents
|
|
29
|
+
- IDE-specific integration files created
|
|
30
|
+
- All agent commands/rules/modes available
|
|
31
|
+
|
|
32
|
+
### Phase 2: Ideation & Planning (Gemini)
|
|
33
|
+
|
|
34
|
+
Use Google's Gemini for collaborative planning with the full team:
|
|
35
|
+
|
|
36
|
+
1. **Open [Google AI Studio](https://aistudio.google.com/)**
|
|
37
|
+
2. **Load team-fullstack**:
|
|
38
|
+
- Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
39
|
+
- Paste into new Gemini chat
|
|
40
|
+
3. **Collaborate with the team**:
|
|
41
|
+
- Business Analyst: Requirements gathering
|
|
42
|
+
- Product Manager: Feature prioritization
|
|
43
|
+
- Solution Architect: Technical design
|
|
44
|
+
- UX Expert: User experience design
|
|
45
|
+
|
|
46
|
+
### Example Gemini Sessions:
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
"I want to build a [type] application that [core purpose].
|
|
50
|
+
Help me brainstorm features and create a comprehensive PRD."
|
|
51
|
+
|
|
52
|
+
"Based on this PRD, design a scalable technical architecture
|
|
53
|
+
that can handle [specific requirements]."
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
4. **Export planning documents**:
|
|
57
|
+
- Save PRD as `docs/prd.md`
|
|
58
|
+
- Save architecture as `docs/architecture.md`
|
|
59
|
+
|
|
60
|
+
### Phase 3: Document Organization (IDE)
|
|
61
|
+
|
|
62
|
+
Switch back to your IDE for document management:
|
|
63
|
+
|
|
64
|
+
1. **Load bmad-master agent** (syntax varies by IDE)
|
|
65
|
+
2. **Shard the PRD**:
|
|
66
|
+
```
|
|
67
|
+
*shard-doc docs/prd.md prd
|
|
68
|
+
```
|
|
69
|
+
3. **Shard the architecture**:
|
|
70
|
+
```
|
|
71
|
+
*shard-doc docs/architecture.md architecture
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**Result**: Organized folder structure:
|
|
75
|
+
|
|
76
|
+
- `docs/prd/` - Broken down PRD sections
|
|
77
|
+
- `docs/architecture/` - Broken down architecture sections
|
|
78
|
+
|
|
79
|
+
### Phase 4: Iterative Development
|
|
80
|
+
|
|
81
|
+
Follow the SM → Dev cycle for systematic story development:
|
|
82
|
+
|
|
83
|
+
#### Story Creation (Scrum Master)
|
|
84
|
+
|
|
85
|
+
1. **Start new chat/conversation**
|
|
86
|
+
2. **Load SM agent**
|
|
87
|
+
3. **Execute**: `*create` (runs create-next-story task)
|
|
88
|
+
4. **Review generated story** in `docs/stories/`
|
|
89
|
+
5. **Update status**: Change from "Draft" to "Approved"
|
|
90
|
+
|
|
91
|
+
#### Story Implementation (Developer)
|
|
92
|
+
|
|
93
|
+
1. **Start new chat/conversation**
|
|
94
|
+
2. **Load Dev agent**
|
|
95
|
+
3. **Agent asks**: Which story to implement
|
|
96
|
+
4. **Follow development tasks**
|
|
97
|
+
5. **Complete implementation**
|
|
98
|
+
6. **Update status**: Change to "Done"
|
|
99
|
+
|
|
100
|
+
#### Repeat Until Complete
|
|
101
|
+
|
|
102
|
+
- **SM**: Create next story → Review → Approve
|
|
103
|
+
- **Dev**: Implement story → Complete → Mark done
|
|
104
|
+
- **Continue**: Until all features implemented
|
|
105
|
+
|
|
106
|
+
## IDE-Specific Syntax
|
|
107
|
+
|
|
108
|
+
### Agent Loading Syntax by IDE:
|
|
109
|
+
|
|
110
|
+
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
111
|
+
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
112
|
+
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
113
|
+
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
114
|
+
|
|
115
|
+
### Chat Management:
|
|
116
|
+
|
|
117
|
+
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
118
|
+
- **Roo Code**: Switch modes within the same conversation
|
|
119
|
+
|
|
120
|
+
## Available Agents
|
|
121
|
+
|
|
122
|
+
### Core Development Agents:
|
|
123
|
+
|
|
124
|
+
- **bmad-master**: Universal task executor, document management
|
|
125
|
+
- **sm**: Scrum Master for story creation and agile process
|
|
126
|
+
- **dev**: Full-stack developer for implementation
|
|
127
|
+
- **architect**: Solution architect for technical design
|
|
128
|
+
|
|
129
|
+
### Specialized Agents:
|
|
130
|
+
|
|
131
|
+
- **pm**: Product manager for planning and prioritization
|
|
132
|
+
- **analyst**: Business analyst for requirements
|
|
133
|
+
- **qa**: QA specialist for testing strategies
|
|
134
|
+
- **po**: Product owner for backlog management
|
|
135
|
+
- **ux-expert**: UX specialist for design
|
|
136
|
+
|
|
137
|
+
## Key Principles
|
|
138
|
+
|
|
139
|
+
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
|
140
|
+
2. **Clean Handoffs**: Always start fresh when switching between agents
|
|
141
|
+
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
|
142
|
+
4. **Iterative Development**: Complete one story before starting the next
|
|
143
|
+
5. **Documentation First**: Always start with solid PRD and architecture
|
|
144
|
+
|
|
145
|
+
## Common Commands
|
|
146
|
+
|
|
147
|
+
Every agent supports these core commands:
|
|
148
|
+
|
|
149
|
+
- `*help` - Show available commands
|
|
150
|
+
- `*status` - Show current context/progress
|
|
151
|
+
- `*exit` - Exit the agent mode
|
|
152
|
+
|
|
153
|
+
## Success Tips
|
|
154
|
+
|
|
155
|
+
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
156
|
+
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
157
|
+
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
158
|
+
- **Keep conversations focused** - One agent, one task per conversation
|
|
159
|
+
- **Review everything** - Always review and approve before marking complete
|
|
160
|
+
|
|
161
|
+
This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.
|