diff --git a/src/modules/bmm/agents/architect.agent.yaml b/src/modules/bmm/agents/architect.agent.yaml index 4f872820..a57253b4 100644 --- a/src/modules/bmm/agents/architect.agent.yaml +++ b/src/modules/bmm/agents/architect.agent.yaml @@ -22,10 +22,6 @@ agent: workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml" description: Check workflow status and get recommendations - - trigger: correct-course - workflow: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml" - description: Course Correction Analysis - - trigger: create-architecture workflow: "{project-root}/bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml" description: Produce a Scale Adaptive Architecture diff --git a/src/modules/bmm/agents/game-dev.agent.yaml b/src/modules/bmm/agents/game-dev.agent.yaml index e027b875..97c4b0f9 100644 --- a/src/modules/bmm/agents/game-dev.agent.yaml +++ b/src/modules/bmm/agents/game-dev.agent.yaml @@ -20,20 +20,16 @@ agent: menu: - trigger: workflow-status workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml" - description: Check workflow status and get recommendations + description: "Check workflow status and get recommendations" - - trigger: create-story - workflow: "{project-root}/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml" - description: Create Development Story - - - trigger: dev-story + - trigger: develop-story workflow: "{project-root}/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml" - description: Implement Story with Context + description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story" + + - trigger: story-done + workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-done/workflow.yaml" + description: "Mark story done after DoD complete" - trigger: code-review workflow: "{project-root}/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml" - description: Review Story Implementation - - - trigger: retro - workflow: "{project-root}/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml" - description: Sprint Retrospective + description: "Perform a thorough clean context QA code review on a story flagged Ready for Review" diff --git a/src/modules/bmm/agents/sm.agent.yaml b/src/modules/bmm/agents/sm.agent.yaml index 499edd2c..27cb1b6b 100644 --- a/src/modules/bmm/agents/sm.agent.yaml +++ b/src/modules/bmm/agents/sm.agent.yaml @@ -31,7 +31,7 @@ agent: - trigger: epic-tech-context workflow: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml" - description: (Optional) Use the PRD and Architecture to create a Tech-Spec for a specific epic + description: (Optional) Use the PRD and Architecture to create a Epic-Tech-Spec for a specific epic - trigger: validate-epic-tech-context validate-workflow: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml" diff --git a/src/modules/bmm/docs/README.md b/src/modules/bmm/docs/README.md index 9d88f7c3..0b483833 100644 --- a/src/modules/bmm/docs/README.md +++ b/src/modules/bmm/docs/README.md @@ -23,12 +23,12 @@ Complete guides for the BMad Method Module (BMM) - AI-powered agile development Understanding how BMM adapts to your needs: - **[Scale Adaptive System](./scale-adaptive-system.md)** - How BMM adapts to project size and complexity (42 min read) - - The five complexity levels (0-4) - - Automatic level detection - - Documentation requirements per level + - Three planning tracks (Quick Flow, BMad Method, Enterprise Method) + - Automatic track recommendation + - Documentation requirements per track - Planning workflow routing -- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track workflow for Level 0-1 projects (26 min read) +- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track workflow for Quick Flow track (26 min read) - Bug fixes and small features - Rapid prototyping approach - Auto-detection of stack and patterns @@ -62,7 +62,7 @@ Comprehensive guide for brownfield development: - **[Brownfield Development Guide](./brownfield-guide.md)** - Complete guide for existing codebases (53 min read) - Documentation phase strategies - - Level detection for brownfield + - Track selection for brownfield - Integration with existing patterns - Phase-by-phase workflow guidance - Common scenarios and troubleshooting @@ -86,7 +86,7 @@ Essential reference materials: **Build something new (greenfield)** → Start with [Quick Start Guide](./quick-start.md) -→ Then review [Scale Adaptive System](./scale-adaptive-system.md) to understand levels +→ Then review [Scale Adaptive System](./scale-adaptive-system.md) to understand tracks **Fix a bug or add small feature** → Go directly to [Quick Spec Flow](./quick-spec-flow.md) @@ -95,7 +95,7 @@ Essential reference materials: → Read [Brownfield Development Guide](./brownfield-guide.md) → Pay special attention to Phase 0 documentation requirements -**Understand project complexity levels** +**Understand planning tracks and methodology** → See [Scale Adaptive System](./scale-adaptive-system.md) **Find specific commands or answers** @@ -114,12 +114,12 @@ Comprehensive documentation for all BMM workflows organized by phase: - **[Phase 2: Planning Workflows](./workflows-planning.md)** - Scale-adaptive planning (967 lines) - prd, tech-spec, gdd, narrative, ux - - Level 0-4 planning approach + - Track-based planning approach (Quick Flow, BMad Method, Enterprise Method) - Which planning workflow to use - **[Phase 3: Solutioning Workflows](./workflows-solutioning.md)** - Architecture and validation (638 lines) - architecture, solutioning-gate-check - - Required for Level 3-4 projects + - Required for BMad Method and Enterprise Method tracks - Preventing agent conflicts - **[Phase 4: Implementation Workflows](./workflows-implementation.md)** - Sprint-based development (1,634 lines) diff --git a/src/modules/bmm/docs/agents-guide.md b/src/modules/bmm/docs/agents-guide.md index c9efb418..c147f9da 100644 --- a/src/modules/bmm/docs/agents-guide.md +++ b/src/modules/bmm/docs/agents-guide.md @@ -144,11 +144,7 @@ The BMad Method Module (BMM) provides a comprehensive team of specialized AI age **Workflows:** - `workflow-status` - Check what to do next -- `create-architecture` - Decision-focused architecture with: - - Starter template intelligence - - Novel pattern design - - Implementation patterns for agent consistency - - Adaptive facilitation (beginner/expert) +- `create-architecture` - Decision-focused architecture with - `validate-architecture` - Validate architecture document - `solutioning-gate-check` - Validate readiness for Phase 4 - `correct-course` - Handle technical changes diff --git a/src/modules/bmm/docs/brownfield-guide.md b/src/modules/bmm/docs/brownfield-guide.md index a35fee27..e45a192e 100644 --- a/src/modules/bmm/docs/brownfield-guide.md +++ b/src/modules/bmm/docs/brownfield-guide.md @@ -35,21 +35,21 @@ Brownfield projects involve working within existing codebases rather than starti ## Getting Started -### Understanding Project Levels +### Understanding Planning Tracks -For complete level details, see [Scale Adaptive System](./scale-adaptive-system.md). +For complete track details, see [Scale Adaptive System](./scale-adaptive-system.md). -**Brownfield levels at a glance:** +**Brownfield tracks at a glance:** -| Level | Scope | Stories | Key Difference | -| ----- | -------------------- | ------- | ---------------------------------- | -| **0** | Bug fix | 1 | Must understand affected code | -| **1** | Small feature | 1-10 | Respect existing patterns | -| **2** | Feature set | 5-15 | Integrate with architecture | -| **3** | Complex integration | 12-40 | Review existing architecture first | -| **4** | Enterprise expansion | 40+ | Full system documentation required | +| Track | Scope | Typical Stories | Key Difference | +| --------------------- | -------------------------- | --------------- | ----------------------------------------------- | +| **Quick Flow** | Bug fixes, small features | 1-15 | Must understand affected code and patterns | +| **BMad Method** | Feature sets, integrations | 10-50+ | Integrate with existing architecture | +| **Enterprise Method** | Enterprise expansions | 30+ | Full system documentation + compliance required | -### Level Detection for Brownfield +**Note:** Story counts are guidance, not definitions. Tracks are chosen based on planning needs. + +### Track Selection for Brownfield When you run `workflow-init`, it handles brownfield intelligently: @@ -69,23 +69,23 @@ When you run `workflow-init`, it handles brownfield intelligently: **Step 3: Analyzes your description** -- Keywords: "fix" → Level 0, "add feature" → Level 1, "dashboard" → Level 2 -- Story count estimation -- Confirms suggested level with you +- Keywords: "fix", "bug" → Quick Flow, "dashboard", "platform" → BMad Method, "enterprise", "multi-tenant" → Enterprise Method +- Complexity assessment +- Confirms suggested track with you **Key Principle:** System asks about YOUR current work first, uses old artifacts as context only. -**Example: Old Level 3 PRD, New Level 0 Work** +**Example: Old Complex PRD, New Simple Work** ``` -System: "Found PRD.md (Level 3, 30 stories, 6 months old)" +System: "Found PRD.md (BMad Method track, 30 stories, 6 months old)" System: "Is this work in progress or previous effort?" You: "Previous effort - I'm just fixing a bug now" System: "Tell me about your current work" You: "Update payment method enums" -System: "Level 0 brownfield. Correct?" +System: "Quick Flow track (tech-spec approach). Correct?" You: "Yes" -✅ Creates Level 0 workflow +✅ Creates Quick Flow workflow ``` --- @@ -140,14 +140,14 @@ If `docs/index.md` exists with comprehensive content, skip to Phase 1 or 2. Without it, workflows lack context: -- **tech-spec** (Level 0-1) can't auto-detect stack/patterns -- **PRD** (Level 2-4) can't reference existing code -- **architecture** (Level 3-4) can't build on existing structure +- **tech-spec** (Quick Flow) can't auto-detect stack/patterns +- **PRD** (BMad Method/Enterprise) can't reference existing code +- **architecture** (BMad Method/Enterprise) can't build on existing structure - **story-context** can't inject pattern-specific guidance --- -## Workflow Phases by Level +## Workflow Phases by Track ### Phase 1: Analysis (Optional) @@ -155,7 +155,7 @@ Without it, workflows lack context: - `brainstorm-project` - Solution exploration - `research` - Technical/market research -- `product-brief` - Strategic planning +- `product-brief` - Strategic planning (BMad Method/Enterprise tracks only) **When to use:** Complex features, technical decisions, strategic additions @@ -165,24 +165,24 @@ See [Workflows Guide](../workflows/README.md) for details. ### Phase 2: Planning (Required) -**Planning approach adapts by level:** +**Planning approach adapts by track:** -**Level 0-1:** Use `tech-spec` workflow +**Quick Flow:** Use `tech-spec` workflow - Creates tech-spec.md - Auto-detects existing stack (brownfield) - Confirms conventions with you - Generates implementation-ready stories -**Level 2-4:** Use `prd` workflow +**BMad Method/Enterprise:** Use `prd` workflow -- Creates PRD.md + epics.md +- Creates PRD.md + epic breakdown - References existing architecture - Plans integration points -**Brownfield-specific:** See [Scale Adaptive System](./scale-adaptive-system.md) for complete workflow paths by level. +**Brownfield-specific:** See [Scale Adaptive System](./scale-adaptive-system.md) for complete workflow paths by track. -### Phase 3: Solutioning (Level 2-4 Only) +### Phase 3: Solutioning (BMad Method/Enterprise Only) **Critical for brownfield:** @@ -193,12 +193,10 @@ See [Workflows Guide](../workflows/README.md) for details. **Workflows:** -- `architecture-review` - Understand existing (Level 3-4) -- `integration-planning` - Plan integration approach (Level 3-4) -- `create-architecture` - Extend architecture docs (Level 2-4) -- `solutioning-gate-check` - Validate before implementation (Level 3-4) +- `create-architecture` - Extend architecture docs (BMad Method/Enterprise) +- `solutioning-gate-check` - Validate before implementation (BMad Method/Enterprise) -### Phase 4: Implementation (All Levels) +### Phase 4: Implementation (All Tracks) **Sprint-based development through story iteration:** @@ -307,10 +305,12 @@ Document in tech-spec/architecture: ## Common Scenarios -### Scenario 1: Bug Fix (Level 0) +### Scenario 1: Bug Fix (Quick Flow) **Situation:** Authentication token expiration causing logout issues +**Track:** Quick Flow + **Workflow:** 1. **Document:** Skip if auth system documented, else run `document-project` (Quick scan) @@ -326,10 +326,12 @@ Document in tech-spec/architecture: --- -### Scenario 2: Small Feature (Level 1) +### Scenario 2: Small Feature (Quick Flow) **Situation:** Add "forgot password" to existing auth system +**Track:** Quick Flow + **Workflow:** 1. **Document:** Run `document-project` (Deep scan of auth module if not documented) @@ -346,37 +348,40 @@ Document in tech-spec/architecture: --- -### Scenario 3: Feature Set (Level 2) +### Scenario 3: Feature Set (BMad Method) **Situation:** Add user dashboard with analytics, preferences, activity +**Track:** BMad Method + **Workflow:** 1. **Document:** Run `document-project` (Deep scan) - Critical for understanding existing UI patterns 2. **Analyze:** Load Analyst → `research` (if evaluating analytics libraries) 3. **Plan:** Load PM → `prd` -4. **Implement:** Sprint-based (10-15 stories) +4. **Solution:** Load Architect → `create-architecture` → `solutioning-gate-check` +5. **Implement:** Sprint-based (10-15 stories) - Load SM → `sprint-planning` - Per epic: `epic-tech-context` → stories - Load DEV → `dev-story` per story -5. **Review:** Per story completion +6. **Review:** Per story completion **Time:** 1-2 weeks --- -### Scenario 4: Complex Integration (Level 3) +### Scenario 4: Complex Integration (BMad Method) **Situation:** Add real-time collaboration to document editor +**Track:** BMad Method + **Workflow:** 1. **Document:** Run `document-project` (Exhaustive if not documented) - **Mandatory** 2. **Analyze:** Load Analyst → `research` (WebSocket vs WebRTC vs CRDT) 3. **Plan:** Load PM → `prd` 4. **Solution:** - - Load Architect → `architecture-review` (understand existing editor) - - Load Architect → `integration-planning` (WebSocket integration strategy) - Load Architect → `create-architecture` (extend for real-time layer) - Load Architect → `solutioning-gate-check` 5. **Implement:** Sprint-based (20-30 stories) @@ -385,10 +390,12 @@ Document in tech-spec/architecture: --- -### Scenario 5: Enterprise Expansion (Level 4) +### Scenario 5: Enterprise Expansion (Enterprise Method) **Situation:** Add multi-tenancy to single-tenant SaaS platform +**Track:** Enterprise Method + **Workflow:** 1. **Document:** Run `document-project` (Exhaustive) - **Mandatory** @@ -398,7 +405,7 @@ Document in tech-spec/architecture: - `product-brief` - Strategic document 3. **Plan:** Load PM → `prd` (comprehensive) 4. **Solution:** - - `architecture-review` - Full system review + - `create-architecture` - Full system architecture - `integration-planning` - Phased migration strategy - `create-architecture` - Multi-tenancy architecture - `validate-architecture` - External review @@ -456,7 +463,7 @@ For complete troubleshooting, see [Troubleshooting Guide](./troubleshooting.md). - Which existing modules to modify - What APIs/services to integrate with - Data flow between new and existing code -4. Run `integration-planning` workflow (Level 3-4) +4. Review architecture document for integration guidance ### Existing Tests Breaking @@ -504,21 +511,19 @@ document-project # Create comprehensive docs (10-30min) # Analyst agent: brainstorm-project # Explore solutions research # Gather data -product-brief # Strategic planning +product-brief # Strategic planning (BMad Method/Enterprise only) # Phase 2: Planning (Required) # PM agent: -tech-spec # Level 0-1 -prd # Level 2-4 +tech-spec # Quick Flow track +prd # BMad Method/Enterprise tracks -# Phase 3: Solutioning (Level 2-4) +# Phase 3: Solutioning (BMad Method/Enterprise) # Architect agent: -architecture-review # Review existing (L3-4) -integration-planning # Plan integration (L3-4) -create-architecture # Extend architecture (L2-4) -solutioning-gate-check # Final approval (L3-4) +create-architecture # Extend architecture +solutioning-gate-check # Final validation -# Phase 4: Implementation (All Levels) +# Phase 4: Implementation (All Tracks) # SM agent: sprint-planning # Initialize tracking epic-tech-context # Epic context @@ -545,17 +550,17 @@ correct-course # If issues **Phase 1-3 Tracking:** -- `docs/bmm-workflow-status.md` - Progress tracker +- `docs/bmm-workflow-status.yaml` - Progress tracker **Phase 2 Planning:** -- `docs/tech-spec.md` (Level 0-1) -- `docs/PRD.md` (Level 2-4) -- `docs/epics.md` (Level 2-4) +- `docs/tech-spec.md` (Quick Flow track) +- `docs/PRD.md` (BMad Method/Enterprise tracks) +- Epic breakdown **Phase 3 Architecture:** -- `docs/architecture.md` (Level 2-4) +- `docs/architecture.md` (BMad Method/Enterprise tracks) **Phase 4 Implementation:** @@ -573,13 +578,13 @@ flowchart TD START --> CHECK CHECK -->|No| DOC[document-project
Deep scan] - CHECK -->|Yes| LEVEL{What Level?} + CHECK -->|Yes| TRACK{What Track?} - DOC --> LEVEL + DOC --> TRACK - LEVEL -->|0-1| TS[tech-spec] - LEVEL -->|2| PRD[prd] - LEVEL -->|3-4| PRD2[prd → architecture] + TRACK -->|Quick Flow| TS[tech-spec] + TRACK -->|BMad Method| PRD[prd → architecture] + TRACK -->|Enterprise| PRD2[prd → arch + security/devops] TS --> IMPL[Phase 4
Implementation] PRD --> IMPL @@ -600,7 +605,7 @@ flowchart TD 2. ✅ **Use fresh chats for complex workflows** - Prevents hallucinations 3. ✅ **Verify files exist before workflows** - Check PRD, epics, stories present 4. ✅ **Read agent menu first** - Confirm agent has the workflow -5. ✅ **Start with smaller level if unsure** - Easy to upgrade (L1 → L2) +5. ✅ **Start with simpler track if unsure** - Easy to upgrade (Quick Flow → BMad Method) 6. ✅ **Keep status files updated** - Manual updates when needed 7. ✅ **Run retrospectives after epics** - Catch issues early 8. ✅ **Follow phase sequence** - Don't skip required phases @@ -609,8 +614,8 @@ flowchart TD ## Related Documentation -- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding levels and complexity -- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Level 0-1 +- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding tracks and complexity +- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Quick Flow - **[Quick Start Guide](./quick-start.md)** - Getting started with BMM - **[Glossary](./glossary.md)** - Key terminology - **[FAQ](./faq.md)** - Common questions diff --git a/src/modules/bmm/docs/glossary.md b/src/modules/bmm/docs/glossary.md index 7b36f7de..a062cac2 100644 --- a/src/modules/bmm/docs/glossary.md +++ b/src/modules/bmm/docs/glossary.md @@ -29,7 +29,7 @@ The complete methodology for AI-assisted software development, encompassing plan ### Scale-Adaptive System -BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project size and complexity (Levels 0-4). +BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project needs through three distinct planning tracks (Quick Flow, BMad Method, Enterprise Method). ### Agent @@ -43,29 +43,23 @@ A multi-step guided process that orchestrates AI agent activities to produce spe ## Scale & Complexity -### Level 0 (Single Atomic Change) +### Quick Flow Track -Single-story projects like bug fixes, typos, or small patches. Uses tech-spec only, no architecture needed. Estimated completion: hours. +Fast implementation track using tech-spec planning only. Best for bug fixes, small features, and changes with clear scope. Typical range: 1-15 stories. No architecture phase needed. Examples: bug fixes, OAuth login, search features. -### Level 1 (Small Feature) +### BMad Method Track -Projects with 1-10 stories, typically 2-3 related changes. Examples: OAuth login, search feature, user profile page. Uses tech-spec with epic breakdown. +Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features requiring system design. Typical range: 10-50+ stories. Examples: admin dashboards, e-commerce platforms, SaaS products. -### Level 2 (Medium Project) +### Enterprise Method Track -Projects with 5-15 stories across multiple epics. Examples: admin dashboard, customer portal, reporting system. Uses PRD + optional architecture. +Extended enterprise planning track adding Security Architecture, DevOps Strategy, and Test Strategy to BMad Method. Best for enterprise requirements, compliance needs, and multi-tenant systems. Typical range: 30+ stories. Examples: multi-tenant platforms, compliance-driven systems, mission-critical applications. -### Level 3 (Complex Integration) +### Planning Track -Projects with 12-40 stories involving subsystems and integrations. Examples: e-commerce platform, SaaS product, multi-module system. Requires PRD + comprehensive architecture. +The methodology path (Quick Flow, BMad Method, or Enterprise Method) chosen for a project based on planning needs, complexity, and requirements rather than story count alone. -### Level 4 (Enterprise Scale) - -Projects with 40+ stories across products. Examples: multi-tenant systems, product ecosystems, platform expansions. Requires full methodology with strategic planning. - -### Complexity Level - -The scale rating (0-4) assigned to a project based on story count, integration requirements, team size, and architectural complexity. +**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math. --- @@ -73,23 +67,23 @@ The scale rating (0-4) assigned to a project based on story count, integration r ### Tech-Spec (Technical Specification) -**Level 0-1 only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources. +**Quick Flow track only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources. ### Epic-Tech-Spec (Epic Technical Specification) -**Level 2-4 only.** Detailed technical planning document created during implementation (just-in-time) for each epic. Supplements PRD + Architecture with epic-specific implementation details, code-level design decisions, and integration points. +**BMad Method/Enterprise tracks only.** Detailed technical planning document created during implementation (just-in-time) for each epic. Supplements PRD + Architecture with epic-specific implementation details, code-level design decisions, and integration points. -**Key Difference:** Tech-spec (Level 0-1) is created upfront and is the only planning doc. Epic-tech-spec (Level 2-4) is created per epic during implementation and supplements PRD + Architecture. +**Key Difference:** Tech-spec (Quick Flow) is created upfront and is the only planning doc. Epic-tech-spec (BMad Method/Enterprise) is created per epic during implementation and supplements PRD + Architecture. ### PRD (Product Requirements Document) -**Level 2-4.** Product-level planning document containing vision, goals, feature requirements, epic breakdown, success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. +**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, feature requirements, epic breakdown, success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. ### Architecture Document -**Level 2-4.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment. Optional for Level 2, required for Level 3-4. +**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment. -**Scale-Adaptive:** Architecture complexity scales with level - Level 2 is lightweight, Level 4 is enterprise-grade. +**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies. ### Epics @@ -113,15 +107,15 @@ Game development equivalent of PRD, created by Game Designer agent for game proj ### Phase 1: Analysis (Optional) -Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for small projects (Level 0-1), recommended for Level 2, required for Level 3-4. +Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method. ### Phase 2: Planning (Required) -**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Level 0-1) or PRD (Level 2-4) based on detected complexity level. +**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track. -### Phase 3: Solutioning (Conditional) +### Phase 3: Solutioning (Track-Dependent) -Architecture design phase. Optional for Level 2, required for Level 3-4. Includes architecture creation, validation, and gate checks. +Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks. ### Phase 4: Implementation (Required) @@ -129,7 +123,7 @@ Sprint-based development through story-by-story iteration. Uses sprint-planning, ### Quick Spec Flow -Fast-track workflow system for Level 0-1 projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping. +Fast-track workflow system for Quick Flow track projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping. ### Just-In-Time Design @@ -153,11 +147,11 @@ Agent that initializes workflows, conducts research, creates product briefs, and ### Architect -Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3. +Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning. ### SM (Scrum Master) -Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4. +Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation. ### DEV (Developer) @@ -191,9 +185,9 @@ Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS, ## Status & Tracking -### bmm-workflow-status.md +### bmm-workflow-status.yaml -**Phases 0-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically. +**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically. ### sprint-status.yaml @@ -269,7 +263,7 @@ Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, ### Gate Check -Validation workflow (solutioning-gate-check) run before Phase 4 to ensure PRD, architecture, and UX documents are cohesive with no gaps or contradictions. Required for Level 3-4. +Validation workflow (solutioning-gate-check) run before Phase 4 to ensure PRD, architecture, and UX documents are cohesive with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks. ### DoD (Definition of Done) @@ -289,11 +283,11 @@ Universal entry point workflow that checks for existing status file, displays cu ### Workflow Init -Initialization workflow that creates bmm-workflow-status.md, detects greenfield vs brownfield, determines complexity level, and sets up appropriate workflow path. +Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path. -### Level Detection +### Track Selection -Automatic analysis by workflow-init that uses keyword analysis, story count estimation, and complexity indicators to suggest appropriate level (0-4). User can override suggested level. +Automatic analysis by workflow-init that uses keyword analysis, complexity indicators, and project requirements to suggest appropriate track (Quick Flow, BMad Method, or Enterprise Method). User can override suggested track. ### Correct Course @@ -305,7 +299,7 @@ Plan for handling changes to existing data, schemas, APIs, or patterns during br ### Feature Flags -Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for Level 2+ brownfield changes. +Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for BMad Method and Enterprise brownfield changes. ### Integration Points @@ -320,8 +314,8 @@ Quick Spec Flow feature that automatically detects existing code style, naming c ## Related Documentation - [Quick Start Guide](./quick-start.md) - Learn BMM basics -- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on levels and complexity +- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on tracks and complexity - [Brownfield Guide](./brownfield-guide.md) - Working with existing codebases -- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for Level 0-1 +- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for Quick Flow track - [FAQ](./faq.md) - Common questions - [Troubleshooting](./troubleshooting.md) - Problem resolution diff --git a/src/modules/bmm/docs/quick-spec-flow.md b/src/modules/bmm/docs/quick-spec-flow.md index 1d00d5c4..f69832a6 100644 --- a/src/modules/bmm/docs/quick-spec-flow.md +++ b/src/modules/bmm/docs/quick-spec-flow.md @@ -8,26 +8,26 @@ ## What is Quick Spec Flow? -Quick Spec Flow is a **streamlined alternative** to the full BMad Method for Level 0-1 projects. Instead of going through Product Brief → PRD → Architecture, you go **straight to a context-aware technical specification** and start coding. +Quick Spec Flow is a **streamlined alternative** to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go **straight to a context-aware technical specification** and start coding. ### When to Use Quick Spec Flow -✅ **Use Quick Spec Flow (Level 0-1) when:** +✅ **Use Quick Flow track when:** -- Single bug fix or small enhancement (Level 0) -- Small feature with 2-3 related changes (Level 1) +- Single bug fix or small enhancement +- Small feature with clear scope (typically 1-15 stories) - Rapid prototyping or experimentation - Adding to existing brownfield codebase - You know exactly what you want to build -❌ **Use Full BMM Flow (Level 2-4) when:** +❌ **Use BMad Method or Enterprise tracks when:** -- Building new products or major features (Level 2-4) +- Building new products or major features - Need stakeholder alignment - Complex multi-team coordination - Requires extensive planning and architecture -💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's size and complexity! +💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs! --- @@ -68,7 +68,7 @@ flowchart TD --- -## Level 0: Single Atomic Change +## Single Atomic Change **Best for:** Bug fixes, single file changes, isolated improvements @@ -104,7 +104,7 @@ flowchart TD - ✅ Auto-validates quality - ✅ Story context optional (tech-spec is comprehensive!) -### Example Level 0 Scenarios +### Example Single Change Scenarios - "Fix the login validation bug" - "Add email field to user registration form" @@ -113,13 +113,13 @@ flowchart TD --- -## Level 1: Coherent Small Feature +## Coherent Small Feature **Best for:** Small features with 2-3 related user stories ### What You Get -1. **tech-spec.md** - Same comprehensive spec as Level 0 +1. **tech-spec.md** - Same comprehensive spec as single change projects 2. **epics.md** - Epic organization with story breakdown 3. **story-[epic-slug]-1.md** - First story 4. **story-[epic-slug]-2.md** - Second story @@ -147,7 +147,7 @@ Stories are **automatically validated** to ensure proper sequence: - ✅ Infrastructure → Features → Polish order - ✅ Backend → Frontend flow -### Example Level 1 Scenarios +### Example Small Feature Scenarios - "Add OAuth social login (Google, GitHub, Twitter)" - "Build user profile page with avatar upload" @@ -302,7 +302,7 @@ Generates scores: - Implementation Readiness: ✅ Ready ``` -### Story Validation (Level 1 Only) +### Story Validation (Multi-Story Features) Checks: @@ -317,7 +317,7 @@ Checks: ## Complete User Journey -### Scenario 1: Bug Fix (Level 0) +### Scenario 1: Bug Fix (Single Change) **Goal:** Fix login validation bug @@ -342,7 +342,7 @@ Checks: --- -### Scenario 2: Small Feature (Level 1) +### Scenario 2: Small Feature (Multi-Story) **Goal:** Add OAuth social login (Google, GitHub) @@ -392,7 +392,7 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows: ### sprint-planning (SM Agent) - ✅ Works with epics.md from tech-spec -- ✅ Organizes Level 1 stories for coordinated implementation +- ✅ Organizes multi-story features for coordinated implementation - ✅ Tracks progress through sprint-status.yaml ### dev-story (DEV Agent) @@ -405,7 +405,7 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows: ## Comparison: Quick Spec vs Full BMM -| Aspect | Quick Spec Flow (Level 0-1) | Full BMM Flow (Level 2-4) | +| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks | | --------------------- | ---------------------------- | ---------------------------------- | | **Setup** | None (standalone) | workflow-init recommended | | **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture | @@ -419,18 +419,18 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows: --- -## When to Graduate from Quick Spec to Full BMM +## When to Graduate from Quick Flow to BMad Method -Start with Quick Spec, but switch to Full BMM when: +Start with Quick Flow, but switch to BMad Method when: -- ❌ Project grows beyond 3-5 stories +- ❌ Project grows beyond initial scope - ❌ Multiple teams need coordination - ❌ Stakeholders need formal documentation - ❌ Product vision is unclear - ❌ Architectural decisions need deep analysis - ❌ Compliance/regulatory requirements exist -💡 **Tip:** You can always run `workflow-init` later to transition from Quick Spec to Full BMM! +💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method! --- @@ -466,8 +466,8 @@ Start with Quick Spec, but switch to Full BMM when: ### 🎯 **Focus** -- Level 0: Single atomic change -- Level 1: Coherent small feature +- Single atomic changes +- Coherent small features - No scope creep - Fast iteration @@ -500,7 +500,7 @@ Start with Quick Spec, but switch to Full BMM when: Quick Spec Flow is **fully standalone**: -- Detects if you're Level 0 or Level 1 +- Detects if it's a single change or multi-story feature - Asks for greenfield vs brownfield - Works without status file tracking - Perfect for rapid prototyping @@ -525,13 +525,13 @@ Quick Spec Flow is **fully standalone**: **A:** Absolutely! Quick Spec Flow captures UX/UI considerations, component changes, and accessibility requirements. -### Q: What if my Level 0 project grows? +### Q: What if my Quick Flow project grows? -**A:** No problem! You can always transition to Full BMM by running workflow-init and create-prd. Your tech-spec becomes input for the PRD. +**A:** No problem! You can always transition to BMad Method by running workflow-init and create-prd. Your tech-spec becomes input for the PRD. ### Q: Do I need story-context for every story? -**A:** Usually no! Tech-spec is comprehensive enough for most Level 0-1 projects. Only use story-context for complex edge cases. +**A:** Usually no! Tech-spec is comprehensive enough for most Quick Flow projects. Only use story-context for complex edge cases. ### Q: Can I skip validation? @@ -566,13 +566,13 @@ When validation runs, read the scores. They tell you if your spec is production- ### 5. **Story Context is Optional** -For Level 0, try going directly to dev-story first. Only add story-context if you hit complexity. +For single changes, try going directly to dev-story first. Only add story-context if you hit complexity. -### 6. **Keep Level 0 Truly Atomic** +### 6. **Keep Single Changes Truly Atomic** -If your "single change" needs 3+ files, it might be Level 1. Let the workflow guide you. +If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you. -### 7. **Validate Story Sequence for Level 1** +### 7. **Validate Story Sequence for Multi-Story Features** When you get multiple stories, check the dependency validation output. Proper sequence matters! @@ -580,7 +580,7 @@ When you get multiple stories, check the dependency validation output. Proper se ## Real-World Examples -### Example 1: Adding Logging (Level 0) +### Example 1: Adding Logging (Single Change) **Input:** "Add structured logging to payment processing" @@ -596,7 +596,7 @@ When you get multiple stories, check the dependency validation output. Proper se --- -### Example 2: Search Feature (Level 1) +### Example 2: Search Feature (Multi-Story) **Input:** "Add search to product catalog with filters" diff --git a/src/modules/bmm/docs/quick-start.md b/src/modules/bmm/docs/quick-start.md index 31088fbb..8e943402 100644 --- a/src/modules/bmm/docs/quick-start.md +++ b/src/modules/bmm/docs/quick-start.md @@ -19,7 +19,7 @@ BMad Method (BMM) helps you build software through guided workflows with special 1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief 2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD) -3. **Phase 3: Architecture** (Conditional) - Design the architecture for complex projects (10+ stories) +3. **Phase 3: Solutioning** (Track-dependent) - Design the architecture for BMad Method and Enterprise tracks 4. **Phase 4: Implementation** (Required) - Build your software Epic by Epic, Story by Story ## Installation @@ -54,28 +54,28 @@ During workflow-init, you'll describe: - Whether there's an existing codebase or this is a new project - The general size and complexity (you can adjust this later) -#### Project Scale Levels +#### Planning Tracks -Based on your description, the workflow will suggest a level and let you choose from: +Based on your description, the workflow will suggest a track and let you choose from: -**Greenfield Project Levels:** +**Three Planning Tracks:** -- **Level 0** - Single atomic change (1 story) - bug fixes, typos, minor updates, single file changes -- **Level 1** - Small feature (1-10 stories) - simple additions, isolated features, one module -- **Level 2** - Medium feature set (5-15 stories) - dashboards, multiple related features, several modules -- **Level 3** - Complex integration (12-40 stories) - platform features, major integrations, architectural changes -- **Level 4** - Enterprise expansion (40+ stories) - multi-tenant, ecosystem changes, system-wide initiatives +- **Quick Flow** - Fast implementation (tech-spec only) - bug fixes, simple features, clear scope (typically 1-15 stories) +- **BMad Method** - Full planning (PRD + Architecture + UX) - products, platforms, complex features (typically 10-50+ stories) +- **Enterprise Method** - Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance, multi-tenant (typically 30+ stories) + +**Note**: Story counts are guidance, not definitions. Tracks are chosen based on planning needs, not story math. #### What gets created? -Once you confirm your level, the `bmm-workflow-status.md` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases. +Once you confirm your track, the `bmm-workflow-status.yaml` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases. **Important notes:** -- Every level has different paths through the phases +- Every track has different paths through the phases - Story counts can still change based on overall complexity as you work -- For this guide, we'll assume a Level 2 project -- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for Level 2+ complexity) +- For this guide, we'll assume a BMad Method track project +- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for BMad Method and Enterprise tracks) ### Step 2: Work Through Phases 1-3 @@ -100,12 +100,12 @@ Phase 1 (Analysis) is entirely optional. All workflows are optional or recommend The next TRULY REQUIRED step is: - PRD (Product Requirements Document) in Phase 2 - Planning - Agent: pm - - Command: /bmad:bmm:workflows:prd + - Command: prd ``` #### How to Run Workflows in Phases 1-3 -When an agent tells you to run a workflow (like `/bmad:bmm:workflows:prd`): +When an agent tells you to run a workflow (like `prd`): 1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](../docs/ide-info/) for your IDE's specific instructions 2. **Wait for the menu** to appear @@ -121,21 +121,21 @@ The agents in V6 are very good with fuzzy menu matching! For v4 users or those who prefer to skip workflow-status guidance: - **Analyst** → Brainstorming, Product Brief -- **PM** → PRD (10+ stories) OR tech-spec (1-10 stories) +- **PM** → PRD (BMad Method/Enterprise tracks) OR tech-spec (Quick Flow track) - **UX-Designer** → UX Design Document (if UI-heavy) -- **Architect** → Architecture (10+ stories) +- **Architect** → Architecture (BMad Method/Enterprise tracks) #### Phase 2: Planning - Creating the PRD -**For Level 2+ projects (10+ stories):** +**For BMad Method and Enterprise tracks:** 1. Load the **PM agent** in a new chat 2. Tell it to run the PRD workflow -3. Once complete, you'll have two files: +3. Once complete, you'll have: - **PRD.md** - Your Product Requirements Document - - **Epics.md** - High-level epics with stories + - Epic breakdown -**For smaller projects (Levels 0-1):** +**For Quick Flow track:** - Use **tech-spec** instead of PRD (no architecture needed) @@ -149,7 +149,7 @@ If your project has a user interface: #### Phase 3: Architecture -**For Level 2+ projects only:** +**For BMad Method and Enterprise tracks:** 1. Load the **Architect agent** in a new chat 2. Tell it to run the create-architecture workflow @@ -261,7 +261,7 @@ The agent creates documents, asks questions, and helps you make decisions throug BMad creates two files to track your progress: -**1. bmm-workflow-status.md** +**1. bmm-workflow-status.yaml** - Shows which phase you're in and what's next - Created by workflow-init @@ -293,16 +293,16 @@ flowchart LR subgraph P2["Phase 2 (Required)
Planning"] direction TB - B1[Level 0-1:
tech-spec] - B2[Level 2+:
PRD] + B1[Quick Flow:
tech-spec] + B2[Method/Enterprise:
PRD] B3[UX opt] B4[PM, UX] B1 ~~~ B2 ~~~ B3 ~~~ B4 end - subgraph P3["Phase 3 (Conditional)
Architecture"] + subgraph P3["Phase 3 (Track-dependent)
Solutioning"] direction TB - C1[Level 2+:
architecture] + C1[Method/Enterprise:
architecture] C2[gate-check] C3[Architect] C1 ~~~ C2 ~~~ C3 @@ -332,7 +332,7 @@ flowchart LR ## Common Questions **Q: Do I always need architecture?** -A: Only for larger projects (10+ stories). Small projects can skip straight from tech-spec to implementation. +A: Only for BMad Method and Enterprise tracks. Quick Flow projects skip straight from tech-spec to implementation. **Q: Can I change my plan later?** A: Yes! The SM agent has a "correct-course" workflow for handling scope changes. @@ -359,7 +359,7 @@ A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directl ✅ **Always use fresh chats** - Load agents in new chats for each workflow to avoid context issues ✅ **Let workflow-status guide you** - Load any agent and ask for status when unsure what's next -✅ **Level matters** - Small projects (0-1) use tech-spec, larger projects (2+) need PRD and architecture +✅ **Track matters** - Quick Flow uses tech-spec, BMad Method/Enterprise need PRD and architecture ✅ **Tracking is automatic** - The status files update themselves, no manual editing needed ✅ **Agents are flexible** - Use menu numbers, shortcuts (\*prd), or natural language diff --git a/src/modules/bmm/docs/scale-adaptive-system.md b/src/modules/bmm/docs/scale-adaptive-system.md index 9dc35920..84f91edf 100644 --- a/src/modules/bmm/docs/scale-adaptive-system.md +++ b/src/modules/bmm/docs/scale-adaptive-system.md @@ -1,136 +1,127 @@ # BMad Method Scale Adaptive System -**Automatically adapts workflows to project complexity - from bug fixes to enterprise systems** +**Automatically adapts workflows to project complexity - from quick fixes to enterprise systems** --- ## Overview -The **Scale Adaptive System** is BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project size and complexity. +The **Scale Adaptive System** intelligently routes projects to the right planning methodology based on complexity, not arbitrary story counts. -### The Problem It Solves +### The Problem Traditional methodologies apply the same process to every project: -- ❌ **Overkill:** Bug fix requires full design docs -- ❌ **Insufficient:** Enterprise system built with minimal planning -- ❌ **One-Size-Fits-None:** Same process for 1 story and 100 stories +- Bug fix requires full design docs +- Enterprise system built with minimal planning +- One-size-fits-none approach ### The Solution -BMad Method **adapts workflows to match project scale**: +BMad Method adapts to three distinct planning tracks: -- ✅ **Level 0 (1 story):** Tech-spec only, implement immediately -- ✅ **Level 2 (10 stories):** PRD + Architecture, structured approach -- ✅ **Level 4 (100+ stories):** Full enterprise planning, comprehensive docs +- **Quick Flow**: Tech-spec only, implement immediately +- **BMad Method**: PRD + Architecture, structured approach +- **Enterprise Method**: Full planning with security/devops/test -**Result:** Right amount of planning for every project - no more, no less. +**Result**: Right planning depth for every project. --- ## Quick Reference -### Five Levels at a Glance +### Three Tracks at a Glance -| Level | Scope | Stories | Documentation | Timeline | -| ----- | -------------------- | ------- | ------------------- | -------- | -| **0** | Single atomic change | 1 | tech-spec only | Hours | -| **1** | Small feature | 1-10 | tech-spec + epic | Days | -| **2** | Medium project | 5-15 | PRD + optional arch | Weeks | -| **3** | Complex integration | 12-40 | PRD + architecture | Months | -| **4** | Enterprise scale | 40+ | Full methodology | Quarters | +| Track | Planning Depth | Time Investment | Best For | +| --------------------- | --------------------- | --------------- | ------------------------------------------ | +| **Quick Flow** | Tech-spec only | Hours to 1 day | Simple features, bug fixes, clear scope | +| **BMad Method** | PRD + Arch + UX | 1-3 days | Products, platforms, complex features | +| **Enterprise Method** | Method + Test/Sec/Ops | 3-7 days | Enterprise needs, compliance, multi-tenant | -### Level Selection Decision Tree +### Decision Tree ```mermaid flowchart TD START{Describe your project} - START -->|Bug fix, typo, patch| L0[Level 0
tech-spec only] - START -->|Small feature, 2-3 stories| L1[Level 1
tech-spec + epic] - START -->|Dashboard, multiple features| L2[Level 2
PRD + optional arch] - START -->|Platform, complex integration| L3[Level 3
PRD + architecture] - START -->|Enterprise, multi-tenant| L4[Level 4
Full methodology] + START -->|Bug fix, simple feature| Q1{Scope crystal clear?} + START -->|Product, platform, complex| M[BMad Method
PRD + Architecture] + START -->|Enterprise, compliance| E[Enterprise Method
Extended Planning] - style L0 fill:#bfb,stroke:#333,stroke-width:2px - style L1 fill:#bbf,stroke:#333,stroke-width:2px - style L2 fill:#ffb,stroke:#333,stroke-width:2px - style L3 fill:#fbf,stroke:#333,stroke-width:2px - style L4 fill:#f9f,stroke:#333,stroke-width:2px + Q1 -->|Yes| QF[Quick Flow
Tech-spec only] + Q1 -->|Uncertain| M + + style QF fill:#bfb,stroke:#333,stroke-width:2px + style M fill:#bbf,stroke:#333,stroke-width:2px + style E fill:#f9f,stroke:#333,stroke-width:2px ``` ### Quick Keywords -- **Level 0:** fix, bug, typo, small change, patch -- **Level 1:** simple, basic, small feature, add, minor -- **Level 2:** dashboard, several features, admin panel, medium -- **Level 3:** platform, integration, complex, system, architecture -- **Level 4:** enterprise, multi-tenant, multiple products, ecosystem, scale +- **Quick Flow**: fix, bug, simple, add, clear scope +- **BMad Method**: product, platform, dashboard, complex, multiple features +- **Enterprise Method**: enterprise, multi-tenant, compliance, security, audit --- -## How Level Detection Works +## How Track Selection Works -When you run `workflow-init`, it analyzes your project using three methods: +When you run `workflow-init`, it guides you through an educational choice: -### 1. Keyword Analysis +### 1. Description Analysis -Scans your description for level-specific keywords (see Quick Keywords above). +Analyzes your project description for complexity indicators and suggests an appropriate track. -### 2. Story Count Estimation +### 2. Educational Presentation -Asks about expected scope and matches to ranges: +Shows all three tracks with: -| Stories | Suggested Level | -| ------- | --------------- | -| 1 | Level 0 | -| 2-10 | Level 1 | -| 5-15 | Level 2 | -| 12-40 | Level 3 | -| 40+ | Level 4 | +- Time investment +- Planning approach +- Benefits and trade-offs +- AI agent support level +- Concrete examples -**Note:** Overlap zones (5-10, 12-15) are intentional - choose based on need for product-level planning. +### 3. Honest Recommendation -### 3. Complexity Indicators +Provides tailored recommendation based on: -Additional factors: +- Complexity keywords +- Greenfield vs brownfield +- User's description -- Multiple teams involved? → Higher level -- External integrations? → Higher level -- Compliance requirements? → Higher level -- Multi-tenant needs? → Level 4 -- Existing system modifications? → Consider brownfield path +### 4. User Choice -### Manual Override - -**You can always override the suggested level.** workflow-init asks for confirmation - if you disagree, just say so and choose the appropriate level. Trust your judgment. +You choose the track that fits your situation. The system guides but never forces. **Example:** ``` -workflow-init: "Based on your description: Level 3 project. Is that correct?" -You: "No, this is simpler - Level 2" -workflow-init: "Got it, creating Level 2 workflow" +workflow-init: "Based on 'Add user dashboard with analytics', I recommend BMad Method. + This involves multiple features and system design. The PRD + Architecture + gives AI agents complete context for better code generation." + +You: "Actually, this is simpler than it sounds. Quick Flow." + +workflow-init: "Got it! Using Quick Flow with tech-spec." ``` --- -## The Five Levels +## The Three Tracks -### Level 0: Single Atomic Change +### Track 1: Quick Flow -**Definition:** Single-story projects like bug fixes, typos, or small patches. +**Definition**: Fast implementation with tech-spec planning. -**Story Count:** 1 story +**Time**: Hours to 1 day of planning -**Timeline:** Hours to 1 day +**Planning Docs**: -**Documentation Requirements:** +- Tech-spec.md (implementation-focused) +- Story files (1-15 typically, auto-detects epic structure) -- **tech-spec.md** - Technical specification with implementation details -- Single story file - -**Workflow Path:** +**Workflow Path**: ``` (Brownfield: document-project first if needed) @@ -138,280 +129,162 @@ workflow-init: "Got it, creating Level 2 workflow" Tech-Spec → Implement ``` -**No Architecture:** Skip entirely -**No PRD:** Tech-spec serves as complete planning doc - -**Use For:** +**Use For**: - Bug fixes -- Single file changes -- Minor configuration updates -- Small refactors -- Typo corrections +- Simple features +- Enhancements with clear scope +- Quick additions -**Example:** "Fix authentication token expiration bug in auth middleware" +**Story Count**: Typically 1-15 stories (guidance, not rule) -**Keywords:** fix, bug, typo, small change, quick update, patch +**Example**: "Fix authentication token expiration bug" + +**AI Agent Support**: Basic - minimal context provided + +**Trade-off**: Less planning = higher rework risk if complexity emerges --- -### Level 1: Small Feature +### Track 2: BMad Method (RECOMMENDED) -**Definition:** Small coherent features with 2-10 related stories. +**Definition**: Full product + system design planning. -**Story Count:** 1-10 stories (typically 2-5) +**Time**: 1-3 days of planning -**Timeline:** 1-3 days +**Planning Docs**: -**Documentation Requirements:** +- PRD.md (product requirements) +- Architecture.md (system design) +- UX Design (if UI components) +- Epic breakdown with stories -- **tech-spec.md** - Technical specification with epic breakdown -- **Epic organization** - Stories grouped by epic -- 2-10 story files - -**Workflow Path:** +**Workflow Path**: ``` (Brownfield: document-project first if needed) ↓ -Tech-Spec + Epic → (Optional) UX Design → Implement +(Optional: Analysis phase - brainstorm, research, product brief) +↓ +PRD → (Optional UX) → Architecture → Gate Check → Implement ``` -**No Architecture:** Skip entirely -**No PRD:** Tech-spec with epic is sufficient +**Use For**: -**Use For:** +**Greenfield**: -- Single module additions -- Small UI enhancements -- Isolated feature additions -- API endpoint additions (OAuth, forgot password, search) +- Products +- Platforms +- Multi-feature initiatives -**Example:** "Add OAuth social login (Google, GitHub, Facebook)" +**Brownfield**: -**UX Note:** Tech-spec can include UX considerations inline, or run separate UX Design workflow if UI is complex. +- Complex additions (new UIs + APIs) +- Major refactors +- New modules -**Keywords:** simple, basic, small feature, add, minor +**Story Count**: Typically 10-50+ stories (guidance, not rule) + +**Examples**: + +- "User dashboard with analytics and preferences" +- "Add real-time collaboration to existing document editor" +- "Payment integration system" + +**AI Agent Support**: Exceptional - complete context for coding partnership + +**Why Architecture for Brownfield?** + +Your brownfield documentation might be huge. Architecture workflow distills massive codebase context into a focused solution design specific to YOUR project. This keeps AI agents focused without getting lost in existing code. + +**Benefits**: + +- Complete AI agent context +- Prevents architectural drift +- Fewer surprises during implementation +- Better code quality +- Faster overall delivery (planning pays off) --- -### Level 2: Medium Project +### Track 3: Enterprise Method -**Definition:** Multiple related features across 1-3 epics. +**Definition**: Extended planning with security, devops, and test strategy. -**Story Count:** 5-15 stories +**Time**: 3-7 days of planning -**Timeline:** 1-2 weeks +**Planning Docs**: -**Documentation Requirements:** +- All BMad Method docs PLUS: +- Security Architecture +- DevOps Strategy +- Test Strategy +- Compliance documentation -- **PRD.md** - Product requirements document -- **epics.md** - Epic breakdown with stories -- **tech-spec.md** (optional) - Or use epic-tech-specs during implementation -- **architecture.md** (optional) - Only if system design needed - -**Workflow Path:** +**Workflow Path**: ``` -(Brownfield: document-project first if needed) +(Brownfield: document-project nearly mandatory) ↓ -Analysis (recommended) → PRD + Epics → (Optional) UX Design → (Optional) Architecture → Implement - ↓ - Epic-tech-spec per epic (recommended) - ↓ - Retrospective after each epic (if >1 epic) -``` - -**Architecture:** Optional - only if system design needed -**Epic-Tech-Specs:** Recommended during implementation - -**Use For:** - -- Multiple related features -- Cross-module enhancements -- Admin dashboards -- Customer portals -- Reporting systems - -**Example:** "Add user dashboard with analytics, preferences, and activity history" - -**Level 2 Decision:** Choose Level 2 over Level 1 when you need product-level planning, have multiple epics, or require stakeholder alignment. - -**Keywords:** dashboard, several features, admin panel, medium - ---- - -### Level 3: Complex Integration - -**Definition:** Complex systems with multiple subsystems and integrations. - -**Story Count:** 12-40 stories - -**Timeline:** 3-6 weeks - -**Documentation Requirements:** - -- **PRD.md** - Comprehensive product requirements -- **epics.md** - Detailed epic breakdown -- **architecture.md** - Required comprehensive system architecture -- **UX design** (recommended for user-facing systems) - -**Workflow Path:** - -``` -(Brownfield: document-project first if needed) +Analysis (recommended/required) → PRD → UX → Architecture ↓ -Analysis + Research → PRD + Epics → (Recommended) UX Design → Architecture (required) → Gate Check → Implement - ↓ - Epic-tech-spec per epic (recommended) - ↓ - Retrospective after each epic -``` - -**Architecture:** Required - comprehensive system design -**Gate Check:** Required - validate cohesion before implementation -**Epic-Tech-Specs:** Highly recommended - -**Use For:** - -- Major feature additions -- Architectural integrations -- Multi-system changes -- E-commerce platforms -- SaaS products -- Multi-module systems - -**Example:** "Adding real-time collaboration features to existing document editor" - -**Critical for Level 3:** - -- Architecture review before planning -- Integration strategy document -- Backward compatibility planning -- Phased rollout consideration - -**Keywords:** platform, integration, complex, system, architecture - ---- - -### Level 4: Enterprise Scale - -**Definition:** Enterprise-scale projects across multiple products or major platform expansions. - -**Story Count:** 40+ stories - -**Timeline:** 3-6 months - -**Documentation Requirements:** - -- **Product brief** - Strategic planning document -- **PRD.md** - Comprehensive product requirements -- **epics.md** - Detailed epic breakdown -- **architecture.md** - Required enterprise-grade architecture -- **UX design** (recommended) - Design system and patterns - -**Workflow Path:** - -``` -(Brownfield: document-project first - nearly mandatory) +Security Architecture → DevOps Strategy → Test Strategy ↓ -Analysis + Research → PRD + Epics → UX Design → Enterprise Architecture → Gate Check → Implement - ↓ - Epic-tech-spec per epic (recommended) - ↓ - Additional design docs for complex subsystems - ↓ - Retrospective after each epic +Gate Check → Implement ``` -**Architecture:** Required - enterprise-grade system design including: +**Use For**: -- Multi-tenancy design -- Security architecture -- Scalability planning -- Integration architecture -- Data architecture -- Deployment architecture - -**Gate Checks:** Required - multiple validation gates -**Additional Design Documents:** Created during implementation as needed - -**Use For:** - -- Platform expansions -- Multi-team initiatives -- System-wide modernization +- Enterprise requirements - Multi-tenant systems -- Product ecosystems -- Enterprise platforms +- Compliance needs (HIPAA, SOC2, etc.) +- Mission-critical systems +- Security-sensitive applications -**Example:** "Adding multi-tenancy to existing single-tenant SaaS platform" +**Story Count**: Typically 30+ stories (but defined by enterprise needs, not count) -**Critical for Enterprise:** +**Examples**: -- Documentation phase nearly mandatory -- Analysis phase (research, product brief) required -- Full architecture review before planning -- Extensive integration testing strategy -- Risk assessment and mitigation planning -- Cross-team coordination -- Feature flag implementation -- Migration strategy for existing data/users +- "Multi-tenant SaaS platform" +- "HIPAA-compliant patient portal" +- "Add SOC2 audit logging to enterprise app" -**Keywords:** enterprise, multi-tenant, multiple products, ecosystem, scale +**AI Agent Support**: Elite - comprehensive enterprise planning + +**Critical for Enterprise**: + +- Security architecture and threat modeling +- DevOps pipeline planning +- Comprehensive test strategy +- Risk assessment +- Compliance mapping --- -## Planning Documents by Level +## Planning Documents by Track -### Understanding Document Types +### Quick Flow Documents -```mermaid -flowchart TD - LEVEL{What Level?} +**Created**: Upfront in Planning Phase - LEVEL -->|0-1| TS[tech-spec
Created upfront
Only planning doc] - LEVEL -->|2-4| PRD[PRD
Created upfront
Product planning] - - PRD --> ARCH{Architecture
needed?} - ARCH -->|Yes
Level 3-4| ARCHD[architecture.md
Created upfront
System design] - ARCH -->|Optional
Level 2| MAYBE[Maybe architecture
if system design needed] - - TS --> IMPL1[Implementation] - ARCHD --> IMPL2[Implementation] - MAYBE --> IMPL2 - - IMPL2 --> ETS[epic-tech-spec
Created just-in-time
Per epic during Phase 4] - - style TS fill:#bfb,stroke:#333,stroke-width:2px - style PRD fill:#bbf,stroke:#333,stroke-width:2px - style ARCHD fill:#ffb,stroke:#333,stroke-width:2px - style ETS fill:#fbf,stroke:#333,stroke-width:2px -``` - -### Tech-Spec (Level 0-1) - -**Created:** Upfront in Planning Phase (Phase 2) -**Serves as:** Primary and only planning document - -**Contains:** +**Tech-Spec**: - Problem statement and solution -- Source tree changes (specific files) +- Source tree changes - Technical implementation details - Detected stack and conventions (brownfield) - UX/UI considerations (if user-facing) - Testing strategy -- Developer resources -**When Used:** Replaces PRD + Architecture for small projects +**Serves as**: Complete planning document (replaces PRD + Architecture) -### PRD (Level 2-4) +--- -**Created:** Upfront in Planning Phase (Phase 2) -**Serves as:** Product-level planning document +### BMad Method Documents -**Contains:** +**Created**: Upfront in Planning and Solutioning Phases + +**PRD (Product Requirements Document)**: - Product vision and goals - Feature requirements @@ -420,20 +293,7 @@ flowchart TD - User experience considerations - Business context -**Complements:** Architecture document (system design) - -### Architecture Document (Level 2-4) - -**Created:** Upfront in Solutioning Phase (Phase 3) -**Serves as:** System-level design document - -**Scale-Adaptive Complexity:** - -- **Level 2:** Optional, lightweight if needed -- **Level 3:** Required, comprehensive -- **Level 4:** Required, enterprise-grade - -**Contains:** +**Architecture Document**: - System components and responsibilities - Data models and schemas @@ -442,44 +302,48 @@ flowchart TD - Performance considerations - Deployment architecture -**Note:** Takes the place of tech-spec for system-level planning in Level 2-4 projects. +**For Brownfield**: Acts as focused "solution design" that distills existing codebase into integration plan -### Epic-Tech-Spec (Level 2-4) +--- -**Created:** Just-in-time during Implementation Phase (Phase 4) -**Serves as:** Epic-specific implementation guide +### Enterprise Method Documents -**Contains:** +**Created**: Extended planning across multiple phases -- Epic-specific technical details -- Detailed implementation approach for this epic -- Code-level design decisions -- Epic-scoped testing strategy -- Integration points with other epics +Includes all BMad Method documents PLUS: -**Key Difference from Tech-Spec:** +**Security Architecture**: -- **Tech-spec (0-1):** Created upfront, primary planning doc -- **Epic-tech-spec (2-4):** Created during implementation, supplements PRD + Architecture +- Threat modeling +- Authentication/authorization design +- Data protection strategy +- Audit requirements -**Why Just-In-Time?** +**DevOps Strategy**: -- Implementation learnings inform later epic-tech-specs -- Avoids over-planning details that may change -- Keeps specs fresh and relevant -- Retrospectives provide input for next epic-tech-spec +- CI/CD pipeline design +- Infrastructure architecture +- Monitoring and alerting +- Disaster recovery + +**Test Strategy**: + +- Test approach and coverage +- Automation strategy +- Quality gates +- Performance testing --- ## Workflow Comparison -| Level | Analysis | Planning | Architecture | Epic-Tech-Specs | Stories | Retrospectives | -| ----- | ----------- | ---------------- | ------------ | --------------- | ------- | ----------------------- | -| **0** | Optional | Tech-spec | None | N/A | 1 | N/A | -| **1** | Optional | Tech-spec + Epic | None | N/A | 2-10 | N/A | -| **2** | Recommended | PRD | Optional | Recommended | 5-15 | After each epic (if >1) | -| **3** | Required | PRD | Required | Recommended | 12-40 | After each epic | -| **4** | Required | PRD | Required | Recommended | 40+ | After each epic | +| Track | Analysis | Planning | Architecture | Security/Ops | Typical Stories | +| --------------- | ----------- | --------- | ------------ | ------------ | --------------- | +| **Quick Flow** | Optional | Tech-spec | None | None | 1-15 | +| **BMad Method** | Recommended | PRD + UX | Required | None | 10-50+ | +| **Enterprise** | Required | PRD + UX | Required | Required | 30+ | + +**Note**: Story counts are GUIDANCE based on typical usage, NOT definitions of tracks. --- @@ -487,14 +351,27 @@ flowchart TD ### Critical First Step -🚨 **For ALL brownfield projects (Level 0-4): Run document-project BEFORE planning workflows** +For ALL brownfield projects: Run `document-project` BEFORE planning workflows. ### Why document-project is Critical -- **Tech-spec workflow** (Level 0-1) uses this for auto-detection -- **PRD workflow** (Level 2-4) references existing code -- **Architecture workflow** (Level 3-4) builds on existing structure -- **Epic-tech-specs** reference existing implementations +**Quick Flow** uses it for: + +- Auto-detecting existing patterns +- Understanding codebase structure +- Confirming conventions + +**BMad Method** uses it for: + +- Architecture inputs (existing structure) +- Integration design +- Pattern consistency + +**Enterprise Method** uses it for: + +- Security analysis +- Integration architecture +- Risk assessment ### Brownfield Workflow Pattern @@ -504,109 +381,88 @@ flowchart TD CHECK{Has docs/
index.md?} START --> CHECK - CHECK -->|No| DOC[document-project workflow
Creates comprehensive docs] - CHECK -->|Yes| PLAN[Continue to Planning] + CHECK -->|No| DOC[document-project workflow
10-30 min] + CHECK -->|Yes| TRACK[Choose Track] - DOC --> PLAN - PLAN --> IMPL[Implementation] + DOC --> TRACK + TRACK -->|Quick| QF[Tech-Spec] + TRACK -->|Method| M[PRD + Arch] + TRACK -->|Enterprise| E[PRD + Arch + Sec/Ops] - style START fill:#f9f,stroke:#333,stroke-width:2px style DOC fill:#ffb,stroke:#333,stroke-width:2px - style PLAN fill:#bfb,stroke:#333,stroke-width:2px + style TRACK fill:#bfb,stroke:#333,stroke-width:2px ``` -**Three Options:** - -1. **No documentation:** Run document-project workflow (10-30 min) -2. **Has docs, no index.md:** Run index-docs task (2-5 min) -3. **Complete documentation:** Skip to planning - -**For complete brownfield guidance:** See [Brownfield Development Guide](./brownfield-guide.md) - --- ## Common Scenarios -### Scenario 1: Bug Fix (Level 0) +### Scenario 1: Bug Fix (Quick Flow) -**Input:** "Fix email validation bug in login form" +**Input**: "Fix email validation bug in login form" -**Detection:** +**Detection**: Keywords "fix", "bug" -- Keywords: "fix", "bug" -- Estimated stories: 1 +**Track**: Quick Flow -**Result:** Level 0 → Tech-spec only - -**Workflow:** +**Workflow**: 1. (Optional) Brief analysis 2. Tech-spec with single story 3. Implement immediately -**Time:** ~2-4 hours total +**Time**: 2-4 hours total --- -### Scenario 2: Small Feature (Level 1) +### Scenario 2: Small Feature (Quick Flow) -**Input:** "Add OAuth social login (Google, GitHub, Facebook)" +**Input**: "Add OAuth social login (Google, GitHub, Facebook)" -**Detection:** +**Detection**: Keywords "add", "feature", clear scope -- Keywords: "add", "feature" -- Estimated stories: 2-3 +**Track**: Quick Flow -**Result:** Level 1 → Tech-spec with epic - -**Workflow:** +**Workflow**: 1. (Optional) Research OAuth providers -2. Tech-spec with epic + 3 stories -3. (Optional) UX Design if UI is complex -4. Implement story-by-story +2. Tech-spec with 3 stories +3. Implement story-by-story -**Time:** 1-3 days +**Time**: 1-3 days --- -### Scenario 3: Customer Portal (Level 2) +### Scenario 3: Customer Portal (BMad Method) -**Input:** "Build customer portal with dashboard, tickets, billing" +**Input**: "Build customer portal with dashboard, tickets, billing" -**Detection:** +**Detection**: Keywords "portal", "dashboard", multiple features -- Keywords: "portal", "dashboard" -- Estimated stories: 10-12 +**Track**: BMad Method -**Result:** Level 2 → PRD + optional architecture +**Workflow**: -**Workflow:** - -1. Product Brief (recommended) +1. (Recommended) Product Brief 2. PRD with epics -3. (Optional) UX Design -4. (Optional) Architecture if system design needed -5. Implement with sprint planning -6. Create epic-tech-spec for each epic as you implement -7. Run retrospective after each epic +3. (If UI) UX Design +4. Architecture (system design) +5. Gate Check +6. Implement with sprint planning -**Time:** 1-2 weeks +**Time**: 1-2 weeks --- -### Scenario 4: E-commerce Platform (Level 3) +### Scenario 4: E-commerce Platform (BMad Method) -**Input:** "Build full e-commerce platform with products, cart, checkout, admin, analytics" +**Input**: "Build e-commerce platform with products, cart, checkout, admin, analytics" -**Detection:** +**Detection**: Keywords "platform", multiple subsystems -- Keywords: "platform", "full" -- Estimated stories: 30-35 +**Track**: BMad Method -**Result:** Level 3 → PRD + Architecture required - -**Workflow:** +**Workflow**: 1. Research + Product Brief 2. Comprehensive PRD @@ -614,33 +470,52 @@ flowchart TD 4. System Architecture (required) 5. Gate check 6. Implement with phased approach -7. Create epic-tech-spec per epic before implementing -8. Run retrospective after each epic -9. Create additional design docs as needed for complex subsystems -**Time:** 3-6 weeks +**Time**: 3-6 weeks --- -### Scenario 5: Adding Feature to Existing App (Brownfield Level 1) +### Scenario 5: Brownfield Addition (BMad Method) -**Input:** "Add search functionality to existing product catalog" +**Input**: "Add search functionality to existing product catalog" -**Detection:** +**Detection**: Brownfield + moderate complexity -- Keywords: "add", "existing" -- Estimated stories: 3-4 -- Field type: Brownfield +**Track**: BMad Method (not Quick Flow) -**Result:** Level 1 Brownfield - -**Critical First Step:** +**Critical First Step**: 1. **Run document-project** to analyze existing codebase -**Then Workflow:** 2. Tech-spec (uses document-project output for analysis) 3. Auto-detects existing patterns 4. Confirms conventions 5. Implement following existing patterns +**Then Workflow**: 2. PRD for search feature 3. Architecture (integration design - highly recommended) 4. Implement following existing patterns -**Time:** 1-3 days (including documentation) +**Time**: 1-2 weeks + +**Why Method not Quick Flow?**: Integration with existing catalog system benefits from architecture planning to ensure consistency. + +--- + +### Scenario 6: Multi-tenant Platform (Enterprise Method) + +**Input**: "Add multi-tenancy to existing single-tenant SaaS platform" + +**Detection**: Keywords "multi-tenant", enterprise scale + +**Track**: Enterprise Method + +**Workflow**: + +1. Document-project (mandatory) +2. Research (compliance, security) +3. PRD (multi-tenancy requirements) +4. Architecture (tenant isolation design) +5. Security Architecture (data isolation, auth) +6. DevOps Strategy (tenant provisioning, monitoring) +7. Test Strategy (tenant isolation testing) +8. Gate check +9. Phased implementation + +**Time**: 3-6 months --- @@ -648,97 +523,72 @@ flowchart TD ### 1. Document-Project First for Brownfield -Always run document-project before starting any brownfield workflow. Even if you know the code, AI agents need it. +Always run `document-project` before starting brownfield planning. AI agents need existing codebase context. -### 2. Trust the Detection +### 2. Trust the Recommendation -If workflow-init suggests Level 2, there's probably complexity you haven't considered. Review before overriding. +If `workflow-init` suggests BMad Method, there's probably complexity you haven't considered. Review carefully before overriding. -### 3. Start Small, Upgrade Later +### 3. Start Smaller if Uncertain -Uncertain between Level 1 and 2? Start with Level 1. You can always run PRD creation later if needed. +Uncertain between Quick Flow and Method? Start with Quick Flow. You can create PRD later if needed. ### 4. Don't Skip Gate Checks -For Level 3-4, gate checks prevent costly mistakes. Invest the time upfront. +For BMad Method and Enterprise, gate checks prevent costly mistakes. Invest the time. -### 5. Create Epic-Tech-Specs Just-Before-Implementation +### 5. Architecture is Optional but Recommended for Brownfield -For Level 2-4, create epic-tech-spec right before implementing each epic. Don't create all upfront. +Brownfield BMad Method makes architecture optional, but it's highly recommended. It distills complex codebase into focused solution design. -### 6. Run Retrospectives Between Epics +### 6. Discovery Phase Based on Need -Capture learnings after each epic. Feed insights into next epic-tech-spec. +Brainstorming and research are offered regardless of track. Use them when you need to think through the problem space. -### 7. Optional UX for Level 1 +### 7. Product Brief for Greenfield Method -If your Level 1 feature has complex UI, run separate UX Design. Otherwise, include UX notes in tech-spec. - -### 8. Architecture Scales - -Level 2 architecture is lighter than Level 3, which is lighter than Level 4. Don't over-architect. +Product Brief is only offered for greenfield BMad Method and Enterprise. It's optional but helps with strategic thinking. --- -## Appendix +## Key Differences from Legacy System -### A. Terminology Quick Reference +### Old System (Levels 0-4) -For complete definitions, see [Glossary](./glossary.md). +- Arbitrary story count thresholds +- Level 2 vs Level 3 based on story count +- Confusing overlap zones (5-10 stories, 12-40 stories) +- Tech-spec and PRD shown as conflicting options -**Key Terms:** +### New System (3 Tracks) -- **Scale-Adaptive:** System that adjusts workflow based on project complexity -- **Tech-Spec:** Technical specification document (Level 0-1, created upfront) -- **Epic-Tech-Spec:** Epic technical specification (Level 2-4, created just-in-time) -- **PRD:** Product Requirements Document -- **Just-In-Time Design:** Creating epic-tech-specs during implementation, not upfront -- **Context Injection:** Dynamic guidance via epic-tech-context and story-context workflows -- **Greenfield:** New project from scratch -- **Brownfield:** Existing codebase +- Methodology-based distinction (not story counts) +- Story counts as guidance, not definitions +- Clear track purposes: + - Quick Flow = Implementation-focused + - BMad Method = Product + system design + - Enterprise = Extended with security/ops +- Mutually exclusive paths chosen upfront +- Educational decision-making -### B. Workflow Path Configuration +--- -The v6 system uses modular path definitions stored in YAML configuration files. +## Migration from Old System -**Location:** `src/modules/bmm/workflows/workflow-status/paths/` +If you have existing projects using the old level system: -**Files:** +- **Level 0-1** → Quick Flow +- **Level 2-3** → BMad Method +- **Level 4** → Enterprise Method -- `greenfield-level-0.yaml` through `greenfield-level-4.yaml` -- `brownfield-level-0.yaml` through `brownfield-level-4.yaml` -- `game-design.yaml` -- `project-levels.yaml` (source of truth) - -Each path file defines: - -- Required vs optional workflows for each phase -- Agent assignments -- Expected outputs -- Phase progression rules - -### C. FAQ - -**Q: What's the difference between tech-spec and epic-tech-spec?** -A: Tech-spec (Level 0-1) is created upfront and serves as the primary planning doc. Epic-tech-spec (Level 2-4) is created during implementation per epic and supplements PRD + Architecture. - -**Q: Why no tech-spec at Level 2+?** -A: Level 2+ needs product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Instead, use epic-tech-specs during implementation for detailed technical guidance per epic. - -**Q: Do I always need Architecture at Level 2?** -A: No, it's optional. Only create Architecture if you need system-level design. Many Level 2 projects work with just PRD + epic-tech-specs. - -**Q: Can I change levels mid-project?** -A: Yes! If you started at Level 1 but realize it's Level 2, run create-prd to add proper planning docs. The system is flexible. - -For more questions, see [FAQ](./faq.md). +Run `workflow-init` on existing projects to migrate to new tracking system. It detects existing planning artifacts and creates appropriate workflow tracking. --- ## Related Documentation - **[Quick Start Guide](./quick-start.md)** - Get started with BMM -- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Level 0-1 +- **[Quick Spec Flow](./quick-spec-flow.md)** - Details on Quick Flow track - **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows - **[Glossary](./glossary.md)** - Complete terminology - **[FAQ](./faq.md)** - Common questions @@ -746,4 +596,4 @@ For more questions, see [FAQ](./faq.md). --- -_Scale Adaptive System - Because one size doesn't fit all._ +_Scale Adaptive System - Right planning depth for every project._ diff --git a/src/modules/bmm/workflows/workflow-status/init/instructions.md b/src/modules/bmm/workflows/workflow-status/init/instructions.md index 26b7c66d..2cafb48d 100644 --- a/src/modules/bmm/workflows/workflow-status/init/instructions.md +++ b/src/modules/bmm/workflows/workflow-status/init/instructions.md @@ -3,182 +3,289 @@ The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml You MUST have already loaded and processed: workflow-init/workflow.yaml Communicate in {communication_language} with {user_name} +This workflow handles BOTH new projects AND legacy projects being migrated to BMad Method - + Welcome to BMad Method, {user_name}! -Quick scan for context (do NOT analyze in depth yet): +Perform comprehensive scan for ALL existing work (not just quick scan): -- Check for codebase: src/, lib/, package.json, .git, etc. -- Check for BMM artifacts: PRD, epics, stories, tech-spec, architecture docs -- Store what was found but do NOT infer project details yet +**Check for BMM planning artifacts:** + +- PRD files: {output*folder}/\_prd*.md or {output*folder}/\_prd*/index.md +- Tech-spec files: {output*folder}/\_tech-spec*.md or {output*folder}/\_spec*.md +- Epic files: {output*folder}/\_epic*.md or {output*folder}/\_epic*/index.md +- Architecture: {output*folder}/\_architecture*.md or {output*folder}/\_arch*.md +- UX Design: {output*folder}/\_ux*.md or {output*folder}/\_design*.md +- Product Brief: {output*folder}/\_brief*.md +- Research docs: {output*folder}/\_research*.md +- Brainstorm docs: {output*folder}/\_brainstorm*.md + +**Check for implementation artifacts:** + +- Story files: {output_folder}/stories/\*.md +- Sprint status: {output*folder}/\_sprint*.yaml or {output_folder}/sprint-status.yaml +- Existing workflow status: {output_folder}/bmm-workflow-status.yaml + +**Check for codebase:** + +- Source code directories: src/, lib/, app/, components/, etc. +- Package files: package.json, requirements.txt, Cargo.toml, go.mod, pom.xml, etc. +- Git repository: .git/ +- Framework indicators: next.config.js, vite.config.js, etc. + + +Analyze findings and categorize project state: + +- **STATE 1:** Clean slate (no artifacts, no code or scaffold only) +- **STATE 2:** Planning in progress (has PRD or tech-spec, no stories/implementation yet) +- **STATE 3:** Implementation in progress (has stories or sprint status) +- **STATE 4:** Legacy codebase (has code but no BMM artifacts) +- **STATE 5:** Partial/unclear (some artifacts, state unclear) + What's your project called? {{#if project_name}}(Config shows: {{project_name}}){{/if}} -Set project_name +Store project_name project_name + - -I found some existing work here. Let me understand what you're working on: + - - -**Planning Documents Found:** -{{#each artifacts}} -- {{artifact_name}} ({{artifact_type}}, {{story_count}} stories, modified {{date}}) -{{/each}} - + + Perfect! This looks like a fresh start. + Set new_project = true + Continue to Step 3 (ask about their work) - - -**Codebase Found:** -- Source code in: {{source_dirs}} -- Tech stack: {{detected_tech_stack}} -{{#if git_history}} -- Git history: {{commit_count}} commits, last commit {{last_commit_date}} + + I found existing planning documents: + +{{#if found_prd}} +📋 **PRD:** {{prd_path}} +{{#if epic_count}}- {{epic_count}} epics, {{story_count}} stories{{/if}} + +- Last modified: {{prd_modified}} + {{/if}} + +{{#if found_tech_spec}} +📋 **Tech-Spec:** {{spec_path}} +{{#if story_count}}- {{story_count}} stories{{/if}} + +- Last modified: {{spec_modified}} + {{/if}} + +{{#if found_architecture}} +🏗️ **Architecture:** {{arch_path}} + +- Last modified: {{arch_modified}} + {{/if}} + +{{#if found_ux}} +🎨 **UX Design:** {{ux_path}} + +- Last modified: {{ux_modified}} + {{/if}} + +{{#if found_brief}} +📄 **Product Brief:** {{brief_path}} + +- Last modified: {{brief_modified}} + {{/if}} + +{{#if found_research}} +🔍 **Research:** {{research_paths}} +{{/if}} + +{{#if found_brainstorm}} +🧠 **Brainstorm:** {{brainstorm_paths}} {{/if}} - -Looking at what I found, are these: +What's your situation with these documents? -a) **Works in progress you're finishing** - continuing the work described in these documents -b) **Documents from a previous effort** - you're starting something NEW and different now -c) **The proposed work you're about to start** - these describe what you want to do -d) **None of these** - let me explain what I'm actually working on +a) **Continue this work** - These docs describe what I'm building now +b) **Override/replace** - These are old, I'm starting something NEW +c) **Already done** - This work is complete, I'm starting a NEW project +d) **Not sure** - Let me explain my situation Your choice [a/b/c/d]: - - User is continuing old work - analyze artifacts to get details - Set continuing_old_work = true - Go to Step 2 (Analyze artifacts for details) - + + Got it! I'll create workflow tracking for your existing planning. + Set continuing_existing_planning = true + Store found artifacts for auto-completion in workflow status + Continue to Step 5 (detect track from artifacts) + - - User is doing NEW work - old artifacts are just context - Set continuing_old_work = false - Go to Step 3 (Ask about NEW work) - + + Should I archive these old documents before we start fresh? - - Artifacts describe proposed work - Set continuing_old_work = true - Go to Step 2 (Analyze artifacts for details) - +I can move them to {output_folder}/archive/ so they're not in the way. - - User will explain their situation - Go to Step 3 (Ask about their work) - - +Archive old docs? (y/n) - - I don't see any existing code or planning documents. Looks like we're starting fresh! - Go to Step 3 (Ask about their work) - - + Create archive folder if needed + Move all found planning artifacts to {output_folder}/archive/ + {{#if archived}}✅ Old documents archived to {output_folder}/archive/{{else}}Starting fresh - old docs will be ignored{{/if}} + Set new_project = true + Continue to Step 3 (ask about their work) - -Analyze found artifacts in detail: -Extract project type from content (game vs software) -Count stories/epics to estimate level: - - Level 0: 1 story - - Level 1: 1-10 stories - - Level 2: 5-15 stories - - Level 3: 12-40 stories - - Level 4: 40+ stories - -Detect field type from codebase presence (greenfield vs brownfield) + -Based on the artifacts you're continuing, I'm suggesting **Level {{project_level}}** because I found {{story_count}} stories across {{epic_count}} epics. + + Should I archive the completed work before starting your new project? (y/n) + Archive old planning docs + {{#if archived}}✅ Completed work archived{{else}}Ready for your new project!{{/if}} + Set new_project = true + Continue to Step 3 (ask about their work) + -Here's the complexity scale for reference: - -**{{field_type}} Project Levels:** - -- **Level 0** - Single atomic change (1 story) - bug fixes, typos, minor updates -- **Level 1** - Small feature (1-10 stories) - simple additions, isolated features -- **Level 2** - Medium feature set (5-15 stories) - dashboards, multiple related features -- **Level 3** - Complex integration (12-40 stories) - platform features, major integrations -- **Level 4** - Enterprise expansion (40+ stories) - multi-tenant, ecosystem changes - -**My suggestion:** Level {{project_level}} {{field_type}} {{project_type}} project - - -Does this match what you're working on? (y/n or tell me what's different) - - - Use analyzed values - Go to Step 4 (Load workflow path) - - - - Update values based on user corrections - Updated to: Level {{project_level}} {{field_type}} {{project_type}}. Correct? (y/n) - Go to Step 4 (Load workflow path) - - -project_name -project_type -project_level -field_type - - - -Tell me about what you're working on. What's the goal? - -Analyze user's description using keyword detection: - -- Level 0 keywords: "fix", "bug", "typo", "small change", "update", "patch", "one file" -- Level 1 keywords: "simple", "basic", "small feature", "add", "minor", "single feature" -- Level 2 keywords: "dashboard", "several features", "admin panel", "medium", "feature set" -- Level 3 keywords: "platform", "integration", "complex", "system", "architecture" -- Level 4 keywords: "enterprise", "multi-tenant", "multiple products", "ecosystem", "phased" - - -Make initial determination: - -- project_type (game or software) -- project_level (0-4) - tentative based on keywords -- field_type (greenfield or brownfield) -- confidence (high/medium/low) - based on clarity of description - - - - Thanks! Let me ask a few clarifying questions to make sure I route you correctly: - -1. Roughly how many distinct features or changes do you think this involves? - -- Just one thing (e.g., fix a bug, add one button, update one API) -- A small feature (2-5 related changes) -- Several features (5-15 related things) -- A major addition (15-40 things to do) -- A large initiative (40+ changes across many areas) - - -Adjust project_level based on response - -2. How much of the existing codebase will this touch? - -- Single file or small area -- One module or component -- Multiple modules (2-4 areas) -- Many modules with integration needs -- System-wide changes - - -Validate and adjust project_level based on scope - - - 3. Is this a game or a software application? - Set project_type based on response + + Tell me what you're trying to accomplish: + Analyze response and guide to appropriate choice (a, b, or c) + Loop back to present choices again with guidance - + + 🚨 **I found active implementation work:** + +{{#if found_stories}} +📝 **Story files:** {{story_count}} stories in {output_folder}/stories/ +{{#if story_examples}}- Examples: {{story_examples}}{{/if}} +{{/if}} + +{{#if found_sprint_status}} +📊 **Sprint tracking:** {{sprint_status_path}} + +- {{completed_stories}} completed +- {{in_progress_stories}} in progress +- {{pending_stories}} pending + {{/if}} + +{{#if found_workflow_status}} +📋 **Workflow status:** {{workflow_status_path}} + +- Generated: {{workflow_status_date}} + {{/if}} + +{{#if found_planning_docs}} +📚 **Planning docs:** {{found_planning_summary}} +{{/if}} + + +What's happening here? + +a) **Continue implementation** - I'm still working on these stories +b) **Completed** - This work is done, starting something NEW +c) **Abandoned** - Stopping this, starting over +d) **Not sure** - Let me explain + +Your choice [a/b/c/d]: + + + Check if bmm-workflow-status.yaml exists + + + ✅ **You already have workflow tracking set up!** + +Your current status file: {{workflow_status_path}} + +You don't need workflow-init - you're already using the workflow system. + +**To check your progress:** + +- Load your current agent (PM, SM, Architect, etc.) +- Run: **/bmad:bmm:workflows:workflow-status** + +This will show you what to do next. + +Happy building! 🚀 +Exit workflow gracefully (workflow already initialized) + + + + You have work in progress but no workflow tracking. + +I'll create workflow tracking that recognizes your existing work. +Set migrating_legacy_project = true +Store found artifacts for workflow status generation +Continue to Step 5 (detect track from artifacts) + + + + + Archive the old work before starting fresh? (y/n) + Create archive folder + Move stories, sprint status, and planning docs to archive + {{#if archived}}✅ Old work archived{{else}}Clean slate! Ready for your new project.{{/if}} + Set new_project = true + Continue to Step 3 (ask about their work) + + + + Tell me more about your situation: + Analyze and guide to appropriate choice + + + + + I see you have an existing codebase: + +{{codebase_summary}} + +No BMM artifacts found - this project hasn't used BMad Method yet. + +Set field_type = "brownfield" +Set new_project = true +Note: Will need document-project before planning + + +💡 **Note for brownfield projects:** +You'll need to run **document-project** workflow before planning. +This analyzes your codebase and creates documentation that AI agents can use. + +I'll include this as a prerequisite in your workflow path. +Continue to Step 3 (ask about their work) + + + + I found some artifacts but the project state is unclear: + +{{list_found_artifacts}} + +Let me understand your situation. + +What are you trying to do? + +a) Continue working on an existing project +b) Start something completely NEW +c) Fix/enhance the existing code +d) Let me explain my situation + +Your choice: + +Analyze response carefully +Guide to appropriate state (Continue existing = Step 5, New = Step 3) + + + + + +Tell me about what you're working on. What's the goal? + +Store user_description + +Analyze description for field type: + +- Brownfield indicators: "existing", "current", "add to", "modify", "enhance", "refactor" +- Greenfield indicators: "new", "build", "create", "from scratch", "start" +- Codebase presence overrides: If found codebase = brownfield unless user says "scaffold" + + + I see you have existing code here. Are you: 1. **Adding to or modifying** the existing codebase (brownfield) @@ -202,189 +309,463 @@ Your choice [1/2/3]: -Build reasoning for suggestion -Store detected_indicators (keywords, scope indicators, complexity signals) +Set field_type based on codebase presence (codebase = brownfield, none = greenfield) -Based on what you've described, I'm suggesting **Level {{project_level}}** because: +Detect project_type (game vs software): -{{reasoning}} (detected: {{detected_indicators}}) - -Here's the complexity scale for reference: - -**{{field_type}} Project Levels:** - -- **Level 0** - Single atomic change (1 story) - bug fixes, typos, minor updates, single file changes -- **Level 1** - Small feature (1-10 stories) - simple additions, isolated features, one module -- **Level 2** - Medium feature set (5-15 stories) - dashboards, multiple related features, several modules -- **Level 3** - Complex integration (12-40 stories) - platform features, major integrations, architectural changes -- **Level 4** - Enterprise expansion (40+ stories) - multi-tenant, ecosystem changes, system-wide initiatives - -**My suggestion:** Level {{project_level}} {{field_type}} {{project_type}} project - - -Does this match what you're working on? (y/n or tell me what's different) - - - Use determined values - Go to Step 4 (Load workflow path) - - - - Update values based on corrections - Updated to: Level {{project_level}} {{field_type}} {{project_type}} - Does that look right now? (y/n) - If yes, go to Step 4. If no, ask what needs adjustment and repeat. - - -project_name -project_type -project_level -field_type - - - -Determine path file based on selections: - - - Load {path_files}/game-design.yaml - Set workflow_path_file = "game-design.yaml" - - - - - Build filename: {field_type}-level-{project_level}.yaml - Load {path_files}/{field_type}-level-{project_level}.yaml - Set workflow_path_file = constructed filename - - -Parse workflow path file to extract phases and workflows -workflow_path_file - - - -Parse the loaded workflow path file and extract all workflows - -For each phase in the path file: - -- Extract phase number and name -- Extract all workflows in that phase -- For each workflow, determine its status type: - - required: true → status = "required" - - recommended: true → status = "recommended" - - conditional: "if_has_ui" → status = "conditional" - - optional: true → status = "optional" - - Default if not specified → status = "required" - - -Build the workflow_items list in this format: - -For each phase: - -1. Add comment header: ` # Phase {n}: {Phase Name}` -2. For each workflow in phase: - - Add entry: ` {workflow-id}: {status}` -3. Add blank line between phases - -Example structure: - -``` - # Phase 1: Analysis - brainstorm-project: optional - research: optional - product-brief: recommended - - # Phase 2: Planning - prd: required - validate-prd: optional - create-design: conditional -``` - - - -Scan for existing workflow output files to auto-detect completion: - -For each workflow in the list, check common output locations: - -- {output_folder}/brainstorm-\*.md for brainstorm-project -- {output_folder}/research-\*.md for research -- {output_folder}/product-brief.md for product-brief -- {output_folder}/prd.md for prd -- {output_folder}/ux-design.md for create-design -- {output_folder}/architecture.md for create-architecture -- {output_folder}/tech-spec.md for tech-spec -- {output_folder}/sprint-status.yaml for sprint-planning - -CRITICAL: If file exists, replace status with ONLY the file path - nothing else. -Example: product-brief: docs/product-brief.md -NOT: product-brief: "completed - docs/product-brief.md" or any other text. - - -workflow_items - - - -Set generated date to current date -generated - -Prepare all template variables for workflow-status-template.yaml: - -- generated: {current_date} -- project_name: {project_name} -- project_type: {project_type} -- project_level: {project_level} -- field_type: {field_type} -- workflow_path_file: {workflow_path_file} -- workflow_items: {workflow_items from step 5} +- Game keywords: "game", "player", "level", "gameplay", "rpg", "fps", "puzzle game" +- Default to "software" if not clearly a game -Display a preview of what will be created: +user_description +field_type +project_type + -Show the first workflow in each phase and total count: + +Before we determine your planning approach, I want to offer some optional +workflows that can help you think through your project more deeply: -"Ready to create workflow status tracking: +Would you like to: -- Phase 1 ({phase_1_workflow_count} workflows): Starting with {first_workflow_phase_1} -- Phase 2 ({phase_2_workflow_count} workflows): Starting with {first_workflow_phase_2} -- Phase 3 ({phase_3_workflow_count} workflows): Starting with {first_workflow_phase_3} -- Phase 4 (Implementation tracked separately in sprint-status.yaml) +- 🧠 **Brainstorm** your project? (Creative exploration and idea generation) +- 🔍 **Research** your domain? (Technical research, competitive analysis, deep-dives) -{{#if detected_completed_workflows}} -Found existing work: -{{#each detected_files}} +These are completely OPTIONAL but can help clarify your vision before planning. + +Your choice: +a) Yes, brainstorm first +b) Yes, research first +c) Yes, both +d) No, I'm ready to plan + +Your choice [a/b/c/d]: + + + Set brainstorm_requested = true + Set research_requested = false + + + + Set brainstorm_requested = false + Set research_requested = true + + + + Set brainstorm_requested = true + Set research_requested = true + + + + Set brainstorm_requested = false + Set research_requested = false + + +brainstorm_requested +research_requested + + + + + + Detect track from existing artifacts: + +**Track Detection Logic:** + +- Has PRD + Architecture → BMad Method +- Has PRD only → BMad Method (architecture was optional/skipped) +- Has tech-spec only → BMad Quick Flow +- Has Security/DevOps docs → BMad Enterprise Method + + + Based on your existing planning documents, I've detected you're using: + +**{{detected_track_name}}** + +{{#if found_artifacts_list}} +Found completed workflows: +{{#each found_artifacts_list}} - {{workflow_name}}: {{file_path}} {{/each}} - {{/if}}" + {{/if}} + +I'll create workflow tracking that matches your existing approach and +automatically marks these completed workflows as done. + +Does this look right? (y/n) + +Which track should I use instead? + +1. BMad Quick Flow +2. BMad Method +3. BMad Enterprise Method + +Your choice: + +Update selected_track based on choice +Store selected_track +selected_track + +Continue to Step 6 (product brief question if applicable) + + + + Now, let me explain your planning options. + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🚀 **BMad Quick Flow** - Fast Implementation Path + +⏱️ **Time:** Hours to 1 day of planning +📝 **Approach:** Tech-spec focused - just enough detail to start coding +✅ **Best for:** Simple features, bug fixes, scope is crystal clear +⚠️ **Trade-off:** Less upfront planning = higher risk of rework if complexity emerges +🤖 **Agent Support:** Basic - AI will have minimal context + +**Example:** "Fix login bug" or "Add export button" + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🎯 **BMad Method** - Full Product Planning (RECOMMENDED) + +⏱️ **Time:** 1-3 days of planning +📝 **Approach:** PRD + UX + Architecture - complete product and system design +✅ **Best for:** + +- **GREENFIELD:** Products, platforms, multi-feature initiatives +- **BROWNFIELD:** Complex additions (new UIs + APIs, major refactors, new modules) + +✅ **Benefits:** + +- AI agents have COMPLETE context for better code generation +- Architecture distills massive codebases into focused solution design +- Prevents architectural drift and ensures consistency +- Fewer surprises and less rework during implementation +- Faster overall delivery (planning investment pays off!) +- Better code quality and maintainability + +🤖 **Agent Support:** Exceptional - AI becomes a true coding partner with full context + +{{#if brownfield}} +💡 **Why Architecture for Brownfield?** +Your brownfield documentation might be huge (thousands of lines). The Architecture +workflow takes all that context and creates a SUCCINCT solution design specific to +YOUR project. This keeps AI agents focused on YOUR changes without getting lost +in the existing codebase details. +{{/if}} + +**Example:** "User dashboard with analytics" or "Payment integration system" +or "Add real-time collaboration to existing editor" + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🏢 **BMad Enterprise Method** - Extended Enterprise Planning + +⏱️ **Time:** 3-7 days of planning +📝 **Approach:** BMad Method + Security Architecture + DevOps + Test Strategy +✅ **Best for:** Enterprise requirements, compliance, multi-tenant, mission-critical +✅ **Benefits:** All of BMad Method PLUS specialized planning for: + +- Security architecture and threat modeling +- DevOps pipeline and infrastructure planning +- Comprehensive test strategy +- Compliance and audit requirements + +🤖 **Agent Support:** Elite - comprehensive planning for complex enterprise systems + +**Example:** "Multi-tenant SaaS platform" or "HIPAA-compliant patient portal" +or "Add SOC2-compliant audit logging to enterprise app" + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +Generate recommendation based on user_description and field_type: + +**Recommendation Logic:** + +- Complexity keywords (dashboard, platform, system, integration, multiple features) → Recommend BMad Method +- Simple keywords (fix, bug, add button, simple) → Mention Quick Flow as option +- Enterprise keywords (multi-tenant, compliance, security, audit) → Recommend Enterprise +- Brownfield + complex → Strongly recommend Method (explain architecture benefit) +- Greenfield + complex → Recommend Method -Ready to create your workflow status file? (y/n) + + +💡 **My Honest Recommendation:** + +{{recommendation_with_reasoning}} + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +Which approach fits your situation? + +1. **BMad Quick Flow** - Fast, minimal planning (I accept rework risk) +2. **BMad Method** - Full planning for better AI results (RECOMMENDED) +3. **BMad Enterprise Method** - Extended planning for enterprise needs +4. **I'm not sure** - Help me decide + +Your choice [1/2/3/4]: + + + Tell me more about your concerns or uncertainties: + Provide tailored guidance based on their specific concerns + Present choices again with more specific recommendation + + +Map choice to track name: + +- 1 → "quick-flow" +- 2 → "method" +- 3 → "enterprise" + + +Store selected_track +selected_track + + + + + + + + Skip this step - product brief not applicable for brownfield or quick flow + Set product_brief_requested = false + Continue to Step 7 (generate workflow path) + + + + One more optional workflow for greenfield projects: + +📋 **Product Brief** - Strategic product planning document + +This is OPTIONAL but recommended for greenfield BMad Method projects. +It helps you articulate: + +- Product vision and unique value proposition +- Target users and their needs +- Success criteria and goals +- Market positioning and strategy + +This comes BEFORE your PRD and helps inform it with strategic thinking. + +Would you like to include Product Brief in your workflow? + +a) Yes, include Product Brief +b) No, skip to PRD + +Your choice [a/b]: + + + Set product_brief_requested = true + + + + Set product_brief_requested = false + + +product_brief_requested + + + + + + +Determine path file based on selected track and field type: + +**Path File Mapping:** + +- quick-flow + greenfield → "quick-flow-greenfield.yaml" +- quick-flow + brownfield → "quick-flow-brownfield.yaml" +- method + greenfield → "method-greenfield.yaml" +- method + brownfield → "method-brownfield.yaml" +- enterprise + greenfield → "enterprise-greenfield.yaml" +- enterprise + brownfield → "enterprise-brownfield.yaml" +- game → "game-design.yaml" + + +Load {path_files}/{determined_path_file} +Parse workflow path file to extract phases and workflows + +Build workflow_items list: + +For each phase in path file: + +1. Check if phase should be included based on: + - User choices (brainstorm_requested, research_requested, product_brief_requested) + - Phase conditions (prerequisite phases, optional phases) +2. Add comment header: ` # Phase {n}: {Phase Name}` +3. For each workflow in phase: + - Check if workflow should be included based on user choices + - Add entry: ` {workflow-id}: {default_status}` + - Default status from path file (required/optional/recommended/conditional) +4. Add blank line between phases + + +Scan for existing completed workflows and update workflow_items: + +**Scan locations:** + +- Brainstorm: {output_folder}/brainstorm\*.md +- Research: {output_folder}/research\*.md +- Product Brief: {output*folder}/\_brief*.md +- PRD: {output*folder}/\_prd*.md or {output*folder}/\_prd*/index.md +- Tech-spec: {output*folder}/\_tech-spec*.md or {output*folder}/\_spec*.md +- Epics: {output*folder}/\_epic*.md or {output*folder}/\_epic*/index.md +- UX Design: {output*folder}/\_ux*.md or {output*folder}/\_design*.md +- Architecture: {output*folder}/\_architecture*.md or {output*folder}/\_arch*.md +- Sprint Planning: {output*folder}/\_sprint*.yaml + +**CRITICAL:** If file exists, replace workflow status with ONLY the file path. +Example: `prd: docs/prd.md` (NOT "completed - docs/prd.md") + + +workflow_path_file +workflow_items + + + + + +Set generated date to current date +generated + +Perfect! Here's your personalized BMad workflow path: + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +**Track:** {{selected_track_display_name}} +**Field Type:** {{field_type}} +**Project:** {{project_name}} + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +{{#if brownfield AND needs_documentation}} +🔧 **Prerequisites:** +✅ document-project - Create comprehensive codebase documentation +(Required before planning workflows) +{{/if}} + +{{#if has_discovery_phase}} +🧠 **Phase 0: Discovery** (Optional - based on your choices) +{{#if brainstorm_requested}} +✅ Brainstorm - Creative exploration session +{{/if}} +{{#if research_requested}} +✅ Research - Domain and technical research +{{/if}} +{{#if product_brief_requested}} +✅ Product Brief - Strategic product planning +{{/if}} +{{/if}} + +{{#if selected_track == quick-flow}} +📝 **Phase 1: Planning** +✅ Tech-Spec - Implementation-focused specification +(Auto-detects epic structure if 2+ stories) + +🚀 **Phase 2: Implementation** +✅ Sprint Planning - Create sprint tracking +✅ Story Development - Implement story-by-story +{{/if}} + +{{#if selected_track in [method, enterprise]}} +📋 **Phase 1: Planning** +✅ PRD - Product Requirements Document +✅ Validate PRD (optional quality check) +✅ UX Design (if UI components - determined after PRD) + +🏗️ **Phase 2: Solutioning** +{{#if brownfield}} +✅ Architecture - Integration design (RECOMMENDED for brownfield) +Creates focused solution design from your existing codebase context +{{else}} +✅ Architecture - System design document +{{/if}} +✅ Validate Architecture (optional quality check) +✅ Solutioning Gate Check - Validate all planning aligns before coding + +🚀 **Phase 3: Implementation** +✅ Sprint Planning - Create sprint tracking +✅ Story Development - Implement story-by-story with epic-tech-specs +{{/if}} + +{{#if selected_track == enterprise}} + +🏢 **Additional Enterprise Planning:** +✅ Security Architecture - Threat modeling and security design +✅ DevOps Strategy - Pipeline and infrastructure planning +✅ Test Strategy - Comprehensive testing approach +{{/if}} + +{{#if found_existing_artifacts}} +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +📁 **Existing Work Detected:** + +I found these completed workflows and will mark them as done: +{{#each completed_workflows}} +✅ {{workflow_name}}: {{file_path}} +{{/each}} + +Your workflow tracking will start from where you left off! + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +{{/if}} + +Ready to create your workflow tracking file? (y/n) - Generate YAML from workflow-status-template.yaml with all variables - Save status file to {output_folder}/bmm-workflow-status.yaml + Prepare all template variables for workflow-status-template.yaml: + - generated: {current_date} + - project_name: {project_name} + - project_type: {project_type} + - selected_track: {selected_track} + - field_type: {field_type} + - workflow_path_file: {workflow_path_file} + - workflow_items: {workflow_items from step 7} + -Identify the first non-completed workflow in the list -Look up that workflow's agent and command from the path file +Generate YAML from workflow-status-template.yaml with all variables +Save status file to {output_folder}/bmm-workflow-status.yaml -✅ Workflow status file created at {output_folder}/bmm-workflow-status.yaml +Identify the first non-completed workflow in workflow_items +Look up that workflow's agent and command from the loaded path file -**Next Steps:** +✅ **Workflow tracking created:** {output_folder}/bmm-workflow-status.yaml -{{#if detected_completed_workflows}} -You have {{detected_count}} workflow(s) already completed. Great progress! +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +{{#if completed_workflows_found}} +🎉 Great news! I found {{completed_count}} workflow(s) already completed. {{/if}} **Next Workflow:** {{next_workflow_name}} - **Agent:** {{next_agent}} - **Command:** /bmad:bmm:workflows:{{next_workflow_id}} -{{#if next_agent !== 'pm'}} -It is recommended to start a new chat and load the {{next_agent}} agent before running the next workflow. +{{#if next_agent != 'analyst' AND next_agent != 'pm'}} +💡 **Tip:** Start a new chat and load the **{{next_agent}}** agent before running this workflow. {{/if}} - + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +Happy building with BMad Method! 🚀 + +**To check your progress anytime:** + +- Load any BMM agent +- Run: /bmad:bmm:workflows:workflow-status + + + + + No problem! You can run workflow-init again anytime you're ready. + +To get started later, just load the Analyst agent and run: +**/bmad:bmm:workflows:workflow-init** + diff --git a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml b/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml deleted file mode 100644 index 854365c4..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +++ /dev/null @@ -1,54 +0,0 @@ -# Brownfield Level 0 - Single Atomic Change in Existing Codebase -# One change to existing system - -project_type: "software" -level: 0 -field_type: "brownfield" -description: "Single atomic change to existing codebase" - -phases: - - prerequisite: true - name: "Documentation" - conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup" - workflows: - - id: "document-project" - required: true - agent: "analyst" - command: "document-project" - output: "Comprehensive project documentation" - purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4" - - - phase: 1 - name: "Analysis" - optional: true - workflows: - - id: "brainstorm-project" - optional: true - agent: "analyst" - command: "brainstorm-project" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "tech-spec" - required: true - agent: "architect" - command: "tech-spec" - output: "Creates single story file" - note: "Must understand existing patterns" - - - phase: 3 - name: "Solutioning" - skip: true - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml b/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml deleted file mode 100644 index 158c7a48..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +++ /dev/null @@ -1,76 +0,0 @@ -# Brownfield Level 2 - Medium Project in Existing Codebase -# 5-15 stories, multiple features added to existing system - -project_type: "software" -level: 2 -field_type: "brownfield" -description: "Medium project adding multiple features to existing codebase" - -phases: - - prerequisite: true - name: "Documentation" - conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup" - workflows: - - id: "document-project" - required: true - agent: "analyst" - command: "document-project" - output: "Comprehensive project documentation" - purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4" - - - phase: 1 - name: "Analysis" - optional: true - workflows: - - id: "brainstorm-project" - optional: true - agent: "analyst" - command: "brainstorm-project" - - id: "research" - optional: true - agent: "analyst" - command: "research" - - id: "product-brief" - optional: true - agent: "analyst" - command: "product-brief" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "prd" - recommended: true - agent: "pm" - command: "prd" - output: "Focused PRD for new features" - note: "Must consider existing system constraints" - - id: "validate-prd" - optional: true - agent: "pm" - command: "validate-prd" - - id: "tech-spec" - required: true - agent: "pm" - command: "tech-spec" - output: "Creates spec with multiple story files" - note: "Integrate with existing patterns" - - id: "create-design" - conditional: "if_has_ui" - agent: "ux-designer" - command: "create-design" - - - phase: 3 - name: "Solutioning" - skip: true - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml b/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml deleted file mode 100644 index 0922cb52..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +++ /dev/null @@ -1,88 +0,0 @@ -# Brownfield Level 4 - Enterprise Scale Changes to Existing System -# 40+ stories, major expansion of existing enterprise system - -project_type: "software" -level: 4 -field_type: "brownfield" -description: "Enterprise scale expansion of existing system" - -phases: - - prerequisite: true - name: "Documentation" - conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup. Critical for enterprise-scale changes" - workflows: - - id: "document-project" - required: true - agent: "analyst" - command: "document-project" - output: "Comprehensive project documentation" - purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4" - - - phase: 1 - name: "Analysis" - required: true - workflows: - - id: "brainstorm-project" - recommended: true - agent: "analyst" - command: "brainstorm-project" - - id: "research" - required: true - agent: "analyst" - command: "research" - note: "Research existing system architecture deeply" - - id: "product-brief" - required: true - agent: "analyst" - command: "product-brief" - note: "Strategic brief for major expansion" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "prd" - required: true - agent: "pm" - command: "prd" - output: "Comprehensive PRD considering existing system" - - id: "validate-prd" - optional: true - agent: "pm" - command: "validate-prd" - - id: "create-design" - required: true - agent: "ux-designer" - command: "create-design" - note: "Multiple UI/UX specifications" - - - phase: 3 - name: "Solutioning" - required: true - workflows: - - id: "create-architecture" - required: true - agent: "architect" - command: "create-architecture" - output: "Architecture for system expansion" - note: "Must maintain backward compatibility" - - id: "validate-architecture" - optional: true - agent: "architect" - command: "validate-architecture" - - id: "solutioning-gate-check" - required: true - agent: "architect" - command: "solutioning-gate-check" - note: "Critical validation before major changes" - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml new file mode 100644 index 00000000..7e4d0d73 --- /dev/null +++ b/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml @@ -0,0 +1,120 @@ +# BMad Enterprise Method - Brownfield +# Extended enterprise planning for complex brownfield with security/devops/test (30+ stories typically) + +method_name: "BMad Enterprise Method" +track: "enterprise" +field_type: "brownfield" +description: "Enterprise-grade planning for complex brownfield additions with extended requirements" + +phases: + - prerequisite: true + name: "Documentation" + conditional: "if_undocumented" + note: "NOT a phase - prerequisite for brownfield without docs (nearly mandatory for enterprise)" + workflows: + - id: "document-project" + required: true + agent: "analyst" + command: "document-project" + output: "Comprehensive project documentation" + purpose: "Understand existing codebase - critical for enterprise brownfield" + + - phase: 0 + name: "Discovery (Required)" + required: true + note: "Analysis phase required for enterprise projects" + workflows: + - id: "brainstorm-project" + optional: true + agent: "analyst" + command: "brainstorm-project" + included_by: "user_choice" + + - id: "research" + recommended: true + agent: "analyst" + command: "research" + included_by: "user_choice" + note: "Highly recommended - compliance, integration, risk research" + + - id: "product-brief" + optional: true + agent: "analyst" + command: "product-brief" + included_by: "user_choice" + note: "Optional for brownfield enterprise" + + - phase: 1 + name: "Planning" + required: true + workflows: + - id: "prd" + required: true + agent: "pm" + command: "prd" + output: "Enterprise PRD with compliance requirements" + note: "Must address existing system constraints and migration strategy" + + - id: "validate-prd" + recommended: true + agent: "pm" + command: "validate-prd" + + - id: "create-design" + recommended: true + agent: "ux-designer" + command: "create-design" + note: "Recommended - must integrate with existing UX patterns" + + - phase: 2 + name: "Solutioning" + required: true + workflows: + - id: "create-architecture" + required: true + agent: "architect" + command: "create-architecture" + output: "Integration architecture with enterprise considerations" + note: "Distills brownfield context + adds security/scalability/compliance design" + + - id: "create-security-architecture" + required: true + agent: "architect" + command: "create-security-architecture" + output: "Security architecture for brownfield integration" + note: "Future workflow - threat model, auth integration, audit requirements" + + - id: "create-devops-strategy" + required: true + agent: "architect" + command: "create-devops-strategy" + output: "DevOps strategy for brownfield deployment" + note: "Future workflow - CI/CD integration, deployment strategy, monitoring" + + - id: "create-test-strategy" + required: true + agent: "tea" + command: "create-test-strategy" + output: "Test strategy including regression testing" + note: "Future workflow - critical for brownfield to prevent breaking existing functionality" + + - id: "validate-architecture" + optional: true + agent: "architect" + command: "validate-architecture" + + - id: "solutioning-gate-check" + required: true + agent: "architect" + command: "solutioning-gate-check" + note: "Critical gate - validates all planning before touching production system" + + - phase: 3 + name: "Implementation" + required: true + workflows: + - id: "sprint-planning" + required: true + agent: "sm" + command: "sprint-planning" + note: "Enterprise brownfield requires careful phasing and feature flags" diff --git a/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml new file mode 100644 index 00000000..f5584d2c --- /dev/null +++ b/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml @@ -0,0 +1,108 @@ +# BMad Enterprise Method - Greenfield +# Extended enterprise planning with security/devops/test for greenfield (30+ stories typically) + +method_name: "BMad Enterprise Method" +track: "enterprise" +field_type: "greenfield" +description: "Complete enterprise-grade planning with security, devops, and test strategy" + +phases: + - phase: 0 + name: "Discovery (Required)" + required: true + note: "Analysis phase required for enterprise projects" + workflows: + - id: "brainstorm-project" + optional: true + agent: "analyst" + command: "brainstorm-project" + included_by: "user_choice" + + - id: "research" + recommended: true + agent: "analyst" + command: "research" + included_by: "user_choice" + note: "Highly recommended for enterprise - domain and compliance research" + + - id: "product-brief" + recommended: true + agent: "analyst" + command: "product-brief" + included_by: "user_choice" + note: "Recommended for strategic alignment" + + - phase: 1 + name: "Planning" + required: true + workflows: + - id: "prd" + required: true + agent: "pm" + command: "prd" + output: "Comprehensive Product Requirements Document" + note: "Enterprise-level requirements with compliance considerations" + + - id: "validate-prd" + recommended: true + agent: "pm" + command: "validate-prd" + + - id: "create-design" + recommended: true + agent: "ux-designer" + command: "create-design" + note: "Highly recommended for enterprise - design system and patterns" + + - phase: 2 + name: "Solutioning" + required: true + workflows: + - id: "create-architecture" + required: true + agent: "architect" + command: "create-architecture" + output: "Enterprise-grade system architecture" + note: "Includes scalability, multi-tenancy, integration architecture" + + - id: "create-security-architecture" + required: true + agent: "architect" + command: "create-security-architecture" + output: "Security architecture and threat model" + note: "Future workflow - security design, auth, compliance" + + - id: "create-devops-strategy" + required: true + agent: "architect" + command: "create-devops-strategy" + output: "DevOps pipeline and infrastructure plan" + note: "Future workflow - CI/CD, deployment, monitoring" + + - id: "create-test-strategy" + required: true + agent: "tea" + command: "create-test-strategy" + output: "Comprehensive test strategy" + note: "Future workflow - test approach, automation, quality gates" + + - id: "validate-architecture" + optional: true + agent: "architect" + command: "validate-architecture" + + - id: "solutioning-gate-check" + required: true + agent: "architect" + command: "solutioning-gate-check" + note: "Validates all planning artifacts align before implementation" + + - phase: 3 + name: "Implementation" + required: true + workflows: + - id: "sprint-planning" + required: true + agent: "sm" + command: "sprint-planning" + note: "Creates sprint plan - enterprise projects may require phased rollout" diff --git a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml b/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml deleted file mode 100644 index 22fdc077..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +++ /dev/null @@ -1,45 +0,0 @@ -# Greenfield Level 0 - Single Atomic Change -# The simplest possible workflow - one change, one story - -project_type: "software" -level: 0 -field_type: "greenfield" -description: "Single atomic change - bug fix, tiny feature, one story" - -phases: - - phase: 1 - name: "Analysis" - optional: true - workflows: - - id: "brainstorm-project" - optional: true - agent: "analyst" - command: "brainstorm-project" - - id: "product-brief" - optional: true - agent: "analyst" - command: "product-brief" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "tech-spec" - required: true - agent: "pm" - command: "tech-spec" - output: "Creates Technical Specification with single story file" - - - phase: 3 - name: "Solutioning" - skip: true - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml b/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml deleted file mode 100644 index 307bd42e..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +++ /dev/null @@ -1,73 +0,0 @@ -# Greenfield Level 3 - Complex System -# Subsystems, integrations, architectural decisions required - -project_type: "software" -level: 3 -field_type: "greenfield" -description: "Complex system - subsystems, integrations, architectural decisions" - -phases: - - phase: 1 - name: "Analysis" - optional: true - workflows: - - id: "brainstorm-project" - optional: true - agent: "analyst" - command: "brainstorm-project" - - id: "research" - optional: true - agent: "analyst" - command: "research" - note: "Multiple research areas likely" - - id: "product-brief" - recommended: true - agent: "analyst" - command: "product-brief" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "prd" - required: true - agent: "pm" - command: "prd" - output: "High-level requirements and epic definitions" - - id: "validate-prd" - optional: true - agent: "pm" - command: "validate-prd" - - id: "create-design" - conditional: "if_has_ui" - agent: "ux-designer" - command: "create-design" - - - phase: 3 - name: "Solutioning" - required: true - workflows: - - id: "create-architecture" - required: true - agent: "architect" - command: "create-architecture" - output: "System-wide architecture document" - - id: "validate-architecture" - optional: true - agent: "architect" - command: "validate-architecture" - - id: "solutioning-gate-check" - recommended: true - agent: "architect" - command: "solutioning-gate-check" - note: "Validate PRD + UX + architecture cohesion before implementation" - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml b/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml deleted file mode 100644 index 3bde6fee..00000000 --- a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +++ /dev/null @@ -1,75 +0,0 @@ -# Greenfield Level 4 - Enterprise Scale -# Multiple products, enterprise architecture, 40+ stories - -project_type: "software" -level: 4 -field_type: "greenfield" -description: "Enterprise scale - multiple products, enterprise architecture" - -phases: - - phase: 1 - name: "Analysis" - required: true - workflows: - - id: "brainstorm-project" - recommended: true - agent: "analyst" - command: "brainstorm-project" - - id: "research" - required: false - agent: "analyst" - command: "research" - note: "Extensive research across multiple domains" - - id: "product-brief" - required: true - agent: "analyst" - command: "product-brief" - note: "Strategic brief for enterprise scope" - - - phase: 2 - name: "Planning" - required: true - workflows: - - id: "prd" - required: true - agent: "pm" - command: "prd" - output: "Comprehensive product requirements document" - - id: "validate-prd" - optional: true - agent: "pm" - command: "validate-prd" - - id: "create-design" - required: true - agent: "ux-designer" - command: "create-design" - note: "Multiple UI/UX specifications needed" - - - phase: 3 - name: "Solutioning" - required: true - workflows: - - id: "create-architecture" - required: true - agent: "architect" - command: "create-architecture" - output: "Enterprise architecture documentation" - - id: "validate-architecture" - optional: true - agent: "architect" - command: "validate-architecture" - - id: "solutioning-gate-check" - required: true - agent: "architect" - command: "solutioning-gate-check" - note: "Validate PRD + UX + architecture cohesion before implementation" - - - phase: 4 - name: "Implementation" - required: true - workflows: - - id: "sprint-planning" - required: true - agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" diff --git a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml b/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml similarity index 59% rename from src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml rename to src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml index 7071b1c2..86a31c74 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml @@ -1,43 +1,49 @@ -# Brownfield Level 3 - Complex Integration with Existing System -# Major feature addition requiring architectural integration +# BMad Method - Brownfield +# Full product + architecture planning for complex brownfield additions (10-50+ stories typically) -project_type: "software" -level: 3 +method_name: "BMad Method" +track: "method" field_type: "brownfield" -description: "Complex integration with existing system architecture" +description: "Complete product and system design for complex brownfield work" phases: - prerequisite: true name: "Documentation" conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup" + note: "NOT a phase - prerequisite for brownfield without docs" workflows: - id: "document-project" required: true agent: "analyst" command: "document-project" output: "Comprehensive project documentation" - purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4" + purpose: "Understand existing codebase before planning" - - phase: 1 - name: "Analysis" - recommended: true + - phase: 0 + name: "Discovery (Optional)" + optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" optional: true agent: "analyst" command: "brainstorm-project" + included_by: "user_choice" + - id: "research" - recommended: true + optional: true agent: "analyst" command: "research" - note: "Research existing architecture patterns" + included_by: "user_choice" + - id: "product-brief" - recommended: true + optional: true agent: "analyst" command: "product-brief" + included_by: "user_choice" + note: "Optional for brownfield, less common than greenfield" - - phase: 2 + - phase: 1 name: "Planning" required: true workflows: @@ -45,46 +51,42 @@ phases: required: true agent: "pm" command: "prd" - output: "Requirements with integration points" + output: "PRD focused on new features/changes" + note: "Must consider existing system constraints" + - id: "validate-prd" optional: true agent: "pm" command: "validate-prd" + - id: "create-design" conditional: "if_has_ui" agent: "ux-designer" command: "create-design" - note: "Must align with existing UI patterns" - - phase: 3 + - phase: 2 name: "Solutioning" required: true workflows: - - id: "architecture-review" - required: true - agent: "architect" - command: "architecture-review" - note: "Review existing architecture first" - - id: "integration-planning" - required: true - agent: "architect" - command: "integration-planning" - output: "Integration strategy document" - id: "create-architecture" - required: true + recommended: true agent: "architect" command: "create-architecture" - note: "Extension of existing architecture" + output: "Integration architecture - solution design for THIS project" + note: "HIGHLY RECOMMENDED: Distills massive brownfield context into focused solution design. Prevents agent confusion." + - id: "validate-architecture" optional: true agent: "architect" command: "validate-architecture" + - id: "solutioning-gate-check" required: true agent: "architect" command: "solutioning-gate-check" + note: "Validates PRD + UX + Architecture (if created) cohesion" - - phase: 4 + - phase: 3 name: "Implementation" required: true workflows: @@ -92,4 +94,4 @@ phases: required: true agent: "sm" command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" + note: "Creates sprint plan with stories" diff --git a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml b/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml similarity index 56% rename from src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml rename to src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml index fbd5af70..88fe51ca 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml @@ -1,31 +1,38 @@ -# Greenfield Level 2 - Medium Project -# Multiple epics with 10+ stories total +# BMad Method - Greenfield +# Full product + architecture planning for greenfield projects (10-50+ stories typically) -project_type: "software" -level: 2 +method_name: "BMad Method" +track: "method" field_type: "greenfield" -description: "Medium project - multiple epics, 10+ stories" +description: "Complete product and system design methodology for greenfield projects" phases: - - phase: 1 - name: "Analysis" + - phase: 0 + name: "Discovery (Optional)" optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" optional: true agent: "analyst" command: "brainstorm-project" + included_by: "user_choice" + - id: "research" optional: true agent: "analyst" command: "research" - note: "Can have multiple research docs" + included_by: "user_choice" + note: "Can have multiple research workflows" + - id: "product-brief" - recommended: true + optional: true agent: "analyst" command: "product-brief" + included_by: "user_choice" + note: "Recommended for greenfield Method projects" - - phase: 2 + - phase: 1 name: "Planning" required: true workflows: @@ -33,22 +40,21 @@ phases: required: true agent: "pm" command: "prd" - output: "Creates PRD with epics.md and story list" + output: "Product Requirements Document with epics and stories" + - id: "validate-prd" optional: true agent: "pm" command: "validate-prd" + note: "Quality check for PRD completeness" + - id: "create-design" conditional: "if_has_ui" agent: "ux-designer" command: "create-design" - - id: "tech-spec" - optional: true - agent: "pm" - command: "tech-spec" - note: "Lightweight Technical Specification planning" + note: "Determined after PRD - user/agent decides if needed" - - phase: 3 + - phase: 2 name: "Solutioning" required: true workflows: @@ -56,18 +62,22 @@ phases: required: true agent: "architect" command: "create-architecture" - output: "System-wide architecture document" + output: "System architecture document" + note: "Complete system design for greenfield projects" + - id: "validate-architecture" optional: true agent: "architect" command: "validate-architecture" + note: "Quality check for architecture completeness" + - id: "solutioning-gate-check" required: true agent: "architect" command: "solutioning-gate-check" - note: "Validate PRD + UX + architecture cohesion before implementation" + note: "Validates PRD + UX + Architecture cohesion before implementation" - - phase: 4 + - phase: 3 name: "Implementation" required: true workflows: @@ -75,4 +85,4 @@ phases: required: true agent: "sm" command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" + note: "Creates sprint plan - subsequent work tracked there" diff --git a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml b/src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml similarity index 58% rename from src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml rename to src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml index a491d8a5..9ae390d3 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml @@ -1,38 +1,42 @@ -# Brownfield Level 1 - Small Feature in Existing Codebase -# 1-10 stories adding to existing system +# BMad Quick Flow - Brownfield +# Fast implementation path for existing codebases (1-15 stories typically) -project_type: "software" -level: 1 +method_name: "BMad Quick Flow" +track: "quick-flow" field_type: "brownfield" -description: "Small feature addition to existing codebase" +description: "Fast tech-spec based implementation for brownfield projects" phases: - prerequisite: true name: "Documentation" conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup" + note: "NOT a phase - prerequisite for brownfield without docs" workflows: - id: "document-project" required: true agent: "analyst" command: "document-project" output: "Comprehensive project documentation" - purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4" + purpose: "Understand existing codebase before planning" - - phase: 1 - name: "Analysis" + - phase: 0 + name: "Discovery (Optional)" optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" optional: true agent: "analyst" command: "brainstorm-project" + included_by: "user_choice" + - id: "research" optional: true agent: "analyst" command: "research" + included_by: "user_choice" - - phase: 2 + - phase: 1 name: "Planning" required: true workflows: @@ -40,14 +44,10 @@ phases: required: true agent: "pm" command: "tech-spec" - output: "Creates story files for feature" - note: "Must integrate with existing architecture" + output: "Technical Specification with stories (auto-detects epic if 2+ stories)" + note: "Integrates with existing codebase patterns from document-project" - - phase: 3 - name: "Solutioning" - skip: true - - - phase: 4 + - phase: 2 name: "Implementation" required: true workflows: @@ -55,4 +55,4 @@ phases: required: true agent: "sm" command: "sprint-planning" - note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status" + note: "Creates sprint plan with all stories" diff --git a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-1.yaml b/src/modules/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml similarity index 55% rename from src/modules/bmm/workflows/workflow-status/paths/greenfield-level-1.yaml rename to src/modules/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml index 5864f144..7926a4cc 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-1.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml @@ -1,30 +1,31 @@ -# Greenfield Level 1 - Small Feature -# Coherent feature with 2-3 stories in a single epic +# BMad Quick Flow - Greenfield +# Fast implementation path with tech-spec planning (1-15 stories typically) -project_type: "software" -level: 1 +method_name: "BMad Quick Flow" +track: "quick-flow" field_type: "greenfield" -description: "Small coherent feature - 2-3 stories, single epic" +description: "Fast tech-spec based implementation for greenfield projects" phases: - - phase: 1 - name: "Analysis" + - phase: 0 + name: "Discovery (Optional)" optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" optional: true agent: "analyst" command: "brainstorm-project" + included_by: "user_choice" + - id: "research" optional: true agent: "analyst" command: "research" - - id: "product-brief" - optional: true - agent: "analyst" - command: "product-brief" + included_by: "user_choice" + note: "Can have multiple research workflows" - - phase: 2 + - phase: 1 name: "Planning" required: true workflows: @@ -32,13 +33,10 @@ phases: required: true agent: "pm" command: "tech-spec" - output: "Creates Technical Specification with an epic and 2-3 story files" + output: "Technical Specification with stories (auto-detects epic if 2+ stories)" + note: "Quick Spec Flow - implementation-focused planning" - - phase: 3 - name: "Solutioning" - skip: true - - - phase: 4 + - phase: 2 name: "Implementation" required: true workflows: diff --git a/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml b/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml index d9ab4d69..209fc4c7 100644 --- a/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +++ b/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml @@ -1,11 +1,11 @@ # Workflow Status Template -# This tracks progress through phases 1-3 of the BMM methodology -# Phase 4 (Implementation) is tracked separately in sprint-status.yaml +# This tracks progress through BMM methodology phases +# Phase 3/4 (Implementation) is tracked separately in sprint-status.yaml # generated: {{generated}} # project: {{project_name}} # project_type: {{project_type}} -# project_level: {{project_level}} +# selected_track: {{selected_track}} # field_type: {{field_type}} # workflow_path: {{workflow_path_file}} @@ -24,7 +24,7 @@ generated: "{{generated}}" project: "{{project_name}}" project_type: "{{project_type}}" -project_level: "{{project_level}}" +selected_track: "{{selected_track}}" field_type: "{{field_type}}" workflow_path: "{{workflow_path_file}}"