bmad-method 6.0.0-alpha.3 → 6.0.0-alpha.5

package/src/modules/bmm/workflows/4-implementation/correct-course/README.md

@@ -1,73 +0,0 @@
----
-last-redoc-date: 2025-10-01
----
-
-# Correct Course Workflow
-
-The correct-course workflow is v6's adaptive response mechanism for stories that encounter issues during development or review, enabling intelligent course correction without restarting from scratch. Run by the Scrum Master (SM) or Team Lead, this workflow analyzes why a story is blocked or has issues, determines whether the story scope needs adjustment, requirements need clarification, technical approach needs revision, or the story needs to be split or reconsidered. This represents the agile principle of embracing change even late in the development cycle, but doing so in a structured way that captures learning and maintains project coherence.
-
-Unlike simply abandoning failed work or blindly pushing forward, correct-course provides a systematic approach to diagnosing issues and determining appropriate remediation. The workflow examines the original story specification, what was actually implemented, what issues arose during development or review, and the broader epic context to recommend the best path forward. This might involve clarifying requirements, adjusting acceptance criteria, revising technical approach, splitting the story into smaller pieces, or even determining the story should be deprioritized.
-
-The critical value of this workflow is that it prevents thrashing—endless cycles of implementation and rework without clear direction. By stepping back to analyze what went wrong and charting a clear path forward, the correct-course workflow enables teams to learn from difficulties and adapt intelligently rather than stubbornly proceeding with a flawed approach.
-
-## Usage
-
-```bash
-# Analyze issues and recommend course correction
-bmad run correct-course
-```
-
-The workflow should be run when:
-
-- Review identifies critical issues requiring rethinking
-- Developer encounters blocking issues during implementation
-- Acceptance criteria prove infeasible or unclear
-- Technical approach needs significant revision
-- Story scope needs adjustment based on discoveries
-
-## Inputs
-
-**Required Context:**
-
-- **Story Document**: Original story specification
-- **Implementation Attempts**: Code changes and approaches tried
-- **Review Feedback**: Issues and concerns identified
-- **Epic Context**: Overall epic goals and current progress
-- **Technical Constraints**: Architecture decisions and limitations discovered
-
-**Analysis Focus:**
-
-- Root cause of issues or blockages
-- Feasibility of current story scope
-- Clarity of requirements and acceptance criteria
-- Appropriateness of technical approach
-- Whether story should be split or revised
-
-## Outputs
-
-**Primary Deliverable:**
-
-- **Course Correction Report** (`[story-id]-correction.md`): Analysis and recommendations including:
-  - Issue root cause analysis
-  - Impact assessment on epic and project
-  - Recommended corrective actions with rationale
-  - Revised story specification if applicable
-  - Updated acceptance criteria if needed
-  - Technical approach adjustments
-  - Timeline and effort implications
-
-**Possible Outcomes:**
-
-1. **Clarify Requirements**: Update story with clearer acceptance criteria
-2. **Revise Scope**: Adjust story scope to be more achievable
-3. **Split Story**: Break into multiple smaller stories
-4. **Change Approach**: Recommend different technical approach
-5. **Deprioritize**: Determine story should be deferred or cancelled
-6. **Unblock**: Identify and address blocking dependencies
-
-**Artifacts:**
-
-- Updated story document if revision needed
-- New story documents if splitting story
-- Updated epic backlog reflecting changes
-- Lessons learned for retrospective

package/src/modules/bmm/workflows/4-implementation/create-story/README.md

@@ -1,146 +0,0 @@
-# Create Story Workflow
-
-Just-in-time story generation creating one story at a time based on epic backlog state. Run by Scrum Master (SM) agent to ensure planned stories align with approved epics.
-
-## Table of Contents
-
-- [Usage](#usage)
-- [Key Features](#key-features)
-- [Inputs & Outputs](#inputs--outputs)
-- [Workflow Behavior](#workflow-behavior)
-- [Integration](#integration)
-
-## Usage
-
-```bash
-# SM initiates next story creation
-bmad sm *create-story
-```
-
-**When to run:**
-
-- Sprint has capacity for new work
-- Previous story is Done/Approved
-- Team ready for next planned story
-
-## Key Features
-
-### Strict Planning Enforcement
-
-- **Only creates stories enumerated in epics.md**
-- Halts if story not found in epic plan
-- Prevents scope creep through validation
-
-### Intelligent Document Discovery
-
-- Auto-finds tech spec: `tech-spec-epic-{N}-*.md`
-- Discovers architecture docs across directories
-- Builds prioritized requirement sources
-
-### Source Document Grounding
-
-- Every requirement traced to source
-- No invention of domain facts
-- Citations included in output
-
-### Non-Interactive Mode
-
-- Default "#yolo" mode minimizes prompts
-- Smooth automated story preparation
-- Only prompts when critical
-
-## Inputs & Outputs
-
-### Required Files
-
-| File                     | Purpose                       | Priority |
-| ------------------------ | ----------------------------- | -------- |
-| epics.md                 | Story enumeration (MANDATORY) | Critical |
-| tech-spec-epic-{N}-\*.md | Epic technical spec           | High     |
-| PRD.md                   | Product requirements          | Medium   |
-| Architecture docs        | Technical constraints         | Low      |
-
-### Auto-Discovered Docs
-
-- `tech-stack.md`, `unified-project-structure.md`
-- `testing-strategy.md`, `backend/frontend-architecture.md`
-- `data-models.md`, `database-schema.md`, `api-specs.md`
-
-### Output
-
-**Story Document:** `{story_dir}/story-{epic}.{story}.md`
-
-- User story statement (role, action, benefit)
-- Acceptance criteria from tech spec/epics
-- Tasks mapped to ACs
-- Testing requirements
-- Dev notes with sources
-- Status: "Draft"
-
-## Workflow Behavior
-
-### Story Number Management
-
-- Auto-detects next story number
-- No duplicates or skipped numbers
-- Maintains epic.story convention
-
-### Update vs Create
-
-- **If current story not Done:** Updates existing
-- **If current story Done:** Creates next (if planned)
-
-### Validation Safeguards
-
-**No Story Found:**
-
-```
-"No planned next story found in epics.md for epic {N}.
-Run *correct-course to add/modify epic stories."
-```
-
-**Missing Config:**
-Ensure `dev_story_location` set in config.yaml
-
-## Integration
-
-### v6 Implementation Cycle
-
-1. **create-story** ← Current step (defines "what")
-2. story-context (adds technical "how")
-3. dev-story (implementation)
-4. code-review (validation)
-5. correct-course (if needed)
-6. retrospective (after epic)
-
-### Document Priority
-
-1. **tech_spec_file** - Epic-specific spec
-2. **epics_file** - Story breakdown
-3. **prd_file** - Business requirements
-4. **architecture_docs** - Technical guidance
-
-## Configuration
-
-```yaml
-# bmad/bmm/config.yaml
-dev_story_location: ./stories
-output_folder: ./output
-
-# workflow.yaml defaults
-non_interactive: true
-auto_run_context: true
-```
-
-## Troubleshooting
-
-| Issue                   | Solution                                   |
-| ----------------------- | ------------------------------------------ |
-| "No planned next story" | Run `*correct-course` to add story to epic |
-| Missing story_dir       | Set `dev_story_location` in config         |
-| Tech spec not found     | Use naming: `tech-spec-epic-{N}-*.md`      |
-| No architecture docs    | Add docs to docs/ or output/ folder        |
-
----
-
-For workflow details, see [instructions.md](./instructions.md) and [checklist.md](./checklist.md).

package/src/modules/bmm/workflows/4-implementation/dev-story/README.md

@@ -1,206 +0,0 @@
-# Dev Story Workflow
-
-The dev-story workflow is where v6's just-in-time context approach delivers its primary value, enabling the Developer (DEV) agent to implement stories with expert-level guidance injected directly into their context. This workflow is run EXCLUSIVELY by the DEV agent and operates on a single story that has been prepared by the SM through create-story and enhanced with story-context. The DEV loads both the story specification and the dynamically-generated story context XML, then proceeds through implementation with the combined knowledge of requirements and domain-specific expertise.
-
-The workflow operates with two critical inputs: the story file (created by SM's create-story) containing acceptance criteria, tasks, and requirements; and the story-context XML (generated by SM's story-context) providing just-in-time expertise injection tailored to the story's technical needs. This dual-input approach ensures the developer has both the "what" (from the story) and the "how" (from the context) needed for successful implementation. The workflow iterates through tasks sequentially, implementing code, writing tests, and updating the story document's allowed sections until all tasks are complete.
-
-A critical aspect of v6 flow is that dev-story may be run multiple times for the same story. Initially run to implement the story, it may be run again after code-review identifies issues that need correction. The workflow intelligently resumes from incomplete tasks, making it ideal for both initial implementation and post-review fixes. The DEV agent maintains strict boundaries on what can be modified in the story file—only Tasks/Subtasks checkboxes, Dev Agent Record, File List, Change Log, and Status may be updated, preserving the story's requirements integrity.
-
-## Usage
-
-```bash
-# Developer implements the story with injected context
-bmad dev *develop
-
-# Or if returning to fix review issues
-bmad dev *develop  # Will resume from incomplete tasks
-```
-
-The DEV runs this workflow:
-
-- After SM completes both create-story and story-context
-- When a story status is "Draft" or "Approved" (ready for development)
-- After code-review identifies issues requiring fixes
-- To resume work on a partially completed story
-
-## Inputs
-
-**Required Files:**
-
-- **Story Document** (`{story_dir}/story-{epic}.{story}.md`): Complete specification including:
-  - User story statement
-  - Acceptance criteria (immutable during dev)
-  - Tasks and subtasks (checkable during implementation)
-  - Dev Notes section (for context and guidance)
-  - Status field (Draft → In Progress → Ready for Review)
-
-- **Story Context XML** (`{story_dir}/story-{epic}.{story}-context.xml`): Domain expertise including:
-  - Technical patterns and best practices
-  - Gotchas and common pitfalls
-  - Testing strategies
-  - Relevant code references
-  - Architecture constraints
-
-**Configuration:**
-
-- `dev_story_location`: Directory containing story files (from bmm/config.yaml)
-- `story_selection_limit`: Number of recent stories to show (default: 10)
-- `run_tests_command`: Test command (default: auto-detected)
-- `strict`: Whether to halt on test failures (default: true)
-
-## Outputs
-
-**Code Implementation:**
-
-- Production code satisfying acceptance criteria
-- Unit, integration, and E2E tests as appropriate
-- Documentation updates
-- Migration scripts if needed
-
-**Story File Updates (allowed sections only):**
-
-- **Tasks/Subtasks**: Checkboxes marked complete as work progresses
-- **Dev Agent Record**: Debug log and completion notes
-- **File List**: All files created or modified
-- **Change Log**: Summary of implementation changes
-- **Status**: Updated to "Ready for Review" when complete
-
-**Validation:**
-
-- All tests passing (existing + new)
-- Acceptance criteria verified
-- Code quality checks passed
-- No regression in existing functionality
-
-## Key Features
-
-**Story-Context Integration**: The workflow loads and leverages the story-context XML throughout implementation, providing expert guidance without cluttering the main conversation. This ensures best practices are followed while maintaining developer autonomy.
-
-**Task-by-Task Iteration**: Implements one task at a time, marking completion before moving to the next. This granular approach enables progress tracking and clean resumption if interrupted or after review feedback.
-
-**Strict File Boundaries**: Only specific sections of the story file may be modified, preserving requirement integrity. The story's acceptance criteria, main description, and other planning sections remain immutable during development.
-
-**Test-Driven Approach**: For each task, the workflow emphasizes writing tests that verify acceptance criteria before or alongside implementation, ensuring requirements are actually met.
-
-**Resumable Implementation**: If the workflow is run again on a story with incomplete tasks (e.g., after code-review finds issues), it intelligently resumes from where it left off rather than starting over.
-
-## Integration with v6 Flow
-
-The dev-story workflow is step 3 in the v6 implementation cycle:
-
-1. SM: create-story (generates the story specification)
-2. SM: story-context (adds JIT technical expertise)
-3. **DEV: dev-story** ← You are here (initial implementation)
-4. DEV/SR: code-review (validates completion)
-5. If issues found: **DEV: dev-story** ← May return here for fixes
-6. After epic: retrospective (captures learnings)
-
-This workflow may be executed multiple times for the same story as part of the review-fix cycle. Each execution picks up from incomplete tasks, making it efficient for iterative improvement.
-
-## Workflow Process
-
-### Phase 1: Story Selection
-
-- If `story_path` provided: Use that story directly
-- Otherwise: List recent stories from `dev_story_location`
-- Parse story structure and validate format
-- Load corresponding story-context XML
-
-### Phase 2: Task Implementation Loop
-
-For each incomplete task:
-
-1. **Plan**: Log approach in Dev Agent Record
-2. **Implement**: Write code following story-context guidance
-3. **Test**: Create tests verifying acceptance criteria
-4. **Validate**: Run tests and quality checks
-5. **Update**: Mark task complete, update File List
-
-### Phase 3: Completion
-
-- Verify all tasks completed
-- Run full test suite
-- Update Status to "Ready for Review"
-- Add completion notes to Dev Agent Record
-
-## Story File Structure
-
-The workflow expects stories with this structure:
-
-```markdown
-# Story {epic}.{story}: {Title}
-
-**Status**: Draft|In Progress|Ready for Review|Done
-**Epic**: {epic_number}
-**Estimated Effort**: {estimate}
-
-## Story
-
-As a {role}, I want to {action} so that {benefit}
-
-## Acceptance Criteria
-
-- [ ] AC1...
-- [ ] AC2...
-
-## Tasks and Subtasks
-
-- [ ] Task 1
-  - [ ] Subtask 1.1
-- [ ] Task 2
-
-## Dev Notes
-
-{Context and guidance from story creation}
-
-## Dev Agent Record
-
-### Debug Log
-
-{Implementation notes added during development}
-
-### Completion Notes
-
-{Summary added when complete}
-
-## File List
-
-{Files created/modified}
-
-## Change Log
-
-{Implementation summary}
-```
-
-## Best Practices
-
-**Load Context First**: Always ensure the story-context XML is loaded at the start. This provides the expert guidance needed throughout implementation.
-
-**Follow Task Order**: Implement tasks in the order listed. Dependencies are typically structured in the task sequence.
-
-**Test Each Task**: Don't wait until the end to write tests. Test each task as you complete it to ensure it meets acceptance criteria.
-
-**Update Incrementally**: Update the story file after each task completion rather than batching updates at the end.
-
-**Respect Boundaries**: Never modify acceptance criteria or story description. If they seem wrong, that's a code-review or correct-course issue, not a dev-story fix.
-
-**Use Context Guidance**: Actively reference the story-context for patterns, gotchas, and best practices. It's there to help you succeed.
-
-## Troubleshooting
-
-**Story Not Found**: Ensure story exists in `dev_story_location` and follows naming pattern `story-{epic}.{story}.md`
-
-**Context XML Missing**: The story-context workflow must be run first. Check for `story-{epic}.{story}-context.xml`
-
-**Tests Failing**: If strict mode is on, the workflow halts. Fix tests before continuing or set strict=false for development iteration.
-
-**Can't Modify Story Section**: Remember only Tasks, Dev Agent Record, File List, Change Log, and Status can be modified. Other sections are immutable.
-
-**Resuming After Review**: If code-review found issues, the workflow automatically picks up from incomplete tasks when run again.
-
-## Related Workflows
-
-- **create-story**: Creates the story specification (run by SM)
-- **story-context**: Generates the context XML (run by SM)
-- **code-review**: Validates implementation (run by SR/DEV)
-- **correct-course**: Handles major issues or scope changes (run by SM)

package/src/modules/bmm/workflows/4-implementation/epic-tech-context/README.md

@@ -1,195 +0,0 @@
-# Technical Specification Workflow
-
-## Overview
-
-Generate a comprehensive Technical Specification for a single epic from PRD, Epics file and Architecture to produce a document with full acceptance criteria and traceability mapping. Creates detailed implementation guidance that bridges business requirements with technical execution.
-
-## Key Features
-
-- **PRD-Architecture Integration** - Synthesizes business requirements with technical constraints
-- **Traceability Mapping** - Links acceptance criteria to technical components and tests
-- **Multi-Input Support** - Leverages PRD, architecture, front-end specs, and brownfield notes
-- **Implementation Focus** - Provides concrete technical guidance for development teams
-- **Testing Integration** - Includes test strategy aligned with acceptance criteria
-- **Validation Ready** - Generates specifications suitable for architectural review
-
-## Usage
-
-### Basic Invocation
-
-```bash
-workflow tech-spec
-```
-
-### With Input Documents
-
-```bash
-# With specific PRD and architecture
-workflow tech-spec --input PRD.md --input architecture.md
-
-# With comprehensive inputs
-workflow tech-spec --input PRD.md --input architecture.md --input front-end-spec.md
-```
-
-### Configuration
-
-- **output_folder**: Location for generated technical specification
-- **epic_id**: Used in output filename (extracted from PRD or prompted)
-- **recommended_inputs**: PRD, architecture, front-end spec, brownfield notes
-
-## Workflow Structure
-
-### Files Included
-
-```
-tech-spec/
-├── workflow.yaml           # Configuration and metadata
-├── instructions.md         # Step-by-step execution guide
-├── template.md            # Technical specification structure
-├── checklist.md           # Validation criteria
-└── README.md              # This file
-```
-
-## Workflow Process
-
-### Phase 1: Input Collection and Analysis (Steps 1-2)
-
-- **Document Discovery**: Locates PRD and Architecture documents
-- **Epic Extraction**: Identifies epic title and ID from PRD content
-- **Template Initialization**: Creates tech-spec document from template
-- **Context Analysis**: Reviews complete PRD and architecture for alignment
-
-### Phase 2: Technical Design Specification (Step 3)
-
-- **Service Architecture**: Defines services/modules with responsibilities and interfaces
-- **Data Modeling**: Specifies entities, schemas, and relationships
-- **API Design**: Documents endpoints, request/response models, and error handling
-- **Workflow Definition**: Details sequence flows and data processing patterns
-
-### Phase 3: Non-Functional Requirements (Step 4)
-
-- **Performance Specs**: Defines measurable latency, throughput, and scalability targets
-- **Security Requirements**: Specifies authentication, authorization, and data protection
-- **Reliability Standards**: Documents availability, recovery, and degradation behavior
-- **Observability Framework**: Defines logging, metrics, and tracing requirements
-
-### Phase 4: Dependencies and Integration (Step 5)
-
-- **Dependency Analysis**: Scans repository for package manifests and frameworks
-- **Integration Mapping**: Identifies external systems and API dependencies
-- **Version Management**: Documents version constraints and compatibility requirements
-- **Infrastructure Needs**: Specifies deployment and runtime dependencies
-
-### Phase 5: Acceptance and Testing (Step 6)
-
-- **Criteria Normalization**: Extracts and refines acceptance criteria from PRD
-- **Traceability Matrix**: Maps acceptance criteria to technical components
-- **Test Strategy**: Defines testing approach for each acceptance criterion
-- **Component Mapping**: Links requirements to specific APIs and modules
-
-### Phase 6: Risk and Validation (Steps 7-8)
-
-- **Risk Assessment**: Identifies technical risks, assumptions, and open questions
-- **Mitigation Planning**: Provides strategies for addressing identified risks
-- **Quality Validation**: Ensures specification meets completeness criteria
-- **Checklist Verification**: Validates against workflow quality standards
-
-## Output
-
-### Generated Files
-
-- **Primary output**: tech-spec-{epic_id}-{date}.md
-- **Traceability data**: Embedded mapping tables linking requirements to implementation
-
-### Output Structure
-
-1. **Overview and Scope** - Project context and boundaries
-2. **System Architecture Alignment** - Connection to architecture
-3. **Detailed Design** - Services, data models, APIs, and workflows
-4. **Non-Functional Requirements** - Performance, security, reliability, observability
-5. **Dependencies and Integrations** - External systems and technical dependencies
-6. **Acceptance Criteria** - Testable requirements from PRD
-7. **Traceability Mapping** - Requirements-to-implementation mapping
-8. **Test Strategy** - Testing approach and framework alignment
-9. **Risks and Assumptions** - Technical risks and mitigation strategies
-
-## Requirements
-
-- **PRD Document**: Product Requirements Document with clear acceptance criteria
-- **Architecture Document**: architecture or technical design
-- **Repository Access**: For dependency analysis and framework detection
-- **Epic Context**: Clear epic identification and scope definition
-
-## Best Practices
-
-### Before Starting
-
-1. **Validate Inputs**: Ensure PRD and architecture documents are complete and current
-2. **Review Requirements**: Confirm acceptance criteria are specific and testable
-3. **Check Dependencies**: Verify repository structure supports automated dependency analysis
-
-### During Execution
-
-1. **Maintain Traceability**: Ensure every acceptance criterion maps to implementation
-2. **Be Implementation-Specific**: Provide concrete technical guidance, not high-level concepts
-3. **Consider Constraints**: Factor in existing system limitations and brownfield challenges
-
-### After Completion
-
-1. **Architect Review**: Have technical lead validate design decisions
-2. **Developer Walkthrough**: Ensure implementation team understands specifications
-3. **Test Planning**: Use traceability matrix for test case development
-
-## Troubleshooting
-
-### Common Issues
-
-**Issue**: Missing or incomplete technical details
-
-- **Solution**: Review architecture document for implementation specifics
-- **Check**: Ensure PRD contains sufficient functional requirements detail
-
-**Issue**: Acceptance criteria don't map cleanly to technical components
-
-- **Solution**: Break down complex criteria into atomic, testable statements
-- **Check**: Verify PRD acceptance criteria are properly structured
-
-**Issue**: Dependency analysis fails or is incomplete
-
-- **Solution**: Check repository structure and manifest file locations
-- **Check**: Verify repository contains standard dependency files (package.json, etc.)
-
-**Issue**: Non-functional requirements are too vague
-
-- **Solution**: Extract specific performance and quality targets from architecture
-- **Check**: Ensure architecture document contains measurable NFR specifications
-
-## Customization
-
-To customize this workflow:
-
-1. **Modify Template**: Update template.md to match organizational technical spec standards
-2. **Extend Dependencies**: Add support for additional package managers or frameworks
-3. **Enhance Validation**: Extend checklist.md with company-specific technical criteria
-4. **Add Sections**: Include additional technical concerns like DevOps or monitoring
-
-## Version History
-
-- **v6.0.0** - Comprehensive technical specification with traceability
-  - PRD-Architecture integration
-  - Automated dependency detection
-  - Traceability mapping
-  - Test strategy alignment
-
-## Support
-
-For issues or questions:
-
-- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
-- Validate output using `checklist.md`
-- Ensure PRD and architecture documents are complete before starting
-- Consult BMAD documentation for technical specification standards
-
----
-
-_Part of the BMad Method v6 - BMM (Method) Module_