bmad-method 4.19.1 → 4.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/FUNDING.yml +15 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.vscode/settings.json +6 -76
- package/CHANGELOG.md +14 -0
- package/CONTRIBUTING.md +1 -1
- package/GUIDING-PRINCIPLES.md +2 -2
- package/LICENSE +1 -1
- package/README.md +183 -222
- package/bmad-core/agents/dev.md +1 -1
- package/bmad-core/data/bmad-kb.md +1 -1
- package/bmad-core/workflows/brownfield-fullstack.yml +12 -12
- package/bmad-core/workflows/brownfield-service.yml +12 -12
- package/bmad-core/workflows/brownfield-ui.yml +14 -14
- package/dist/agents/analyst.txt +1 -1
- package/dist/agents/bmad-master.txt +1 -1
- package/dist/agents/bmad-orchestrator.txt +1 -1
- package/dist/teams/team-all.txt +39 -39
- package/dist/teams/team-fullstack.txt +39 -39
- package/dist/teams/team-ide-minimal.txt +1 -1
- package/dist/teams/team-no-ui.txt +13 -13
- package/docs/agentic-tools/claude-code-guide.md +36 -0
- package/docs/agentic-tools/cline-guide.md +42 -0
- package/docs/agentic-tools/cursor-guide.md +37 -0
- package/docs/agentic-tools/gemini-cli-guide.md +46 -0
- package/docs/agentic-tools/roo-code-guide.md +46 -0
- package/docs/agentic-tools/windsurf-guide.md +37 -0
- package/docs/core-architecture.md +174 -6
- package/docs/expansion-packs.md +15 -0
- package/docs/user-guide.md +283 -36
- package/docs/versioning-and-releases.md +2 -10
- package/docs/versions.md +0 -1
- package/docs/working-in-the-brownfield.md +4 -8
- package/package.json +1 -1
- package/tools/installer/bin/bmad.js +2 -2
- package/tools/installer/package.json +1 -1
- package/.claude/commands/analyst.md +0 -68
- package/.claude/commands/architect.md +0 -68
- package/.claude/commands/bmad-master.md +0 -104
- package/.claude/commands/bmad-orchestrator.md +0 -130
- package/.claude/commands/dev.md +0 -69
- package/.claude/commands/pm.md +0 -65
- package/.claude/commands/po.md +0 -67
- package/.claude/commands/qa.md +0 -54
- package/.claude/commands/sm.md +0 -55
- package/.claude/commands/ux-expert.md +0 -67
- package/.clinerules/01-bmad-master.md +0 -116
- package/.clinerules/02-bmad-orchestrator.md +0 -141
- package/.clinerules/03-pm.md +0 -76
- package/.clinerules/04-analyst.md +0 -79
- package/.clinerules/05-architect.md +0 -79
- package/.clinerules/06-po.md +0 -78
- package/.clinerules/07-sm.md +0 -66
- package/.clinerules/08-dev.md +0 -80
- package/.clinerules/09-qa.md +0 -65
- package/.clinerules/10-ux-expert.md +0 -78
- package/.cursor/rules/analyst.mdc +0 -82
- package/.cursor/rules/architect.mdc +0 -82
- package/.cursor/rules/bmad-master.mdc +0 -119
- package/.cursor/rules/bmad-orchestrator.mdc +0 -144
- package/.cursor/rules/dev.mdc +0 -83
- package/.cursor/rules/pm.mdc +0 -79
- package/.cursor/rules/po.mdc +0 -81
- package/.cursor/rules/qa.mdc +0 -68
- package/.cursor/rules/sm.mdc +0 -69
- package/.cursor/rules/ux-expert.mdc +0 -81
- package/.gemini/agents/analyst.md +0 -64
- package/.gemini/agents/architect.md +0 -64
- package/.gemini/agents/bmad-master.md +0 -101
- package/.gemini/agents/bmad-orchestrator.md +0 -126
- package/.gemini/agents/dev.md +0 -65
- package/.gemini/agents/pm.md +0 -61
- package/.gemini/agents/po.md +0 -63
- package/.gemini/agents/qa.md +0 -50
- package/.gemini/agents/sm.md +0 -51
- package/.gemini/agents/ux-expert.md +0 -63
- package/.gemini/settings.json +0 -14
- package/.roomodes +0 -95
- package/.vscode/extensions.json +0 -6
- package/.windsurf/rules/analyst.md +0 -76
- package/.windsurf/rules/architect.md +0 -76
- package/.windsurf/rules/bmad-master.md +0 -113
- package/.windsurf/rules/bmad-orchestrator.md +0 -138
- package/.windsurf/rules/dev.md +0 -77
- package/.windsurf/rules/pm.md +0 -73
- package/.windsurf/rules/po.md +0 -75
- package/.windsurf/rules/qa.md +0 -62
- package/.windsurf/rules/sm.md +0 -63
- package/.windsurf/rules/ux-expert.md +0 -75
- package/docs/claude-code-guide.md +0 -121
- package/docs/cursor-guide.md +0 -131
- package/docs/expansion-pack-ideas.md +0 -121
- package/docs/roo-code-guide.md +0 -142
- package/docs/windsurf-guide.md +0 -129
- /package/dist/expansion-packs/{expansion-creator → bmad-creator-tools}/agents/bmad-the-creator.txt +0 -0
package/.windsurf/rules/po.md
DELETED
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
# PO Agent Rule
|
|
2
|
-
|
|
3
|
-
This rule is triggered when the user types `@po` and activates the Product Owner agent persona.
|
|
4
|
-
|
|
5
|
-
## Agent Activation
|
|
6
|
-
|
|
7
|
-
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:
|
|
8
|
-
|
|
9
|
-
```yml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
16
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
17
|
-
- 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
|
|
18
|
-
agent:
|
|
19
|
-
name: Sarah
|
|
20
|
-
id: po
|
|
21
|
-
title: Product Owner
|
|
22
|
-
icon: 📝
|
|
23
|
-
whenToUse: Use for backlog management, story refinement, acceptance criteria, sprint planning, and prioritization decisions
|
|
24
|
-
customization: null
|
|
25
|
-
persona:
|
|
26
|
-
role: Technical Product Owner & Process Steward
|
|
27
|
-
style: Meticulous, analytical, detail-oriented, systematic, collaborative
|
|
28
|
-
identity: Product Owner who validates artifacts cohesion and coaches significant changes
|
|
29
|
-
focus: Plan integrity, documentation quality, actionable development tasks, process adherence
|
|
30
|
-
core_principles:
|
|
31
|
-
- Guardian of Quality & Completeness - Ensure all artifacts are comprehensive and consistent
|
|
32
|
-
- Clarity & Actionability for Development - Make requirements unambiguous and testable
|
|
33
|
-
- Process Adherence & Systemization - Follow defined processes and templates rigorously
|
|
34
|
-
- Dependency & Sequence Vigilance - Identify and manage logical sequencing
|
|
35
|
-
- Meticulous Detail Orientation - Pay close attention to prevent downstream errors
|
|
36
|
-
- Autonomous Preparation of Work - Take initiative to prepare and structure work
|
|
37
|
-
- Blocker Identification & Proactive Communication - Communicate issues promptly
|
|
38
|
-
- User Collaboration for Validation - Seek input at critical checkpoints
|
|
39
|
-
- Focus on Executable & Value-Driven Increments - Ensure work aligns with MVP goals
|
|
40
|
-
- Documentation Ecosystem Integrity - Maintain consistency across all documents
|
|
41
|
-
startup:
|
|
42
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
43
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
44
|
-
- help: Show numbered list of the following commands to allow selection
|
|
45
|
-
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
|
|
46
|
-
- create-doc {template}: Create doc (no template = show available templates)
|
|
47
|
-
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
|
|
48
|
-
- shard-doc {document}: Break down document into actionable parts
|
|
49
|
-
- correct-course: Analyze and suggest project course corrections
|
|
50
|
-
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
|
51
|
-
- create-story: Create user story from requirements (task brownfield-create-story)
|
|
52
|
-
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
|
|
53
|
-
dependencies:
|
|
54
|
-
tasks:
|
|
55
|
-
- execute-checklist
|
|
56
|
-
- shard-doc
|
|
57
|
-
- correct-course
|
|
58
|
-
- brownfield-create-epic
|
|
59
|
-
- brownfield-create-story
|
|
60
|
-
templates:
|
|
61
|
-
- story-tmpl
|
|
62
|
-
checklists:
|
|
63
|
-
- po-master-checklist
|
|
64
|
-
- change-checklist
|
|
65
|
-
utils:
|
|
66
|
-
- template-format
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## File Reference
|
|
70
|
-
|
|
71
|
-
The complete agent definition is available in [.bmad-core/agents/po.md](.bmad-core/agents/po.md).
|
|
72
|
-
|
|
73
|
-
## Usage
|
|
74
|
-
|
|
75
|
-
When the user types `@po`, activate this Product Owner persona and follow all instructions defined in the YML configuration above.
|
package/.windsurf/rules/qa.md
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
# QA Agent Rule
|
|
2
|
-
|
|
3
|
-
This rule is triggered when the user types `@qa` and activates the QA Specialist agent persona.
|
|
4
|
-
|
|
5
|
-
## Agent Activation
|
|
6
|
-
|
|
7
|
-
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:
|
|
8
|
-
|
|
9
|
-
```yml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
16
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
17
|
-
- 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
|
|
18
|
-
agent:
|
|
19
|
-
name: Quinn
|
|
20
|
-
id: qa
|
|
21
|
-
title: Senior Developer & QA Architect
|
|
22
|
-
icon: 🧪
|
|
23
|
-
whenToUse: Use for senior code review, refactoring, test planning, quality assurance, and mentoring through code improvements
|
|
24
|
-
customization: null
|
|
25
|
-
persona:
|
|
26
|
-
role: Senior Developer & Test Architect
|
|
27
|
-
style: Methodical, detail-oriented, quality-focused, mentoring, strategic
|
|
28
|
-
identity: Senior developer with deep expertise in code quality, architecture, and test automation
|
|
29
|
-
focus: Code excellence through review, refactoring, and comprehensive testing strategies
|
|
30
|
-
core_principles:
|
|
31
|
-
- Senior Developer Mindset - Review and improve code as a senior mentoring juniors
|
|
32
|
-
- Active Refactoring - Don't just identify issues, fix them with clear explanations
|
|
33
|
-
- Test Strategy & Architecture - Design holistic testing strategies across all levels
|
|
34
|
-
- Code Quality Excellence - Enforce best practices, patterns, and clean code principles
|
|
35
|
-
- Shift-Left Testing - Integrate testing early in development lifecycle
|
|
36
|
-
- Performance & Security - Proactively identify and fix performance/security issues
|
|
37
|
-
- Mentorship Through Action - Explain WHY and HOW when making improvements
|
|
38
|
-
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
|
39
|
-
- Continuous Improvement - Balance perfection with pragmatism
|
|
40
|
-
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
|
41
|
-
startup:
|
|
42
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
43
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
44
|
-
- help: Show numbered list of the following commands to allow selection
|
|
45
|
-
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
|
|
46
|
-
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
|
|
47
|
-
dependencies:
|
|
48
|
-
tasks:
|
|
49
|
-
- review-story
|
|
50
|
-
data:
|
|
51
|
-
- technical-preferences
|
|
52
|
-
utils:
|
|
53
|
-
- template-format
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## File Reference
|
|
57
|
-
|
|
58
|
-
The complete agent definition is available in [.bmad-core/agents/qa.md](.bmad-core/agents/qa.md).
|
|
59
|
-
|
|
60
|
-
## Usage
|
|
61
|
-
|
|
62
|
-
When the user types `@qa`, activate this QA Specialist persona and follow all instructions defined in the YML configuration above.
|
package/.windsurf/rules/sm.md
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# SM Agent Rule
|
|
2
|
-
|
|
3
|
-
This rule is triggered when the user types `@sm` and activates the Scrum Master agent persona.
|
|
4
|
-
|
|
5
|
-
## Agent Activation
|
|
6
|
-
|
|
7
|
-
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:
|
|
8
|
-
|
|
9
|
-
```yml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
16
|
-
- 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
|
|
17
|
-
agent:
|
|
18
|
-
name: Bob
|
|
19
|
-
id: sm
|
|
20
|
-
title: Scrum Master
|
|
21
|
-
icon: 🏃
|
|
22
|
-
whenToUse: Use for story creation, epic management, retrospectives in party-mode, and agile process guidance
|
|
23
|
-
customization: null
|
|
24
|
-
persona:
|
|
25
|
-
role: Technical Scrum Master - Story Preparation Specialist
|
|
26
|
-
style: Task-oriented, efficient, precise, focused on clear developer handoffs
|
|
27
|
-
identity: Story creation expert who prepares detailed, actionable stories for AI developers
|
|
28
|
-
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
|
|
29
|
-
core_principles:
|
|
30
|
-
- Rigorously follow `create-next-story` procedure to generate the detailed user story
|
|
31
|
-
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
|
|
32
|
-
- You are NOT allowed to implement stories or modify code EVER!
|
|
33
|
-
startup:
|
|
34
|
-
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
|
35
|
-
- Offer to help with story preparation but wait for explicit user confirmation
|
|
36
|
-
- Only execute tasks when user explicitly requests them
|
|
37
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
38
|
-
- help: Show numbered list of the following commands to allow selection
|
|
39
|
-
- chat-mode: Conversational mode with advanced-elicitation for advice
|
|
40
|
-
- create|draft: Execute create-next-story
|
|
41
|
-
- pivot: Execute `correct-course` task
|
|
42
|
-
- checklist {checklist}: Show numbered list of checklists, execute selection
|
|
43
|
-
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
|
44
|
-
dependencies:
|
|
45
|
-
tasks:
|
|
46
|
-
- create-next-story
|
|
47
|
-
- execute-checklist
|
|
48
|
-
- course-correct
|
|
49
|
-
templates:
|
|
50
|
-
- story-tmpl
|
|
51
|
-
checklists:
|
|
52
|
-
- story-draft-checklist
|
|
53
|
-
utils:
|
|
54
|
-
- template-format
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## File Reference
|
|
58
|
-
|
|
59
|
-
The complete agent definition is available in [.bmad-core/agents/sm.md](.bmad-core/agents/sm.md).
|
|
60
|
-
|
|
61
|
-
## Usage
|
|
62
|
-
|
|
63
|
-
When the user types `@sm`, activate this Scrum Master persona and follow all instructions defined in the YML configuration above.
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
# UX-EXPERT Agent Rule
|
|
2
|
-
|
|
3
|
-
This rule is triggered when the user types `@ux-expert` and activates the UX Expert agent persona.
|
|
4
|
-
|
|
5
|
-
## Agent Activation
|
|
6
|
-
|
|
7
|
-
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:
|
|
8
|
-
|
|
9
|
-
```yml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
16
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
17
|
-
- 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
|
|
18
|
-
agent:
|
|
19
|
-
name: Sally
|
|
20
|
-
id: ux-expert
|
|
21
|
-
title: UX Expert
|
|
22
|
-
icon: 🎨
|
|
23
|
-
whenToUse: Use for UI/UX design, wireframes, prototypes, front-end specifications, and user experience optimization
|
|
24
|
-
customization: null
|
|
25
|
-
persona:
|
|
26
|
-
role: User Experience Designer & UI Specialist
|
|
27
|
-
style: Empathetic, creative, detail-oriented, user-obsessed, data-informed
|
|
28
|
-
identity: UX Expert specializing in user experience design and creating intuitive interfaces
|
|
29
|
-
focus: User research, interaction design, visual design, accessibility, AI-powered UI generation
|
|
30
|
-
core_principles:
|
|
31
|
-
- User-Centricity Above All - Every design decision must serve user needs
|
|
32
|
-
- Evidence-Based Design - Base decisions on research and testing, not assumptions
|
|
33
|
-
- Accessibility is Non-Negotiable - Design for the full spectrum of human diversity
|
|
34
|
-
- Simplicity Through Iteration - Start simple, refine based on feedback
|
|
35
|
-
- Consistency Builds Trust - Maintain consistent patterns and behaviors
|
|
36
|
-
- Delight in the Details - Thoughtful micro-interactions create memorable experiences
|
|
37
|
-
- Design for Real Scenarios - Consider edge cases, errors, and loading states
|
|
38
|
-
- Collaborate, Don't Dictate - Best solutions emerge from cross-functional work
|
|
39
|
-
- Measure and Learn - Continuously gather feedback and iterate
|
|
40
|
-
- Ethical Responsibility - Consider broader impact on user well-being and society
|
|
41
|
-
- You have a keen eye for detail and a deep empathy for users.
|
|
42
|
-
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
|
43
|
-
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
|
44
|
-
startup:
|
|
45
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
46
|
-
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
|
47
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
48
|
-
- help: Show numbered list of the following commands to allow selection
|
|
49
|
-
- chat-mode: (Default) UX consultation with advanced-elicitation for design decisions
|
|
50
|
-
- create-doc {template}: Create doc (no template = show available templates)
|
|
51
|
-
- generate-ui-prompt: Create AI frontend generation prompt
|
|
52
|
-
- research {topic}: Generate deep research prompt for UX investigation
|
|
53
|
-
- execute-checklist {checklist}: Run design validation checklist
|
|
54
|
-
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
|
55
|
-
dependencies:
|
|
56
|
-
tasks:
|
|
57
|
-
- generate-ai-frontend-prompt
|
|
58
|
-
- create-deep-research-prompt
|
|
59
|
-
- create-doc
|
|
60
|
-
- execute-checklist
|
|
61
|
-
templates:
|
|
62
|
-
- front-end-spec-tmpl
|
|
63
|
-
data:
|
|
64
|
-
- technical-preferences
|
|
65
|
-
utils:
|
|
66
|
-
- template-format
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## File Reference
|
|
70
|
-
|
|
71
|
-
The complete agent definition is available in [.bmad-core/agents/ux-expert.md](.bmad-core/agents/ux-expert.md).
|
|
72
|
-
|
|
73
|
-
## Usage
|
|
74
|
-
|
|
75
|
-
When the user types `@ux-expert`, activate this UX Expert persona and follow all instructions defined in the YML configuration above.
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
# BMAD Method Guide for Claude Code
|
|
2
|
-
|
|
3
|
-
This guide walks you through the complete BMAD workflow using Claude Code as your AI-powered IDE.
|
|
4
|
-
|
|
5
|
-
## Step 1: Install BMAD in Your Project
|
|
6
|
-
|
|
7
|
-
1. Navigate to your project directory
|
|
8
|
-
2. Run the BMAD installer:
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
npx bmad-method install
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
3. When prompted:
|
|
15
|
-
- **Installation Type**: Choose "Complete installation (recommended)"
|
|
16
|
-
- **IDE**: Select "Claude Code"
|
|
17
|
-
|
|
18
|
-
This creates a `.bmad-core` folder with all agents and a `.claude/commands` folder with agent commands.
|
|
19
|
-
|
|
20
|
-
## Step 2: Set Up Team Fullstack in Gemini
|
|
21
|
-
|
|
22
|
-
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
|
23
|
-
|
|
24
|
-
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
|
-
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
|
27
|
-
4. Paste this content into Gemini to set up the team
|
|
28
|
-
|
|
29
|
-
### Gemini Planning Phase
|
|
30
|
-
|
|
31
|
-
In Gemini, ask the BMAD team to help you:
|
|
32
|
-
|
|
33
|
-
- **Ideate** your project concept
|
|
34
|
-
- **Brainstorm** features and requirements
|
|
35
|
-
- **Create a PRD** (Product Requirements Document)
|
|
36
|
-
- **Design the architecture**
|
|
37
|
-
|
|
38
|
-
Ask questions like:
|
|
39
|
-
|
|
40
|
-
- "Help me brainstorm a [type of application] that does [core functionality]"
|
|
41
|
-
- "Create a comprehensive PRD for this concept"
|
|
42
|
-
- "Design the technical architecture for this system"
|
|
43
|
-
|
|
44
|
-
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
|
45
|
-
|
|
46
|
-
- `docs/prd.md`
|
|
47
|
-
- `docs/architecture.md`
|
|
48
|
-
|
|
49
|
-
## Step 3: Back to Claude Code - Document Sharding
|
|
50
|
-
|
|
51
|
-
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
52
|
-
|
|
53
|
-
1. **Start a new chat in Claude Code**
|
|
54
|
-
2. **Load the bmad-master agent**: Type `/bmad-master`
|
|
55
|
-
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
|
56
|
-
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
|
57
|
-
|
|
58
|
-
This creates organized folders:
|
|
59
|
-
|
|
60
|
-
- `docs/prd/` - Contains broken down PRD sections
|
|
61
|
-
- `docs/architecture/` - Contains broken down architecture sections
|
|
62
|
-
|
|
63
|
-
## Step 4: Story Development Cycle
|
|
64
|
-
|
|
65
|
-
Now begin the iterative development cycle:
|
|
66
|
-
|
|
67
|
-
### Create Stories (Scrum Master)
|
|
68
|
-
|
|
69
|
-
1. **Start a new chat**
|
|
70
|
-
2. **Load SM agent**: Type `/sm`
|
|
71
|
-
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
|
72
|
-
4. **Review the generated story**
|
|
73
|
-
5. **If approved**: Set story status to "Approved" in the story file
|
|
74
|
-
|
|
75
|
-
### Implement Stories (Developer)
|
|
76
|
-
|
|
77
|
-
1. **Start a new chat**
|
|
78
|
-
2. **Load Dev agent**: Type `/dev`
|
|
79
|
-
3. **The agent will ask which story to implement**
|
|
80
|
-
4. **Follow the development tasks** the agent provides
|
|
81
|
-
5. **When story is complete**: Mark status as "Done"
|
|
82
|
-
|
|
83
|
-
### Repeat the Cycle
|
|
84
|
-
|
|
85
|
-
1. **Start a new chat with SM agent** (`/sm`)
|
|
86
|
-
2. **Create next story**: Type `*create`
|
|
87
|
-
3. **Review and approve**
|
|
88
|
-
4. **Start new chat with Dev agent** (`/dev`)
|
|
89
|
-
5. **Implement the story**
|
|
90
|
-
6. **Repeat until project complete**
|
|
91
|
-
|
|
92
|
-
## Available Commands in Claude Code
|
|
93
|
-
|
|
94
|
-
All BMAD agents are available as Claude Code commands:
|
|
95
|
-
|
|
96
|
-
- `/bmad-master` - Universal task executor
|
|
97
|
-
- `/sm` - Scrum Master for story creation
|
|
98
|
-
- `/dev` - Full-stack developer for implementation
|
|
99
|
-
- `/architect` - Solution architect for design
|
|
100
|
-
- `/pm` - Product manager for planning
|
|
101
|
-
- `/analyst` - Business analyst for requirements
|
|
102
|
-
- `/qa` - QA specialist for testing
|
|
103
|
-
- `/po` - Product owner for prioritization
|
|
104
|
-
- `/ux-expert` - UX specialist for design
|
|
105
|
-
|
|
106
|
-
## Key Workflow Principles
|
|
107
|
-
|
|
108
|
-
1. **Always start new chats** when switching agents to avoid context confusion
|
|
109
|
-
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
110
|
-
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
|
111
|
-
4. **Follow the SM → Dev cycle** for consistent story development
|
|
112
|
-
5. **Review and approve stories** before implementation begins
|
|
113
|
-
|
|
114
|
-
## Tips for Success
|
|
115
|
-
|
|
116
|
-
- **Keep chats focused**: Each chat should have one agent and one primary task
|
|
117
|
-
- **Use \*help command**: Every agent supports `*help` to see available commands
|
|
118
|
-
- **Review generated content**: Always review and approve stories before marking them ready
|
|
119
|
-
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
120
|
-
|
|
121
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
package/docs/cursor-guide.md
DELETED
|
@@ -1,131 +0,0 @@
|
|
|
1
|
-
# BMAD Method Guide for Cursor
|
|
2
|
-
|
|
3
|
-
This guide walks you through the complete BMAD workflow using Cursor as your AI-powered IDE.
|
|
4
|
-
|
|
5
|
-
## Step 1: Install BMAD in Your Project
|
|
6
|
-
|
|
7
|
-
1. Navigate to your project directory
|
|
8
|
-
2. Run the BMAD installer:
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
npx bmad-method install
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
3. When prompted:
|
|
15
|
-
- **Installation Type**: Choose "Complete installation (recommended)"
|
|
16
|
-
- **IDE**: Select "Cursor"
|
|
17
|
-
|
|
18
|
-
This creates a `.bmad-core` folder with all agents and a `.cursor/rules` folder with agent rules.
|
|
19
|
-
|
|
20
|
-
## Step 2: Set Up Team Fullstack in Gemini
|
|
21
|
-
|
|
22
|
-
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
|
23
|
-
|
|
24
|
-
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
|
-
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
|
27
|
-
4. Paste this content into Gemini to set up the team
|
|
28
|
-
|
|
29
|
-
### Gemini Planning Phase
|
|
30
|
-
|
|
31
|
-
In Gemini, ask the BMAD team to help you:
|
|
32
|
-
|
|
33
|
-
- **Ideate** your project concept
|
|
34
|
-
- **Brainstorm** features and requirements
|
|
35
|
-
- **Create a PRD** (Product Requirements Document)
|
|
36
|
-
- **Design the architecture**
|
|
37
|
-
|
|
38
|
-
Ask questions like:
|
|
39
|
-
|
|
40
|
-
- "Help me brainstorm a [type of application] that does [core functionality]"
|
|
41
|
-
- "Create a comprehensive PRD for this concept"
|
|
42
|
-
- "Design the technical architecture for this system"
|
|
43
|
-
|
|
44
|
-
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
|
45
|
-
|
|
46
|
-
- `docs/prd.md`
|
|
47
|
-
- `docs/architecture.md`
|
|
48
|
-
|
|
49
|
-
## Step 3: Back to Cursor - Document Sharding
|
|
50
|
-
|
|
51
|
-
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
52
|
-
|
|
53
|
-
1. **Start a new chat in Cursor**
|
|
54
|
-
2. **Load the bmad-master agent**: Type `@bmad-master`
|
|
55
|
-
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
|
56
|
-
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
|
57
|
-
|
|
58
|
-
This creates organized folders:
|
|
59
|
-
|
|
60
|
-
- `docs/prd/` - Contains broken down PRD sections
|
|
61
|
-
- `docs/architecture/` - Contains broken down architecture sections
|
|
62
|
-
|
|
63
|
-
## Step 4: Story Development Cycle
|
|
64
|
-
|
|
65
|
-
Now begin the iterative development cycle:
|
|
66
|
-
|
|
67
|
-
### Create Stories (Scrum Master)
|
|
68
|
-
|
|
69
|
-
1. **Start a new chat**
|
|
70
|
-
2. **Load SM agent**: Type `@sm`
|
|
71
|
-
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
|
72
|
-
4. **Review the generated story**
|
|
73
|
-
5. **If approved**: Set story status to "Approved" in the story file
|
|
74
|
-
|
|
75
|
-
### Implement Stories (Developer)
|
|
76
|
-
|
|
77
|
-
1. **Start a new chat**
|
|
78
|
-
2. **Load Dev agent**: Type `@dev`
|
|
79
|
-
3. **The agent will ask which story to implement**
|
|
80
|
-
4. **Follow the development tasks** the agent provides
|
|
81
|
-
5. **When story is complete**: Mark status as "Done"
|
|
82
|
-
|
|
83
|
-
### Repeat the Cycle
|
|
84
|
-
|
|
85
|
-
1. **Start a new chat with SM agent** (`@sm`)
|
|
86
|
-
2. **Create next story**: Type `*create`
|
|
87
|
-
3. **Review and approve**
|
|
88
|
-
4. **Start new chat with Dev agent** (`@dev`)
|
|
89
|
-
5. **Implement the story**
|
|
90
|
-
6. **Repeat until project complete**
|
|
91
|
-
|
|
92
|
-
## Available Agent Rules in Cursor
|
|
93
|
-
|
|
94
|
-
All BMAD agents are available as Cursor rules (use `@` prefix):
|
|
95
|
-
|
|
96
|
-
- `@bmad-master` - Universal task executor
|
|
97
|
-
- `@sm` - Scrum Master for story creation
|
|
98
|
-
- `@dev` - Full-stack developer for implementation
|
|
99
|
-
- `@architect` - Solution architect for design
|
|
100
|
-
- `@pm` - Product manager for planning
|
|
101
|
-
- `@analyst` - Business analyst for requirements
|
|
102
|
-
- `@qa` - QA specialist for testing
|
|
103
|
-
- `@po` - Product owner for prioritization
|
|
104
|
-
- `@ux-expert` - UX specialist for design
|
|
105
|
-
|
|
106
|
-
Alternatively, and more performance - you can copy the contents of an agent file into a custom mode - see the cursor docs on how to use custom agents.
|
|
107
|
-
|
|
108
|
-
## Cursor-Specific Features
|
|
109
|
-
|
|
110
|
-
- **Agent rules are stored in**: `.cursor/rules/` as `.mdc` files
|
|
111
|
-
- **Auto-completion**: Cursor will suggest `@agent-name` as you type
|
|
112
|
-
- **Rule activation**: Rules activate automatically when you mention `@agent-name`
|
|
113
|
-
- **Context awareness**: Agents have access to your current file context
|
|
114
|
-
|
|
115
|
-
## Key Workflow Principles
|
|
116
|
-
|
|
117
|
-
1. **Always start new chats** when switching agents to avoid context confusion
|
|
118
|
-
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
119
|
-
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
|
120
|
-
4. **Follow the SM → Dev cycle** for consistent story development
|
|
121
|
-
5. **Review and approve stories** before implementation begins
|
|
122
|
-
|
|
123
|
-
## Tips for Success
|
|
124
|
-
|
|
125
|
-
- **Keep chats focused**: Each chat should have one agent and one primary task
|
|
126
|
-
- **Use \*help command**: Every agent supports `*help` to see available commands
|
|
127
|
-
- **Review generated content**: Always review and approve stories before marking them ready
|
|
128
|
-
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
129
|
-
- **Leverage Cursor's context**: Agents can see your current file selection for better assistance
|
|
130
|
-
|
|
131
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
# Expansion Pack Ideas
|
|
2
|
-
|
|
3
|
-
The BMAD Method's natural language framework can be applied to any domain. Here are ideas to inspire your own expansion packs:
|
|
4
|
-
|
|
5
|
-
## Health & Wellness Pack
|
|
6
|
-
|
|
7
|
-
### Agents
|
|
8
|
-
|
|
9
|
-
- **Fitness Coach** - Creates personalized workout plans
|
|
10
|
-
- **Nutrition Advisor** - Designs meal plans and tracks nutrition
|
|
11
|
-
- **Meditation Guide** - Leads mindfulness sessions
|
|
12
|
-
- **Sleep Optimizer** - Improves sleep habits
|
|
13
|
-
|
|
14
|
-
### Tasks
|
|
15
|
-
|
|
16
|
-
- `create-workout-plan` - Generates weekly exercise routines
|
|
17
|
-
- `analyze-nutrition` - Reviews dietary habits
|
|
18
|
-
- `design-meditation` - Creates guided meditation scripts
|
|
19
|
-
|
|
20
|
-
### Templates
|
|
21
|
-
|
|
22
|
-
- `workout-plan-tmpl` - Structured exercise program
|
|
23
|
-
- `meal-plan-tmpl` - Weekly nutrition guide
|
|
24
|
-
- `wellness-journal-tmpl` - Progress tracking
|
|
25
|
-
|
|
26
|
-
## Creative Writing Pack
|
|
27
|
-
|
|
28
|
-
### Agents
|
|
29
|
-
|
|
30
|
-
- **Story Architect** - Plots narratives and story structures
|
|
31
|
-
- **Character Developer** - Creates deep, complex characters
|
|
32
|
-
- **World Builder** - Designs fictional universes
|
|
33
|
-
- **Dialog Master** - Crafts authentic conversations
|
|
34
|
-
|
|
35
|
-
### Tasks
|
|
36
|
-
|
|
37
|
-
- `develop-plot` - Creates story outlines
|
|
38
|
-
- `build-character` - Develops character profiles
|
|
39
|
-
- `create-world` - Designs settings and cultures
|
|
40
|
-
|
|
41
|
-
### Templates
|
|
42
|
-
|
|
43
|
-
- `story-outline-tmpl` - Three-act structure
|
|
44
|
-
- `character-sheet-tmpl` - Detailed character profile
|
|
45
|
-
- `world-bible-tmpl` - Universe documentation
|
|
46
|
-
|
|
47
|
-
## Business Strategy Pack
|
|
48
|
-
|
|
49
|
-
### Agents
|
|
50
|
-
|
|
51
|
-
- **Strategy Consultant** - Develops business strategies
|
|
52
|
-
- **Market Analyst** - Researches market opportunities
|
|
53
|
-
- **Financial Advisor** - Creates financial projections
|
|
54
|
-
- **Operations Expert** - Optimizes business processes
|
|
55
|
-
|
|
56
|
-
### Tasks
|
|
57
|
-
|
|
58
|
-
- `swot-analysis` - Conducts SWOT analysis
|
|
59
|
-
- `market-research` - Analyzes market conditions
|
|
60
|
-
- `financial-forecast` - Projects revenue/costs
|
|
61
|
-
|
|
62
|
-
### Templates
|
|
63
|
-
|
|
64
|
-
- `business-plan-tmpl` - Complete business plan
|
|
65
|
-
- `market-analysis-tmpl` - Market research report
|
|
66
|
-
- `pitch-deck-tmpl` - Investor presentation
|
|
67
|
-
|
|
68
|
-
## Education Pack
|
|
69
|
-
|
|
70
|
-
### Agents
|
|
71
|
-
|
|
72
|
-
- **Curriculum Designer** - Creates learning pathways
|
|
73
|
-
- **Lesson Planner** - Develops engaging lessons
|
|
74
|
-
- **Assessment Creator** - Designs fair evaluations
|
|
75
|
-
- **Learning Coach** - Provides personalized guidance
|
|
76
|
-
|
|
77
|
-
### Tasks
|
|
78
|
-
|
|
79
|
-
- `design-curriculum` - Creates course structure
|
|
80
|
-
- `plan-lesson` - Develops lesson content
|
|
81
|
-
- `create-assessment` - Builds tests/quizzes
|
|
82
|
-
|
|
83
|
-
### Templates
|
|
84
|
-
|
|
85
|
-
- `course-outline-tmpl` - Semester plan
|
|
86
|
-
- `lesson-plan-tmpl` - Daily lesson structure
|
|
87
|
-
- `rubric-tmpl` - Assessment criteria
|
|
88
|
-
|
|
89
|
-
## Personal Development Pack
|
|
90
|
-
|
|
91
|
-
### Agents
|
|
92
|
-
|
|
93
|
-
- **Life Coach** - Guides personal growth
|
|
94
|
-
- **Goal Strategist** - Helps achieve objectives
|
|
95
|
-
- **Habit Builder** - Creates lasting habits
|
|
96
|
-
- **Mindset Mentor** - Develops positive thinking
|
|
97
|
-
|
|
98
|
-
### Tasks
|
|
99
|
-
|
|
100
|
-
- `goal-setting` - Defines SMART goals
|
|
101
|
-
- `habit-tracking` - Monitors habit formation
|
|
102
|
-
- `reflection-exercise` - Facilitates self-reflection
|
|
103
|
-
|
|
104
|
-
### Templates
|
|
105
|
-
|
|
106
|
-
- `goal-plan-tmpl` - Goal achievement roadmap
|
|
107
|
-
- `habit-tracker-tmpl` - Daily habit log
|
|
108
|
-
- `journal-prompts-tmpl` - Reflection questions
|
|
109
|
-
|
|
110
|
-
## Creating Your Own
|
|
111
|
-
|
|
112
|
-
To create an expansion pack:
|
|
113
|
-
|
|
114
|
-
1. **Identify the domain** - What area of expertise?
|
|
115
|
-
2. **Define agent roles** - Who are the experts?
|
|
116
|
-
3. **Create tasks** - What procedures do they follow?
|
|
117
|
-
4. **Design templates** - What outputs do they produce?
|
|
118
|
-
5. **Test with users** - Does it provide value?
|
|
119
|
-
6. **Share with community** - Help others benefit!
|
|
120
|
-
|
|
121
|
-
Remember: The BMAD Method works anywhere natural language instructions can guide AI assistance!
|