bmad-method 5.0.0 → 5.0.1

package/.bmad-core/tasks/create-expansion-pack.md

@@ -1,425 +0,0 @@
-# Create Expansion Pack Task
-
-This task helps you create a comprehensive BMAD expansion pack that can include new agents, tasks, templates, and checklists for a specific domain.
-
-## Understanding Expansion Packs
-
-Expansion packs extend BMAD with domain-specific capabilities. They are self-contained packages that can be installed into any BMAD project. Every expansion pack MUST include a custom BMAD orchestrator agent that manages the domain-specific workflow.
-
-## CRITICAL REQUIREMENTS
-
-1. **Create Planning Document First**: Before any implementation, create a concise task list for user approval
-2. **Verify All References**: Any task, template, or data file referenced in an agent MUST exist in the pack
-3. **Include Orchestrator**: Every pack needs a custom BMAD-style orchestrator agent
-4. **User Data Requirements**: Clearly specify any files users must provide in their data folder
-
-## Process Overview
-
-### Phase 1: Discovery and Planning
-
-#### 1.1 Define the Domain
-
-Ask the user:
-
-- **Pack Name**: Short identifier (e.g., `healthcare`, `fintech`, `gamedev`)
-- **Display Name**: Full name (e.g., "Healthcare Compliance Pack")
-- **Description**: What domain or industry does this serve?
-- **Key Problems**: What specific challenges will this pack solve?
-- **Target Users**: Who will benefit from this expansion?
-
-#### 1.2 Gather Examples
-
-Request from the user:
-
-- **Sample Documents**: Any existing documents in this domain
-- **Workflow Examples**: How work currently flows in this domain
-- **Compliance Needs**: Any regulatory or standards requirements
-- **Output Examples**: What final deliverables look like
-- **Data Requirements**: What reference data files users will need to provide
-
-#### 1.3 Create Planning Document
-
-IMPORTANT: STOP HERE AND CREATE PLAN FIRST
-
-Create `expansion-packs/{pack-name}/plan.md` with:
-
-```markdown
-# {Pack Name} Expansion Pack Plan
-
-## Overview
-
-- Pack Name: {name}
-- Description: {description}
-- Target Domain: {domain}
-
-## Components to Create
-
-### Agents
-
-- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMAD orchestrator)
-- [ ] {agent-1-name}
-- [ ] {agent-2-name}
-
-### Tasks
-
-- [ ] {task-1} (referenced by: {agent})
-- [ ] {task-2} (referenced by: {agent})
-
-### Templates
-
-- [ ] {template-1} (used by: {agent/task})
-- [ ] {template-2} (used by: {agent/task})
-
-### Checklists
-
-- [ ] {checklist-1}
-- [ ] {checklist-2}
-
-### Data Files Required from User
-
-- [ ] {filename}.{ext} - {description of content needed}
-- [ ] {filename2}.{ext} - {description of content needed}
-
-## Approval
-
-User approval received: [ ] Yes
-```
-
-Important: Wait for user approval before proceeding to Phase 2
-
-### Phase 2: Component Design
-
-#### 2.1 Create Orchestrator Agent
-
-**FIRST PRIORITY**: Design the custom BMAD orchestrator:
-
-- **Name**: `{pack-name}-orchestrator`
-- **Purpose**: Master coordinator for domain-specific workflow
-- **Key Commands**: Domain-specific orchestration commands
-- **Integration**: How it leverages other pack agents
-- **Workflow**: The complete process it manages
-
-#### 2.2 Identify Specialist Agents
-
-For each additional agent:
-
-- **Role**: What specialist is needed?
-- **Expertise**: Domain-specific knowledge required
-- **Interactions**: How they work with orchestrator and BMAD agents
-- **Unique Value**: What can't existing agents handle?
-- **Required Tasks**: List ALL tasks this agent references
-- **Required Templates**: List ALL templates this agent uses
-- **Required Data**: List ALL data files this agent needs
-
-#### 2.3 Design Specialized Tasks
-
-For each task:
-
-- **Purpose**: What specific action does it enable?
-- **Inputs**: What information is needed?
-- **Process**: Step-by-step instructions
-- **Outputs**: What gets produced?
-- **Agent Usage**: Which agents will use this task?
-
-#### 2.4 Create Document Templates
-
-For each template:
-
-- **Document Type**: What kind of document?
-- **Structure**: Sections and organization
-- **Placeholders**: Variable content areas
-- **Instructions**: How to complete each section
-- **Standards**: Any format requirements
-
-#### 2.5 Define Checklists
-
-For each checklist:
-
-- **Purpose**: What quality aspect does it verify?
-- **Scope**: When should it be used?
-- **Items**: Specific things to check
-- **Criteria**: Pass/fail conditions
-
-### Phase 3: Implementation
-
-IMPORTANT: Only proceed after plan.md is approved
-
-#### 3.1 Create Directory Structure
-
-```text
-expansion-packs/
-└── {pack-name}/
-    ├── plan.md (ALREADY CREATED)
-    ├── manifest.yml
-    ├── README.md
-    ├── agents/
-    │   ├── {pack-name}-orchestrator.yml (REQUIRED)
-    │   └── {agent-id}.yml
-    ├── personas/
-    │   ├── {pack-name}-orchestrator.md (REQUIRED)
-    │   └── {agent-id}.md
-    ├── tasks/
-    │   └── {task-name}.md
-    ├── templates/
-    │   └── {template-name}.md
-    ├── checklists/
-    │   └── {checklist-name}.md
-    └── ide-agents/
-        ├── {pack-name}-orchestrator.ide.md (REQUIRED)
-        └── {agent-id}.ide.md
-```
-
-#### 3.2 Create Manifest
-
-Create `manifest.yml`:
-
-```yaml
-name: {pack-name}
-version: 1.0.0
-description: >-
-  {Detailed description of the expansion pack}
-author: {Your name or organization}
-bmad_version: "4.0.0"
-
-# Files to create in the expansion pack
-files:
-  agents:
-    - {pack-name}-orchestrator.yml
-    - {agent-name}.yml
-
-  personas:
-    - {pack-name}-orchestrator.md
-    - {agent-name}.md
-
-  ide-agents:
-    - {pack-name}-orchestrator.ide.md
-    - {agent-name}.ide.md
-
-  tasks:
-    - {task-name}.md
-
-  templates:
-    - {template-name}.md
-
-  checklists:
-    - {checklist-name}.md
-
-# Data files users must provide
-required_data:
-  - filename: {data-file}.{ext}
-    description: {What this file should contain}
-    location: bmad-core/data/
-
-# Dependencies on core BMAD components
-dependencies:
-  - {core-agent-name}
-  - {core-task-name}
-
-# Post-install message
-post_install_message: |
-  {Pack Name} expansion pack ready!
-
-  Required data files:
-  - {data-file}.{ext}: {description}
-
-  To use: npm run agent {pack-name}-orchestrator
-```
-
-### Phase 4: Content Creation
-
-IMPORTANT: Work through plan.md checklist systematically!
-
-#### 4.1 Create Orchestrator First
-
-1. Create `personas/{pack-name}-orchestrator.md` with BMAD-style commands
-2. Create `agents/{pack-name}-orchestrator.yml` configuration
-3. Create `ide-agents/{pack-name}-orchestrator.ide.md`
-4. Verify ALL referenced tasks exist
-5. Verify ALL referenced templates exist
-6. Document data file requirements
-
-#### 4.2 Agent Creation Order
-
-For each additional agent:
-
-1. Create persona file with domain expertise
-2. Create agent configuration YAML
-3. Create IDE-optimized version
-4. **STOP** - Verify all referenced tasks/templates exist
-5. Create any missing tasks/templates immediately
-6. Mark agent as complete in plan.md
-
-#### 4.3 Task Creation Guidelines
-
-Each task should:
-
-1. Have a clear, single purpose
-2. Include step-by-step instructions
-3. Provide examples when helpful
-4. Reference domain standards
-5. Be reusable across agents
-
-#### 4.4 Template Best Practices
-
-Templates should:
-
-1. Include clear section headers
-2. Provide inline instructions
-3. Show example content
-4. Mark required vs optional sections
-5. Include domain-specific terminology
-
-### Phase 5: Verification and Documentation
-
-#### 5.1 Final Verification Checklist
-
-Before declaring complete:
-
-1. [ ] All items in plan.md marked complete
-2. [ ] Orchestrator agent created and tested
-3. [ ] All agent references validated
-4. [ ] All required data files documented
-5. [ ] manifest.yml lists all components
-6. [ ] No orphaned tasks or templates
-
-#### 5.2 Create README
-
-Include:
-
-- Overview of the pack's purpose
-- **Orchestrator usage instructions**
-- Required data files and formats
-- List of all components
-- Integration with BMAD workflow
-- Example scenarios
-
-#### 5.3 Data File Documentation
-
-For each required data file:
-
-```markdown
-## Required Data Files
-
-### {filename}.{ext}
-
-- **Purpose**: {why this file is needed}
-- **Format**: {file format and structure}
-- **Location**: Place in `bmad-core/data/`
-- **Example**:
-```
-
-## Example: Healthcare Expansion Pack
-
-```text
-healthcare/
-├── plan.md (Created first for approval)
-├── manifest.yml
-├── README.md
-├── agents/
-│   ├── healthcare-orchestrator.yml (REQUIRED)
-│   ├── clinical-analyst.yml
-│   └── compliance-officer.yml
-├── personas/
-│   ├── healthcare-orchestrator.md (REQUIRED)
-│   ├── clinical-analyst.md
-│   └── compliance-officer.md
-├── ide-agents/
-│   ├── healthcare-orchestrator.ide.md (REQUIRED)
-│   ├── clinical-analyst.ide.md
-│   └── compliance-officer.ide.md
-├── tasks/
-│   ├── hipaa-assessment.md
-│   ├── clinical-protocol-review.md
-│   └── patient-data-analysis.md
-├── templates/
-│   ├── clinical-trial-protocol.md
-│   ├── hipaa-compliance-report.md
-│   └── patient-outcome-report.md
-└── checklists/
-    ├── hipaa-checklist.md
-    └── clinical-data-quality.md
-
-Required user data files:
-- bmad-core/data/medical-terminology.md
-- bmad-core/data/hipaa-requirements.md
-```
-
-## Interactive Questions Flow
-
-### Initial Discovery
-
-1. "What domain or industry will this expansion pack serve?"
-2. "What are the main challenges or workflows in this domain?"
-3. "Do you have any example documents or outputs? (Please share)"
-4. "What specialized roles/experts exist in this domain?"
-5. "What reference data will users need to provide?"
-
-### Planning Phase
-
-1. "Here's the proposed plan. Please review and approve before we continue."
-
-### Orchestrator Design
-
-1. "What key commands should the {pack-name} orchestrator support?"
-2. "What's the typical workflow from start to finish?"
-3. "How should it integrate with core BMAD agents?"
-
-### Agent Planning
-
-1. "For agent '{name}', what is their specific expertise?"
-2. "What tasks will this agent reference? (I'll create them)"
-3. "What templates will this agent use? (I'll create them)"
-4. "What data files will this agent need? (You'll provide these)"
-
-### Task Design
-
-1. "Describe the '{task}' process step-by-step"
-2. "What information is needed to complete this task?"
-3. "What should the output look like?"
-
-### Template Creation
-
-1. "What sections should the '{template}' document have?"
-2. "Are there any required formats or standards?"
-3. "Can you provide an example of a completed document?"
-
-### Data Requirements
-
-1. "For {data-file}, what information should it contain?"
-2. "What format should this data be in?"
-3. "Can you provide a sample?"
-
-## Important Considerations
-
-- **Plan First**: ALWAYS create and get approval for plan.md before implementing
-- **Orchestrator Required**: Every pack MUST have a custom BMAD orchestrator
-- **Verify References**: ALL referenced tasks/templates MUST exist
-- **Document Data Needs**: Clearly specify what users must provide
-- **Domain Expertise**: Ensure accuracy in specialized fields
-- **Compliance**: Include necessary regulatory requirements
-
-## Tips for Success
-
-1. **Plan Thoroughly**: The plan.md prevents missing components
-2. **Build Orchestrator First**: It defines the overall workflow
-3. **Verify As You Go**: Check off items in plan.md
-4. **Test References**: Ensure no broken dependencies
-5. **Document Data**: Users need clear data file instructions
-
-## Common Mistakes to Avoid
-
-1. **Missing Orchestrator**: Every pack needs its own BMAD-style orchestrator
-2. **Orphaned References**: Agent references task that doesn't exist
-3. **Unclear Data Needs**: Not specifying required user data files
-4. **Skipping Plan**: Going straight to implementation
-5. **Generic Orchestrator**: Not making it domain-specific
-
-## Completion Checklist
-
-- [ ] plan.md created and approved
-- [ ] All plan.md items checked off
-- [ ] Orchestrator agent created
-- [ ] All agent references verified
-- [ ] Data requirements documented or added
-- [ ] README includes all setup instructions
-- [ ] manifest.yml reflects actual files

package/.bmad-core/tasks/create-next-story.md

@@ -1,206 +0,0 @@
-# Create Next Story Task
-
-## Purpose
-
-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
-
-### 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`)
-
-#### 1.2 Review Existing Stories
-
-- Review `docs/stories/` to 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:
-
-    ```plaintext
-    ALERT: Found incomplete story:
-    File: {lastEpicNum}.{lastStoryNum}.story.md
-    Status: [current status]
-
-    Would you like to:
-    1. View the incomplete story details (instructs user to do so, agent does not display)
-    2. Cancel new story creation at this time
-    3. Accept risk & Override to create the next story in draft
-
-    Please choose an option (1/2/3):
-    ```
-
-  - 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 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)
-
-- For the identified story, open its parent Epic File (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.
-
-### 3. Review Previous Story and Extract Dev Notes
-
-[[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`
-  - Pay special attention to:
-    - Dev Agent Record sections (especially Completion Notes and Debug Log References)
-    - Any deviations from planned implementation
-    - Technical decisions made during implementation
-    - Challenges encountered and solutions applied
-    - 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
-
-[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
-
-#### 4.1 Start with Architecture Index
-
-- Read `docs/architecture/index.md` to understand the full scope of available documentation
-- Identify which sharded documents are most relevant to the current story
-
-#### 4.2 Recommended Reading Order Based on Story Type
-
-[[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.]]
-
-**For ALL Stories:**
-
-1. `docs/architecture/tech-stack.md` - Understand technology constraints and versions
-2. `docs/architecture/unified-project-structure.md` - Know where code should be placed
-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 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:**
-
-- Read both Backend and Frontend sections above
-
-#### 4.3 Extract Story-Specific Technical Details
-
-[[LLM: As you read each document, extract ONLY the information directly relevant to implementing the current story. Do NOT include general information unless it directly impacts the story implementation.]]
-
-For each relevant document, extract:
-
-- Specific data models, schemas, or structures the story will use
-- API endpoints the story must implement or consume
-- Component specifications for UI elements in the story
-- File paths and naming conventions for new code
-- Testing requirements specific to the story's features
-- Security or performance considerations affecting the story
-
-#### 4.4 Document Source References
-
-[[LLM: ALWAYS cite the source document and section for each technical detail you include. This helps the dev agent verify information if needed.]]
-
-Format references as: `[Source: architecture/{filename}.md#{section}]`
-
-### 5. Verify Project Structure Alignment
-
-- Cross-reference the story's requirements and anticipated file manipulations with the Project Structure Guide from `docs/architecture/unified-project-structure.md`.
-- Ensure any file paths, component locations, or module names implied by the story align with defined structures.
-- Document any structural conflicts, necessary clarifications, or undefined components/paths in a "Project Structure Notes" section within the story draft.
-
-### 6. Populate Story Template with Full Context
-
-- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
-- Use the Story Template to structure the file.
-- Fill in:
-  - Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
-  - `Status: Draft`
-  - `Story` (User Story statement from Epic)
-  - `Acceptance Criteria (ACs)` (from Epic, to be refined if needed based on context)
-- **`Dev Technical Guidance` section (CRITICAL):**
-
-  [[LLM: This section MUST contain ONLY information extracted from the architecture shards. NEVER invent or assume technical details.]]
-
-  - Include ALL relevant technical details gathered from Steps 3 and 4, organized by category:
-    - **Previous Story Insights**: Key learnings or considerations from the previous story
-    - **Data Models**: Specific schemas, validation rules, relationships [with source references]
-    - **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
-    - **Component Specifications**: UI component details, props, state management [with source references]
-    - **File Locations**: Exact paths where new code should be created based on project structure
-    - **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
-    - **Technical Constraints**: Version requirements, performance considerations, security rules
-  - Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
-  - If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
-
-- **`Tasks / Subtasks` section:**
-  - Generate a detailed, sequential list of technical tasks based ONLY on:
-    - Requirements from the Epic
-    - Technical constraints from architecture shards
-    - Project structure from unified-project-structure.md
-    - Testing requirements from testing-strategy.md
-  - Each task must reference relevant architecture documentation
-  - Include unit testing as explicit subtasks based on testing-strategy.md
-  - Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
-- Add notes on project structure alignment or discrepancies found in Step 5.
-- Prepare content for the "Deviation Analysis" based on any conflicts between epic requirements and architecture constraints.
-
-### 7. Run Story Draft Checklist
-
-- Execute the Story Draft Checklist against the prepared story
-- Document any issues or gaps identified
-- Make necessary adjustments to meet quality standards
-- Ensure all technical guidance is properly sourced from architecture docs
-
-### 8. Finalize Story File
-
-- Review all sections for completeness and accuracy
-- 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`
-
-### 9. Report Completion
-
-Provide a summary to the user including:
-
-- Story created: `{epicNum}.{storyNum} - {Story Title}`
-- Status: Draft
-- Key technical components included from architecture docs
-- Any deviations or conflicts noted between epic and architecture
-- Recommendations for story review before approval
-- Next steps: Story should be reviewed by PO for approval before dev work begins
-
-[[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]