Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
7df4f4cd0f | ||
|
|
f39b4951e9 | ||
|
|
764e7702b3 | ||
|
|
ac291c8dbe | ||
|
|
d59aa191fc | ||
|
|
b2a0725002 | ||
|
|
9bebbc9064 | ||
|
|
180c6a7b72 |
@@ -2,27 +2,24 @@
|
||||
|
||||
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:
|
||||
|
||||
```yml
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
whenToUse: "Use for system design, architecture documents, technology selection, API design, and infrastructure planning"
|
||||
customization:
|
||||
|
||||
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Holistic System Architect & Full-Stack Technical Leader
|
||||
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
||||
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
||||
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
||||
|
||||
core_principles:
|
||||
- Holistic System Thinking - View every component as part of a larger system
|
||||
- User Experience Drives Architecture - Start with user journeys and work backward
|
||||
@@ -34,24 +31,22 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
- "*execute-checklist {checklist}" - Run architectural validation checklist
|
||||
- "*research {topic}" - Generate deep research prompt for architectural decisions
|
||||
- "*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run architectural validation checklist'
|
||||
- '*research {topic}" - Generate deep research prompt for architectural decisions'
|
||||
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
|
||||
@@ -55,10 +55,8 @@ dependencies:
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-expansion-pack
|
||||
- create-agent
|
||||
- document-project
|
||||
- create-next-story
|
||||
- create-team
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
@@ -69,7 +67,6 @@ dependencies:
|
||||
- brownfield-architecture-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- front-end-spec-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
@@ -85,8 +82,6 @@ dependencies:
|
||||
- agent-switcher.ide
|
||||
- template-format
|
||||
- workflow-management
|
||||
schemas:
|
||||
- agent-team-schema
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
|
||||
@@ -2,20 +2,18 @@
|
||||
|
||||
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yml
|
||||
```yaml
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: "Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult"
|
||||
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
- Never pre-load resources - discover and load at runtime
|
||||
@@ -25,52 +23,42 @@ persona:
|
||||
- Be explicit about active persona and current task
|
||||
- Always use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
startup:
|
||||
- Announce: "Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options."
|
||||
- Announce: Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options.
|
||||
- Assess user goal, suggest agent transformation if match, offer numbered options if generic
|
||||
- Load resources only when needed
|
||||
|
||||
commands:
|
||||
- "*help" - Show commands/workflows/agents
|
||||
- "*chat-mode" - Conversational mode with advanced-elicitation
|
||||
- "*kb-mode" - Load knowledge base for full BMAD help
|
||||
- "*status" - Show current context/agent/progress
|
||||
- "*agent {name}" - Transform into agent (list if unspecified)
|
||||
- "*exit" - Return to BMad or exit (confirm if exiting BMad)
|
||||
- "*task {name}" - Run task (list if unspecified)
|
||||
- "*workflow {type}" - Start/list workflows
|
||||
- "*checklist {name}" - Execute checklist (list if unspecified)
|
||||
- "*yolo" - Toggle skip confirmations
|
||||
- "*party-mode" - Group chat with all agents
|
||||
- "*doc-out" - Output full document
|
||||
|
||||
- '*help" - Show commands/workflows/agents'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation'
|
||||
- '*kb-mode" - Load knowledge base for full BMAD help'
|
||||
- '*status" - Show current context/agent/progress'
|
||||
- '*agent {name}" - Transform into agent (list if unspecified)'
|
||||
- '*exit" - Return to BMad or exit (confirm if exiting BMad)'
|
||||
- '*task {name}" - Run task (list if unspecified)'
|
||||
- '*workflow {type}" - Start/list workflows'
|
||||
- '*checklist {name}" - Execute checklist (list if unspecified)'
|
||||
- '*yolo" - Toggle skip confirmations'
|
||||
- '*party-mode" - Group chat with all agents'
|
||||
- '*doc-out" - Output full document'
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
|
||||
transformation:
|
||||
- Match name/role to agents
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- 'Templates/Tasks: Only when executing'
|
||||
- Always indicate loading
|
||||
|
||||
workflow:
|
||||
- Ask project type (greenfield/brownfield)
|
||||
- Ask scope (UI/service/fullstack/other)
|
||||
- Recommend workflow, guide through stages
|
||||
- Explain web context management if needed
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- create-team
|
||||
- create-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
data:
|
||||
|
||||
60
.bmad-core/bmad-core-config.yml
Normal file
60
.bmad-core/bmad-core-config.yml
Normal file
@@ -0,0 +1,60 @@
|
||||
agent_file_references:
|
||||
core_docs:
|
||||
- docs/index.md
|
||||
- docs/prd.md
|
||||
- docs/architecture.md
|
||||
- docs/architecture/index.md
|
||||
- 'docs/architecture/coding-standards.md # Required by DEV at startup'
|
||||
- 'docs/architecture/tech-stack.md # Technology stack reference'
|
||||
- 'docs/architecture/unified-project-structure.md # Project structure guide'
|
||||
- 'docs/architecture/testing-strategy.md # Testing requirements'
|
||||
story_files:
|
||||
- 'docs/stories/ # Stories directory (pattern: {epicNum}.{storyNum}.story.md)'
|
||||
epic_locations:
|
||||
primary: docs/
|
||||
secondary: docs/prd/
|
||||
architecture_shards:
|
||||
backend:
|
||||
- 'docs/architecture/backend-architecture.md # Backend service patterns'
|
||||
- 'docs/architecture/rest-api-spec.md # API endpoint specifications'
|
||||
- 'docs/architecture/data-models.md # Data structures and validation'
|
||||
- 'docs/architecture/database-schema.md # Database design'
|
||||
- 'docs/architecture/external-apis.md # Third-party integrations'
|
||||
frontend:
|
||||
- 'docs/architecture/frontend-architecture.md # Frontend patterns'
|
||||
- docs/architecture/components.md
|
||||
- 'docs/architecture/core-workflows.md # User interaction flows'
|
||||
- 'docs/architecture/ui-ux-spec.md # UI/UX specifications'
|
||||
shared:
|
||||
- 'docs/architecture/tech-stack.md # Technology constraints'
|
||||
- 'docs/architecture/unified-project-structure.md # Code organization'
|
||||
- 'docs/architecture/coding-standards.md # Project conventions'
|
||||
- 'docs/architecture/testing-strategy.md # Testing requirements'
|
||||
additional_docs:
|
||||
- 'docs/tech-stack.md # Technology stack (if separate)'
|
||||
- 'docs/data-models.md # Data models (if separate)'
|
||||
- 'docs/api-reference.md # API reference (if separate)'
|
||||
- 'docs/frontend-architecture.md # Frontend arch (if separate)'
|
||||
bmad_core_dependencies:
|
||||
tasks:
|
||||
- .bmad-core/tasks/create-next-story.md
|
||||
- .bmad-core/tasks/execute-checklist.md
|
||||
- .bmad-core/tasks/correct-course.md
|
||||
- .bmad-core/tasks/shard-doc.md
|
||||
- .bmad-core/tasks/index-docs.md
|
||||
templates:
|
||||
- .bmad-core/templates/story-tmpl.md
|
||||
checklists:
|
||||
- .bmad-core/checklists/story-draft-checklist.md
|
||||
- .bmad-core/checklists/story-dod-checklist.md
|
||||
utils:
|
||||
- .bmad-core/utils/template-format.md
|
||||
file_patterns:
|
||||
story_files: '{epicNum}.{storyNum}.story.md'
|
||||
epic_files: epic-{n}-{description}.md
|
||||
story_statuses:
|
||||
- Draft
|
||||
- Approved
|
||||
- In Progress
|
||||
- Review
|
||||
- Done
|
||||
@@ -1,153 +0,0 @@
|
||||
# BMAD Agent Team Configuration Schema
|
||||
# This schema defines the structure for BMAD agent team configuration files
|
||||
# Teams bundle multiple agents and workflows for specific project types
|
||||
|
||||
type: object
|
||||
required:
|
||||
- bundle
|
||||
- agents
|
||||
- workflows
|
||||
|
||||
properties:
|
||||
bundle:
|
||||
type: object
|
||||
description: Team bundle metadata and configuration
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: Human-friendly name of the team bundle
|
||||
pattern: "^Team .+$"
|
||||
examples:
|
||||
- "Team Fullstack"
|
||||
- "Team No UI"
|
||||
- "Team All"
|
||||
|
||||
description:
|
||||
type: string
|
||||
description: Detailed description of the team's purpose, capabilities, and use cases
|
||||
minLength: 20
|
||||
maxLength: 500
|
||||
|
||||
agents:
|
||||
type: array
|
||||
description: List of agents included in this team bundle
|
||||
minItems: 2
|
||||
items:
|
||||
type: string
|
||||
description: Agent ID matching agents/{agent}.yml or special value '*' for all agents
|
||||
pattern: "^([a-z-]+|\\*)$"
|
||||
examples:
|
||||
- "bmad"
|
||||
- "analyst"
|
||||
- "pm"
|
||||
- "ux-expert"
|
||||
- "architect"
|
||||
- "po"
|
||||
- "sm"
|
||||
- "dev"
|
||||
- "qa"
|
||||
- "*"
|
||||
uniqueItems: true
|
||||
allOf:
|
||||
- description: Must include 'bmad' as the orchestrator
|
||||
contains:
|
||||
const: "bmad"
|
||||
|
||||
workflows:
|
||||
type: array
|
||||
description: List of workflows this team can execute
|
||||
minItems: 1
|
||||
items:
|
||||
type: string
|
||||
description: Workflow ID matching bmad-core/workflows/{workflow}.yml
|
||||
enum:
|
||||
- "brownfield-fullstack"
|
||||
- "brownfield-service"
|
||||
- "brownfield-ui"
|
||||
- "greenfield-fullstack"
|
||||
- "greenfield-service"
|
||||
- "greenfield-ui"
|
||||
uniqueItems: true
|
||||
|
||||
# No additional properties allowed
|
||||
additionalProperties: false
|
||||
|
||||
# Validation rules
|
||||
allOf:
|
||||
- if:
|
||||
properties:
|
||||
agents:
|
||||
contains:
|
||||
const: "*"
|
||||
then:
|
||||
properties:
|
||||
agents:
|
||||
maxItems: 2
|
||||
description: When using wildcard '*', only 'bmad' and '*' should be present
|
||||
|
||||
- if:
|
||||
properties:
|
||||
bundle:
|
||||
properties:
|
||||
name:
|
||||
const: "Team No UI"
|
||||
then:
|
||||
properties:
|
||||
agents:
|
||||
not:
|
||||
contains:
|
||||
const: "ux-expert"
|
||||
workflows:
|
||||
not:
|
||||
contains:
|
||||
enum: ["brownfield-ui", "greenfield-ui"]
|
||||
|
||||
# Examples showing valid team configurations
|
||||
examples:
|
||||
minimal_team:
|
||||
bundle:
|
||||
name: "Team Minimal"
|
||||
description: "Minimal team for basic project planning and architecture without implementation"
|
||||
agents:
|
||||
- bmad
|
||||
- analyst
|
||||
- architect
|
||||
workflows:
|
||||
- greenfield-service
|
||||
|
||||
fullstack_team:
|
||||
bundle:
|
||||
name: "Team Fullstack"
|
||||
description: "Comprehensive full-stack development team capable of handling both greenfield application development and brownfield enhancement projects. This team combines strategic planning, user experience design, and holistic system architecture to deliver complete solutions from concept to deployment."
|
||||
agents:
|
||||
- bmad
|
||||
- analyst
|
||||
- pm
|
||||
- ux-expert
|
||||
- architect
|
||||
- po
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
|
||||
all_agents_team:
|
||||
bundle:
|
||||
name: "Team All"
|
||||
description: "This is a full organization of agents and includes every possible agent. This will produce the largest bundle but give the most options for discussion in a single session"
|
||||
agents:
|
||||
- bmad
|
||||
- "*"
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
@@ -1,229 +0,0 @@
|
||||
# Create Team Task
|
||||
|
||||
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.
|
||||
|
||||
**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.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Load and understand the team schema: `/bmad-core/schemas/agent-team-schema.yml`
|
||||
2. Review existing teams in `/bmad-core/agent-teams/` for patterns and naming conventions
|
||||
3. List available agents from `/agents/` to understand team composition options
|
||||
4. Review workflows in `/bmad-core/workflows/` to align team capabilities
|
||||
|
||||
## Process
|
||||
|
||||
### 1. Define Team Purpose and Scope
|
||||
|
||||
Before selecting agents, clarify the team's mission:
|
||||
|
||||
- **Team Purpose**: What specific problems will this team solve?
|
||||
- **Project Types**: Greenfield, brownfield, or both?
|
||||
- **Technical Scope**: UI-focused, backend-only, or full-stack?
|
||||
- **Team Size Consideration**: Smaller teams (3-5 agents) for focused work, larger teams (6-8) for comprehensive coverage
|
||||
|
||||
### 2. Create Team Metadata
|
||||
|
||||
Based on the schema requirements:
|
||||
|
||||
- **Team Name**: Must follow pattern `^Team .+$` (e.g., "Team Frontend", "Team Analytics")
|
||||
- For user teams: prefix with period (e.g., "Team .MyCustom")
|
||||
- **Description**: 20-500 characters explaining team's purpose, capabilities, and use cases
|
||||
- **File Name**: `/bmad-core/agent-teams/team-{identifier}.yml`
|
||||
- For user teams: `/bmad-core/agent-teams/.team-{identifier}.yml`
|
||||
|
||||
### 3. Select Agents Based on Purpose
|
||||
|
||||
#### Discover Available Agents
|
||||
|
||||
1. List all agents from `/agents/` directory
|
||||
2. Review each agent's role and capabilities
|
||||
3. Consider agent synergies and coverage
|
||||
|
||||
#### Agent Selection Guidelines
|
||||
|
||||
Based on team purpose, recommend agents:
|
||||
|
||||
**For Planning & Strategy Teams:**
|
||||
|
||||
- `bmad` (required orchestrator)
|
||||
- `analyst` - Requirements gathering and research
|
||||
- `pm` - Product strategy and documentation
|
||||
- `po` - Validation and approval
|
||||
- `architect` - Technical planning (if technical planning needed)
|
||||
|
||||
**For Design & UX Teams:**
|
||||
|
||||
- `bmad` (required orchestrator)
|
||||
- `ux-expert` - User experience design
|
||||
- `architect` - Frontend architecture
|
||||
- `pm` - Product requirements alignment
|
||||
- `po` - Design validation
|
||||
|
||||
**For Development Teams:**
|
||||
|
||||
- `bmad-orchestrator` (required)
|
||||
- `sm` - Sprint coordination
|
||||
- `dev` - Implementation
|
||||
- `qa` - Quality assurance
|
||||
- `architect` - Technical guidance
|
||||
|
||||
**For Full-Stack Teams:**
|
||||
|
||||
- `bmad-orchestrator` (required)
|
||||
- `analyst` - Initial planning
|
||||
- `pm` - Product management
|
||||
- `ux-expert` - UI/UX design (if UI work included)
|
||||
- `architect` - System architecture
|
||||
- `po` - Validation
|
||||
- Additional agents as needed
|
||||
|
||||
#### Special Cases
|
||||
|
||||
- **Using Wildcard**: If team needs all agents, use `["bmad", "*"]`
|
||||
- **Validation**: Schema requires `bmad` in all teams
|
||||
|
||||
### 4. Select Workflows
|
||||
|
||||
Based on the schema's workflow enum values and team composition:
|
||||
|
||||
1. **Analyze team capabilities** against available workflows:
|
||||
|
||||
- `brownfield-fullstack` - Requires full team with UX
|
||||
- `brownfield-service` - Backend-focused team
|
||||
- `brownfield-ui` - UI/UX-focused team
|
||||
- `greenfield-fullstack` - Full team for new projects
|
||||
- `greenfield-service` - Backend team for new services
|
||||
- `greenfield-ui` - Frontend team for new UIs
|
||||
|
||||
2. **Match workflows to agents**:
|
||||
|
||||
- UI workflows require `ux-expert`
|
||||
- Service workflows benefit from `architect` and `dev`
|
||||
- All workflows benefit from planning agents (`analyst`, `pm`)
|
||||
|
||||
3. **Apply schema validation rules**:
|
||||
- Teams without `ux-expert` shouldn't have UI workflows
|
||||
- Teams named "Team No UI" can't have UI workflows
|
||||
|
||||
### 5. Create Team Configuration
|
||||
|
||||
Generate the configuration following the schema:
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: "{Team Name}" # Must match pattern "^Team .+$"
|
||||
description: >-
|
||||
{20-500 character description explaining purpose,
|
||||
capabilities, and ideal use cases}
|
||||
|
||||
agents:
|
||||
- bmad # Required orchestrator
|
||||
- { agent-id-1 }
|
||||
- { agent-id-2 }
|
||||
# ... additional agents
|
||||
|
||||
workflows:
|
||||
- { workflow-1 } # From enum list
|
||||
- { workflow-2 }
|
||||
# ... additional workflows
|
||||
```
|
||||
|
||||
### 6. Validate Team Composition
|
||||
|
||||
Before finalizing, verify:
|
||||
|
||||
1. **Role Coverage**: Does the team have all necessary skills for its workflows?
|
||||
2. **Size Optimization**:
|
||||
- Minimum: 2 agents (bmad + 1)
|
||||
- Recommended: 3-7 agents
|
||||
- Maximum with wildcard: bmad + "\*"
|
||||
3. **Workflow Alignment**: Can the selected agents execute all workflows?
|
||||
4. **Schema Compliance**: Configuration matches all schema requirements
|
||||
|
||||
### 7. Integration Recommendations
|
||||
|
||||
Document how this team integrates with existing system:
|
||||
|
||||
1. **Complementary Teams**: Which existing teams complement this one?
|
||||
2. **Handoff Points**: Where does this team hand off to others?
|
||||
3. **Use Case Scenarios**: Specific project types ideal for this team
|
||||
|
||||
### 8. Validation and Testing
|
||||
|
||||
1. **Schema Validation**: Ensure configuration matches agent-team-schema.yml
|
||||
2. **Build Validation**: Run `npm run validate`
|
||||
3. **Build Team**: Run `npm run build:team -t {team-name}`
|
||||
4. **Size Check**: Verify output is appropriate for target platform
|
||||
5. **Test Scenarios**: Run sample workflows with the team
|
||||
|
||||
## Example Team Creation
|
||||
|
||||
### Example 1: API Development Team
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: "Team API"
|
||||
description: >-
|
||||
Specialized team for API and backend service development. Focuses on
|
||||
robust service architecture, implementation, and testing without UI
|
||||
components. Ideal for microservices, REST APIs, and backend systems.
|
||||
|
||||
agents:
|
||||
- bmad
|
||||
- analyst
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
- po
|
||||
|
||||
workflows:
|
||||
- greenfield-service
|
||||
- brownfield-service
|
||||
```
|
||||
|
||||
### Example 2: Rapid Prototyping Team
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: "Team Prototype"
|
||||
description: >-
|
||||
Agile team for rapid prototyping and proof of concept development.
|
||||
Combines planning, design, and implementation for quick iterations
|
||||
on new ideas and experimental features.
|
||||
|
||||
agents:
|
||||
- bmad
|
||||
- pm
|
||||
- ux-expert
|
||||
- architect
|
||||
- dev
|
||||
|
||||
workflows:
|
||||
- greenfield-ui
|
||||
- greenfield-fullstack
|
||||
```
|
||||
|
||||
## Team Creation Checklist
|
||||
|
||||
- [ ] Team purpose clearly defined
|
||||
- [ ] Name follows schema pattern "Team {Name}"
|
||||
- [ ] Description is 20-500 characters
|
||||
- [ ] Includes bmad orchestrator
|
||||
- [ ] Agents align with team purpose
|
||||
- [ ] Workflows match team capabilities
|
||||
- [ ] No conflicting validations (e.g., no-UI team with UI workflows)
|
||||
- [ ] Configuration validates against schema
|
||||
- [ ] Build completes successfully
|
||||
- [ ] Output size appropriate for platform
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Start Focused**: Create teams with specific purposes rather than general-purpose teams
|
||||
2. **Consider Workflow**: Order agents by typical workflow sequence
|
||||
3. **Avoid Redundancy**: Don't duplicate roles unless needed
|
||||
4. **Document Rationale**: Explain why each agent is included
|
||||
5. **Test Integration**: Verify team works well with selected workflows
|
||||
6. **Iterate**: Refine team composition based on usage
|
||||
|
||||
This schema-driven approach ensures teams are well-structured, purposeful, and integrate seamlessly with the BMAD ecosystem.
|
||||
389
.bmad-core/tasks/document-project.md
Normal file
389
.bmad-core/tasks/document-project.md
Normal file
@@ -0,0 +1,389 @@
|
||||
# Document an Existing Project
|
||||
|
||||
## Purpose
|
||||
|
||||
Generate comprehensive documentation for existing projects optimized for AI development agents. This task creates structured reference materials that enable AI agents to understand project context, conventions, and patterns for effective contribution to any codebase.
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Initial Project Analysis
|
||||
|
||||
[[LLM: Begin by conducting a comprehensive analysis of the existing project. Use available tools to:
|
||||
|
||||
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
||||
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
||||
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
||||
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
||||
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
||||
|
||||
Ask the user these elicitation questions to better understand their needs:
|
||||
|
||||
- What is the primary purpose of this project?
|
||||
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
||||
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
||||
- Are there any existing documentation standards or formats you prefer?
|
||||
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
||||
]]
|
||||
|
||||
### 2. Core Documentation Generation
|
||||
|
||||
[[LLM: Based on your analysis, generate the following core documentation files. Adapt the content and structure to match the specific project type and context you discovered:
|
||||
|
||||
**Core Documents (always generate):**
|
||||
|
||||
1. **docs/index.md** - Master documentation index
|
||||
2. **docs/architecture/index.md** - Architecture documentation index
|
||||
3. **docs/architecture/coding-standards.md** - Coding conventions and style guidelines
|
||||
4. **docs/architecture/tech-stack.md** - Technology stack and version constraints
|
||||
5. **docs/architecture/unified-project-structure.md** - Project structure and organization
|
||||
6. **docs/architecture/testing-strategy.md** - Testing approaches and requirements
|
||||
|
||||
**Backend Documents (generate for backend/full-stack projects):**
|
||||
|
||||
7. **docs/architecture/backend-architecture.md** - Backend service patterns and structure
|
||||
8. **docs/architecture/rest-api-spec.md** - API endpoint specifications
|
||||
9. **docs/architecture/data-models.md** - Data structures and validation rules
|
||||
10. **docs/architecture/database-schema.md** - Database design and relationships
|
||||
11. **docs/architecture/external-apis.md** - Third-party integrations
|
||||
|
||||
**Frontend Documents (generate for frontend/full-stack projects):**
|
||||
|
||||
12. **docs/architecture/frontend-architecture.md** - Frontend patterns and structure
|
||||
13. **docs/architecture/components.md** - UI component specifications
|
||||
14. **docs/architecture/core-workflows.md** - User interaction flows
|
||||
15. **docs/architecture/ui-ux-spec.md** - UI/UX specifications and guidelines
|
||||
|
||||
**Additional Documents (generate if applicable):**
|
||||
|
||||
16. **docs/prd.md** - Product requirements document (if not exists)
|
||||
17. **docs/architecture/deployment-guide.md** - Deployment and operations info
|
||||
18. **docs/architecture/security-considerations.md** - Security patterns and requirements
|
||||
19. **docs/architecture/performance-guidelines.md** - Performance optimization patterns
|
||||
|
||||
**Optional Enhancement Documents:**
|
||||
|
||||
20. **docs/architecture/troubleshooting-guide.md** - Common issues and solutions
|
||||
21. **docs/architecture/changelog-conventions.md** - Change management practices
|
||||
22. **docs/architecture/code-review-checklist.md** - Review standards and practices
|
||||
|
||||
Present each document section by section, using the advanced elicitation task after each major section.]]
|
||||
|
||||
### 3. Document Structure Template
|
||||
|
||||
[[LLM: Use this standardized structure for each documentation file, adapting content as needed:
|
||||
|
||||
```markdown
|
||||
# {{Document Title}}
|
||||
|
||||
## Overview
|
||||
|
||||
{{Brief description of what this document covers and why it's important for AI agents}}
|
||||
|
||||
## Quick Reference
|
||||
|
||||
{{Key points, commands, or patterns that agents need most frequently}}
|
||||
|
||||
## Detailed Information
|
||||
|
||||
{{Comprehensive information organized into logical sections}}
|
||||
|
||||
## Examples
|
||||
|
||||
{{Concrete examples showing proper usage or implementation}}
|
||||
|
||||
## Common Patterns
|
||||
|
||||
{{Recurring patterns agents should recognize and follow}}
|
||||
|
||||
## Things to Avoid
|
||||
|
||||
{{Anti-patterns, deprecated approaches, or common mistakes}}
|
||||
|
||||
## Related Resources
|
||||
|
||||
{{Links to other relevant documentation or external resources}}
|
||||
```
|
||||
|
||||
Each document should be:
|
||||
|
||||
- **Concrete and actionable** - Focus on what agents need to do, not just concepts
|
||||
- **Pattern-focused** - Highlight recurring patterns agents can recognize and replicate
|
||||
- **Example-rich** - Include specific code examples and real file references
|
||||
- **Context-aware** - Reference actual project files, folders, and conventions
|
||||
- **Assumption-free** - Don't assume agents know project history or implicit knowledge
|
||||
]]
|
||||
|
||||
### 4. Content Guidelines for Each Document Type
|
||||
|
||||
#### Core Architecture Documents
|
||||
|
||||
##### docs/architecture/index.md
|
||||
|
||||
[[LLM: Create a comprehensive index of all architecture documentation:
|
||||
|
||||
- List all architecture documents with brief descriptions
|
||||
- Group documents by category (backend, frontend, shared)
|
||||
- Include quick links to key sections
|
||||
- Provide reading order recommendations for different use cases]]
|
||||
|
||||
##### docs/architecture/unified-project-structure.md
|
||||
|
||||
[[LLM: Document the complete project structure:
|
||||
|
||||
- Root-level directory structure with explanations
|
||||
- Where each type of code belongs (backend, frontend, tests, etc.)
|
||||
- File naming conventions and patterns
|
||||
- Module/package organization
|
||||
- Generated vs. source file locations
|
||||
- Build output locations]]
|
||||
|
||||
##### docs/architecture/coding-standards.md
|
||||
|
||||
[[LLM: Capture project-wide coding conventions:
|
||||
|
||||
- Language-specific style guidelines
|
||||
- Naming conventions (variables, functions, classes, files)
|
||||
- Code organization within files
|
||||
- Import/export patterns
|
||||
- Comment and documentation standards
|
||||
- Linting and formatting tool configurations
|
||||
- Git commit message conventions]]
|
||||
|
||||
##### docs/architecture/tech-stack.md
|
||||
|
||||
[[LLM: Document all technologies and versions:
|
||||
|
||||
- Primary languages and versions
|
||||
- Frameworks and major libraries with versions
|
||||
- Development tools and their versions
|
||||
- Database systems and versions
|
||||
- External services and APIs used
|
||||
- Browser/runtime requirements]]
|
||||
|
||||
##### docs/architecture/testing-strategy.md
|
||||
|
||||
[[LLM: Define testing approaches and requirements:
|
||||
|
||||
- Test file locations and naming conventions
|
||||
- Unit testing patterns and frameworks
|
||||
- Integration testing approaches
|
||||
- E2E testing setup (if applicable)
|
||||
- Test coverage requirements
|
||||
- Mocking strategies
|
||||
- Test data management]]
|
||||
|
||||
#### Backend Architecture Documents
|
||||
|
||||
##### docs/architecture/backend-architecture.md
|
||||
|
||||
[[LLM: Document backend service structure:
|
||||
|
||||
- Service layer organization
|
||||
- Controller/route patterns
|
||||
- Middleware architecture
|
||||
- Authentication/authorization patterns
|
||||
- Request/response flow
|
||||
- Background job processing
|
||||
- Service communication patterns]]
|
||||
|
||||
##### docs/architecture/rest-api-spec.md
|
||||
|
||||
[[LLM: Specify all API endpoints:
|
||||
|
||||
- Base URL and versioning strategy
|
||||
- Authentication methods
|
||||
- Common headers and parameters
|
||||
- Each endpoint with:
|
||||
- HTTP method and path
|
||||
- Request parameters/body
|
||||
- Response format and status codes
|
||||
- Error responses
|
||||
- Rate limiting and quotas]]
|
||||
|
||||
##### docs/architecture/data-models.md
|
||||
|
||||
[[LLM: Define data structures and validation:
|
||||
|
||||
- Core business entities
|
||||
- Data validation rules
|
||||
- Relationships between entities
|
||||
- Computed fields and derivations
|
||||
- Data transformation patterns
|
||||
- Serialization formats]]
|
||||
|
||||
##### docs/architecture/database-schema.md
|
||||
|
||||
[[LLM: Document database design:
|
||||
|
||||
- Database type and version
|
||||
- Table/collection structures
|
||||
- Indexes and constraints
|
||||
- Relationships and foreign keys
|
||||
- Migration patterns
|
||||
- Seed data requirements
|
||||
- Backup and recovery procedures]]
|
||||
|
||||
##### docs/architecture/external-apis.md
|
||||
|
||||
[[LLM: Document third-party integrations:
|
||||
|
||||
- List of external services used
|
||||
- Authentication methods for each
|
||||
- API endpoints and usage patterns
|
||||
- Rate limits and quotas
|
||||
- Error handling strategies
|
||||
- Webhook configurations
|
||||
- Data synchronization patterns]]
|
||||
|
||||
#### Frontend Architecture Documents
|
||||
|
||||
##### docs/architecture/frontend-architecture.md
|
||||
|
||||
[[LLM: Document frontend application structure:
|
||||
|
||||
- Component hierarchy and organization
|
||||
- State management patterns
|
||||
- Routing architecture
|
||||
- Data fetching patterns
|
||||
- Authentication flow
|
||||
- Error boundary strategies
|
||||
- Performance optimization patterns]]
|
||||
|
||||
##### docs/architecture/components.md
|
||||
|
||||
[[LLM: Specify UI components:
|
||||
|
||||
- Component library/design system used
|
||||
- Custom component specifications
|
||||
- Props and state for each component
|
||||
- Component composition patterns
|
||||
- Styling approaches
|
||||
- Accessibility requirements
|
||||
- Component testing patterns]]
|
||||
|
||||
##### docs/architecture/core-workflows.md
|
||||
|
||||
[[LLM: Document user interaction flows:
|
||||
|
||||
- Major user journeys
|
||||
- Screen flow diagrams
|
||||
- Form handling patterns
|
||||
- Navigation patterns
|
||||
- Data flow through workflows
|
||||
- Error states and recovery
|
||||
- Loading and transition states]]
|
||||
|
||||
##### docs/architecture/ui-ux-spec.md
|
||||
|
||||
[[LLM: Define UI/UX guidelines:
|
||||
|
||||
- Design system specifications
|
||||
- Color palette and typography
|
||||
- Spacing and layout grids
|
||||
- Responsive breakpoints
|
||||
- Animation and transition guidelines
|
||||
- Accessibility standards
|
||||
- Browser compatibility requirements]]
|
||||
|
||||
### 5. Adaptive Content Strategy
|
||||
|
||||
[[LLM: Adapt your documentation approach based on project characteristics:
|
||||
|
||||
**For Web Applications:**
|
||||
|
||||
- Focus on component patterns, routing, state management
|
||||
- Include build processes, asset handling, and deployment
|
||||
- Cover API integration patterns and data fetching
|
||||
|
||||
**For Backend Services:**
|
||||
|
||||
- Emphasize service architecture, data models, and API design
|
||||
- Include database interaction patterns and migration strategies
|
||||
- Cover authentication, authorization, and security patterns
|
||||
|
||||
**For CLI Tools:**
|
||||
|
||||
- Focus on command structure, argument parsing, and output formatting
|
||||
- Include plugin/extension patterns if applicable
|
||||
- Cover configuration file handling and user interaction patterns
|
||||
|
||||
**For Libraries/Frameworks:**
|
||||
|
||||
- Emphasize public API design and usage patterns
|
||||
- Include extension points and customization approaches
|
||||
- Cover versioning, compatibility, and migration strategies
|
||||
|
||||
**For Mobile Applications:**
|
||||
|
||||
- Focus on platform-specific patterns and navigation
|
||||
- Include state management and data persistence approaches
|
||||
- Cover platform integration and native feature usage
|
||||
|
||||
**For Data Science/ML Projects:**
|
||||
|
||||
- Emphasize data pipeline patterns and model organization
|
||||
- Include experiment tracking and reproducibility approaches
|
||||
- Cover data validation and model deployment patterns
|
||||
]]
|
||||
|
||||
### 6. Quality Assurance
|
||||
|
||||
[[LLM: Before completing each document:
|
||||
|
||||
1. **Accuracy Check**: Verify all file paths, commands, and code examples work
|
||||
2. **Completeness Review**: Ensure the document covers the most important patterns an agent would encounter
|
||||
3. **Clarity Assessment**: Check that explanations are clear and actionable
|
||||
4. **Consistency Verification**: Ensure terminology and patterns align across all documents
|
||||
5. **Agent Perspective**: Review from the viewpoint of an AI agent that needs to contribute to this project
|
||||
|
||||
Ask the user to review each completed document and use the advanced elicitation task to refine based on their feedback.]]
|
||||
|
||||
### 7. Final Integration
|
||||
|
||||
[[LLM: After all documents are completed:
|
||||
|
||||
1. Ensure all documents are created in the proper BMAD-expected locations:
|
||||
|
||||
- Core docs in `docs/` (index.md, prd.md)
|
||||
- Architecture shards in `docs/architecture/` subdirectory
|
||||
- Create the `docs/architecture/` directory if it doesn't exist
|
||||
|
||||
2. Create/update the master index documents:
|
||||
|
||||
- Update `docs/index.md` to reference all documentation
|
||||
- Create `docs/architecture/index.md` listing all architecture shards
|
||||
|
||||
3. Verify document cross-references:
|
||||
|
||||
- Ensure all documents link to related documentation
|
||||
- Check that file paths match the actual project structure
|
||||
- Validate that examples reference real files in the project
|
||||
|
||||
4. Provide maintenance guidance:
|
||||
|
||||
- Document update triggers (when to update each doc)
|
||||
- Create a simple checklist for keeping docs current
|
||||
- Suggest automated validation approaches
|
||||
|
||||
5. Summary report including:
|
||||
- List of all documents created with their paths
|
||||
- Any gaps or areas needing human review
|
||||
- Recommendations for project-specific additions
|
||||
- Next steps for maintaining documentation accuracy
|
||||
|
||||
Present a summary of what was created and ask if any additional documentation would be helpful for AI agents working on this specific project.]]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Documentation enables AI agents to understand project context without additional explanation
|
||||
- All major architectural patterns and coding conventions are captured
|
||||
- Examples reference actual project files and demonstrate real usage
|
||||
- Documentation is structured consistently and easy to navigate
|
||||
- Content is actionable and focuses on what agents need to do, not just understand
|
||||
|
||||
## Notes
|
||||
|
||||
- This task is designed to work with any project type, language, or framework
|
||||
- The documentation should reflect the project as it actually is, not as it should be
|
||||
- Focus on patterns that agents can recognize and replicate consistently
|
||||
- Include both positive examples (what to do) and negative examples (what to avoid)
|
||||
@@ -2,57 +2,50 @@
|
||||
|
||||
## Purpose
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Completed UI/UX Specification (`front-end-spec-tmpl`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`)
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack)
|
||||
- Primary Design Files (Figma, Sketch, etc. - for visual context if the tool can accept it or if descriptions are needed)
|
||||
- Completed UI/UX Specification (`front-end-spec`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
||||
|
||||
## Key Activities & Instructions
|
||||
|
||||
1. **Confirm Target AI Generation Platform:**
|
||||
### 1. Core Prompting Principles
|
||||
|
||||
- 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.).
|
||||
- Explain that prompt optimization might differ slightly based on the platform's capabilities and preferred input format.
|
||||
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
||||
|
||||
2. **Synthesize Inputs into a Structured Prompt:**
|
||||
- **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.
|
||||
- **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.
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
- **Overall Project Context:**
|
||||
- Briefly state the project's purpose (from brief/PRD).
|
||||
- Specify the chosen frontend framework, core libraries, and UI component library (from `front-end-architecture` and main `architecture`).
|
||||
- Mention the styling approach (e.g., Tailwind CSS, CSS Modules).
|
||||
- **Design System & Visuals:**
|
||||
- Reference the primary design files (e.g., Figma link).
|
||||
- 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`).
|
||||
- List any global UI components or design tokens that should be defined or adhered to.
|
||||
- **Application Structure & Routing:**
|
||||
- Describe the main pages/views and their routes (from `front-end-architecture` - Routing Strategy).
|
||||
- Outline the navigation structure (from `front-end-spec-tmpl`).
|
||||
- **Key User Flows & Page-Level Interactions:**
|
||||
- For a few critical user flows (from `front-end-spec-tmpl`):
|
||||
- Describe the sequence of user actions and expected UI changes on each relevant page.
|
||||
- Specify API calls to be made (referencing API endpoints from the main `architecture`) and how data should be displayed or used.
|
||||
- **Component Generation Instructions (Iterative or Key Components):**
|
||||
- Based on the chosen AI tool's capabilities, decide on a strategy:
|
||||
- **Option 1 (Scaffolding):** Prompt for the generation of main page structures, layouts, and placeholders for components.
|
||||
- **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).
|
||||
- **Option 3 (Holistic, if tool supports):** Attempt to describe the entire application structure and key components more broadly.
|
||||
- <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>
|
||||
- **State Management (High-Level Pointers):**
|
||||
- Mention the chosen state management solution (e.g., "Use Redux Toolkit").
|
||||
- For key pieces of data, indicate if they should be managed in global state.
|
||||
- **API Integration Points:**
|
||||
- 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).
|
||||
- **Critical "Don'ts" or Constraints:**
|
||||
- e.g., "Do not use deprecated libraries." "Ensure all forms have basic client-side validation."
|
||||
- **Platform-Specific Optimizations:**
|
||||
- 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).
|
||||
### 2. The Structured Prompting Framework
|
||||
|
||||
3. **Present and Refine the Master Prompt:**
|
||||
- Output the generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included.
|
||||
- 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.
|
||||
- <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>
|
||||
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
||||
|
||||
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
||||
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
||||
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.
|
||||
- _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."_
|
||||
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.
|
||||
- _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."_
|
||||
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.
|
||||
- _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."_
|
||||
|
||||
### 3. Assembling the Master Prompt
|
||||
|
||||
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
||||
|
||||
1. **Gather Foundational Context**:
|
||||
- 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.
|
||||
2. **Describe the Visuals**:
|
||||
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
||||
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
||||
3. **Build the Prompt using the Structured Framework**:
|
||||
- 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.
|
||||
4. **Present and Refine**:
|
||||
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
||||
- <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>
|
||||
|
||||
@@ -136,7 +136,7 @@ Common patterns to consider:
|
||||
|
||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||
|
||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences`
|
||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences`
|
||||
2. For each category, present 2-3 viable options with pros/cons
|
||||
3. Make a clear recommendation based on project needs
|
||||
4. Get explicit user approval for each selection
|
||||
@@ -344,15 +344,18 @@ Use YAML format for better readability. If no REST API, skip this section.]]
|
||||
```yaml
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title: { { api_title } }
|
||||
version: { { api_version } }
|
||||
description: { { api_description } }
|
||||
|
||||
title:
|
||||
'[object Object]': null
|
||||
version:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
servers:
|
||||
- url: { { api_base_url } }
|
||||
description: { { environment } }
|
||||
# ... OpenAPI specification continues
|
||||
```
|
||||
- url:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
```text
|
||||
|
||||
^^/CONDITION: has_rest_api^^
|
||||
|
||||
@@ -463,7 +466,7 @@ Get user input on deployment preferences and CI/CD tool choices.]]
|
||||
|
||||
### Environment Promotion Flow
|
||||
|
||||
```
|
||||
```text
|
||||
{{promotion_flow_diagram}}
|
||||
```
|
||||
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
|
||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
||||
|
||||
1. Check if `data#technical-preferences` file exists - use it to pre-populate choices
|
||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
|
||||
[[LLM: Gather technical decisions that will be used for this simple technical PRD that includes architecture decisions. Steps:
|
||||
|
||||
1. Check if `data#technical-preferences` file exists - use it to pre-populate choices
|
||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
|
||||
@@ -9,8 +9,7 @@ The BMAD orchestrator MUST read the available workflows from the current team co
|
||||
**Critical Distinction**:
|
||||
|
||||
- When asked "what workflows are available?", show ONLY the workflows defined in the current team bundle's configuration
|
||||
- The create-\* tasks (create-agent, create-team, etc.) are for CREATING new configurations, not for listing what's available in the current session
|
||||
- Use `/agent-list` to show agents in the current bundle, NOT the create-agent task
|
||||
- Use `/agent-list` to show agents in the current bundle
|
||||
- Use `/workflows` to show workflows in the current bundle, NOT any creation tasks
|
||||
|
||||
### Workflow Descriptions
|
||||
@@ -48,7 +47,7 @@ Available workflows for [Team Name]:
|
||||
[... etc. ...]
|
||||
|
||||
Use /workflow-start {number or id} to begin a workflow.
|
||||
```
|
||||
```text
|
||||
|
||||
### /workflow-start {workflow-id}
|
||||
|
||||
@@ -90,7 +89,7 @@ BMad: I see you've completed Discovery and part of Product Planning.
|
||||
- UX Strategy with Sally (ux-expert)
|
||||
|
||||
Would you like me to load Sally to continue?
|
||||
```
|
||||
```text
|
||||
|
||||
### /workflow-next
|
||||
|
||||
@@ -131,11 +130,11 @@ workflow_state:
|
||||
project-brief:
|
||||
status: completed
|
||||
created_by: analyst
|
||||
timestamp: 2024-01-15T10:30:00Z
|
||||
timestamp: 2024-01-15T10:30:00.000Z
|
||||
prd:
|
||||
status: in-progress
|
||||
created_by: pm
|
||||
started: 2024-01-15T11:00:00Z
|
||||
started: 2024-01-15T11:00:00.000Z
|
||||
```
|
||||
|
||||
### 4. Workflow Interruption Handling
|
||||
@@ -160,7 +159,7 @@ BMad: I see you have a PRD and architecture document. Based on these artifacts,
|
||||
- Load Sarah (Product Owner) to validate all artifacts
|
||||
|
||||
Would you like to continue with this workflow?
|
||||
```
|
||||
```text
|
||||
|
||||
## Workflow Context Passing
|
||||
|
||||
@@ -194,9 +193,9 @@ Some workflows may have multiple paths:
|
||||
|
||||
```yaml
|
||||
conditional_paths:
|
||||
- condition: "project_type == 'mobile'"
|
||||
- condition: project_type == 'mobile'
|
||||
next_stage: mobile-specific-design
|
||||
- condition: "project_type == 'web'"
|
||||
- condition: project_type == 'web'
|
||||
next_stage: web-architecture
|
||||
- default: fullstack-architecture
|
||||
```
|
||||
|
||||
@@ -43,27 +43,24 @@ These references map directly to bundle sections:
|
||||
|
||||
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:
|
||||
|
||||
```yml
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
whenToUse: "Use for system design, architecture documents, technology selection, API design, and infrastructure planning"
|
||||
customization:
|
||||
|
||||
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Holistic System Architect & Full-Stack Technical Leader
|
||||
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
||||
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
||||
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
||||
|
||||
core_principles:
|
||||
- Holistic System Thinking - View every component as part of a larger system
|
||||
- User Experience Drives Architecture - Start with user journeys and work backward
|
||||
@@ -75,24 +72,22 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
- "*execute-checklist {checklist}" - Run architectural validation checklist
|
||||
- "*research {topic}" - Generate deep research prompt for architectural decisions
|
||||
- "*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run architectural validation checklist'
|
||||
- '*research {topic}" - Generate deep research prompt for architectural decisions'
|
||||
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
@@ -184,106 +179,6 @@ If template specifies a checklist:
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
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.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
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.
|
||||
|
||||
## Instructions
|
||||
|
||||
1. **Initial Assessment**
|
||||
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
- Confirm if they want to work through the checklist:
|
||||
- Section by section (interactive mode - very time consuming)
|
||||
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
||||
|
||||
2. **Document and Artifact Gathering**
|
||||
|
||||
- Each checklist will specify its required documents/artifacts at the beginning
|
||||
- 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.
|
||||
|
||||
3. **Checklist Processing**
|
||||
|
||||
If in interactive mode:
|
||||
|
||||
- Work through each section of the checklist one at a time
|
||||
- For each section:
|
||||
- Review all items in the section following instructions for that section embedded in the checklist
|
||||
- Check each item against the relevant documentation or artifacts as appropriate
|
||||
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
|
||||
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
||||
|
||||
If in YOLO mode:
|
||||
|
||||
- Process all sections at once
|
||||
- Create a comprehensive report of all findings
|
||||
- Present the complete analysis to the user
|
||||
|
||||
4. **Validation Approach**
|
||||
|
||||
For each checklist item:
|
||||
|
||||
- Read and understand the requirement
|
||||
- Look for evidence in the documentation that satisfies the requirement
|
||||
- Consider both explicit mentions and implicit coverage
|
||||
- Aside from this, follow all checklist llm instructions
|
||||
- Mark items as:
|
||||
- ✅ PASS: Requirement clearly met
|
||||
- ❌ FAIL: Requirement not met or insufficient coverage
|
||||
- ⚠️ PARTIAL: Some aspects covered but needs improvement
|
||||
- N/A: Not applicable to this case
|
||||
|
||||
5. **Section Analysis**
|
||||
|
||||
For each section:
|
||||
|
||||
- think step by step to calculate pass rate
|
||||
- Identify common themes in failed items
|
||||
- Provide specific recommendations for improvement
|
||||
- In interactive mode, discuss findings with user
|
||||
- Document any user decisions or explanations
|
||||
|
||||
6. **Final Report**
|
||||
|
||||
Prepare a summary that includes:
|
||||
|
||||
- Overall checklist completion status
|
||||
- Pass rates by section
|
||||
- List of failed items with context
|
||||
- Specific recommendations for improvement
|
||||
- Any sections or items marked as N/A with justification
|
||||
|
||||
## Checklist Execution Methodology
|
||||
|
||||
Each checklist now contains embedded LLM prompts and instructions that will:
|
||||
|
||||
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
|
||||
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
|
||||
3. **Provide contextual guidance** - Section-specific prompts for better validation
|
||||
4. **Generate comprehensive reports** - Final summary with detailed findings
|
||||
|
||||
The LLM will:
|
||||
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
|
||||
==================== START: tasks#create-deep-research-prompt ====================
|
||||
# Create Deep Research Prompt Task
|
||||
|
||||
@@ -588,6 +483,498 @@ Present these numbered options to the user:
|
||||
- Plan for iterative refinement based on initial findings
|
||||
==================== END: tasks#create-deep-research-prompt ====================
|
||||
|
||||
==================== START: tasks#document-project ====================
|
||||
# Document an Existing Project
|
||||
|
||||
## Purpose
|
||||
|
||||
Generate comprehensive documentation for existing projects optimized for AI development agents. This task creates structured reference materials that enable AI agents to understand project context, conventions, and patterns for effective contribution to any codebase.
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Initial Project Analysis
|
||||
|
||||
[[LLM: Begin by conducting a comprehensive analysis of the existing project. Use available tools to:
|
||||
|
||||
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
||||
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
||||
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
||||
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
||||
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
||||
|
||||
Ask the user these elicitation questions to better understand their needs:
|
||||
|
||||
- What is the primary purpose of this project?
|
||||
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
||||
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
||||
- Are there any existing documentation standards or formats you prefer?
|
||||
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
||||
]]
|
||||
|
||||
### 2. Core Documentation Generation
|
||||
|
||||
[[LLM: Based on your analysis, generate the following core documentation files. Adapt the content and structure to match the specific project type and context you discovered:
|
||||
|
||||
**Core Documents (always generate):**
|
||||
|
||||
1. **docs/index.md** - Master documentation index
|
||||
2. **docs/architecture/index.md** - Architecture documentation index
|
||||
3. **docs/architecture/coding-standards.md** - Coding conventions and style guidelines
|
||||
4. **docs/architecture/tech-stack.md** - Technology stack and version constraints
|
||||
5. **docs/architecture/unified-project-structure.md** - Project structure and organization
|
||||
6. **docs/architecture/testing-strategy.md** - Testing approaches and requirements
|
||||
|
||||
**Backend Documents (generate for backend/full-stack projects):**
|
||||
|
||||
7. **docs/architecture/backend-architecture.md** - Backend service patterns and structure
|
||||
8. **docs/architecture/rest-api-spec.md** - API endpoint specifications
|
||||
9. **docs/architecture/data-models.md** - Data structures and validation rules
|
||||
10. **docs/architecture/database-schema.md** - Database design and relationships
|
||||
11. **docs/architecture/external-apis.md** - Third-party integrations
|
||||
|
||||
**Frontend Documents (generate for frontend/full-stack projects):**
|
||||
|
||||
12. **docs/architecture/frontend-architecture.md** - Frontend patterns and structure
|
||||
13. **docs/architecture/components.md** - UI component specifications
|
||||
14. **docs/architecture/core-workflows.md** - User interaction flows
|
||||
15. **docs/architecture/ui-ux-spec.md** - UI/UX specifications and guidelines
|
||||
|
||||
**Additional Documents (generate if applicable):**
|
||||
|
||||
16. **docs/prd.md** - Product requirements document (if not exists)
|
||||
17. **docs/architecture/deployment-guide.md** - Deployment and operations info
|
||||
18. **docs/architecture/security-considerations.md** - Security patterns and requirements
|
||||
19. **docs/architecture/performance-guidelines.md** - Performance optimization patterns
|
||||
|
||||
**Optional Enhancement Documents:**
|
||||
|
||||
20. **docs/architecture/troubleshooting-guide.md** - Common issues and solutions
|
||||
21. **docs/architecture/changelog-conventions.md** - Change management practices
|
||||
22. **docs/architecture/code-review-checklist.md** - Review standards and practices
|
||||
|
||||
Present each document section by section, using the advanced elicitation task after each major section.]]
|
||||
|
||||
### 3. Document Structure Template
|
||||
|
||||
[[LLM: Use this standardized structure for each documentation file, adapting content as needed:
|
||||
|
||||
```markdown
|
||||
# {{Document Title}}
|
||||
|
||||
## Overview
|
||||
|
||||
{{Brief description of what this document covers and why it's important for AI agents}}
|
||||
|
||||
## Quick Reference
|
||||
|
||||
{{Key points, commands, or patterns that agents need most frequently}}
|
||||
|
||||
## Detailed Information
|
||||
|
||||
{{Comprehensive information organized into logical sections}}
|
||||
|
||||
## Examples
|
||||
|
||||
{{Concrete examples showing proper usage or implementation}}
|
||||
|
||||
## Common Patterns
|
||||
|
||||
{{Recurring patterns agents should recognize and follow}}
|
||||
|
||||
## Things to Avoid
|
||||
|
||||
{{Anti-patterns, deprecated approaches, or common mistakes}}
|
||||
|
||||
## Related Resources
|
||||
|
||||
{{Links to other relevant documentation or external resources}}
|
||||
```
|
||||
|
||||
Each document should be:
|
||||
|
||||
- **Concrete and actionable** - Focus on what agents need to do, not just concepts
|
||||
- **Pattern-focused** - Highlight recurring patterns agents can recognize and replicate
|
||||
- **Example-rich** - Include specific code examples and real file references
|
||||
- **Context-aware** - Reference actual project files, folders, and conventions
|
||||
- **Assumption-free** - Don't assume agents know project history or implicit knowledge
|
||||
]]
|
||||
|
||||
### 4. Content Guidelines for Each Document Type
|
||||
|
||||
#### Core Architecture Documents
|
||||
|
||||
##### docs/architecture/index.md
|
||||
|
||||
[[LLM: Create a comprehensive index of all architecture documentation:
|
||||
|
||||
- List all architecture documents with brief descriptions
|
||||
- Group documents by category (backend, frontend, shared)
|
||||
- Include quick links to key sections
|
||||
- Provide reading order recommendations for different use cases]]
|
||||
|
||||
##### docs/architecture/unified-project-structure.md
|
||||
|
||||
[[LLM: Document the complete project structure:
|
||||
|
||||
- Root-level directory structure with explanations
|
||||
- Where each type of code belongs (backend, frontend, tests, etc.)
|
||||
- File naming conventions and patterns
|
||||
- Module/package organization
|
||||
- Generated vs. source file locations
|
||||
- Build output locations]]
|
||||
|
||||
##### docs/architecture/coding-standards.md
|
||||
|
||||
[[LLM: Capture project-wide coding conventions:
|
||||
|
||||
- Language-specific style guidelines
|
||||
- Naming conventions (variables, functions, classes, files)
|
||||
- Code organization within files
|
||||
- Import/export patterns
|
||||
- Comment and documentation standards
|
||||
- Linting and formatting tool configurations
|
||||
- Git commit message conventions]]
|
||||
|
||||
##### docs/architecture/tech-stack.md
|
||||
|
||||
[[LLM: Document all technologies and versions:
|
||||
|
||||
- Primary languages and versions
|
||||
- Frameworks and major libraries with versions
|
||||
- Development tools and their versions
|
||||
- Database systems and versions
|
||||
- External services and APIs used
|
||||
- Browser/runtime requirements]]
|
||||
|
||||
##### docs/architecture/testing-strategy.md
|
||||
|
||||
[[LLM: Define testing approaches and requirements:
|
||||
|
||||
- Test file locations and naming conventions
|
||||
- Unit testing patterns and frameworks
|
||||
- Integration testing approaches
|
||||
- E2E testing setup (if applicable)
|
||||
- Test coverage requirements
|
||||
- Mocking strategies
|
||||
- Test data management]]
|
||||
|
||||
#### Backend Architecture Documents
|
||||
|
||||
##### docs/architecture/backend-architecture.md
|
||||
|
||||
[[LLM: Document backend service structure:
|
||||
|
||||
- Service layer organization
|
||||
- Controller/route patterns
|
||||
- Middleware architecture
|
||||
- Authentication/authorization patterns
|
||||
- Request/response flow
|
||||
- Background job processing
|
||||
- Service communication patterns]]
|
||||
|
||||
##### docs/architecture/rest-api-spec.md
|
||||
|
||||
[[LLM: Specify all API endpoints:
|
||||
|
||||
- Base URL and versioning strategy
|
||||
- Authentication methods
|
||||
- Common headers and parameters
|
||||
- Each endpoint with:
|
||||
- HTTP method and path
|
||||
- Request parameters/body
|
||||
- Response format and status codes
|
||||
- Error responses
|
||||
- Rate limiting and quotas]]
|
||||
|
||||
##### docs/architecture/data-models.md
|
||||
|
||||
[[LLM: Define data structures and validation:
|
||||
|
||||
- Core business entities
|
||||
- Data validation rules
|
||||
- Relationships between entities
|
||||
- Computed fields and derivations
|
||||
- Data transformation patterns
|
||||
- Serialization formats]]
|
||||
|
||||
##### docs/architecture/database-schema.md
|
||||
|
||||
[[LLM: Document database design:
|
||||
|
||||
- Database type and version
|
||||
- Table/collection structures
|
||||
- Indexes and constraints
|
||||
- Relationships and foreign keys
|
||||
- Migration patterns
|
||||
- Seed data requirements
|
||||
- Backup and recovery procedures]]
|
||||
|
||||
##### docs/architecture/external-apis.md
|
||||
|
||||
[[LLM: Document third-party integrations:
|
||||
|
||||
- List of external services used
|
||||
- Authentication methods for each
|
||||
- API endpoints and usage patterns
|
||||
- Rate limits and quotas
|
||||
- Error handling strategies
|
||||
- Webhook configurations
|
||||
- Data synchronization patterns]]
|
||||
|
||||
#### Frontend Architecture Documents
|
||||
|
||||
##### docs/architecture/frontend-architecture.md
|
||||
|
||||
[[LLM: Document frontend application structure:
|
||||
|
||||
- Component hierarchy and organization
|
||||
- State management patterns
|
||||
- Routing architecture
|
||||
- Data fetching patterns
|
||||
- Authentication flow
|
||||
- Error boundary strategies
|
||||
- Performance optimization patterns]]
|
||||
|
||||
##### docs/architecture/components.md
|
||||
|
||||
[[LLM: Specify UI components:
|
||||
|
||||
- Component library/design system used
|
||||
- Custom component specifications
|
||||
- Props and state for each component
|
||||
- Component composition patterns
|
||||
- Styling approaches
|
||||
- Accessibility requirements
|
||||
- Component testing patterns]]
|
||||
|
||||
##### docs/architecture/core-workflows.md
|
||||
|
||||
[[LLM: Document user interaction flows:
|
||||
|
||||
- Major user journeys
|
||||
- Screen flow diagrams
|
||||
- Form handling patterns
|
||||
- Navigation patterns
|
||||
- Data flow through workflows
|
||||
- Error states and recovery
|
||||
- Loading and transition states]]
|
||||
|
||||
##### docs/architecture/ui-ux-spec.md
|
||||
|
||||
[[LLM: Define UI/UX guidelines:
|
||||
|
||||
- Design system specifications
|
||||
- Color palette and typography
|
||||
- Spacing and layout grids
|
||||
- Responsive breakpoints
|
||||
- Animation and transition guidelines
|
||||
- Accessibility standards
|
||||
- Browser compatibility requirements]]
|
||||
|
||||
### 5. Adaptive Content Strategy
|
||||
|
||||
[[LLM: Adapt your documentation approach based on project characteristics:
|
||||
|
||||
**For Web Applications:**
|
||||
|
||||
- Focus on component patterns, routing, state management
|
||||
- Include build processes, asset handling, and deployment
|
||||
- Cover API integration patterns and data fetching
|
||||
|
||||
**For Backend Services:**
|
||||
|
||||
- Emphasize service architecture, data models, and API design
|
||||
- Include database interaction patterns and migration strategies
|
||||
- Cover authentication, authorization, and security patterns
|
||||
|
||||
**For CLI Tools:**
|
||||
|
||||
- Focus on command structure, argument parsing, and output formatting
|
||||
- Include plugin/extension patterns if applicable
|
||||
- Cover configuration file handling and user interaction patterns
|
||||
|
||||
**For Libraries/Frameworks:**
|
||||
|
||||
- Emphasize public API design and usage patterns
|
||||
- Include extension points and customization approaches
|
||||
- Cover versioning, compatibility, and migration strategies
|
||||
|
||||
**For Mobile Applications:**
|
||||
|
||||
- Focus on platform-specific patterns and navigation
|
||||
- Include state management and data persistence approaches
|
||||
- Cover platform integration and native feature usage
|
||||
|
||||
**For Data Science/ML Projects:**
|
||||
|
||||
- Emphasize data pipeline patterns and model organization
|
||||
- Include experiment tracking and reproducibility approaches
|
||||
- Cover data validation and model deployment patterns
|
||||
]]
|
||||
|
||||
### 6. Quality Assurance
|
||||
|
||||
[[LLM: Before completing each document:
|
||||
|
||||
1. **Accuracy Check**: Verify all file paths, commands, and code examples work
|
||||
2. **Completeness Review**: Ensure the document covers the most important patterns an agent would encounter
|
||||
3. **Clarity Assessment**: Check that explanations are clear and actionable
|
||||
4. **Consistency Verification**: Ensure terminology and patterns align across all documents
|
||||
5. **Agent Perspective**: Review from the viewpoint of an AI agent that needs to contribute to this project
|
||||
|
||||
Ask the user to review each completed document and use the advanced elicitation task to refine based on their feedback.]]
|
||||
|
||||
### 7. Final Integration
|
||||
|
||||
[[LLM: After all documents are completed:
|
||||
|
||||
1. Ensure all documents are created in the proper BMAD-expected locations:
|
||||
|
||||
- Core docs in `docs/` (index.md, prd.md)
|
||||
- Architecture shards in `docs/architecture/` subdirectory
|
||||
- Create the `docs/architecture/` directory if it doesn't exist
|
||||
|
||||
2. Create/update the master index documents:
|
||||
|
||||
- Update `docs/index.md` to reference all documentation
|
||||
- Create `docs/architecture/index.md` listing all architecture shards
|
||||
|
||||
3. Verify document cross-references:
|
||||
|
||||
- Ensure all documents link to related documentation
|
||||
- Check that file paths match the actual project structure
|
||||
- Validate that examples reference real files in the project
|
||||
|
||||
4. Provide maintenance guidance:
|
||||
|
||||
- Document update triggers (when to update each doc)
|
||||
- Create a simple checklist for keeping docs current
|
||||
- Suggest automated validation approaches
|
||||
|
||||
5. Summary report including:
|
||||
- List of all documents created with their paths
|
||||
- Any gaps or areas needing human review
|
||||
- Recommendations for project-specific additions
|
||||
- Next steps for maintaining documentation accuracy
|
||||
|
||||
Present a summary of what was created and ask if any additional documentation would be helpful for AI agents working on this specific project.]]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Documentation enables AI agents to understand project context without additional explanation
|
||||
- All major architectural patterns and coding conventions are captured
|
||||
- Examples reference actual project files and demonstrate real usage
|
||||
- Documentation is structured consistently and easy to navigate
|
||||
- Content is actionable and focuses on what agents need to do, not just understand
|
||||
|
||||
## Notes
|
||||
|
||||
- This task is designed to work with any project type, language, or framework
|
||||
- The documentation should reflect the project as it actually is, not as it should be
|
||||
- Focus on patterns that agents can recognize and replicate consistently
|
||||
- Include both positive examples (what to do) and negative examples (what to avoid)
|
||||
==================== END: tasks#document-project ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
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.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
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.
|
||||
|
||||
## Instructions
|
||||
|
||||
1. **Initial Assessment**
|
||||
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
- Confirm if they want to work through the checklist:
|
||||
- Section by section (interactive mode - very time consuming)
|
||||
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
||||
|
||||
2. **Document and Artifact Gathering**
|
||||
|
||||
- Each checklist will specify its required documents/artifacts at the beginning
|
||||
- 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.
|
||||
|
||||
3. **Checklist Processing**
|
||||
|
||||
If in interactive mode:
|
||||
|
||||
- Work through each section of the checklist one at a time
|
||||
- For each section:
|
||||
- Review all items in the section following instructions for that section embedded in the checklist
|
||||
- Check each item against the relevant documentation or artifacts as appropriate
|
||||
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
|
||||
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
||||
|
||||
If in YOLO mode:
|
||||
|
||||
- Process all sections at once
|
||||
- Create a comprehensive report of all findings
|
||||
- Present the complete analysis to the user
|
||||
|
||||
4. **Validation Approach**
|
||||
|
||||
For each checklist item:
|
||||
|
||||
- Read and understand the requirement
|
||||
- Look for evidence in the documentation that satisfies the requirement
|
||||
- Consider both explicit mentions and implicit coverage
|
||||
- Aside from this, follow all checklist llm instructions
|
||||
- Mark items as:
|
||||
- ✅ PASS: Requirement clearly met
|
||||
- ❌ FAIL: Requirement not met or insufficient coverage
|
||||
- ⚠️ PARTIAL: Some aspects covered but needs improvement
|
||||
- N/A: Not applicable to this case
|
||||
|
||||
5. **Section Analysis**
|
||||
|
||||
For each section:
|
||||
|
||||
- think step by step to calculate pass rate
|
||||
- Identify common themes in failed items
|
||||
- Provide specific recommendations for improvement
|
||||
- In interactive mode, discuss findings with user
|
||||
- Document any user decisions or explanations
|
||||
|
||||
6. **Final Report**
|
||||
|
||||
Prepare a summary that includes:
|
||||
|
||||
- Overall checklist completion status
|
||||
- Pass rates by section
|
||||
- List of failed items with context
|
||||
- Specific recommendations for improvement
|
||||
- Any sections or items marked as N/A with justification
|
||||
|
||||
## Checklist Execution Methodology
|
||||
|
||||
Each checklist now contains embedded LLM prompts and instructions that will:
|
||||
|
||||
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
|
||||
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
|
||||
3. **Provide contextual guidance** - Section-specific prompts for better validation
|
||||
4. **Generate comprehensive reports** - Final summary with detailed findings
|
||||
|
||||
The LLM will:
|
||||
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
|
||||
==================== START: templates#architecture-tmpl ====================
|
||||
# {{Project Name}} Architecture Document
|
||||
|
||||
@@ -727,7 +1114,7 @@ Common patterns to consider:
|
||||
|
||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||
|
||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences`
|
||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences`
|
||||
2. For each category, present 2-3 viable options with pros/cons
|
||||
3. Make a clear recommendation based on project needs
|
||||
4. Get explicit user approval for each selection
|
||||
@@ -935,15 +1322,18 @@ Use YAML format for better readability. If no REST API, skip this section.]]
|
||||
```yaml
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title: { { api_title } }
|
||||
version: { { api_version } }
|
||||
description: { { api_description } }
|
||||
|
||||
title:
|
||||
'[object Object]': null
|
||||
version:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
servers:
|
||||
- url: { { api_base_url } }
|
||||
description: { { environment } }
|
||||
# ... OpenAPI specification continues
|
||||
```
|
||||
- url:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
```text
|
||||
|
||||
^^/CONDITION: has_rest_api^^
|
||||
|
||||
@@ -1054,7 +1444,7 @@ Get user input on deployment preferences and CI/CD tool choices.]]
|
||||
|
||||
### Environment Promotion Flow
|
||||
|
||||
```
|
||||
```text
|
||||
{{promotion_flow_diagram}}
|
||||
```
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1237,7 +1237,7 @@ Document sharded successfully:
|
||||
|
||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
||||
|
||||
1. Check if `data#technical-preferences` file exists - use it to pre-populate choices
|
||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
@@ -1683,7 +1683,7 @@ so that {{benefit}}.
|
||||
|
||||
[[LLM: Gather technical decisions that will be used for this simple technical PRD that includes architecture decisions. Steps:
|
||||
|
||||
1. Check if `data#technical-preferences` file exists - use it to pre-populate choices
|
||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
|
||||
@@ -112,60 +112,53 @@ dependencies:
|
||||
|
||||
## Purpose
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Completed UI/UX Specification (`front-end-spec-tmpl`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`)
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack)
|
||||
- Primary Design Files (Figma, Sketch, etc. - for visual context if the tool can accept it or if descriptions are needed)
|
||||
- Completed UI/UX Specification (`front-end-spec`)
|
||||
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
||||
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
||||
|
||||
## Key Activities & Instructions
|
||||
|
||||
1. **Confirm Target AI Generation Platform:**
|
||||
### 1. Core Prompting Principles
|
||||
|
||||
- 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.).
|
||||
- Explain that prompt optimization might differ slightly based on the platform's capabilities and preferred input format.
|
||||
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
||||
|
||||
2. **Synthesize Inputs into a Structured Prompt:**
|
||||
- **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.
|
||||
- **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.
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
- **Overall Project Context:**
|
||||
- Briefly state the project's purpose (from brief/PRD).
|
||||
- Specify the chosen frontend framework, core libraries, and UI component library (from `front-end-architecture` and main `architecture`).
|
||||
- Mention the styling approach (e.g., Tailwind CSS, CSS Modules).
|
||||
- **Design System & Visuals:**
|
||||
- Reference the primary design files (e.g., Figma link).
|
||||
- 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`).
|
||||
- List any global UI components or design tokens that should be defined or adhered to.
|
||||
- **Application Structure & Routing:**
|
||||
- Describe the main pages/views and their routes (from `front-end-architecture` - Routing Strategy).
|
||||
- Outline the navigation structure (from `front-end-spec-tmpl`).
|
||||
- **Key User Flows & Page-Level Interactions:**
|
||||
- For a few critical user flows (from `front-end-spec-tmpl`):
|
||||
- Describe the sequence of user actions and expected UI changes on each relevant page.
|
||||
- Specify API calls to be made (referencing API endpoints from the main `architecture`) and how data should be displayed or used.
|
||||
- **Component Generation Instructions (Iterative or Key Components):**
|
||||
- Based on the chosen AI tool's capabilities, decide on a strategy:
|
||||
- **Option 1 (Scaffolding):** Prompt for the generation of main page structures, layouts, and placeholders for components.
|
||||
- **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).
|
||||
- **Option 3 (Holistic, if tool supports):** Attempt to describe the entire application structure and key components more broadly.
|
||||
- <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>
|
||||
- **State Management (High-Level Pointers):**
|
||||
- Mention the chosen state management solution (e.g., "Use Redux Toolkit").
|
||||
- For key pieces of data, indicate if they should be managed in global state.
|
||||
- **API Integration Points:**
|
||||
- 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).
|
||||
- **Critical "Don'ts" or Constraints:**
|
||||
- e.g., "Do not use deprecated libraries." "Ensure all forms have basic client-side validation."
|
||||
- **Platform-Specific Optimizations:**
|
||||
- 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).
|
||||
### 2. The Structured Prompting Framework
|
||||
|
||||
3. **Present and Refine the Master Prompt:**
|
||||
- Output the generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included.
|
||||
- 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.
|
||||
- <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>
|
||||
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
||||
|
||||
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
||||
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
||||
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.
|
||||
- _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."_
|
||||
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.
|
||||
- _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."_
|
||||
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.
|
||||
- _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."_
|
||||
|
||||
### 3. Assembling the Master Prompt
|
||||
|
||||
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
||||
|
||||
1. **Gather Foundational Context**:
|
||||
- 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.
|
||||
2. **Describe the Visuals**:
|
||||
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
||||
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
||||
3. **Build the Prompt using the Structured Framework**:
|
||||
- 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.
|
||||
4. **Present and Refine**:
|
||||
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
||||
- <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>
|
||||
==================== END: tasks#generate-ai-frontend-prompt ====================
|
||||
|
||||
==================== START: tasks#create-deep-research-prompt ====================
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -6,27 +6,24 @@ When this command is used, adopt the following agent persona:
|
||||
|
||||
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:
|
||||
|
||||
```yml
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
whenToUse: "Use for system design, architecture documents, technology selection, API design, and infrastructure planning"
|
||||
customization:
|
||||
|
||||
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Holistic System Architect & Full-Stack Technical Leader
|
||||
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
||||
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
||||
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
||||
|
||||
core_principles:
|
||||
- Holistic System Thinking - View every component as part of a larger system
|
||||
- User Experience Drives Architecture - Start with user journeys and work backward
|
||||
@@ -38,24 +35,22 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
- "*execute-checklist {checklist}" - Run architectural validation checklist
|
||||
- "*research {topic}" - Generate deep research prompt for architectural decisions
|
||||
- "*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run architectural validation checklist'
|
||||
- '*research {topic}" - Generate deep research prompt for architectural decisions'
|
||||
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
|
||||
@@ -59,10 +59,8 @@ dependencies:
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-expansion-pack
|
||||
- create-agent
|
||||
- document-project
|
||||
- create-next-story
|
||||
- create-team
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
@@ -73,7 +71,6 @@ dependencies:
|
||||
- brownfield-architecture-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- front-end-spec-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
@@ -89,8 +86,6 @@ dependencies:
|
||||
- agent-switcher.ide
|
||||
- template-format
|
||||
- workflow-management
|
||||
schemas:
|
||||
- agent-team-schema
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
|
||||
@@ -6,20 +6,18 @@ When this command is used, adopt the following agent persona:
|
||||
|
||||
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yml
|
||||
```yaml
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: "Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult"
|
||||
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
- Never pre-load resources - discover and load at runtime
|
||||
@@ -29,52 +27,42 @@ persona:
|
||||
- Be explicit about active persona and current task
|
||||
- Always use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
startup:
|
||||
- Announce: "Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options."
|
||||
- Announce: Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options.
|
||||
- Assess user goal, suggest agent transformation if match, offer numbered options if generic
|
||||
- Load resources only when needed
|
||||
|
||||
commands:
|
||||
- "*help" - Show commands/workflows/agents
|
||||
- "*chat-mode" - Conversational mode with advanced-elicitation
|
||||
- "*kb-mode" - Load knowledge base for full BMAD help
|
||||
- "*status" - Show current context/agent/progress
|
||||
- "*agent {name}" - Transform into agent (list if unspecified)
|
||||
- "*exit" - Return to BMad or exit (confirm if exiting BMad)
|
||||
- "*task {name}" - Run task (list if unspecified)
|
||||
- "*workflow {type}" - Start/list workflows
|
||||
- "*checklist {name}" - Execute checklist (list if unspecified)
|
||||
- "*yolo" - Toggle skip confirmations
|
||||
- "*party-mode" - Group chat with all agents
|
||||
- "*doc-out" - Output full document
|
||||
|
||||
- '*help" - Show commands/workflows/agents'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation'
|
||||
- '*kb-mode" - Load knowledge base for full BMAD help'
|
||||
- '*status" - Show current context/agent/progress'
|
||||
- '*agent {name}" - Transform into agent (list if unspecified)'
|
||||
- '*exit" - Return to BMad or exit (confirm if exiting BMad)'
|
||||
- '*task {name}" - Run task (list if unspecified)'
|
||||
- '*workflow {type}" - Start/list workflows'
|
||||
- '*checklist {name}" - Execute checklist (list if unspecified)'
|
||||
- '*yolo" - Toggle skip confirmations'
|
||||
- '*party-mode" - Group chat with all agents'
|
||||
- '*doc-out" - Output full document'
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
|
||||
transformation:
|
||||
- Match name/role to agents
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- 'Templates/Tasks: Only when executing'
|
||||
- Always indicate loading
|
||||
|
||||
workflow:
|
||||
- Ask project type (greenfield/brownfield)
|
||||
- Ask scope (UI/service/fullstack/other)
|
||||
- Recommend workflow, guide through stages
|
||||
- Explain web context management if needed
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- create-team
|
||||
- create-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
data:
|
||||
|
||||
@@ -14,25 +14,22 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
|
||||
```yml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
whenToUse: "Use for system design, architecture documents, technology selection, API design, and infrastructure planning"
|
||||
customization:
|
||||
|
||||
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Holistic System Architect & Full-Stack Technical Leader
|
||||
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
||||
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
||||
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
||||
|
||||
core_principles:
|
||||
- Holistic System Thinking - View every component as part of a larger system
|
||||
- User Experience Drives Architecture - Start with user journeys and work backward
|
||||
@@ -44,24 +41,22 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
- "*execute-checklist {checklist}" - Run architectural validation checklist
|
||||
- "*research {topic}" - Generate deep research prompt for architectural decisions
|
||||
- "*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run architectural validation checklist'
|
||||
- '*research {topic}" - Generate deep research prompt for architectural decisions'
|
||||
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
|
||||
@@ -65,10 +65,8 @@ dependencies:
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-expansion-pack
|
||||
- create-agent
|
||||
- document-project
|
||||
- create-next-story
|
||||
- create-team
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
@@ -79,7 +77,6 @@ dependencies:
|
||||
- brownfield-architecture-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- front-end-spec-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
@@ -95,8 +92,6 @@ dependencies:
|
||||
- agent-switcher.ide
|
||||
- template-format
|
||||
- workflow-management
|
||||
schemas:
|
||||
- agent-team-schema
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
|
||||
@@ -18,14 +18,12 @@ agent:
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: "Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult"
|
||||
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
- Never pre-load resources - discover and load at runtime
|
||||
@@ -35,52 +33,42 @@ persona:
|
||||
- Be explicit about active persona and current task
|
||||
- Always use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
startup:
|
||||
- Announce: "Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options."
|
||||
- Announce: Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options.
|
||||
- Assess user goal, suggest agent transformation if match, offer numbered options if generic
|
||||
- Load resources only when needed
|
||||
|
||||
commands:
|
||||
- "*help" - Show commands/workflows/agents
|
||||
- "*chat-mode" - Conversational mode with advanced-elicitation
|
||||
- "*kb-mode" - Load knowledge base for full BMAD help
|
||||
- "*status" - Show current context/agent/progress
|
||||
- "*agent {name}" - Transform into agent (list if unspecified)
|
||||
- "*exit" - Return to BMad or exit (confirm if exiting BMad)
|
||||
- "*task {name}" - Run task (list if unspecified)
|
||||
- "*workflow {type}" - Start/list workflows
|
||||
- "*checklist {name}" - Execute checklist (list if unspecified)
|
||||
- "*yolo" - Toggle skip confirmations
|
||||
- "*party-mode" - Group chat with all agents
|
||||
- "*doc-out" - Output full document
|
||||
|
||||
- '*help" - Show commands/workflows/agents'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation'
|
||||
- '*kb-mode" - Load knowledge base for full BMAD help'
|
||||
- '*status" - Show current context/agent/progress'
|
||||
- '*agent {name}" - Transform into agent (list if unspecified)'
|
||||
- '*exit" - Return to BMad or exit (confirm if exiting BMad)'
|
||||
- '*task {name}" - Run task (list if unspecified)'
|
||||
- '*workflow {type}" - Start/list workflows'
|
||||
- '*checklist {name}" - Execute checklist (list if unspecified)'
|
||||
- '*yolo" - Toggle skip confirmations'
|
||||
- '*party-mode" - Group chat with all agents'
|
||||
- '*doc-out" - Output full document'
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
|
||||
transformation:
|
||||
- Match name/role to agents
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- 'Templates/Tasks: Only when executing'
|
||||
- Always indicate loading
|
||||
|
||||
workflow:
|
||||
- Ask project type (greenfield/brownfield)
|
||||
- Ask scope (UI/service/fullstack/other)
|
||||
- Recommend workflow, guide through stages
|
||||
- Explain web context management if needed
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- create-team
|
||||
- create-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
data:
|
||||
|
||||
@@ -8,25 +8,22 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
|
||||
```yml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- 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
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
whenToUse: "Use for system design, architecture documents, technology selection, API design, and infrastructure planning"
|
||||
customization:
|
||||
|
||||
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Holistic System Architect & Full-Stack Technical Leader
|
||||
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
||||
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
||||
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
||||
|
||||
core_principles:
|
||||
- Holistic System Thinking - View every component as part of a larger system
|
||||
- User Experience Drives Architecture - Start with user journeys and work backward
|
||||
@@ -38,24 +35,22 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
- "*execute-checklist {checklist}" - Run architectural validation checklist
|
||||
- "*research {topic}" - Generate deep research prompt for architectural decisions
|
||||
- "*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run architectural validation checklist'
|
||||
- '*research {topic}" - Generate deep research prompt for architectural decisions'
|
||||
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
|
||||
@@ -59,10 +59,8 @@ dependencies:
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-expansion-pack
|
||||
- create-agent
|
||||
- document-project
|
||||
- create-next-story
|
||||
- create-team
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
@@ -73,7 +71,6 @@ dependencies:
|
||||
- brownfield-architecture-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- front-end-spec-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
@@ -89,8 +86,6 @@ dependencies:
|
||||
- agent-switcher.ide
|
||||
- template-format
|
||||
- workflow-management
|
||||
schemas:
|
||||
- agent-team-schema
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
|
||||
@@ -12,14 +12,12 @@ agent:
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: "Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult"
|
||||
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
- Never pre-load resources - discover and load at runtime
|
||||
@@ -29,52 +27,42 @@ persona:
|
||||
- Be explicit about active persona and current task
|
||||
- Always use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
startup:
|
||||
- Announce: "Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options."
|
||||
- Announce: Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options.
|
||||
- Assess user goal, suggest agent transformation if match, offer numbered options if generic
|
||||
- Load resources only when needed
|
||||
|
||||
commands:
|
||||
- "*help" - Show commands/workflows/agents
|
||||
- "*chat-mode" - Conversational mode with advanced-elicitation
|
||||
- "*kb-mode" - Load knowledge base for full BMAD help
|
||||
- "*status" - Show current context/agent/progress
|
||||
- "*agent {name}" - Transform into agent (list if unspecified)
|
||||
- "*exit" - Return to BMad or exit (confirm if exiting BMad)
|
||||
- "*task {name}" - Run task (list if unspecified)
|
||||
- "*workflow {type}" - Start/list workflows
|
||||
- "*checklist {name}" - Execute checklist (list if unspecified)
|
||||
- "*yolo" - Toggle skip confirmations
|
||||
- "*party-mode" - Group chat with all agents
|
||||
- "*doc-out" - Output full document
|
||||
|
||||
- '*help" - Show commands/workflows/agents'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation'
|
||||
- '*kb-mode" - Load knowledge base for full BMAD help'
|
||||
- '*status" - Show current context/agent/progress'
|
||||
- '*agent {name}" - Transform into agent (list if unspecified)'
|
||||
- '*exit" - Return to BMad or exit (confirm if exiting BMad)'
|
||||
- '*task {name}" - Run task (list if unspecified)'
|
||||
- '*workflow {type}" - Start/list workflows'
|
||||
- '*checklist {name}" - Execute checklist (list if unspecified)'
|
||||
- '*yolo" - Toggle skip confirmations'
|
||||
- '*party-mode" - Group chat with all agents'
|
||||
- '*doc-out" - Output full document'
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
|
||||
transformation:
|
||||
- Match name/role to agents
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- 'Templates/Tasks: Only when executing'
|
||||
- Always indicate loading
|
||||
|
||||
workflow:
|
||||
- Ask project type (greenfield/brownfield)
|
||||
- Ask scope (UI/service/fullstack/other)
|
||||
- Recommend workflow, guide through stages
|
||||
- Explain web context management if needed
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- create-team
|
||||
- create-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
data:
|
||||
|
||||
45
CHANGELOG.md
45
CHANGELOG.md
@@ -1,31 +1,36 @@
|
||||
# [5.0.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v5.0.0) (2025-06-15)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
|
||||
* auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
|
||||
* auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
|
||||
* BMAD install creates `.bmad-core/.bmad-core/` directory structure + updates ([#223](https://github.com/bmadcode/BMAD-METHOD/issues/223)) ([28b313c](https://github.com/bmadcode/BMAD-METHOD/commit/28b313c01df41961cebb71fb3bce0fcc7b4b4796))
|
||||
* resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
|
||||
* resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
|
||||
* update dependency resolver to support both yml and yaml code blocks ([ba1e5ce](https://github.com/bmadcode/BMAD-METHOD/commit/ba1e5ceb36f4a0bb204ceee40e92725d3fc57c5f))
|
||||
* update glob usage to modern async API ([927515c](https://github.com/bmadcode/BMAD-METHOD/commit/927515c0895f94ce6fb0adf7cabe2f978c1ee108))
|
||||
* update yaml-format.js to use dynamic chalk imports ([b53d954](https://github.com/bmadcode/BMAD-METHOD/commit/b53d954b7aac68d25d688140ace3b98a43fa0e5f))
|
||||
# [4.4.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.3.0...v4.4.0) (2025-06-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enhance installer with multi-IDE support and sync version bumping ([ebfd4c7](https://github.com/bmadcode/BMAD-METHOD/commit/ebfd4c7dd52fd38d71a4b054cd0c5d45a4b5d226))
|
||||
* improve semantic-release automation and disable manual version bumping ([38a5024](https://github.com/bmadcode/BMAD-METHOD/commit/38a5024026e9588276bc3c6c2b92f36139480ca4))
|
||||
* sync IDE configurations across all platforms ([b6a2f5b](https://github.com/bmadcode/BMAD-METHOD/commit/b6a2f5b25eaf96841bade4e236fffa2ce7de2773))
|
||||
* update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
|
||||
* web bundles include a simplified prd with architecture now for simpler project folderes not needing a full plown architecture doc! ([8773545](https://github.com/bmadcode/BMAD-METHOD/commit/877354525e76cd1c9375e009a3a1429633010226))
|
||||
* improve docs, technical preference usage ([764e770](https://github.com/bmadcode/BMAD-METHOD/commit/764e7702b313f34bb13a8bcce3b637699bb2b8ec))
|
||||
* web bundles updated ([f39b495](https://github.com/bmadcode/BMAD-METHOD/commit/f39b4951e9e37acd7b2bda4124ddd8edb7a6d0df))
|
||||
|
||||
# [5.0.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v5.0.0) (2025-06-15)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
|
||||
- auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
|
||||
- auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
|
||||
- BMAD install creates `.bmad-core/.bmad-core/` directory structure + updates ([#223](https://github.com/bmadcode/BMAD-METHOD/issues/223)) ([28b313c](https://github.com/bmadcode/BMAD-METHOD/commit/28b313c01df41961cebb71fb3bce0fcc7b4b4796))
|
||||
- resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
|
||||
- resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
|
||||
- update dependency resolver to support both yml and yaml code blocks ([ba1e5ce](https://github.com/bmadcode/BMAD-METHOD/commit/ba1e5ceb36f4a0bb204ceee40e92725d3fc57c5f))
|
||||
- update glob usage to modern async API ([927515c](https://github.com/bmadcode/BMAD-METHOD/commit/927515c0895f94ce6fb0adf7cabe2f978c1ee108))
|
||||
- update yaml-format.js to use dynamic chalk imports ([b53d954](https://github.com/bmadcode/BMAD-METHOD/commit/b53d954b7aac68d25d688140ace3b98a43fa0e5f))
|
||||
|
||||
### Features
|
||||
|
||||
- enhance installer with multi-IDE support and sync version bumping ([ebfd4c7](https://github.com/bmadcode/BMAD-METHOD/commit/ebfd4c7dd52fd38d71a4b054cd0c5d45a4b5d226))
|
||||
- improve semantic-release automation and disable manual version bumping ([38a5024](https://github.com/bmadcode/BMAD-METHOD/commit/38a5024026e9588276bc3c6c2b92f36139480ca4))
|
||||
- sync IDE configurations across all platforms ([b6a2f5b](https://github.com/bmadcode/BMAD-METHOD/commit/b6a2f5b25eaf96841bade4e236fffa2ce7de2773))
|
||||
- update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
|
||||
- web bundles include a simplified prd with architecture now for simpler project folderes not needing a full plown architecture doc! ([8773545](https://github.com/bmadcode/BMAD-METHOD/commit/877354525e76cd1c9375e009a3a1429633010226))
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* Manual version bumping via npm scripts is now disabled. Use conventional commits for automated releases.
|
||||
- Manual version bumping via npm scripts is now disabled. Use conventional commits for automated releases.
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.ai/code)
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
||||
|
||||
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
||||
|
||||
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
12
README.md
12
README.md
@@ -241,7 +241,10 @@ Ask the agent you are using for help with /help (in the web) or \*help in the id
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
We welcome contributions!
|
||||
|
||||
- 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
- See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines
|
||||
|
||||
### Development Setup
|
||||
|
||||
@@ -253,6 +256,11 @@ npm install
|
||||
|
||||
## Documentation & Guides
|
||||
|
||||
### Architecture & Technical
|
||||
|
||||
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
||||
|
||||
### Workflow Guides
|
||||
|
||||
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
@@ -274,7 +282,7 @@ MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
## Version History
|
||||
|
||||
- **Current**: [v4.0.0](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
||||
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
||||
- **Previous Versions**:
|
||||
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
|
||||
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
|
||||
|
||||
@@ -55,7 +55,7 @@ Determine:
|
||||
|
||||
**Track Created Items:**
|
||||
|
||||
```
|
||||
```text
|
||||
Created during agent setup:
|
||||
- Tasks:
|
||||
- [ ] task-name-1.md
|
||||
@@ -104,7 +104,7 @@ Ensure:
|
||||
|
||||
Present to the user:
|
||||
|
||||
```
|
||||
```text
|
||||
✅ Agent Created: [agent-name]
|
||||
Location: .bmad-core/agents/[agent-id].md
|
||||
|
||||
@@ -141,18 +141,16 @@ agent:
|
||||
name: Data Analyst
|
||||
id: data-analyst
|
||||
title: Data Analysis Specialist
|
||||
|
||||
persona:
|
||||
role: Expert in data analysis, visualization, and insights extraction
|
||||
style: analytical, data-driven, clear, methodical
|
||||
identity: I am a seasoned data analyst who transforms raw data into actionable insights
|
||||
focus: data exploration, statistical analysis, visualization, reporting
|
||||
|
||||
core_principles:
|
||||
- Data integrity and accuracy above all
|
||||
- Clear communication of complex findings
|
||||
- Actionable insights over raw numbers
|
||||
```
|
||||
```text
|
||||
|
||||
## Creating Missing Dependencies
|
||||
|
||||
@@ -185,12 +183,12 @@ When a required task or template doesn't exist:
|
||||
```yaml
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc # Required if agent creates any documents
|
||||
- analyze-requirements # Custom task for this agent
|
||||
- generate-report # Another custom task
|
||||
- 'create-doc # Required if agent creates any documents'
|
||||
- 'analyze-requirements # Custom task for this agent'
|
||||
- 'generate-report # Another custom task'
|
||||
templates:
|
||||
- requirements-doc # Template for requirements documents
|
||||
- analysis-report # Template for analysis reports
|
||||
- 'requirements-doc # Template for requirements documents'
|
||||
- 'analysis-report # Template for analysis reports'
|
||||
```
|
||||
|
||||
## Notes
|
||||
@@ -83,7 +83,7 @@ Create `expansion-packs/{pack-name}/plan.md` with:
|
||||
## Approval
|
||||
|
||||
User approval received: [ ] Yes
|
||||
```
|
||||
```text
|
||||
|
||||
Important: Wait for user approval before proceeding to Phase 2
|
||||
|
||||
@@ -223,7 +223,7 @@ post_install_message: |
|
||||
- {data-file}.{ext}: {description}
|
||||
|
||||
To use: npm run agent {pack-name}-orchestrator
|
||||
```
|
||||
```text
|
||||
|
||||
### Phase 4: Content Creation
|
||||
|
||||
213
docs/core-architecture.md
Normal file
213
docs/core-architecture.md
Normal file
@@ -0,0 +1,213 @@
|
||||
# BMAD Method: Core Architecture
|
||||
|
||||
This document serves as the definitive source of truth for the BMAD-Method's architecture. It is designed to be understood by both human developers and the AI agents that operate within the framework.
|
||||
|
||||
## 1. Overview
|
||||
|
||||
The BMAD-Method is an AI-Powered Agile Development Framework designed to transform software development by providing specialized AI agents for every role in a complete Agile team. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex software development tasks in a predictable, high-quality manner.
|
||||
|
||||
The system facilitates a full development lifecycle:
|
||||
|
||||
1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
|
||||
2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
|
||||
3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
|
||||
|
||||
## 2. System Architecture Diagram
|
||||
|
||||
The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph BMAD Method Project
|
||||
subgraph Core Framework
|
||||
A["bmad-core"]
|
||||
A --> B["agents"]
|
||||
A --> C["agent-teams"]
|
||||
A --> D["workflows"]
|
||||
A --> E["templates"]
|
||||
A --> F["tasks"]
|
||||
A --> G["checklists"]
|
||||
A --> H["data (KB)"]
|
||||
end
|
||||
|
||||
subgraph Tooling
|
||||
I["tools/builders/web-builder.js"]
|
||||
end
|
||||
|
||||
subgraph Outputs
|
||||
J[".bmad-core/web-bundles"]
|
||||
end
|
||||
|
||||
B -- defines dependencies for --> E
|
||||
B -- defines dependencies for --> F
|
||||
B -- defines dependencies for --> G
|
||||
B -- defines dependencies for --> H
|
||||
|
||||
C -- bundles --> B
|
||||
I -- reads from --> A
|
||||
I -- creates --> J
|
||||
end
|
||||
|
||||
subgraph Target Environments
|
||||
K["IDE (Cursor, VS Code, etc.)"]
|
||||
L["Web UI (Gemini, ChatGPT)"]
|
||||
end
|
||||
|
||||
B --> K
|
||||
J --> L
|
||||
|
||||
style A fill:#1a73e8,color:#fff
|
||||
style I fill:#f9ab00,color:#fff
|
||||
style J fill:#34a853,color:#fff
|
||||
```text
|
||||
|
||||
## 3. Core Components
|
||||
|
||||
The `.bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
|
||||
|
||||
### 3.1. Agents (`.bmad-core/agents/`)
|
||||
|
||||
- **Purpose**: These are the foundational building blocks of the system. Each markdown file (e.g., `bmad-master.md`, `pm.md`, `dev.md`) defines the persona, capabilities, and dependencies of a single AI agent.
|
||||
- **Structure**: An agent file contains a YAML header that specifies its role, persona, dependencies, and startup instructions. These dependencies are lists of tasks, templates, checklists, and data files that the agent is allowed to use.
|
||||
- **Startup Instructions**: Agents can include startup sequences that load project-specific documentation from the `docs/` folder, such as coding standards, API specifications, or project structure documents. This provides immediate project context upon activation.
|
||||
- **Document Integration**: Agents can reference and load documents from the project's `docs/` folder as part of tasks, workflows, or startup sequences. Users can also drag documents directly into chat interfaces to provide additional context.
|
||||
- **Example**: The `bmad-master` agent lists its dependencies, which tells the build tool which files to include in a web bundle and informs the agent of its own capabilities.
|
||||
|
||||
### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
|
||||
|
||||
- **Purpose**: Team files (e.g., `team-all.yml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
|
||||
- **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
|
||||
|
||||
### 3.3. Workflows (`.bmad-core/workflows/`)
|
||||
|
||||
- **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
|
||||
- **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
|
||||
|
||||
### 3.4. Reusable Resources (`templates`, `tasks`, `checklists`, `data`)
|
||||
|
||||
- **Purpose**: These folders house the modular components that are dynamically loaded by agents based on their dependencies.
|
||||
- **`templates/`**: Contains markdown templates for common documents like PRDs, architecture specifications, and user stories.
|
||||
- **`tasks/`**: Defines the instructions for carrying out specific, repeatable actions like "shard-doc" or "create-next-story".
|
||||
- **`checklists/`**: Provides quality assurance checklists for agents like the Product Owner (`po`) or Architect.
|
||||
- **`data/`**: Contains the core knowledge base (`bmad-kb.md`), technical preferences (`technical-preferences.md`), and other key data files.
|
||||
|
||||
#### 3.4.1. Template Processing System
|
||||
|
||||
A key architectural principle of BMAD is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
|
||||
|
||||
The BMAD framework employs a sophisticated template processing system orchestrated by three key components:
|
||||
|
||||
- **`template-format.md`** (`.bmad-core/utils/`): Defines the foundational markup language used throughout all BMAD templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
|
||||
|
||||
- **`create-doc.md`** (`.bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
|
||||
|
||||
- **`advanced-elicitation.md`** (`.bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
|
||||
|
||||
The system maintains a clean separation of concerns: template markup is processed internally by AI agents but never exposed to users, while providing sophisticated AI processing capabilities through embedded intelligence within the templates themselves.
|
||||
|
||||
#### 3.4.2. Technical Preferences System
|
||||
|
||||
BMAD includes a personalization layer through the `technical-preferences.md` file in `.bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
|
||||
|
||||
**Purpose and Benefits:**
|
||||
- **Consistency**: Ensures all agents reference the same technical preferences
|
||||
- **Efficiency**: Eliminates the need to repeatedly specify preferred technologies
|
||||
- **Personalization**: Agents provide recommendations aligned with user preferences
|
||||
- **Learning**: Captures lessons learned and preferences that evolve over time
|
||||
|
||||
**Content Structure:**
|
||||
The file typically includes preferred technology stacks, design patterns, external services, coding standards, and anti-patterns to avoid. Agents automatically reference this file during planning and development to provide contextually appropriate suggestions.
|
||||
|
||||
**Integration Points:**
|
||||
- Templates can reference technical preferences during document generation
|
||||
- Agents suggest preferred technologies when appropriate for project requirements
|
||||
- When preferences don't fit project needs, agents explain alternatives
|
||||
- Web bundles can include preferences content for consistent behavior across platforms
|
||||
|
||||
**Evolution Over Time:**
|
||||
Users are encouraged to continuously update this file with discoveries from projects, adding both positive preferences and technologies to avoid, creating a personalized knowledge base that improves agent recommendations over time.
|
||||
|
||||
## 4. The Build & Delivery Process
|
||||
|
||||
The framework is designed for two primary environments: local IDEs and web-based AI chat interfaces. The `web-builder.js` script is the key to supporting the latter.
|
||||
|
||||
### 4.1. Web Builder (`tools/builders/web-builder.js`)
|
||||
|
||||
- **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `.bmad-core/web-bundles/`.
|
||||
- **Process**:
|
||||
1. **Resolves Dependencies**: For a given agent or team, the script reads its definition file.
|
||||
2. It recursively finds all dependent resources (tasks, templates, etc.) that the agent/team needs.
|
||||
3. **Bundles Content**: It reads the content of all these files and concatenates them into a single, large text file, with clear separators indicating the original file path of each section.
|
||||
4. **Outputs Bundle**: The final `.txt` file is saved in the `web-bundles` directory, ready to be uploaded to a web UI.
|
||||
|
||||
### 4.2. Environment-Specific Usage
|
||||
|
||||
- **For IDEs**: Users interact with the agents directly via their markdown files in `.bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
|
||||
- **For Web UIs**: Users upload a pre-built bundle from `.bmad-core/web-bundles/`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
|
||||
|
||||
## 5. BMAD Workflows
|
||||
|
||||
### 5.1. The Planning Workflow
|
||||
|
||||
Before development begins, BMAD follows a structured planning workflow that establishes the foundation for successful project execution:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A["Start: Project Idea"] --> B{"Optional: Analyst Brainstorming"}
|
||||
B -->|Yes| C["Analyst: Market Research & Analysis"]
|
||||
B -->|No| D["Create Project Brief"]
|
||||
C --> D["Analyst: Create Project Brief"]
|
||||
D --> E["PM: Create PRD from Brief"]
|
||||
E --> F["Architect: Create Architecture from PRD"]
|
||||
F --> G["PO: Run Master Checklist"]
|
||||
G --> H{"Documents Aligned?"}
|
||||
H -->|Yes| I["Planning Complete"]
|
||||
H -->|No| J["PO: Update Epics & Stories"]
|
||||
J --> K["Update PRD/Architecture as needed"]
|
||||
K --> G
|
||||
I --> L["📁 Switch to IDE"]
|
||||
L --> M["PO: Shard Documents"]
|
||||
M --> N["Ready for SM/Dev Cycle"]
|
||||
|
||||
style I fill:#34a853,color:#fff
|
||||
style G fill:#f9ab00,color:#fff
|
||||
style L fill:#1a73e8,color:#fff
|
||||
style N fill:#34a853,color:#fff
|
||||
```
|
||||
|
||||
**Key Planning Phases:**
|
||||
|
||||
1. **Optional Analysis**: Analyst conducts market research and competitive analysis
|
||||
2. **Project Brief**: Foundation document created by Analyst or user
|
||||
3. **PRD Creation**: PM transforms brief into comprehensive product requirements
|
||||
4. **Architecture Design**: Architect creates technical foundation based on PRD
|
||||
5. **Validation & Alignment**: PO ensures all documents are consistent and complete
|
||||
6. **Refinement**: Updates to epics, stories, and documents as needed
|
||||
7. **Environment Transition**: Critical switch from web UI to IDE for development workflow
|
||||
8. **Document Preparation**: PO shards large documents for development consumption
|
||||
|
||||
**Workflow Orchestration**: The `bmad-orchestrator` agent uses these workflow definitions to guide users through the complete process, ensuring proper transitions between planning (web UI) and development (IDE) phases.
|
||||
|
||||
### 5.2. The Core Development Cycle
|
||||
|
||||
Once the initial planning and architecture phases are complete, the project moves into a cyclical development workflow, as detailed in the `bmad-kb.md`. This ensures a steady, sequential, and quality-controlled implementation process.
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
|
||||
B --> C["PO: Shard Arch"]
|
||||
C --> D["Development Phase"]
|
||||
D --> E["Scrum Master: Drafts next story from sharded epic"]
|
||||
E --> F{"User Approval"}
|
||||
F -->|Approved| G["Dev: Implement Story"]
|
||||
F -->|Needs Changes| E
|
||||
G --> H["Dev: Complete story Tasks"]
|
||||
H --> I{"User Verification"}
|
||||
I -->|Verified Complete| J["Mark Story as Done"]
|
||||
I -->|Needs Fixes| G
|
||||
J --> E
|
||||
|
||||
style J fill:#34a853,color:#fff
|
||||
```
|
||||
|
||||
This cycle continues, with the Scrum Master and Developer agents working in tandem, until all stories in the epic are completed.
|
||||
141
docs/how-to-contribute-with-pull-requests.md
Normal file
141
docs/how-to-contribute-with-pull-requests.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# How to Contribute with Pull Requests
|
||||
|
||||
**New to GitHub and pull requests?** This guide will walk you through the basics step by step.
|
||||
|
||||
## What is a Pull Request?
|
||||
|
||||
A pull request (PR) is how you propose changes to a project on GitHub. Think of it as saying "Here are some changes I'd like to make - please review and consider adding them to the main project."
|
||||
|
||||
## Before You Start
|
||||
|
||||
⚠️ **Important**: Please keep your contributions small and focused! We prefer many small, clear changes rather than one massive change. If you're planning something big, please [open an issue](https://github.com/bmadcode/bmad-method/issues) or start a [discussion](https://github.com/bmadcode/bmad-method/discussions) first.
|
||||
|
||||
## Step-by-Step Guide
|
||||
|
||||
### 1. Fork the Repository
|
||||
|
||||
1. Go to the [BMAD-METHOD repository](https://github.com/bmadcode/bmad-method)
|
||||
2. Click the "Fork" button in the top-right corner
|
||||
3. This creates your own copy of the project
|
||||
|
||||
### 2. Clone Your Fork
|
||||
|
||||
```bash
|
||||
# Replace YOUR-USERNAME with your actual GitHub username
|
||||
git clone https://github.com/YOUR-USERNAME/bmad-method.git
|
||||
cd bmad-method
|
||||
```text
|
||||
|
||||
### 3. Create a New Branch
|
||||
|
||||
**Never work directly on the `main` branch!** Always create a new branch for your changes:
|
||||
|
||||
```bash
|
||||
# Create and switch to a new branch
|
||||
git checkout -b fix/typo-in-readme
|
||||
# or
|
||||
git checkout -b feature/add-new-agent
|
||||
```
|
||||
|
||||
**Branch naming tips:**
|
||||
|
||||
- `fix/description` - for bug fixes
|
||||
- `feature/description` - for new features
|
||||
- `docs/description` - for documentation changes
|
||||
|
||||
### 4. Make Your Changes
|
||||
|
||||
- Edit the files you want to change
|
||||
- Keep changes small and focused on one thing
|
||||
- Test your changes if possible
|
||||
|
||||
### 5. Commit Your Changes
|
||||
|
||||
```bash
|
||||
# Add your changes
|
||||
git add .
|
||||
|
||||
# Commit with a clear message
|
||||
git commit -m "Fix typo in README.md"
|
||||
```text
|
||||
|
||||
**Good commit messages:**
|
||||
|
||||
- "Fix typo in installation instructions"
|
||||
- "Add example for new agent usage"
|
||||
- "Update broken link in docs"
|
||||
|
||||
**Bad commit messages:**
|
||||
|
||||
- "stuff"
|
||||
- "changes"
|
||||
- "update"
|
||||
|
||||
### 6. Push to Your Fork
|
||||
|
||||
```bash
|
||||
# Push your branch to your fork
|
||||
git push origin fix/typo-in-readme
|
||||
```
|
||||
|
||||
### 7. Create the Pull Request
|
||||
|
||||
1. Go to your fork on GitHub
|
||||
2. You'll see a green "Compare & pull request" button - click it
|
||||
3. Fill out the PR template:
|
||||
- **Title**: Clear, descriptive title
|
||||
- **Description**: Explain what you changed and why
|
||||
|
||||
### 8. Wait for Review
|
||||
|
||||
- A maintainer will review your PR
|
||||
- They might ask for changes
|
||||
- Be patient and responsive to feedback
|
||||
|
||||
## What Makes a Good Pull Request?
|
||||
|
||||
✅ **Good PRs:**
|
||||
|
||||
- Change one thing at a time
|
||||
- Have clear, descriptive titles
|
||||
- Explain what and why in the description
|
||||
- Include only the files that need to change
|
||||
|
||||
❌ **Avoid:**
|
||||
|
||||
- Changing formatting of entire files
|
||||
- Multiple unrelated changes in one PR
|
||||
- Copying your entire project/repo into the PR
|
||||
- Changes without explanation
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
1. **Don't reformat entire files** - only change what's necessary
|
||||
2. **Don't include unrelated changes** - stick to one fix/feature per PR
|
||||
3. **Don't paste code in issues** - create a proper PR instead
|
||||
4. **Don't submit your whole project** - contribute specific improvements
|
||||
|
||||
## Need Help?
|
||||
|
||||
- 💬 Join our [Discord Community](https://discord.gg/g6ypHytrCB) for real-time help
|
||||
- 💬 Ask questions in [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
||||
- 🐛 Report bugs in [Issues](https://github.com/bmadcode/bmad-method/issues)
|
||||
- 📖 Read the full [Contributing Guidelines](../CONTRIBUTING.md)
|
||||
|
||||
## Example: Good vs Bad PRs
|
||||
|
||||
### 😀 Good PR Example
|
||||
|
||||
**Title**: "Fix broken link to installation guide"
|
||||
**Changes**: One file, one line changed
|
||||
**Description**: "The link in README.md was pointing to the wrong file. Updated to point to correct installation guide."
|
||||
|
||||
### 😞 Bad PR Example
|
||||
|
||||
**Title**: "Updates"
|
||||
**Changes**: 50 files, entire codebase reformatted
|
||||
**Description**: "Made some improvements"
|
||||
|
||||
---
|
||||
|
||||
**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner.
|
||||
@@ -1,42 +0,0 @@
|
||||
# PRD
|
||||
|
||||
## Epic 1: Core To-Do Functionality
|
||||
|
||||
**Goal:** To deliver a functional, single-user to-do application with user authentication and full CRUD (Create, Read, Update, Delete) capabilities for tasks.
|
||||
|
||||
**Stories:**
|
||||
|
||||
**Story 1.1: User Authentication**
|
||||
|
||||
- **As a** user,
|
||||
- **I want** to be able to sign up, log in, and log out,
|
||||
- **so that** I can securely manage my personal to-do list.
|
||||
- **Acceptance Criteria:**
|
||||
1. The application uses the Supabase Auth UI for login and sign-up forms.
|
||||
2. A user can create an account and will be automatically logged in.
|
||||
3. A logged-in user can log out, which redirects them to the login page.
|
||||
4. The main to-do list page is protected and only visible to authenticated users.
|
||||
|
||||
**Story 1.2: Create and View To-Dos**
|
||||
|
||||
- **As an** authenticated user,
|
||||
- **I want** to enter a task into an input field and see it appear on my to-do list,
|
||||
- **so that** I can keep track of my tasks.
|
||||
- **Acceptance Criteria:**
|
||||
1. There is a text input field and a "Create" button on the main page.
|
||||
2. Submitting a new task adds it to the database and displays it in the list of to-dos without a page refresh.
|
||||
3. The to-do list is fetched from the Supabase database when the page loads.
|
||||
4. The input field is cleared after a to-do is successfully created.
|
||||
|
||||
**Story 1.3: Update and Delete To-Dos**
|
||||
|
||||
- **As an** authenticated user,
|
||||
- **I want** to be able to mark a to-do as complete and delete it,
|
||||
- **so that** I can manage my task list effectively.
|
||||
- **Acceptance Criteria:**
|
||||
1. Each to-do item has a checkbox or button to toggle its "completed" status.
|
||||
2. Changing the status updates the item in the database and visually (e.g., with a strikethrough).
|
||||
3. Each to-do item has a "Delete" button.
|
||||
4. Clicking "Delete" removes the to-do from the UI and the database.
|
||||
|
||||
With this epic, the planning phase is complete. All the requirements are clearly defined and structured for development.
|
||||
1007
docs/user-guide.md
Normal file
1007
docs/user-guide.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,113 +1,3 @@
|
||||
# BMAD Method Expansion Packs
|
||||
|
||||
## Overview
|
||||
|
||||
Expansion packs extend BMAD Method with specialized capabilities for specific use cases. They allow teams to add functionality without cluttering the core workflow.
|
||||
|
||||
## Core BMAD Flow
|
||||
|
||||
The original BMAD Method follows a simple, proven flow:
|
||||
|
||||
````text
|
||||
Analyst → PM → Architect → SM → Dev
|
||||
(Brief) → (PRD) → (Architecture) → (Stories) → (Implementation)
|
||||
```text
|
||||
|
||||
This core flow remains clean and focused on getting from business requirements to working software.
|
||||
|
||||
## Why Expansion Packs?
|
||||
|
||||
As BMAD has evolved, we've identified specialized needs that don't fit every project:
|
||||
|
||||
- Infrastructure and DevOps workflows
|
||||
- UX/UI design processes
|
||||
- Data engineering pipelines
|
||||
- Security and compliance workflows
|
||||
- Mobile development patterns
|
||||
- Real World assistance and workflows without AI Agents development in mind
|
||||
|
||||
Rather than complicate the core method, expansion packs let you "opt-in" to additional capabilities.
|
||||
|
||||
## Available Expansion Packs
|
||||
|
||||
### 1. Infrastructure & DevOps
|
||||
|
||||
- **Purpose**: Cloud infrastructure design and platform engineering
|
||||
- **Adds**: DevOps agent, infrastructure templates, validation checklists
|
||||
- **Use When**: You need to design and implement cloud infrastructure
|
||||
|
||||
### 2. UX/Design (Coming Soon)
|
||||
|
||||
- **Purpose**: User experience and interface design workflows
|
||||
- **Adds**: Design Architect agent, UI component templates
|
||||
- **Use When**: You need detailed UI/UX design processes
|
||||
|
||||
### 3. Data Engineering (Planned)
|
||||
|
||||
- **Purpose**: Data pipeline and analytics infrastructure
|
||||
- **Adds**: Data Engineer agent, ETL templates, data architecture patterns
|
||||
- **Use When**: You're building data-intensive applications
|
||||
|
||||
## Structure of an Expansion Pack
|
||||
|
||||
Each expansion pack contains:
|
||||
|
||||
```text
|
||||
expansion-pack-name/
|
||||
├── README.md # Overview and usage instructions
|
||||
├── manifest.yml # Installation configuration
|
||||
├── agents/ # Agent configurations (.yml)
|
||||
├── personas/ # Persona definitions (.md)
|
||||
├── ide-agents/ # IDE-specific agents (.ide.md)
|
||||
├── templates/ # Document templates (.md)
|
||||
├── tasks/ # Specialized tasks (.md)
|
||||
└── checklists/ # Validation checklists (.md)
|
||||
````
|
||||
|
||||
## Installing an Expansion Pack
|
||||
|
||||
### Method 1: NPM Script
|
||||
|
||||
````bash
|
||||
npm run install:expansion <pack-name>
|
||||
```text
|
||||
|
||||
### Method 2: Direct Script
|
||||
|
||||
```bash
|
||||
node tools/install-expansion-pack.js <pack-name>
|
||||
````
|
||||
|
||||
### Method 3: Manual
|
||||
|
||||
1. Copy files according to manifest.yml
|
||||
2. Update team configurations as needed
|
||||
3. Rebuild bundles with `npm run build`
|
||||
|
||||
## Creating Your Own Expansion Pack
|
||||
|
||||
1. Create a new folder under `expansion-packs/`
|
||||
2. Add your specialized agents, templates, and tasks
|
||||
3. Create a manifest.yml defining installation mappings
|
||||
4. Write a README explaining purpose and usage
|
||||
5. Test installation process
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Keep Core Simple**: Don't add to core what could be an expansion
|
||||
2. **Clear Purpose**: Each pack should solve a specific need
|
||||
3. **Self-Contained**: Packs should work independently when possible
|
||||
4. **Document Well**: Clear README and usage examples
|
||||
5. **Version Compatibility**: Note which BMAD version the pack requires
|
||||
|
||||
## Future Vision
|
||||
|
||||
We envision a library of expansion packs for various industries and use cases:
|
||||
|
||||
- Healthcare compliance workflows
|
||||
- Financial services security patterns
|
||||
- E-commerce optimization flows
|
||||
- Gaming development pipelines
|
||||
- IoT device management
|
||||
|
||||
The goal is to keep BMAD's core simple while allowing infinite extensibility through modular expansion packs.
|
||||
Expansion packs extend BMAD-METHOD beyond traditional software development, providing specialized agent teams, templates, and workflows for specific domains and industries. Each pack is a self-contained ecosystem designed to bring the power of AI-assisted workflows to any field. Coming soon.
|
||||
|
||||
74
expansion-packs/infrastructure-devops/tasks/create-doc.md
Normal file
74
expansion-packs/infrastructure-devops/tasks/create-doc.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# Create Document from Template Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Identify Template and Context
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
|
||||
### 6. Validation
|
||||
|
||||
If template specifies a checklist:
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
|
||||
### 7. Final Presentation
|
||||
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
|
||||
## Important Notes
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "5.0.0",
|
||||
"version": "4.4.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "5.0.0",
|
||||
"version": "4.4.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.3.0",
|
||||
"version": "4.4.0",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.3.0",
|
||||
"version": "4.4.0",
|
||||
"description": "BMAD Method installer - AI-powered Agile development framework",
|
||||
"main": "lib/installer.js",
|
||||
"bin": {
|
||||
|
||||
Reference in New Issue
Block a user