bmad-method 6.0.0-alpha.9 → 6.0.1

package/src/modules/bmm/docs/workflows-planning.md

@@ -1,601 +0,0 @@
-# BMM Planning Workflows (Phase 2)
-
-**Reading Time:** ~10 minutes
-
-## Overview
-
-Phase 2 (Planning) workflows are **required** for all projects. They transform strategic vision into actionable requirements using a **scale-adaptive system** that automatically selects the right planning depth based on project complexity.
-
-**Key principle:** One unified entry point (`workflow-init`) intelligently routes to the appropriate planning methodology - from quick tech-specs to comprehensive PRDs.
-
-**When to use:** All projects require planning. The system adapts depth automatically based on complexity.
-
----
-
-## Phase 2 Planning Workflow Map
-
-```mermaid
-%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%%
-graph TB
-    Start["<b>START: workflow-init</b><br/>Discovery + routing"]
-
-    subgraph QuickFlow["<b>QUICK FLOW (Simple Planning)</b>"]
-        direction TB
-        TechSpec["<b>PM: tech-spec</b><br/>Technical document<br/>→ Story or Epic+Stories<br/>1-15 stories typically"]
-    end
-
-    subgraph BMadMethod["<b>BMAD METHOD (Recommended)</b>"]
-        direction TB
-        PRD["<b>PM: prd</b><br/>Strategic PRD"]
-        GDD["<b>Game Designer: gdd</b><br/>Game design doc"]
-        Narrative["<b>Game Designer: narrative</b><br/>Story-driven design"]
-
-        Epics["<b>PM: create-epics-and-stories</b><br/>Epic+Stories breakdown<br/>10-50+ stories typically"]
-
-        UXDesign["<b>UX Designer: ux</b><br/>Optional UX specification"]
-    end
-
-    subgraph Enterprise["<b>ENTERPRISE METHOD</b>"]
-        direction TB
-        EntNote["<b>Uses BMad Method Planning</b><br/>+<br/>Extended Phase 3 workflows<br/>(Architecture + Security + DevOps)<br/>30+ stories typically"]
-    end
-
-    subgraph Updates["<b>MID-STREAM UPDATES (Anytime)</b>"]
-        direction LR
-        CorrectCourse["<b>PM/SM: correct-course</b><br/>Update requirements/stories"]
-    end
-
-    Start -->|Bug fix, simple| QuickFlow
-    Start -->|Software product| PRD
-    Start -->|Game project| GDD
-    Start -->|Story-driven| Narrative
-    Start -->|Enterprise needs| Enterprise
-
-    PRD --> Epics
-    GDD --> Epics
-    Narrative --> Epics
-    Epics -.->|Optional| UXDesign
-    UXDesign -.->|May update| Epics
-
-    QuickFlow --> Phase4["<b>Phase 4: Implementation</b>"]
-    Epics --> Phase3["<b>Phase 3: Architecture</b>"]
-    Enterprise -.->|Uses BMad planning| Epics
-    Enterprise --> Phase3Ext["<b>Phase 3: Extended</b><br/>(Arch + Sec + DevOps)"]
-    Phase3 --> Phase4
-    Phase3Ext --> Phase4
-
-    Phase4 -.->|Significant changes| CorrectCourse
-    CorrectCourse -.->|Updates| Epics
-
-    style Start fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000
-    style QuickFlow fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000
-    style BMadMethod fill:#e1bee7,stroke:#6a1b9a,stroke-width:3px,color:#000
-    style Enterprise fill:#ffcdd2,stroke:#c62828,stroke-width:3px,color:#000
-    style Updates fill:#ffecb3,stroke:#ff6f00,stroke-width:3px,color:#000
-    style Phase3 fill:#90caf9,stroke:#0d47a1,stroke-width:2px,color:#000
-    style Phase4 fill:#ffcc80,stroke:#e65100,stroke-width:2px,color:#000
-
-    style TechSpec fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000
-    style PRD fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
-    style GDD fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
-    style Narrative fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
-    style UXDesign fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
-    style Epics fill:#ba68c8,stroke:#6a1b9a,stroke-width:3px,color:#000
-    style EntNote fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000
-    style Phase3Ext fill:#ef5350,stroke:#c62828,stroke-width:2px,color:#000
-    style CorrectCourse fill:#ffb74d,stroke:#ff6f00,stroke-width:2px,color:#000
-```
-
----
-
-## Quick Reference
-
-| Workflow                     | Agent         | Track       | Purpose                                    | Typical Stories |
-| ---------------------------- | ------------- | ----------- | ------------------------------------------ | --------------- |
-| **workflow-init**            | PM/Analyst    | All         | Entry point: discovery + routing           | N/A             |
-| **tech-spec**                | PM            | Quick Flow  | Technical document → Story or Epic+Stories | 1-15            |
-| **prd**                      | PM            | BMad Method | Strategic PRD                              | 10-50+          |
-| **gdd**                      | Game Designer | BMad Method | Game Design Document                       | 10-50+          |
-| **narrative**                | Game Designer | BMad Method | Story-driven game/experience design        | 10-50+          |
-| **create-epics-and-stories** | PM            | BMad Method | Break PRD/GDD into Epic+Stories            | N/A             |
-| **ux**                       | UX Designer   | BMad Method | Optional UX specification                  | N/A             |
-| **correct-course**           | PM/SM         | All         | Mid-stream requirement changes             | N/A             |
-
-**Note:** Story counts are guidance based on typical usage, not strict definitions.
-
----
-
-## Scale-Adaptive Planning System
-
-BMM uses three distinct planning tracks that adapt to project complexity:
-
-### Track 1: Quick Flow
-
-**Best For:** Bug fixes, simple features, clear scope, enhancements
-
-**Planning:** Tech-spec only → Implementation
-
-**Time:** Hours to 1 day
-
-**Story Count:** Typically 1-15 (guidance)
-
-**Documents:** tech-spec.md + story files
-
-**Example:** "Fix authentication bug", "Add OAuth social login"
-
----
-
-### Track 2: BMad Method (RECOMMENDED)
-
-**Best For:** Products, platforms, complex features, multiple epics
-
-**Planning:** PRD + Architecture → Implementation
-
-**Time:** 1-3 days
-
-**Story Count:** Typically 10-50+ (guidance)
-
-**Documents:** PRD.md (or GDD.md) + architecture.md + epic files + story files
-
-**Greenfield:** Product Brief (optional) → PRD → UX (optional) → Architecture → Implementation
-
-**Brownfield:** document-project → PRD → Architecture (recommended) → Implementation
-
-**Example:** "Customer dashboard", "E-commerce platform", "Add search to existing app"
-
-**Why Architecture for Brownfield?** Distills massive codebase context into focused solution design for your specific project.
-
----
-
-### Track 3: Enterprise Method
-
-**Best For:** Enterprise requirements, multi-tenant, compliance, security-sensitive
-
-**Planning (Phase 2):** Uses BMad Method planning (PRD + Epic+Stories)
-
-**Solutioning (Phase 3):** Extended workflows (Architecture + Security + DevOps + SecOps as optional additions)
-
-**Time:** 3-7 days total (1-3 days planning + 2-4 days extended solutioning)
-
-**Story Count:** Typically 30+ (but defined by enterprise needs)
-
-**Documents Phase 2:** PRD.md + epics + epic files + story files
-
-**Documents Phase 3:** architecture.md + security-architecture.md (optional) + devops-strategy.md (optional) + secops-strategy.md (optional)
-
-**Example:** "Multi-tenant SaaS", "HIPAA-compliant portal", "Add SOC2 audit logging"
-
----
-
-## How Track Selection Works
-
-`workflow-init` guides you through educational choice:
-
-1. **Description Analysis** - Analyzes project description for complexity
-2. **Educational Presentation** - Shows all three tracks with trade-offs
-3. **Recommendation** - Suggests track based on keywords and context
-4. **User Choice** - You select the track that fits
-
-The system guides but never forces. You can override recommendations.
-
----
-
-## Workflow Descriptions
-
-### workflow-init (Entry Point)
-
-**Purpose:** Single unified entry point for all planning. Discovers project needs and intelligently routes to appropriate track.
-
-**Agent:** PM (orchestrates others as needed)
-
-**Always Use:** This is your planning starting point. Don't call prd/gdd/tech-spec directly unless skipping discovery.
-
-**Process:**
-
-1. Discovery (understand context, assess complexity, identify concerns)
-2. Routing Decision (determine track, explain rationale, confirm)
-3. Execute Target Workflow (invoke planning workflow, pass context)
-4. Handoff (document decisions, recommend next phase)
-
----
-
-### tech-spec (Quick Flow)
-
-**Purpose:** Lightweight technical specification for simple changes (Quick Flow track). Produces technical document and story or epic+stories structure.
-
-**Agent:** PM
-
-**When to Use:**
-
-- Bug fixes
-- Single API endpoint additions
-- Configuration changes
-- Small UI component additions
-- Isolated validation rules
-
-**Key Outputs:**
-
-- **tech-spec.md** - Technical document containing:
-  - Problem statement and solution
-  - Source tree changes
-  - Implementation details
-  - Testing strategy
-  - Acceptance criteria
-- **Story file(s)** - Single story OR epic+stories structure (1-15 stories typically)
-
-**Skip To Phase:** 4 (Implementation) - no Phase 3 architecture needed
-
-**Example:** "Fix null pointer when user has no profile image" → Single file change, null check, unit test, no DB migration.
-
----
-
-### prd (Product Requirements Document)
-
-**Purpose:** Strategic PRD with epic breakdown for software products (BMad Method track).
-
-**Agent:** PM (with Architect and Analyst support)
-
-**When to Use:**
-
-- Medium to large feature sets
-- Multi-screen user experiences
-- Complex business logic
-- Multiple system integrations
-- Phased delivery required
-
-**Scale-Adaptive Structure:**
-
-- **Light:** Single epic, 5-10 stories, simplified analysis (10-15 pages)
-- **Standard:** 2-4 epics, 15-30 stories, comprehensive analysis (20-30 pages)
-- **Comprehensive:** 5+ epics, 30-50+ stories, multi-phase, extensive stakeholder analysis (30-50+ pages)
-
-**Key Outputs:**
-
-- PRD.md (complete requirements)
-- epics.md (epic breakdown)
-- Epic files (epic-1-_.md, epic-2-_.md, etc.)
-
-**Integration:** Feeds into Architecture (Phase 3)
-
-**Example:** E-commerce checkout → 3 epics (Guest Checkout, Payment Processing, Order Management), 21 stories, 4-6 week delivery.
-
----
-
-### gdd (Game Design Document)
-
-**Purpose:** Complete game design document for game projects (BMad Method track).
-
-**Agent:** Game Designer
-
-**When to Use:**
-
-- Designing any game (any genre)
-- Need comprehensive design documentation
-- Team needs shared vision
-- Publisher/stakeholder communication
-
-**BMM GDD vs Traditional:**
-
-- Scale-adaptive detail (not waterfall)
-- Agile epic structure
-- Direct handoff to implementation
-- Integrated with testing workflows
-
-**Key Outputs:**
-
-- GDD.md (complete game design)
-- Epic breakdown (Core Loop, Content, Progression, Polish)
-
-**Integration:** Feeds into Architecture (Phase 3)
-
-**Example:** Roguelike card game → Core concept (Slay the Spire meets Hades), 3 characters, 120 cards, 50 enemies, Epic breakdown with 26 stories.
-
----
-
-### narrative (Narrative Design)
-
-**Purpose:** Story-driven design workflow for games/experiences where narrative is central (BMad Method track).
-
-**Agent:** Game Designer (Narrative Designer persona) + Creative Problem Solver (CIS)
-
-**When to Use:**
-
-- Story is central to experience
-- Branching narrative with player choices
-- Character-driven games
-- Visual novels, adventure games, RPGs
-
-**Combine with GDD:**
-
-1. Run `narrative` first (story structure)
-2. Then run `gdd` (integrate story with gameplay)
-
-**Key Outputs:**
-
-- narrative-design.md (complete narrative spec)
-- Story structure (acts, beats, branching)
-- Characters (profiles, arcs, relationships)
-- Dialogue system design
-- Implementation guide
-
-**Integration:** Combine with GDD, then feeds into Architecture (Phase 3)
-
-**Example:** Choice-driven RPG → 3 acts, 12 chapters, 5 choice points, 3 endings, 60K words, 40 narrative scenes.
-
----
-
-### ux (UX-First Design)
-
-**Purpose:** UX specification for projects where user experience is the primary differentiator (BMad Method track).
-
-**Agent:** UX Designer
-
-**When to Use:**
-
-- UX is primary competitive advantage
-- Complex user workflows needing design thinking
-- Innovative interaction patterns
-- Design system creation
-- Accessibility-critical experiences
-
-**Collaborative Approach:**
-
-1. Visual exploration (generate multiple options)
-2. Informed decisions (evaluate with user needs)
-3. Collaborative design (refine iteratively)
-4. Living documentation (evolves with project)
-
-**Key Outputs:**
-
-- ux-spec.md (complete UX specification)
-- User journeys
-- Wireframes and mockups
-- Interaction specifications
-- Design system (components, patterns, tokens)
-- Epic breakdown (UX stories)
-
-**Integration:** Feeds PRD or updates epics, then Architecture (Phase 3)
-
-**Example:** Dashboard redesign → Card-based layout with split-pane toggle, 5 card components, 12 color tokens, responsive grid, 3 epics (Layout, Visualization, Accessibility).
-
----
-
-### create-epics-and-stories
-
-**Purpose:** Break PRD/GDD requirements into bite-sized stories organized in epics (BMad Method track).
-
-**Agent:** PM
-
-**When to Use:**
-
-- After PRD/GDD complete (often run automatically)
-- Can also run standalone later to re-generate epics/stories
-- When planning story breakdown outside main PRD workflow
-
-**Key Outputs:**
-
-- epics.md (all epics with story breakdown)
-- Epic files (epic-1-\*.md, etc.)
-
-**Note:** PRD workflow often creates epics automatically. This workflow can be run standalone if needed later.
-
----
-
-### correct-course
-
-**Purpose:** Handle significant requirement changes during implementation (all tracks).
-
-**Agent:** PM, Architect, or SM
-
-**When to Use:**
-
-- Priorities change mid-project
-- New requirements emerge
-- Scope adjustments needed
-- Technical blockers require replanning
-
-**Process:**
-
-1. Analyze impact of change
-2. Propose solutions (continue, pivot, pause)
-3. Update affected documents (PRD, epics, stories)
-4. Re-route for implementation
-
-**Integration:** Updates planning artifacts, may trigger architecture review
-
----
-
-## Decision Guide
-
-### Which Planning Workflow?
-
-**Use `workflow-init` (Recommended):** Let the system discover needs and route appropriately.
-
-**Direct Selection (Advanced):**
-
-- **Bug fix or single change** → `tech-spec` (Quick Flow)
-- **Software product** → `prd` (BMad Method)
-- **Game (gameplay-first)** → `gdd` (BMad Method)
-- **Game (story-first)** → `narrative` + `gdd` (BMad Method)
-- **UX innovation project** → `ux` + `prd` (BMad Method)
-- **Enterprise with compliance** → Choose track in `workflow-init` → Enterprise Method
-
----
-
-## Integration with Phase 3 (Solutioning)
-
-Planning outputs feed into Solutioning:
-
-| Planning Output     | Solutioning Input                    | Track Decision               |
-| ------------------- | ------------------------------------ | ---------------------------- |
-| tech-spec.md        | Skip Phase 3 → Phase 4 directly      | Quick Flow (no architecture) |
-| PRD.md              | **architecture** (Level 3-4)         | BMad Method (recommended)    |
-| GDD.md              | **architecture** (game tech)         | BMad Method (recommended)    |
-| narrative-design.md | **architecture** (narrative systems) | BMad Method                  |
-| ux-spec.md          | **architecture** (frontend design)   | BMad Method                  |
-| Enterprise docs     | **architecture** + security/ops      | Enterprise Method (required) |
-
-**Key Decision Points:**
-
-- **Quick Flow:** Skip Phase 3 entirely → Phase 4 (Implementation)
-- **BMad Method:** Optional Phase 3 (simple), Required Phase 3 (complex)
-- **Enterprise:** Required Phase 3 (architecture + extended planning)
-
-See: [workflows-solutioning.md](./workflows-solutioning.md)
-
----
-
-## Best Practices
-
-### 1. Always Start with workflow-init
-
-Let the entry point guide you. It prevents over-planning simple features or under-planning complex initiatives.
-
-### 2. Trust the Recommendation
-
-If `workflow-init` suggests BMad Method, there's likely complexity you haven't considered. Review carefully before overriding.
-
-### 3. Iterate on Requirements
-
-Planning documents are living. Refine PRDs/GDDs as you learn during Solutioning and Implementation.
-
-### 4. Involve Stakeholders Early
-
-Review PRDs/GDDs with stakeholders before Solutioning. Catch misalignment early.
-
-### 5. Focus on "What" Not "How"
-
-Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning).
-
-### 6. Document-Project First for Brownfield
-
-Always run `document-project` before planning brownfield projects. AI agents need existing codebase context.
-
----
-
-## Common Patterns
-
-### Greenfield Software (BMad Method)
-
-```
-1. (Optional) Analysis: product-brief, research
-2. workflow-init → routes to prd
-3. PM: prd workflow
-4. (Optional) UX Designer: ux workflow
-5. PM: create-epics-and-stories (may be automatic)
-6. → Phase 3: architecture
-```
-
-### Brownfield Software (BMad Method)
-
-```
-1. Technical Writer or Analyst: document-project
-2. workflow-init → routes to prd
-3. PM: prd workflow
-4. PM: create-epics-and-stories
-5. → Phase 3: architecture (recommended for focused solution design)
-```
-
-### Bug Fix (Quick Flow)
-
-```
-1. workflow-init → routes to tech-spec
-2. Architect: tech-spec workflow
-3. → Phase 4: Implementation (skip Phase 3)
-```
-
-### Game Project (BMad Method)
-
-```
-1. (Optional) Analysis: game-brief, research
-2. workflow-init → routes to gdd
-3. Game Designer: gdd workflow (or narrative + gdd if story-first)
-4. Game Designer creates epic breakdown
-5. → Phase 3: architecture (game systems)
-```
-
-### Enterprise Project (Enterprise Method)
-
-```
-1. (Recommended) Analysis: research (compliance, security)
-2. workflow-init → routes to Enterprise Method
-3. PM: prd workflow
-4. (Optional) UX Designer: ux workflow
-5. PM: create-epics-and-stories
-6. → Phase 3: architecture + security + devops + test strategy
-```
-
----
-
-## Common Anti-Patterns
-
-### ❌ Skipping Planning
-
-"We'll just start coding and figure it out."
-**Result:** Scope creep, rework, missed requirements
-
-### ❌ Over-Planning Simple Changes
-
-"Let me write a 20-page PRD for this button color change."
-**Result:** Wasted time, analysis paralysis
-
-### ❌ Planning Without Discovery
-
-"I already know what I want, skip the questions."
-**Result:** Solving wrong problem, missing opportunities
-
-### ❌ Treating PRD as Immutable
-
-"The PRD is locked, no changes allowed."
-**Result:** Ignoring new information, rigid planning
-
-### ✅ Correct Approach
-
-- Use scale-adaptive planning (right depth for complexity)
-- Involve stakeholders in review
-- Iterate as you learn
-- Keep planning docs living and updated
-- Use `correct-course` for significant changes
-
----
-
-## Related Documentation
-
-- [Phase 1: Analysis Workflows](./workflows-analysis.md) - Optional discovery phase
-- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) - Next phase
-- [Phase 4: Implementation Workflows](./workflows-implementation.md)
-- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding the three tracks
-- [Quick Spec Flow](./quick-spec-flow.md) - Quick Flow track details
-- [Agents Guide](./agents-guide.md) - Complete agent reference
-
----
-
-## Troubleshooting
-
-**Q: Which workflow should I run first?**
-A: Run `workflow-init`. It analyzes your project and routes to the right planning workflow.
-
-**Q: Do I always need a PRD?**
-A: No. Simple changes use `tech-spec` (Quick Flow). Only BMad Method and Enterprise tracks create PRDs.
-
-**Q: Can I skip Phase 3 (Solutioning)?**
-A: Yes for Quick Flow. Optional for BMad Method (simple projects). Required for BMad Method (complex projects) and Enterprise.
-
-**Q: How do I know which track to choose?**
-A: Use `workflow-init` - it recommends based on your description. Story counts are guidance, not definitions.
-
-**Q: What if requirements change mid-project?**
-A: Run `correct-course` workflow. It analyzes impact and updates planning artifacts.
-
-**Q: Do brownfield projects need architecture?**
-A: Recommended! Architecture distills massive codebase into focused solution design for your specific project.
-
-**Q: When do I run create-epics-and-stories?**
-A: Usually automatic during PRD/GDD. Can also run standalone later to regenerate epics.
-
-**Q: Should I use product-brief before PRD?**
-A: Optional but recommended for greenfield. Helps strategic thinking. `workflow-init` offers it based on context.
-
----
-
-_Phase 2 Planning - Scale-adaptive requirements for every project._