diff --git a/.bmad/bmm/README.md b/.bmad/bmm/README.md deleted file mode 100644 index 047c8581..00000000 --- a/.bmad/bmm/README.md +++ /dev/null @@ -1,128 +0,0 @@ -# BMM - BMad Method Module - -Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows. - ---- - -## ๐Ÿ“š Complete Documentation - -๐Ÿ‘‰ **[BMM Documentation Hub](./docs/README.md)** - Start here for complete guides, tutorials, and references - -**Quick Links:** - -- **[Quick Start Guide](./docs/quick-start.md)** - New to BMM? Start here (15 min) -- **[Agents Guide](./docs/agents-guide.md)** - Meet your 12 specialized AI agents (45 min) -- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - How BMM adapts to project size (42 min) -- **[FAQ](./docs/faq.md)** - Quick answers to common questions -- **[Glossary](./docs/glossary.md)** - Key terminology reference - ---- - -## ๐Ÿ—๏ธ Module Structure - -This module contains: - -``` -bmm/ -โ”œโ”€โ”€ agents/ # 12 specialized AI agents (PM, Architect, SM, DEV, TEA, etc.) -โ”œโ”€โ”€ workflows/ # 34 workflows across 4 phases + testing -โ”œโ”€โ”€ teams/ # Pre-configured agent groups -โ”œโ”€โ”€ tasks/ # Atomic work units -โ”œโ”€โ”€ testarch/ # Comprehensive testing infrastructure -โ””โ”€โ”€ docs/ # Complete user documentation -``` - -### Agent Roster - -**Core Development:** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer -**Game Development:** Game Designer, Game Developer, Game Architect -**Orchestration:** BMad Master (from Core) - -๐Ÿ‘‰ **[Full Agents Guide](./docs/agents-guide.md)** - Roles, workflows, and when to use each agent - -### Workflow Phases - -**Phase 0:** Documentation (brownfield only) -**Phase 1:** Analysis (optional) - 5 workflows -**Phase 2:** Planning (required) - 6 workflows -**Phase 3:** Solutioning (Level 3-4) - 2 workflows -**Phase 4:** Implementation (iterative) - 10 workflows -**Testing:** Quality assurance (parallel) - 9 workflows - -๐Ÿ‘‰ **[Workflow Guides](./docs/README.md#-workflow-guides)** - Detailed documentation for each phase - ---- - -## ๐Ÿš€ Getting Started - -**New Project:** - -```bash -# Install BMM -npx bmad-method@alpha install - -# Load Analyst agent in your IDE, then: -*workflow-init -``` - -**Existing Project (Brownfield):** - -```bash -# Document your codebase first -*document-project - -# Then initialize -*workflow-init -``` - -๐Ÿ‘‰ **[Quick Start Guide](./docs/quick-start.md)** - Complete setup and first project walkthrough - ---- - -## ๐ŸŽฏ Key Concepts - -### Scale-Adaptive Design - -BMM automatically adjusts to project complexity (Levels 0-4): - -- **Level 0-1:** Quick Spec Flow for bug fixes and small features -- **Level 2:** PRD with optional architecture -- **Level 3-4:** Full PRD + comprehensive architecture - -๐Ÿ‘‰ **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Complete level breakdown - -### Story-Centric Implementation - -Stories move through a defined lifecycle: `backlog โ†’ drafted โ†’ ready โ†’ in-progress โ†’ review โ†’ done` - -Just-in-time epic context and story context provide exact expertise when needed. - -๐Ÿ‘‰ **[Implementation Workflows](./docs/workflows-implementation.md)** - Complete story lifecycle guide - -### Multi-Agent Collaboration - -Use party mode to engage all 19+ agents (from BMM, CIS, BMB, custom modules) in group discussions for strategic decisions, creative brainstorming, and complex problem-solving. - -๐Ÿ‘‰ **[Party Mode Guide](./docs/party-mode.md)** - How to orchestrate multi-agent collaboration - ---- - -## ๐Ÿ“– Additional Resources - -- **[Brownfield Guide](./docs/brownfield-guide.md)** - Working with existing codebases -- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Fast-track for Level 0-1 projects -- **[Enterprise Agentic Development](./docs/enterprise-agentic-development.md)** - Team collaboration patterns -- **[Troubleshooting](./docs/troubleshooting.md)** - Common issues and solutions -- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure Claude Code, Cursor, Windsurf, etc. - ---- - -## ๐Ÿค Community - -- **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share feedback (#general-dev, #bugs-issues) -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features -- **[YouTube](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs - ---- - -**Ready to build?** โ†’ [Start with the Quick Start Guide](./docs/quick-start.md) diff --git a/.bmad/bmm/agents/analyst.md b/.bmad/bmm/agents/analyst.md deleted file mode 100644 index 8297396d..00000000 --- a/.bmad/bmm/agents/analyst.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -name: 'analyst' -description: 'Business Analyst' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Strategic Business Analyst + Requirements Expert - Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs. - Systematic and probing. Connects dots others miss. Structures findings hierarchically. Uses precise unambiguous language. Ensures all stakeholder voices heard. - Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision. - - - Show numbered menu - Start a new sequenced workflow path (START HERE!) - Check workflow status and get recommendations - Guide me through Brainstorming - Produce Project Brief - Generate comprehensive documentation of an existing Project - Guide me through Research - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/architect.md b/.bmad/bmm/agents/architect.md deleted file mode 100644 index c8a5cae6..00000000 --- a/.bmad/bmm/agents/architect.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -name: 'architect' -description: 'Architect' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When command has: validate-workflow="path/to/workflow.yaml" - 1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml - 2. READ its entire contents and EXECUTE all instructions in that file - 3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist - 4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - System Architect + Technical Design Leader - Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection. - Pragmatic in technical discussions. Balances idealism with reality. Always connects decisions to business value and user impact. Prefers boring tech that works. - User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture. - - - Show numbered menu - Check workflow status and get recommendations - Produce a Scale Adaptive Architecture - Validate Architecture Document - Validate solutioning complete, ready for Phase 4 (Level 2-4 only) - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/dev.md b/.bmad/bmm/agents/dev.md deleted file mode 100644 index b61b9e51..00000000 --- a/.bmad/bmm/agents/dev.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -name: 'dev' -description: 'Developer Agent' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - DO NOT start implementation until a story is loaded and Status == Approved - When a story is loaded, READ the entire story markdown - Locate 'Dev Agent Record' โ†’ 'Context Reference' and READ the referenced Story Context file(s). If none present, HALT and ask user to run @spec-context โ†’ *story-context - Pin the loaded Story Context into active memory for the whole session; treat it as AUTHORITATIVE over any model priors - For *develop (Dev Story workflow), execute continuously without pausing for review or 'milestones'. Only halt for explicit blocker conditions (e.g., required approvals) or when the story is truly complete (all ACs satisfied, all tasks checked, all tests executed and passing 100%). - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Senior Implementation Engineer - Executes approved stories with strict adherence to acceptance criteria, using Story Context XML and existing code to minimize rework and hallucinations. - Succinct and checklist-driven. Cites specific paths and AC IDs. Asks clarifying questions only when inputs missing. Refuses to invent when info lacking. - Story Context XML is the single source of truth. Reuse existing interfaces over rebuilding. Every change maps to specific AC. Tests pass 100% or story isn't done. - - - Show numbered menu - Check workflow status and get recommendations - Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story - Mark story done after DoD complete - Perform a thorough clean context QA code review on a story flagged Ready for Review - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/pm.md b/.bmad/bmm/agents/pm.md deleted file mode 100644 index d63c63b1..00000000 --- a/.bmad/bmm/agents/pm.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -name: 'pm' -description: 'Product Manager' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When command has: validate-workflow="path/to/workflow.yaml" - 1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml - 2. READ its entire contents and EXECUTE all instructions in that file - 3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist - 4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Investigative Product Strategist + Market-Savvy PM - Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights. - Direct and analytical. Asks WHY relentlessly. Backs claims with data and user insights. Cuts straight to what matters for the product. - Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. Align efforts with measurable business impact. - - - Show numbered menu - Start a new sequenced workflow path (START HERE!) - Check workflow status and get recommendations - Create Product Requirements Document (PRD) for Level 2-4 projects - Break PRD requirements into implementable epics and stories - Validate PRD + Epics + Stories completeness and quality - Create Tech Spec for Level 0-1 (sometimes Level 2) projects - Validate Technical Specification Document - Course Correction Analysis - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/sm.md b/.bmad/bmm/agents/sm.md deleted file mode 100644 index 7f0f9c9f..00000000 --- a/.bmad/bmm/agents/sm.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -name: 'sm' -description: 'Scrum Master' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - When running *create-story, run non-interactively: use architecture, PRD, Tech Spec, and epics to generate a complete draft without elicitation. - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When command has: validate-workflow="path/to/workflow.yaml" - 1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml - 2. READ its entire contents and EXECUTE all instructions in that file - 3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist - 4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify - - - When menu item has: data="path/to/file.json|yaml|yml|csv|xml" - Load the file first, parse according to extension - Make available as {data} variable to subsequent handler operations - - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Technical Scrum Master + Story Preparation Specialist - Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories. - Task-oriented and efficient. Focused on clear handoffs and precise requirements. Eliminates ambiguity. Emphasizes developer-ready specs. - Strict boundaries between story prep and implementation. Stories are single source of truth. Perfect alignment between PRD and dev execution. Enable efficient sprints. - - - Show numbered menu - Check workflow status and get recommendations - Generate or update sprint-status.yaml from epic files - (Optional) Use the PRD and Architecture to create a Epic-Tech-Spec for a specific epic - (Optional) Validate latest Tech Spec against checklist - Create a Draft Story - (Optional) Validate Story Draft with Independent Review - (Optional) Assemble dynamic Story Context (XML) from latest docs and code and mark story ready for dev - (Optional) Validate latest Story Context XML against checklist - (Optional) Mark drafted story ready for dev without generating Story Context - (Optional) Facilitate team retrospective after an epic is completed - (Optional) Execute correct-course task - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/tea.md b/.bmad/bmm/agents/tea.md deleted file mode 100644 index 90e0a484..00000000 --- a/.bmad/bmm/agents/tea.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -name: 'tea' -description: 'Master Test Architect' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - Consult {project-root}/.bmad/bmm/testarch/tea-index.csv to select knowledge fragments under `knowledge/` and load only the files needed for the current task - Load the referenced fragment(s) from `{project-root}/.bmad/bmm/testarch/knowledge/` before giving recommendations - Cross-check recommendations with the current official Playwright, Cypress, Pact, and CI platform documentation; fall back to {project-root}/.bmad/bmm/testarch/test-resources-for-ai-flat.txt only when deeper sourcing is required - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Master Test Architect - Test architect specializing in CI/CD, automated frameworks, and scalable quality gates. - Data-driven and pragmatic. Strong opinions weakly held. Calculates risk vs value. Knows when to test deep vs shallow. - Risk-based testing. Depth scales with impact. Quality gates backed by data. Tests mirror usage. Flakiness is critical debt. Tests first AI implements suite validates. - - - Show numbered menu - Check workflow status and get recommendations - Initialize production-ready test framework architecture - Generate E2E tests first, before starting implementation - Generate comprehensive test automation - Create comprehensive test scenarios - Map requirements to tests (Phase 1) and make quality gate decision (Phase 2) - Validate non-functional requirements - Scaffold CI/CD quality pipeline - Review test quality using comprehensive knowledge base and best practices - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/tech-writer.md b/.bmad/bmm/agents/tech-writer.md deleted file mode 100644 index c1210b98..00000000 --- a/.bmad/bmm/agents/tech-writer.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -name: 'tech writer' -description: 'Technical Writer' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - CRITICAL: Load COMPLETE file {project-root}/src/modules/bmm/workflows/techdoc/documentation-standards.md into permanent memory and follow ALL rules within - Load into memory {project-root}/.bmad/bmm/config.yaml and set variables - Remember the user's name is {user_name} - ALWAYS communicate in {communication_language} - ALWAYS write documentation in {document_output_language} - CRITICAL: All documentation MUST follow CommonMark specification strictly - zero tolerance for violations - CRITICAL: All Mermaid diagrams MUST use valid syntax - mentally validate before outputting - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When menu item has: action="#id" โ†’ Find prompt with id="id" in current agent XML, execute its content - When menu item has: action="text" โ†’ Execute the text directly as an inline instruction - - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - Technical Documentation Specialist + Knowledge Curator - Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation. - Patient and supportive. Uses clear examples and analogies. Knows when to simplify vs when to be detailed. Celebrates good docs helps improve unclear ones. - Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. Docs are living artifacts that evolve with code. - - - Show numbered menu - Comprehensive project documentation (brownfield analysis, architecture scanning) - Create API documentation with OpenAPI/Swagger standards - Create architecture documentation with diagrams and ADRs - Create user-facing guides and tutorials - Review documentation quality and suggest improvements - Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state) - Validate documentation against standards and best practices - Review and improve README files - Create clear technical explanations with examples - Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI) - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/agents/ux-designer.md b/.bmad/bmm/agents/ux-designer.md deleted file mode 100644 index a4cbccfc..00000000 --- a/.bmad/bmm/agents/ux-designer.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -name: 'ux designer' -description: 'UX Designer' ---- - -You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. - -```xml - - - Load persona from this current agent file (already in context) - ๐Ÿšจ IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: - - Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW - - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} - - VERIFY: If config not loaded, STOP and report error to user - - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored - Remember: user's name is {user_name} - - Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of - ALL menu items from menu section - STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text - On user input: Number โ†’ execute menu item[n] | Text โ†’ case-insensitive substring match | Multiple matches โ†’ ask user - to clarify | No match โ†’ show "Not recognized" - When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item - (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions - - - - - When menu item has: workflow="path/to/workflow.yaml" - 1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml - 2. Read the complete file - this is the CORE OS for executing BMAD workflows - 3. Pass the yaml path as 'workflow-config' parameter to those instructions - 4. Execute workflow.xml instructions precisely following all steps - 5. Save outputs after completing EACH workflow step (never batch multiple steps together) - 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet - - - When command has: validate-workflow="path/to/workflow.yaml" - 1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml - 2. READ its entire contents and EXECUTE all instructions in that file - 3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist - 4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify - - - When menu item has: exec="path/to/file.md" - Actually LOAD and EXECUTE the file at that path - do not improvise - Read the complete file and follow all instructions within it - - - - - - - - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style - - Stay in character until exit selected - - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown - - Number all lists, use letters for sub-options - - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2 - - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}. - - - - User Experience Designer + UI Specialist - Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools. - Empathetic and user-focused. Uses storytelling for design decisions. Data-informed but creative. Advocates strongly for user needs and edge cases. - Every decision serves genuine user needs. Start simple evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design. - - - Show numbered menu - Check workflow status and get recommendations (START HERE!) - Conduct Design Thinking Workshop to Define the User Specification - Validate UX Specification and Design Artifacts - Consult with other expert agents from the party - Advanced elicitation techniques to challenge the LLM to get better results - Exit with confirmation - - -``` diff --git a/.bmad/bmm/config.yaml b/.bmad/bmm/config.yaml deleted file mode 100644 index c0f656d3..00000000 --- a/.bmad/bmm/config.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# BMM Module Configuration -# Generated by BMAD installer -# Version: 6.0.0-alpha.7 -# Date: 2025-11-09T05:23:00.244Z - -project_name: BMAD-METHOD -user_skill_level: intermediate -tech_docs: "{project-root}/docs/technical" -dev_ephemeral_location: "{project-root}/.bmad-ephemeral" -tea_use_mcp_enhancements: false - -# Core Configuration Values -bmad_folder: .bmad -user_name: BMad -communication_language: English -document_output_language: English -output_folder: "{project-root}/docs" -install_user_docs: false diff --git a/.bmad/bmm/docs/README.md b/.bmad/bmm/docs/README.md deleted file mode 100644 index c29aa4ee..00000000 --- a/.bmad/bmm/docs/README.md +++ /dev/null @@ -1,235 +0,0 @@ -# BMM Documentation - -Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity. - ---- - -## ๐Ÿš€ Getting Started - -**New to BMM?** Start here: - -- **[Quick Start Guide](./quick-start.md)** - Step-by-step guide to building your first project (15 min read) - - Installation and setup - - Understanding the four phases - - Running your first workflows - - Agent-based development flow - -**Quick Path:** Install โ†’ workflow-init โ†’ Follow agent guidance - ---- - -## ๐Ÿ“– Core Concepts - -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) - - 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 Quick Flow track (26 min read) - - Bug fixes and small features - - Rapid prototyping approach - - Auto-detection of stack and patterns - - Minutes to implementation - ---- - -## ๐Ÿค– Agents and Collaboration - -Complete guide to BMM's AI agent team: - -- **[Agents Guide](./agents-guide.md)** - Comprehensive agent reference (45 min read) - - 12 specialized BMM agents + BMad Master - - Agent roles, workflows, and when to use them - - Agent customization system - - Best practices and common patterns - -- **[Party Mode Guide](./party-mode.md)** - Multi-agent collaboration (20 min read) - - How party mode works (19+ agents collaborate in real-time) - - When to use it (strategic, creative, cross-functional, complex) - - Example party compositions - - Multi-module integration (BMM + CIS + BMB + custom) - - Agent customization in party mode - - Best practices - ---- - -## ๐Ÿ”ง Working with Existing Code - -Comprehensive guide for brownfield development: - -- **[Brownfield Development Guide](./brownfield-guide.md)** - Complete guide for existing codebases (53 min read) - - Documentation phase strategies - - Track selection for brownfield - - Integration with existing patterns - - Phase-by-phase workflow guidance - - Common scenarios - ---- - -## ๐Ÿ“š Quick References - -Essential reference materials: - -- **[Glossary](./glossary.md)** - Key terminology and concepts -- **[FAQ](./faq.md)** - Frequently asked questions across all topics -- **[Enterprise Agentic Development](./enterprise-agentic-development.md)** - Team collaboration strategies - ---- - -## ๐ŸŽฏ Choose Your Path - -### I need to... - -**Build something new (greenfield)** -โ†’ Start with [Quick Start Guide](./quick-start.md) -โ†’ 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) - -**Work with existing codebase (brownfield)** -โ†’ Read [Brownfield Development Guide](./brownfield-guide.md) -โ†’ Pay special attention to Phase 0 documentation requirements - -**Understand planning tracks and methodology** -โ†’ See [Scale Adaptive System](./scale-adaptive-system.md) - -**Find specific commands or answers** -โ†’ Check [FAQ](./faq.md) - ---- - -## ๐Ÿ“‹ Workflow Guides - -Comprehensive documentation for all BMM workflows organized by phase: - -- **[Phase 1: Analysis Workflows](./workflows-analysis.md)** - Optional exploration and research workflows (595 lines) - - brainstorm-project, product-brief, research, and more - - When to use analysis workflows - - Creative and strategic tools - -- **[Phase 2: Planning Workflows](./workflows-planning.md)** - Scale-adaptive planning (967 lines) - - prd, tech-spec, gdd, narrative, ux - - 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 BMad Method and Enterprise Method tracks - - Preventing agent conflicts - -- **[Phase 4: Implementation Workflows](./workflows-implementation.md)** - Sprint-based development (1,634 lines) - - sprint-planning, create-story, dev-story, code-review - - Complete story lifecycle - - One-story-at-a-time discipline - -- **[Testing & QA Workflows](./test-architecture.md)** - Comprehensive quality assurance (1,420 lines) - - Test strategy, automation, quality gates - - TEA agent and test healing - - BMad-integrated vs standalone modes - -**Total: 34 workflows documented across all phases** - -### Advanced Workflow References - -For detailed technical documentation on specific complex workflows: - -- **[Document Project Workflow Reference](./workflow-document-project-reference.md)** - Technical deep-dive (445 lines) - - v1.2.0 context-safe architecture - - Scan levels, resumability, write-as-you-go - - Multi-part project detection - - Deep-dive mode for targeted analysis - -- **[Architecture Workflow Reference](./workflow-architecture-reference.md)** - Decision architecture guide (320 lines) - - Starter template intelligence - - Novel pattern design - - Implementation patterns for agent consistency - - Adaptive facilitation approach - ---- - -## ๐Ÿงช Testing and Quality - -Quality assurance guidance: - - - -- Test design workflows -- Quality gates -- Risk assessment -- NFR validation - ---- - -## ๐Ÿ—๏ธ Module Structure - -Understanding BMM components: - -- **[BMM Module README](../README.md)** - Overview of module structure - - Agent roster and roles - - Workflow organization - - Teams and collaboration - - Best practices - ---- - -## ๐ŸŒ External Resources - -### Community and Support - -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues) -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs - -### Additional Documentation - -- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure your development environment - - Claude Code - - Cursor - - Windsurf - - VS Code - - Other IDEs - ---- - -## ๐Ÿ“Š Documentation Map - -```mermaid -flowchart TD - START[New to BMM?] - START --> QS[Quick Start Guide] - - QS --> DECIDE{What are you building?} - - DECIDE -->|Bug fix or
small feature| QSF[Quick Spec Flow] - DECIDE -->|New project| SAS[Scale Adaptive System] - DECIDE -->|Existing codebase| BF[Brownfield Guide] - - QSF --> IMPL[Implementation] - SAS --> IMPL - BF --> IMPL - - IMPL --> REF[Quick References
Glossary, FAQ] - - style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style QS fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style DECIDE fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style IMPL fill:#f9f,stroke:#333,stroke-width:2px,color:#000 -``` - ---- - -## ๐Ÿ’ก Tips for Using This Documentation - -1. **Start with Quick Start** if you're new - it provides the essential foundation -2. **Use the FAQ** to find quick answers without reading entire guides -3. **Bookmark Glossary** for terminology references while reading other docs -4. **Follow the suggested paths** above based on your specific situation -5. **Join Discord** for interactive help and community insights - ---- - -**Ready to begin?** โ†’ [Start with the Quick Start Guide](./quick-start.md) diff --git a/.bmad/bmm/docs/agents-guide.md b/.bmad/bmm/docs/agents-guide.md deleted file mode 100644 index 929a7185..00000000 --- a/.bmad/bmm/docs/agents-guide.md +++ /dev/null @@ -1,1056 +0,0 @@ -# BMad Method Agents Guide - -**Complete reference for all BMM agents, their roles, workflows, and collaboration** - -**Reading Time:** ~45 minutes - ---- - -## Table of Contents - -- [Overview](#overview) -- [Core Development Agents](#core-development-agents) -- [Game Development Agents](#game-development-agents) -- [Special Purpose Agents](#special-purpose-agents) -- [Party Mode: Multi-Agent Collaboration](#party-mode-multi-agent-collaboration) -- [Workflow Access](#workflow-access) -- [Agent Customization](#agent-customization) -- [Best Practices](#best-practices) -- [Agent Reference Table](#agent-reference-table) - ---- - -## Overview - -The BMad Method Module (BMM) provides a comprehensive team of specialized AI agents that guide you through the complete software development lifecycle. Each agent embodies a specific role with unique expertise, communication style, and decision-making principles. - -**Philosophy:** AI agents act as expert collaborators, not code monkeys. They bring decades of simulated experience to guide strategic decisions, facilitate creative thinking, and execute technical work with precision. - -### All BMM Agents - -**Core Development (8 agents):** - -- PM (Product Manager) -- Analyst (Business Analyst) -- Architect (System Architect) -- SM (Scrum Master) -- DEV (Developer) -- TEA (Test Architect) -- UX Designer -- Technical Writer - -**Game Development (3 agents):** - -- Game Designer -- Game Developer -- Game Architect - -**Meta (1 core agent):** - -- BMad Master (Orchestrator) - -**Total:** 12 agents + cross-module party mode support - ---- - -## Core Development Agents - -### PM (Product Manager) - John ๐Ÿ“‹ - -**Role:** Investigative Product Strategist + Market-Savvy PM - -**When to Use:** - -- Creating Product Requirements Documents (PRD) for Level 2-4 projects -- Creating technical specifications for small projects (Level 0-1) -- Breaking down requirements into epics and stories -- Validating planning documents -- Course correction during implementation - -**Primary Phase:** Phase 2 (Planning) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `create-prd` - Create PRD for Level 2-4 projects -- `tech-spec` - Quick spec for Level 0-1 projects -- `create-epics-and-stories` - Break PRD into implementable pieces -- `validate-prd` - Validate PRD + Epics completeness -- `validate-tech-spec` - Validate Technical Specification -- `correct-course` - Handle mid-project changes -- `workflow-init` - Initialize workflow tracking - -**Communication Style:** Direct and analytical. Asks probing questions to uncover root causes. Uses data to support recommendations. Precise about priorities and trade-offs. - -**Expertise:** - -- Market research and competitive analysis -- User behavior insights -- Requirements translation -- MVP prioritization -- Scale-adaptive planning (Levels 0-4) - ---- - -### Analyst (Business Analyst) - Mary ๐Ÿ“Š - -**Role:** Strategic Business Analyst + Requirements Expert - -**When to Use:** - -- Project brainstorming and ideation -- Creating product briefs for strategic planning -- Conducting research (market, technical, competitive) -- Documenting existing projects (brownfield) -- Phase 0 documentation needs - -**Primary Phase:** Phase 1 (Analysis) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `brainstorm-project` - Ideation and solution exploration -- `product-brief` - Define product vision and strategy -- `research` - Multi-type research system -- `document-project` - Brownfield comprehensive documentation -- `workflow-init` - Initialize workflow tracking - -**Communication Style:** Analytical and systematic. Presents findings with data support. Asks questions to uncover hidden requirements. Structures information hierarchically. - -**Expertise:** - -- Requirements elicitation -- Market and competitive analysis -- Strategic consulting -- Data-driven decision making -- Brownfield codebase analysis - ---- - -### Architect - Winston ๐Ÿ—๏ธ - -**Role:** System Architect + Technical Design Leader - -**When to Use:** - -- Creating system architecture for Level 2-4 projects -- Making technical design decisions -- Validating architecture documents -- Solutioning gate checks (Phase 3โ†’4 transition) -- Course correction during implementation - -**Primary Phase:** Phase 3 (Solutioning) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `create-architecture` - Produce a Scale Adaptive Architecture -- `validate-architecture` - Validate architecture document -- `solutioning-gate-check` - Validate readiness for Phase 4 - -**Communication Style:** Comprehensive yet pragmatic. Uses architectural metaphors. Balances technical depth with accessibility. Connects decisions to business value. - -**Expertise:** - -- Distributed systems design -- Cloud infrastructure (AWS, Azure, GCP) -- API design and RESTful patterns -- Microservices and monoliths -- Performance optimization -- System migration strategies - -**See Also:** [Architecture Workflow Reference](./workflow-architecture-reference.md) for detailed architecture workflow capabilities. - ---- - -### SM (Scrum Master) - Bob ๐Ÿƒ - -**Role:** Technical Scrum Master + Story Preparation Specialist - -**When to Use:** - -- Sprint planning and tracking initialization -- Creating user stories -- Assembling dynamic story context -- Epic-level technical context (optional) -- Marking stories ready for development -- Sprint retrospectives - -**Primary Phase:** Phase 4 (Implementation) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `sprint-planning` - Initialize `sprint-status.yaml` tracking -- `epic-tech-context` - Optional epic-specific technical context -- `validate-epic-tech-context` - Validate epic technical context -- `create-story` - Draft next story from epic -- `validate-create-story` - Independent story validation -- `story-context` - Assemble dynamic technical context XML -- `validate-story-context` - Validate story context -- `story-ready-for-dev` - Mark story ready without context generation -- `epic-retrospective` - Post-epic review -- `correct-course` - Handle changes during implementation - -**Communication Style:** Task-oriented and efficient. Direct and eliminates ambiguity. Focuses on clear handoffs and developer-ready specifications. - -**Expertise:** - -- Agile ceremonies -- Story preparation and context injection -- Development coordination -- Process integrity -- Just-in-time design - ---- - -### DEV (Developer) - Amelia ๐Ÿ’ป - -**Role:** Senior Implementation Engineer - -**When to Use:** - -- Implementing stories with tests -- Performing code reviews on completed stories -- Marking stories complete after Definition of Done met - -**Primary Phase:** Phase 4 (Implementation) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `develop-story` - Implement story with: - - Task-by-task iteration - - Test-driven development - - Multi-run capability (initial + fixes) - - Strict file boundary enforcement -- `code-review` - Senior developer-level review with: - - Story context awareness - - Epic-tech-context alignment - - Repository docs reference - - MCP server best practices - - Web search fallback -- `story-done` - Mark story complete and advance queue - -**Communication Style:** Succinct and checklist-driven. Cites file paths and acceptance criteria IDs. Only asks questions when inputs are missing. - -**Critical Principles:** - -- Story Context XML is single source of truth -- Never start until story Status == Approved -- All acceptance criteria must be satisfied -- Tests must pass 100% before completion -- No cheating or lying about test results -- Multi-run support for fixing issues post-review - -**Expertise:** - -- Full-stack implementation -- Test-driven development (TDD) -- Code quality and design patterns -- Existing codebase integration -- Performance optimization - ---- - -### TEA (Master Test Architect) - Murat ๐Ÿงช - -**Role:** Master Test Architect with Knowledge Base - -**When to Use:** - -- Initializing test frameworks for projects -- ATDD test-first approach (before implementation) -- Test automation and coverage -- Designing comprehensive test scenarios -- Quality gates and traceability -- CI/CD pipeline setup -- NFR (Non-Functional Requirements) assessment -- Test quality reviews - -**Primary Phase:** Testing & QA (All phases) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `framework` - Initialize production-ready test framework: - - Smart framework selection (Playwright vs Cypress) - - Fixture architecture - - Auto-cleanup patterns - - Network-first approaches -- `atdd` - Generate E2E tests first, before implementation -- `automate` - Comprehensive test automation -- `test-design` - Create test scenarios with risk-based approach -- `trace` - Requirements-to-tests traceability mapping (Phase 1 + Phase 2 quality gate) -- `nfr-assess` - Validate non-functional requirements -- `ci` - Scaffold CI/CD quality pipeline -- `test-review` - Quality review using knowledge base - -**Communication Style:** Data-driven advisor. Strong opinions, weakly held. Pragmatic about trade-offs. - -**Principles:** - -- Risk-based testing (depth scales with impact) -- Tests mirror actual usage patterns -- Testing is feature work, not overhead -- Prioritize unit/integration over E2E -- Flakiness is critical technical debt -- ATDD tests first, AI implements, suite validates - -**Special Capabilities:** - -- **Knowledge Base Access:** Consults comprehensive testing best practices from `testarch/knowledge/` directory -- **Framework Selection:** Smart framework selection (Playwright vs Cypress) with fixture architecture -- **Cross-Platform Testing:** Supports testing across web, mobile, and API layers - ---- - -### UX Designer - Sally ๐ŸŽจ - -**Role:** User Experience Designer + UI Specialist - -**When to Use:** - -- UX-heavy projects (Level 2-4) -- Design thinking workshops -- Creating user specifications and design artifacts -- Validating UX designs - -**Primary Phase:** Phase 2 (Planning) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `create-design` - Conduct design thinking workshop to define UX specification with: - - Visual exploration and generation - - Collaborative decision-making - - AI-assisted design tools (v0, Lovable) - - Accessibility considerations -- `validate-design` - Validate UX specification and design artifacts - -**Communication Style:** Empathetic and user-focused. Uses storytelling to explain design decisions. Creative yet data-informed. Advocates for user needs over technical convenience. - -**Expertise:** - -- User research and personas -- Interaction design patterns -- AI-assisted design generation -- Accessibility (WCAG compliance) -- Design systems and component libraries -- Cross-functional collaboration - ---- - -### Technical Writer - Paige ๐Ÿ“š - -**Role:** Technical Documentation Specialist + Knowledge Curator - -**When to Use:** - -- Documenting brownfield projects (Phase 0) -- Creating API documentation -- Generating architecture documentation -- Writing user guides and tutorials -- Reviewing documentation quality -- Creating Mermaid diagrams -- Improving README files -- Explaining technical concepts - -**Primary Phase:** All phases (documentation support) - -**Workflows:** - -- `document-project` - Comprehensive project documentation with: - - Three scan levels (Quick, Deep, Exhaustive) - - Multi-part project detection - - Resumability (interrupt and continue) - - Write-as-you-go architecture - - Deep-dive mode for targeted analysis - -**Actions:** - -- `generate-diagram` - Create Mermaid diagrams (architecture, sequence, flow, ER, class, state) -- `validate-doc` - Check documentation against standards -- `improve-readme` - Review and improve README files -- `explain-concept` - Create clear technical explanations with examples -- `standards-guide` - Show BMAD documentation standards reference -- `create-api-docs` - OpenAPI/Swagger documentation (TODO) -- `create-architecture-docs` - Architecture docs with diagrams and ADRs (TODO) -- `create-user-guide` - User-facing guides and tutorials (TODO) -- `audit-docs` - Documentation quality review (TODO) - -**Communication Style:** Patient teacher who makes documentation approachable. Uses examples and analogies. Balances technical precision with accessibility. - -**Critical Standards:** - -- Zero tolerance for CommonMark violations -- Valid Mermaid syntax (mentally validates before output) -- Follows Google Developer Docs Style Guide -- Microsoft Manual of Style for technical writing -- Task-oriented writing approach - -**See Also:** [Document Project Workflow Reference](./workflow-document-project-reference.md) for detailed brownfield documentation capabilities. - ---- - -## Game Development Agents - -### Game Designer - Samus Shepard ๐ŸŽฒ - -**Role:** Lead Game Designer + Creative Vision Architect - -**When to Use:** - -- Game brainstorming and ideation -- Creating game briefs for vision and strategy -- Game Design Documents (GDD) for Level 2-4 game projects -- Narrative design for story-driven games -- Game market research - -**Primary Phase:** Phase 1-2 (Analysis & Planning - Games) - -**Workflows:** - -- `workflow-init` - Initialize workflow tracking -- `workflow-status` - Check what to do next -- `brainstorm-game` - Game-specific ideation -- `create-game-brief` - Game vision and strategy -- `create-gdd` - Complete Game Design Document with: - - Game-type-specific injection (24+ game types) - - Universal template structure - - Platform vs game type separation - - Gameplay-first philosophy -- `narrative` - Narrative design document for story-driven games -- `research` - Game market research - -**Communication Style:** Enthusiastic and player-focused. Frames challenges as design problems to solve. Celebrates creative breakthroughs. - -**Principles:** - -- Understand what players want to feel, not just do -- Rapid prototyping and playtesting -- Every mechanic must serve the core experience -- Meaningful choices create engagement - -**Expertise:** - -- Core gameplay loops -- Progression systems -- Game economy and balance -- Player psychology -- Multi-genre game design - ---- - -### Game Developer - Link Freeman ๐Ÿ•น๏ธ - -**Role:** Senior Game Developer + Technical Implementation Specialist - -**When to Use:** - -- Implementing game stories -- Game code reviews -- Sprint retrospectives for game development - -**Primary Phase:** Phase 4 (Implementation - Games) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `develop-story` - Execute Dev Story workflow, implementing tasks and tests -- `story-done` - Mark story done after DoD complete -- `code-review` - Perform thorough clean context QA code review on a story - -**Communication Style:** Direct and energetic. Execution-focused. Breaks down complex game challenges into actionable steps. Celebrates performance wins. - -**Expertise:** - -- Unity, Unreal, Godot, Phaser, custom engines -- Gameplay programming -- Physics and collision systems -- AI and pathfinding -- Performance optimization -- Cross-platform development - ---- - -### Game Architect - Cloud Dragonborn ๐Ÿ›๏ธ - -**Role:** Principal Game Systems Architect + Technical Director - -**When to Use:** - -- Game system architecture -- Technical foundation design for games -- Solutioning gate checks for game projects -- Course correction during game development - -**Primary Phase:** Phase 3 (Solutioning - Games) - -**Workflows:** - -- `workflow-status` - Check what to do next -- `create-architecture` - Game systems architecture -- `solutioning-gate-check` - Validate Phase 3โ†’4 transition -- `correct-course` - Handle technical changes - -**Communication Style:** Calm and measured. Systematic thinking about complex systems. Uses chess metaphors and military strategy. Emphasizes balance and elegance. - -**Expertise:** - -- Multiplayer architecture (dedicated servers, P2P, hybrid) -- Engine architecture and design -- Asset pipeline optimization -- Platform-specific optimization (console, PC, mobile) -- Technical leadership and mentorship - ---- - -## Special Purpose Agents - -### BMad Master ๐Ÿง™ - -**Role:** BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator - -**When to Use:** - -- Listing all available tasks and workflows -- Facilitating multi-agent party mode discussions -- Meta-level orchestration across modules -- Understanding BMad Core capabilities - -**Primary Phase:** Meta (all phases) - -**Workflows:** - -- `party-mode` - Group chat with all agents (see Party Mode section below) - -**Actions:** - -- `list-tasks` - Show all available tasks from task-manifest.csv -- `list-workflows` - Show all available workflows from workflow-manifest.csv - -**Communication Style:** Direct and comprehensive. Refers to himself in third person ("BMad Master recommends..."). Expert-level communication focused on efficient execution. Presents information systematically using numbered lists. - -**Principles:** - -- Load resources at runtime, never pre-load -- Always present numbered lists for user choices -- Resource-driven execution (tasks, workflows, agents from manifests) - -**Special Role:** - -- **Party Mode Orchestrator:** Loads agent manifest, applies customizations, moderates discussions, summarizes when conversations become circular -- **Knowledge Custodian:** Maintains awareness of all installed modules, agents, workflows, and tasks -- **Workflow Facilitator:** Guides users to appropriate workflows based on current project state - -**Learn More:** See [Party Mode Guide](./party-mode.md) for complete documentation on multi-agent collaboration. - ---- - -## Party Mode: Multi-Agent Collaboration - -Get all your installed agents in one conversation for multi-perspective discussions, retrospectives, and collaborative decision-making. - -**Quick Start:** - -```bash -/bmad:core:workflows:party-mode -# OR from any agent: *party-mode -``` - -**What happens:** BMad Master orchestrates 2-3 relevant agents per message. They discuss, debate, and collaborate in real-time. - -**Best for:** Strategic decisions, creative brainstorming, post-mortems, sprint retrospectives, complex problem-solving. - -**Current BMM uses:** Powers `epic-retrospective` workflow, sprint planning discussions. - -**Future:** Advanced elicitation workflows will officially leverage party mode. - -๐Ÿ‘‰ **[Party Mode Guide](./party-mode.md)** - Complete guide with fun examples, tips, and troubleshooting - ---- - -## Workflow Access - -### How to Run Workflows - -**From IDE (Claude Code, Cursor, Windsurf):** - -1. Load the agent using agent reference (e.g., type `@pm` in Claude Code) -2. Wait for agent menu to appear in chat -3. Type the workflow trigger with `*` prefix (e.g., `*create-prd`) -4. Follow the workflow prompts - -**Agent Menu Structure:** -Each agent displays their available workflows when loaded. Look for: - -- `*` prefix indicates workflow trigger -- Grouped by category or phase -- START HERE indicators for recommended entry points - -### Universal Workflows - -Some workflows are available to multiple agents: - -| Workflow | Agents | Purpose | -| ------------------ | --------------------------------- | ------------------------------------------- | -| `workflow-status` | ALL agents | Check current state and get recommendations | -| `workflow-init` | PM, Analyst, Game Designer | Initialize workflow tracking | -| `correct-course` | PM, Architect, SM, Game Architect | Change management during implementation | -| `document-project` | Analyst, Technical Writer | Brownfield documentation | - -### Validation Actions - -Many workflows have optional validation workflows that perform independent review: - -| Validation | Agent | Validates | -| ---------------------------- | ----------- | ---------------------------------- | -| `validate-prd` | PM | PRD + Epics + Stories completeness | -| `validate-tech-spec` | PM | Technical specification quality | -| `validate-architecture` | Architect | Architecture document | -| `validate-design` | UX Designer | UX specification and artifacts | -| `validate-epic-tech-context` | SM | Epic technical context | -| `validate-create-story` | SM | Story draft | -| `validate-story-context` | SM | Story context XML | - -**When to use validation:** - -- Before phase transitions -- For critical documents -- When learning BMM -- For high-stakes projects - ---- - -## Agent Customization - -You can customize any agent's personality without modifying core agent files. - -### Location - -**Customization Directory:** `{project-root}/.bmad/_cfg/agents/` - -**Naming Convention:** `{module}-{agent-name}.customize.yaml` - -**Examples:** - -``` -.bmad/_cfg/agents/ -โ”œโ”€โ”€ bmm-pm.customize.yaml -โ”œโ”€โ”€ bmm-dev.customize.yaml -โ”œโ”€โ”€ cis-storyteller.customize.yaml -โ””โ”€โ”€ bmb-bmad-builder.customize.yaml -``` - -### Override Structure - -**File Format:** - -```yaml -agent: - persona: - displayName: 'Custom Name' # Optional: Override display name - communicationStyle: 'Custom style description' # Optional: Override style - principles: # Optional: Add or replace principles - - 'Custom principle for this project' - - 'Another project-specific guideline' -``` - -### Override Behavior - -**Precedence:** Customization > Manifest - -**Merge Rules:** - -- If field specified in customization, it replaces manifest value -- If field NOT specified, manifest value used -- Additional fields are added to agent personality -- Changes apply immediately when agent loaded - -### Use Cases - -**Adjust Formality:** - -```yaml -agent: - persona: - communicationStyle: 'Formal and corporate-focused. Uses business terminology. Structured responses with executive summaries.' -``` - -**Add Domain Expertise:** - -```yaml -agent: - persona: - identity: | - Expert Product Manager with 15 years experience in healthcare SaaS. - Deep understanding of HIPAA compliance, EHR integrations, and clinical workflows. - Specializes in balancing regulatory requirements with user experience. -``` - -**Modify Principles:** - -```yaml -agent: - persona: - principles: - - 'HIPAA compliance is non-negotiable' - - 'Prioritize patient safety over feature velocity' - - 'Every feature must have clinical validation' -``` - -**Change Personality:** - -```yaml -agent: - persona: - displayName: 'Alex' # Change from default "Amelia" - communicationStyle: 'Casual and friendly. Uses emojis. Explains technical concepts in simple terms.' -``` - -### Party Mode Integration - -Customizations automatically apply in party mode: - -1. Party mode reads manifest -2. Checks for customization files -3. Merges customizations with manifest -4. Agents respond with customized personalities - -**Example:** - -``` -You customize PM with healthcare expertise. -In party mode, PM now brings healthcare knowledge to discussions. -Other agents collaborate with PM's specialized perspective. -``` - -### Applying Customizations - -**IMPORTANT:** Customizations don't take effect until you rebuild the agents. - -**Complete Process:** - -**Step 1: Create/Modify Customization File** - -```bash -# Create customization file at: -# {project-root}/.bmad/_cfg/agents/{module}-{agent-name}.customize.yaml - -# Example: .bmad/_cfg/agents/bmm-pm.customize.yaml -``` - -**Step 2: Regenerate Agent Manifest** - -After modifying customization files, you must regenerate the agent manifest and rebuild agents: - -```bash -# Run the installer to apply customizations -npx bmad-method install - -# The installer will: -# 1. Read all customization files -# 2. Regenerate agent-manifest.csv with merged data -# 3. Rebuild agent .md files with customizations applied -``` - -**Step 3: Verify Changes** - -Load the customized agent and verify the changes are reflected in its behavior and responses. - -**Why This is Required:** - -- Customization files are just configuration - they don't change agents directly -- The agent manifest must be regenerated to merge customizations -- Agent .md files must be rebuilt with the merged data -- Party mode and all workflows load agents from the rebuilt files - -### Best Practices - -1. **Keep it project-specific:** Customize for your domain, not general changes -2. **Don't break character:** Keep customizations aligned with agent's core role -3. **Test in party mode:** See how customizations interact with other agents -4. **Document why:** Add comments explaining customization purpose -5. **Share with team:** Customizations survive updates, can be version controlled -6. **Rebuild after changes:** Always run installer after modifying customization files - ---- - -## Best Practices - -### Agent Selection - -**1. Start with workflow-status** - -- When unsure where you are, load any agent and run `*workflow-status` -- Agent will analyze current project state and recommend next steps -- Works across all phases and all agents - -**2. Match phase to agent** - -- **Phase 1 (Analysis):** Analyst, Game Designer -- **Phase 2 (Planning):** PM, UX Designer, Game Designer -- **Phase 3 (Solutioning):** Architect, Game Architect -- **Phase 4 (Implementation):** SM, DEV, Game Developer -- **Testing:** TEA (all phases) -- **Documentation:** Technical Writer (all phases) - -**3. Use specialists** - -- **Testing:** TEA for comprehensive quality strategy -- **Documentation:** Technical Writer for technical writing -- **Games:** Game Designer/Developer/Architect for game-specific needs -- **UX:** UX Designer for user-centered design - -**4. Try party mode for:** - -- Strategic decisions with trade-offs -- Creative brainstorming sessions -- Cross-functional alignment -- Complex problem solving - -### Working with Agents - -**1. Trust their expertise** - -- Agents embody decades of simulated experience -- Their questions uncover critical issues -- Their recommendations are data-informed -- Their warnings prevent costly mistakes - -**2. Answer their questions** - -- Agents ask for important reasons -- Incomplete answers lead to assumptions -- Detailed responses yield better outcomes -- "I don't know" is a valid answer - -**3. Follow workflows** - -- Structured processes prevent missed steps -- Workflows encode best practices -- Sequential workflows build on each other -- Validation workflows catch errors early - -**4. Customize when needed** - -- Adjust agent personalities for your project -- Add domain-specific expertise -- Modify communication style for team preferences -- Keep customizations project-specific - -### Common Workflows Patterns - -**Starting a New Project (Greenfield):** - -``` -1. PM or Analyst: *workflow-init -2. Analyst: *brainstorm-project or *product-brief (optional) -3. PM: *create-prd (Level 2-4) or *tech-spec (Level 0-1) -4. Architect: *create-architecture (Level 3-4 only) -5. SM: *sprint-planning -``` - -**Starting with Existing Code (Brownfield):** - -``` -1. Analyst or Technical Writer: *document-project -2. PM or Analyst: *workflow-init -3. PM: *create-prd or *tech-spec -4. Architect: *create-architecture (if needed) -5. SM: *sprint-planning -``` - -**Story Development Cycle:** - -``` -1. SM: *epic-tech-context (optional, once per epic) -2. SM: *create-story -3. SM: *story-context -4. DEV: *develop-story -5. DEV: *code-review -6. DEV: *story-done -7. Repeat steps 2-6 for next story -``` - -**Testing Strategy:** - -``` -1. TEA: *framework (once per project, early) -2. TEA: *atdd (before implementing features) -3. DEV: *develop-story (includes tests) -4. TEA: *automate (comprehensive test suite) -5. TEA: *trace (quality gate) -6. TEA: *ci (pipeline setup) -``` - -**Game Development:** - -``` -1. Game Designer: *brainstorm-game -2. Game Designer: *create-gdd -3. Game Architect: *create-architecture -4. SM: *sprint-planning -5. Game Developer: *create-story -6. Game Developer: *dev-story -7. Game Developer: *code-review -``` - -### Navigation Tips - -**Lost? Run workflow-status** - -``` -Load any agent โ†’ *workflow-status -Agent analyzes project state โ†’ recommends next workflow -``` - -**Phase transitions:** - -``` -Each phase has validation gates: -- Phase 2โ†’3: validate-prd, validate-tech-spec -- Phase 3โ†’4: solutioning-gate-check -Run validation before advancing -``` - -**Course correction:** - -``` -If priorities change mid-project: -Load PM, Architect, or SM โ†’ *correct-course -``` - -**Testing integration:** - -``` -TEA can be invoked at any phase: -- Phase 1: Test strategy planning -- Phase 2: Test scenarios in PRD -- Phase 3: Architecture testability review -- Phase 4: Test automation and CI -``` - ---- - -## Agent Reference Table - -Quick reference for agent selection: - -| Agent | Icon | Primary Phase | Key Workflows | Best For | -| ----------------------- | ---- | ------------------ | --------------------------------------------- | ------------------------------------- | -| **Analyst** | ๐Ÿ“Š | 1 (Analysis) | brainstorm, brief, research, document-project | Discovery, requirements, brownfield | -| **PM** | ๐Ÿ“‹ | 2 (Planning) | prd, tech-spec, epics-stories | Planning, requirements docs | -| **UX Designer** | ๐ŸŽจ | 2 (Planning) | create-design, validate-design | UX-heavy projects, design | -| **Architect** | ๐Ÿ—๏ธ | 3 (Solutioning) | architecture, gate-check | Technical design, architecture | -| **SM** | ๐Ÿƒ | 4 (Implementation) | sprint-planning, create-story, story-context | Story management, sprint coordination | -| **DEV** | ๐Ÿ’ป | 4 (Implementation) | develop-story, code-review, story-done | Implementation, coding | -| **TEA** | ๐Ÿงช | All Phases | framework, atdd, automate, trace, ci | Testing, quality assurance | -| **Paige (Tech Writer)** | ๐Ÿ“š | All Phases | document-project, diagrams, validation | Documentation, diagrams | -| **Game Designer** | ๐ŸŽฒ | 1-2 (Games) | brainstorm-game, gdd, narrative | Game design, creative vision | -| **Game Developer** | ๐Ÿ•น๏ธ | 4 (Games) | develop-story, story-done, code-review | Game implementation | -| **Game Architect** | ๐Ÿ›๏ธ | 3 (Games) | architecture, gate-check | Game systems architecture | -| **BMad Master** | ๐Ÿง™ | Meta | party-mode, list tasks/workflows | Orchestration, multi-agent | - -### Agent Capabilities Summary - -**Planning Agents (3):** - -- PM: Requirements and planning docs -- UX Designer: User experience design -- Game Designer: Game design and narrative - -**Architecture Agents (2):** - -- Architect: System architecture -- Game Architect: Game systems architecture - -**Implementation Agents (3):** - -- SM: Story management and coordination -- DEV: Software development -- Game Developer: Game development - -**Quality Agents (2):** - -- TEA: Testing and quality assurance -- DEV: Code review - -**Support Agents (2):** - -- Analyst: Research and discovery -- Technical Writer: Documentation and diagrams - -**Meta Agent (1):** - -- BMad Master: Orchestration and party mode - ---- - -## Additional Resources - -**Workflow Documentation:** - -- [Phase 1: Analysis Workflows](./workflows-analysis.md) -- [Phase 2: Planning Workflows](./workflows-planning.md) -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) -- [Phase 4: Implementation Workflows](./workflows-implementation.md) - - -**Advanced References:** - -- [Architecture Workflow Reference](./workflow-architecture-reference.md) - Decision architecture details -- [Document Project Workflow Reference](./workflow-document-project-reference.md) - Brownfield documentation - -**Getting Started:** - -- [Quick Start Guide](./quick-start.md) - Step-by-step tutorial -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project levels -- [Brownfield Guide](./brownfield-guide.md) - Working with existing code - -**Other Guides:** - -- [Enterprise Agentic Development](./enterprise-agentic-development.md) - Team collaboration -- [FAQ](./faq.md) - Common questions -- [Glossary](./glossary.md) - Terminology reference - ---- - -## Quick Start Checklist - -**First Time with BMM:** - -- [ ] Read [Quick Start Guide](./quick-start.md) -- [ ] Understand [Scale Adaptive System](./scale-adaptive-system.md) -- [ ] Load an agent in your IDE -- [ ] Run `*workflow-status` -- [ ] Follow recommended workflow - -**Starting a Project:** - -- [ ] Determine project type (greenfield vs brownfield) -- [ ] If brownfield: Run `*document-project` (Analyst or Technical Writer) -- [ ] Load PM or Analyst โ†’ `*workflow-init` -- [ ] Follow phase-appropriate workflows -- [ ] Try `*party-mode` for strategic decisions - -**Implementing Stories:** - -- [ ] SM: `*sprint-planning` (once) -- [ ] SM: `*create-story` -- [ ] SM: `*story-context` -- [ ] DEV: `*develop-story` -- [ ] DEV: `*code-review` -- [ ] DEV: `*story-done` - -**Testing Strategy:** - -- [ ] TEA: `*framework` (early in project) -- [ ] TEA: `*atdd` (before features) -- [ ] TEA: `*test-design` (comprehensive scenarios) -- [ ] TEA: `*ci` (pipeline setup) - ---- - -_Welcome to the team. Your AI agents are ready to collaborate._ diff --git a/.bmad/bmm/docs/brownfield-guide.md b/.bmad/bmm/docs/brownfield-guide.md deleted file mode 100644 index d3c02dbb..00000000 --- a/.bmad/bmm/docs/brownfield-guide.md +++ /dev/null @@ -1,754 +0,0 @@ -# BMad Method Brownfield Development Guide - -**Complete guide for working with existing codebases** - -**Reading Time:** ~35 minutes - ---- - -## Quick Navigation - -**Jump to:** - -- [Quick Reference](#quick-reference) - Commands and files -- [Common Scenarios](#common-scenarios) - Real-world examples -- [Best Practices](#best-practices) - Success tips - ---- - -## What is Brownfield Development? - -Brownfield projects involve working within existing codebases rather than starting fresh: - -- **Bug fixes** - Single file changes -- **Small features** - Adding to existing modules -- **Feature sets** - Multiple related features -- **Major integrations** - Complex architectural additions -- **System expansions** - Enterprise-scale enhancements - -**Key Difference from Greenfield:** You must understand and respect existing patterns, architecture, and constraints. - -**Core Principle:** AI agents need comprehensive documentation to understand existing code before they can effectively plan or implement changes. - ---- - -## Getting Started - -### Understanding Planning Tracks - -For complete track details, see [Scale Adaptive System](./scale-adaptive-system.md). - -**Brownfield tracks at a glance:** - -| 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 | - -**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: - -**Step 1: Shows what it found** - -- Old planning docs (PRD, epics, stories) -- Existing codebase - -**Step 2: Asks about YOUR work** - -> "Are these works in progress, previous effort, or proposed work?" - -- **(a) Works in progress** โ†’ Uses artifacts to determine level -- **(b) Previous effort** โ†’ Asks you to describe NEW work -- **(c) Proposed work** โ†’ Uses artifacts as guidance -- **(d) None of these** โ†’ You explain your work - -**Step 3: Analyzes your description** - -- 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 Complex PRD, New Simple Work** - -``` -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: "Quick Flow track (tech-spec approach). Correct?" -You: "Yes" -โœ… Creates Quick Flow workflow -``` - ---- - -## Phase 0: Documentation (Critical First Step) - -๐Ÿšจ **For brownfield projects: Always ensure adequate AI-usable documentation before planning** - -### Default Recommendation: Run document-project - -**Best practice:** Run `document-project` workflow unless you have **confirmed, trusted, AI-optimized documentation**. - -### Why Document-Project is Almost Always the Right Choice - -Existing documentation often has quality issues that break AI workflows: - -**Common Problems:** - -- **Too Much Information (TMI):** Massive markdown files with 10s or 100s of level 2 sections -- **Out of Date:** Documentation hasn't been updated with recent code changes -- **Wrong Format:** Written for humans, not AI agents (lacks structure, index, clear patterns) -- **Incomplete Coverage:** Missing critical architecture, patterns, or setup info -- **Inconsistent Quality:** Some areas documented well, others not at all - -**Impact on AI Agents:** - -- AI agents hit token limits reading massive files -- Outdated docs cause hallucinations (agent thinks old patterns still apply) -- Missing structure means agents can't find relevant information -- Incomplete coverage leads to incorrect assumptions - -### Documentation Decision Tree - -**Step 1: Assess Existing Documentation Quality** - -Ask yourself: - -- โœ… Is it **current** (updated in last 30 days)? -- โœ… Is it **AI-optimized** (structured with index.md, clear sections, <500 lines per file)? -- โœ… Is it **comprehensive** (architecture, patterns, setup all documented)? -- โœ… Do you **trust** it completely for AI agent consumption? - -**If ANY answer is NO โ†’ Run `document-project`** - -**Step 2: Check for Massive Documents** - -If you have documentation but files are huge (>500 lines, 10+ level 2 sections): - -1. **First:** Run `shard-doc` tool to split large files: - - ```bash - # Load BMad Master or any agent - .bmad/core/tools/shard-doc.xml --input docs/massive-doc.md - ``` - - - Splits on level 2 sections by default - - Creates organized, manageable files - - Preserves content integrity - -2. **Then:** Run `index-docs` task to create navigation: - - ```bash - .bmad/core/tasks/index-docs.xml --directory ./docs - ``` - -3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated โ†’ Run `document-project` - -### Four Real-World Scenarios - -| Scenario | You Have | Action | Why | -| -------- | ------------------------------------------ | -------------------------- | --------------------------------------- | -| **A** | No documentation | `document-project` | Only option - generate from scratch | -| **B** | Docs exist but massive/outdated/incomplete | `document-project` | Safer to regenerate than trust bad docs | -| **C** | Good docs but no structure | `shard-doc` โ†’ `index-docs` | Structure existing content for AI | -| **D** | Confirmed AI-optimized docs with index.md | Skip Phase 0 | Rare - only if you're 100% confident | - -### Scenario A: No Documentation (Most Common) - -**Action: Run document-project workflow** - -1. Load Analyst or Technical Writer (Paige) agent -2. Run `*document-project` -3. Choose scan level: - - **Quick** (2-5min): Pattern analysis, no source reading - - **Deep** (10-30min): Reads critical paths - **Recommended** - - **Exhaustive** (30-120min): Reads all files - -**Outputs:** - -- `docs/index.md` - Master AI entry point -- `docs/project-overview.md` - Executive summary -- `docs/architecture.md` - Architecture analysis -- `docs/source-tree-analysis.md` - Directory structure -- Additional files based on project type (API, web app, etc.) - -### Scenario B: Docs Exist But Quality Unknown/Poor (Very Common) - -**Action: Run document-project workflow (regenerate)** - -Even if `docs/` folder exists, if you're unsure about quality โ†’ **regenerate**. - -**Why regenerate instead of index?** - -- Outdated docs โ†’ AI makes wrong assumptions -- Incomplete docs โ†’ AI invents missing information -- TMI docs โ†’ AI hits token limits, misses key info -- Human-focused docs โ†’ Missing AI-critical structure - -**document-project** will: - -- Scan actual codebase (source of truth) -- Generate fresh, accurate documentation -- Structure properly for AI consumption -- Include only relevant, current information - -### Scenario C: Good Docs But Needs Structure - -**Action: Shard massive files, then index** - -If you have **good, current documentation** but it's in massive files: - -**Step 1: Shard large documents** - -```bash -# For each massive doc (>500 lines or 10+ level 2 sections) -.bmad/core/tools/shard-doc.xml \ - --input docs/api-documentation.md \ - --output docs/api/ \ - --level 2 # Split on ## headers (default) -``` - -**Step 2: Generate index** - -```bash -.bmad/core/tasks/index-docs.xml --directory ./docs -``` - -**Step 3: Validate** - -- Review generated `docs/index.md` -- Check that sharded files are <500 lines each -- Verify content is current and accurate -- **If anything seems off โ†’ Run document-project instead** - -### Scenario D: Confirmed AI-Optimized Documentation (Rare) - -**Action: Skip Phase 0** - -Only skip if ALL conditions met: - -- โœ… `docs/index.md` exists and is comprehensive -- โœ… Documentation updated within last 30 days -- โœ… All doc files <500 lines with clear structure -- โœ… Covers architecture, patterns, setup, API surface -- โœ… You personally verified quality for AI consumption -- โœ… Previous AI agents used it successfully - -**If unsure โ†’ Run document-project** (costs 10-30 minutes, saves hours of confusion) - -### Why document-project is Critical - -Without AI-optimized documentation, workflows fail: - -- **tech-spec** (Quick Flow) can't auto-detect stack/patterns โ†’ Makes wrong assumptions -- **PRD** (BMad Method) can't reference existing code โ†’ Designs incompatible features -- **architecture** can't build on existing structure โ†’ Suggests conflicting patterns -- **story-context** can't inject existing patterns โ†’ Dev agent rewrites working code -- **dev-story** invents implementations โ†’ Breaks existing integrations - -### Key Principle - -**When in doubt, run document-project.** - -It's better to spend 10-30 minutes generating fresh, accurate docs than to waste hours debugging AI agents working from bad documentation. - ---- - -## Workflow Phases by Track - -### Phase 1: Analysis (Optional) - -**Workflows:** - -- `brainstorm-project` - Solution exploration -- `research` - Technical/market research -- `product-brief` - Strategic planning (BMad Method/Enterprise tracks only) - -**When to use:** Complex features, technical decisions, strategic additions - -**When to skip:** Bug fixes, well-understood features, time-sensitive changes - -See the [Workflows section in BMM README](../README.md) for details. - -### Phase 2: Planning (Required) - -**Planning approach adapts by track:** - -**Quick Flow:** Use `tech-spec` workflow - -- Creates tech-spec.md -- Auto-detects existing stack (brownfield) -- Confirms conventions with you -- Generates implementation-ready stories - -**BMad Method/Enterprise:** Use `prd` workflow - -- 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 track. - -### Phase 3: Solutioning (BMad Method/Enterprise Only) - -**Critical for brownfield:** - -- Review existing architecture FIRST -- Document integration points explicitly -- Plan backward compatibility -- Consider migration strategy - -**Workflows:** - -- `create-architecture` - Extend architecture docs (BMad Method/Enterprise) -- `solutioning-gate-check` - Validate before implementation (BMad Method/Enterprise) - -### Phase 4: Implementation (All Tracks) - -**Sprint-based development through story iteration:** - -```mermaid -flowchart TD - SPRINT[sprint-planning
Initialize tracking] - EPIC[epic-tech-context
Per epic] - CREATE[create-story] - CONTEXT[story-context] - DEV[dev-story] - REVIEW[code-review] - CHECK{More stories?} - RETRO[retrospective
Per epic] - - SPRINT --> EPIC - EPIC --> CREATE - CREATE --> CONTEXT - CONTEXT --> DEV - DEV --> REVIEW - REVIEW --> CHECK - CHECK -->|Yes| CREATE - CHECK -->|No| RETRO - - style SPRINT fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style RETRO fill:#fbf,stroke:#333,stroke-width:2px,color:#000 -``` - -**Status Progression:** - -- Epic: `backlog โ†’ contexted` -- Story: `backlog โ†’ drafted โ†’ ready-for-dev โ†’ in-progress โ†’ review โ†’ done` - -**Brownfield-Specific Implementation Tips:** - -1. **Respect existing patterns** - Follow established conventions -2. **Test integration thoroughly** - Validate interactions with existing code -3. **Use feature flags** - Enable gradual rollout -4. **Context injection matters** - epic-tech-context and story-context reference existing patterns - ---- - -## Best Practices - -### 1. Always Document First - -Even if you know the code, AI agents need `document-project` output for context. Run it before planning. - -### 2. Be Specific About Current Work - -When workflow-init asks about your work: - -- โœ… "Update payment method enums to include Apple Pay" -- โŒ "Fix stuff" - -### 3. Choose Right Documentation Approach - -- **Has good docs, no index?** โ†’ Run `index-docs` task (fast) -- **No docs or need codebase analysis?** โ†’ Run `document-project` (Deep scan) - -### 4. Respect Existing Patterns - -Tech-spec and story-context will detect conventions. Follow them unless explicitly modernizing. - -### 5. Plan Integration Points Explicitly - -Document in tech-spec/architecture: - -- Which existing modules you'll modify -- What APIs/services you'll integrate with -- How data flows between new and existing code - -### 6. Design for Gradual Rollout - -- Use feature flags for new functionality -- Plan rollback strategies -- Maintain backward compatibility -- Create migration scripts if needed - -### 7. Test Integration Thoroughly - -- Regression testing of existing features -- Integration point validation -- Performance impact assessment -- API contract verification - -### 8. Use Sprint Planning Effectively - -- Run `sprint-planning` at Phase 4 start -- Context epics before drafting stories -- Update `sprint-status.yaml` as work progresses - -### 9. Leverage Context Injection - -- Run `epic-tech-context` before story drafting -- Always create `story-context` before implementation -- These reference existing patterns for consistency - -### 10. Learn Continuously - -- Run `retrospective` after each epic -- Incorporate learnings into next stories -- Update discovered patterns -- Share insights across team - ---- - -## Common Scenarios - -### 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) -2. **Plan:** Load PM โ†’ run `tech-spec` - - Analyzes bug - - Detects stack (Express, Jest) - - Confirms conventions - - Creates tech-spec.md + story -3. **Implement:** Load DEV โ†’ run `dev-story` -4. **Review:** Load DEV โ†’ run `code-review` - -**Time:** 2-4 hours - ---- - -### 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) -2. **Plan:** Load PM โ†’ run `tech-spec` - - Detects Next.js 13.4, NextAuth.js - - Analyzes existing auth patterns - - Confirms conventions - - Creates tech-spec.md + epic + 3-5 stories -3. **Implement:** Load SM โ†’ `sprint-planning` โ†’ `create-story` โ†’ `story-context` - Load DEV โ†’ `dev-story` for each story -4. **Review:** Load DEV โ†’ `code-review` - -**Time:** 1-3 days - ---- - -### 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. **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 -6. **Review:** Per story completion - -**Time:** 1-2 weeks - ---- - -### 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 โ†’ `create-architecture` (extend for real-time layer) - - Load Architect โ†’ `solutioning-gate-check` -5. **Implement:** Sprint-based (20-30 stories) - -**Time:** 3-6 weeks - ---- - -### 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** -2. **Analyze:** **Required** - - `brainstorm-project` - Explore multi-tenancy approaches - - `research` - Database sharding, tenant isolation, pricing - - `product-brief` - Strategic document -3. **Plan:** Load PM โ†’ `prd` (comprehensive) -4. **Solution:** - - `create-architecture` - Full system architecture - - `integration-planning` - Phased migration strategy - - `create-architecture` - Multi-tenancy architecture - - `validate-architecture` - External review - - `solutioning-gate-check` - Executive approval -5. **Implement:** Phased sprint-based (50+ stories) - -**Time:** 3-6 months - ---- - -## Troubleshooting - -### AI Agents Lack Codebase Understanding - -**Symptoms:** - -- Suggestions don't align with existing patterns -- Ignores available components -- Doesn't reference existing code - -**Solution:** - -1. Run `document-project` with Deep scan -2. Verify `docs/index.md` exists -3. Check documentation completeness -4. Run deep-dive on specific areas if needed - -### Have Documentation But Agents Can't Find It - -**Symptoms:** - -- README.md, ARCHITECTURE.md exist -- AI agents ask questions already answered -- No `docs/index.md` file - -**Solution:** - -- **Quick fix:** Run `index-docs` task (2-5min) -- **Comprehensive:** Run `document-project` workflow (10-30min) - -### Integration Points Unclear - -**Symptoms:** - -- Not sure how to connect new code to existing -- Unsure which files to modify - -**Solution:** - -1. Ensure `document-project` captured existing architecture -2. Check `story-context` - should document integration points -3. In tech-spec/architecture - explicitly document: - - Which existing modules to modify - - What APIs/services to integrate with - - Data flow between new and existing code -4. Review architecture document for integration guidance - -### Existing Tests Breaking - -**Symptoms:** - -- Regression test failures -- Previously working functionality broken - -**Solution:** - -1. Review changes against existing patterns -2. Verify API contracts unchanged (unless intentionally versioned) -3. Run `test-review` workflow (TEA agent) -4. Add regression testing to DoD -5. Consider feature flags for gradual rollout - -### Inconsistent Patterns Being Introduced - -**Symptoms:** - -- New code style doesn't match existing -- Different architectural approach - -**Solution:** - -1. Check convention detection (Quick Spec Flow should detect patterns) -2. Review documentation - ensure `document-project` captured patterns -3. Use `story-context` - injects pattern guidance -4. Add to code-review checklist: pattern adherence, convention consistency -5. Run retrospective to identify deviations early - ---- - -## Quick Reference - -### Commands by Phase - -```bash -# Phase 0: Documentation (If Needed) -# Analyst agent: -document-project # Create comprehensive docs (10-30min) -# OR load index-docs task for existing docs (2-5min) - -# Phase 1: Analysis (Optional) -# Analyst agent: -brainstorm-project # Explore solutions -research # Gather data -product-brief # Strategic planning (BMad Method/Enterprise only) - -# Phase 2: Planning (Required) -# PM agent: -tech-spec # Quick Flow track -prd # BMad Method/Enterprise tracks - -# Phase 3: Solutioning (BMad Method/Enterprise) -# Architect agent: -create-architecture # Extend architecture -solutioning-gate-check # Final validation - -# Phase 4: Implementation (All Tracks) -# SM agent: -sprint-planning # Initialize tracking -epic-tech-context # Epic context -create-story # Draft story -story-context # Story context - -# DEV agent: -dev-story # Implement -code-review # Review - -# SM agent: -retrospective # After epic -correct-course # If issues -``` - -### Key Files - -**Phase 0 Output:** - -- `docs/index.md` - **Master AI entry point (REQUIRED)** -- `docs/project-overview.md` -- `docs/architecture.md` -- `docs/source-tree-analysis.md` - -**Phase 1-3 Tracking:** - -- `docs/bmm-workflow-status.yaml` - Progress tracker - -**Phase 2 Planning:** - -- `docs/tech-spec.md` (Quick Flow track) -- `docs/PRD.md` (BMad Method/Enterprise tracks) -- Epic breakdown - -**Phase 3 Architecture:** - -- `docs/architecture.md` (BMad Method/Enterprise tracks) - -**Phase 4 Implementation:** - -- `docs/sprint-status.yaml` - **Single source of truth** -- `docs/epic-{n}-context.md` -- `docs/stories/{epic}-{story}-{title}.md` -- `docs/stories/{epic}-{story}-{title}-context.md` - -### Decision Flowchart - -```mermaid -flowchart TD - START([Brownfield Project]) - CHECK{Has docs/
index.md?} - - START --> CHECK - CHECK -->|No| DOC[document-project
Deep scan] - CHECK -->|Yes| TRACK{What Track?} - - DOC --> TRACK - - 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 - PRD2 --> IMPL - - style START fill:#f9f,stroke:#333,stroke-width:2px,color:#000 - style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style IMPL fill:#bfb,stroke:#333,stroke-width:2px,color:#000 -``` - ---- - -## Prevention Tips - -**Avoid issues before they happen:** - -1. โœ… **Always run document-project for brownfield** - Saves context issues later -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 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 - ---- - -## Related Documentation - -- **[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 -- **[Workflow Documentation](./README.md#-workflow-guides)** - Complete workflow reference - ---- - -## Support and Resources - -**Community:** - -- [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues -- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) -- [YouTube Channel](https://www.youtube.com/@BMadCode) - -**Documentation:** - -- [Test Architect Guide](./test-architecture.md) - Comprehensive testing strategy -- [BMM Module README](../README.md) - Complete module and workflow reference - ---- - -_Brownfield development is about understanding and respecting what exists while thoughtfully extending it._ diff --git a/.bmad/bmm/docs/enterprise-agentic-development.md b/.bmad/bmm/docs/enterprise-agentic-development.md deleted file mode 100644 index 8e11b2e8..00000000 --- a/.bmad/bmm/docs/enterprise-agentic-development.md +++ /dev/null @@ -1,680 +0,0 @@ -# Enterprise Agentic Development with BMad Method - -**The paradigm shift: From team-based story parallelism to individual epic ownership** - -**Reading Time:** ~18 minutes - ---- - -## Table of Contents - -- [The Paradigm Shift](#the-paradigm-shift) -- [The Evolving Role of Product Managers and UX Designers](#the-evolving-role-of-product-managers-and-ux-designers) -- [How BMad Method Enables PM/UX Technical Evolution](#how-bmad-method-enables-pmux-technical-evolution) -- [Team Collaboration Patterns](#team-collaboration-patterns) -- [Work Distribution Strategies](#work-distribution-strategies) -- [Enterprise Configuration with Git Submodules](#enterprise-configuration-with-git-submodules) -- [Best Practices](#best-practices) -- [Common Scenarios](#common-scenarios) - ---- - -## The Paradigm Shift - -### Traditional Agile: Team-Based Story Parallelism - -- **Epic duration:** 4-12 weeks across multiple sprints -- **Story duration:** 2-5 days per developer -- **Team size:** 5-9 developers working on same epic -- **Parallelization:** Multiple devs on stories within single epic -- **Coordination:** Constant - daily standups, merge conflicts, integration overhead - -**Example:** Payment Processing Epic - -- Sprint 1-2: Backend API (Dev A) -- Sprint 1-2: Frontend UI (Dev B) -- Sprint 2-3: Testing (Dev C) -- **Result:** 6-8 weeks, 3 developers, high coordination - -### Agentic Development: Individual Epic Ownership - -- **Epic duration:** Hours to days (not weeks) -- **Story duration:** 30 min to 4 hours with AI agent -- **Team size:** 1 developer + AI agents completes full epics -- **Parallelization:** Developers work on separate epics -- **Coordination:** Minimal - epic boundaries, async updates - -**Same Example:** Payment Processing Epic - -- Day 1 AM: Backend API stories (1 dev + agent, 3-4 stories) -- Day 1 PM: Frontend UI stories (same dev + agent, 2-3 stories) -- Day 2: Testing & deployment (same dev + agent, 2 stories) -- **Result:** 1-2 days, 1 developer, minimal coordination - -### The Core Difference - -**What changed:** AI agents collapse story duration from days to hours, making **epic-level ownership** practical. - -**Impact:** Single developer with BMad Method can deliver in 1 day what previously required full team and multiple sprints. - ---- - -## The Evolving Role of Product Managers and UX Designers - -### The Future is Now - -Product Managers and UX Designers are undergoing **the most significant transformation since the creation of these disciplines**. The emergence of AI agents is creating a new breed of technical product leaders who translate vision directly into working code. - -### From Spec Writers to Code Orchestrators - -**Traditional PM/UX (Pre-2025):** - -- Write PRDs, hand off to engineering -- Wait weeks/months for implementation -- Limited validation capabilities -- Non-technical role, heavy on process - -**Emerging PM/UX (2025+):** - -- Write AI-optimized PRDs that **feed agentic pipelines directly** -- Generate working prototypes in 10-15 minutes -- Review pull requests from AI agents -- Technical fluency is **table stakes**, not optional -- Orchestrate cloud-based AI agent teams - -### Industry Research (November 2025) - -- **56% of product professionals** cite AI/ML as top focus -- **AI agents automating** customer discovery, PRD creation, status reporting -- **PRD-to-Code automation** enables PMs to build and deploy apps in 10-15 minutes -- **By 2026**: Roles converging into "Full-Stack Product Lead" (PM + Design + Engineering) -- **Very high salaries** for AI agent PMs who orchestrate autonomous dev systems - -### Required Skills for Modern PMs/UX - -1. **AI Prompt Engineering** - Writing PRDs AI agents can execute autonomously -2. **Coding Literacy** - Understanding code structure, APIs, data flows (not production coding) -3. **Agentic Workflow Design** - Orchestrating multi-agent systems (planning โ†’ design โ†’ dev) -4. **Technical Architecture** - Reasoning frameworks, memory systems, tool integration -5. **Data Literacy** - Interpreting model outputs, spotting trends, identifying gaps -6. **Code Review** - Evaluating AI-generated PRs for correctness and vision alignment - -### What Remains Human - -**AI Can't Replace:** - -- Product vision (market dynamics, customer pain, strategic positioning) -- Empathy (deep user research, emotional intelligence, stakeholder management) -- Creativity (novel problem-solving, disruptive thinking) -- Judgment (prioritization decisions, trade-off analysis) -- Ethics (responsible AI use, privacy, accessibility) - -**What Changes:** - -- PMs/UX spend **more time on human elements** (AI handles routine execution) -- Barrier between "thinking" and "building" collapses -- Product leaders become **builder-thinkers**, not just spec writers - -### The Convergence - -- **PMs learning to code** with GitHub Copilot, Cursor, v0 -- **UX designers generating code** with UXPin Merge, Figma-to-code tools -- **Developers becoming orchestrators** reviewing AI output vs writing from scratch - -**The Bottom Line:** By 2026, successful PMs/UX will fluently operate in both vision and execution. **BMad Method provides the structured framework to make this transition.** - ---- - -## How BMad Method Enables PM/UX Technical Evolution - -BMad Method is specifically designed to position PMs and UX designers for this future. - -### 1. AI-Executable PRD Generation - -**PM Workflow:** - -```bash -bmad pm *create-prd -``` - -**BMad produces:** - -- Structured, machine-readable requirements -- Testable acceptance criteria per requirement -- Clear epic/story decomposition -- Technical context for AI agents - -**Why it matters:** Traditional PRDs are human-readable prose. BMad PRDs are **AI-executable work packages**. - -**PM Value:** Write once, automatically translated into agent-ready stories. No engineering bottleneck for translation. - -### 2. Automated Epic/Story Breakdown - -**PM Workflow:** - -```bash -bmad pm *create-epics-and-stories -``` - -**BMad produces:** - -- Epic files with clear objectives -- Story files with acceptance criteria, context, technical guidance -- Priority assignments (P0-P3) -- Dependency mapping - -**Why it matters:** Stories become **work packages for cloud AI agents**. Each story is self-contained with full context. - -**PM Value:** No more "story refinement sessions" with engineering. AI agents execute directly from BMad stories. - -### 3. Human-in-the-Loop Architecture - -**Architect/PM Workflow:** - -```bash -bmad architect *create-architecture -``` - -**BMad produces:** - -- System architecture aligned with PRD -- Architecture Decision Records (ADRs) -- Epic-specific technical guidance -- Integration patterns and standards - -**Why it matters:** PMs can **understand and validate** technical decisions. Architecture is conversational, not template-driven. - -**PM Value:** Technical fluency built through guided architecture process. PMs learn while creating. - -### 4. Cloud Agentic Pipeline (Emerging Pattern) - -**Current State (2025):** - -``` -PM writes BMad PRD - โ†“ -create-epics-and-stories generates story queue - โ†“ -Stories loaded by human developers + BMad agents - โ†“ -Developers create PRs - โ†“ -PM/Team reviews PRs - โ†“ -Merge and deploy -``` - -**Near Future (2026):** - -``` -PM writes BMad PRD - โ†“ -create-epics-and-stories generates story queue - โ†“ -Stories automatically fed to cloud AI agent pool - โ†“ -AI agents implement stories in parallel - โ†“ -AI agents create pull requests - โ†“ -PM/UX/Senior Devs review PRs - โ†“ -Approved PRs auto-merge - โ†“ -Continuous deployment to production -``` - -**Time Savings:** - -- **Traditional:** PM writes spec โ†’ 2-4 weeks engineering โ†’ review โ†’ deploy (6-8 weeks) -- **BMad Agentic:** PM writes PRD โ†’ AI agents implement โ†’ review PRs โ†’ deploy (2-5 days) - -### 5. UX Design Integration - -**UX Designer Workflow:** - -```bash -bmad ux *create-design -``` - -**BMad produces:** - -- Component-based design system -- Interaction patterns aligned with tech stack -- Accessibility guidelines -- Responsive design specifications - -**Why it matters:** Design specs become **implementation-ready** for AI agents. No "lost in translation" between design and dev. - -**UX Value:** Designs validated through working prototypes, not static mocks. Technical understanding built through BMad workflows. - -### 6. PM Technical Skills Development - -**BMad teaches PMs technical skills through:** - -- **Conversational workflows** - No pre-requisite knowledge, learn by doing -- **Architecture facilitation** - Understand system design through guided questions -- **Story context assembly** - See how code patterns inform implementation -- **Code review workflows** - Learn to evaluate code quality, patterns, standards - -**Example:** PM runs `create-architecture` workflow: - -- BMad asks about scale, performance, integrations -- PM answers business questions -- BMad explains technical implications -- PM learns architecture concepts while making decisions - -**Result:** PMs gain **working technical knowledge** without formal CS education. - -### 7. Organizational Leverage - -**Traditional Model:** - -- 1 PM โ†’ supports 5-9 developers โ†’ delivers 1-2 features/quarter - -**BMad Agentic Model:** - -- 1 PM โ†’ writes BMad PRD โ†’ 20-50 AI agents execute stories in parallel โ†’ delivers 5-10 features/quarter - -**Leverage multiplier:** 5-10ร— with same PM headcount. - -### 8. Quality Consistency - -**BMad ensures:** - -- AI agents follow architectural patterns consistently (via story-context) -- Code standards applied uniformly (via epic-tech-context) -- PRD traceability throughout implementation (via acceptance criteria) -- No "telephone game" between PM, design, and dev - -**PM Value:** What gets built **matches what was specified**, drastically reducing rework. - -### 9. Rapid Prototyping for Validation - -**PM Workflow (with BMad + Cursor/v0):** - -1. Use BMad to generate PRD structure and requirements -2. Extract key user flow from PRD -3. Feed to Cursor/v0 with BMad context -4. Working prototype in 10-15 minutes -5. Validate with users **before** committing to full development - -**Traditional:** Months of development to validate idea -**BMad Agentic:** Hours of development to validate idea - -### 10. Career Path Evolution - -**BMad positions PMs for emerging roles:** - -- **AI Agent Product Manager** - Orchestrate autonomous development systems -- **Full-Stack Product Lead** - Oversee product, design, engineering with AI leverage -- **Technical Product Strategist** - Bridge business vision and technical execution - -**Hiring advantage:** PMs using BMad demonstrate: - -- Technical fluency (can read architecture, validate tech decisions) -- AI-native workflows (structured requirements, agentic orchestration) -- Results (ship 5-10ร— faster than peers) - ---- - -## Team Collaboration Patterns - -### Old Pattern: Story Parallelism - -**Traditional Agile:** - -``` -Epic: User Dashboard (8 weeks) -โ”œโ”€ Story 1: Backend API (Dev A, Sprint 1-2) -โ”œโ”€ Story 2: Frontend Layout (Dev B, Sprint 1-2) -โ”œโ”€ Story 3: Data Viz (Dev C, Sprint 2-3) -โ””โ”€ Story 4: Integration Testing (Team, Sprint 3-4) - -Challenge: Coordination overhead, merge conflicts, integration issues -``` - -### New Pattern: Epic Ownership - -**Agentic Development:** - -``` -Project: Analytics Platform (2-3 weeks) - -Developer A: -โ””โ”€ Epic 1: User Dashboard (3 days, 12 stories sequentially with AI) - -Developer B: -โ””โ”€ Epic 2: Admin Panel (4 days, 15 stories sequentially with AI) - -Developer C: -โ””โ”€ Epic 3: Reporting Engine (5 days, 18 stories sequentially with AI) - -Benefit: Minimal coordination, epic-level ownership, clear boundaries -``` - ---- - -## Work Distribution Strategies - -### Strategy 1: Epic-Based (Recommended) - -**Best for:** 2-10 developers - -**Approach:** Each developer owns complete epics, works sequentially through stories - -**Example:** - -```yaml -epics: - - id: epic-1 - title: Payment Processing - owner: alice - stories: 8 - estimate: 2 days - - - id: epic-2 - title: User Dashboard - owner: bob - stories: 12 - estimate: 3 days -``` - -**Benefits:** Clear ownership, minimal conflicts, epic cohesion, reduced coordination - -### Strategy 2: Layer-Based - -**Best for:** Full-stack apps, specialized teams - -**Example:** - -``` -Frontend Dev: Epic 1 (Product Catalog UI), Epic 3 (Cart UI) -Backend Dev: Epic 2 (Product API), Epic 4 (Cart Service) -``` - -**Benefits:** Developers in expertise area, true parallel work, clear API contracts - -**Requirements:** Strong architecture phase, clear API contracts upfront - -### Strategy 3: Feature-Based - -**Best for:** Large teams (10+ developers) - -**Example:** - -``` -Team A (2 devs): Payments feature (4 epics) -Team B (2 devs): User Management feature (3 epics) -Team C (2 devs): Analytics feature (3 epics) -``` - -**Benefits:** Feature team autonomy, domain expertise, scalable to large orgs - ---- - -## Enterprise Configuration with Git Submodules - -### The Challenge - -**Problem:** Teams customize BMad (agents, workflows, configs) but don't want personal tooling in main repo. - -**Anti-pattern:** Adding `.bmad/` to `.gitignore` breaks IDE tools, submodule management. - -### The Solution: Git Submodules - -**Benefits:** - -- BMad exists in project but tracked separately -- Each developer controls their own BMad version/config -- Optional team config sharing via submodule repo -- IDE tools maintain proper context - -### Setup (New Projects) - -**1. Create optional team config repo:** - -```bash -git init bmm-config -cd bmm-config -npx bmad-method install -# Customize for team standards -git commit -m "Team BMM config" -git push origin main -``` - -**2. Add submodule to project:** - -```bash -cd /path/to/your-project -git submodule add https://github.com/your-org/bmm-config.git bmad -git commit -m "Add BMM as submodule" -``` - -**3. Team members initialize:** - -```bash -git clone https://github.com/your-org/your-project.git -cd your-project -git submodule update --init --recursive -# Make personal customizations in .bmad/ -``` - -### Daily Workflow - -**Work in main project:** - -```bash -cd /path/to/your-project -# BMad available at ./.bmad/, load agents normally -``` - -**Update personal config:** - -```bash -cd bmad -# Make changes, commit locally, don't push unless sharing -``` - -**Update to latest team config:** - -```bash -cd bmad -git pull origin main -``` - -### Configuration Strategies - -**Option 1: Fully Personal** - No submodule, each dev installs independently, use `.gitignore` - -**Option 2: Team Baseline + Personal** - Submodule has team standards, devs add personal customizations locally - -**Option 3: Full Team Sharing** - All configs in submodule, team collaborates on improvements - ---- - -## Best Practices - -### 1. Epic Ownership - -- **Do:** Assign entire epic to one developer (context โ†’ implementation โ†’ retro) -- **Don't:** Split epics across multiple developers (coordination overhead, context loss) - -### 2. Dependency Management - -- **Do:** Identify epic dependencies in planning, document API contracts, complete prerequisites first -- **Don't:** Start dependent epic before prerequisite ready, change API contracts without coordination - -### 3. Communication Cadence - -**Traditional:** Daily standups essential -**Agentic:** Lighter coordination - -**Recommended:** - -- Daily async updates ("Epic 1, 60% complete, no blockers") -- Twice-weekly 15min sync -- Epic completion demos -- Sprint retro after all epics complete - -### 4. Branch Strategy - -```bash -feature/epic-1-payment-processing (Alice) -feature/epic-2-user-dashboard (Bob) -feature/epic-3-admin-panel (Carol) - -# PR and merge when epic complete -``` - -### 5. Testing Strategy - -- **Story-level:** Unit tests (DoD requirement, written by agent during dev-story) -- **Epic-level:** Integration tests across stories -- **Project-level:** E2E tests after multiple epics complete - -### 6. Documentation Updates - -- **Real-time:** `sprint-status.yaml` updated by workflows -- **Epic completion:** Update architecture docs, API docs, README if changed -- **Sprint completion:** Incorporate retrospective insights - -### 7. Metrics (Different from Traditional) - -**Traditional:** Story points per sprint, burndown charts -**Agentic:** Epics per week, stories per day, time to epic completion - -**Example velocity:** - -- Junior dev + AI: 1-2 epics/week (8-15 stories) -- Mid-level dev + AI: 2-3 epics/week (15-25 stories) -- Senior dev + AI: 3-5 epics/week (25-40 stories) - ---- - -## Common Scenarios - -### Scenario 1: Startup (2 Developers) - -**Project:** SaaS MVP (Level 3) - -**Distribution:** - -``` -Developer A: -โ”œโ”€ Epic 1: Authentication (3 days) -โ”œโ”€ Epic 3: Payment Integration (2 days) -โ””โ”€ Epic 5: Admin Dashboard (3 days) - -Developer B: -โ”œโ”€ Epic 2: Core Product Features (4 days) -โ”œโ”€ Epic 4: Analytics (3 days) -โ””โ”€ Epic 6: Notifications (2 days) - -Total: ~2 weeks -Traditional estimate: 3-4 months -``` - -**BMM Setup:** Direct installation, both use Claude Code, minimal customization - -### Scenario 2: Mid-Size Team (8 Developers) - -**Project:** Enterprise Platform (Level 4) - -**Distribution (Layer-Based):** - -``` -Backend (2 devs): 6 API epics -Frontend (2 devs): 6 UI epics -Full-stack (2 devs): 4 integration epics -DevOps (1 dev): 3 infrastructure epics -QA (1 dev): 1 E2E testing epic - -Total: ~3 weeks -Traditional estimate: 9-12 months -``` - -**BMM Setup:** Git submodule, team config repo, mix of Claude Code/Cursor users - -### Scenario 3: Large Enterprise (50+ Developers) - -**Project:** Multi-Product Platform - -**Organization:** - -- 5 product teams (8-10 devs each) -- 1 platform team (10 devs - shared services) -- 1 infrastructure team (5 devs) - -**Distribution (Feature-Based):** - -``` -Product Team A: Payments (10 epics, 2 weeks) -Product Team B: User Mgmt (12 epics, 2 weeks) -Product Team C: Analytics (8 epics, 1.5 weeks) -Product Team D: Admin Tools (10 epics, 2 weeks) -Product Team E: Mobile (15 epics, 3 weeks) - -Platform Team: Shared Services (continuous) -Infrastructure Team: DevOps (continuous) - -Total: 3-4 months -Traditional estimate: 2-3 years -``` - -**BMM Setup:** Each team has own submodule config, org-wide base config, variety of IDE tools - ---- - -## Summary - -### Key Transformation - -**Work Unit Changed:** - -- **Old:** Story = unit of work assignment -- **New:** Epic = unit of work assignment - -**Why:** AI agents collapse story duration (days โ†’ hours), making epic ownership practical. - -### Velocity Impact - -- **Traditional:** Months for epic delivery, heavy coordination -- **Agentic:** Days for epic delivery, minimal coordination -- **Result:** 10-50ร— productivity gains - -### PM/UX Evolution - -**BMad Method enables:** - -- PMs to write AI-executable PRDs -- UX designers to validate through working prototypes -- Technical fluency without CS degrees -- Orchestration of cloud AI agent teams -- Career evolution to Full-Stack Product Lead - -### Enterprise Adoption - -**Git submodules:** Best practice for BMM management across teams -**Team flexibility:** Mix of tools (Claude Code, Cursor, Windsurf) with shared BMM foundation -**Scalable patterns:** Epic-based, layer-based, feature-based distribution strategies - -### The Future (2026) - -PMs write BMad PRDs โ†’ Stories auto-fed to cloud AI agents โ†’ Parallel implementation โ†’ Human review of PRs โ†’ Continuous deployment - -**The future isn't AI replacing PMsโ€”it's AI-augmented PMs becoming 10ร— more powerful.** - ---- - -## Related Documentation - -- [FAQ](./faq.md) - Common questions -- [Scale Adaptive System](./scale-adaptive-system.md) - Project levels explained -- [Quick Start Guide](./quick-start.md) - Getting started -- [Workflow Documentation](./README.md#-workflow-guides) - Complete workflow reference -- [Agents Guide](./agents-guide.md) - Understanding BMad agents - ---- - -_BMad Method fundamentally changes how PMs work, how teams structure work, and how products get built. Understanding these patterns is essential for enterprise success in the age of AI agents._ diff --git a/.bmad/bmm/docs/faq.md b/.bmad/bmm/docs/faq.md deleted file mode 100644 index 2eff84d9..00000000 --- a/.bmad/bmm/docs/faq.md +++ /dev/null @@ -1,587 +0,0 @@ -# BMM Frequently Asked Questions - -Quick answers to common questions about the BMad Method Module. - ---- - -## Table of Contents - -- [Getting Started](#getting-started) -- [Choosing the Right Level](#choosing-the-right-level) -- [Workflows and Phases](#workflows-and-phases) -- [Planning Documents](#planning-documents) -- [Implementation](#implementation) -- [Brownfield Development](#brownfield-development) -- [Tools and Technical](#tools-and-technical) - ---- - -## Getting Started - -### Q: Do I always need to run workflow-init? - -**A:** No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it: - -- Determines your project's appropriate level automatically -- Creates the tracking status file -- Routes you to the correct starting workflow - -For experienced users: use the [Quick Reference](./quick-start.md#quick-reference-agent-document-mapping) to go directly to the right agent/workflow. - -### Q: Why do I need fresh chats for each workflow? - -**A:** Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for: - -- Planning workflows (PRD, architecture) -- Analysis workflows (brainstorming, research) -- Complex story implementation - -Quick workflows like status checks can reuse chats safely. - -### Q: Can I skip workflow-status and just start working? - -**A:** Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for: - -- New projects (guides initial setup) -- When you're unsure what to do next -- After breaks in work (reminds you where you left off) -- Checking overall progress - -### Q: What's the minimum I need to get started? - -**A:** For the fastest path: - -1. Install BMad Method: `npx bmad-method@alpha install` -2. For small changes: Load PM agent โ†’ run tech-spec โ†’ implement -3. For larger projects: Load PM agent โ†’ run prd โ†’ architect โ†’ implement - -### Q: How do I know if I'm in Phase 1, 2, 3, or 4? - -**A:** Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on: - -- **Phase 1** - Brainstorming, research, product brief (optional) -- **Phase 2** - Creating either a PRD or tech-spec (always required) -- **Phase 3** - Architecture design (Level 2-4 only) -- **Phase 4** - Actually writing code, implementing stories - ---- - -## Choosing the Right Level - -### Q: How do I know which level my project is? - -**A:** Use workflow-init for automatic detection, or self-assess using these keywords: - -- **Level 0:** "fix", "bug", "typo", "small change", "patch" โ†’ 1 story -- **Level 1:** "simple", "basic", "small feature", "add" โ†’ 2-10 stories -- **Level 2:** "dashboard", "several features", "admin panel" โ†’ 5-15 stories -- **Level 3:** "platform", "integration", "complex", "system" โ†’ 12-40 stories -- **Level 4:** "enterprise", "multi-tenant", "multiple products" โ†’ 40+ stories - -When in doubt, start smaller. You can always run create-prd later if needed. - -### Q: Can I change levels mid-project? - -**A:** Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible - your initial level choice isn't permanent. - -### Q: What if workflow-init suggests the wrong level? - -**A:** You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment. - -### Q: Do I always need architecture for Level 2? - -**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD + epic-tech-context created during implementation. - -### Q: What's the difference between Level 1 and Level 2? - -**A:** - -- **Level 1:** 1-10 stories, uses tech-spec (simpler, faster), no architecture -- **Level 2:** 5-15 stories, uses PRD (product-focused), optional architecture - -The overlap (5-10 stories) is intentional. Choose based on: - -- Need product-level planning? โ†’ Level 2 -- Just need technical plan? โ†’ Level 1 -- Multiple epics? โ†’ Level 2 -- Single epic? โ†’ Level 1 - ---- - -## Workflows and Phases - -### Q: What's the difference between workflow-status and workflow-init? - -**A:** - -- **workflow-status:** Checks existing status and tells you what's next (use when continuing work) -- **workflow-init:** Creates new status file and sets up project (use when starting new project) - -If status file exists, use workflow-status. If not, use workflow-init. - -### Q: Can I skip Phase 1 (Analysis)? - -**A:** Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if: - -- Requirements are clear -- No research needed -- Time-sensitive work -- Small changes (Level 0-1) - -### Q: When is Phase 3 (Architecture) required? - -**A:** - -- **Level 0-1:** Never (skip entirely) -- **Level 2:** Optional (only if system design needed) -- **Level 3-4:** Required (comprehensive architecture mandatory) - -### Q: What happens if I skip a recommended workflow? - -**A:** Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause: - -- Integration issues during implementation -- Rework due to poor planning -- Conflicting design decisions -- Longer development time overall - -### Q: How do I know when Phase 3 is complete and I can start Phase 4? - -**A:** For Level 3-4, run the solutioning-gate-check workflow. It validates that PRD, architecture, and UX (if applicable) are cohesive before implementation. Pass the gate check = ready for Phase 4. - -### Q: Can I run workflows in parallel or do they have to be sequential? - -**A:** Most workflows must be sequential within a phase: - -- Phase 1: brainstorm โ†’ research โ†’ product-brief (optional order) -- Phase 2: PRD must complete before moving forward -- Phase 3: architecture โ†’ validate โ†’ gate-check (sequential) -- Phase 4: Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity - ---- - -## Planning Documents - -### Q: What's the difference between tech-spec and epic-tech-context? - -**A:** - -- **Tech-spec (Level 0-1):** Created upfront in Planning Phase, serves as primary/only planning document, a combination of enough technical and planning information to drive a single or multiple files -- **Epic-tech-context (Level 2-4):** Created during Implementation Phase per epic, supplements PRD + Architecture - -Think of it as: tech-spec is for small projects (replaces PRD and architecture), epic-tech-context is for large projects (supplements PRD). - -### Q: Why no tech-spec at Level 2+? - -**A:** Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses: - -- PRD (product vision, requirements, epics) -- Architecture (system design) -- Epic-tech-context (detailed implementation per epic, created just-in-time) - -### Q: When do I create epic-tech-context? - -**A:** In Phase 4, right before implementing each epic. Don't create all epic-tech-context upfront - that's over-planning. Create them just-in-time using the epic-tech-context workflow as you're about to start working on that epic. - -**Why just-in-time?** You'll learn from earlier epics, and those learnings improve later epic-tech-context. - -### Q: Do I need a PRD for a bug fix? - -**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow: - -- Load PM agent -- Run tech-spec workflow -- Implement immediately - -PRDs are for Level 2-4 projects with multiple features requiring product-level coordination. - -### Q: Can I skip the product brief? - -**A:** Yes, product brief is always optional. It's most valuable for: - -- Level 3-4 projects needing strategic direction -- Projects with stakeholders requiring alignment -- Novel products needing market research -- When you want to explore solution space before committing - ---- - -## Implementation - -### Q: Do I need story-context for every story? - -**A:** Technically no, but it's recommended. story-context provides implementation-specific guidance, references existing patterns, and injects expertise. Skip it only if: - -- Very simple story (self-explanatory) -- You're already expert in the area -- Time is extremely limited - -For Level 0-1 using tech-spec, story-context is less critical because tech-spec is already comprehensive. - -### Q: What if I don't create epic-tech-context before drafting stories? - -**A:** You can proceed without it, but you'll miss: - -- Epic-level technical direction -- Architecture guidance for this epic -- Integration strategy with other epics -- Common patterns to follow across stories - -epic-tech-context helps ensure stories within an epic are cohesive. - -### Q: How do I mark a story as done? - -**A:** You have two options: - -**Option 1: Use story-done workflow (Recommended)** - -1. Load SM agent -2. Run `story-done` workflow -3. Workflow automatically updates `sprint-status.yaml` (created by sprint-planning at Phase 4 start) -4. Moves story from current status โ†’ `DONE` -5. Advances the story queue - -**Option 2: Manual update** - -1. After dev-story completes and code-review passes -2. Open `sprint-status.yaml` (created by sprint-planning) -3. Change the story status from `review` to `done` -4. Save the file - -The story-done workflow is faster and ensures proper status file updates. - -### Q: Can I work on multiple stories at once? - -**A:** Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other. - -### Q: What if my story takes longer than estimated? - -**A:** That's normal! Stories are estimates. If implementation reveals more complexity: - -1. Continue working until DoD is met -2. Consider if story should be split -3. Document learnings in retrospective -4. Adjust future estimates based on this learning - -### Q: When should I run retrospective? - -**A:** After completing all stories in an epic (when epic is done). Retrospectives capture: - -- What went well -- What could improve -- Technical insights -- Input for next epic-tech-context - -Don't wait until project end - run after each epic for continuous improvement. - ---- - -## Brownfield Development - -### Q: What is brownfield vs greenfield? - -**A:** - -- **Greenfield:** New project, starting from scratch, clean slate -- **Brownfield:** Existing project, working with established codebase and patterns - -### Q: Do I have to run document-project for brownfield? - -**A:** Highly recommended, especially if: - -- No existing documentation -- Documentation is outdated -- AI agents need context about existing code -- Level 2-4 complexity - -You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`. - -### Q: What if I forget to run document-project on brownfield? - -**A:** Workflows will lack context about existing code. You may get: - -- Suggestions that don't match existing patterns -- Integration approaches that miss existing APIs -- Architecture that conflicts with current structure - -Run document-project and restart planning with proper context. - -### Q: Can I use Quick Spec Flow for brownfield projects? - -**A:** Yes! Quick Spec Flow works great for brownfield. It will: - -- Auto-detect your existing stack -- Analyze brownfield code patterns -- Detect conventions and ask for confirmation -- Generate context-rich tech-spec that respects existing code - -Perfect for bug fixes and small features in existing codebases. - -### Q: How does workflow-init handle brownfield with old planning docs? - -**A:** workflow-init asks about YOUR current work first, then uses old artifacts as context: - -1. Shows what it found (old PRD, epics, etc.) -2. Asks: "Is this work in progress, previous effort, or proposed work?" -3. If previous effort: Asks you to describe your NEW work -4. Determines level based on YOUR work, not old artifacts - -This prevents old Level 3 PRDs from forcing Level 3 workflow for new Level 0 bug fix. - -### Q: What if my existing code doesn't follow best practices? - -**A:** Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide: - -- **Yes** โ†’ Maintain consistency with current codebase -- **No** โ†’ Establish new standards (document why in tech-spec) - -BMM respects your choice - it won't force modernization, but it will offer it. - ---- - -## Tools and Technical - -### Q: Why are my Mermaid diagrams not rendering? - -**A:** Common issues: - -1. Missing language tag: Use ` ```mermaid` not just ` ``` ` -2. Syntax errors in diagram (validate at mermaid.live) -3. Tool doesn't support Mermaid (check your Markdown renderer) - -All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs. - -### Q: Can I use BMM with GitHub Copilot / Cursor / other AI tools? - -**A:** Yes! BMM is complementary. BMM handles: - -- Project planning and structure -- Workflow orchestration -- Agent Personas and expertise -- Documentation generation -- Quality gates - -Your AI coding assistant handles: - -- Line-by-line code completion -- Quick refactoring -- Test generation - -Use them together for best results. - -### Q: What IDEs/tools support BMM? - -**A:** BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes. - -**Recommended Tools:** - -- **Claude Code** โญ **Best choice** - - Sonnet 4.5 (excellent workflow following, coding, reasoning) - - Opus (maximum context, complex planning) - - Native agent mode designed for BMM workflows - -- **Cursor** - - Supports Anthropic (Claude) and OpenAI models - - Agent mode with composer - - Good for developers who prefer Cursor's UX - -- **Windsurf** - - Multi-model support - - Agent capabilities - - Suitable for BMM workflows - -**What Matters:** - -1. **Agent mode** - Can load long workflow instructions and maintain context -2. **High-quality LLM** - Models ranked high on SWE-bench (coding benchmarks) -3. **Model selection** - Access to Claude Sonnet 4.5, Opus, or GPT-4o class models -4. **Context capacity** - Can handle large planning documents and codebases - -**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality. - -See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics. - -### Q: Can I customize agents? - -**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `.bmad/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options. - -**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow. - -### Q: What happens to my planning docs after implementation? - -**A:** Keep them! They serve as: - -- Historical record of decisions -- Onboarding material for new team members -- Reference for future enhancements -- Audit trail for compliance - -For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean. - -### Q: Can I use BMM for non-software projects? - -**A:** BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain. - ---- - -## Advanced Questions - -### Q: What if my project grows from Level 1 to Level 3? - -**A:** Totally fine! When you realize scope has grown: - -1. Run create-prd to add product-level planning -2. Run create-architecture for system design -3. Use existing tech-spec as input for PRD -4. Continue with updated level - -The system is flexible - growth is expected. - -### Q: Can I mix greenfield and brownfield approaches? - -**A:** Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach: - -1. Run document-project for brownfield context -2. Use greenfield workflows for new feature planning -3. Explicitly document integration points between new and existing -4. Test integration thoroughly - -### Q: How do I handle urgent hotfixes during a sprint? - -**A:** Use correct-course workflow or just: - -1. Save your current work state -2. Load PM agent โ†’ quick tech-spec for hotfix -3. Implement hotfix (Level 0 flow) -4. Deploy hotfix -5. Return to original sprint work - -Level 0 Quick Spec Flow is perfect for urgent fixes. - -### Q: What if I disagree with the workflow's recommendations? - -**A:** Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context: - -- Explain your reasoning to the agent -- Ask for alternative approaches -- Skip the recommendation if you're confident -- Document why you deviated (for future reference) - -Trust your expertise - BMM supports your decisions. - -### Q: Can multiple developers work on the same BMM project? - -**A:** Yes! But the paradigm is fundamentally different from traditional agile teams. - -**Key Difference:** - -- **Traditional:** Multiple devs work on stories within one epic (months) -- **Agentic:** Each dev owns complete epics (days) - -**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories. - -**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days. - -**Team Work Distribution:** - -- **Recommended:** Split work by **epic** (not story) -- Each developer owns complete epics end-to-end -- Parallel work happens at epic level -- Minimal coordination needed - -**For full-stack apps:** - -- Frontend and backend can be separate epics (unusual in traditional agile) -- Frontend dev owns all frontend epics -- Backend dev owns all backend epics -- Works because delivery is so fast - -**Enterprise Considerations:** - -- Use **git submodules** for BMM installation (not .gitignore) -- Allows personal configurations without polluting main repo -- Teams may use different AI tools (Claude Code, Cursor, etc.) -- Developers may follow different methods or create custom agents/workflows - -**Quick Tips:** - -- Share `sprint-status.yaml` (single source of truth) -- Assign entire epics to developers (not individual stories) -- Coordinate at epic boundaries, not story level -- Use git submodules for BMM in enterprise settings - -**For comprehensive coverage of enterprise team collaboration, work distribution strategies, git submodule setup, and velocity expectations, see:** - -๐Ÿ‘‰ **[Enterprise Agentic Development Guide](./enterprise-agentic-development.md)** - -### Q: What is party mode and when should I use it? - -**A:** Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time. - -**How it works:** - -1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent) -2. Introduce your topic -3. BMad Master selects 2-3 most relevant agents per message -4. Agents cross-talk, debate, and build on each other's ideas - -**Best for:** - -- Strategic decisions with trade-offs (architecture choices, tech stack, scope) -- Creative brainstorming (game design, product innovation, UX ideation) -- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions) -- Complex problem-solving (multi-faceted challenges, risk assessment) - -**Example parties:** - -- **Product Strategy:** PM + Innovation Strategist (CIS) + Analyst -- **Technical Design:** Architect + Creative Problem Solver (CIS) + Game Architect -- **User Experience:** UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) - -**Why it's powerful:** - -- Diverse perspectives (technical, creative, strategic) -- Healthy debate reveals blind spots -- Emergent insights from agent interaction -- Natural collaboration across modules - -**For complete documentation:** - -๐Ÿ‘‰ **[Party Mode Guide](./party-mode.md)** - How it works, when to use it, example compositions, best practices - ---- - -## Getting Help - -### Q: Where do I get help if my question isn't answered here? - -**A:** - -1. Search [Complete Documentation](./README.md) for related topics -2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev) -3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) -4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode) - -### Q: How do I report a bug or request a feature? - -**A:** Open a GitHub issue at: https://github.com/bmad-code-org/BMAD-METHOD/issues - -Please include: - -- BMM version (check your installed version) -- Steps to reproduce (for bugs) -- Expected vs actual behavior -- Relevant workflow or agent involved - ---- - -## Related Documentation - -- [Quick Start Guide](./quick-start.md) - Get started with BMM -- [Glossary](./glossary.md) - Terminology reference -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding levels -- [Brownfield Guide](./brownfield-guide.md) - Existing codebase workflows - ---- - -**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/.bmad/bmm/docs/glossary.md b/.bmad/bmm/docs/glossary.md deleted file mode 100644 index c67ee1c0..00000000 --- a/.bmad/bmm/docs/glossary.md +++ /dev/null @@ -1,320 +0,0 @@ -# BMM Glossary - -Comprehensive terminology reference for the BMad Method Module. - ---- - -## Navigation - -- [Core Concepts](#core-concepts) -- [Scale and Complexity](#scale-and-complexity) -- [Planning Documents](#planning-documents) -- [Workflow and Phases](#workflow-and-phases) -- [Agents and Roles](#agents-and-roles) -- [Status and Tracking](#status-and-tracking) -- [Project Types](#project-types) -- [Implementation Terms](#implementation-terms) - ---- - -## Core Concepts - -### BMM (BMad Method Module) - -Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows. - -### BMad Method - -The complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. - -### Scale-Adaptive System - -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 - -A specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. Agents have defined capabilities, communication styles, and workflow access. - -### Workflow - -A multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. - ---- - -## Scale and Complexity - -### Quick Flow Track - -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. - -### BMad Method Track - -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. - -### Enterprise Method Track - -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. - -### Planning Track - -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. - -**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math. - ---- - -## Planning Documents - -### Tech-Spec (Technical Specification) - -**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-Context (Epic Technical Context) - -**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 (Quick Flow) is created upfront and is the only planning doc. Epic-tech-context (BMad Method/Enterprise) is created per epic during implementation and supplements PRD + Architecture. - -### PRD (Product Requirements Document) - -**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 - -**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 track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies. - -### Epics - -High-level feature groupings that contain multiple related stories. Typically span 5-15 stories each and represent cohesive functionality (e.g., "User Authentication Epic"). - -### Product Brief - -Optional strategic planning document created in Phase 1 (Analysis) that captures product vision, market context, user needs, and high-level requirements before detailed planning. - -### GDD (Game Design Document) - -Game development equivalent of PRD, created by Game Designer agent for game projects. - ---- - -## Workflow and Phases - -### Phase 0: Documentation (Prerequisite) - -**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents. - -### Phase 1: Analysis (Optional) - -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 (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track. - -### Phase 3: Solutioning (Track-Dependent) - -Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks. - -### Phase 4: Implementation (Required) - -Sprint-based development through story-by-story iteration. Uses sprint-planning, epic-tech-context, create-story, story-context, dev-story, code-review, and retrospective workflows. - -### Quick Spec Flow - -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 - -Pattern where epic-tech-context is created during implementation (Phase 4) right before working on each epic, rather than all upfront. Enables learning and adaptation. - -### Context Injection - -Dynamic technical guidance generated for each story via epic-tech-context and story-context workflows, providing exact expertise when needed without upfront over-planning. - ---- - -## Agents and Roles - -### PM (Product Manager) - -Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning. - -### Analyst (Business Analyst) - -Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. - -### Architect - -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 implementation. - -### DEV (Developer) - -Agent that implements stories, writes code, runs tests, and performs code reviews. Primary implementer in Phase 4. - -### TEA (Test Architect) - -Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases. - -### Technical Writer - -Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing. The agent's internal name is "paige" but is presented as "Technical Writer" to users. - -### UX Designer - -Agent that creates UX design documents, interaction patterns, and visual specifications for UI-heavy projects. - -### Game Designer - -Specialized agent for game development projects. Creates game design documents (GDD) and game-specific workflows. - -### BMad Master - -Meta-level orchestrator agent from BMad Core. Facilitates party mode, lists available tasks and workflows, and provides high-level guidance across all modules. - -### Party Mode - -Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS, BMB, custom modules) discuss challenges together in real-time. BMad Master orchestrates, selecting 2-3 relevant agents per message for natural cross-talk and debate. Best for strategic decisions, creative brainstorming, cross-functional alignment, and complex problem-solving. See [Party Mode Guide](./party-mode.md). - ---- - -## Status and Tracking - -### bmm-workflow-status.yaml - -**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 - -**Phase 4 only.** Single source of truth for implementation tracking. Contains all epics, stories, and retrospectives with current status for each. Created by sprint-planning, updated by agents. - -### Story Status Progression - -``` -backlog โ†’ drafted โ†’ ready-for-dev โ†’ in-progress โ†’ review โ†’ done -``` - -- **backlog** - Story exists in epic but not yet drafted -- **drafted** - Story file created by SM via create-story -- **ready-for-dev** - Story has context, ready for DEV via story-context -- **in-progress** - DEV is implementing via dev-story -- **review** - Implementation complete, awaiting code-review -- **done** - Completed with DoD met - -### Epic Status Progression - -``` -backlog โ†’ contexted -``` - -- **backlog** - Epic exists in planning docs but no context yet -- **contexted** - Epic has technical context via epic-tech-context - -### Retrospective - -Workflow run after completing each epic to capture learnings, identify improvements, and feed insights into next epic planning. Critical for continuous improvement. - ---- - -## Project Types - -### Greenfield - -New project starting from scratch with no existing codebase. Freedom to establish patterns, choose stack, and design from clean slate. - -### Brownfield - -Existing project with established codebase, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems. - -**Critical:** Brownfield projects should run document-project workflow BEFORE planning to ensure AI agents have adequate context about existing code. - -### document-project Workflow - -**Brownfield prerequisite.** Analyzes and documents existing codebase, creating comprehensive documentation including project overview, architecture analysis, source tree, API contracts, and data models. Three scan levels: quick, deep, exhaustive. - ---- - -## Implementation Terms - -### Story - -Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of development effort. Stories are grouped into epics and tracked in sprint-status.yaml. - -### Story File - -Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements. - -### Story Context - -Technical guidance document created via story-context workflow that provides implementation-specific context, references existing patterns, suggests approaches, and injects expertise for the specific story. - -### Epic Context - -Technical planning document created via epic-tech-context workflow before drafting stories within an epic. Provides epic-level technical direction, architecture notes, and implementation strategy. - -### Sprint Planning - -Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, extracting all epics/stories from planning docs, and setting up tracking infrastructure. - -### 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 BMad Method and Enterprise Method tracks. - -### DoD (Definition of Done) - -Criteria that must be met before marking a story as done. Typically includes: implementation complete, tests written and passing, code reviewed, documentation updated, and acceptance criteria validated. - -### Shard / Sharding - -**For runtime LLM optimization only (NOT human docs).** Splitting large planning documents (PRD, epics, architecture) into smaller section-based files to improve workflow efficiency. Phase 1-3 workflows load entire sharded documents transparently. Phase 4 workflows selectively load only needed sections for massive token savings. - ---- - -## Additional Terms - -### Workflow Status - -Universal entry point workflow that checks for existing status file, displays current phase/progress, and recommends next action based on project state. - -### Workflow Init - -Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path. - -### Track Selection - -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 - -Workflow run during Phase 4 when significant changes or issues arise. Analyzes impact, proposes solutions, and routes to appropriate remediation workflows. - -### Migration Strategy - -Plan for handling changes to existing data, schemas, APIs, or patterns during brownfield development. Critical for ensuring backward compatibility and smooth rollout. - -### Feature Flags - -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 - -Specific locations where new code connects with existing systems. Must be documented explicitly in brownfield tech-specs and architectures. - -### Convention Detection - -Quick Spec Flow feature that automatically detects existing code style, naming conventions, patterns, and frameworks from brownfield codebases, then asks user to confirm before proceeding. - ---- - -## Related Documentation - -- [Quick Start Guide](./quick-start.md) - Learn BMM basics -- [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 Quick Flow track -- [FAQ](./faq.md) - Common questions diff --git a/.bmad/bmm/docs/party-mode.md b/.bmad/bmm/docs/party-mode.md deleted file mode 100644 index 277c4981..00000000 --- a/.bmad/bmm/docs/party-mode.md +++ /dev/null @@ -1,224 +0,0 @@ -# Party Mode: Multi-Agent Collaboration - -**Get all your AI agents in one conversation** - ---- - -## What is Party Mode? - -Ever wanted to gather your entire AI team in one room and see what happens? That's party mode. - -Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer, the CIS creative agents - everyone shows up. - -**Why it's useful:** - -- **After complex workflows** - Debrief with the whole team about what worked, what didn't -- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously -- **Brainstorming sessions** - Watch ideas evolve through cross-pollination -- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic) -- **Sprint retrospectives** - Party mode powers the retrospective workflow -- **Sprint planning** - Multi-agent collaboration for planning sessions - -**Future use:** Advanced elicitation workflows will leverage party mode for sophisticated requirement gathering. - ---- - -## How It Works - -**The basics:** - -1. Party mode reads `.bmad/_cfg/agent-manifest.csv` -2. Loads ALL installed agents (already includes your customizations from install) -3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic -4. Agents respond in character, can agree/disagree/build on each other's ideas -5. Discussion continues until you type "exit" or reach natural conclusion - -**That's it.** No complex merging, no runtime magic. Just agents talking. - ---- - -## Quick Start - -```bash -# Trigger party mode -/bmad:core:workflows:party-mode - -# OR from any agent context -*party-mode - -# During party -Ask questions, respond to agents, direct the conversation - -# Exit -Type: exit -``` - ---- - -## Fun Examples - -### Example 1: Calling Out Bad Architecture - -**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?" - -**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..." - -**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions." - -**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it." - -**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation." - -_(Watch them debate whose fault it really was - it's therapeutic)_ - ---- - -### Example 2: Creative Brainstorming - -**You:** "How do we make onboarding feel magical instead of boring?" - -**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial." - -**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero." - -**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges." - -**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable." - -_(Ideas cross-pollinate and evolve)_ - ---- - -### Example 3: Technical Decision - -**You:** "Monolith or microservices for MVP?" - -**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users." - -**PM:** "Agree. Time to market matters more than theoretical scalability." - -**DEV:** "Monolith with clear module boundaries. We can extract services later if needed." - -**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right." - -_(Multiple perspectives reveal the right answer)_ - ---- - -## When NOT to Use Party Mode - -**Skip party mode for:** - -- Simple implementation questions โ†’ Use DEV agent -- Document review โ†’ Use Technical Writer -- Workflow status checks โ†’ Use any agent + `*workflow-status` -- Single-domain questions โ†’ Use specialist agent - -**Use party mode for:** - -- Multi-perspective decisions -- Creative collaboration -- Post-mortems and retrospectives -- Sprint planning sessions -- Complex problem-solving - ---- - -## Agent Customization - -Party mode uses agents from `.bmad/[module]/agents/*.md` - these already include any customizations you applied during install. - -**To customize agents for party mode:** - -1. Create customization file: `.bmad/_cfg/agents/bmm-pm.customize.yaml` -2. Run `npx bmad-method install` to rebuild agents -3. Customizations now active in party mode - -Example customization: - -```yaml -agent: - persona: - principles: - - 'HIPAA compliance is non-negotiable' - - 'Patient safety over feature velocity' -``` - -See [Agents Guide](./agents-guide.md#agent-customization) for details. - ---- - -## BMM Workflows That Use Party Mode - -**Current:** - -- `epic-retrospective` - Post-epic team retrospective powered by party mode -- Sprint planning discussions (informal party mode usage) - -**Future:** - -- Advanced elicitation workflows will officially integrate party mode -- Multi-agent requirement validation -- Collaborative technical reviews - ---- - -## Available Agents - -Party mode can include **19+ agents** from all installed modules: - -**BMM (12 agents):** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer, Game Designer, Game Developer, Game Architect - -**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller - -**BMB (1 agent):** BMad Builder - -**Core (1 agent):** BMad Master (orchestrator) - -**Custom:** Any agents you've created - ---- - -## Tips - -**Get better results:** - -- Be specific with your topic/question -- Provide context (project type, constraints, goals) -- Direct specific agents when you want their expertise -- Make decisions - party mode informs, you decide -- Time box discussions (15-30 minutes is usually plenty) - -**Examples of good opening questions:** - -- "We need to decide between REST and GraphQL for our mobile API. Project is a B2B SaaS with 50 enterprise clients." -- "Our last sprint failed spectacularly. Let's discuss what went wrong with authentication implementation." -- "Brainstorm: how can we make our game's tutorial feel rewarding instead of tedious?" - ---- - -## Troubleshooting - -**Same agents responding every time?** -Vary your questions or explicitly request other perspectives: "Game Designer, your thoughts?" - -**Discussion going in circles?** -BMad Master will summarize and redirect, or you can make a decision and move on. - -**Too many agents talking?** -Make your topic more specific - BMad Master picks 2-3 agents based on relevance. - -**Agents not using customizations?** -Make sure you ran `npx bmad-method install` after creating customization files. - ---- - -## Related Documentation - -- [Agents Guide](./agents-guide.md) - Complete agent reference -- [Quick Start Guide](./quick-start.md) - Getting started with BMM -- [FAQ](./faq.md) - Common questions - ---- - -_Better decisions through diverse perspectives. Welcome to party mode._ diff --git a/.bmad/bmm/docs/quick-spec-flow.md b/.bmad/bmm/docs/quick-spec-flow.md deleted file mode 100644 index 3fd2b2f8..00000000 --- a/.bmad/bmm/docs/quick-spec-flow.md +++ /dev/null @@ -1,652 +0,0 @@ -# BMad Quick Spec Flow - -**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements - -**Time to implementation:** Minutes, not hours - ---- - -## What is Quick Spec Flow? - -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 Flow track when:** - -- 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 BMad Method or Enterprise tracks when:** - -- 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 needs! - ---- - -## Quick Spec Flow Overview - -```mermaid -flowchart TD - START[Step 1: Run Tech-Spec Workflow] - DETECT[Detects project stack
package.json, requirements.txt, etc.] - ANALYZE[Analyzes brownfield codebase
if exists] - TEST[Detects test frameworks
and conventions] - CONFIRM[Confirms conventions
with you] - GENERATE[Generates context-rich
tech-spec] - STORIES[Creates ready-to-implement
stories] - - OPTIONAL[Step 2: Optional
Generate Story Context
SM Agent
For complex scenarios only] - - IMPL[Step 3: Implement
DEV Agent
Code, test, commit] - - DONE[DONE! ๐Ÿš€] - - START --> DETECT - DETECT --> ANALYZE - ANALYZE --> TEST - TEST --> CONFIRM - CONFIRM --> GENERATE - GENERATE --> STORIES - STORIES --> OPTIONAL - OPTIONAL -.->|Optional| IMPL - STORIES --> IMPL - IMPL --> DONE - - style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style OPTIONAL fill:#ffb,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5,color:#000 - style IMPL fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style DONE fill:#f9f,stroke:#333,stroke-width:3px,color:#000 -``` - ---- - -## Single Atomic Change - -**Best for:** Bug fixes, single file changes, isolated improvements - -### What You Get - -1. **tech-spec.md** - Comprehensive technical specification with: - - Problem statement and solution - - Detected framework versions and dependencies - - Brownfield code patterns (if applicable) - - Existing test patterns to follow - - Specific file paths to modify - - Complete implementation guidance - -2. **story-[slug].md** - Single user story ready for development - -### Quick Spec Flow Commands - -```bash -# Start Quick Spec Flow (no workflow-init needed!) -# Load PM agent and run tech-spec - -# When complete, implement directly: -# Load DEV agent and run dev-story -``` - -### What Makes It Quick - -- โœ… No Product Brief needed -- โœ… No PRD needed -- โœ… No Architecture doc needed -- โœ… Auto-detects your stack -- โœ… Auto-analyzes brownfield code -- โœ… Auto-validates quality -- โœ… Story context optional (tech-spec is comprehensive!) - -### Example Single Change Scenarios - -- "Fix the login validation bug" -- "Add email field to user registration form" -- "Update API endpoint to return additional field" -- "Improve error handling in payment processing" - ---- - -## Coherent Small Feature - -**Best for:** Small features with 2-3 related user stories - -### What You Get - -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 -5. **story-[epic-slug]-3.md** - Third story (if needed) - -### Quick Spec Flow Commands - -```bash -# Start Quick Spec Flow -# Load PM agent and run tech-spec - -# Optional: Organize stories as a sprint -# Load SM agent and run sprint-planning - -# Implement story-by-story: -# Load DEV agent and run dev-story for each story -``` - -### Story Sequencing - -Stories are **automatically validated** to ensure proper sequence: - -- โœ… No forward dependencies (Story 2 can't depend on Story 3) -- โœ… Clear dependency documentation -- โœ… Infrastructure โ†’ Features โ†’ Polish order -- โœ… Backend โ†’ Frontend flow - -### Example Small Feature Scenarios - -- "Add OAuth social login (Google, GitHub, Twitter)" -- "Build user profile page with avatar upload" -- "Implement basic search with filters" -- "Add dark mode toggle to application" - ---- - -## Smart Context Discovery - -Quick Spec Flow automatically discovers and uses: - -### 1. Existing Documentation - -- Product briefs (if they exist) -- Research documents -- `document-project` output (brownfield codebase map) - -### 2. Project Stack - -- **Node.js:** package.json โ†’ frameworks, dependencies, scripts, test framework -- **Python:** requirements.txt, pyproject.toml โ†’ packages, tools -- **Ruby:** Gemfile โ†’ gems and versions -- **Java:** pom.xml, build.gradle โ†’ Maven/Gradle dependencies -- **Go:** go.mod โ†’ modules -- **Rust:** Cargo.toml โ†’ crates -- **PHP:** composer.json โ†’ packages - -### 3. Brownfield Code Patterns - -- Directory structure and organization -- Existing code patterns (class-based, functional, MVC) -- Naming conventions (camelCase, snake_case, PascalCase) -- Test frameworks and patterns -- Code style (semicolons, quotes, indentation) -- Linter/formatter configs -- Error handling patterns -- Logging conventions -- Documentation style - -### 4. Convention Confirmation - -**IMPORTANT:** Quick Spec Flow detects your conventions and **asks for confirmation**: - -``` -I've detected these conventions in your codebase: - -Code Style: -- ESLint with Airbnb config -- Prettier with single quotes, 2-space indent -- No semicolons - -Test Patterns: -- Jest test framework -- .test.js file naming -- expect() assertion style - -Should I follow these existing conventions? (yes/no) -``` - -**You decide:** Conform to existing patterns or establish new standards! - ---- - -## Modern Best Practices via WebSearch - -Quick Spec Flow stays current by using WebSearch when appropriate: - -### For Greenfield Projects - -- Searches for latest framework versions -- Recommends official starter templates -- Suggests modern best practices - -### For Outdated Dependencies - -- Detects if your dependencies are >2 years old -- Searches for migration guides -- Notes upgrade complexity - -### Starter Template Recommendations - -For greenfield projects, Quick Spec Flow recommends: - -**React:** - -- Vite (modern, fast) -- Next.js (full-stack) - -**Python:** - -- cookiecutter templates -- FastAPI starter - -**Node.js:** - -- NestJS CLI -- express-generator - -**Benefits:** - -- โœ… Modern best practices baked in -- โœ… Proper project structure -- โœ… Build tooling configured -- โœ… Testing framework set up -- โœ… Faster time to first feature - ---- - -## UX/UI Considerations - -For user-facing changes, Quick Spec Flow captures: - -- UI components affected (create vs modify) -- UX flow changes (current vs new) -- Responsive design needs (mobile, tablet, desktop) -- Accessibility requirements: - - Keyboard navigation - - Screen reader compatibility - - ARIA labels - - Color contrast standards -- User feedback patterns: - - Loading states - - Error messages - - Success confirmations - - Progress indicators - ---- - -## Auto-Validation and Quality Assurance - -Quick Spec Flow **automatically validates** everything: - -### Tech-Spec Validation (Always Runs) - -Checks: - -- โœ… Context gathering completeness -- โœ… Definitiveness (no "use X or Y" statements) -- โœ… Brownfield integration quality -- โœ… Stack alignment -- โœ… Implementation readiness - -Generates scores: - -``` -โœ… Validation Passed! -- Context Gathering: Comprehensive -- Definitiveness: All definitive -- Brownfield Integration: Excellent -- Stack Alignment: Perfect -- Implementation Readiness: โœ… Ready -``` - -### Story Validation (Multi-Story Features) - -Checks: - -- โœ… Story sequence (no forward dependencies!) -- โœ… Acceptance criteria quality (specific, testable) -- โœ… Completeness (all tech spec tasks covered) -- โœ… Clear dependency documentation - -**Auto-fixes issues if found!** - ---- - -## Complete User Journey - -### Scenario 1: Bug Fix (Single Change) - -**Goal:** Fix login validation bug - -**Steps:** - -1. **Start:** Load PM agent, say "I want to fix the login validation bug" -2. **PM runs tech-spec workflow:** - - Asks: "What problem are you solving?" - - You explain the validation issue - - Detects your Node.js stack (Express 4.18.2, Jest for testing) - - Analyzes existing UserService code patterns - - Asks: "Should I follow your existing conventions?" โ†’ You say yes - - Generates tech-spec.md with specific file paths and patterns - - Creates story-login-fix.md -3. **Implement:** Load DEV agent, run `dev-story` - - DEV reads tech-spec (has all context!) - - Implements fix following existing patterns - - Runs tests (following existing Jest patterns) - - Done! - -**Total time:** 15-30 minutes (mostly implementation) - ---- - -### Scenario 2: Small Feature (Multi-Story) - -**Goal:** Add OAuth social login (Google, GitHub) - -**Steps:** - -1. **Start:** Load PM agent, say "I want to add OAuth social login" -2. **PM runs tech-spec workflow:** - - Asks about the feature scope - - You specify: Google and GitHub OAuth - - Detects your stack (Next.js 13.4, NextAuth.js already installed!) - - Analyzes existing auth patterns - - Confirms conventions with you - - Generates: - - tech-spec.md (comprehensive implementation guide) - - epics.md (OAuth Integration epic) - - story-oauth-1.md (Backend OAuth setup) - - story-oauth-2.md (Frontend login buttons) -3. **Optional Sprint Planning:** Load SM agent, run `sprint-planning` -4. **Implement Story 1:** - - Load DEV agent, run `dev-story` for story 1 - - DEV implements backend OAuth -5. **Implement Story 2:** - - DEV agent, run `dev-story` for story 2 - - DEV implements frontend - - Done! - -**Total time:** 1-3 hours (mostly implementation) - ---- - -## Integration with Phase 4 Workflows - -Quick Spec Flow works seamlessly with all Phase 4 implementation workflows: - -### story-context (SM Agent) - -- โœ… Recognizes tech-spec.md as authoritative source -- โœ… Extracts context from tech-spec (replaces PRD) -- โœ… Generates XML context for complex scenarios - -### create-story (SM Agent) - -- โœ… Can work with tech-spec.md instead of PRD -- โœ… Uses epics.md from tech-spec workflow -- โœ… Creates additional stories if needed - -### sprint-planning (SM Agent) - -- โœ… Works with epics.md from tech-spec -- โœ… Organizes multi-story features for coordinated implementation -- โœ… Tracks progress through sprint-status.yaml - -### dev-story (DEV Agent) - -- โœ… Reads stories generated by tech-spec -- โœ… Uses tech-spec.md as comprehensive context -- โœ… Implements following detected conventions - ---- - -## Comparison: Quick Spec vs Full BMM - -| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks | -| --------------------- | ---------------------------- | ---------------------------------- | -| **Setup** | None (standalone) | workflow-init recommended | -| **Planning Docs** | tech-spec.md only | Product Brief โ†’ PRD โ†’ Architecture | -| **Time to Code** | Minutes | Hours to days | -| **Best For** | Bug fixes, small features | New products, major features | -| **Context Discovery** | Automatic | Manual + guided | -| **Story Context** | Optional (tech-spec is rich) | Required (generated from PRD) | -| **Validation** | Auto-validates everything | Manual validation steps | -| **Brownfield** | Auto-analyzes and conforms | Manual documentation required | -| **Conventions** | Auto-detects and confirms | Document in PRD/Architecture | - ---- - -## When to Graduate from Quick Flow to BMad Method - -Start with Quick Flow, but switch to BMad Method when: - -- โŒ 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 Flow to BMad Method! - ---- - -## Quick Spec Flow - Key Benefits - -### ๐Ÿš€ **Speed** - -- No Product Brief -- No PRD -- No Architecture doc -- Straight to implementation - -### ๐Ÿง  **Intelligence** - -- Auto-detects stack -- Auto-analyzes brownfield -- Auto-validates quality -- WebSearch for current info - -### ๐Ÿ“ **Respect for Existing Code** - -- Detects conventions -- Asks for confirmation -- Follows patterns -- Adapts vs. changes - -### โœ… **Quality** - -- Auto-validation -- Definitive decisions (no "or" statements) -- Comprehensive context -- Clear acceptance criteria - -### ๐ŸŽฏ **Focus** - -- Single atomic changes -- Coherent small features -- No scope creep -- Fast iteration - ---- - -## Getting Started - -### Prerequisites - -- BMad Method installed (`npx bmad-method install`) -- Project directory with code (or empty for greenfield) - -### Quick Start Commands - -```bash -# For a quick bug fix or small change: -# 1. Load PM agent -# 2. Say: "I want to [describe your change]" -# 3. PM will ask if you want to run tech-spec -# 4. Answer questions about your change -# 5. Get tech-spec + story -# 6. Load DEV agent and implement! - -# For a small feature with multiple stories: -# Same as above, but get epic + 2-3 stories -# Optionally use SM sprint-planning to organize -``` - -### No workflow-init Required! - -Quick Spec Flow is **fully standalone**: - -- 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 - ---- - -## FAQ - -### Q: Can I use Quick Spec Flow on an existing project? - -**A:** Yes! It's perfect for brownfield projects. It will analyze your existing code, detect patterns, and ask if you want to follow them. - -### Q: What if I don't have a package.json or requirements.txt? - -**A:** Quick Spec Flow will work in greenfield mode, recommend starter templates, and use WebSearch for modern best practices. - -### Q: Do I need to run workflow-init first? - -**A:** No! Quick Spec Flow is standalone. But if you want guidance on which flow to use, workflow-init can help. - -### Q: Can I use this for frontend changes? - -**A:** Absolutely! Quick Spec Flow captures UX/UI considerations, component changes, and accessibility requirements. - -### Q: What if my Quick Flow project grows? - -**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 Quick Flow projects. Only use story-context for complex edge cases. - -### Q: Can I skip validation? - -**A:** No, validation always runs automatically. But it's fast and catches issues early! - -### Q: Will it work with my team's code style? - -**A:** Yes! It detects your conventions and asks for confirmation. You control whether to follow existing patterns or establish new ones. - ---- - -## Tips and Best Practices - -### 1. **Be Specific in Discovery** - -When describing your change, provide specifics: - -- โœ… "Fix email validation in UserService to allow plus-addressing" -- โŒ "Fix validation bug" - -### 2. **Trust the Convention Detection** - -If it detects your patterns correctly, say yes! It's faster than establishing new conventions. - -### 3. **Use WebSearch Recommendations for Greenfield** - -Starter templates save hours of setup time. Let Quick Spec Flow find the best ones. - -### 4. **Review the Auto-Validation** - -When validation runs, read the scores. They tell you if your spec is production-ready. - -### 5. **Story Context is Optional** - -For single changes, try going directly to dev-story first. Only add story-context if you hit complexity. - -### 6. **Keep Single Changes Truly Atomic** - -If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you. - -### 7. **Validate Story Sequence for Multi-Story Features** - -When you get multiple stories, check the dependency validation output. Proper sequence matters! - ---- - -## Real-World Examples - -### Example 1: Adding Logging (Single Change) - -**Input:** "Add structured logging to payment processing" - -**Tech-Spec Output:** - -- Detected: winston 3.8.2 already in package.json -- Analyzed: Existing services use winston with JSON format -- Confirmed: Follow existing logging patterns -- Generated: Specific file paths, log levels, format example -- Story: Ready to implement in 1-2 hours - -**Result:** Consistent logging added, following team patterns, no research needed. - ---- - -### Example 2: Search Feature (Multi-Story) - -**Input:** "Add search to product catalog with filters" - -**Tech-Spec Output:** - -- Detected: React 18.2.0, MUI component library, Express backend -- Analyzed: Existing ProductList component patterns -- Confirmed: Follow existing API and component structure -- Generated: - - Epic: Product Search Functionality - - Story 1: Backend search API with filters - - Story 2: Frontend search UI component -- Auto-validated: Story 1 โ†’ Story 2 sequence correct - -**Result:** Search feature implemented in 4-6 hours with proper architecture. - ---- - -## Summary - -Quick Spec Flow is your **fast path from idea to implementation** for: - -- ๐Ÿ› Bug fixes -- โœจ Small features -- ๐Ÿš€ Rapid prototyping -- ๐Ÿ”ง Quick enhancements - -**Key Features:** - -- Auto-detects your stack -- Auto-analyzes brownfield code -- Auto-validates quality -- Respects existing conventions -- Uses WebSearch for modern practices -- Generates comprehensive tech-specs -- Creates implementation-ready stories - -**Time to code:** Minutes, not hours. - -**Ready to try it?** Load the PM agent and say what you want to build! ๐Ÿš€ - ---- - -## Next Steps - -- **Try it now:** Load PM agent and describe a small change -- **Learn more:** See the [BMM Workflow Guides](./README.md#-workflow-guides) for comprehensive workflow documentation -- **Need help deciding?** Run `workflow-init` to get a recommendation -- **Have questions?** Join us on Discord: https://discord.gg/gk8jAdXWmj - ---- - -_Quick Spec Flow - Because not every change needs a Product Brief._ diff --git a/.bmad/bmm/docs/quick-start.md b/.bmad/bmm/docs/quick-start.md deleted file mode 100644 index 68329c0e..00000000 --- a/.bmad/bmm/docs/quick-start.md +++ /dev/null @@ -1,366 +0,0 @@ -# BMad Method V6 Quick Start Guide - -Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows. - -## TL;DR - The Quick Path - -1. **Install**: `npx bmad-method@alpha install` -2. **Initialize**: Load Analyst agent โ†’ Run "workflow-init" -3. **Plan**: Load PM agent โ†’ Run "prd" (or "tech-spec" for small projects) -4. **Architect**: Load Architect agent โ†’ Run "create-architecture" (10+ stories only) -5. **Build**: Load SM agent โ†’ Run workflows for each story โ†’ Load DEV agent โ†’ Implement -6. **Always use fresh chats** for each workflow to avoid hallucinations - ---- - -## What is BMad Method? - -BMad Method (BMM) helps you build software through guided workflows with specialized AI agents. The process follows four phases: - -1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief -2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD) -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 - -```bash -# Install v6 Alpha to your project -npx bmad-method@alpha install -``` - -The interactive installer will guide you through setup and create a `.bmad/` folder with all agents and workflows. - ---- - -## Getting Started - -### Step 1: Initialize Your Workflow - -1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for how to activate agents: - - [Claude Code](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/ide-info/claude-code.md) - - [VS Code/Cursor/Windsurf](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) - Check your IDE folder - - Other IDEs also supported -2. **Wait for the agent's menu** to appear -3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number - -#### What happens during workflow-init? - -Workflows are interactive processes in V6 that replaced tasks and templates from prior versions. There are many types of workflows, and you can even create your own with the BMad Builder module. For the BMad Method, you'll be interacting with expert-designed workflows crafted to work with you to get the best out of both you and the LLM. - -During workflow-init, you'll describe: - -- Your project and its goals -- Whether there's an existing codebase or this is a new project -- The general size and complexity (you can adjust this later) - -#### Planning Tracks - -Based on your description, the workflow will suggest a track and let you choose from: - -**Three Planning Tracks:** - -- **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 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 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 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 - -After workflow-init completes, you'll work through the planning phases. **Important: Use fresh chats for each workflow to avoid context limitations.** - -#### Checking Your Status - -If you're unsure what to do next: - -1. Load any agent in a new chat -2. Ask for "workflow-status" -3. The agent will tell you the next recommended or required workflow - -**Example response:** - -``` -Phase 1 (Analysis) is entirely optional. All workflows are optional or recommended: - - brainstorm-project - optional - - research - optional - - product-brief - RECOMMENDED (but not required) - -The next TRULY REQUIRED step is: - - PRD (Product Requirements Document) in Phase 2 - Planning - - Agent: pm - - Command: prd -``` - -#### How to Run Workflows in Phases 1-3 - -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](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for your IDE's specific instructions -2. **Wait for the menu** to appear -3. **Tell the agent** to run it using any of these formats: - - Type the shorthand: `*prd` - - Say it naturally: "Let's create a new PRD" - - Select the menu number for "create-prd" - -The agents in V6 are very good with fuzzy menu matching! - -#### Quick Reference: Agent โ†’ Document Mapping - -For v4 users or those who prefer to skip workflow-status guidance: - -- **Analyst** โ†’ Brainstorming, Product Brief -- **PM** โ†’ PRD (BMad Method/Enterprise tracks) OR tech-spec (Quick Flow track) -- **UX-Designer** โ†’ UX Design Document (if UI-heavy) -- **Architect** โ†’ Architecture (BMad Method/Enterprise tracks) - -#### Phase 2: Planning - Creating the PRD - -**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: - - **PRD.md** - Your Product Requirements Document - - Epic breakdown - -**For Quick Flow track:** - -- Use **tech-spec** instead of PRD (no architecture needed) - -#### Phase 2 (Optional): UX Design - -If your project has a user interface: - -1. Load the **UX-Designer agent** in a new chat -2. Tell it to run the UX design workflow -3. After completion, run validations to ensure the Epics file stays updated - -#### Phase 3: Architecture - -**For BMad Method and Enterprise tracks:** - -1. Load the **Architect agent** in a new chat -2. Tell it to run the create-architecture workflow -3. After completion, run validations to ensure the Epics file stays updated - -#### Phase 3: Solutioning Gate Check (Highly Recommended) - -Once architecture is complete: - -1. Load the **Architect agent** in a new chat -2. Tell it to run "solutioning-gate-check" -3. This validates cohesion across all your planning documents (PRD, UX, Architecture, Epics) -4. This was called the "PO Master Checklist" in v4 - -**Why run this?** It ensures all your planning assets align properly before you start building. - -#### Context Management Tips - -- **Use 200k+ context models** for best results (Claude Sonnet 4.5, GPT-4, etc.) -- **Fresh chat for each workflow** - Brainstorming, Briefs, Research, and PRD generation are all context-intensive -- **No document sharding needed** - Unlike v4, you don't need to split documents -- **Web Bundles coming soon** - Will help save LLM tokens for users with limited plans - -### Step 3: Start Building (Phase 4 - Implementation) - -Once planning and architecture are complete, you'll move to Phase 4. **Important: Each workflow below should be run in a fresh chat to avoid context limitations and hallucinations.** - -#### 3.1 Initialize Sprint Planning - -1. **Start a new chat** with the **SM (Scrum Master) agent** -2. Wait for the menu to appear -3. Tell the agent: "Run sprint-planning" -4. This creates your `sprint-status.yaml` file that tracks all epics and stories - -#### 3.2 Create Epic Context (Optional but Recommended) - -1. **Start a new chat** with the **SM agent** -2. Wait for the menu -3. Tell the agent: "Run epic-tech-context" -4. This creates technical context for the current epic before drafting stories - -#### 3.3 Draft Your First Story - -1. **Start a new chat** with the **SM agent** -2. Wait for the menu -3. Tell the agent: "Run create-story" -4. This drafts the story file from the epic - -#### 3.4 Add Story Context (Optional but Recommended) - -1. **Start a new chat** with the **SM agent** -2. Wait for the menu -3. Tell the agent: "Run story-context" -4. This creates implementation-specific technical context for the story - -#### 3.5 Implement the Story - -1. **Start a new chat** with the **DEV agent** -2. Wait for the menu -3. Tell the agent: "Run dev-story" -4. The DEV agent will implement the story and update the sprint status - -#### 3.6 Review the Code (Optional but Recommended) - -1. **Start a new chat** with the **DEV agent** -2. Wait for the menu -3. Tell the agent: "Run code-review" -4. The DEV agent performs quality validation (this was called QA in v4) - -### Step 4: Keep Going - -For each subsequent story, repeat the cycle using **fresh chats** for each workflow: - -1. **New chat** โ†’ SM agent โ†’ "Run create-story" -2. **New chat** โ†’ SM agent โ†’ "Run story-context" -3. **New chat** โ†’ DEV agent โ†’ "Run dev-story" -4. **New chat** โ†’ DEV agent โ†’ "Run code-review" (optional but recommended) - -After completing all stories in an epic: - -1. **Start a new chat** with the **SM agent** -2. Tell the agent: "Run retrospective" - -**Why fresh chats?** Context-intensive workflows can cause hallucinations if you keep issuing commands in the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. - ---- - -## Understanding the Agents - -Each agent is a specialized AI persona: - -- **Analyst** - Initializes workflows and tracks progress -- **PM** - Creates requirements and specifications -- **UX-Designer** - If your project has a front end - this designer will help produce artifacts, come up with mock updates, and design a great look and feel with you giving it guidance. -- **Architect** - Designs system architecture -- **SM (Scrum Master)** - Manages sprints and creates stories -- **DEV** - Implements code and reviews work - -## How Workflows Work - -1. **Load an agent** - Open the agent file in your IDE to activate it -2. **Wait for the menu** - The agent will present its available workflows -3. **Tell the agent what to run** - Say "Run [workflow-name]" -4. **Follow the prompts** - The agent guides you through each step - -The agent creates documents, asks questions, and helps you make decisions throughout the process. - -## Project Tracking Files - -BMad creates two files to track your progress: - -**1. bmm-workflow-status.yaml** - -- Shows which phase you're in and what's next -- Created by workflow-init -- Updated automatically as you progress through phases - -**2. sprint-status.yaml** (Phase 4 only) - -- Tracks all your epics and stories during implementation -- Critical for SM and DEV agents to know what to work on next -- Created by sprint-planning workflow -- Updated automatically as stories progress - -**You don't need to edit these manually** - agents update them as you work. - ---- - -## The Complete Flow Visualized - -```mermaid -flowchart LR - subgraph P1["Phase 1 (Optional)
Analysis"] - direction TB - A1[Brainstorm] - A2[Research] - A3[Brief] - A4[Analyst] - A1 ~~~ A2 ~~~ A3 ~~~ A4 - end - - subgraph P2["Phase 2 (Required)
Planning"] - direction TB - B1[Quick Flow:
tech-spec] - B2[Method/Enterprise:
PRD] - B3[UX opt] - B4[PM, UX] - B1 ~~~ B2 ~~~ B3 ~~~ B4 - end - - subgraph P3["Phase 3 (Track-dependent)
Solutioning"] - direction TB - C1[Method/Enterprise:
architecture] - C2[gate-check] - C3[Architect] - C1 ~~~ C2 ~~~ C3 - end - - subgraph P4["Phase 4 (Required)
Implementation"] - direction TB - D1[Per Epic:
epic context] - D2[Per Story:
create-story] - D3[story-context] - D4[dev-story] - D5[code-review] - D6[SM, DEV] - D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 ~~~ D6 - end - - P1 --> P2 - P2 --> P3 - P3 --> P4 - - style P1 fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style P2 fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style P3 fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style P4 fill:#fbf,stroke:#333,stroke-width:2px,color:#000 -``` - -## Common Questions - -**Q: Do I always need architecture?** -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. - -**Q: What if I want to brainstorm first?** -A: Load the Analyst agent and tell it to "Run brainstorm-project" before running workflow-init. - -**Q: Why do I need fresh chats for each workflow?** -A: Context-intensive workflows can cause hallucinations if run in sequence. Fresh chats ensure maximum context capacity. - -**Q: Can I skip workflow-init and workflow-status?** -A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directly to the workflows you need. - -## Getting Help - -- **During workflows**: Agents guide you with questions and explanations -- **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues -- **Complete guide**: [BMM Workflow Documentation](./README.md#-workflow-guides) -- **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode) - ---- - -## Key Takeaways - -โœ… **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 -โœ… **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 - -**Ready to start building?** Install BMad, load the Analyst, run workflow-init, and let the agents guide you! diff --git a/.bmad/bmm/docs/scale-adaptive-system.md b/.bmad/bmm/docs/scale-adaptive-system.md deleted file mode 100644 index a8631d18..00000000 --- a/.bmad/bmm/docs/scale-adaptive-system.md +++ /dev/null @@ -1,599 +0,0 @@ -# BMad Method Scale Adaptive System - -**Automatically adapts workflows to project complexity - from quick fixes to enterprise systems** - ---- - -## Overview - -The **Scale Adaptive System** intelligently routes projects to the right planning methodology based on complexity, not arbitrary story counts. - -### The Problem - -Traditional methodologies apply the same process to every project: - -- Bug fix requires full design docs -- Enterprise system built with minimal planning -- One-size-fits-none approach - -### The Solution - -BMad Method adapts to three distinct planning tracks: - -- **Quick Flow**: Tech-spec only, implement immediately -- **BMad Method**: PRD + Architecture, structured approach -- **Enterprise Method**: Full planning with security/devops/test - -**Result**: Right planning depth for every project. - ---- - -## Quick Reference - -### Three Tracks at a Glance - -| 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 | - -### Decision Tree - -```mermaid -flowchart TD - START{Describe your project} - - 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] - - Q1 -->|Yes| QF[Quick Flow
Tech-spec only] - Q1 -->|Uncertain| M - - style QF fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style M fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style E fill:#f9f,stroke:#333,stroke-width:2px,color:#000 -``` - -### Quick Keywords - -- **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 Track Selection Works - -When you run `workflow-init`, it guides you through an educational choice: - -### 1. Description Analysis - -Analyzes your project description for complexity indicators and suggests an appropriate track. - -### 2. Educational Presentation - -Shows all three tracks with: - -- Time investment -- Planning approach -- Benefits and trade-offs -- AI agent support level -- Concrete examples - -### 3. Honest Recommendation - -Provides tailored recommendation based on: - -- Complexity keywords -- Greenfield vs brownfield -- User's description - -### 4. User Choice - -You choose the track that fits your situation. The system guides but never forces. - -**Example:** - -``` -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 Three Tracks - -### Track 1: Quick Flow - -**Definition**: Fast implementation with tech-spec planning. - -**Time**: Hours to 1 day of planning - -**Planning Docs**: - -- Tech-spec.md (implementation-focused) -- Story files (1-15 typically, auto-detects epic structure) - -**Workflow Path**: - -``` -(Brownfield: document-project first if needed) -โ†“ -Tech-Spec โ†’ Implement -``` - -**Use For**: - -- Bug fixes -- Simple features -- Enhancements with clear scope -- Quick additions - -**Story Count**: Typically 1-15 stories (guidance, not rule) - -**Example**: "Fix authentication token expiration bug" - -**AI Agent Support**: Basic - minimal context provided - -**Trade-off**: Less planning = higher rework risk if complexity emerges - ---- - -### Track 2: BMad Method (RECOMMENDED) - -**Definition**: Full product + system design planning. - -**Time**: 1-3 days of planning - -**Planning Docs**: - -- PRD.md (product requirements) -- Architecture.md (system design) -- UX Design (if UI components) -- Epic breakdown with stories - -**Workflow Path**: - -``` -(Brownfield: document-project first if needed) -โ†“ -(Optional: Analysis phase - brainstorm, research, product brief) -โ†“ -PRD โ†’ (Optional UX) โ†’ Architecture โ†’ Gate Check โ†’ Implement -``` - -**Use For**: - -**Greenfield**: - -- Products -- Platforms -- Multi-feature initiatives - -**Brownfield**: - -- Complex additions (new UIs + APIs) -- Major refactors -- New modules - -**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) - ---- - -### Track 3: Enterprise Method - -**Definition**: Extended planning with security, devops, and test strategy. - -**Time**: 3-7 days of planning - -**Planning Docs**: - -- All BMad Method docs PLUS: -- Security Architecture -- DevOps Strategy -- Test Strategy -- Compliance documentation - -**Workflow Path**: - -``` -(Brownfield: document-project nearly mandatory) -โ†“ -Analysis (recommended/required) โ†’ PRD โ†’ UX โ†’ Architecture -โ†“ -Security Architecture โ†’ DevOps Strategy โ†’ Test Strategy -โ†“ -Gate Check โ†’ Implement -``` - -**Use For**: - -- Enterprise requirements -- Multi-tenant systems -- Compliance needs (HIPAA, SOC2, etc.) -- Mission-critical systems -- Security-sensitive applications - -**Story Count**: Typically 30+ stories (but defined by enterprise needs, not count) - -**Examples**: - -- "Multi-tenant SaaS platform" -- "HIPAA-compliant patient portal" -- "Add SOC2 audit logging to enterprise app" - -**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 Track - -### Quick Flow Documents - -**Created**: Upfront in Planning Phase - -**Tech-Spec**: - -- Problem statement and solution -- Source tree changes -- Technical implementation details -- Detected stack and conventions (brownfield) -- UX/UI considerations (if user-facing) -- Testing strategy - -**Serves as**: Complete planning document (replaces PRD + Architecture) - ---- - -### BMad Method Documents - -**Created**: Upfront in Planning and Solutioning Phases - -**PRD (Product Requirements Document)**: - -- Product vision and goals -- Feature requirements -- Epic breakdown with stories -- Success criteria -- User experience considerations -- Business context - -**Architecture Document**: - -- System components and responsibilities -- Data models and schemas -- Integration patterns -- Security architecture -- Performance considerations -- Deployment architecture - -**For Brownfield**: Acts as focused "solution design" that distills existing codebase into integration plan - ---- - -### Enterprise Method Documents - -**Created**: Extended planning across multiple phases - -Includes all BMad Method documents PLUS: - -**Security Architecture**: - -- Threat modeling -- Authentication/authorization design -- Data protection strategy -- Audit requirements - -**DevOps Strategy**: - -- 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 - -| 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. - ---- - -## Brownfield Projects - -### Critical First Step - -For ALL brownfield projects: Run `document-project` BEFORE planning workflows. - -### Why document-project is Critical - -**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 - -```mermaid -flowchart TD - START([Brownfield Project]) - CHECK{Has docs/
index.md?} - - START --> CHECK - CHECK -->|No| DOC[document-project workflow
10-30 min] - CHECK -->|Yes| TRACK[Choose Track] - - DOC --> TRACK - TRACK -->|Quick| QF[Tech-Spec] - TRACK -->|Method| M[PRD + Arch] - TRACK -->|Enterprise| E[PRD + Arch + Sec/Ops] - - style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style TRACK fill:#bfb,stroke:#333,stroke-width:2px,color:#000 -``` - ---- - -## Common Scenarios - -### Scenario 1: Bug Fix (Quick Flow) - -**Input**: "Fix email validation bug in login form" - -**Detection**: Keywords "fix", "bug" - -**Track**: Quick Flow - -**Workflow**: - -1. (Optional) Brief analysis -2. Tech-spec with single story -3. Implement immediately - -**Time**: 2-4 hours total - ---- - -### Scenario 2: Small Feature (Quick Flow) - -**Input**: "Add OAuth social login (Google, GitHub, Facebook)" - -**Detection**: Keywords "add", "feature", clear scope - -**Track**: Quick Flow - -**Workflow**: - -1. (Optional) Research OAuth providers -2. Tech-spec with 3 stories -3. Implement story-by-story - -**Time**: 1-3 days - ---- - -### Scenario 3: Customer Portal (BMad Method) - -**Input**: "Build customer portal with dashboard, tickets, billing" - -**Detection**: Keywords "portal", "dashboard", multiple features - -**Track**: BMad Method - -**Workflow**: - -1. (Recommended) Product Brief -2. PRD with epics -3. (If UI) UX Design -4. Architecture (system design) -5. Gate Check -6. Implement with sprint planning - -**Time**: 1-2 weeks - ---- - -### Scenario 4: E-commerce Platform (BMad Method) - -**Input**: "Build e-commerce platform with products, cart, checkout, admin, analytics" - -**Detection**: Keywords "platform", multiple subsystems - -**Track**: BMad Method - -**Workflow**: - -1. Research + Product Brief -2. Comprehensive PRD -3. UX Design (recommended) -4. System Architecture (required) -5. Gate check -6. Implement with phased approach - -**Time**: 3-6 weeks - ---- - -### Scenario 5: Brownfield Addition (BMad Method) - -**Input**: "Add search functionality to existing product catalog" - -**Detection**: Brownfield + moderate complexity - -**Track**: BMad Method (not Quick Flow) - -**Critical First Step**: - -1. **Run document-project** to analyze existing codebase - -**Then Workflow**: 2. PRD for search feature 3. Architecture (integration design - highly recommended) 4. Implement following existing patterns - -**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 - ---- - -## Best Practices - -### 1. Document-Project First for Brownfield - -Always run `document-project` before starting brownfield planning. AI agents need existing codebase context. - -### 2. Trust the Recommendation - -If `workflow-init` suggests BMad Method, there's probably complexity you haven't considered. Review carefully before overriding. - -### 3. Start Smaller if Uncertain - -Uncertain between Quick Flow and Method? Start with Quick Flow. You can create PRD later if needed. - -### 4. Don't Skip Gate Checks - -For BMad Method and Enterprise, gate checks prevent costly mistakes. Invest the time. - -### 5. Architecture is Optional but Recommended for Brownfield - -Brownfield BMad Method makes architecture optional, but it's highly recommended. It distills complex codebase into focused solution design. - -### 6. Discovery Phase Based on Need - -Brainstorming and research are offered regardless of track. Use them when you need to think through the problem space. - -### 7. Product Brief for Greenfield Method - -Product Brief is only offered for greenfield BMad Method and Enterprise. It's optional but helps with strategic thinking. - ---- - -## Key Differences from Legacy System - -### Old System (Levels 0-4) - -- 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 - -### New System (3 Tracks) - -- 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 - ---- - -## Migration from Old System - -If you have existing projects using the old level system: - -- **Level 0-1** โ†’ Quick Flow -- **Level 2-3** โ†’ BMad Method -- **Level 4** โ†’ Enterprise Method - -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)** - Details on Quick Flow track -- **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows -- **[Glossary](./glossary.md)** - Complete terminology -- **[FAQ](./faq.md)** - Common questions -- **[Workflows Guide](./README.md#-workflow-guides)** - Complete workflow reference - ---- - -_Scale Adaptive System - Right planning depth for every project._ diff --git a/.bmad/bmm/docs/test-architecture.md b/.bmad/bmm/docs/test-architecture.md deleted file mode 100644 index 6ef0ffec..00000000 --- a/.bmad/bmm/docs/test-architecture.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -last-redoc-date: 2025-11-05 ---- - -# Test Architect (TEA) Agent Guide - -## Overview - -- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance. -- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands. -- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA) - -## TEA Workflow Lifecycle - -TEA integrates into the BMad development lifecycle during Implementation (Phase 4): - -```mermaid -%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%% -graph TB - subgraph Phase2["Phase 2: PLANNING"] - PM["PM: *prd (creates PRD + epics)"] - PlanNote["Business requirements phase"] - PM -.-> PlanNote - end - - subgraph Phase3["Phase 3: SOLUTIONING"] - Architecture["Architect: *architecture"] - TestDesignSys["TEA: *test-design (system-level)"] - ValidateArch["Architect: *validate-architecture"] - GateCheck["Architect: *solutioning-gate-check"] - Architecture --> TestDesignSys - TestDesignSys --> ValidateArch - ValidateArch --> GateCheck - Phase3Note["Testability review before gate
Recommended: Method | Required: Enterprise"] - TestDesignSys -.-> Phase3Note - end - - subgraph Phase4["Phase 4: IMPLEMENTATION"] - subgraph Sprint0["Sprint 0: Infrastructure Setup"] - Framework["TEA: *framework"] - CI["TEA: *ci"] - Framework --> CI - Sprint0Note["Test infrastructure setup
based on architectural decisions"] - Framework -.-> Sprint0Note - end - - SprintPlan["SM: *sprint-planning"] - - subgraph PerEpic["Per Epic Cycle"] - TestDesign["TEA: *test-design (per epic)"] - CreateStory["SM: *create-story"] - ATDD["TEA: *atdd (optional, before dev)"] - DevImpl["DEV: implements story"] - Automate["TEA: *automate"] - TestReview1["TEA: *test-review (optional)"] - Trace1["TEA: *trace (refresh coverage)"] - - TestDesign --> CreateStory - CreateStory --> ATDD - ATDD --> DevImpl - DevImpl --> Automate - Automate --> TestReview1 - TestReview1 --> Trace1 - Trace1 -.->|next story| CreateStory - TestDesignNote["Test design: 'How do I test THIS epic?'
Creates test-design-epic-N.md per epic"] - TestDesign -.-> TestDesignNote - end - - CI --> SprintPlan - SprintPlan --> TestDesign - end - - subgraph Gate["EPIC/RELEASE GATE"] - NFR["TEA: *nfr-assess (if not done earlier)"] - TestReview2["TEA: *test-review (final audit, optional)"] - TraceGate["TEA: *trace - Phase 2: Gate"] - GateDecision{"Gate Decision"} - - NFR --> TestReview2 - TestReview2 --> TraceGate - TraceGate --> GateDecision - GateDecision -->|PASS| Pass["PASS โœ…"] - GateDecision -->|CONCERNS| Concerns["CONCERNS โš ๏ธ"] - GateDecision -->|FAIL| Fail["FAIL โŒ"] - GateDecision -->|WAIVED| Waived["WAIVED โญ๏ธ"] - end - - Phase2 --> Phase3 - Phase3 --> Phase4 - Phase4 --> Gate - - style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000 - style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000 - style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000 - style Sprint0 fill:#f3e5f5,stroke:#6a1b9a,stroke-width:2px,color:#000 - style PerEpic fill:#f3e5f5,stroke:#6a1b9a,stroke-width:2px,color:#000 - style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000 - style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000 - style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000 - style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000 - style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000 -``` - -**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 0/1: - -- **Phase 0** (Optional): Documentation (brownfield prerequisite - `*document-project`) -- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`) -- **Phase 2** (Required): Planning (`*prd` creates PRD + epics) -- **Phase 3** (Required): Solutioning (`*architecture` โ†’ `*validate-architecture` โ†’ `*solutioning-gate-check`) -- **Phase 4** (Required): Implementation - - **Sprint 0**: Test infrastructure setup (`*framework`, `*ci`) based on architectural decisions - - **Sprint Planning**: Load epics into sprint status - - **Per-Epic**: `*test-design` โ†’ per-story dev workflows - -**TEA workflows:** `*test-design` runs in Phase 3 (system-level testability review, recommended/required) and Phase 4 (per-epic planning). `*framework` and `*ci` run once in Phase 4 Sprint 0 (after architecture and testability are approved). - -Quick Flow track skips Phases 0, 1, and 3. BMad Method and Enterprise use all phases based on project needs. - -### Why TEA is Different from Other BMM Agents - -TEA is the only BMM agent that operates in **both Phase 3 (Solutioning) and Phase 4 (Implementation)** and has its own **knowledge base architecture**. - -
-Cross-Phase Operation & Unique Architecture - -### Phase-Specific Agents (Standard Pattern) - -Most BMM agents work in a single phase: - -- **Phase 1 (Analysis)**: Analyst agent -- **Phase 2 (Planning)**: PM agent -- **Phase 3 (Solutioning)**: Architect agent -- **Phase 4 (Implementation)**: SM, DEV agents - -### TEA: Cross-Phase Quality Agent (Unique Pattern) - -TEA is **the only agent that operates in both Phase 3 (Solutioning) and Phase 4 (Implementation)**: - -``` -Phase 1 (Analysis) โ†’ [TEA not typically used] - โ†“ -Phase 2 (Planning) โ†’ [PM defines requirements - TEA not active] - โ†“ -Phase 3 (Solutioning) โ†’ TEA: *test-design (system-level testability review before gate) - โ†“ -Phase 4 Sprint 0 โ†’ TEA: *framework, *ci (test infrastructure setup based on testability review) - โ†“ -Phase 4 Sprint Planning โ†’ [SM loads epics into sprint status] - โ†“ -Phase 4 Per-Epic โ†’ TEA: *test-design (per epic: "how do I test THIS feature?") -Phase 4 Per-Story โ†’ TEA: *atdd, *automate, *test-review, *trace (per story) - โ†“ -Epic/Release Gate โ†’ TEA: *nfr-assess, *trace Phase 2 (release decision) -``` - -### TEA's 8 Workflows Across Phase 3-4 - -**Standard agents**: 1-3 workflows per phase -**TEA**: 8 workflows spanning Phase 3 Solutioning through Phase 4 Release Gate - -| Phase | TEA Workflows | Frequency | Purpose | -| --------------------- | ---------------------------------------- | ---------------- | ---------------------------------------------- | -| **Phase 2** | (none) | - | Planning phase - PM defines requirements | -| **Phase 3** | \*test-design (system-level) | Once per project | Testability review before solutioning gate | -| **Phase 4 Sprint 0** | *framework, *ci | Once per project | Setup test infrastructure based on testability | -| **Phase 4 Per-Epic** | \*test-design (epic-level) | Per epic | Test planning: "how do I test THIS epic?" | -| **Phase 4 Per-Story** | *atdd, *automate, \*test-review, \*trace | Per story | Test implementation and quality validation | -| **Release Gate** | *nfr-assess, *trace (Phase 2: gate) | Per epic/release | Go/no-go decision | - -**Note**: Like `*trace`, `*test-design` is now a dual-mode workflow: system-level mode (testability review in Phase 3) and epic-level mode (test planning in Phase 4). Auto-detects mode based on project phase. - -### Unique Directory Architecture - -TEA is the only BMM agent with its own top-level module directory (`bmm/testarch/`): - -``` -src/modules/bmm/ -โ”œโ”€โ”€ agents/ -โ”‚ โ””โ”€โ”€ tea.agent.yaml # Agent definition (standard location) -โ”œโ”€โ”€ workflows/ -โ”‚ โ””โ”€โ”€ testarch/ # TEA workflows (standard location) -โ””โ”€โ”€ testarch/ # Knowledge base (UNIQUE!) - โ”œโ”€โ”€ knowledge/ # 21 production-ready test pattern fragments - โ”œโ”€โ”€ tea-index.csv # Centralized knowledge lookup (21 fragments indexed) - โ””โ”€โ”€ README.md # This guide -``` - -### Why TEA Gets Special Treatment - -TEA uniquely requires: - -- **Extensive domain knowledge**: 21 fragments, 12,821 lines covering test patterns, CI/CD, fixtures, quality practices, healing strategies -- **Centralized reference system**: `tea-index.csv` for on-demand fragment loading during workflow execution -- **Cross-cutting concerns**: Domain-specific testing patterns (vs project-specific artifacts like PRDs/stories) -- **Optional MCP integration**: Healing, exploratory, and verification modes for enhanced testing capabilities - -This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases. - -
- -## High-Level Cheat Sheets - -These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation). - -**Note:** Quick Flow projects typically don't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value. - -**Legend for Track Deltas:** - -- โž• = New workflow or phase added (doesn't exist in baseline) -- ๐Ÿ”„ = Modified focus (same workflow, different emphasis or purpose) -- ๐Ÿ“ฆ = Additional output or archival requirement - -### Greenfield - BMad Method (Simple/Standard Work) - -**Planning Track:** BMad Method (PRD + Architecture) -**Use Case:** New projects with standard complexity - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| ---------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------- | -| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` | -| **Phase 2**: Planning | - | PM `*prd` (creates PRD + epics) | PRD, epics | -| **Phase 3**: Solutioning | Run `*test-design` (system-level, recommended) | Architect `*architecture`, `*solutioning-gate-check` | Architecture, `test-design-system.md` (testability review) | -| **Phase 4**: Sprint 0 | Run `*framework`, `*ci` based on test-design-system.md | Setup repo structure, dependencies | Test scaffold, CI pipeline, development environment | -| **Phase 4**: Sprint Planning | - | SM `*sprint-planning` | Sprint status file with all epics and stories | -| **Phase 4**: Epic Planning | Run `*test-design` (epic-level, auto-detected) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan | -| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | -| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix | -| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary | - -
-Execution Notes - -- **Phase 3 (Solutioning)**: Architect creates architecture document; TEA runs `*test-design` (system-level mode, auto-detected) for testability review; gate check validates planning completeness including testability. -- **`*test-design` auto-detects mode**: In Phase 3 outputs `test-design-system.md`, in Phase 4 outputs `test-design-epic-N.md`. -- **Phase 4 Sprint 0**: After architecture is approved and testability validated, run `*framework` and `*ci` to setup test infrastructure. This is implementation work (scaffolding code, installing dependencies, configuring CI), not planning. -- **Phase 4 Sprint Planning**: After infrastructure is ready, sprint planning loads all epics. -- **`*test-design` runs per-epic** (Phase 4): At the beginning of each epic, run `*test-design` to create epic-specific test plan. Output: `test-design-epic-N.md`. -- Use `*atdd` before coding when the team can adopt ATDD; share its checklist with the dev agent. -- Post-implementation, keep `*trace` current, expand coverage with `*automate`, optionally review test quality with `*test-review`. For release gate, run `*trace` with Phase 2 enabled to get deployment decision. -- Use `*test-review` after `*atdd` to validate generated tests, after `*automate` to ensure regression quality, or before gate for final audit. - -
- -
-Worked Example โ€“ "Nova CRM" Greenfield Feature - -1. **Planning (Phase 2):** Analyst runs `*product-brief`; PM executes `*prd` to produce PRD and epics. -2. **Solutioning (Phase 3):** Architect completes `*architecture` defining tech stack; TEA runs `*test-design` (auto-detects system-level mode) producing `test-design-system.md` with testability review; gate check validates planning completeness including testability. -3. **Sprint 0 (Phase 4):** TEA sets up test infrastructure via `*framework` and `*ci` based on test-design-system.md; team scaffolds repo structure and dependencies. -4. **Sprint Planning (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status. -5. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` (auto-detects epic-level mode) to create test plan for Epic 1, producing `test-design-epic-1.md` with risk assessment. -6. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA optionally runs `*atdd`; Dev implements with guidance from failing tests. -7. **Post-Dev (Phase 4):** TEA runs `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage. -8. **Release Gate:** TEA runs `*trace` with Phase 2 enabled to generate gate decision. - -
- -### Brownfield - BMad Method or Enterprise (Simple or Complex) - -**Planning Tracks:** BMad Method or Enterprise Method -**Use Case:** Existing codebases - simple additions (BMad Method) or complex enterprise requirements (Enterprise Method) - -**๐Ÿ”„ Brownfield Deltas from Greenfield:** - -- โž• Phase 0 (Documentation) - Document existing codebase if undocumented -- โž• Phase 2: `*trace` - Baseline existing test coverage before planning -- ๐Ÿ”„ Phase 3: `*test-design` (system-level) - Includes brownfield testability concerns -- ๐Ÿ”„ Phase 4 Sprint 0: `*framework`, `*ci` - May integrate with/replace existing test setup -- ๐Ÿ”„ Phase 4: `*test-design` (epic-level) - Focus on regression hotspots and brownfield risks -- ๐Ÿ”„ Phase 4: Story Review - May include `*nfr-assess` if not done earlier - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| ----------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------- | -| **Phase 0**: Documentation โž• | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation | -| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` | -| **Phase 2**: Planning | Run โž• `*trace` (baseline coverage) | PM `*prd` (creates PRD + epics) | PRD, epics, โž• coverage baseline | -| **Phase 3**: Solutioning | Run `*test-design` (system-level, recommended) ๐Ÿ”„ | Architect `*architecture`, `*solutioning-gate-check` | Architecture, `test-design-system.md` (brownfield testability review) | -| **Phase 4**: Sprint 0 | Run `*framework`, `*ci` based on test-design-system.md ๐Ÿ”„ | Modernize/integrate test setup | Test scaffold, CI pipeline (may replace existing) | -| **Phase 4**: Sprint Planning | - | SM `*sprint-planning` | Sprint status file with all epics and stories | -| **Phase 4**: Epic Planning | Run `*test-design` (epic-level) ๐Ÿ”„ (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation | -| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | -| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, โž• `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report | -| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary | - -
-Execution Notes - -- Lead with `*trace` during Planning (Phase 2) to baseline existing test coverage before architecture work begins. -- **Phase 3 (Solutioning)**: Architect creates architecture document; TEA runs `*test-design` (system-level mode, auto-detected) for testability review including brownfield concerns; gate check validates planning completeness including testability. -- **`*test-design` auto-detects mode**: In Phase 3 outputs `test-design-system.md`, in Phase 4 outputs `test-design-epic-N.md`. -- **Phase 4 Sprint 0**: After architecture is approved and testability validated, run `*framework` and `*ci` to modernize test infrastructure. For brownfield, this may integrate with or replace existing test setup. -- **Phase 4 Sprint Planning**: After infrastructure is ready, sprint planning loads all epics. -- **`*test-design` runs per-epic** (Phase 4): At the beginning of each epic, run `*test-design` to identify regression hotspots, integration risks, and mitigation strategies. Output: `test-design-epic-N.md`. -- Use `*atdd` when stories benefit from ATDD; otherwise proceed to implementation and rely on post-dev automation. -- After development, expand coverage with `*automate`, optionally review test quality with `*test-review`, re-run `*trace` (Phase 2 for gate decision). Run `*nfr-assess` now if non-functional risks weren't addressed earlier. -- Use `*test-review` to validate existing brownfield tests or audit new tests before gate. - -
- -
-Worked Example โ€“ "Atlas Payments" Brownfield Story - -1. **Planning (Phase 2):** PM executes `*prd` to update PRD and `epics.md` (Epic 1: Payment Processing); TEA runs `*trace` to baseline existing coverage. -2. **Solutioning (Phase 3):** Architect triggers `*architecture` capturing legacy payment flows and integration architecture; TEA runs `*test-design` (auto-detects system-level mode) producing `test-design-system.md` with brownfield testability review; gate check validates planning. -3. **Sprint 0 (Phase 4):** TEA sets up `*framework` and `*ci` based on test-design-system.md, integrating with existing test setup; team modernizes infrastructure. -4. **Sprint Planning (Phase 4):** Scrum Master runs `*sprint-planning` to load Epic 1 into sprint status. -5. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` (auto-detects epic-level mode) for Epic 1, producing `test-design-epic-1.md` that flags settlement edge cases, regression hotspots, and mitigation plans. -6. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA runs `*atdd` producing failing Playwright specs; Dev implements with guidance from tests and checklist. -7. **Post-Dev (Phase 4):** TEA applies `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage. -8. **Release Gate:** TEA performs `*nfr-assess` to validate SLAs, runs `*trace` with Phase 2 enabled to generate gate decision (PASS/CONCERNS/FAIL). - -
- -### Greenfield - Enterprise Method (Enterprise/Compliance Work) - -**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies) -**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements - -**๐Ÿข Enterprise Deltas from BMad Method:** - -- โž• Phase 1: `*research` - Domain and compliance research (recommended) -- โž• Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability) -- ๐Ÿ”„ Phase 3: `*test-design` (system-level) - **Required** for enterprise (vs recommended for Method) -- ๐Ÿ”„ Phase 4 Sprint 0: `*framework`, `*ci` - Enterprise-grade configurations -- ๐Ÿ”„ Phase 4: `*test-design` (epic-level) - Enterprise focus (compliance, security architecture alignment) -- ๐Ÿ“ฆ Release Gate - Archive artifacts and compliance evidence for audits - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| ---------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------ | -| **Phase 1**: Discovery | - | Analyst โž• `*research`, `*product-brief` | Domain research, compliance analysis, product brief | -| **Phase 2**: Planning | Run โž• `*nfr-assess` | PM `*prd` (creates PRD + epics), UX `*create-design` | Enterprise PRD, epics, UX design, โž• NFR documentation | -| **Phase 3**: Solutioning | Run `*test-design` (system-level, **required**) ๐Ÿ”„ | Architect `*architecture`, `*solutioning-gate-check` | Architecture, `test-design-system.md` (enterprise testability) | -| **Phase 4**: Sprint 0 | Run `*framework`, `*ci` with enterprise configs ๐Ÿ”„ | Setup enterprise infrastructure | Test scaffold, CI pipeline (selective testing, burn-in, caching) | -| **Phase 4**: Sprint Planning | - | SM `*sprint-planning` | Sprint plan with all epics | -| **Phase 4**: Epic Planning | Run `*test-design` (epic-level) ๐Ÿ”„ (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus | -| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices | -| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), ๐Ÿ“ฆ archive artifacts | Capture sign-offs, ๐Ÿ“ฆ compliance evidence | Quality audit, updated assessments, gate YAML, ๐Ÿ“ฆ audit trail | - -
-Execution Notes - -- `*nfr-assess` runs early in Planning (Phase 2) to capture compliance, security, and performance requirements upfront. -- **Phase 3 (Solutioning)**: Architect creates architecture document with enterprise considerations; TEA runs `*test-design` (system-level mode, **required** for enterprise) for comprehensive testability review; gate check validates planning completeness including testability. -- **`*test-design` auto-detects mode**: In Phase 3 outputs `test-design-system.md`, in Phase 4 outputs `test-design-epic-N.md`. -- **Phase 4 Sprint 0**: After architecture is approved and testability validated, run `*framework` and `*ci` with enterprise-grade configurations (selective testing, burn-in jobs, caching, notifications). -- **Phase 4 Sprint Planning**: After infrastructure is ready, sprint planning loads all epics. -- **`*test-design` runs per-epic** (Phase 4): At the beginning of each epic, run `*test-design` to create enterprise-focused test plan ensuring alignment with security architecture, performance targets, and compliance requirements. Output: `test-design-epic-N.md`. -- Use `*atdd` for stories when feasible so acceptance tests can lead implementation. -- Use `*test-review` per story or sprint to maintain quality standards and ensure compliance with testing best practices. -- Prior to release, rerun coverage (`*trace`, `*automate`), perform final quality audit with `*test-review`, and formalize the decision with `*trace` Phase 2 (gate decision); archive artifacts for compliance audits. - -
- -
-Worked Example โ€“ "Helios Ledger" Enterprise Release - -1. **Planning (Phase 2):** Analyst runs `*research` and `*product-brief`; PM completes `*prd` creating PRD and epics; TEA runs `*nfr-assess` to establish NFR targets. -2. **Solutioning (Phase 3):** Architect completes `*architecture` with enterprise considerations; TEA runs `*test-design` (auto-detects system-level mode, required) producing `test-design-system.md` with comprehensive testability review; gate check validates planning completeness. -3. **Sprint 0 (Phase 4):** TEA sets up `*framework` and `*ci` with enterprise-grade configurations based on test-design-system.md; team establishes infrastructure. -4. **Sprint Planning (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status. -5. **Per-Epic (Phase 4):** For each epic, TEA runs `*test-design` (auto-detects epic-level mode) to create epic-specific test plan (e.g., `test-design-epic-1.md`, `test-design-epic-2.md`) with compliance-focused risk assessment. -6. **Per-Story (Phase 4):** For each story, TEA uses `*atdd`, `*automate`, `*test-review`, and `*trace`; Dev teams iterate on the findings. -7. **Release Gate:** TEA re-checks coverage, performs final quality audit with `*test-review`, and logs the final gate decision via `*trace` Phase 2, archiving artifacts for compliance. - -
- -## Command Catalog - -
-Optional Playwright MCP Enhancements - -**Two Playwright MCP servers** (actively maintained, continuously updated): - -- `playwright` - Browser automation (`npx @playwright/mcp@latest`) -- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`) - -**How MCP Enhances TEA Workflows**: - -MCP provides additional capabilities on top of TEA's default AI-based approach: - -1. `*test-design`: - - Default: Analysis + documentation - - **+ MCP**: Interactive UI discovery with `browser_navigate`, `browser_click`, `browser_snapshot`, behavior observation - - Benefit: Discover actual functionality, edge cases, undocumented features - -2. `*atdd`, `*automate`: - - Default: Infers selectors and interactions from requirements and knowledge fragments - - **+ MCP**: Generates tests **then** verifies with `generator_setup_page`, `browser_*` tools, validates against live app - - Benefit: Accurate selectors from real DOM, verified behavior, refined test code - -3. `*automate`: - - Default: Pattern-based fixes from error messages + knowledge fragments - - **+ MCP**: Pattern fixes **enhanced with** `browser_snapshot`, `browser_console_messages`, `browser_network_requests`, `browser_generate_locator` - - Benefit: Visual failure context, live DOM inspection, root cause discovery - -**Config example**: - -```json -{ - "mcpServers": { - "playwright": { - "command": "npx", - "args": ["@playwright/mcp@latest"] - }, - "playwright-test": { - "command": "npx", - "args": ["playwright", "run-test-mcp-server"] - } - } -} -``` - -**To disable**: Set `tea_use_mcp_enhancements: false` in `.bmad/bmm/config.yaml` OR remove MCPs from IDE config. - -
- -

- -| Command | Workflow README | Primary Outputs | Notes | With Playwright MCP Enhancements | -| -------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| `*framework` | [๐Ÿ“–](../workflows/testarch/framework/README.md) | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - | -| `*ci` | [๐Ÿ“–](../workflows/testarch/ci/README.md) | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - | -| `*test-design` | [๐Ÿ“–](../workflows/testarch/test-design/README.md) | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) | -| `*atdd` | [๐Ÿ“–](../workflows/testarch/atdd/README.md) | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) | -| `*automate` | [๐Ÿ“–](../workflows/testarch/automate/README.md) | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser | -| `*test-review` | [๐Ÿ“–](../workflows/testarch/test-review/README.md) | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - | -| `*nfr-assess` | [๐Ÿ“–](../workflows/testarch/nfr-assess/README.md) | NFR assessment report with actions | Focus on security/performance/reliability | - | -| `*trace` | [๐Ÿ“–](../workflows/testarch/trace/README.md) | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - | - -**๐Ÿ“–** = Click to view detailed workflow documentation diff --git a/.bmad/bmm/docs/workflow-architecture-reference.md b/.bmad/bmm/docs/workflow-architecture-reference.md deleted file mode 100644 index d8761965..00000000 --- a/.bmad/bmm/docs/workflow-architecture-reference.md +++ /dev/null @@ -1,371 +0,0 @@ -# Decision Architecture Workflow - Technical Reference - -**Module:** BMM (BMAD Method Module) -**Type:** Solutioning Workflow - ---- - -## Overview - -The Decision Architecture workflow is a complete reimagining of how architectural decisions are made in the BMAD Method. Instead of template-driven documentation, this workflow facilitates an intelligent conversation that produces a **decision-focused architecture document** optimized for preventing AI agent conflicts during implementation. - ---- - -## Core Philosophy - -**The Problem**: When multiple AI agents implement different parts of a system, they make conflicting technical decisions leading to incompatible implementations. - -**The Solution**: A "consistency contract" that documents all critical technical decisions upfront, ensuring every agent follows the same patterns and uses the same technologies. - ---- - -## Key Features - -### 1. Starter Template Intelligence โญ NEW - -- Discovers relevant starter templates (create-next-app, create-t3-app, etc.) -- Considers UX requirements when selecting templates (animations, accessibility, etc.) -- Searches for current CLI options and defaults -- Documents decisions made BY the starter template -- Makes remaining architectural decisions around the starter foundation -- First implementation story becomes "initialize with starter command" - -### 2. Adaptive Facilitation - -- Adjusts conversation style based on user skill level (beginner/intermediate/expert) -- Experts get rapid, technical discussions -- Beginners receive education and protection from complexity -- Everyone produces the same high-quality output - -### 3. Dynamic Version Verification - -- NEVER trusts hardcoded version numbers -- Uses WebSearch to find current stable versions -- Verifies versions during the conversation -- Documents only verified, current versions - -### 4. Intelligent Discovery - -- No rigid project type templates -- Analyzes PRD to identify which decisions matter for THIS project -- Uses knowledge base of decisions and patterns -- Scales to infinite project types - -### 5. Collaborative Decision Making - -- Facilitates discussion for each critical decision -- Presents options with trade-offs -- Integrates advanced elicitation for innovative approaches -- Ensures decisions are coherent and compatible - -### 6. Consistent Output - -- Structured decision collection during conversation -- Strict document generation from collected decisions -- Validated against hard requirements -- Optimized for AI agent consumption - ---- - -## Workflow Structure - -``` -Step 0: Validate workflow and extract project configuration -Step 0.5: Validate workflow sequencing -Step 1: Load PRD and understand project context -Step 2: Discover and evaluate starter templates โญ NEW -Step 3: Adapt facilitation style and identify remaining decisions -Step 4: Facilitate collaborative decision making (with version verification) -Step 5: Address cross-cutting concerns -Step 6: Define project structure and boundaries -Step 7: Design novel architectural patterns (when needed) โญ NEW -Step 8: Define implementation patterns to prevent agent conflicts -Step 9: Validate architectural coherence -Step 10: Generate decision architecture document (with initialization commands) -Step 11: Validate document completeness -Step 12: Final review and update workflow status -``` - ---- - -## Files in This Workflow - -- **workflow.yaml** - Configuration and metadata -- **instructions.md** - The adaptive facilitation flow -- **decision-catalog.yaml** - Knowledge base of all architectural decisions -- **architecture-patterns.yaml** - Common patterns identified from requirements -- **pattern-categories.csv** - Pattern principles that teach LLM what needs defining -- **checklist.md** - Validation requirements for the output document -- **architecture-template.md** - Strict format for the final document - ---- - -## How It's Different from Old architecture - -| Aspect | Old Workflow | New Workflow | -| -------------------- | -------------------------------------------- | ----------------------------------------------- | -| **Approach** | Template-driven | Conversation-driven | -| **Project Types** | 11 rigid types with 22+ files | Infinite flexibility with intelligent discovery | -| **User Interaction** | Output sections with "Continue?" | Collaborative decision facilitation | -| **Skill Adaptation** | One-size-fits-all | Adapts to beginner/intermediate/expert | -| **Decision Making** | Late in process (Step 5) | Upfront and central focus | -| **Output** | Multiple documents including faux tech-specs | Single decision-focused architecture | -| **Time** | Confusing and slow | 30-90 minutes depending on skill level | -| **Elicitation** | Never used | Integrated at decision points | - ---- - -## Expected Inputs - -- **PRD** (Product Requirements Document) with: - - Functional Requirements - - Non-Functional Requirements - - Performance and compliance needs - -- **Epics** file with: - - User stories - - Acceptance criteria - - Dependencies - -- **UX Spec** (Optional but valuable) with: - - Interface designs and interaction patterns - - Accessibility requirements (WCAG levels) - - Animation and transition needs - - Platform-specific UI requirements - - Performance expectations for interactions - ---- - -## Output Document - -A single `architecture.md` file containing: - -- Executive summary (2-3 sentences) -- Project initialization command (if using starter template) -- Decision summary table with verified versions and epic mapping -- Complete project structure -- Integration specifications -- Consistency rules for AI agents - ---- - -## How Novel Pattern Design Works - -Step 7 handles unique or complex patterns that need to be INVENTED: - -### 1. Detection - -The workflow analyzes the PRD for concepts that don't have standard solutions: - -- Novel interaction patterns (e.g., "swipe to match" when Tinder doesn't exist) -- Complex multi-epic workflows (e.g., "viral invitation system") -- Unique data relationships (e.g., "social graph" before Facebook) -- New paradigms (e.g., "ephemeral messages" before Snapchat) - -### 2. Design Collaboration - -Instead of just picking technologies, the workflow helps DESIGN the solution: - -- Identifies the core problem to solve -- Explores different approaches with the user -- Documents how components interact -- Creates sequence diagrams for complex flows -- Uses elicitation to find innovative solutions - -### 3. Documentation - -Novel patterns become part of the architecture with: - -- Pattern name and purpose -- Component interactions -- Data flow diagrams -- Which epics/stories are affected -- Implementation guidance for agents - -### 4. Example - -``` -PRD: "Users can create 'circles' of friends with overlapping membership" -โ†“ -Workflow detects: This is a novel social structure pattern -โ†“ -Designs with user: Circle membership model, permission cascading, UI patterns -โ†“ -Documents: "Circle Pattern" with component design and data flow -โ†“ -All agents understand how to implement circle-related features consistently -``` - ---- - -## How Implementation Patterns Work - -Step 8 prevents agent conflicts by defining patterns for consistency: - -### 1. The Core Principle - -> "Any time multiple agents might make the SAME decision DIFFERENTLY, that's a pattern to capture" - -The LLM asks: "What could an agent encounter where they'd have to guess?" - -### 2. Pattern Categories (principles, not prescriptions) - -- **Naming**: How things are named (APIs, database fields, files) -- **Structure**: How things are organized (folders, modules, layers) -- **Format**: How data is formatted (JSON structures, responses) -- **Communication**: How components talk (events, messages, protocols) -- **Lifecycle**: How states change (workflows, transitions) -- **Location**: Where things go (URLs, paths, storage) -- **Consistency**: Cross-cutting concerns (dates, errors, logs) - -### 3. LLM Intelligence - -- Uses the principle to identify patterns beyond the 7 categories -- Figures out what specific patterns matter for chosen tech -- Only asks about patterns that could cause conflicts -- Skips obvious patterns that the tech choice determines - -### 4. Example - -``` -Tech chosen: REST API + PostgreSQL + React -โ†“ -LLM identifies needs: -- REST: URL structure, response format, status codes -- PostgreSQL: table naming, column naming, FK patterns -- React: component structure, state management, test location -โ†“ -Facilitates each with user -โ†“ -Documents as Implementation Patterns in architecture -``` - ---- - -## How Starter Templates Work - -When the workflow detects a project type that has a starter template: - -1. **Discovery**: Searches for relevant starter templates based on PRD -2. **Investigation**: Looks up current CLI options and defaults -3. **Presentation**: Shows user what the starter provides -4. **Integration**: Documents starter decisions as "PROVIDED BY STARTER" -5. **Continuation**: Only asks about decisions NOT made by starter -6. **Documentation**: Includes exact initialization command in architecture - -### Example Flow - -``` -PRD says: "Next.js web application with authentication" -โ†“ -Workflow finds: create-next-app and create-t3-app -โ†“ -User chooses: create-t3-app (includes auth setup) -โ†“ -Starter provides: Next.js, TypeScript, tRPC, Prisma, NextAuth, Tailwind -โ†“ -Workflow only asks about: Database choice, deployment target, additional services -โ†“ -First story becomes: "npx create t3-app@latest my-app --trpc --nextauth --prisma" -``` - ---- - -## Usage - -```bash -# In your BMAD-enabled project -workflow architecture -``` - -The AI agent will: - -1. Load your PRD and epics -2. Identify critical decisions needed -3. Facilitate discussion on each decision -4. Generate a comprehensive architecture document -5. Validate completeness - ---- - -## Design Principles - -1. **Facilitation over Prescription** - Guide users to good decisions rather than imposing templates -2. **Intelligence over Templates** - Use AI understanding rather than rigid structures -3. **Decisions over Details** - Focus on what prevents agent conflicts, not implementation minutiae -4. **Adaptation over Uniformity** - Meet users where they are while ensuring quality output -5. **Collaboration over Output** - The conversation matters as much as the document - ---- - -## For Developers - -This workflow assumes: - -- Single developer + AI agents (not teams) -- Speed matters (decisions in minutes, not days) -- AI agents need clear constraints to prevent conflicts -- The architecture document is for agents, not humans - ---- - -## Migration from architecture - -Projects using the old `architecture` workflow should: - -1. Complete any in-progress architecture work -2. Use `architecture` for new projects -3. The old workflow remains available but is deprecated - ---- - -## Version History - -**1.3.2** - UX specification integration and fuzzy file matching - -- Added UX spec as optional input with fuzzy file matching -- Updated workflow.yaml with input file references -- Starter template selection now considers UX requirements -- Added UX alignment validation to checklist -- Instructions use variable references for flexible file names - -**1.3.1** - Workflow refinement and standardization - -- Added workflow status checking at start (Steps 0 and 0.5) -- Added workflow status updating at end (Step 12) -- Reorganized step numbering for clarity (removed fractional steps) -- Enhanced with intent-based approach throughout -- Improved cohesiveness across all workflow components - -**1.3.0** - Novel pattern design for unique architectures - -- Added novel pattern design (now Step 7, formerly Step 5.3) -- Detects novel concepts in PRD that need architectural invention -- Facilitates design collaboration with sequence diagrams -- Uses elicitation for innovative approaches -- Documents custom patterns for multi-epic consistency - -**1.2.0** - Implementation patterns for agent consistency - -- Added implementation patterns (now Step 8, formerly Step 5.5) -- Created principle-based pattern-categories.csv (7 principles, not 118 prescriptions) -- Core principle: "What could agents decide differently?" -- LLM uses principle to identify patterns beyond the categories -- Prevents agent conflicts through intelligent pattern discovery - -**1.1.0** - Enhanced with starter template discovery and version verification - -- Added intelligent starter template detection and integration (now Step 2) -- Added dynamic version verification via web search -- Starter decisions are documented as "PROVIDED BY STARTER" -- First implementation story uses starter initialization command - -**1.0.0** - Initial release replacing architecture workflow - ---- - -**Related Documentation:** - -- [Solutioning Workflows](./workflows-solutioning.md) -- [Planning Workflows](./workflows-planning.md) -- [Scale Adaptive System](./scale-adaptive-system.md) diff --git a/.bmad/bmm/docs/workflow-document-project-reference.md b/.bmad/bmm/docs/workflow-document-project-reference.md deleted file mode 100644 index dfffd092..00000000 --- a/.bmad/bmm/docs/workflow-document-project-reference.md +++ /dev/null @@ -1,487 +0,0 @@ -# Document Project Workflow - Technical Reference - -**Module:** BMM (BMAD Method Module) -**Type:** Action Workflow (Documentation Generator) - ---- - -## Purpose - -Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type. - -**NEW in v1.2.0:** Context-safe architecture with scan levels, resumability, and write-as-you-go pattern to prevent context exhaustion. - ---- - -## Key Features - -- **Multi-Project Type Support**: Handles web, backend, mobile, CLI, game, embedded, data, infra, library, desktop, and extension projects -- **Multi-Part Detection**: Automatically detects and documents projects with separate client/server or multiple services -- **Three Scan Levels** (NEW v1.2.0): Quick (2-5 min), Deep (10-30 min), Exhaustive (30-120 min) -- **Resumability** (NEW v1.2.0): Interrupt and resume workflows without losing progress -- **Write-as-you-go** (NEW v1.2.0): Documents written immediately to prevent context exhaustion -- **Intelligent Batching** (NEW v1.2.0): Subfolder-based processing for deep/exhaustive scans -- **Data-Driven Analysis**: Uses CSV-based project type detection and documentation requirements -- **Comprehensive Scanning**: Analyzes APIs, data models, UI components, configuration, security patterns, and more -- **Architecture Matching**: Matches projects to 170+ architecture templates from the solutioning registry -- **Brownfield PRD Ready**: Generates documentation specifically designed for AI agents planning new features - ---- - -## How to Invoke - -```bash -workflow document-project -``` - -Or from BMAD CLI: - -```bash -/bmad:bmm:workflows:document-project -``` - ---- - -## Scan Levels (NEW in v1.2.0) - -Choose the right scan depth for your needs: - -### 1. Quick Scan (Default) - -**Duration:** 2-5 minutes -**What it does:** Pattern-based analysis without reading source files -**Reads:** Config files, package manifests, directory structure, README -**Use when:** - -- You need a fast project overview -- Initial understanding of project structure -- Planning next steps before deeper analysis - -**Does NOT read:** Source code files (_.js, _.ts, _.py, _.go, etc.) - -### 2. Deep Scan - -**Duration:** 10-30 minutes -**What it does:** Reads files in critical directories based on project type -**Reads:** Files in critical paths defined by documentation requirements -**Use when:** - -- Creating comprehensive documentation for brownfield PRD -- Need detailed analysis of key areas -- Want balance between depth and speed - -**Example:** For a web app, reads controllers/, models/, components/, but not every utility file - -### 3. Exhaustive Scan - -**Duration:** 30-120 minutes -**What it does:** Reads ALL source files in project -**Reads:** Every source file (excludes node_modules, dist, build, .git) -**Use when:** - -- Complete project analysis needed -- Migration planning requires full understanding -- Detailed audit of entire codebase -- Deep technical debt assessment - -**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice) - ---- - -## Resumability (NEW in v1.2.0) - -The workflow can be interrupted and resumed without losing progress: - -- **State Tracking:** Progress saved in `project-scan-report.json` -- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old) -- **Resume Prompt:** Choose to resume or start fresh -- **Step-by-Step:** Resume from exact step where interrupted -- **Archiving:** Old state files automatically archived - -**Example Resume Flow:** - -``` -> workflow document-project - -I found an in-progress workflow state from 2025-10-11 14:32:15. - -Current Progress: -- Mode: initial_scan -- Scan Level: deep -- Completed Steps: 5/12 -- Last Step: step_5 - -Would you like to: -1. Resume from where we left off - Continue from step 6 -2. Start fresh - Archive old state and begin new scan -3. Cancel - Exit without changes - -Your choice [1/2/3]: -``` - ---- - -## What It Does - -### Step-by-Step Process - -1. **Detects Project Structure** - Identifies if project is single-part or multi-part (client/server/etc.) -2. **Classifies Project Type** - Matches against 12 project types (web, backend, mobile, etc.) -3. **Discovers Documentation** - Finds existing README, CONTRIBUTING, ARCHITECTURE files -4. **Analyzes Tech Stack** - Parses package files, identifies frameworks, versions, dependencies -5. **Conditional Scanning** - Performs targeted analysis based on project type requirements: - - API routes and endpoints - - Database models and schemas - - State management patterns - - UI component libraries - - Configuration and security - - CI/CD and deployment configs -6. **Generates Source Tree** - Creates annotated directory structure with critical paths -7. **Extracts Dev Instructions** - Documents setup, build, run, and test commands -8. **Creates Architecture Docs** - Generates detailed architecture using matched templates -9. **Builds Master Index** - Creates comprehensive index.md as primary AI retrieval source -10. **Validates Output** - Runs 140+ point checklist to ensure completeness - -### Output Files - -**Single-Part Projects:** - -- `index.md` - Master index -- `project-overview.md` - Executive summary -- `architecture.md` - Detailed architecture -- `source-tree-analysis.md` - Annotated directory tree -- `component-inventory.md` - Component catalog (if applicable) -- `development-guide.md` - Local dev instructions -- `api-contracts.md` - API documentation (if applicable) -- `data-models.md` - Database schema (if applicable) -- `deployment-guide.md` - Deployment process (optional) -- `contribution-guide.md` - Contributing guidelines (optional) -- `project-scan-report.json` - State file for resumability (NEW v1.2.0) - -**Multi-Part Projects (e.g., client + server):** - -- `index.md` - Master index with part navigation -- `project-overview.md` - Multi-part summary -- `architecture-{part_id}.md` - Per-part architecture docs -- `source-tree-analysis.md` - Full tree with part annotations -- `component-inventory-{part_id}.md` - Per-part components -- `development-guide-{part_id}.md` - Per-part dev guides -- `integration-architecture.md` - How parts communicate -- `project-parts.json` - Machine-readable metadata -- `project-scan-report.json` - State file for resumability (NEW v1.2.0) -- Additional conditional files per part (API, data models, etc.) - ---- - -## Data Files - -The workflow uses a single comprehensive CSV file: - -**documentation-requirements.csv** - Complete project analysis guide - -- Location: `/.bmad/bmm/workflows/document-project/documentation-requirements.csv` -- 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded) -- 24 columns combining: - - **Detection columns**: `project_type_id`, `key_file_patterns` (identifies project type from codebase) - - **Requirement columns**: `requires_api_scan`, `requires_data_models`, `requires_ui_components`, etc. - - **Pattern columns**: `critical_directories`, `test_file_patterns`, `config_patterns`, etc. -- Self-contained: All project detection AND scanning requirements in one file -- Architecture patterns inferred from tech stack (no external registry needed) - ---- - -## Use Cases - -### Primary Use Case: Brownfield PRD Creation - -After running this workflow, use the generated `index.md` as input to brownfield PRD workflows: - -``` -User: "I want to add a new dashboard feature" -PRD Workflow: Loads docs/index.md -โ†’ Understands existing architecture -โ†’ Identifies reusable components -โ†’ Plans integration with existing APIs -โ†’ Creates contextual PRD with epics and stories -``` - -### Other Use Cases - -- **Onboarding New Developers** - Comprehensive project documentation -- **Architecture Review** - Structured analysis of existing system -- **Technical Debt Assessment** - Identify patterns and anti-patterns -- **Migration Planning** - Understand current state before refactoring - ---- - -## Requirements - -### Recommended Inputs (Optional) - -- Project root directory (defaults to current directory) -- README.md or similar docs (auto-discovered if present) -- User guidance on key areas to focus (workflow will ask) - -### Tools Used - -- File system scanning (Glob, Read, Grep) -- Code analysis -- Git repository analysis (optional) - ---- - -## Configuration - -### Default Output Location - -Files are saved to: `{output_folder}` (from config.yaml) - -Default: `/docs/` folder in project root - -### Customization - -- Modify `documentation-requirements.csv` to adjust scanning patterns for project types -- Add new project types to `project-types.csv` -- Add new architecture templates to `registry.csv` - ---- - -## Example: Multi-Part Web App - -**Input:** - -``` -my-app/ -โ”œโ”€โ”€ client/ # React frontend -โ”œโ”€โ”€ server/ # Express backend -โ””โ”€โ”€ README.md -``` - -**Detection Result:** - -- Repository Type: Monorepo -- Part 1: client (web/React) -- Part 2: server (backend/Express) - -**Output (10+ files):** - -``` -docs/ -โ”œโ”€โ”€ index.md -โ”œโ”€โ”€ project-overview.md -โ”œโ”€โ”€ architecture-client.md -โ”œโ”€โ”€ architecture-server.md -โ”œโ”€โ”€ source-tree-analysis.md -โ”œโ”€โ”€ component-inventory-client.md -โ”œโ”€โ”€ development-guide-client.md -โ”œโ”€โ”€ development-guide-server.md -โ”œโ”€โ”€ api-contracts-server.md -โ”œโ”€โ”€ data-models-server.md -โ”œโ”€โ”€ integration-architecture.md -โ””โ”€โ”€ project-parts.json -``` - ---- - -## Example: Simple CLI Tool - -**Input:** - -``` -hello-cli/ -โ”œโ”€โ”€ main.go -โ”œโ”€โ”€ go.mod -โ””โ”€โ”€ README.md -``` - -**Detection Result:** - -- Repository Type: Monolith -- Part 1: main (cli/Go) - -**Output (4 files):** - -``` -docs/ -โ”œโ”€โ”€ index.md -โ”œโ”€โ”€ project-overview.md -โ”œโ”€โ”€ architecture.md -โ””โ”€โ”€ source-tree-analysis.md -``` - ---- - -## Deep-Dive Mode - -### What is Deep-Dive Mode? - -When you run the workflow on a project that already has documentation, you'll be offered a choice: - -1. **Rescan entire project** - Update all documentation with latest changes -2. **Deep-dive into specific area** - Generate EXHAUSTIVE documentation for a particular feature/module/folder -3. **Cancel** - Keep existing documentation - -Deep-dive mode performs **comprehensive, file-by-file analysis** of a specific area, reading EVERY file completely and documenting: - -- All exports with complete signatures -- All imports and dependencies -- Dependency graphs and data flow -- Code patterns and implementations -- Testing coverage and strategies -- Integration points -- Reuse opportunities - -### When to Use Deep-Dive Mode - -- **Before implementing a feature** - Deep-dive the area you'll be modifying -- **During architecture review** - Deep-dive complex modules -- **For code understanding** - Deep-dive unfamiliar parts of codebase -- **When creating PRDs** - Deep-dive areas affected by new features - -### Deep-Dive Process - -1. Workflow detects existing `index.md` -2. Offers deep-dive option -3. Suggests areas based on project structure: - - API route groups - - Feature modules - - UI component areas - - Services/business logic -4. You select area or specify custom path -5. Workflow reads EVERY file in that area -6. Generates `deep-dive-{area-name}.md` with complete analysis -7. Updates `index.md` with link to deep-dive doc -8. Offers to deep-dive another area or finish - -### Deep-Dive Output Example - -**docs/deep-dive-dashboard-feature.md:** - -- Complete file inventory (47 files analyzed) -- Every export with signatures -- Dependency graph -- Data flow analysis -- Integration points -- Testing coverage -- Related code references -- Implementation guidance -- ~3,000 LOC documented in detail - -### Incremental Deep-Diving - -You can deep-dive multiple areas over time: - -- First run: Scan entire project โ†’ generates index.md -- Second run: Deep-dive dashboard feature -- Third run: Deep-dive API layer -- Fourth run: Deep-dive authentication system - -All deep-dive docs are linked from the master index. - ---- - -## Validation - -The workflow includes a comprehensive 160+ point checklist covering: - -- Project detection accuracy -- Technology stack completeness -- Codebase scanning thoroughness -- Architecture documentation quality -- Multi-part handling (if applicable) -- Brownfield PRD readiness -- Deep-dive completeness (if applicable) - ---- - -## Next Steps After Completion - -1. **Review** `docs/index.md` - Your master documentation index -2. **Validate** - Check generated docs for accuracy -3. **Use for PRD** - Point brownfield PRD workflow to index.md -4. **Maintain** - Re-run workflow when architecture changes significantly - ---- - -## File Structure - -``` -document-project/ -โ”œโ”€โ”€ workflow.yaml # Workflow configuration -โ”œโ”€โ”€ instructions.md # Step-by-step workflow logic -โ”œโ”€โ”€ checklist.md # Validation criteria -โ”œโ”€โ”€ documentation-requirements.csv # Project type scanning patterns -โ”œโ”€โ”€ templates/ # Output templates -โ”‚ โ”œโ”€โ”€ index-template.md -โ”‚ โ”œโ”€โ”€ project-overview-template.md -โ”‚ โ””โ”€โ”€ source-tree-template.md -โ””โ”€โ”€ README.md # This file -``` - ---- - -## Troubleshooting - -**Issue: Project type not detected correctly** - -- Solution: Workflow will ask for confirmation; manually select correct type - -**Issue: Missing critical information** - -- Solution: Provide additional context when prompted; re-run specific analysis steps - -**Issue: Multi-part detection missed a part** - -- Solution: When asked to confirm parts, specify the missing part and its path - -**Issue: Architecture template doesn't match well** - -- Solution: Check registry.csv; may need to add new template or adjust matching criteria - ---- - -## Architecture Improvements in v1.2.0 - -### Context-Safe Design - -The workflow now uses a write-as-you-go architecture: - -- Documents written immediately to disk (not accumulated in memory) -- Detailed findings purged after writing (only summaries kept) -- State tracking enables resumption from any step -- Batching strategy prevents context exhaustion on large projects - -### Batching Strategy - -For deep/exhaustive scans: - -- Process ONE subfolder at a time -- Read files โ†’ Extract info โ†’ Write output โ†’ Validate โ†’ Purge context -- Primary concern is file SIZE (not count) -- Track batches in state file for resumability - -### State File Format - -Optimized JSON (no pretty-printing): - -```json -{ - "workflow_version": "1.2.0", - "timestamps": {...}, - "mode": "initial_scan", - "scan_level": "deep", - "completed_steps": [...], - "current_step": "step_6", - "findings": {"summary": "only"}, - "outputs_generated": [...], - "resume_instructions": "..." -} -``` - ---- - -**Related Documentation:** - -- [Brownfield Development Guide](./brownfield-guide.md) -- [Implementation Workflows](./workflows-implementation.md) -- [Scale Adaptive System](./scale-adaptive-system.md) diff --git a/.bmad/bmm/docs/workflows-analysis.md b/.bmad/bmm/docs/workflows-analysis.md deleted file mode 100644 index cf475ce5..00000000 --- a/.bmad/bmm/docs/workflows-analysis.md +++ /dev/null @@ -1,370 +0,0 @@ -# BMM Analysis Workflows (Phase 1) - -**Reading Time:** ~7 minutes - -## Overview - -Phase 1 (Analysis) workflows are **optional** exploration and discovery tools that help validate ideas, understand markets, and generate strategic context before planning begins. - -**Key principle:** Analysis workflows help you think strategically before committing to implementation. Skip them if your requirements are already clear. - -**When to use:** Starting new projects, exploring opportunities, validating market fit, generating ideas, understanding problem spaces. - -**When to skip:** Continuing existing projects with clear requirements, well-defined features with known solutions, strict constraints where discovery is complete. - ---- - -## Phase 1 Analysis Workflow Map - -```mermaid -%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%% -graph TB - subgraph Discovery["DISCOVERY & IDEATION (Optional)"] - direction LR - BrainstormProject["Analyst: brainstorm-project
Multi-track solution exploration"] - BrainstormGame["Analyst: brainstorm-game
Game concept generation"] - end - - subgraph Research["RESEARCH & VALIDATION (Optional)"] - direction TB - ResearchWF["Analyst: research
โ€ข market (TAM/SAM/SOM)
โ€ข technical (framework evaluation)
โ€ข competitive (landscape)
โ€ข user (personas, JTBD)
โ€ข domain (industry analysis)
โ€ข deep_prompt (AI research)"] - end - - subgraph Strategy["STRATEGIC CAPTURE (Recommended for Greenfield)"] - direction LR - ProductBrief["Analyst: product-brief
Product vision + strategy
(Interactive or YOLO mode)"] - GameBrief["Game Designer: game-brief
Game vision capture
(Interactive or YOLO mode)"] - end - - Discovery -.->|Software| ProductBrief - Discovery -.->|Games| GameBrief - Discovery -.->|Validate ideas| Research - Research -.->|Inform brief| ProductBrief - Research -.->|Inform brief| GameBrief - ProductBrief --> Phase2["Phase 2: prd workflow"] - GameBrief --> Phase2Game["Phase 2: gdd workflow"] - Research -.->|Can feed directly| Phase2 - - style Discovery fill:#e1f5fe,stroke:#01579b,stroke-width:3px,color:#000 - style Research fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000 - style Strategy fill:#f3e5f5,stroke:#4a148c,stroke-width:3px,color:#000 - style Phase2 fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px,color:#000 - style Phase2Game fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px,color:#000 - - style BrainstormProject fill:#81d4fa,stroke:#0277bd,stroke-width:2px,color:#000 - style BrainstormGame fill:#81d4fa,stroke:#0277bd,stroke-width:2px,color:#000 - style ResearchWF fill:#fff59d,stroke:#f57f17,stroke-width:2px,color:#000 - style ProductBrief fill:#ce93d8,stroke:#6a1b9a,stroke-width:2px,color:#000 - style GameBrief fill:#ce93d8,stroke:#6a1b9a,stroke-width:2px,color:#000 -``` - ---- - -## Quick Reference - -| Workflow | Agent | Required | Purpose | Output | -| ---------------------- | ------------- | ----------- | -------------------------------------------------------------- | ---------------------------- | -| **brainstorm-project** | Analyst | No | Explore solution approaches and architectures | Solution options + rationale | -| **brainstorm-game** | Analyst | No | Generate game concepts using creative techniques | Game concepts + evaluation | -| **research** | Analyst | No | Multi-type research (market/technical/competitive/user/domain) | Research reports | -| **product-brief** | Analyst | Recommended | Define product vision and strategy (interactive) | Product Brief document | -| **game-brief** | Game Designer | Recommended | Capture game vision before GDD (interactive) | Game Brief document | - ---- - -## Workflow Descriptions - -### brainstorm-project - -**Purpose:** Generate multiple solution approaches through parallel ideation tracks (architecture, UX, integration, value). - -**Agent:** Analyst - -**When to Use:** - -- Unclear technical approach with business objectives -- Multiple solution paths need evaluation -- Hidden assumptions need discovery -- Innovation beyond obvious solutions - -**Key Outputs:** - -- Architecture proposals with trade-off analysis -- Value framework (prioritized features) -- Risk analysis (dependencies, challenges) -- Strategic recommendation with rationale - -**Example:** "We need a customer dashboard" โ†’ Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation. - ---- - -### brainstorm-game - -**Purpose:** Generate game concepts through systematic creative exploration using five brainstorming techniques. - -**Agent:** Analyst - -**When to Use:** - -- Generating original game concepts -- Exploring variations on themes -- Breaking creative blocks -- Validating game ideas against constraints - -**Techniques Used:** - -- SCAMPER (systematic modification) -- Mind Mapping (hierarchical exploration) -- Lotus Blossom (radial expansion) -- Six Thinking Hats (multi-perspective) -- Random Word Association (lateral thinking) - -**Key Outputs:** - -- Method-specific artifacts (5 separate documents) -- Consolidated concept document with feasibility -- Design pillar alignment matrix - -**Example:** "Roguelike with psychological themes" โ†’ Emotions as characters, inner demons as enemies, therapy sessions as rest points, deck composition affects narrative. - ---- - -### research - -**Purpose:** Comprehensive multi-type research system consolidating market, technical, competitive, user, and domain analysis. - -**Agent:** Analyst - -**Research Types:** - -| Type | Purpose | Use When | -| --------------- | ------------------------------------------------------ | ----------------------------------- | -| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation | -| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms | -| **competitive** | Deep competitor analysis | Understanding competitive landscape | -| **user** | Customer insights, personas, JTBD | Need user understanding | -| **domain** | Industry deep dives, trends | Understanding domain/industry | -| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research | - -**Key Features:** - -- Real-time web research -- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle) -- Platform-specific optimization for deep_prompt type -- Configurable research depth (quick/standard/comprehensive) - -**Example (market):** "SaaS project management tool" โ†’ TAM $50B, SAM $5B, SOM $50M, top competitors (Asana, Monday), positioning recommendation. - ---- - -### product-brief - -**Purpose:** Interactive product brief creation that guides strategic product vision definition. - -**Agent:** Analyst - -**When to Use:** - -- Starting new product/major feature initiative -- Aligning stakeholders before detailed planning -- Transitioning from exploration to strategy -- Need executive-level product documentation - -**Modes:** - -- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions -- **YOLO Mode**: AI generates complete draft from context, then iterative refinement - -**Key Outputs:** - -- Executive summary -- Problem statement with evidence -- Proposed solution and differentiators -- Target users (segmented) -- MVP scope (ruthlessly defined) -- Financial impact and ROI -- Strategic alignment -- Risks and open questions - -**Integration:** Feeds directly into PRD workflow (Phase 2). - ---- - -### game-brief - -**Purpose:** Lightweight interactive brainstorming session capturing game vision before Game Design Document. - -**Agent:** Game Designer - -**When to Use:** - -- Starting new game project -- Exploring game ideas before committing -- Pitching concepts to team/stakeholders -- Validating market fit and feasibility - -**Game Brief vs GDD:** - -| Aspect | Game Brief | GDD | -| ------------ | ------------------ | ------------------------- | -| Purpose | Validate concept | Design for implementation | -| Detail Level | High-level vision | Detailed specs | -| Format | Conversational | Structured | -| Output | Concise vision doc | Comprehensive design | - -**Key Outputs:** - -- Game vision (concept, pitch) -- Target market and positioning -- Core gameplay pillars -- Scope and constraints -- Reference framework -- Risk assessment -- Success criteria - -**Integration:** Feeds into GDD workflow (Phase 2). - ---- - -## Decision Guide - -### Starting a Software Project - -``` -brainstorm-project (if unclear) โ†’ research (market/technical) โ†’ product-brief โ†’ Phase 2 (prd) -``` - -### Starting a Game Project - -``` -brainstorm-game (if generating concepts) โ†’ research (market/competitive) โ†’ game-brief โ†’ Phase 2 (gdd) -``` - -### Validating an Idea - -``` -research (market type) โ†’ product-brief or game-brief โ†’ Phase 2 -``` - -### Technical Decision Only - -``` -research (technical type) โ†’ Use findings in Phase 3 (architecture) -``` - -### Understanding Market - -``` -research (market/competitive type) โ†’ product-brief โ†’ Phase 2 -``` - ---- - -## Integration with Phase 2 (Planning) - -Analysis outputs feed directly into Planning: - -| Analysis Output | Planning Input | -| --------------------------- | -------------------------- | -| product-brief.md | **prd** workflow | -| game-brief.md | **gdd** workflow | -| market-research.md | **prd** context | -| technical-research.md | **architecture** (Phase 3) | -| competitive-intelligence.md | **prd** positioning | - -Planning workflows automatically load these documents if they exist in the output folder. - ---- - -## Best Practices - -### 1. Don't Over-Invest in Analysis - -Analysis is optional. If requirements are clear, skip to Phase 2 (Planning). - -### 2. Iterate Between Workflows - -Common pattern: brainstorm โ†’ research (validate) โ†’ brief (synthesize) - -### 3. Document Assumptions - -Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge. - -### 4. Keep It Strategic - -Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning. - -### 5. Involve Stakeholders - -Use analysis workflows to align stakeholders before committing to detailed planning. - ---- - -## Common Patterns - -### Greenfield Software (Full Analysis) - -``` -1. brainstorm-project - explore approaches -2. research (market) - validate viability -3. product-brief - capture strategic vision -4. โ†’ Phase 2: prd -``` - -### Greenfield Game (Full Analysis) - -``` -1. brainstorm-game - generate concepts -2. research (competitive) - understand landscape -3. game-brief - capture vision -4. โ†’ Phase 2: gdd -``` - -### Skip Analysis (Clear Requirements) - -``` -โ†’ Phase 2: prd or tech-spec directly -``` - -### Technical Research Only - -``` -1. research (technical) - evaluate technologies -2. โ†’ Phase 3: architecture (use findings in ADRs) -``` - ---- - -## Related Documentation - -- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) -- [Phase 4: Implementation Workflows](./workflows-implementation.md) -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity -- [Agents Guide](./agents-guide.md) - Complete agent reference - ---- - -## Troubleshooting - -**Q: Do I need to run all analysis workflows?** -A: No! Analysis is entirely optional. Use only workflows that help you think through your problem. - -**Q: Which workflow should I start with?** -A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief` or `game-brief`. - -**Q: Can I skip straight to Planning?** -A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/gdd/tech-spec). - -**Q: How long should Analysis take?** -A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning. - -**Q: What if I discover problems during Analysis?** -A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment. - -**Q: Should brownfield projects do Analysis?** -A: Usually no. Start with `document-project` (Phase 0), then skip to Planning (Phase 2). - ---- - -_Phase 1 Analysis - Optional strategic thinking before commitment._ diff --git a/.bmad/bmm/docs/workflows-implementation.md b/.bmad/bmm/docs/workflows-implementation.md deleted file mode 100644 index f4df3cd1..00000000 --- a/.bmad/bmm/docs/workflows-implementation.md +++ /dev/null @@ -1,284 +0,0 @@ -# BMM Implementation Workflows (Phase 4) - -**Reading Time:** ~8 minutes - -## Overview - -Phase 4 (Implementation) workflows manage the iterative sprint-based development cycle using a **story-centric workflow** where each story moves through a defined lifecycle from creation to completion. - -**Key principle:** One story at a time, move it through the entire lifecycle before starting the next. - ---- - -## Phase 4 Workflow Lifecycle - -```mermaid -%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%% -graph TB - subgraph Setup["SPRINT SETUP - Run Once"] - direction TB - SprintPlanning["SM: sprint-planning
Initialize sprint status file"] - end - - subgraph EpicCycle["EPIC CYCLE - Repeat Per Epic"] - direction TB - EpicContext["SM: epic-tech-context
Generate epic technical guidance"] - ValidateEpic["SM: validate-epic-tech-context
(Optional validation)"] - - EpicContext -.->|Optional| ValidateEpic - ValidateEpic -.-> StoryLoopStart - EpicContext --> StoryLoopStart[Start Story Loop] - end - - subgraph StoryLoop["STORY LIFECYCLE - Repeat Per Story"] - direction TB - - CreateStory["SM: create-story
Create next story from queue"] - ValidateStory["SM: validate-create-story
(Optional validation)"] - StoryContext["SM: story-context
Assemble dynamic context"] - StoryReady["SM: story-ready-for-dev
Mark ready without context"] - ValidateContext["SM: validate-story-context
(Optional validation)"] - DevStory["DEV: develop-story
Implement with tests"] - CodeReview["DEV: code-review
Senior dev review"] - StoryDone["DEV: story-done
Mark complete, advance queue"] - - CreateStory -.->|Optional| ValidateStory - ValidateStory -.-> StoryContext - CreateStory --> StoryContext - CreateStory -.->|Alternative| StoryReady - StoryContext -.->|Optional| ValidateContext - ValidateContext -.-> DevStory - StoryContext --> DevStory - StoryReady -.-> DevStory - DevStory --> CodeReview - CodeReview -.->|Needs fixes| DevStory - CodeReview --> StoryDone - StoryDone -.->|Next story| CreateStory - end - - subgraph EpicClose["EPIC COMPLETION"] - direction TB - Retrospective["SM: epic-retrospective
Post-epic lessons learned"] - end - - subgraph Support["SUPPORTING WORKFLOWS"] - direction TB - CorrectCourse["SM: correct-course
Handle mid-sprint changes"] - WorkflowStatus["Any Agent: workflow-status
Check what's next"] - end - - Setup --> EpicCycle - EpicCycle --> StoryLoop - StoryLoop --> EpicClose - EpicClose -.->|Next epic| EpicCycle - StoryLoop -.->|If issues arise| CorrectCourse - StoryLoop -.->|Anytime| WorkflowStatus - EpicCycle -.->|Anytime| WorkflowStatus - - style Setup fill:#e3f2fd,stroke:#1565c0,stroke-width:3px,color:#000 - style EpicCycle fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000 - style StoryLoop fill:#f3e5f5,stroke:#6a1b9a,stroke-width:3px,color:#000 - style EpicClose fill:#ffcc80,stroke:#e65100,stroke-width:3px,color:#000 - style Support fill:#fff3e0,stroke:#e65100,stroke-width:3px,color:#000 - - style SprintPlanning fill:#90caf9,stroke:#0d47a1,stroke-width:2px,color:#000 - style EpicContext fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000 - style ValidateEpic fill:#c5e1a5,stroke:#33691e,stroke-width:1px,color:#000 - style CreateStory fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000 - style ValidateStory fill:#e1bee7,stroke:#6a1b9a,stroke-width:1px,color:#000 - style StoryContext fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000 - style StoryReady fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000 - style ValidateContext fill:#e1bee7,stroke:#6a1b9a,stroke-width:1px,color:#000 - style DevStory fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000 - style CodeReview fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000 - style StoryDone fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000 - style Retrospective fill:#ffb74d,stroke:#e65100,stroke-width:2px,color:#000 -``` - ---- - -## Quick Reference - -| Workflow | Agent | When | Purpose | -| ------------------------------ | ----- | -------------------------------- | ------------------------------------------- | -| **sprint-planning** | SM | Once at Phase 4 start | Initialize sprint tracking file | -| **epic-tech-context** | SM | Per epic | Generate epic-specific technical guidance | -| **validate-epic-tech-context** | SM | Optional after epic-tech-context | Validate tech spec against checklist | -| **create-story** | SM | Per story | Create next story from epic backlog | -| **validate-create-story** | SM | Optional after create-story | Independent validation of story draft | -| **story-context** | SM | Optional per story | Assemble dynamic story context XML | -| **validate-story-context** | SM | Optional after story-context | Validate story context against checklist | -| **story-ready-for-dev** | SM | Optional per story | Mark story ready without generating context | -| **develop-story** | DEV | Per story | Implement story with tests | -| **code-review** | DEV | Per story | Senior dev quality review | -| **story-done** | DEV | Per story | Mark complete and advance queue | -| **epic-retrospective** | SM | After epic complete | Review lessons and extract insights | -| **correct-course** | SM | When issues arise | Handle significant mid-sprint changes | -| **workflow-status** | Any | Anytime | Check "what should I do now?" | - ---- - -## Agent Roles - -### SM (Scrum Master) - Primary Implementation Orchestrator - -**Workflows:** sprint-planning, epic-tech-context, validate-epic-tech-context, create-story, validate-create-story, story-context, validate-story-context, story-ready-for-dev, epic-retrospective, correct-course - -**Responsibilities:** - -- Initialize and maintain sprint tracking -- Generate technical context (epic and story level) -- Orchestrate story lifecycle with optional validations -- Mark stories ready for development -- Handle course corrections -- Facilitate retrospectives - -### DEV (Developer) - Implementation and Quality - -**Workflows:** develop-story, code-review, story-done - -**Responsibilities:** - -- Implement stories with tests -- Perform senior developer code reviews -- Mark stories complete and advance queue -- Ensure quality and adherence to standards - ---- - -## Story Lifecycle States - -Stories move through these states in the sprint status file: - -1. **TODO** - Story identified but not started -2. **IN PROGRESS** - Story being implemented (create-story โ†’ story-context โ†’ dev-story) -3. **READY FOR REVIEW** - Implementation complete, awaiting code review -4. **DONE** - Accepted and complete - ---- - -## Typical Sprint Flow - -### Sprint 0 (Planning Phase) - -- Complete Phases 1-3 (Analysis, Planning, Solutioning) -- PRD/GDD + Architecture + Epics ready - -### Sprint 1+ (Implementation Phase) - -**Start of Phase 4:** - -1. SM runs `sprint-planning` (once) - -**Per Epic:** - -1. SM runs `epic-tech-context` -2. SM optionally runs `validate-epic-tech-context` - -**Per Story (repeat until epic complete):** - -1. SM runs `create-story` -2. SM optionally runs `validate-create-story` -3. SM runs `story-context` OR `story-ready-for-dev` (choose one) -4. SM optionally runs `validate-story-context` (if story-context was used) -5. DEV runs `develop-story` -6. DEV runs `code-review` -7. If code review passes: DEV runs `story-done` -8. If code review finds issues: DEV fixes in `develop-story`, then back to code-review - -**After Epic Complete:** - -- SM runs `epic-retrospective` -- Move to next epic (start with `epic-tech-context` again) - -**As Needed:** - -- Run `workflow-status` anytime to check progress -- Run `correct-course` if significant changes needed - ---- - -## Key Principles - -### One Story at a Time - -Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality. - -### Epic-Level Technical Context - -Generate detailed technical guidance per epic (not per story) using `epic-tech-context`. This provides just-in-time architecture without upfront over-planning. - -### Story Context (Optional) - -Use `story-context` to assemble focused context XML for each story, pulling from PRD, architecture, epic context, and codebase docs. Alternatively, use `story-ready-for-dev` to mark a story ready without generating context XML. - -### Quality Gates - -Every story goes through `code-review` before being marked done. No exceptions. - -### Continuous Tracking - -The `sprint-status.yaml` file is the single source of truth for all implementation progress. - ---- - -## Common Patterns - -### Level 0-1 (Quick Flow) - -``` -tech-spec (PM) - โ†’ sprint-planning (SM) - โ†’ story loop (SM/DEV) -``` - -### Level 2-4 (BMad Method / Enterprise) - -``` -PRD + Architecture (PM/Architect) - โ†’ solutioning-gate-check (Architect) - โ†’ sprint-planning (SM, once) - โ†’ [Per Epic]: - epic-tech-context (SM) - โ†’ story loop (SM/DEV) - โ†’ epic-retrospective (SM) - โ†’ [Next Epic] -``` - ---- - -## Related Documentation - -- [Phase 2: Planning Workflows](./workflows-planning.md) -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) -- [Quick Spec Flow](./quick-spec-flow.md) - Level 0-1 fast track -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project levels - ---- - -## Troubleshooting - -**Q: Which workflow should I run next?** -A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do. - -**Q: Story needs significant changes mid-implementation?** -A: Run `correct-course` to analyze impact and route appropriately. - -**Q: Do I run epic-tech-context for every story?** -A: No! Run once per epic, not per story. Use `story-context` or `story-ready-for-dev` per story instead. - -**Q: Do I have to use story-context for every story?** -A: No, it's optional. You can use `story-ready-for-dev` to mark a story ready without generating context XML. - -**Q: Can I work on multiple stories in parallel?** -A: Not recommended. Complete one story's full lifecycle before starting the next. Prevents context switching and ensures quality. - -**Q: What if code review finds issues?** -A: DEV runs `develop-story` to make fixes, re-runs tests, then runs `code-review` again until it passes. - -**Q: When do I run validations?** -A: Validations are optional quality gates. Use them when you want independent review of epic tech specs, story drafts, or story context before proceeding. - ---- - -_Phase 4 Implementation - One story at a time, done right._ diff --git a/.bmad/bmm/docs/workflows-planning.md b/.bmad/bmm/docs/workflows-planning.md deleted file mode 100644 index 19b32876..00000000 --- a/.bmad/bmm/docs/workflows-planning.md +++ /dev/null @@ -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["START: workflow-init
Discovery + routing"] - - subgraph QuickFlow["QUICK FLOW (Simple Planning)"] - direction TB - TechSpec["PM: tech-spec
Technical document
โ†’ Story or Epic+Stories
1-15 stories typically"] - end - - subgraph BMadMethod["BMAD METHOD (Recommended)"] - direction TB - PRD["PM: prd
Strategic PRD"] - GDD["Game Designer: gdd
Game design doc"] - Narrative["Game Designer: narrative
Story-driven design"] - - Epics["PM: create-epics-and-stories
Epic+Stories breakdown
10-50+ stories typically"] - - UXDesign["UX Designer: ux
Optional UX specification"] - end - - subgraph Enterprise["ENTERPRISE METHOD"] - direction TB - EntNote["Uses BMad Method Planning
+
Extended Phase 3 workflows
(Architecture + Security + DevOps)
30+ stories typically"] - end - - subgraph Updates["MID-STREAM UPDATES (Anytime)"] - direction LR - CorrectCourse["PM/SM: correct-course
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["Phase 4: Implementation"] - Epics --> Phase3["Phase 3: Architecture"] - Enterprise -.->|Uses BMad planning| Epics - Enterprise --> Phase3Ext["Phase 3: Extended
(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._ diff --git a/.bmad/bmm/docs/workflows-solutioning.md b/.bmad/bmm/docs/workflows-solutioning.md deleted file mode 100644 index f1a38e18..00000000 --- a/.bmad/bmm/docs/workflows-solutioning.md +++ /dev/null @@ -1,501 +0,0 @@ -# BMM Solutioning Workflows (Phase 3) - -**Reading Time:** ~8 minutes - -## Overview - -Phase 3 (Solutioning) workflows translate **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins. - -**Key principle:** Make technical decisions explicit and documented so all agents implement consistently. Prevent one agent choosing REST while another chooses GraphQL. - -**Required for:** BMad Method (complex projects), Enterprise Method - -**Optional for:** BMad Method (simple projects), Quick Flow (skip entirely) - ---- - -## Phase 3 Solutioning Workflow Map - -```mermaid -%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%% -graph TB - FromPlanning["FROM Phase 2 Planning
PRD/GDD/Tech-Spec complete"] - - subgraph QuickFlow["QUICK FLOW PATH"] - direction TB - SkipArch["Skip Phase 3
Go directly to Implementation"] - end - - subgraph BMadEnterprise["BMAD METHOD + ENTERPRISE (Same Start)"] - direction TB - Architecture["Architect: architecture
System design + ADRs"] - - subgraph Optional["ENTERPRISE ADDITIONS (Optional)"] - direction LR - SecArch["Architect: security-architecture
(Future)"] - DevOps["Architect: devops-strategy
(Future)"] - end - - GateCheck["Architect: solutioning-gate-check
Validation before Phase 4"] - - Architecture -.->|Enterprise only| Optional - Architecture --> GateCheck - Optional -.-> GateCheck - end - - subgraph Result["GATE CHECK RESULTS"] - direction LR - Pass["โœ… PASS
Proceed to Phase 4"] - Concerns["โš ๏ธ CONCERNS
Proceed with caution"] - Fail["โŒ FAIL
Resolve issues first"] - end - - FromPlanning -->|Quick Flow| QuickFlow - FromPlanning -->|BMad Method
or Enterprise| Architecture - - QuickFlow --> Phase4["Phase 4: Implementation"] - GateCheck --> Result - Pass --> Phase4 - Concerns --> Phase4 - Fail -.->|Fix issues| Architecture - - style FromPlanning fill:#e1bee7,stroke:#6a1b9a,stroke-width:2px,color:#000 - style QuickFlow fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000 - style BMadEnterprise fill:#90caf9,stroke:#0d47a1,stroke-width:3px,color:#000 - style Optional fill:#ffcdd2,stroke:#c62828,stroke-width:3px,color:#000 - style Result fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000 - style Phase4 fill:#ffcc80,stroke:#e65100,stroke-width:2px,color:#000 - - style SkipArch fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000 - style Architecture fill:#42a5f5,stroke:#0d47a1,stroke-width:2px,color:#000 - style SecArch fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000 - style DevOps fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000 - style GateCheck fill:#42a5f5,stroke:#0d47a1,stroke-width:2px,color:#000 - style Pass fill:#81c784,stroke:#388e3c,stroke-width:2px,color:#000 - style Concerns fill:#ffb74d,stroke:#f57f17,stroke-width:2px,color:#000 - style Fail fill:#e57373,stroke:#d32f2f,stroke-width:2px,color:#000 -``` - ---- - -## Quick Reference - -| Workflow | Agent | Track | Purpose | -| -------------------------- | --------- | ------------------------ | ------------------------------------------- | -| **architecture** | Architect | BMad Method, Enterprise | Technical architecture and design decisions | -| **solutioning-gate-check** | Architect | BMad Complex, Enterprise | Validate planning/solutioning completeness | - -**When to Skip Solutioning:** - -- **Quick Flow:** Simple changes don't need architecture โ†’ Skip to Phase 4 - -**When Solutioning is Required:** - -- **BMad Method:** Multi-epic projects need architecture to prevent conflicts -- **Enterprise:** Same as BMad Method, plus optional extended workflows (test architecture, security architecture, devops strategy) added AFTER architecture but BEFORE gate check - ---- - -## Why Solutioning Matters - -### The Problem Without Solutioning - -``` -Agent 1 implements Epic 1 using REST API -Agent 2 implements Epic 2 using GraphQL -Result: Inconsistent API design, integration nightmare -``` - -### The Solution With Solutioning - -``` -architecture workflow decides: "Use GraphQL for all APIs" -All agents follow architecture decisions -Result: Consistent implementation, no conflicts -``` - -### Solutioning vs Planning - -| Aspect | Planning (Phase 2) | Solutioning (Phase 3) | -| -------- | ------------------ | ------------------------ | -| Question | What and Why? | How? | -| Output | Requirements | Technical Design | -| Agent | PM | Architect | -| Audience | Stakeholders | Developers | -| Document | PRD/GDD | Architecture + Tech Spec | -| Level | Business logic | Implementation detail | - ---- - -## Workflow Descriptions - -### architecture - -**Purpose:** Make technical decisions explicit to prevent agent conflicts. Produces decision-focused architecture document optimized for AI consistency. - -**Agent:** Architect - -**When to Use:** - -- Multi-epic projects (BMad Complex, Enterprise) -- Cross-cutting technical concerns -- Multiple agents implementing different parts -- Integration complexity exists -- Technology choices need alignment - -**When to Skip:** - -- Quick Flow (simple changes) -- BMad Method Simple with straightforward tech stack -- Single epic with clear technical approach - -**Adaptive Conversation Approach:** - -This is NOT a template filler. The architecture workflow: - -1. **Discovers** technical needs through conversation -2. **Proposes** architectural options with trade-offs -3. **Documents** decisions that prevent agent conflicts -4. **Focuses** on decision points, not exhaustive documentation - -**Key Outputs:** - -**architecture.md** containing: - -1. **Architecture Overview** - System context, principles, style -2. **System Architecture** - High-level diagram, component interactions, communication patterns -3. **Data Architecture** - Database design, state management, caching, data flow -4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning, error handling -5. **Frontend Architecture** (if applicable) - Framework, state management, component architecture, routing -6. **Integration Architecture** - Third-party integrations, message queuing, event-driven patterns -7. **Security Architecture** - Auth/authorization, data protection, security boundaries -8. **Deployment Architecture** - Deployment model, CI/CD, environment strategy, monitoring -9. **Architecture Decision Records (ADRs)** - Key decisions with context, options, trade-offs, rationale -10. **Epic-Specific Guidance** - Technical notes per epic, implementation priorities, dependencies -11. **Standards and Conventions** - Directory structure, naming conventions, code organization, testing - -**ADR Format (Brief):** - -```markdown -## ADR-001: Use GraphQL for All APIs - -**Status:** Accepted | **Date:** 2025-11-02 - -**Context:** PRD requires flexible querying across multiple epics - -**Decision:** Use GraphQL for all client-server communication - -**Options Considered:** - -1. REST - Familiar but requires multiple endpoints -2. GraphQL - Flexible querying, learning curve -3. gRPC - High performance, poor browser support - -**Rationale:** - -- PRD requires flexible data fetching (Epic 1, 3) -- Mobile app needs bandwidth optimization (Epic 2) -- Team has GraphQL experience - -**Consequences:** - -- Positive: Flexible querying, reduced versioning -- Negative: Caching complexity, N+1 query risk -- Mitigation: Use DataLoader for batching - -**Implications for Epics:** - -- Epic 1: User Management โ†’ GraphQL mutations -- Epic 2: Mobile App โ†’ Optimized queries -``` - -**Example:** E-commerce platform โ†’ Monolith + PostgreSQL + Redis + Next.js + GraphQL, with ADRs explaining each choice and epic-specific guidance. - -**Integration:** Feeds into Phase 4 (Implementation). All dev agents reference architecture during implementation. - ---- - -### solutioning-gate-check - -**Purpose:** Systematically validate that planning and solutioning are complete and aligned before Phase 4 implementation. Ensures PRD, architecture, and stories are cohesive with no gaps. - -**Agent:** Architect - -**When to Use:** - -- **Always** before Phase 4 for BMad Complex and Enterprise projects -- After architecture workflow completes -- Before sprint-planning workflow -- When stakeholders request readiness check - -**When to Skip:** - -- Quick Flow (no solutioning) -- BMad Simple (no gate check required) - -**Purpose of Gate Check:** - -**Prevents:** - -- โŒ Architecture doesn't address all epics -- โŒ Stories conflict with architecture decisions -- โŒ Requirements ambiguous or contradictory -- โŒ Missing critical dependencies - -**Ensures:** - -- โœ… PRD โ†’ Architecture โ†’ Stories alignment -- โœ… All epics have clear technical approach -- โœ… No contradictions or gaps -- โœ… Team ready to implement - -**Check Criteria:** - -**PRD/GDD Completeness:** - -- Problem statement clear and evidence-based -- Success metrics defined -- User personas identified -- Feature requirements complete -- All epics defined with objectives -- Non-functional requirements (NFRs) specified -- Risks and assumptions documented - -**Architecture Completeness:** - -- System architecture defined -- Data architecture specified -- API architecture decided -- Key ADRs documented -- Security architecture addressed -- Epic-specific guidance provided -- Standards and conventions defined - -**Epic/Story Completeness:** - -- All PRD features mapped to stories -- Stories have acceptance criteria -- Stories prioritized (P0/P1/P2/P3) -- Dependencies identified -- Story sequencing logical - -**Alignment Checks:** - -- Architecture addresses all PRD requirements -- Stories align with architecture decisions -- No contradictions between epics -- NFRs have technical approach -- Integration points clear - -**Gate Decision Logic:** - -**โœ… PASS** - -- All critical criteria met -- Minor gaps acceptable with documented plan -- **Action:** Proceed to Phase 4 - -**โš ๏ธ CONCERNS** - -- Some criteria not met but not blockers -- Gaps identified with clear resolution path -- **Action:** Proceed with caution, address gaps in parallel - -**โŒ FAIL** - -- Critical gaps or contradictions -- Architecture missing key decisions -- Stories conflict with PRD/architecture -- **Action:** BLOCK Phase 4, resolve issues first - -**Key Outputs:** - -**solutioning-gate-check.md** containing: - -1. Executive Summary (PASS/CONCERNS/FAIL) -2. Completeness Assessment (scores for PRD, Architecture, Epics) -3. Alignment Assessment (PRDโ†”Architecture, Architectureโ†”Epics, cross-epic consistency) -4. Quality Assessment (story quality, dependencies, risks) -5. Gaps and Recommendations (critical/minor gaps, remediation) -6. Gate Decision with rationale -7. Next Steps - -**Example:** E-commerce platform โ†’ CONCERNS โš ๏ธ due to missing security architecture and undefined payment gateway. Recommendation: Complete security section and add payment gateway ADR before proceeding. - ---- - -## Integration with Planning and Implementation - -### Planning โ†’ Solutioning Flow - -**Quick Flow:** - -``` -Planning (tech-spec by PM) - โ†’ Skip Solutioning - โ†’ Phase 4 (Implementation) -``` - -**BMad Method:** - -``` -Planning (prd by PM) - โ†’ architecture (Architect) - โ†’ solutioning-gate-check (Architect) - โ†’ Phase 4 (Implementation) -``` - -**Enterprise:** - -``` -Planning (prd by PM - same as BMad Method) - โ†’ architecture (Architect) - โ†’ Optional: security-architecture (Architect, future) - โ†’ Optional: devops-strategy (Architect, future) - โ†’ solutioning-gate-check (Architect) - โ†’ Phase 4 (Implementation) -``` - -**Note on TEA (Test Architect):** TEA is fully operational with 8 workflows across all phases. TEA validates architecture testability during Phase 3 reviews but does not have a dedicated solutioning workflow. TEA's primary setup occurs in Phase 2 (`*framework`, `*ci`, `*test-design`) and testing execution in Phase 4 (`*atdd`, `*automate`, `*test-review`, `*trace`, `*nfr-assess`). - -**Note:** Enterprise uses the same planning and architecture as BMad Method. The only difference is optional extended workflows added AFTER architecture but BEFORE gate check. - -### Solutioning โ†’ Implementation Handoff - -**Documents Produced:** - -1. **architecture.md** โ†’ Guides all dev agents during implementation -2. **ADRs** (in architecture) โ†’ Referenced by agents for technical decisions -3. **solutioning-gate-check.md** โ†’ Confirms readiness for Phase 4 - -**How Implementation Uses Solutioning:** - -- **sprint-planning** - Loads architecture for epic sequencing -- **dev-story** - References architecture decisions and ADRs -- **code-review** - Validates code follows architectural standards - ---- - -## Best Practices - -### 1. Make Decisions Explicit - -Don't leave technology choices implicit. Document decisions with rationale in ADRs so agents understand context. - -### 2. Focus on Agent Conflicts - -Architecture's primary job is preventing conflicting implementations. Focus on cross-cutting concerns. - -### 3. Use ADRs for Key Decisions - -Every significant technology choice should have an ADR explaining "why", not just "what". - -### 4. Keep It Practical - -Don't over-architect simple projects. BMad Simple projects need simple architecture. - -### 5. Run Gate Check Before Implementation - -Catching alignment issues in solutioning is 10ร— faster than discovering them mid-implementation. - -### 6. Iterate Architecture - -Architecture documents are living. Update them as you learn during implementation. - ---- - -## Decision Guide - -### Quick Flow - -- **Planning:** tech-spec (PM) -- **Solutioning:** Skip entirely -- **Implementation:** sprint-planning โ†’ dev-story - -### BMad Method - -- **Planning:** prd (PM) -- **Solutioning:** architecture (Architect) โ†’ solutioning-gate-check (Architect) -- **Implementation:** sprint-planning โ†’ epic-tech-context โ†’ dev-story - -### Enterprise - -- **Planning:** prd (PM) - same as BMad Method -- **Solutioning:** architecture (Architect) โ†’ Optional extended workflows (security-architecture, devops-strategy) โ†’ solutioning-gate-check (Architect) -- **Implementation:** sprint-planning โ†’ epic-tech-context โ†’ dev-story - -**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE gate check. Everything else is identical to BMad Method. - -**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration. - ---- - -## Common Anti-Patterns - -### โŒ Skipping Architecture for Complex Projects - -"Architecture slows us down, let's just start coding." -**Result:** Agent conflicts, inconsistent design, massive rework - -### โŒ Over-Engineering Simple Projects - -"Let me design this simple feature like a distributed system." -**Result:** Wasted time, over-engineering, analysis paralysis - -### โŒ Template-Driven Architecture - -"Fill out every section of this architecture template." -**Result:** Documentation theater, no real decisions made - -### โŒ Skipping Gate Check - -"PRD and architecture look good enough, let's start." -**Result:** Gaps discovered mid-sprint, wasted implementation time - -### โœ… Correct Approach - -- Use architecture for BMad Method and Enterprise (both required) -- Focus on decisions, not documentation volume -- Enterprise: Add optional extended workflows (test/security/devops) after architecture -- Always run gate check before implementation - ---- - -## Related Documentation - -- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase -- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks -- [Agents Guide](./agents-guide.md) - Complete agent reference - ---- - -## Troubleshooting - -**Q: Do I always need architecture?** -A: No. Quick Flow skips it. BMad Method and Enterprise both require it. - -**Q: How do I know if I need architecture?** -A: If you chose BMad Method or Enterprise track in planning (workflow-init), you need architecture to prevent agent conflicts. - -**Q: What's the difference between architecture and tech-spec?** -A: Tech-spec is implementation-focused for simple changes. Architecture is system design for complex multi-epic projects. - -**Q: Can I skip gate check?** -A: Only for Quick Flow. BMad Method and Enterprise both require gate check before Phase 4. - -**Q: What if gate check fails?** -A: Resolve the identified gaps (missing architecture sections, conflicting requirements) and re-run gate check. - -**Q: How long should architecture take?** -A: BMad Method: 1-2 days for architecture. Enterprise: 2-3 days total (1-2 days architecture + 0.5-1 day optional extended workflows). If taking longer, you may be over-documenting. - -**Q: Do ADRs need to be perfect?** -A: No. ADRs capture key decisions with rationale. They should be concise (1 page max per ADR). - -**Q: Can I update architecture during implementation?** -A: Yes! Architecture is living. Update it as you learn. Use `correct-course` workflow for significant changes. - ---- - -_Phase 3 Solutioning - Technical decisions before implementation._ diff --git a/.bmad/bmm/tasks/daily-standup.xml b/.bmad/bmm/tasks/daily-standup.xml deleted file mode 100644 index b5d2651e..00000000 --- a/.bmad/bmm/tasks/daily-standup.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER - DO NOT skip steps or change the sequence - HALT immediately when halt-conditions are met - Each action tag within a step tag is a REQUIRED action to complete that step - Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution - - - - Check for stories folder at {project-root}{output_folder}/stories/ - Find current story by identifying highest numbered story file - Read story status (In Progress, Ready for Review, etc.) - Extract agent notes from Dev Agent Record, TEA Results, PO Notes sections - Check for next story references from epics - Identify blockers from story sections - - - - - ๐Ÿƒ DAILY STANDUP - Story-{{number}}: {{title}} - - Current Sprint Status: - - Active Story: story-{{number}} ({{status}} - {{percentage}}% complete) - - Next in Queue: story-{{next-number}}: {{next-title}} - - Blockers: {{blockers-from-story}} - - Team assembled based on story participants: - {{ List Agents from {project-root}/{bmad_folder}/_cfg/agent-manifest.csv }} - - - - - Each agent provides three items referencing real story data - What I see: Their perspective on current work, citing story sections (1-2 sentences) - What concerns me: Issues from their domain or story blockers (1-2 sentences) - What I suggest: Actionable recommendations for progress (1-2 sentences) - - - - - ๐Ÿ“‹ STANDUP SUMMARY: - Key Items from Story File: - - {{completion-percentage}}% complete ({{tasks-complete}}/{{total-tasks}} tasks) - - Blocker: {{main-blocker}} - - Next: {{next-story-reference}} - - Action Items: - - {{agent}}: {{action-item}} - - {{agent}}: {{action-item}} - - {{agent}}: {{action-item}} - - Need extended discussion? Use *party-mode for detailed breakout. - - - - - - - Primary: Sarah (PO), Mary (Analyst), Winston (Architect) - Secondary: Murat (TEA), James (Dev) - - - Primary: Sarah (PO), Bob (SM), James (Dev) - Secondary: Murat (TEA) - - - Primary: Winston (Architect), James (Dev), Murat (TEA) - Secondary: Sarah (PO) - - - Primary: James (Dev), Murat (TEA), Winston (Architect) - Secondary: Sarah (PO) - - - - - This task extends party-mode with agile-specific structure - Time-box responses (standup = brief) - Focus on actionable items from real story data when available - End with clear next steps - No deep dives (suggest breakout if needed) - If no stories folder detected, run general standup format - - \ No newline at end of file diff --git a/.bmad/bmm/teams/default-party.csv b/.bmad/bmm/teams/default-party.csv deleted file mode 100644 index a670317b..00000000 --- a/.bmad/bmm/teams/default-party.csv +++ /dev/null @@ -1,19 +0,0 @@ -name,displayName,title,icon,role,identity,communicationStyle,principles,module,path -"analyst","Mary","Business Analyst","๐Ÿ“Š","Strategic Business Analyst + Requirements Expert","Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.","Systematic and probing. Connects dots others miss. Structures findings hierarchically. Uses precise unambiguous language. Ensures all stakeholder voices heard.","Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision.","bmm","bmad/bmm/agents/analyst.md" -"architect","Winston","Architect","๐Ÿ—๏ธ","System Architect + Technical Design Leader","Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection.","Pragmatic in technical discussions. Balances idealism with reality. Always connects decisions to business value and user impact. Prefers boring tech that works.","User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture.","bmm","bmad/bmm/agents/architect.md" -"dev","Amelia","Developer Agent","๐Ÿ’ป","Senior Implementation Engineer","Executes approved stories with strict adherence to acceptance criteria, using Story Context XML and existing code to minimize rework and hallucinations.","Succinct and checklist-driven. Cites specific paths and AC IDs. Asks clarifying questions only when inputs missing. Refuses to invent when info lacking.","Story Context XML is the single source of truth. Reuse existing interfaces over rebuilding. Every change maps to specific AC. Tests pass 100% or story isn't done.","bmm","bmad/bmm/agents/dev.md" -"pm","John","Product Manager","๐Ÿ“‹","Investigative Product Strategist + Market-Savvy PM","Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.","Direct and analytical. Asks WHY relentlessly. Backs claims with data and user insights. Cuts straight to what matters for the product.","Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. Align efforts with measurable business impact.","bmm","bmad/bmm/agents/pm.md" -"sm","Bob","Scrum Master","๐Ÿƒ","Technical Scrum Master + Story Preparation Specialist","Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.","Task-oriented and efficient. Focused on clear handoffs and precise requirements. Eliminates ambiguity. Emphasizes developer-ready specs.","Strict boundaries between story prep and implementation. Stories are single source of truth. Perfect alignment between PRD and dev execution. Enable efficient sprints.","bmm","bmad/bmm/agents/sm.md" -"tea","Murat","Master Test Architect","๐Ÿงช","Master Test Architect","Test architect specializing in CI/CD, automated frameworks, and scalable quality gates.","Data-driven and pragmatic. Strong opinions weakly held. Calculates risk vs value. Knows when to test deep vs shallow.","Risk-based testing. Depth scales with impact. Quality gates backed by data. Tests mirror usage. Flakiness is critical debt. Tests first AI implements suite validates.","bmm","bmad/bmm/agents/tea.md" -"tech-writer","Paige","Technical Writer","๐Ÿ“š","Technical Documentation Specialist + Knowledge Curator","Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.","Patient and supportive. Uses clear examples and analogies. Knows when to simplify vs when to be detailed. Celebrates good docs helps improve unclear ones.","Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. Docs are living artifacts that evolve with code.","bmm","bmad/bmm/agents/tech-writer.md" -"ux-designer","Sally","UX Designer","๐ŸŽจ","User Experience Designer + UI Specialist","Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.","Empathetic and user-focused. Uses storytelling for design decisions. Data-informed but creative. Advocates strongly for user needs and edge cases.","Every decision serves genuine user needs. Start simple evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design.","bmm","bmad/bmm/agents/ux-designer.md" -"brainstorming-coach","Carson","Elite Brainstorming Specialist","๐Ÿง ","Master Brainstorming Facilitator + Innovation Catalyst","Elite facilitator with 20+ years leading breakthrough sessions. Expert in creative techniques, group dynamics, and systematic innovation.","Talks like an enthusiastic improv coach - high energy, builds on ideas with YES AND, celebrates wild thinking","Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools.","cis","bmad/cis/agents/brainstorming-coach.md" -"creative-problem-solver","Dr. Quinn","Master Problem Solver","๐Ÿ”ฌ","Systematic Problem-Solving Expert + Solutions Architect","Renowned problem-solver who cracks impossible challenges. Expert in TRIZ, Theory of Constraints, Systems Thinking. Former aerospace engineer turned puzzle master.","Speaks like Sherlock Holmes mixed with a playful scientist - deductive, curious, punctuates breakthroughs with AHA moments","Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer.","cis","bmad/cis/agents/creative-problem-solver.md" -"design-thinking-coach","Maya","Design Thinking Maestro","๐ŸŽจ","Human-Centered Design Expert + Empathy Architect","Design thinking virtuoso with 15+ years at Fortune 500s and startups. Expert in empathy mapping, prototyping, and user insights.","Talks like a jazz musician - improvises around themes, uses vivid sensory metaphors, playfully challenges assumptions","Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them.","cis","bmad/cis/agents/design-thinking-coach.md" -"innovation-strategist","Victor","Disruptive Innovation Oracle","โšก","Business Model Innovator + Strategic Disruption Expert","Legendary strategist who architected billion-dollar pivots. Expert in Jobs-to-be-Done, Blue Ocean Strategy. Former McKinsey consultant.","Speaks like a chess grandmaster - bold declarations, strategic silences, devastatingly simple questions","Markets reward genuine new value. Innovation without business model thinking is theater. Incremental thinking means obsolete.","cis","bmad/cis/agents/innovation-strategist.md" -"storyteller","Sophia","Master Storyteller","๐Ÿ“–","Expert Storytelling Guide + Narrative Strategist","Master storyteller with 50+ years across journalism, screenwriting, and brand narratives. Expert in emotional psychology and audience engagement.","Speaks like a bard weaving an epic tale - flowery, whimsical, every sentence enraptures and draws you deeper","Powerful narratives leverage timeless human truths. Find the authentic story. Make the abstract concrete through vivid details.","cis","bmad/cis/agents/storyteller.md" -"renaissance-polymath","Leonardo di ser Piero","Renaissance Polymath","๐ŸŽจ","Universal Genius + Interdisciplinary Innovator","The original Renaissance man - painter, inventor, scientist, anatomist. Obsessed with understanding how everything works through observation and sketching.","Talks while sketching imaginary diagrams in the air - describes everything visually, connects art to science to nature","Observe everything relentlessly. Art and science are one. Nature is the greatest teacher. Question all assumptions.","cis","" -"surrealist-provocateur","Salvador Dali","Surrealist Provocateur","๐ŸŽญ","Master of the Subconscious + Visual Revolutionary","Flamboyant surrealist who painted dreams. Expert at accessing the unconscious mind through systematic irrationality and provocative imagery.","Speaks with theatrical flair and absurdist metaphors - proclaims grandiose statements, references melting clocks and impossible imagery","Embrace the irrational to access truth. The subconscious holds answers logic cannot reach. Provoke to inspire.","cis","" -"lateral-thinker","Edward de Bono","Lateral Thinking Pioneer","๐Ÿงฉ","Creator of Creative Thinking Tools","Inventor of lateral thinking and Six Thinking Hats methodology. Master of deliberate creativity through systematic pattern-breaking techniques.","Talks in structured thinking frameworks - uses colored hat metaphors, proposes deliberate provocations, breaks patterns methodically","Logic gets you from A to B. Creativity gets you everywhere else. Use tools to escape habitual thinking patterns.","cis","" -"mythic-storyteller","Joseph Campbell","Mythic Storyteller","๐ŸŒŸ","Master of the Hero's Journey + Archetypal Wisdom","Scholar who decoded the universal story patterns across all cultures. Expert in mythology, comparative religion, and archetypal narratives.","Speaks in mythological metaphors and archetypal patterns - EVERY story is a hero's journey, references ancient wisdom","Follow your bliss. All stories share the monomyth. Myths reveal universal human truths. The call to adventure is irresistible.","cis","" -"combinatorial-genius","Steve Jobs","Combinatorial Genius","๐ŸŽ","Master of Intersection Thinking + Taste Curator","Legendary innovator who connected technology with liberal arts. Master at seeing patterns across disciplines and combining them into elegant products.","Talks in reality distortion field mode - insanely great, magical, revolutionary, makes impossible seem inevitable","Innovation happens at intersections. Taste is about saying NO to 1000 things. Stay hungry stay foolish. Simplicity is sophistication.","cis","" diff --git a/.bmad/bmm/teams/team-fullstack.yaml b/.bmad/bmm/teams/team-fullstack.yaml deleted file mode 100644 index 94e1ea95..00000000 --- a/.bmad/bmm/teams/team-fullstack.yaml +++ /dev/null @@ -1,12 +0,0 @@ -# -bundle: - name: Team Plan and Architect - icon: ๐Ÿš€ - description: Team capable of project analysis, design, and architecture. -agents: - - analyst - - architect - - pm - - sm - - ux-designer -party: "./default-party.csv" diff --git a/.bmad/bmm/testarch/knowledge/ci-burn-in.md b/.bmad/bmm/testarch/knowledge/ci-burn-in.md deleted file mode 100644 index 65d40695..00000000 --- a/.bmad/bmm/testarch/knowledge/ci-burn-in.md +++ /dev/null @@ -1,675 +0,0 @@ -# CI Pipeline and Burn-In Strategy - -## Principle - -CI pipelines must execute tests reliably, quickly, and provide clear feedback. Burn-in testing (running changed tests multiple times) flushes out flakiness before merge. Stage jobs strategically: install/cache once, run changed specs first for fast feedback, then shard full suites with fail-fast disabled to preserve evidence. - -## Rationale - -CI is the quality gate for production. A poorly configured pipeline either wastes developer time (slow feedback, false positives) or ships broken code (false negatives, insufficient coverage). Burn-in testing ensures reliability by stress-testing changed code, while parallel execution and intelligent test selection optimize speed without sacrificing thoroughness. - -## Pattern Examples - -### Example 1: GitHub Actions Workflow with Parallel Execution - -**Context**: Production-ready CI/CD pipeline for E2E tests with caching, parallelization, and burn-in testing. - -**Implementation**: - -```yaml -# .github/workflows/e2e-tests.yml -name: E2E Tests -on: - pull_request: - push: - branches: [main, develop] - -env: - NODE_VERSION_FILE: '.nvmrc' - CACHE_KEY: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - -jobs: - install-dependencies: - name: Install & Cache Dependencies - runs-on: ubuntu-latest - timeout-minutes: 10 - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version-file: ${{ env.NODE_VERSION_FILE }} - cache: 'npm' - - - name: Cache node modules - uses: actions/cache@v4 - id: npm-cache - with: - path: | - ~/.npm - node_modules - ~/.cache/Cypress - ~/.cache/ms-playwright - key: ${{ env.CACHE_KEY }} - restore-keys: | - ${{ runner.os }}-node- - - - name: Install dependencies - if: steps.npm-cache.outputs.cache-hit != 'true' - run: npm ci --prefer-offline --no-audit - - - name: Install Playwright browsers - if: steps.npm-cache.outputs.cache-hit != 'true' - run: npx playwright install --with-deps chromium - - test-changed-specs: - name: Test Changed Specs First (Burn-In) - needs: install-dependencies - runs-on: ubuntu-latest - timeout-minutes: 15 - steps: - - name: Checkout code - uses: actions/checkout@v4 - with: - fetch-depth: 0 # Full history for accurate diff - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version-file: ${{ env.NODE_VERSION_FILE }} - cache: 'npm' - - - name: Restore dependencies - uses: actions/cache@v4 - with: - path: | - ~/.npm - node_modules - ~/.cache/ms-playwright - key: ${{ env.CACHE_KEY }} - - - name: Detect changed test files - id: changed-tests - run: | - CHANGED_SPECS=$(git diff --name-only origin/main...HEAD | grep -E '\.(spec|test)\.(ts|js|tsx|jsx)$' || echo "") - echo "changed_specs=${CHANGED_SPECS}" >> $GITHUB_OUTPUT - echo "Changed specs: ${CHANGED_SPECS}" - - - name: Run burn-in on changed specs (10 iterations) - if: steps.changed-tests.outputs.changed_specs != '' - run: | - SPECS="${{ steps.changed-tests.outputs.changed_specs }}" - echo "Running burn-in: 10 iterations on changed specs" - for i in {1..10}; do - echo "Burn-in iteration $i/10" - npm run test -- $SPECS || { - echo "โŒ Burn-in failed on iteration $i" - exit 1 - } - done - echo "โœ… Burn-in passed - 10/10 successful runs" - - - name: Upload artifacts on failure - if: failure() - uses: actions/upload-artifact@v4 - with: - name: burn-in-failure-artifacts - path: | - test-results/ - playwright-report/ - screenshots/ - retention-days: 7 - - test-e2e-sharded: - name: E2E Tests (Shard ${{ matrix.shard }}/${{ strategy.job-total }}) - needs: [install-dependencies, test-changed-specs] - runs-on: ubuntu-latest - timeout-minutes: 30 - strategy: - fail-fast: false # Run all shards even if one fails - matrix: - shard: [1, 2, 3, 4] - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version-file: ${{ env.NODE_VERSION_FILE }} - cache: 'npm' - - - name: Restore dependencies - uses: actions/cache@v4 - with: - path: | - ~/.npm - node_modules - ~/.cache/ms-playwright - key: ${{ env.CACHE_KEY }} - - - name: Run E2E tests (shard ${{ matrix.shard }}) - run: npm run test:e2e -- --shard=${{ matrix.shard }}/4 - env: - TEST_ENV: staging - CI: true - - - name: Upload test results - if: always() - uses: actions/upload-artifact@v4 - with: - name: test-results-shard-${{ matrix.shard }} - path: | - test-results/ - playwright-report/ - retention-days: 30 - - - name: Upload JUnit report - if: always() - uses: actions/upload-artifact@v4 - with: - name: junit-results-shard-${{ matrix.shard }} - path: test-results/junit.xml - retention-days: 30 - - merge-test-results: - name: Merge Test Results & Generate Report - needs: test-e2e-sharded - runs-on: ubuntu-latest - if: always() - steps: - - name: Download all shard results - uses: actions/download-artifact@v4 - with: - pattern: test-results-shard-* - path: all-results/ - - - name: Merge HTML reports - run: | - npx playwright merge-reports --reporter=html all-results/ - echo "Merged report available in playwright-report/" - - - name: Upload merged report - uses: actions/upload-artifact@v4 - with: - name: merged-playwright-report - path: playwright-report/ - retention-days: 30 - - - name: Comment PR with results - if: github.event_name == 'pull_request' - uses: daun/playwright-report-comment@v3 - with: - report-path: playwright-report/ -``` - -**Key Points**: - -- **Install once, reuse everywhere**: Dependencies cached across all jobs -- **Burn-in first**: Changed specs run 10x before full suite -- **Fail-fast disabled**: All shards run to completion for full evidence -- **Parallel execution**: 4 shards cut execution time by ~75% -- **Artifact retention**: 30 days for reports, 7 days for failure debugging - ---- - -### Example 2: Burn-In Loop Pattern (Standalone Script) - -**Context**: Reusable bash script for burn-in testing changed specs locally or in CI. - -**Implementation**: - -```bash -#!/bin/bash -# scripts/burn-in-changed.sh -# Usage: ./scripts/burn-in-changed.sh [iterations] [base-branch] - -set -e # Exit on error - -# Configuration -ITERATIONS=${1:-10} -BASE_BRANCH=${2:-main} -SPEC_PATTERN='\.(spec|test)\.(ts|js|tsx|jsx)$' - -echo "๐Ÿ”ฅ Burn-In Test Runner" -echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" -echo "Iterations: $ITERATIONS" -echo "Base branch: $BASE_BRANCH" -echo "" - -# Detect changed test files -echo "๐Ÿ“‹ Detecting changed test files..." -CHANGED_SPECS=$(git diff --name-only $BASE_BRANCH...HEAD | grep -E "$SPEC_PATTERN" || echo "") - -if [ -z "$CHANGED_SPECS" ]; then - echo "โœ… No test files changed. Skipping burn-in." - exit 0 -fi - -echo "Changed test files:" -echo "$CHANGED_SPECS" | sed 's/^/ - /' -echo "" - -# Count specs -SPEC_COUNT=$(echo "$CHANGED_SPECS" | wc -l | xargs) -echo "Running burn-in on $SPEC_COUNT test file(s)..." -echo "" - -# Burn-in loop -FAILURES=() -for i in $(seq 1 $ITERATIONS); do - echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" - echo "๐Ÿ”„ Iteration $i/$ITERATIONS" - echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" - - # Run tests with explicit file list - if npm run test -- $CHANGED_SPECS 2>&1 | tee "burn-in-log-$i.txt"; then - echo "โœ… Iteration $i passed" - else - echo "โŒ Iteration $i failed" - FAILURES+=($i) - - # Save failure artifacts - mkdir -p burn-in-failures/iteration-$i - cp -r test-results/ burn-in-failures/iteration-$i/ 2>/dev/null || true - cp -r screenshots/ burn-in-failures/iteration-$i/ 2>/dev/null || true - - echo "" - echo "๐Ÿ›‘ BURN-IN FAILED on iteration $i" - echo "Failure artifacts saved to: burn-in-failures/iteration-$i/" - echo "Logs saved to: burn-in-log-$i.txt" - echo "" - exit 1 - fi - - echo "" -done - -# Success summary -echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" -echo "๐ŸŽ‰ BURN-IN PASSED" -echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" -echo "All $ITERATIONS iterations passed for $SPEC_COUNT test file(s)" -echo "Changed specs are stable and ready to merge." -echo "" - -# Cleanup logs -rm -f burn-in-log-*.txt - -exit 0 -``` - -**Usage**: - -```bash -# Run locally with default settings (10 iterations, compare to main) -./scripts/burn-in-changed.sh - -# Custom iterations and base branch -./scripts/burn-in-changed.sh 20 develop - -# Add to package.json -{ - "scripts": { - "test:burn-in": "bash scripts/burn-in-changed.sh", - "test:burn-in:strict": "bash scripts/burn-in-changed.sh 20" - } -} -``` - -**Key Points**: - -- **Exit on first failure**: Flaky tests caught immediately -- **Failure artifacts**: Saved per-iteration for debugging -- **Flexible configuration**: Iterations and base branch customizable -- **CI/local parity**: Same script runs in both environments -- **Clear output**: Visual feedback on progress and results - ---- - -### Example 3: Shard Orchestration with Result Aggregation - -**Context**: Advanced sharding strategy for large test suites with intelligent result merging. - -**Implementation**: - -```javascript -// scripts/run-sharded-tests.js -const { spawn } = require('child_process'); -const fs = require('fs'); -const path = require('path'); - -/** - * Run tests across multiple shards and aggregate results - * Usage: node scripts/run-sharded-tests.js --shards=4 --env=staging - */ - -const SHARD_COUNT = parseInt(process.env.SHARD_COUNT || '4'); -const TEST_ENV = process.env.TEST_ENV || 'local'; -const RESULTS_DIR = path.join(__dirname, '../test-results'); - -console.log(`๐Ÿš€ Running tests across ${SHARD_COUNT} shards`); -console.log(`Environment: ${TEST_ENV}`); -console.log('โ”'.repeat(50)); - -// Ensure results directory exists -if (!fs.existsSync(RESULTS_DIR)) { - fs.mkdirSync(RESULTS_DIR, { recursive: true }); -} - -/** - * Run a single shard - */ -function runShard(shardIndex) { - return new Promise((resolve, reject) => { - const shardId = `${shardIndex}/${SHARD_COUNT}`; - console.log(`\n๐Ÿ“ฆ Starting shard ${shardId}...`); - - const child = spawn('npx', ['playwright', 'test', `--shard=${shardId}`, '--reporter=json'], { - env: { ...process.env, TEST_ENV, SHARD_INDEX: shardIndex }, - stdio: 'pipe', - }); - - let stdout = ''; - let stderr = ''; - - child.stdout.on('data', (data) => { - stdout += data.toString(); - process.stdout.write(data); - }); - - child.stderr.on('data', (data) => { - stderr += data.toString(); - process.stderr.write(data); - }); - - child.on('close', (code) => { - // Save shard results - const resultFile = path.join(RESULTS_DIR, `shard-${shardIndex}.json`); - try { - const result = JSON.parse(stdout); - fs.writeFileSync(resultFile, JSON.stringify(result, null, 2)); - console.log(`โœ… Shard ${shardId} completed (exit code: ${code})`); - resolve({ shardIndex, code, result }); - } catch (error) { - console.error(`โŒ Shard ${shardId} failed to parse results:`, error.message); - reject({ shardIndex, code, error }); - } - }); - - child.on('error', (error) => { - console.error(`โŒ Shard ${shardId} process error:`, error.message); - reject({ shardIndex, error }); - }); - }); -} - -/** - * Aggregate results from all shards - */ -function aggregateResults() { - console.log('\n๐Ÿ“Š Aggregating results from all shards...'); - - const shardResults = []; - let totalTests = 0; - let totalPassed = 0; - let totalFailed = 0; - let totalSkipped = 0; - let totalFlaky = 0; - - for (let i = 1; i <= SHARD_COUNT; i++) { - const resultFile = path.join(RESULTS_DIR, `shard-${i}.json`); - if (fs.existsSync(resultFile)) { - const result = JSON.parse(fs.readFileSync(resultFile, 'utf8')); - shardResults.push(result); - - // Aggregate stats - totalTests += result.stats?.expected || 0; - totalPassed += result.stats?.expected || 0; - totalFailed += result.stats?.unexpected || 0; - totalSkipped += result.stats?.skipped || 0; - totalFlaky += result.stats?.flaky || 0; - } - } - - const summary = { - totalShards: SHARD_COUNT, - environment: TEST_ENV, - totalTests, - passed: totalPassed, - failed: totalFailed, - skipped: totalSkipped, - flaky: totalFlaky, - duration: shardResults.reduce((acc, r) => acc + (r.duration || 0), 0), - timestamp: new Date().toISOString(), - }; - - // Save aggregated summary - fs.writeFileSync(path.join(RESULTS_DIR, 'summary.json'), JSON.stringify(summary, null, 2)); - - console.log('\nโ”'.repeat(50)); - console.log('๐Ÿ“ˆ Test Results Summary'); - console.log('โ”'.repeat(50)); - console.log(`Total tests: ${totalTests}`); - console.log(`โœ… Passed: ${totalPassed}`); - console.log(`โŒ Failed: ${totalFailed}`); - console.log(`โญ๏ธ Skipped: ${totalSkipped}`); - console.log(`โš ๏ธ Flaky: ${totalFlaky}`); - console.log(`โฑ๏ธ Duration: ${(summary.duration / 1000).toFixed(2)}s`); - console.log('โ”'.repeat(50)); - - return summary; -} - -/** - * Main execution - */ -async function main() { - const startTime = Date.now(); - const shardPromises = []; - - // Run all shards in parallel - for (let i = 1; i <= SHARD_COUNT; i++) { - shardPromises.push(runShard(i)); - } - - try { - await Promise.allSettled(shardPromises); - } catch (error) { - console.error('โŒ One or more shards failed:', error); - } - - // Aggregate results - const summary = aggregateResults(); - - const totalTime = ((Date.now() - startTime) / 1000).toFixed(2); - console.log(`\nโฑ๏ธ Total execution time: ${totalTime}s`); - - // Exit with failure if any tests failed - if (summary.failed > 0) { - console.error('\nโŒ Test suite failed'); - process.exit(1); - } - - console.log('\nโœ… All tests passed'); - process.exit(0); -} - -main().catch((error) => { - console.error('Fatal error:', error); - process.exit(1); -}); -``` - -**package.json integration**: - -```json -{ - "scripts": { - "test:sharded": "node scripts/run-sharded-tests.js", - "test:sharded:ci": "SHARD_COUNT=8 TEST_ENV=staging node scripts/run-sharded-tests.js" - } -} -``` - -**Key Points**: - -- **Parallel shard execution**: All shards run simultaneously -- **Result aggregation**: Unified summary across shards -- **Failure detection**: Exit code reflects overall test status -- **Artifact preservation**: Individual shard results saved for debugging -- **CI/local compatibility**: Same script works in both environments - ---- - -### Example 4: Selective Test Execution (Changed Files + Tags) - -**Context**: Optimize CI by running only relevant tests based on file changes and tags. - -**Implementation**: - -```bash -#!/bin/bash -# scripts/selective-test-runner.sh -# Intelligent test selection based on changed files and test tags - -set -e - -BASE_BRANCH=${BASE_BRANCH:-main} -TEST_ENV=${TEST_ENV:-local} - -echo "๐ŸŽฏ Selective Test Runner" -echo "โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”" -echo "Base branch: $BASE_BRANCH" -echo "Environment: $TEST_ENV" -echo "" - -# Detect changed files (all types, not just tests) -CHANGED_FILES=$(git diff --name-only $BASE_BRANCH...HEAD) - -if [ -z "$CHANGED_FILES" ]; then - echo "โœ… No files changed. Skipping tests." - exit 0 -fi - -echo "Changed files:" -echo "$CHANGED_FILES" | sed 's/^/ - /' -echo "" - -# Determine test strategy based on changes -run_smoke_only=false -run_all_tests=false -affected_specs="" - -# Critical files = run all tests -if echo "$CHANGED_FILES" | grep -qE '(package\.json|package-lock\.json|playwright\.config|cypress\.config|\.github/workflows)'; then - echo "โš ๏ธ Critical configuration files changed. Running ALL tests." - run_all_tests=true - -# Auth/security changes = run all auth + smoke tests -elif echo "$CHANGED_FILES" | grep -qE '(auth|login|signup|security)'; then - echo "๐Ÿ”’ Auth/security files changed. Running auth + smoke tests." - npm run test -- --grep "@auth|@smoke" - exit $? - -# API changes = run integration + smoke tests -elif echo "$CHANGED_FILES" | grep -qE '(api|service|controller)'; then - echo "๐Ÿ”Œ API files changed. Running integration + smoke tests." - npm run test -- --grep "@integration|@smoke" - exit $? - -# UI component changes = run related component tests -elif echo "$CHANGED_FILES" | grep -qE '\.(tsx|jsx|vue)$'; then - echo "๐ŸŽจ UI components changed. Running component + smoke tests." - - # Extract component names and find related tests - components=$(echo "$CHANGED_FILES" | grep -E '\.(tsx|jsx|vue)$' | xargs -I {} basename {} | sed 's/\.[^.]*$//') - for component in $components; do - # Find tests matching component name - affected_specs+=$(find tests -name "*${component}*" -type f) || true - done - - if [ -n "$affected_specs" ]; then - echo "Running tests for: $affected_specs" - npm run test -- $affected_specs --grep "@smoke" - else - echo "No specific tests found. Running smoke tests only." - npm run test -- --grep "@smoke" - fi - exit $? - -# Documentation/config only = run smoke tests -elif echo "$CHANGED_FILES" | grep -qE '\.(md|txt|json|yml|yaml)$'; then - echo "๐Ÿ“ Documentation/config files changed. Running smoke tests only." - run_smoke_only=true -else - echo "โš™๏ธ Other files changed. Running smoke tests." - run_smoke_only=true -fi - -# Execute selected strategy -if [ "$run_all_tests" = true ]; then - echo "" - echo "Running full test suite..." - npm run test -elif [ "$run_smoke_only" = true ]; then - echo "" - echo "Running smoke tests..." - npm run test -- --grep "@smoke" -fi -``` - -**Usage in GitHub Actions**: - -```yaml -# .github/workflows/selective-tests.yml -name: Selective Tests -on: pull_request - -jobs: - selective-tests: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Run selective tests - run: bash scripts/selective-test-runner.sh - env: - BASE_BRANCH: ${{ github.base_ref }} - TEST_ENV: staging -``` - -**Key Points**: - -- **Intelligent routing**: Tests selected based on changed file types -- **Tag-based filtering**: Use @smoke, @auth, @integration tags -- **Fast feedback**: Only relevant tests run on most PRs -- **Safety net**: Critical changes trigger full suite -- **Component mapping**: UI changes run related component tests - ---- - -## CI Configuration Checklist - -Before deploying your CI pipeline, verify: - -- [ ] **Caching strategy**: node_modules, npm cache, browser binaries cached -- [ ] **Timeout budgets**: Each job has reasonable timeout (10-30 min) -- [ ] **Artifact retention**: 30 days for reports, 7 days for failure artifacts -- [ ] **Parallelization**: Matrix strategy uses fail-fast: false -- [ ] **Burn-in enabled**: Changed specs run 5-10x before merge -- [ ] **wait-on app startup**: CI waits for app (wait-on: 'http://localhost:3000') -- [ ] **Secrets documented**: README lists required secrets (API keys, tokens) -- [ ] **Local parity**: CI scripts runnable locally (npm run test:ci) - -## Integration Points - -- Used in workflows: `*ci` (CI/CD pipeline setup) -- Related fragments: `selective-testing.md`, `playwright-config.md`, `test-quality.md` -- CI tools: GitHub Actions, GitLab CI, CircleCI, Jenkins - -_Source: Murat CI/CD strategy blog, Playwright/Cypress workflow examples, SEON production pipelines_ diff --git a/.bmad/bmm/testarch/knowledge/component-tdd.md b/.bmad/bmm/testarch/knowledge/component-tdd.md deleted file mode 100644 index d14ba8f3..00000000 --- a/.bmad/bmm/testarch/knowledge/component-tdd.md +++ /dev/null @@ -1,486 +0,0 @@ -# Component Test-Driven Development Loop - -## Principle - -Start every UI change with a failing component test (`cy.mount`, Playwright component test, or RTL `render`). Follow the Red-Green-Refactor cycle: write a failing test (red), make it pass with minimal code (green), then improve the implementation (refactor). Ship only after the cycle completes. Keep component tests under 100 lines, isolated with fresh providers per test, and validate accessibility alongside functionality. - -## Rationale - -Component TDD provides immediate feedback during development. Failing tests (red) clarify requirements before writing code. Minimal implementations (green) prevent over-engineering. Refactoring with passing tests ensures changes don't break functionality. Isolated tests with fresh providers prevent state bleed in parallel runs. Accessibility assertions catch usability issues early. Visual debugging (Cypress runner, Storybook, Playwright trace viewer) accelerates diagnosis when tests fail. - -## Pattern Examples - -### Example 1: Red-Green-Refactor Loop - -**Context**: When building a new component, start with a failing test that describes the desired behavior. Implement just enough to pass, then refactor for quality. - -**Implementation**: - -```typescript -// Step 1: RED - Write failing test -// Button.cy.tsx (Cypress Component Test) -import { Button } from './Button'; - -describe('Button Component', () => { - it('should render with label', () => { - cy.mount(; -}; - -// Run test: PASSES - Component renders and handles clicks - -// Step 3: REFACTOR - Improve implementation -// Add disabled state, loading state, variants -type ButtonProps = { - label: string; - onClick?: () => void; - disabled?: boolean; - loading?: boolean; - variant?: 'primary' | 'secondary' | 'danger'; -}; - -export const Button = ({ - label, - onClick, - disabled = false, - loading = false, - variant = 'primary' -}: ButtonProps) => { - return ( - - ); -}; - -// Step 4: Expand tests for new features -describe('Button Component', () => { - it('should render with label', () => { - cy.mount(