fix: installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions!
This commit is contained in:
Brian Madison
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -34,14 +35,14 @@ persona:
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
|
||||
- '*research {topic}" - Generate deep research prompt for investigation'
|
||||
- '*elicit" - Run advanced elicitation to clarify requirements'
|
||||
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- brainstorm {topic}: Facilitate structured brainstorming session
|
||||
- research {topic}: Generate deep research prompt for investigation
|
||||
- elicit: Run advanced elicitation to clarify requirements
|
||||
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- brainstorming-techniques
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -34,13 +35,13 @@ persona:
|
||||
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'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- 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
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
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
|
||||
root: .bmad-core
|
||||
agent:
|
||||
name: BMad Master
|
||||
id: bmad-master
|
||||
@@ -22,21 +23,21 @@ persona:
|
||||
- Use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
startup:
|
||||
- Announce: I'm BMad Master, your BMAD task executor. I can run any task, template, util, checklist, workflow, or schema. Type *help or tell me what you need.
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Do NOT scan filesystem or load any resources during startup
|
||||
- CRITICAL: Do NOT run discovery tasks automatically
|
||||
- Wait for user request before any tool use
|
||||
- Match request to resources, offer numbered options if unclear
|
||||
- Load resources only when explicitly requested
|
||||
commands:
|
||||
- '*help" - Show commands'
|
||||
- '*chat" - Advanced elicitation + KB mode'
|
||||
- '*status" - Current context'
|
||||
- '*task/template/util/checklist/workflow {name}" - Execute (list if no name)'
|
||||
- '*list {type}" - List resources by type'
|
||||
- '*exit" - Exit (confirm)'
|
||||
- '*yolo" - Skip confirmations'
|
||||
- '*doc-out" - Output full document'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show commands
|
||||
- chat: Advanced elicitation + KB mode
|
||||
- status: Current context
|
||||
- task {template|util|checklist|workflow}: Execute
|
||||
- list {task|template|util|checklist|workflow}: List resources by type
|
||||
- exit: Exit (confirm)
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- doc-out: Output full document
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
@@ -74,7 +75,6 @@ dependencies:
|
||||
- prd-tmpl
|
||||
- project-brief-tmpl
|
||||
- story-tmpl
|
||||
- web-agent-startup-instructions-template
|
||||
data:
|
||||
- bmad-kb
|
||||
- technical-preferences
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
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:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yml
|
||||
root: .bmad-core
|
||||
agent:
|
||||
name: James
|
||||
id: dev
|
||||
@@ -19,33 +20,35 @@ persona:
|
||||
|
||||
core_principles:
|
||||
- CRITICAL: Story-Centric - Story has ALL info. NEVER load PRD/architecture/other docs files unless explicitly directed in dev notes
|
||||
- CRITICAL: Load Standards - MUST load docs/architecture/coding-standards.md into core memory at startup
|
||||
- CRITICAL: Config-Based Loading - MUST load .bmad-core/core-config.yml at startup, then load ONLY files listed in devLoadAlwaysFiles. Inform user of missing files but continue
|
||||
- CRITICAL: Dev Record Only - ONLY update Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
|
||||
- Sequential Execution - Complete tasks 1-by-1 in order. Mark [x] before next. No skipping
|
||||
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
|
||||
- Debug Log Discipline - Log temp changes to table. Revert after fix. Keep story lean
|
||||
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
|
||||
- Code Excellence - Clean, secure, maintainable code per coding-standards.md
|
||||
- Code Excellence - Clean, secure, maintainable code per loaded standards
|
||||
- Numbered Options - Always use numbered lists when presenting choices
|
||||
|
||||
startup:
|
||||
- Announce: Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Do NOT load any story files or coding-standards.md during startup
|
||||
- CRITICAL: Load .bmad-core/core-config.yml and read devLoadAlwaysFiles list
|
||||
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
|
||||
- CRITICAL: Do NOT load any story files during startup unless user requested you do
|
||||
- CRITICAL: Do NOT scan docs/stories/ directory automatically
|
||||
- CRITICAL: Do NOT begin any tasks automatically
|
||||
- Wait for user to specify story or ask for story selection
|
||||
- Only load files and begin work when explicitly requested by user
|
||||
- Only load story files and begin work when explicitly requested by user
|
||||
|
||||
commands:
|
||||
- "*help" - Show commands
|
||||
- "*chat-mode" - Conversational mode
|
||||
- "*run-tests" - Execute linting+tests
|
||||
- "*lint" - Run linting only
|
||||
- "*dod-check" - Run story-dod-checklist
|
||||
- "*status" - Show task progress
|
||||
- "*debug-log" - Show debug entries
|
||||
- "*complete-story" - Finalize to "Review"
|
||||
- "*exit" - Leave developer mode
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: Conversational mode for development discussions
|
||||
- run-tests: Execute linting and tests
|
||||
- lint: Run linting only
|
||||
- dod-check: Run story-dod-checklist
|
||||
- status: Show task progress
|
||||
- debug-log: Show debug entries
|
||||
- complete-story: Finalize to "Review"
|
||||
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
||||
|
||||
task-execution:
|
||||
flow: "Read task→Implement→Write tests→Pass tests→Update [x]→Next task"
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -31,11 +32,11 @@ persona:
|
||||
- Strategic thinking & outcome-oriented
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) Deep conversation with advanced-elicitation
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -33,16 +34,16 @@ persona:
|
||||
- Documentation Ecosystem Integrity - Maintain consistency across all documents
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
|
||||
- '*shard-doc {document}" - Break down document into actionable parts'
|
||||
- '*correct-course" - Analyze and suggest project course corrections'
|
||||
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
|
||||
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
|
||||
- '*exit" - Say Goodbye, You are no longer this Agent'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
|
||||
- shard-doc {document}: Break down document into actionable parts
|
||||
- correct-course: Analyze and suggest project course corrections
|
||||
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
|
||||
- create-story: Create user story from requirements (task brownfield-create-story)
|
||||
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -33,11 +34,11 @@ persona:
|
||||
- Cross-Browser & Cross-Platform Testing - Ensure comprehensive compatibility
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) QA consultation with advanced-elicitation for test strategy'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*exit" - Say goodbye as the QA Test Architect, and then abandon inhabiting this persona'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
data:
|
||||
- technical-preferences
|
||||
|
||||
@@ -2,16 +2,10 @@
|
||||
|
||||
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:
|
||||
|
||||
## Task and File Resolution
|
||||
|
||||
`Create Next Story`: `.bmad-core/tasks/create-next-story.md`
|
||||
`story-tmpl`: `.bmad-core/templates/story-tmpl.md`
|
||||
`story-draft-checklist`: `.bmad-core/checklists/story-draft-checklist.md`
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
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
|
||||
agent:
|
||||
@@ -27,31 +21,25 @@ persona:
|
||||
identity: Story creation expert who prepares detailed, actionable stories for AI developers
|
||||
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
|
||||
core_principles:
|
||||
- Task Adherence - Rigorously follow `Create Next Story` procedures
|
||||
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
|
||||
- Clarity for Developer Handoff - Stories must be immediately actionable
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
- Rigorously follow `create-next-story` procedure to generate the detailed user story
|
||||
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
|
||||
- You are NOT allowed to implement stories or modify code EVER!
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Do NOT automatically execute `Create Next Story` tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
||||
- Offer to help with story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent'
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
|
||||
- '*create" - Execute all steps in `Create Next Story`'
|
||||
- '*pivot" - Run correct-course task (ensure no story already created first)'
|
||||
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
|
||||
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
|
||||
- '*index-docs" - Update documentation index in /docs/index.md'
|
||||
- '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: Conversational mode with advanced-elicitation for advice
|
||||
- create|draft: Execute create-next-story
|
||||
- pivot: Execute `correct-course` task
|
||||
- checklist {checklist}: Show numbered list of checklists, execute selection
|
||||
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-next-story
|
||||
- execute-checklist
|
||||
- course-correct
|
||||
templates:
|
||||
- story-tmpl
|
||||
checklists:
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
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
|
||||
@@ -37,14 +38,14 @@ persona:
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions'
|
||||
- '*create-doc {template}" - Create doc (no template = show available templates)'
|
||||
- '*generate-ui-prompt" - Create AI frontend generation prompt'
|
||||
- '*research {topic}" - Generate deep research prompt for UX investigation'
|
||||
- '*execute-checklist {checklist}" - Run design validation checklist'
|
||||
- '*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona'
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) UX consultation with advanced-elicitation for design decisions
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- generate-ui-prompt: Create AI frontend generation prompt
|
||||
- research {topic}: Generate deep research prompt for UX investigation
|
||||
- execute-checklist {checklist}: Run design validation checklist
|
||||
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- generate-ai-frontend-prompt
|
||||
|
||||
24
bmad-core/core-config.yml
Normal file
24
bmad-core/core-config.yml
Normal file
@@ -0,0 +1,24 @@
|
||||
core-project-information:
|
||||
dev-story-location: docs/stories # alternate could be .ai/stories if preferred for example
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs/prd
|
||||
epicFilePattern: epic-{n}*.md
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
# if you have a front-end architecture document, uncomment the following and validate the file path
|
||||
# front-end-architecture:
|
||||
# front-end-architecture-file: docs/front-end-architecture.md
|
||||
# architectureVersion: v4
|
||||
# architectureSharded: true
|
||||
# architectureShardedLocation: docs/architecture
|
||||
customTechnicalDocuments: null # list other documents only if you want the SM to read them when creating stories
|
||||
devLoadAlwaysFiles:
|
||||
- docs/architecture/coding-standards.md
|
||||
- docs/architecture/tech-stack.md
|
||||
- docs/architecture/project-structure.md
|
||||
@@ -27,7 +27,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
#### Option 1: Web UI
|
||||
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
||||
|
||||
1. Navigate to `.bmad-core/web-bundles/teams/`
|
||||
1. Navigate to `dist/teams/`
|
||||
2. Copy `team-fullstack.txt` content
|
||||
3. Create new Gemini Gem or CustomGPT
|
||||
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
@@ -200,14 +200,16 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
### Dual Environment Architecture
|
||||
|
||||
#### IDE Environment
|
||||
|
||||
- Users interact directly with agent markdown files
|
||||
- Agents can access all dependencies dynamically
|
||||
- Supports real-time file operations and project integration
|
||||
- Optimized for development workflow execution
|
||||
|
||||
#### Web UI Environment
|
||||
- Uses pre-built bundles from `bmad-core/web-bundles/`
|
||||
- Single text files containing all agent dependencies
|
||||
|
||||
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
|
||||
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
||||
- Created by the web-builder tool for upload to web interfaces
|
||||
- Provides complete context in one package
|
||||
|
||||
@@ -220,6 +222,7 @@ BMAD employs a sophisticated template system with three key components:
|
||||
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
||||
|
||||
**Template Features**:
|
||||
|
||||
- **Self-contained**: Templates embed both output structure and processing instructions
|
||||
- **Variable Substitution**: `{{placeholders}}` for dynamic content
|
||||
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
|
||||
|
||||
@@ -4,45 +4,42 @@
|
||||
|
||||
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
|
||||
|
||||
## Inputs for this Task
|
||||
|
||||
- Access to the project's documentation repository, specifically:
|
||||
- `docs/index.md` (hereafter "Index Doc")
|
||||
- All Epic files - located in one of these locations:
|
||||
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
|
||||
- Secondary: `docs/epics/epic-{n}-{description}.md`
|
||||
- User-specified location if not found in above paths
|
||||
- Existing story files in `docs/stories/`
|
||||
- Main PRD (hereafter "PRD Doc")
|
||||
- Main Architecture Document (hereafter "Main Arch Doc")
|
||||
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
|
||||
- Project Structure Guide (`docs/project-structure.md`)
|
||||
- Operational Guidelines Document (`docs/operational-guidelines.md`)
|
||||
- Technology Stack Document (`docs/tech-stack.md`)
|
||||
- Data Models Document (as referenced in Index Doc)
|
||||
- API Reference Document (as referenced in Index Doc)
|
||||
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
|
||||
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
|
||||
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
|
||||
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
|
||||
|
||||
## Task Execution Instructions
|
||||
|
||||
### 0. Load Core Configuration
|
||||
|
||||
[[LLM: CRITICAL - This MUST be your first step]]
|
||||
|
||||
- Load `.bmad-core/core-config.yml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `dev-story-location`: Where to save story files
|
||||
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
||||
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
|
||||
- `prd.prdShardedLocation`: Location of sharded epic files
|
||||
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
||||
- `architecture.architectureVersion`: Architecture document version
|
||||
- `architecture.architectureSharded`: Whether architecture is sharded
|
||||
- `architecture.architecture-file`: Location of monolithic architecture
|
||||
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
||||
|
||||
### 1. Identify Next Story for Preparation
|
||||
|
||||
#### 1.1 Locate Epic Files
|
||||
|
||||
- First, determine where epic files are located:
|
||||
- Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
|
||||
- If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
|
||||
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
|
||||
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
|
||||
- Based on `prdSharded` from config:
|
||||
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
||||
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
|
||||
|
||||
#### 1.2 Review Existing Stories
|
||||
|
||||
- Review `docs/stories/` to find the highest-numbered story file.
|
||||
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
|
||||
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
||||
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
||||
|
||||
- Verify its `Status` is 'Done' (or equivalent).
|
||||
- If not 'Done', present an alert to the user:
|
||||
|
||||
@@ -60,17 +57,17 @@ To identify the next logical story based on project progress and epic definition
|
||||
```
|
||||
|
||||
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
|
||||
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
|
||||
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
|
||||
|
||||
- **If no story files exist in `docs/stories/`:**
|
||||
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
|
||||
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
|
||||
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
||||
|
||||
### 2. Gather Core Story Requirements (from Epic File)
|
||||
### 2. Gather Core Story Requirements (from Epic)
|
||||
|
||||
- For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
|
||||
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
|
||||
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
|
||||
- Keep a record of this original epic-defined scope for later deviation analysis.
|
||||
|
||||
@@ -79,7 +76,7 @@ To identify the next logical story based on project progress and epic definition
|
||||
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
|
||||
|
||||
- If this is not the first story (i.e., previous story exists):
|
||||
- Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
|
||||
- Read the previous sequential story from `docs/stories`
|
||||
- Pay special attention to:
|
||||
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
|
||||
- Any deviations from planned implementation
|
||||
@@ -88,18 +85,30 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Any "lessons learned" or notes for future stories
|
||||
- Extract relevant insights that might inform the current story's preparation
|
||||
|
||||
### 4. Gather & Synthesize Architecture Context from Sharded Docs
|
||||
### 4. Gather & Synthesize Architecture Context
|
||||
|
||||
[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
|
||||
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
|
||||
|
||||
#### 4.1 Start with Architecture Index
|
||||
#### 4.1 Determine Architecture Document Strategy
|
||||
|
||||
- Read `docs/architecture/index.md` to understand the full scope of available documentation
|
||||
- Identify which sharded documents are most relevant to the current story
|
||||
Based on configuration loaded in Step 0:
|
||||
|
||||
#### 4.2 Recommended Reading Order Based on Story Type
|
||||
- **If `architectureVersion: v4` and `architectureSharded: true`**:
|
||||
- Read `{architectureShardedLocation}/index.md` to understand available documentation
|
||||
- Follow the structured reading order in section 4.2 below
|
||||
|
||||
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
||||
- Load the monolithic architecture from `architecture-file`
|
||||
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
||||
|
||||
- **If `architectureVersion` is NOT v4**:
|
||||
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
||||
- If `architectureSharded: true`: Search sharded files by filename relevance
|
||||
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
|
||||
|
||||
[[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
|
||||
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
||||
|
||||
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
|
||||
|
||||
**For ALL Stories:**
|
||||
|
||||
@@ -108,9 +117,18 @@ To identify the next logical story based on project progress and epic definition
|
||||
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
|
||||
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
|
||||
|
||||
**For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
||||
**For Backend/API Stories, additionally read:**
|
||||
5. `docs/architecture/data-models.md` - Data structures and validation rules
|
||||
6. `docs/architecture/database-schema.md` - Database design and relationships
|
||||
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
|
||||
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
|
||||
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
|
||||
|
||||
**For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
|
||||
**For Frontend/UI Stories, additionally read:**
|
||||
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
|
||||
6. `docs/architecture/components.md` - Specific component designs
|
||||
7. `docs/architecture/core-workflows.md` - User interaction flows
|
||||
8. `docs/architecture/data-models.md` - Frontend data handling
|
||||
|
||||
**For Full-Stack Stories:**
|
||||
|
||||
@@ -143,7 +161,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
|
||||
### 6. Populate Story Template with Full Context
|
||||
|
||||
- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
|
||||
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
|
||||
- Use the Story Template to structure the file.
|
||||
- Fill in:
|
||||
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
||||
@@ -190,7 +208,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
- Verify all source references are included for technical details
|
||||
- Ensure tasks align with both epic requirements and architecture constraints
|
||||
- Update status to "Draft"
|
||||
- Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
|
||||
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
|
||||
|
||||
### 9. Report Completion
|
||||
|
||||
|
||||
Reference in New Issue
Block a user