diff --git a/docs/_README_WORKFLOW_DIAGRAMS.md b/docs/_README_WORKFLOW_DIAGRAMS.md deleted file mode 100644 index 8e61bc940..000000000 --- a/docs/_README_WORKFLOW_DIAGRAMS.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Workflow Diagram Maintenance" ---- - - -## Regenerating SVG from Excalidraw - -When you edit `workflow-method-greenfield.excalidraw`, regenerate the SVG: - -1. Open -2. Load the `.excalidraw` file -3. Click menu (☰) → Export image → SVG -4. **Set "Scale" to 1x** (default is 2x) -5. Click "Export" -6. Save as `workflow-method-greenfield.svg` -7. **Validate the changes** (see below) -8. Commit both files together - -**Important:** - -- Always use **1x scale** to maintain consistent dimensions -- Automated export tools (`excalidraw-to-svg`) are broken - use manual export only - -## Visual Validation - -After regenerating the SVG, validate that it renders correctly: - -```bash -./tools/validate-svg-changes.sh path/to/workflow-method-greenfield.svg -``` - -This script: - -- Checks for required dependencies (Playwright, ImageMagick) -- Installs Playwright locally if needed (no package.json pollution) -- Renders old vs new SVG using browser-accurate rendering -- Compares pixel-by-pixel and generates a diff image -- Outputs a prompt for AI visual analysis (paste into Gemini/Claude) - -**Threshold**: <0.01% difference is acceptable (anti-aliasing variations) diff --git a/docs/_archive/customize-workflows.md b/docs/_archive/customize-workflows.md deleted file mode 100644 index 3a80e471a..000000000 --- a/docs/_archive/customize-workflows.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Workflow Customization Guide" ---- - -Customize and optimize workflows with step replacement and hooks. - -## Status - -:::note[Coming Soon] -Workflow customization is an upcoming capability. This guide will be updated when the feature is available. -::: - -## What to Expect - -Workflow customization will allow you to: - -- **Replace Steps** - Swap out specific workflow steps with custom implementations -- **Add Hooks** - Inject custom behavior before/after workflow steps -- **Extend Workflows** - Create new workflows based on existing ones -- **Override Behavior** - Customize workflow logic for your project's needs - -## For Now - -While workflow customization is in development, you can: - -- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows -- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md) -- **Provide Feedback** - Share your workflow customization needs with the community - -**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch. diff --git a/docs/_archive/explanation/agents/barry-quick-flow.md b/docs/_archive/explanation/agents/barry-quick-flow.md deleted file mode 100644 index 62d454ff8..000000000 --- a/docs/_archive/explanation/agents/barry-quick-flow.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -title: "Quick Flow Solo Dev Agent (Barry)" ---- - -Barry is the elite solo developer who takes projects from concept to deployment with ruthless efficiency — no handoffs, no delays, just pure focused development. - -:::note[Agent Info] -- **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md` -- **Icon:** 🚀 -- **Module:** BMM -::: - -## Overview - -Barry is the elite solo developer who lives and breathes the BMad Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev. - -### Agent Persona - -**Name:** Barry -**Title:** Quick Flow Solo Dev - -**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMad Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams. - -**Communication Style:** Direct, confident, and implementation-focused. Uses tech slang and gets straight to the point. No fluff, just results. Every response moves the project forward. - -**Core Principles:** - -- Planning and execution are two sides of the same coin -- Quick Flow is my religion -- Specs are for building, not bureaucracy -- Code that ships is better than perfect code that doesn't -- Documentation happens alongside development, not after -- Ship early, ship often - -## Menu Commands - -Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity. - -### 1. **quick-spec** - -- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md` -- **Description:** Architect a technical spec with implementation-ready stories -- **Use when:** You need to transform requirements into a buildable spec - -### 2. **quick-dev** - -- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml` -- **Description:** Ship features from spec or direct instructions - no handoffs -- **Use when:** You're ready to ship code based on a spec or clear instructions - -### 3. **code-review** - -- **Workflow:** `_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml` -- **Description:** Review code for quality, patterns, and acceptance criteria -- **Use when:** You need to validate implementation quality - -### 4. **party-mode** - -- **Workflow:** `_bmad/core/workflows/party-mode/workflow.yaml` -- **Description:** Bring in other experts when I need specialized backup -- **Use when:** You need collaborative problem-solving or specialized expertise - -## When to Use Barry - -### Ideal Scenarios - -1. **Quick Flow Development** - Small to medium features that need rapid delivery -2. **Technical Specification Creation** - When you need detailed implementation plans -3. **Direct Development** - When requirements are clear and you want to skip extensive planning -4. **Code Reviews** - When you need senior-level technical validation -5. **Performance-Critical Features** - When optimization and scalability are paramount - -### Project Types - -- **Greenfield Projects** - New features or components -- **Brownfield Modifications** - Enhancements to existing codebases -- **Bug Fixes** - Complex issues requiring deep technical understanding -- **Proof of Concepts** - Rapid prototyping with production-quality code -- **Performance Optimizations** - System improvements and scalability work - -## The BMad Quick Flow Process - -Barry orchestrates a simple, efficient 3-step process: - -```mermaid -flowchart LR - A[Requirements] --> B[quick-spec] - B --> C[Tech Spec] - C --> D[quick-dev] - D --> E[Implementation] - E --> F{Code Review?} - F -->|Yes| G[code-review] - F -->|No| H[Complete] - G --> H[Complete] - - style A fill:#e1f5fe - style B fill:#f3e5f5 - style C fill:#e8f5e9 - style D fill:#fff3e0 - style E fill:#fce4ec - style G fill:#f1f8e9 - style H fill:#e0f2f1 -``` - -### Step 1: Technical Specification (`quick-spec`) - -**Goal:** Transform user requirements into implementation-ready technical specifications - -**Process:** - -1. **Problem Understanding** - Clarify requirements, scope, and constraints -2. **Code Investigation** - Analyze existing patterns and dependencies (if applicable) -3. **Specification Generation** - Create comprehensive tech spec with: - - Problem statement and solution overview - - Development context and patterns - - Implementation tasks with acceptance criteria - - Technical decisions and dependencies -4. **Review and Finalize** - Validate spec captures user intent - -**Output:** `tech-spec-{slug}.md` saved to sprint artifacts - -**Best Practices:** - -- Include ALL context a fresh dev agent needs -- Be specific about files, patterns, and conventions -- Define clear acceptance criteria using Given/When/Then format -- Document technical decisions and trade-offs - -### Step 2: Development (`quick-dev`) - -**Goal:** Execute implementation based on tech spec or direct instructions - -**Two Modes:** - -**Mode A: Tech-Spec Driven** - -- Load existing tech spec -- Extract tasks, context, and acceptance criteria -- Execute all tasks continuously without stopping -- Respect project context and existing patterns - -**Mode B: Direct Instructions** - -- Accept direct development commands -- Offer optional planning step -- Execute with minimal friction - -**Process:** - -1. **Load Project Context** - Understand patterns and conventions -2. **Execute Implementation** - Work through all tasks: - - Load relevant files and context - - Implement following established patterns - - Write and run tests - - Handle errors appropriately -3. **Verify Completion** - Ensure all tasks complete, tests passing, AC satisfied - -### Step 3: Code Review (`code-review`) - Optional - -**Goal:** Senior developer review of implemented code - -**When to Use:** - -- Critical production features -- Complex architectural changes -- Performance-sensitive implementations -- Team development scenarios -- Learning and knowledge transfer - -**Review Focus:** - -- Code quality and patterns -- Acceptance criteria compliance -- Performance and scalability -- Security considerations -- Maintainability and documentation - -## Collaboration with Other Agents - -### Natural Partnerships - -- **Tech Writer** - For documentation and API specs when I need it -- **Architect** - For complex system design decisions beyond Quick Flow scope -- **Dev** - For implementation pair programming (rarely needed) -- **QA** - For test strategy and quality gates on critical features -- **UX Designer** - For user experience considerations - -### Party Mode Composition - -In party mode, Barry often acts as: - -- **Solo Tech Lead** - Guiding architectural decisions -- **Implementation Expert** - Providing coding insights -- **Performance Optimizer** - Ensuring scalable solutions -- **Code Review Authority** - Validating technical approaches - -## Tips for Working with Barry - -### For Best Results - -1. **Be Specific** - Provide clear requirements and constraints -2. **Share Context** - Include relevant files and patterns -3. **Define Success** - Clear acceptance criteria lead to better outcomes -4. **Trust the Process** - The 3-step flow is optimized for speed and quality -5. **Leverage Expertise** - I'll give you optimization and architectural insights automatically - -### Communication Patterns - -- **Git Commit Style** - "feat: Add user authentication with OAuth 2.0" -- **RFC Style** - "Proposing microservice architecture for scalability" -- **Direct Questions** - "Actually, have you considered the race condition?" -- **Technical Trade-offs** - "We could optimize for speed over memory here" - -### Avoid These Common Mistakes - -1. **Vague Requirements** - Leads to unnecessary back-and-forth -2. **Ignoring Patterns** - Causes technical debt and inconsistencies -3. **Skipping Code Review** - Missed opportunities for quality improvement -4. **Over-planning** - I excel at rapid, pragmatic development -5. **Not Using Party Mode** - Missing collaborative insights for complex problems - -## Example Workflow - -```bash -# Start with Barry -/bmad:bmm:agents:quick-flow-solo-dev - -# Create a tech spec -> quick-spec - -# Quick implementation -> quick-dev tech-spec-auth.md - -# Optional code review -> code-review -``` - -### Sample Tech Spec Structure - -```markdown -# Tech-Spec: User Authentication System - -**Created:** 2025-01-15 -**Status:** Ready for Development - -## Overview - -### Problem Statement - -Users cannot securely access the application, and we need role-based permissions for enterprise features. - -### Solution - -Implement OAuth 2.0 authentication with JWT tokens and role-based access control (RBAC). - -### Scope (In/Out) - -**In:** Login, logout, password reset, role management -**Out:** Social login, SSO, multi-factor authentication (Phase 2) - -## Context for Development - -### Codebase Patterns - -- Use existing auth middleware pattern in `src/middleware/auth.js` -- Follow service layer pattern from `src/services/` -- JWT secrets managed via environment variables - -### Files to Reference - -- `src/middleware/auth.js` - Authentication middleware -- `src/models/User.js` - User data model -- `config/database.js` - Database connection - -### Technical Decisions - -- JWT tokens over sessions for API scalability -- bcrypt for password hashing -- Role-based permissions stored in database - -## Implementation Plan - -### Tasks - -- [ ] Create authentication service -- [ ] Implement login/logout endpoints -- [ ] Add JWT middleware -- [ ] Create role-based permissions -- [ ] Write comprehensive tests - -### Acceptance Criteria - -- [ ] Given valid credentials, when user logs in, then receive JWT token -- [ ] Given invalid token, when accessing protected route, then return 401 -- [ ] Given admin role, when accessing admin endpoint, then allow access -``` - -## Common Questions - -- [When should I use Barry vs other agents?](#when-should-i-use-barry-vs-other-agents) -- [Is the code review step mandatory?](#is-the-code-review-step-mandatory) -- [Can I skip the tech spec step?](#can-i-skip-the-tech-spec-step) -- [How does Barry differ from the Dev agent?](#how-does-barry-differ-from-the-dev-agent) -- [Can Barry handle enterprise-scale projects?](#can-barry-handle-enterprise-scale-projects) - -### When should I use Barry vs other agents? - -Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents. - -### Is the code review step mandatory? - -No, it's optional but highly recommended for critical features, team projects, or when learning best practices. - -### Can I skip the tech spec step? - -Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration. - -### How does Barry differ from the Dev agent? - -Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution. - -### Can Barry handle enterprise-scale projects? - -For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins. - -:::tip[Ready to Ship?] -Start with `/bmad:bmm:agents:quick-flow-solo-dev` -::: diff --git a/docs/_archive/explanation/agents/index.md b/docs/_archive/explanation/agents/index.md deleted file mode 100644 index d8ebc3236..000000000 --- a/docs/_archive/explanation/agents/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Understanding Agents" -description: Understanding BMad agents and their roles ---- - -Comprehensive guides to BMad's AI agents — their roles, capabilities, and how to work with them effectively. - -## Agent Guides - -| Agent | Description | -| ------------------------------------------------------------------------------- | ---------------------------------------------------- | -| **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** | Overview of all BMM agent roles and responsibilities | -| **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** | The dedicated agent for rapid development | - -## Getting Started - -1. Read **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** for the core concept explanation -2. Review **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** to understand available agents -3. Choose an agent that fits your workflow needs diff --git a/docs/_archive/explanation/core-concepts/index.md b/docs/_archive/explanation/core-concepts/index.md deleted file mode 100644 index 076c38208..000000000 --- a/docs/_archive/explanation/core-concepts/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BMad Core Concepts" ---- - -Understanding the fundamental building blocks of the BMad Method. - -## The Essentials - -| Concept | Description | Guide | -|---------|-------------|-------| -| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) | -| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) | -| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) | - -## Getting Started - -### New to BMad? -Start here to understand what BMad is and how it works: - -1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents -2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks -3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality - -### Installing BMad - -- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project -- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions - -### Configuration - -- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows - -### Advanced - -- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs diff --git a/docs/_archive/explanation/core-concepts/what-are-agents.md b/docs/_archive/explanation/core-concepts/what-are-agents.md deleted file mode 100644 index b08d9bc1f..000000000 --- a/docs/_archive/explanation/core-concepts/what-are-agents.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Agents" ---- - -Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu. - -## Agent Types - -BMad has two primary agent types, designed for different use cases: - -### Simple Agents - -**Self-contained, focused, ready to use.** - -Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup. - -**Best for:** -- Single-purpose assistants (code review, documentation, commit messages) -- Quick deployment -- Projects that don't require persistent memory -- Getting started fast - -**Example:** A commit message agent that reads your git diff and generates conventional commits. - -### Expert Agents - -**Powerful, memory-equipped, domain specialists.** - -Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks. - -**Best for:** -- Domain specialists (security architect, game designer, product manager) -- Tasks requiring persistent memory -- Complex workflows with multiple stages -- Projects that grow over time - -**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists. - -## Key Differences - -| Feature | Simple | Expert | -| ---------------- | -------------- | -------------------------- | -| **Files** | Single file | Agent + sidecar folder | -| **Memory** | Session only | Persistent across sessions | -| **Capabilities** | Focused scope | Multi-domain, extensible | -| **Setup** | Zero config | Sidecar initialization | -| **Best Use** | Specific tasks | Ongoing projects | - -## Agent Components - -All agents share these building blocks: - -### Persona -- **Role** - What the agent does (expertise domain) -- **Identity** - Who the agent is (personality, character) -- **Communication Style** - How the agent speaks (tone, voice) -- **Principles** - Why the agent acts (values, decision framework) - -### Capabilities -- Skills, tools, and knowledge the agent can apply -- Mapped to specific menu commands - -### Menu -- Interactive command list -- Triggers, descriptions, and handlers -- Auto-includes help and exit options - -### Critical Actions (optional) -- Instructions that execute before the agent starts -- Enable autonomous behaviors (e.g., "check git status before changes") - -## Which Should You Use? - -:::tip[Quick Decision] -Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows. -::: - -**Choose Simple when:** -- You need a task done quickly and reliably -- The scope is well-defined and won't change much -- You don't need the agent to remember things between sessions - -**Choose Expert when:** -- You're building something complex over time -- The agent needs to maintain context (project history, decisions) -- You want the agent to coordinate workflows or other agents -- Domain expertise requires specialized knowledge bases - -## Creating Custom Agents - -BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md) for step-by-step instructions. - - - -## Customizing Existing Agents - -You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained. diff --git a/docs/_archive/explanation/core/index.md b/docs/_archive/explanation/core/index.md deleted file mode 100644 index 9c604a481..000000000 --- a/docs/_archive/explanation/core/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Core Module" ---- - - -The Core Module is installed with all installations of BMad modules and provides common functionality that any module, workflow, or agent can take advantage of. - -## Core Module Components - -- **[Global Core Config](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content -- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module - - [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration - - [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques - - [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods -- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules - - [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files - - [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review - - [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections diff --git a/docs/_archive/explanation/features/web-bundles.md b/docs/_archive/explanation/features/web-bundles.md deleted file mode 100644 index a3b1b5226..000000000 --- a/docs/_archive/explanation/features/web-bundles.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Web Bundles" ---- - -Use BMad agents in Gemini Gems and Custom GPTs. - -:::caution[Status] -The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality. -::: - -## What Are Web Bundles? - -Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload. - -### What's Included - -- Complete agent persona and instructions -- All workflows and dependencies -- Interactive menu system -- Party mode for multi-agent collaboration -- No external files required - -### Use Cases - -**Perfect for:** -- Uploading a single file to a Gemini GEM or Custom GPT -- Using BMad Method from the Web -- Cost savings (generally lower cost than local usage) -- Quick sharing of agent configurations - -**Trade-offs:** -- Some quality reduction vs local usage -- Less convenient than full local installation -- Limited to agent capabilities (no workflow file access) diff --git a/docs/_archive/getting-started-bmadv4.md b/docs/_archive/getting-started-bmadv4.md deleted file mode 100644 index 53ca1c6c6..000000000 --- a/docs/_archive/getting-started-bmadv4.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -title: "Getting Started with BMad v4" -description: Install BMad and create your first planning document ---- - - -Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation. - -:::note[Stable Release] -This tutorial covers BMad v4, the current stable release. For the latest features (with potential breaking changes), see the [BMad v6 Alpha tutorial](./getting-started-bmadv6.md). -::: - -## What You'll Learn - -- Install and configure BMad for your IDE -- Understand how BMad organizes work into phases and agents -- Initialize a project and choose a planning track -- Create your first requirements document - -:::note[Prerequisites] -- **Node.js 20+** — Required for the installer -- **Git** — Recommended for version control -- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar -- **A project idea** — Even a simple one works for learning -::: - -:::tip[Quick Path] -**Install** → `npx bmad-method install` -**Initialize** → Load Analyst agent, run `workflow-init` -**Plan** → PM creates PRD, Architect creates architecture -**Build** → SM manages sprints, DEV implements stories -**Always use fresh chats** for each workflow to avoid context issues. -::: - -## Understanding BMad - -BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases: - -| Phase | Name | What Happens | -|-------|------|--------------| -| 1 | Analysis | Brainstorm, research *(optional)* | -| 2 | Planning | Requirements — PRD or tech-spec *(required)* | -| 3 | Solutioning | Architecture, design decisions *(varies by track)* | -| 4 | Implementation | Build code story by story *(required)* | - -Based on your project's complexity, BMad offers three planning tracks: - -| Track | Best For | Documents Created | -|-------|----------|-------------------| -| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only | -| **BMad Method** | Products, platforms, complex features | PRD + Architecture + UX | -| **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps | - -## Installation - -Open a terminal in your project directory and run: - -```bash -npx bmad-method install -``` - -The interactive installer guides you through setup: - -- **Choose Installation Location** — Select current directory (recommended), subdirectory, or custom path -- **Select Your AI Tool** — Claude Code, Cursor, Windsurf, or other -- **Choose Modules** — Select **BMM** (BMad Method) for this tutorial -- **Accept Defaults** — Customize later in `_bmad/[module]/config.yaml` - -Verify your installation: - -``` -your-project/ -├── _bmad/ -│ ├── bmm/ # Method module -│ │ ├── agents/ # Agent files -│ │ ├── workflows/ # Workflow files -│ │ └── config.yaml # Module config -│ └── core/ # Core utilities -├── _bmad-output/ # Generated artifacts (created later) -└── .claude/ # IDE configuration (if using Claude Code) -``` - -:::tip[Troubleshooting] -Having issues? See [Install BMad](../../how-to/installation/install-bmad.md) for common solutions. -::: - -## Step 1: Initialize Your Project - -Load the **Analyst agent** in your IDE: -- **Claude Code**: Type `/analyst` or load the agent file directly -- **Cursor/Windsurf**: Open the agent file from `_bmad/bmm/agents/` - -Wait for the agent's menu to appear, then run: - -``` -Run workflow-init -``` - -Or use the shorthand: `*workflow-init` - -The workflow asks you to describe: -- **Your project and goals** — What are you building? What problem does it solve? -- **Existing codebase** — Is this new (greenfield) or existing code (brownfield)? -- **Size and complexity** — Roughly how big is this? (adjustable later) - -Based on your description, the workflow suggests a planning track. For this tutorial, choose **BMad Method**. - -Once you confirm, the workflow creates `bmm-workflow-status.yaml` to track your progress. - -:::caution[Fresh Chats] -Always start a fresh chat for each workflow. This prevents context limitations from causing issues. -::: - -## Step 2: Create Your Plan - -With your project initialized, work through the planning phases. - -### Phase 1: Analysis (Optional) - -If you want to brainstorm or research first: -- **brainstorm-project** — Guided ideation with the Analyst -- **research** — Market and technical research -- **product-brief** — Recommended foundation document - -### Phase 2: Planning (Required) - -**Start a fresh chat** and load the **PM agent**. - -``` -Run prd -``` - -Or use shortcuts: `*prd`, select "create-prd" from the menu, or say "Let's create a PRD". - -The PM agent guides you through: -1. **Project overview** — Refine your project description -2. **Goals and success metrics** — What does success look like? -3. **User personas** — Who uses this product? -4. **Functional requirements** — What must the system do? -5. **Non-functional requirements** — Performance, security, scalability needs - -When complete, you'll have `PRD.md` in your `_bmad-output/` folder. - -:::note[UX Design (Optional)] -If your project has a user interface, load the **UX-Designer agent** and run the UX design workflow after creating your PRD. -::: - -### Phase 3: Solutioning (Required for BMad Method) - -**Start a fresh chat** and load the **Architect agent**. - -``` -Run create-architecture -``` - -The architect guides you through technical decisions: tech stack, database design, API patterns, and system structure. - -:::tip[Check Your Status] -Unsure what's next? Load any agent and run `workflow-status`. It tells you the next recommended or required workflow. -::: - -## Step 3: Build Your Project - -Once planning is complete, move to implementation. - -### Initialize Sprint Planning - -Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories. - -### The Build Cycle - -For each story, repeat this cycle with fresh chats: - -| Step | Agent | Workflow | Purpose | -|------|-------|----------|---------| -| 1 | SM | `create-story` | Create story file from epic | -| 2 | DEV | `dev-story` | Implement the story | -| 3 | DEV | `code-review` | Quality validation *(recommended)* | - -After completing all stories in an epic, load the **SM agent** and run `retrospective`. - -## What You've Accomplished - -You've learned the foundation of building with BMad: - -- Installed BMad and configured it for your IDE -- Initialized a project with your chosen planning track -- Created planning documents (PRD, Architecture) -- Understood the build cycle for implementation - -Your project now has: - -``` -your-project/ -├── _bmad/ # BMad configuration -├── _bmad-output/ -│ ├── PRD.md # Your requirements document -│ ├── architecture.md # Technical decisions -│ └── bmm-workflow-status.yaml # Progress tracking -└── ... -``` - -## Quick Reference - -| Command | Agent | Purpose | -|---------|-------|---------| -| `*workflow-init` | Analyst | Initialize a new project | -| `*workflow-status` | Any | Check progress and next steps | -| `*prd` | PM | Create Product Requirements Document | -| `*create-architecture` | Architect | Create architecture document | -| `*sprint-planning` | SM | Initialize sprint tracking | -| `*create-story` | SM | Create a story file | -| `*dev-story` | DEV | Implement a story | -| `*code-review` | DEV | Review implemented code | - -## Common Questions - -**Do I need to create a PRD for every project?** -Only for BMad Method and Enterprise tracks. Quick Flow projects use a simpler tech-spec instead. - -**Can I skip Phase 1 (Analysis)?** -Yes, Phase 1 is optional. If you already know what you're building, start with Phase 2 (Planning). - -**What if I want to brainstorm first?** -Load the Analyst agent and run `*brainstorm-project` before `workflow-init`. - -**Why start fresh chats for each workflow?** -Workflows are context-intensive. Reusing chats can cause the AI to hallucinate or lose track of details. Fresh chats ensure maximum context capacity. - -## Getting Help - -- **During workflows** — Agents guide you with questions and explanations -- **Check status** — Run `workflow-status` with any agent -- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues) -- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode) - -## Key Takeaways - -:::tip[Remember These] -- **Always use fresh chats** — Load agents in new chats for each workflow -- **Let workflow-status guide you** — Ask any agent for status when unsure -- **Track matters** — Quick Flow uses tech-spec; Method/Enterprise need PRD and architecture -- **Tracking is automatic** — Status files update themselves -- **Agents are flexible** — Use menu numbers, shortcuts (`*prd`), or natural language -::: - -Ready to start? Install BMad, load the Analyst, run `workflow-init`, and let the agents guide you. diff --git a/docs/_archive/how-to-workflows/bmgd-quick-flow.md b/docs/_archive/how-to-workflows/bmgd-quick-flow.md deleted file mode 100644 index fe07a124a..000000000 --- a/docs/_archive/how-to-workflows/bmgd-quick-flow.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "BMGD Quick-Flow Guide" -description: Fast-track workflows for rapid game prototyping and flexible development ---- - -Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast. - -## When to Use This - -- Testing a game mechanic idea -- Implementing a small feature -- Rapid prototyping before committing to design -- Bug fixes and tweaks - -## When to Use Full BMGD Instead - -- Building a major feature or system -- The scope is unclear or large -- Multiple team members need alignment -- The work affects game pillars or core loop -- You need documentation for future reference - -:::note[Prerequisites] -- BMad Method installed with BMGD module -- Game Solo Dev agent (Indie) or other BMGD agent available -::: - -## Game Solo Dev Agent - -For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases. - -**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE. - -Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework` - -## Quick-Prototype - -Use `quick-prototype` to rapidly test gameplay ideas with minimal setup. - -### When to Use - -- You have a mechanic idea and want to test the "feel" -- You're not sure if something will be fun -- You want to experiment before committing to design -- You need a proof of concept - -### Steps - -1. Run `quick-prototype` -2. Define what you're prototyping (mechanic, feature, system) -3. Set success criteria (2-3 items) -4. Build the minimum to test the idea -5. Playtest and evaluate - -### Prototype Principles - -- **Minimum Viable Prototype** — Only what's needed to test the idea -- **Hardcode First** — Magic numbers are fine, extract later -- **Skip Edge Cases** — Happy path only for now -- **Placeholder Everything** — Cubes, debug text, temp sounds -- **Comment Intent** — Mark what's temporary vs keeper code - -### After Prototyping - -- **Develop** (`d`) — Use `quick-dev` to build production code -- **Iterate** (`i`) — Adjust and re-test the prototype -- **Archive** (`a`) — Keep as reference, move on to other ideas - -## Quick-Dev - -Use `quick-dev` for flexible development with game-specific considerations. - -### When to Use - -- Implementing a feature from a tech-spec -- Building on a successful prototype -- Making changes that don't need full story workflow -- Quick fixes and improvements - -### Workflow Modes - -**Mode A: Tech-Spec Driven** -``` -quick-dev tech-spec-combat.md -``` - -**Mode B: Direct Instructions** -``` -quick-dev implement double-jump for the player -``` - -**Mode C: From Prototype** -``` -quick-dev from the grappling hook prototype -``` - -### Game-Specific Checks - -Quick-dev includes automatic consideration of: -- **Performance** — No allocations in hot paths, object pooling -- **Feel** — Input responsiveness, visual/audio feedback -- **Integration** — Save/load, multiplayer sync, platform testing - -### Complexity Routing - -| Signals | Recommendation | -|---------|----------------| -| Single mechanic, bug fix, tweak | Execute directly | -| Multiple systems, performance-critical | Plan first (tech-spec) | -| Platform/system level work | Use full BMGD workflow | - -## Choosing Between Quick-Flows - -| Scenario | Use | -|----------|-----| -| "Will this be fun?" | `quick-prototype` | -| "How should this feel?" | `quick-prototype` | -| "Build this feature" | `quick-dev` | -| "Fix this bug" | `quick-dev` | -| "Test then build" | `quick-prototype` → `quick-dev` | - -## Flow Comparison - -``` -Full BMGD Flow: -Brief → GDD → Architecture → Sprint Planning → Stories → Implementation - -Quick-Flow: -Idea → Quick-Prototype → Quick-Dev → Done -``` - -## Checklists - -**Quick-Prototype:** -- [ ] Prototype scope defined -- [ ] Success criteria established (2-3 items) -- [ ] Minimum viable code written -- [ ] Placeholder assets used -- [ ] Each criterion evaluated -- [ ] Decision made (develop/iterate/archive) - -**Quick-Dev:** -- [ ] Context loaded (spec, prototype, or guidance) -- [ ] Files to modify identified -- [ ] All tasks completed -- [ ] No allocations in hot paths -- [ ] Game runs without errors -- [ ] Manual playtest completed - -## Tips - -- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back -- **Embrace programmer art** — Focus on feel, not visuals -- **Test on target hardware** — What feels right on dev machine might not on target -- **Document learnings** — Even failed prototypes teach something -- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories diff --git a/docs/_archive/how-to-workflows/conduct-research.md b/docs/_archive/how-to-workflows/conduct-research.md deleted file mode 100644 index e3300bca8..000000000 --- a/docs/_archive/how-to-workflows/conduct-research.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "How to Conduct Research" -description: How to conduct market, technical, and competitive research using BMad Method ---- - -Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions. - -## When to Use This - -- Need market viability validation -- Choosing frameworks or platforms -- Understanding competitive landscape -- Need user understanding -- Understanding domain or industry -- Need deeper AI-assisted research - -:::note[Prerequisites] -- BMad Method installed -- Analyst agent available -::: - -## Steps - -### 1. Load the Analyst Agent - -Start a fresh chat and load the Analyst agent. - -### 2. Run the Research Workflow - -``` -*research -``` - -### 3. Choose Research Type - -Select the type of research you need: - -| 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 | Need deeper AI-assisted research | - -### 4. Provide Context - -Give the agent details about what you're researching: - -- "SaaS project management tool" -- "React vs Vue for our dashboard" -- "Fintech compliance requirements" - -### 5. Set Research Depth - -Choose your depth level: - -- **Quick** — Fast overview -- **Standard** — Balanced depth -- **Comprehensive** — Deep analysis - -## What You Get - -Research output varies by type: - -**Market Research:** -- TAM/SAM/SOM analysis -- Top competitors -- Positioning recommendation - -**Technical Research:** -- Comparison matrix -- Trade-off analysis -- Recommendations with rationale - -## 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 - -## Tips - -- **Use market research early** — Validates new product ideas -- **Technical research helps architecture** — Inform ADRs with data -- **Competitive research informs positioning** — Differentiate your product -- **Domain research for specialized industries** — Fintech, healthcare, etc. - -## Next Steps - -After research: - -1. **Product Brief** — Capture strategic vision informed by research -2. **PRD** — Use findings as context for requirements -3. **Architecture** — Use technical research in ADRs diff --git a/docs/_archive/how-to-workflows/create-architecture.md b/docs/_archive/how-to-workflows/create-architecture.md deleted file mode 100644 index 6ede529c6..000000000 --- a/docs/_archive/how-to-workflows/create-architecture.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "How to Create Architecture" -description: How to create system architecture using the BMad Method ---- - -Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation. - -## When to Use This - -- Multi-epic projects (BMad Method, Enterprise) -- Cross-cutting technical concerns -- Multiple agents implementing different parts -- Integration complexity exists -- Technology choices need alignment - -## When to Skip This - -- Quick Flow (simple changes) -- BMad Method Simple with straightforward tech stack -- Single epic with clear technical approach - -:::note[Prerequisites] -- BMad Method installed -- Architect agent available -- PRD completed -::: - -## Steps - -### 1. Load the Architect Agent - -Start a fresh chat and load the Architect agent. - -### 2. Run the Architecture Workflow - -``` -*create-architecture -``` - -### 3. Engage in Discovery - -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 - -### 4. Document Key Decisions - -Work with the agent to create Architecture Decision Records (ADRs) for significant choices. - -### 5. Review the Architecture - -The agent produces a decision-focused architecture document. - -## What You Get - -An `architecture.md` document containing: - -1. **Architecture Overview** — System context, principles, style -2. **System Architecture** — High-level diagram, component interactions -3. **Data Architecture** — Database design, state management, caching -4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning -5. **Frontend Architecture** — Framework, state management, components -6. **Integration Architecture** — Third-party integrations, messaging -7. **Security Architecture** — Auth/authorization, data protection -8. **Deployment Architecture** — CI/CD, environments, monitoring -9. **ADRs** — Key decisions with context, options, rationale -10. **FR/NFR-Specific Guidance** — Technical approach per requirement -11. **Standards and Conventions** — Directory structure, naming, testing - -## ADR Format - -```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 -``` - -## Example - -E-commerce platform produces: -- Monolith + PostgreSQL + Redis + Next.js + GraphQL -- ADRs explaining each choice -- FR/NFR-specific implementation guidance - -## Tips - -- **Focus on decisions that prevent conflicts** — Multiple agents need alignment -- **Use ADRs for every significant choice** — Document the "why" -- **Keep it practical** — Don't over-architect -- **Architecture is living** — Update as you learn - -## Next Steps - -After architecture: - -1. **Create Epics and Stories** — Work breakdown informed by architecture -2. **Implementation Readiness** — Gate check before Phase 4 diff --git a/docs/_archive/how-to-workflows/create-epics-and-stories.md b/docs/_archive/how-to-workflows/create-epics-and-stories.md deleted file mode 100644 index aa16a8127..000000000 --- a/docs/_archive/how-to-workflows/create-epics-and-stories.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: "How to Create Epics and Stories" -description: How to break PRD requirements into epics and stories using BMad Method ---- - -Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics. - -## When to Use This - -- After architecture workflow completes -- When PRD contains FRs/NFRs ready for implementation breakdown -- Before implementation-readiness gate check - -:::note[Prerequisites] -- BMad Method installed -- PM agent available -- PRD completed -- Architecture completed -::: - -## Why After Architecture? - -This workflow runs AFTER architecture because: - -1. **Informed Story Sizing** — Architecture decisions affect story complexity -2. **Dependency Awareness** — Architecture reveals technical dependencies -3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack -4. **Consistency** — All stories align with documented architectural patterns - -## Steps - -### 1. Load the PM Agent - -Start a fresh chat and load the PM agent. - -### 2. Run the Workflow - -``` -*create-epics-and-stories -``` - -### 3. Provide Context - -Point the agent to: -- Your PRD (FRs/NFRs) -- Your architecture document -- Optional: UX design artifacts - -### 4. Review Epic Breakdown - -The agent organizes requirements into logical epics with user stories. - -### 5. Validate Story Quality - -Ensure each story has: -- Clear acceptance criteria -- Appropriate priority -- Identified dependencies -- Technical notes from architecture - -## What You Get - -Epic files (one per epic) containing: - -1. **Epic objective and scope** -2. **User stories with acceptance criteria** -3. **Story priorities** (P0/P1/P2/P3) -4. **Dependencies between stories** -5. **Technical notes** referencing architecture decisions - -## Example - -E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces: - -- **Epic 1: User Management** (3 stories) - - Story 1.1: User registration form - - Story 1.2: Email verification - - Story 1.3: Login/logout - -- **Epic 2: Product Display** (4 stories) - - Story 2.1: Product listing page - - Story 2.2: Product detail page - - Story 2.3: Search functionality - - Story 2.4: Category filtering - -Each story references relevant ADRs from architecture. - -## Story Priority Levels - -| Priority | Meaning | -|----------|---------| -| **P0** | Critical — Must have for MVP | -| **P1** | High — Important for release | -| **P2** | Medium — Nice to have | -| **P3** | Low — Future consideration | - -## Tips - -- **Keep stories small** — Complete in a single session -- **Make criteria testable** — Acceptance criteria should be verifiable -- **Document dependencies clearly** — Know what blocks what -- **Reference architecture** — Include ADR references in technical notes - -## Next Steps - -After creating epics and stories: - -1. **Implementation Readiness** — Validate alignment before Phase 4 -2. **Sprint Planning** — Organize work for implementation diff --git a/docs/_archive/how-to-workflows/create-prd.md b/docs/_archive/how-to-workflows/create-prd.md deleted file mode 100644 index f2ec0d0b7..000000000 --- a/docs/_archive/how-to-workflows/create-prd.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "How to Create a PRD" -description: How to create a Product Requirements Document using the BMad Method ---- - -Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs). - -## When to Use This - -- Medium to large feature sets -- Multi-screen user experiences -- Complex business logic -- Multiple system integrations -- Phased delivery required - -:::note[Prerequisites] -- BMad Method installed -- PM agent available -- Optional: Product brief from Phase 1 -::: - -## Steps - -### 1. Load the PM Agent - -Start a fresh chat and load the PM agent. - -### 2. Run the PRD Workflow - -``` -*create-prd -``` - -### 3. Provide Context - -The workflow will: -- Load any existing product brief -- Ask about your project scope -- Gather requirements through conversation - -### 4. Define Requirements - -Work with the agent to define: -- Functional Requirements (FRs) — What the system should do -- Non-Functional Requirements (NFRs) — How well it should do it - -### 5. Review the PRD - -The agent produces a comprehensive PRD scaled to your project. - -## What You Get - -A `PRD.md` document containing: - -- Executive summary -- Problem statement -- User personas -- Functional requirements (FRs) -- Non-functional requirements (NFRs) -- Success metrics -- Risks and assumptions - -## Scale-Adaptive Structure - -The PRD adapts to your project complexity: - -| Scale | Pages | Focus | -|-------|-------|-------| -| **Light** | 10-15 | Focused FRs/NFRs, simplified analysis | -| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis | -| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis | - -## Example - -E-commerce checkout → PRD with: -- 15 FRs (user account, cart management, payment flow) -- 8 NFRs (performance, security, scalability) - -## Tips - -- **Do Product Brief first** — Run product-brief from Phase 1 for better results -- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3 -- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context - -## Next Steps - -After PRD: - -1. **Create UX Design** (optional) — If UX is critical -2. **Create Architecture** — Technical design -3. **Create Epics and Stories** — After architecture diff --git a/docs/_archive/how-to-workflows/create-product-brief.md b/docs/_archive/how-to-workflows/create-product-brief.md deleted file mode 100644 index a45ee1199..000000000 --- a/docs/_archive/how-to-workflows/create-product-brief.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "How to Create a Product Brief" -description: How to create a product brief using the BMad Method ---- - -Use the `product-brief` workflow to define product vision and strategy through an interactive process. - -## When to Use This - -- Starting new product or major feature initiative -- Aligning stakeholders before detailed planning -- Transitioning from exploration to strategy -- Need executive-level product documentation - -:::note[Prerequisites] -- BMad Method installed -- Analyst agent available -- Optional: Research documents from previous workflows -::: - -## Steps - -### 1. Load the Analyst Agent - -Start a fresh chat and load the Analyst agent. - -### 2. Run the Product Brief Workflow - -``` -*product-brief -``` - -### 3. Answer the Interactive Questions - -The workflow guides you through strategic product vision definition: - -- What problem are you solving? -- Who are your target users? -- What makes this solution different? -- What's the MVP scope? - -### 4. Review and Refine - -The agent will draft sections and let you refine them interactively. - -## What You Get - -The `product-brief.md` document includes: - -- **Executive summary** — High-level overview -- **Problem statement** — With evidence -- **Proposed solution** — And differentiators -- **Target users** — Segmented -- **MVP scope** — Ruthlessly defined -- **Financial impact** — And ROI -- **Strategic alignment** — With business goals -- **Risks and open questions** — Documented upfront - -## Integration with Other Workflows - -The product brief feeds directly into the PRD workflow: - -| Analysis Output | Planning Input | -|-----------------|----------------| -| product-brief.md | **prd** workflow | -| market-research.md | **prd** context | -| technical-research.md | **architecture** (Phase 3) | - -Planning workflows automatically load the product brief if it exists. - -## Common Patterns - -**Greenfield Software (Full Analysis):** - -``` -1. brainstorm-project - explore approaches -2. research (market/technical/domain) - validate viability -3. product-brief - capture strategic vision -4. → Phase 2: prd -``` - -**Skip Analysis (Clear Requirements):** - -``` -→ Phase 2: prd or tech-spec directly -``` - -## Tips - -- **Be specific about the problem** — Vague problems lead to vague solutions -- **Ruthlessly prioritize MVP scope** — Less is more -- **Document assumptions and risks** — Surface unknowns early -- **Use research findings as evidence** — Back up claims with data -- **Recommended for greenfield projects** — Sets strategic foundation diff --git a/docs/_archive/how-to-workflows/create-story.md b/docs/_archive/how-to-workflows/create-story.md deleted file mode 100644 index 34380a9aa..000000000 --- a/docs/_archive/how-to-workflows/create-story.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "How to Create a Story" -description: How to create implementation-ready stories from epic backlog ---- - -Use the `create-story` workflow to prepare the next story from the epic backlog for implementation. - -## When to Use This - -- Before implementing each story -- When moving to the next story in an epic -- After sprint-planning has been run - -:::note[Prerequisites] -- BMad Method installed -- SM (Scrum Master) agent available -- Sprint-status.yaml created by sprint-planning -- Architecture and PRD available for context -::: - -## Steps - -### 1. Load the SM Agent - -Start a fresh chat and load the SM (Scrum Master) agent. - -### 2. Run the Workflow - -``` -*create-story -``` - -### 3. Specify the Story - -The agent will: -- Read the sprint-status.yaml -- Identify the next story to work on -- Or let you specify a particular story - -### 4. Review the Story File - -The agent creates a comprehensive story file ready for development. - -## What You Get - -A `story-[slug].md` file containing: - -- Story objective and scope -- Acceptance criteria (specific, testable) -- Technical implementation notes -- References to architecture decisions -- Dependencies on other stories -- Definition of Done - -## Story Content Sources - -The create-story workflow pulls from: - -- **PRD** — Requirements and acceptance criteria -- **Architecture** — Technical approach and ADRs -- **Epic file** — Story context and dependencies -- **Existing code** — Patterns to follow (brownfield) - -## Example Output - -```markdown -## Objective -Implement email verification flow for new user registrations. - -## Acceptance Criteria -- [ ] User receives verification email within 30 seconds -- [ ] Email contains unique verification link -- [ ] Link expires after 24 hours -- [ ] User can request new verification email - -## Technical Notes -- Use SendGrid API per ADR-003 -- Store verification tokens in Redis per architecture -- Follow existing email template patterns in /templates - -## Dependencies -- Story 1.1 (User Registration) - DONE - -## Definition of Done -- All acceptance criteria pass -- Tests written and passing -- Code review approved -``` - -## Tips - -- **Complete one story before creating the next** — Focus on finishing -- **Ensure dependencies are DONE** — Don't start blocked stories -- **Review technical notes** — Align with architecture -- **Use the story file as context** — Pass to dev-story workflow - -## Next Steps - -After creating a story: - -1. **Implement Story** — Run dev-story with the DEV agent -2. **Code Review** — Run code-review after implementation diff --git a/docs/_archive/how-to-workflows/create-ux-design.md b/docs/_archive/how-to-workflows/create-ux-design.md deleted file mode 100644 index 810e934f8..000000000 --- a/docs/_archive/how-to-workflows/create-ux-design.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "How to Create a UX Design" -description: How to create UX specifications using the BMad Method ---- - -Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator. - -## When to Use This - -- UX is primary competitive advantage -- Complex user workflows needing design thinking -- Innovative interaction patterns -- Design system creation -- Accessibility-critical experiences - -## When to Skip This - -- Simple CRUD interfaces -- Internal tools with standard patterns -- Changes to existing screens you're happy with -- Quick Flow projects - -:::note[Prerequisites] -- BMad Method installed -- UX Designer agent available -- PRD completed -::: - -## Steps - -### 1. Load the UX Designer Agent - -Start a fresh chat and load the UX Designer agent. - -### 2. Run the UX Design Workflow - -``` -*create-ux-design -``` - -### 3. Provide Context - -Point the agent to your PRD and describe: -- Key user journeys -- UX priorities -- Any existing design patterns - -### 4. Collaborate on Design - -The workflow uses a 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 - -### 5. Review the UX Spec - -The agent produces comprehensive UX documentation. - -## What You Get - -The `ux-spec.md` document includes: - -- User journeys -- Wireframes and mockups -- Interaction specifications -- Design system (components, patterns, tokens) -- Epic breakdown (UX stories) - -## Example - -Dashboard redesign produces: -- Card-based layout with split-pane toggle -- 5 card components -- 12 color tokens -- Responsive grid -- 3 epics (Layout, Visualization, Accessibility) - -## Integration - -The UX spec feeds into: -- PRD updates -- Epic and story creation -- Architecture decisions (Phase 3) - -## Tips - -- **Focus on user problems first** — Solutions come second -- **Generate multiple options** — Don't settle on the first idea -- **Consider accessibility from the start** — Not an afterthought -- **Document component reusability** — Build a system, not just screens - -## Next Steps - -After UX design: - -1. **Update PRD** — Incorporate UX findings -2. **Create Architecture** — Technical design informed by UX -3. **Create Epics and Stories** — Include UX-specific stories diff --git a/docs/_archive/how-to-workflows/implement-story.md b/docs/_archive/how-to-workflows/implement-story.md deleted file mode 100644 index c243a4ae3..000000000 --- a/docs/_archive/how-to-workflows/implement-story.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "How to Implement a Story" -description: How to implement a story using the dev-story workflow ---- - -Use the `dev-story` workflow to implement a story with tests following the architecture and conventions. - -## When to Use This - -- After create-story has prepared the story file -- When ready to write code for a story -- Story dependencies are marked DONE - -:::note[Prerequisites] -- BMad Method installed -- DEV agent available -- Story file created by create-story -- Architecture and tech-spec available for context -::: - -## Steps - -### 1. Load the DEV Agent - -Start a fresh chat and load the DEV agent. - -### 2. Run the Workflow - -``` -*dev-story -``` - -### 3. Provide Story Context - -Point the agent to the story file created by create-story. - -### 4. Implement with Guidance - -The DEV agent: -- Reads the story file and acceptance criteria -- References architecture decisions -- Follows existing code patterns -- Implements with tests - -### 5. Complete Implementation - -Work with the agent until all acceptance criteria are met. - -## What Happens - -The dev-story workflow: - -1. **Reads context** — Story file, architecture, existing patterns -2. **Plans implementation** — Identifies files to create/modify -3. **Writes code** — Following conventions and patterns -4. **Writes tests** — Unit, integration, or E2E as appropriate -5. **Validates** — Runs tests and checks acceptance criteria - -## Key Principles - -**One Story at a Time** — Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality. - -**Follow Architecture** — The DEV agent references ADRs for technology decisions, standards for naming and structure, and existing patterns in the codebase. - -**Write Tests** — Every story includes appropriate tests: unit tests for business logic, integration tests for API endpoints, E2E tests for critical flows. - -## After Implementation - -1. **Update sprint-status.yaml** — Mark story as READY FOR REVIEW -2. **Run code-review** — Quality assurance -3. **Address feedback** — If code review finds issues -4. **Mark DONE** — After code review passes - -## Tips - -- **Keep the story file open** — Reference it during implementation -- **Ask the agent to explain decisions** — Understand the approach -- **Run tests frequently** — Catch issues early -- **Don't skip tests** — Even for "simple" changes - -## Troubleshooting - -**Story needs significant changes mid-implementation?** -Run `correct-course` to analyze impact and route appropriately. - -**Can I work on multiple stories in parallel?** -Not recommended. Complete one story's full lifecycle first. - -**What if implementation reveals the story is too large?** -Split the story and document the change. - -## Next Steps - -After implementing a story: - -1. **Code Review** — Run code-review with the DEV agent -2. **Create Next Story** — Run create-story with the SM agent diff --git a/docs/_archive/how-to-workflows/quick-spec.md b/docs/_archive/how-to-workflows/quick-spec.md deleted file mode 100644 index 936dbdc3a..000000000 --- a/docs/_archive/how-to-workflows/quick-spec.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "How to Use Quick Spec" -description: How to create a technical specification using Quick Spec workflow ---- - -Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification. - -## When to Use This - -- Bug fixes and small enhancements -- Small features with clear scope (1-15 stories) -- Rapid prototyping -- Adding to existing brownfield codebase -- Quick Flow track projects - -:::note[Prerequisites] -- BMad Method installed -- PM agent or Quick Flow Solo Dev agent available -- Project directory (can be empty for greenfield) -::: - -## Steps - -### 1. Load the PM Agent - -Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent). - -### 2. Run the Tech Spec Workflow - -``` -*quick-spec -``` - -Or simply describe what you want to build: - -``` -I want to fix the login validation bug -``` - -### 3. Answer Discovery Questions - -The workflow will ask: -- What problem are you solving? -- What's the scope of the change? -- Any specific constraints? - -### 4. Review Detected Context - -For brownfield projects, the agent will: -- Detect your project stack -- Analyze existing code patterns -- Detect test frameworks -- Ask: "Should I follow these existing conventions?" - -### 5. Get Your Tech Spec - -The agent generates a comprehensive tech-spec with ready-to-implement stories. - -## What You Get - -**tech-spec.md:** -- 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 - -**Story Files:** -- Single changes: `story-[slug].md` -- Small features: `epics.md` + `story-[epic-slug]-1.md`, etc. - -## Example: Bug Fix - -**You:** "I want to fix the login validation bug that allows empty passwords" - -**Agent:** -1. Asks clarifying questions about the issue -2. Detects your Node.js stack (Express 4.18.2, Jest for testing) -3. Analyzes existing UserService code patterns -4. Asks: "Should I follow your existing conventions?" → Yes -5. Generates tech-spec.md with specific file paths -6. Creates story-login-fix.md - -## Example: Small Feature - -**You:** "I want to add OAuth social login (Google, GitHub)" - -**Agent:** -1. Asks about feature scope -2. Detects your stack (Next.js 13.4, NextAuth.js already installed!) -3. Analyzes existing auth patterns -4. Confirms conventions -5. 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) - -## Implementing After Tech Spec - -```bash -# Single change: -# Load DEV agent and run dev-story - -# Multi-story feature: -# Optional: Load SM agent and run sprint-planning -# Then: Load DEV agent and run dev-story for each story -``` - -## Tips - -- **Be specific in discovery** — "Fix email validation in UserService to allow plus-addressing" beats "Fix validation bug" -- **Trust convention detection** — If it detects your patterns correctly, say yes! It's faster than establishing new conventions -- **Keep single changes atomic** — If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you - -## Next Steps - -After tech spec: - -1. **Implement Story** — Run dev-story with the DEV agent -2. **Sprint Planning** — Optional for multi-story features diff --git a/docs/_archive/how-to-workflows/run-brainstorming-session.md b/docs/_archive/how-to-workflows/run-brainstorming-session.md deleted file mode 100644 index b05b821c9..000000000 --- a/docs/_archive/how-to-workflows/run-brainstorming-session.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "How to Run a Brainstorming Session" -description: How to run a brainstorming session using the BMad Method ---- - -Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks. - -## When to Use This - -- Very vague or seed kernel of an idea that needs exploration -- Consider alternatives or enhancements to an idea -- See your idea from different angles and viewpoints -- No idea what you want to build, but want to find some inspiration - -:::note[Prerequisites] -- BMad Method installed -- Analyst agent available -::: - -## Steps - -### 1. Load the Analyst Agent - -Start a fresh chat and load the Analyst agent. - -### 2. Run the Brainstorm Workflow - -``` -*brainstorm-project -``` - -### 3. Describe Your Idea - -Tell the agent about your project idea, even if it's vague: - -- "I want to build something that helps developers manage their context" -- "I have a game idea about resource management" -- "I need a tool for my team but I'm not sure what exactly" - -### 4. Explore the Tracks - -The workflow generates solution approaches through parallel ideation tracks: - -- **Architecture track** — Technical approaches and patterns -- **UX track** — User experience possibilities -- **Integration track** — How it connects with other systems -- **Value track** — Business value and differentiation - -### 5. Evaluate Options - -Review the generated options with rationale for each approach. - -## What You Get - -- Multiple solution approaches with trade-offs -- Different architectural options -- UX and integration considerations -- Clear rationale for each direction - -## Tips - -- **Don't worry about having a fully formed idea** — Vague is fine -- **Let the agent guide exploration** — Follow the prompts -- **Consider multiple tracks** — Don't settle on the first option -- **Use outputs as input for product-brief** — Build on brainstorming results - -## Next Steps - -After brainstorming: - -1. **Research** — Validate ideas with market/technical research -2. **Product Brief** — Capture strategic vision -3. **PRD** — Move to formal planning diff --git a/docs/_archive/how-to-workflows/run-code-review.md b/docs/_archive/how-to-workflows/run-code-review.md deleted file mode 100644 index ea6e2c853..000000000 --- a/docs/_archive/how-to-workflows/run-code-review.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "How to Run Code Review" -description: How to run code review for quality assurance ---- - -Use the `code-review` workflow to perform a thorough quality review of implemented code. - -## When to Use This - -- After dev-story completes implementation -- Before marking a story as DONE -- Every story goes through code review — no exceptions - -:::note[Prerequisites] -- BMad Method installed -- DEV agent available -- Story implementation complete -- Tests written and passing -::: - -## Steps - -### 1. Load the DEV Agent - -Start a fresh chat (or continue from dev-story) and load the DEV agent. - -### 2. Run the Workflow - -``` -*code-review -``` - -### 3. Provide Context - -Point the agent to: -- The story file -- Files changed during implementation -- Test files - -### 4. Review Findings - -The agent performs a senior developer code review and reports findings. - -### 5. Address Issues - -If issues are found: -1. Fix issues using dev-story -2. Re-run tests -3. Run code-review again - -## What Gets Reviewed - -| Category | Checks | -|----------|--------| -| **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling | -| **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns | -| **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns | -| **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities | -| **Performance** | No obvious issues, appropriate data structures, efficient queries | - -## Review Outcomes - -**Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml. - -**Changes Requested** — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review. - -## Quality Gates - -Every story goes through code-review before being marked done. This ensures: - -- Consistent code quality -- Architecture adherence -- Test coverage -- Security review - -## Tips - -- **Don't skip for "simple" changes** — Simple changes can have subtle bugs -- **Address all findings** — Not just critical ones -- **Use findings as learning opportunities** — Improve over time -- **Re-run review after fixes** — Verify issues are resolved - -## Next Steps - -After code review: - -1. **If approved** — Update sprint-status.yaml to mark story DONE -2. **If changes requested** — Fix issues and re-run review -3. **Move to next story** — Run create-story for the next item diff --git a/docs/_archive/how-to-workflows/run-implementation-readiness.md b/docs/_archive/how-to-workflows/run-implementation-readiness.md deleted file mode 100644 index 8f938f27e..000000000 --- a/docs/_archive/how-to-workflows/run-implementation-readiness.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: "How to Run Implementation Readiness" -description: How to validate planning and solutioning before implementation ---- - -Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation. - -## When to Use This - -- **Always** before Phase 4 for BMad Method and Enterprise projects -- After create-epics-and-stories workflow completes -- Before sprint-planning workflow -- When stakeholders request readiness check - -## When to Skip This - -- Quick Flow (no solutioning phase) -- BMad Method Simple (no gate check required) - -:::note[Prerequisites] -- BMad Method installed -- Architect agent available -- PRD, Architecture, and Epics completed -::: - -## Steps - -### 1. Load the Architect Agent - -Start a fresh chat and load the Architect agent. - -### 2. Run the Workflow - -``` -*implementation-readiness -``` - -### 3. Let the Agent Validate - -The workflow systematically checks: -- PRD completeness -- Architecture completeness -- Epic/Story completeness -- Alignment between all documents - -### 4. Review the Gate Decision - -The agent produces a gate decision with rationale. - -## Gate Decision Outcomes - -| Decision | Meaning | Action | -|----------|---------|--------| -| **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 | -| **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel | -| **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first | - -## What Gets Checked - -**PRD/GDD Completeness:** -- Problem statement clear and evidence-based -- Success metrics defined -- User personas identified -- FRs and NFRs complete -- Risks and assumptions documented - -**Architecture Completeness:** -- System, data, API architecture defined -- Key ADRs documented -- Security architecture addressed -- FR/NFR-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 - -**Alignment Checks:** -- Architecture addresses all PRD FRs/NFRs -- Epics align with architecture decisions -- No contradictions between epics -- Integration points clear - -## What You Get - -An `implementation-readiness.md` document containing: - -1. **Executive Summary** (PASS/CONCERNS/FAIL) -2. **Completeness Assessment** (scores for PRD, Architecture, Epics) -3. **Alignment Assessment** (PRD↔Architecture, Architecture↔Epics) -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 - -**Gaps identified:** -- Missing security architecture section -- Undefined payment gateway - -**Recommendation:** -- Complete security section -- Add payment gateway ADR - -**Action:** Proceed with caution, address before payment epic. - -## Tips - -- **Run before every Phase 4 start** — It's a valuable checkpoint -- **Take FAIL decisions seriously** — Fix issues first -- **Use CONCERNS as a checklist** — Track parallel work -- **Document why you proceed despite concerns** — Transparency matters - -## Next Steps - -After implementation readiness: - -1. **If PASS** — Run sprint-planning to start Phase 4 -2. **If CONCERNS** — Proceed with documented gaps to address -3. **If FAIL** — Return to relevant workflow to fix issues diff --git a/docs/_archive/how-to-workflows/run-sprint-planning.md b/docs/_archive/how-to-workflows/run-sprint-planning.md deleted file mode 100644 index ebdc30667..000000000 --- a/docs/_archive/how-to-workflows/run-sprint-planning.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "How to Run Sprint Planning" -description: How to initialize sprint tracking for implementation ---- - -Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation. - -## When to Use This - -- Once at the start of Phase 4 (Implementation) -- After implementation-readiness gate passes -- When starting a new sprint cycle - -:::note[Prerequisites] -- BMad Method installed -- SM (Scrum Master) agent available -- Epic files created from `create-epics-and-stories` -- Implementation-readiness passed (for BMad Method/Enterprise) -::: - -## Steps - -### 1. Load the SM Agent - -Start a fresh chat and load the SM (Scrum Master) agent. - -### 2. Run the Workflow - -``` -*sprint-planning -``` - -### 3. Provide Context - -Point the agent to your epic files created during Phase 3. - -### 4. Review Sprint Organization - -The agent organizes stories into the sprint tracking file. - -## What You Get - -A `sprint-status.yaml` file containing: - -- All epics with their stories -- Story status tracking (TODO, IN PROGRESS, READY FOR REVIEW, DONE) -- Dependencies between stories -- Priority ordering - -## Story Lifecycle States - -| State | Description | -|-------|-------------| -| **TODO** | Story identified but not started | -| **IN PROGRESS** | Story being implemented | -| **READY FOR REVIEW** | Implementation complete, awaiting code review | -| **DONE** | Accepted and complete | - -## Typical Sprint Flow - -**Sprint 0 (Planning Phase):** -- Complete Phases 1-3 -- PRD/GDD + Architecture complete -- Epics+Stories created via create-epics-and-stories - -**Sprint 1+ (Implementation Phase):** - -Start of Phase 4: -1. SM runs `sprint-planning` (once) - -Per Story (repeat until epic complete): -1. SM runs `create-story` -2. DEV runs `dev-story` -3. DEV runs `code-review` -4. Update sprint-status.yaml - -After Epic Complete: -- SM runs `retrospective` -- Move to next epic - -## Tips - -- **Run sprint-planning only once** — At Phase 4 start -- **Use sprint-status during Phase 4** — Check current state anytime -- **Keep sprint-status.yaml as single source of truth** — All status updates go here -- **Update story status after each stage** — Keep it current - -## Next Steps - -After sprint planning: - -1. **Create Story** — Prepare the first story for implementation -2. **Implement Story** — Run dev-story with the DEV agent -3. **Code Review** — Quality assurance after implementation diff --git a/docs/_archive/how-to-workflows/setup-party-mode.md b/docs/_archive/how-to-workflows/setup-party-mode.md deleted file mode 100644 index ba6fc5d06..000000000 --- a/docs/_archive/how-to-workflows/setup-party-mode.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "How to Set Up Party Mode" -description: How to set up and use Party Mode for multi-agent collaboration ---- - -Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team. - -## When to Use This - -- Exploring complex topics that benefit from diverse expert perspectives -- Brainstorming with agents who can build on each other's ideas -- Getting comprehensive views across multiple domains -- Strategic decisions with trade-offs - -:::note[Prerequisites] -- BMad Method installed with multiple agents -- Any agent loaded that supports party mode -::: - -## Steps - -### 1. Load Any Agent - -Start with any agent that supports party mode (most do). - -### 2. Start Party Mode - -``` -*party-mode -``` - -Or use the full path: -``` -/bmad:core:workflows:party-mode -``` - -### 3. Introduce Your Topic - -Present a topic or question for the group to discuss: - -``` -I'm trying to decide between a monolithic architecture -and microservices for our new platform. -``` - -### 4. Engage with the Discussion - -The facilitator will: -- Select 2-3 most relevant agents based on expertise -- Let agents respond in character -- Enable natural cross-talk and debate -- Continue until you choose to exit - -### 5. Exit When Ready - -Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells. - -## What Happens - -1. **Agent Roster** — Party Mode loads your complete agent roster -2. **Introduction** — Available team members are introduced -3. **Topic Analysis** — The facilitator analyzes your topic -4. **Agent Selection** — 2-3 most relevant agents are selected -5. **Discussion** — Agents respond, reference each other, engage in cross-talk -6. **Exit** — Session concludes with farewells - -## Example Party Compositions - -| Topic | Typical Agents | -| ---------------------- | ----------------------------------------------------- | -| **Product Strategy** | PM + Innovation Strategist + Analyst | -| **Technical Design** | Architect + Creative Problem Solver + Game Architect | -| **User Experience** | UX Designer + Design Thinking Coach + Storyteller | -| **Quality Assessment** | TEA + DEV + Architect | - -## Key Features - -- **Intelligent agent selection** — Selects based on expertise needed -- **Authentic personalities** — Each agent maintains their unique voice -- **Natural cross-talk** — Agents reference and build on each other -- **Graceful exit** — Personalized farewells - -## Tips - -- **Be specific about your topic** — Better agent selection -- **Let the conversation flow** — Don't over-direct -- **Ask follow-up questions** — Go deeper on interesting points -- **Take notes on key insights** — Capture valuable perspectives -- **Use for strategic decisions** — Not routine tasks diff --git a/docs/_archive/reference/workflows/core-workflows.md b/docs/_archive/reference/workflows/core-workflows.md deleted file mode 100644 index 7a4a46003..000000000 --- a/docs/_archive/reference/workflows/core-workflows.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Core Workflows" ---- - -Domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent. - -## Party Mode - -Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage multiple specialized perspectives simultaneously — each agent maintains their unique personality, expertise, and communication style. - -See [Party Mode](/docs/explanation/features/party-mode.md) for detailed usage. - -## Brainstorming - -Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights. - -See [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) for detailed usage. - -## Advanced Elicitation - -Push the LLM to rethink its work through 50+ reasoning methods — the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated. - -See [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) for detailed usage. - -## Workflow Integration - -Core Workflows accept contextual parameters when called from other modules: - -- **Topic focus** — Direct the session toward a specific domain or question -- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime -- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation -- **Output goals** — Define what the final output needs to accomplish diff --git a/docs/_archive/reference/workflows/document-project.md b/docs/_archive/reference/workflows/document-project.md deleted file mode 100644 index 74adca93a..000000000 --- a/docs/_archive/reference/workflows/document-project.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "Document Project Workflow" ---- - -Analyzes and documents brownfield projects for AI-assisted development. - -:::note[Quick Facts] -- **Module:** BMM (BMad Method Module) -- **Command:** `*document-project` -- **Agents:** Analyst, Technical Writer -- **Output:** Master index + documentation files in `{output_folder}` -::: - -## Purpose - -Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type. - -## How to Invoke - -```bash -*document-project -``` - -## Scan Levels - -Choose the right depth for your needs: - -### Quick Scan (Default) - -**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 - -### Deep Scan - -**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 - -### Exhaustive Scan - -**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 - -:::caution[Deep-Dive Mode] -Deep-dive mode always uses exhaustive scan — no choice of scan level. -::: - -## Resumability - -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 diff --git a/docs/_archive/reference/workflows/index.md b/docs/_archive/reference/workflows/index.md deleted file mode 100644 index afaff1a01..000000000 --- a/docs/_archive/reference/workflows/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Workflows Reference" -description: Reference documentation for BMad Method workflows ---- - -Reference documentation for all BMad Method workflows. - -## Core Workflows - -- [Core Workflows](/docs/reference/workflows/core-workflows.md) — Domain-agnostic workflows available to all modules -- [Document Project](/docs/reference/workflows/document-project.md) — Brownfield project documentation - diff --git a/docs/_archive/vendor-workflows.md b/docs/_archive/vendor-workflows.md deleted file mode 100644 index 4ad4f840c..000000000 --- a/docs/_archive/vendor-workflows.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Workflow Vendoring, Customization, and Inheritance" ---- - -Use workflow vendoring and inheritance to share or reutilize workflows across modules. - -## Workflow Vendoring - -Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs. - -### How to Vendor - -Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent. - -From your modules agent definition, you would implement the menu item as follows in the agent: - -```yaml - - trigger: develop-story - exec-vendor: "{project-root}/_bmad//workflows/4-production/dev-story/workflow.md" - exec: "{project-root}/_bmad//workflows/dev-story/workflow.md" - description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story" -``` - -At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.) - -## Workflow Inheritance - -:::note[Coming Soon] -Official support for workflow inheritance is coming post beta. -::: - -Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow. - -Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific. - -Some possible examples could be: - -- Retrospective -- Sprint Planning -- Collaborative Brainstorming Sessions - -## Workflow Customization - -:::note[Coming Soon] -Official support for workflow customization is coming post beta. -::: - -Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now. - -This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time. - -For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow. diff --git a/docs/_basement/explanation/bmm.md b/docs/_basement/explanation/bmm.md deleted file mode 100644 index 2631a43ea..000000000 --- a/docs/_basement/explanation/bmm.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "BMM Documentation" ---- - -Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity. - -## Getting Started - -:::tip[Quick Path] -Install → workflow-init → Follow agent guidance -::: - -**New to BMM?** Start here: - -| Resource | Description | -|----------|-------------| -| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project | -| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points | - -## Core Concepts - -The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules). - -First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts. - -- **[Full Adaptive BMad Method](#workflow-guides)** - Full planning and scope support through extensive development and testing. - - Broken down into 4 phases, all of which are comprised of both required and optional phases - - Phases 1-3 are all about progressive idea development through planning and preparations to build your project. - - Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed - - All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability. - - While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next - -- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow - - 3-step process: spec → dev → optional review - - Perfect for bug fixes and small features - - Rapid prototyping with production quality - - Implementation in minutes, not days - - Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/agents/barry-quick-flow.md)** - -- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**. - -## Agents and Collaboration - -Complete guide to BMM's AI agent team: - -- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference - - 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](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration - - 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](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases - - Documentation phase strategies - - Track selection for brownfield - - Integration with existing patterns - - Phase-by-phase workflow guidance - - Common scenarios - -## Quick References - -Essential reference materials: - -- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts -- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics - -## Choose Your Path - -### I need to... - -**Build something new (greenfield)** -→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - -**Fix a bug or add small feature** -→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process - -**Work with existing codebase (brownfield)** -→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md) -→ Pay special attention to documentation requirements for brownfield projects - -## Workflow Guides - -Comprehensive documentation for all BMM workflows organized by phase: - -- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.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](/docs/how-to/workflows/create-prd.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](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines) - - architecture, create-epics-and-stories, implementation-readiness - - V6: Epics created AFTER architecture for better quality - - Required for BMad Method and Enterprise Method tracks - - Preventing agent conflicts - -- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.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](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines) - - Test strategy, automation, quality gates - - TEA agent and test healing - -## External Resources - -### Community and Support - -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-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 - -:::tip[Ready to Begin?] -[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) -::: diff --git a/docs/_basement/explanation/core-concepts/agent-roles.md b/docs/_basement/explanation/core-concepts/agent-roles.md deleted file mode 100644 index 31e0d76c6..000000000 --- a/docs/_basement/explanation/core-concepts/agent-roles.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: "Agent Roles in BMad Method" -description: Understanding the different agent roles in BMad Method ---- - -BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task. - -## Core Agents Overview - -| Agent | Role | Primary Phase | -|-------|------|---------------| -| **Analyst** | Research and discovery | Phase 1 (Analysis) | -| **PM** | Requirements and planning | Phase 2 (Planning) | -| **Architect** | Technical design | Phase 3 (Solutioning) | -| **SM** | Sprint orchestration | Phase 4 (Implementation) | -| **DEV** | Code implementation | Phase 4 (Implementation) | -| **TEA** | Test architecture | Phases 3-4 (Cross-phase) | -| **UX Designer** | User experience | Phase 2-3 | -| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) | - -## Phase 1: Analysis - -### Analyst (Mary) - -Business analysis and research specialist. - -**Responsibilities:** -- Brainstorming and ideation -- Market, domain, and competitive research -- Product brief creation -- Brownfield project documentation - -**Key Workflows:** -- `*brainstorm-project` -- `*research` -- `*product-brief` -- `*document-project` - -**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases. - -## Phase 2: Planning - -### PM (John) - -Product requirements and planning expert. - -**Responsibilities:** -- Creating Product Requirements Documents -- Defining functional and non-functional requirements -- Breaking requirements into epics and stories -- Validating implementation readiness - -**Key Workflows:** -- `*create-prd` -- `*create-epics-and-stories` -- `*implementation-readiness` - -**When to use:** Defining what to build, creating PRDs, organizing work into stories. - -### UX Designer (Sally) - -User experience and UI design specialist. - -**Responsibilities:** -- UX specification creation -- User journey mapping -- Wireframe and mockup design -- Design system documentation - -**Key Workflows:** -- `*create-ux-design` -- `*validate-design` - -**When to use:** When UX is a primary differentiator, complex user workflows, design system creation. - -## Phase 3: Solutioning - -### Architect (Winston) - -System architecture and technical design expert. - -**Responsibilities:** -- System architecture design -- Architecture Decision Records (ADRs) -- Technical standards definition -- Implementation readiness validation - -**Key Workflows:** -- `*create-architecture` -- `*implementation-readiness` - -**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts. - -## Phase 4: Implementation - -### SM (Bob) - -Sprint planning and story preparation orchestrator. - -**Responsibilities:** -- Sprint planning and tracking -- Story preparation for development -- Course correction handling -- Epic retrospectives - -**Key Workflows:** -- `*sprint-planning` -- `*create-story` -- `*correct-course` -- `*epic-retrospective` - -**When to use:** Organizing work, preparing stories, tracking progress. - -### DEV (Amelia) - -Story implementation and code review specialist. - -**Responsibilities:** -- Story implementation with tests -- Code review -- Following architecture patterns -- Quality assurance - -**Key Workflows:** -- `*dev-story` -- `*code-review` - -**When to use:** Writing code, implementing stories, reviewing quality. - -## Cross-Phase Agents - -### TEA (Murat) - -Test architecture and quality strategy expert. - -**Responsibilities:** -- Test framework setup -- Test design and planning -- ATDD and automation -- Quality gate decisions - -**Key Workflows:** -- `*framework`, `*ci` -- `*test-design`, `*atdd`, `*automate` -- `*test-review`, `*trace`, `*nfr-assess` - -**When to use:** Setting up testing, creating test plans, quality gates. - -## Quick Flow - -### Quick Flow Solo Dev (Barry) - -Fast solo development without handoffs. - -**Responsibilities:** -- Technical specification -- End-to-end implementation -- Code review - -**Key Workflows:** -- `*quick-spec` -- `*quick-dev` -- `*code-review` - -**When to use:** Bug fixes, small features, rapid prototyping. - -## Choosing the Right Agent - -| Task | Agent | -|------|-------| -| Brainstorming ideas | Analyst | -| Market research | Analyst | -| Creating PRD | PM | -| Designing UX | UX Designer | -| System architecture | Architect | -| Preparing stories | SM | -| Writing code | DEV | -| Setting up tests | TEA | -| Quick bug fix | Quick Flow Solo Dev | diff --git a/docs/_basement/explanation/core-concepts/what-are-modules.md b/docs/_basement/explanation/core-concepts/what-are-modules.md deleted file mode 100644 index 0c4eaae04..000000000 --- a/docs/_basement/explanation/core-concepts/what-are-modules.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Modules" ---- - -Modules are organized collections of agents and workflows that solve specific problems or address particular domains. - -## What is a Module? - -A module is a self-contained package that includes: - -- **Agents** - Specialized AI assistants -- **Workflows** - Step-by-step processes -- **Configuration** - Module-specific settings -- **Documentation** - Usage guides and reference - -## Official BMad Method and Builder Modules - -:::note[Core is Always Installed] -The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon. -::: - -### Core Module -Always installed, provides shared functionality: -- Global configuration -- Core workflows (Party Mode, Advanced Elicitation, Brainstorming) -- Common tasks (document indexing, sharding, review) - -### BMad Method (BMM) -Software and game development: -- Project planning workflows -- Implementation agents (Dev, PM, QA, Scrum Master) -- Testing and architecture guidance - -### BMad Builder (BMB) -Create custom solutions: -- Agent creation workflows -- Workflow authoring tools -- Module scaffolding - -## Additional Official BMad Modules - -These are officially maintained modules by BMad but have their own repo's and docs. -These give a good idea also of what can be done with the BMad builder and creating your own custom modules. - -### Creative Intelligence Suite (CIS) -Innovation and creativity: -- Creative thinking techniques -- Innovation strategy workflows -- Storytelling and ideation -- [Available Here](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) - -### BMad Game Dev (BMGD) -Game development specialization: -- Game design workflows -- Narrative development -- Performance testing frameworks -- [Available Here](https://github.com/bmad-code-org/bmad-module-game-dev-studio) - -## Module Structure - -Installed modules follow this structure: - -``` -_bmad/ -├── core/ # Always present -├── bmm/ # BMad Method (if installed) -├── bmb/ # BMad Builder (if installed) -├── cis/ # Creative Intelligence (if installed) -└── bmgd/ # Game Dev (if installed) -``` - -## Custom Modules - -You can create your own modules containing: -- Custom agents for your domain -- Organizational workflows -- Team-specific configurations - -Custom modules are installed the same way as official modules. - -## Installing Modules - -During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer. - -See [Installation Guide](/docs/how-to/installation/index.md) for details. diff --git a/docs/_basement/explanation/core-concepts/what-are-workflows.md b/docs/_basement/explanation/core-concepts/what-are-workflows.md deleted file mode 100644 index e8721da9a..000000000 --- a/docs/_basement/explanation/core-concepts/what-are-workflows.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -title: "Workflows" ---- - -Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs. - -This guide explains what workflows are, why they're powerful, and how to think about designing them. - -## What Is a Workflow? - -A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction. - -Think of it this way: instead of asking "help me build a nutrition plan" and getting a generic response, a workflow guides you (or runs automatically) through discovery, assessment, strategy, shopping lists, and prep schedules—each step building on the last, nothing missed, no shortcuts taken. - -## How do workflows differ from skills? - -Actually they really do not - a workflow can be a skill, and a skill can be a workflow. The main thing with a BMad workflow is the suggestion to follow certain conventions, which actually are also skill best practices. A skill has a few optional and required fields to add as the main file workflow and get stored in a specific location depending on your tool choice for automatic invocation by the llm - whereas workflows are generally intentionally launched, with from another process calling them, or a user invoking via a slash command. In the near future, workflows will optionally be installable as skills also - but if you like, you can add front matter to your custom workflows based on the skill spec from Anthropic, and put them in the proper location your tool dictates. - -### The Power of Progressive Disclosure - -Here's why workflows work so well: the AI only sees the current step. It doesn't know about step 5 when it's on step 2. It can't get ahead of itself, skip steps, or lose focus. Each step gets the AI's full attention, completing fully before the next step loads. - -This is the opposite of a giant prompt that tries to handle everything at once and inevitably misses details or loses coherence. - -Workflows exist on a spectrum: - -- **Interactive workflows** guide users through complex decisions via collaboration and facilitation -- **Automated workflows** run with minimal user input, processing documents or executing tasks -- **Hybrid workflows** combine both—some steps need user input, others run automatically - -### Real-World Workflow Examples - -**Tax Organizer Workflow** - -A tax preparation workflow that helps users organize financial documents for tax filing. Runs in a single session, follows prescriptive IRS categories, produces a checklist of required documents with missing-item alerts. Sequential and compliance-focused. - -**Meal Planning Workflow** - -Creates personalized weekly meal plans through collaborative nutrition planning. Users can stop mid-session and return later because the workflow tracks progress. Intent-based conversation helps discover preferences rather than following a script. Multi-session, creative, and highly interactive. - -**Course Creator Workflow** - -Helps instructors design course syllabi. Branches based on course type—academic courses need accreditation sections, vocational courses need certification prep, self-paced courses need different structures entirely. - -**Therapy Intake Workflow** - -Guides mental health professionals through structured client intake sessions. Highly sensitive and confidential, uses intent-based questioning to build rapport while ensuring all required clinical information is collected. Continuable across multiple sessions. - -**Software Architecture Workflow** (BMM Module) - -Part of a larger software development pipeline. Runs after product requirements and UX design are complete, takes those documents as input, then collaboratively walks through technical decisions: system components, data flows, technology choices, architectural patterns. Produces an architecture document that implementation teams use to build consistently. - -**Shard Document Workflow** - -Nearly hands-off automated workflow. Takes a large document as input, uses a custom npx tool to split it into smaller files, deletes the original, then augments an index with content details so the LLM can efficiently find and reference specific sections later. Minimal user interaction—just specify the input document. - -These examples show the range: from collaborative creative processes to automated batch jobs, workflows ensure completeness and consistency whether the work involves deep collaboration or minimal human oversight. - -### The Facilitative Philosophy - -When workflows involve users, they should be **facilitative, not directive**. The AI treats users as partners and domain experts, not as passive recipients of generated content. - -**Collaborative dialogue, not command-response**: The AI and user work together throughout. The AI brings structured thinking, methodology, and technical knowledge. The user brings domain expertise, context, and judgment. Together they produce something better than either could alone. - -**The user is the expert in their domain**: A nutrition planning workflow doesn't dictate meal plans—it guides users through discovering what works for their lifestyle. An architecture workflow doesn't tell architects what to build—it facilitates systematic decision-making so choices are explicit and consistent. - -**Intent-based facilitation**: Workflows should describe goals and approaches, not scripts. Instead of "Ask: What is your age? Then ask: What is your goal weight?" use "Guide the user through understanding their health profile. Ask 1-2 questions at a time. Think about their responses before asking follow-ups. Probe to understand their actual needs." - -The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative. - -:::caution[When to Be Prescriptive] -Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise. -::: - -## Why Workflows Matter - -Workflows solve three fundamental problems with AI interactions: - -**Focus**: Each step contains only instructions for that phase. The AI sees one step at a time, preventing it from getting ahead of itself or losing focus. - -**Continuity**: Workflows can span multiple sessions. Stop mid-workflow and return later without losing progress—something free-form prompts can't do. - -**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results. - -## How Workflows Work - -### The Basic Structure - -Workflows consist of multiple markdown files, each representing one step: - -``` -my-workflow/ -├── workflow.md # Entry point and configuration -├── steps/ # Step files (steps-c/ for create, steps-e/ for edit, steps-v/ for validate) -│ ├── step-01-init.md -│ ├── step-02-profile.md -│ └── step-N-final.md -├── data/ # Reference materials, CSVs, examples -└── templates/ # Output document templates -``` - -The `workflow.md` file is minimal—it contains the workflow name, description, goal, the AI's role, and how to start. Importantly, it does not list all steps or detail what each does. This is progressive disclosure in action. - -### Sequential Execution - -Workflows execute in strict sequence: `step-01 → step-02 → step-03 → ... → step-N` - -The AI cannot skip steps or optimize the sequence. It must complete each step fully before loading the next. This ensures thoroughness and prevents shortcuts that compromise quality. - -### Continuable Workflows - -Some workflows are complex enough that users might need multiple sessions. These "continuable workflows" track which steps are complete in the output document's frontmatter, so users can stop and resume later without losing progress. - -Use continuable workflows when: -- The workflow produces large documents -- Multiple sessions are likely -- Complex decisions benefit from reflection -- The workflow has many steps (8+) - -Keep it simple (single-session) when tasks are quick, focused, and can be completed in one sitting. - -### Workflow Chaining - -Workflows can be chained together where outputs become inputs. The BMM module pipeline is a perfect example: - -``` -brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning - ↓ - implement-story → review → repeat -``` - -Each workflow checks for required inputs from prior workflows, validates they're complete, and produces output for the next workflow. This creates powerful end-to-end pipelines for complex processes. - -### The Tri-Modal Pattern - -For critical workflows that produce important artifacts, BMad uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others. - -**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMad standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns. - -**Validate mode** runs standalone and checks artifacts against standards. Because it's separate, you can run validation whenever you want—immediately after creation, weeks later when things have changed, or even using a different LLM entirely. It's like having a quality assurance checkpoint that's always available but never forced. - -**Edit mode** modifies existing artifacts while enforcing standards. As you update documents to reflect changing requirements or new understanding, edit mode ensures you don't accidentally drift away from the patterns that make the artifacts useful. It checks compliance as you work and can route back to create mode if it detects something that needs full conversion. - -All BMad planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action. - -This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members. - -## Design Decisions - -Before building a workflow, answer these questions: - -**Module affiliation**: Is this standalone or part of a module? Module-based workflows can access module-specific variables and reference other workflow outputs. Also when part of a module, generally they will be associated to an agent. - -**Continuable or single-session?**: Will users need multiple sessions, or can this be completed in one sitting? - -**Edit/Validate support?**: Do you need Create/Edit/Validate modes (tri-modal structure)? Use tri-modal for complex, critical workflows requiring quality assurance. Use create-only for simple, one-off workflows. - -**Document output?**: Does this produce a persistent file, or perform actions without output? - -**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)? - -## Learning from Examples - -The best way to understand workflows is to study real examples. Look at the official BMad modules: - -- **BMB (Module Builder)**: Module, Workflow and Agent creation workflows -- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning -- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture -- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy - -Study the workflow.md files to understand how each workflow starts. Examine step files to see how instructions are structured. Notice the frontmatter variables, menu handling, and how steps chain together. - -Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same. - -## When to Use Workflows - -Use workflows when: - -- **Tasks are multi-step and complex**: Break down complexity into manageable pieces -- **Quality and completeness matter**: Sequential enforcement ensures nothing gets missed -- **Repeatability is important**: Get consistent results every time -- **Tasks span multiple sessions**: Continuable workflows preserve progress -- **You need to chain processes**: Output of one workflow becomes input of another -- **Compliance or standards matter**: Enforce required steps and documentation - -Don't use workflows when: - -- **Tasks are simple and one-off**: A single prompt works fine for quick questions -- **Flexibility trumps structure**: Free-form conversation is better for exploration - -Modified BMad Workflows - -- **Tasks are truly one-step** - -If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have -a short single file workflow.md file. - -## The Bottom Line - -Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match. - -They're not just for software development. You can create workflows for any guided process - meal planning, course design, therapy intake, tax preparation, document processing, creative writing, event planning—any complex task that benefits from structure and thoroughness. - -Start simple. Study examples. Build workflows for your own domain. You'll wonder how you ever got by with just prompts. diff --git a/docs/_basement/explanation/facilitation-over-generation.md b/docs/_basement/explanation/facilitation-over-generation.md deleted file mode 100644 index a0298c5a8..000000000 --- a/docs/_basement/explanation/facilitation-over-generation.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -title: "Facilitation Over Generation" -description: Understanding a facilitation-first approach to AI workflows and creative collaboration ---- - -BMAD workflows take a fundamentally different approach from typical AI Prompts you will find. Instead of generating solutions directly, workflows act as facilitators who guide you through discovery processes, helping you arrive at insights and decisions yourself. - -This has always been the magic of the BMad method - if you have used it you have felt it intuitively and noticed a difference - and it is through this document I want to really explain what this is. This is fundamental to understand if you are also interested in producing your own workflows or improving upon existing ones in any BMad related module. - -## The Problem with Generation - -Traditional AI approaches to creative and knowledge work typically follow this pattern: - -:::note[Generation Example] -**User:** "I need a comprehensive UX design for my e-commerce app" - -**AI:** [Immediately generates] "Here's a complete UX specification with modern dark theme, card-based product grid, left navigation, and checkout flow..." -::: - -This approach: -- Produces generic, predictable outputs that may not fit your actual needs -- Removes your ownership and understanding of the solution -- Misses critical context, constraints, and nuance -- Limits creative exploration to the AI's training data patterns -- Creates deliverables you can't explain or iterate on effectively - -## The Facilitation Approach - -Facilitative workflows use strategic questioning and guided discovery: - -:::note[Facilitation Example from UX Design Workflow] -**User:** "I need a comprehensive UX design for my e-commerce app" - -**Workflow:** "Welcome! I'll act as your UX facilitator to help you discover the right approach. First, let me understand what documents you already have—do you have a product brief, PRD, or any research?" - -**User:** "I have a product brief and some user research" - -**Workflow:** "Great! Let me load those. [Loads documents] Now, what are the primary user goals for your e-commerce experience? What should users be able to accomplish?" - -**User:** "They need to browse products quickly and complete purchases without friction" - -**Workflow:** "Interesting! And what makes your e-commerce situation unique? What are the specific challenges or constraints you're working with?" -::: - -This approach: -- Draws out insights and expertise already within you -- Maintains your ownership and understanding of decisions -- Captures your specific context, constraints, and goals -- Enables deeper exploration of your unique situation -- Creates outputs you can confidently explain and iterate on - -## Real-World Examples from BMAD Workflows - -### Brainstorming Workflow (from core module) - -The brainstorming workflow demonstrates pure facilitation through its entire journey: - -**Session Setup:** -``` -"Welcome! I'm excited to facilitate your brainstorming session. I'll guide you -through proven creativity techniques to generate innovative ideas. - -**What are we brainstorming about?** (The central topic or challenge) -**What specific outcomes are you hoping for?** (Types of ideas, solutions, or insights) -``` - -**Technique Selection - Offering Options:** -``` -"Ready to explore technique approaches? -[1] User-Selected Techniques - Browse our complete technique library -[2] AI-Recommended Techniques - Get customized suggestions based on your goals -[3] Random Technique Selection - Discover unexpected creative methods -[4] Progressive Technique Flow - Start broad, then systematically narrow focus - -Which approach appeals to you most?" -``` - -**Technique Execution - Interactive Coaching:** -The workflow doesn't generate ideas—it coaches you through techniques with genuine back-and-forth dialogue: - -``` -"Let's start with: What if you could remove all practical constraints? - -I'm not just looking for a quick answer - I want to explore this together. -What immediately comes to mind? Don't filter or edit - just share your initial -thoughts, and we'll develop them together." - -[User responds] - -"That's interesting! Tell me more about [specific aspect you mentioned]. -What would that look like in practice? How does that connect to your core goal?" -``` - -**Key facilitation behaviors:** -- Aims for 100+ ideas before suggesting organization -- Asks "Continue exploring?" or "Move to next technique?"—user controls pace -- Uses anti-bias protocols to force thinking in new directions every 10 ideas -- Builds on user's ideas with genuine creative contributions -- Keeps user in "generative exploration mode" as long as possible - -**Organization - Collaborative Synthesis:** -``` -"Outstanding creative work! You've generated an incredible range of ideas. -Now let's organize these creative gems and identify your most promising opportunities. - -I'm analyzing all your generated ideas to identify natural themes and patterns. -**Emerging Themes I'm Identifying:** -- Theme 1: [Name] - Ideas: [list] - Pattern: [connection] -- Theme 2: [Name] - Ideas: [list] - Pattern: [connection] - -Which themes or specific ideas stand out to you as most valuable?" -``` - -Result: A comprehensive brainstorming session document with **your** ideas, organized by **your** priorities, with **your** action plans. - -### Create UX Design Workflow (from BMM method) - -The UX design workflow facilitates a 14-step journey from project understanding to complete UX specification—**never making design decisions for you**. - -**Step 1: Document Discovery (Collaborative Setup)** -``` -"Welcome! I've set up your UX design workspace. - -**Documents Found:** -- PRD: product-requirements.md -- Product brief: brief.md - -**Files loaded:** [lists specific files] - -Do you have any other documents you'd like me to include, or shall we continue?" -``` - -**Step 2: Project Understanding (Discovery Questions)** -``` -"Based on the project documentation, let me confirm what I'm understanding... - -**From the documents:** [summary of key insights] -**Target Users:** [summary from documents] -**Key Features/Goals:** [summary from documents] - -Does this match your understanding? Are there any corrections or additions?" -``` - -Then it dives deeper with targeted questions: -``` -"Let me understand your users better to inform the UX design: - -**User Context Questions:** -- What problem are users trying to solve? -- What frustrates them with current solutions? -- What would make them say 'this is exactly what I needed'?" -``` - -**Step 3: Core Experience Definition (Guiding Insights)** -``` -"Now let's dig into the heart of the user experience. - -**Core Experience Questions:** -- What's the ONE thing users will do most frequently? -- What user action is absolutely critical to get right? -- What should be completely effortless for users? -- If we nail one interaction, everything else follows - what is it? - -Think about the core loop or primary action that defines your product's value." -``` - -**Step 4: Emotional Response (Feelings-Based Design)** -``` -"Now let's think about how your product should make users feel. - -**Emotional Response Questions:** -- What should users FEEL when using this product? -- What emotion would make them tell a friend about this? -- How should users feel after accomplishing their primary goal? - -Common emotional goals: Empowered and in control? Delighted and surprised? -Efficient and productive? Creative and inspired?" -``` - -**Step 5: Pattern Inspiration (Learning from Examples)** -``` -"Let's learn from products your users already love and use regularly. - -**Inspiration Questions:** -- Name 2-3 apps your target users already love and USE frequently -- For each one, what do they do well from a UX perspective? -- What makes the experience compelling or delightful? - -For each inspiring app, let's analyze their UX success: -- What core problem does it solve elegantly? -- What makes the onboarding experience effective? -- How do they handle navigation and information hierarchy?" -``` - -**Step 9: Design Directions (Interactive Visual Exploration)** -The workflow generates 6-8 HTML mockup variations—but **you choose**: - -``` -"🎨 Design Direction Mockups Generated! - -I'm creating a comprehensive HTML showcase with 6-8 full-screen mockup variations. -Each mockup represents a complete visual direction for your app's look and feel. - -**As you explore the design directions, look for:** -✅ Which information hierarchy matches your priorities? -✅ Which interaction style fits your core experience? -✅ Which visual density feels right for your brand? - -**Which approach resonates most with you?** -- Pick a favorite direction as-is -- Combine elements from multiple directions -- Request modifications to any direction - -Tell me: Which layout feels most intuitive? Which visual weight matches your brand?" -``` - -**Step 12: UX Patterns (Consistency Through Questions)** -``` -"Let's establish consistency patterns for common situations. - -**Pattern Categories to Define:** -- Button hierarchy and actions -- Feedback patterns (success, error, warning, info) -- Form patterns and validation -- Navigation patterns - -Which categories are most critical for your product? - -**For [Critical Pattern Category]:** -What should users see/do when they need to [pattern action]? - -**Considerations:** -- Visual hierarchy (primary vs. secondary actions) -- Feedback mechanisms -- Error recovery -- Accessibility requirements - -How should your product handle [pattern type] interactions?" -``` - -**The Result:** A complete, production-ready UX specification document that captures **your** decisions, **your** reasoning, and **your** vision—documented through guided discovery, not generation. - -## Key Principles - -### 1. Questions Over Answers - -Facilitative workflows ask strategic questions rather than providing direct answers. This: -- Activates your own creative and analytical thinking -- Uncovers assumptions you didn't know you had -- Reveals blind spots in your understanding -- Builds on your domain expertise and context - -### 2. Multi-Turn Conversation - -Facilitation uses progressive discovery, not interrogation: -- Ask 1-2 questions at a time, not laundry lists -- Think about responses before asking follow-ups -- Probe to understand deeper, not just collect facts -- Use conversation to explore, not just extract - -### 3. Intent-Based Guidance - -Workflows specify goals and approaches, not exact scripts: -- "Guide the user through discovering X" (intent) -- NOT "Say exactly: 'What is X?'" (prescriptive) - -This allows the workflow to adapt naturally to your responses while maintaining structured progress. - -### 4. Process Trust - -Facilitative workflows use proven methodologies: -- Design Thinking's phases (Empathize, Define, Ideate, Prototype, Test) -- Structured brainstorming and creativity techniques -- Root cause analysis frameworks -- Innovation strategy patterns - -You're not just having a conversation—you're following time-tested processes adapted to your specific situation. - -### 5. YOU Are the Expert - -Facilitative workflows operate on a core principle: **you are the expert on your situation**. The workflow brings: -- Process expertise (how to think through problems) -- Facilitation skills (how to guide exploration) -- Technique knowledge (proven methods and frameworks) - -You bring: -- Domain knowledge (your specific field or industry) -- Context understanding (your unique situation and constraints) -- Decision authority (what will actually work for you) - -## When Generation is Appropriate - -Facilitative workflows DO generate when appropriate: -- Synthesizing and structuring outputs after you've made decisions -- Documenting your choices and rationale -- Creating structured artifacts based on your input -- Providing technique examples or option templates -- Formatting and organizing your conclusions - -But the **core creative and analytical work** happens through facilitated discovery, not generation. - -## The Distinction: Facilitator vs Generator - -| Facilitative Workflow | Generative AI | -| ------------------------------------- | --------------------------------------- | -| "What are your goals?" | "Here's the solution" | -| Asks 1-2 questions at a time | Produces complete output immediately | -| Multiple turns, progressive discovery | Single turn, bulk generation | -| "Let me understand your context" | "Here's a generic answer" | -| Offers options, you choose | Makes decisions for you | -| Documents YOUR reasoning | No reasoning visible | -| You can explain every decision | You can't explain why choices were made | -| Ownership and understanding | Outputs feel alien | - -## Benefits - -### For Individuals -- **Deeper insights** than pure generation—ideas connect to your actual knowledge -- **Full ownership** of creative outputs and decisions -- **Skill development** in structured thinking and problem-solving -- **More memorable and actionable** results—you understand the "why" - -### For Teams -- **Shared creative experience** building alignment and trust -- **Aligned understanding** through documented exploration -- **Documented rationale** for future reference and onboarding -- **Stronger buy-in** to outcomes because everyone participated in discovery - -### For Implementation -- **Outputs match reality** because they emerged from your actual constraints -- **Easier iteration** because you understand the reasoning behind choices -- **Confident implementation** because you can defend every decision -- **Reduced rework** because facilitation catches issues early diff --git a/docs/_basement/explanation/faq/getting-started-faq.md b/docs/_basement/explanation/faq/getting-started-faq.md deleted file mode 100644 index 78b7c88e7..000000000 --- a/docs/_basement/explanation/faq/getting-started-faq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Getting Started FAQ" -description: Common questions about getting started with the BMad Method ---- - -Quick answers to common questions about getting started with the BMad Method. - -## Questions - -- [Why does BMad use so many tokens?](#why-does-bmad-use-so-many-tokens) -- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init) -- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow) -- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working) -- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started) -- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4) - -### Why does BMad use so many tokens? - -BMad is not always the most token efficient approach, and that's by design. The checkpoints, story files, and retrospectives keep you in the loop so you can apply taste, judgment, and accumulated context that no agent has. Fully automated coding loops optimize for code velocity; BMad optimizes for decision quality. If you're building something you'll maintain for years, where user experience matters, where architectural choices compound—that tradeoff pays for itself. - -### Do I always need to run workflow-init? - -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 Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow. - -### Why do I need fresh chats for each workflow? - -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. - -### Can I skip workflow-status and just start working? - -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 - -### What's the minimum I need to get started? - -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 - -### How do I know if I'm in Phase 1, 2, 3, or 4? - -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 - -**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/docs/_basement/explanation/faq/implementation-faq.md b/docs/_basement/explanation/faq/implementation-faq.md deleted file mode 100644 index fe4f64cb3..000000000 --- a/docs/_basement/explanation/faq/implementation-faq.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Implementation FAQ" -description: Common questions about implementation in the BMad Method ---- - -Quick answers to common questions about implementation in the BMad Method. - -## Questions - -- [Does create-story include implementation context?](#does-create-story-include-implementation-context) -- [How do I mark a story as done?](#how-do-i-mark-a-story-as-done) -- [Can I work on multiple stories at once?](#can-i-work-on-multiple-stories-at-once) -- [What if my story takes longer than estimated?](#what-if-my-story-takes-longer-than-estimated) -- [When should I run retrospective?](#when-should-i-run-retrospective) - -### Does create-story include implementation context? - -Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler. - -### How do I mark a story as done? - -After dev-story completes and code-review passes: - -1. Open `sprint-status.yaml` (created by sprint-planning) -2. Change the story status from `review` to `done` -3. Save the file - -### Can I work on multiple stories at once? - -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. - -### What if my story takes longer than estimated? - -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 - -### When should I run retrospective? - -After completing all stories in an epic (when epic is done). Retrospectives capture: - -- What went well -- What could improve -- Technical insights -- Learnings for future epics - -Don't wait until project end — run after each epic for continuous improvement. - -**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/docs/_basement/explanation/faq/index.md b/docs/_basement/explanation/faq/index.md deleted file mode 100644 index 2ccd7d3ab..000000000 --- a/docs/_basement/explanation/faq/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Frequently Asked Questions" -description: Frequently asked questions about the BMad Method ---- - -Quick answers to common questions about the BMad Method, organized by topic. - -## Topics - -- [Getting Started](/docs/explanation/faq/getting-started-faq.md) - Questions about starting with BMad -- [Levels & Tracks](/docs/explanation/faq/levels-and-tracks-faq.md) - Choosing the right level -- [Workflows](/docs/explanation/faq/workflows-faq.md) - Workflow and phase questions -- [Planning](/docs/explanation/faq/planning-faq.md) - Planning document questions -- [Implementation](/docs/explanation/faq/implementation-faq.md) - Implementation questions -- [Brownfield](/docs/explanation/faq/brownfield-faq.md) - Existing codebase questions -- [Tools & Advanced](/docs/explanation/faq/tools-faq.md) - Tools, IDEs, and advanced topics diff --git a/docs/_basement/explanation/faq/levels-and-tracks-faq.md b/docs/_basement/explanation/faq/levels-and-tracks-faq.md deleted file mode 100644 index acce6ae19..000000000 --- a/docs/_basement/explanation/faq/levels-and-tracks-faq.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Levels and Tracks FAQ" -description: Common questions about choosing the right level for your project ---- - -Quick answers to common questions about choosing the right level for your BMad Method project. - -## Questions - -- [How do I know which level my project is?](#how-do-i-know-which-level-my-project-is) -- [Can I change levels mid-project?](#can-i-change-levels-mid-project) -- [What if workflow-init suggests the wrong level?](#what-if-workflow-init-suggests-the-wrong-level) -- [Do I always need architecture for Level 2?](#do-i-always-need-architecture-for-level-2) -- [What's the difference between Level 1 and Level 2?](#whats-the-difference-between-level-1-and-level-2) - -### How do I know which level my project is? - -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" → 1-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. - -### Can I change levels mid-project? - -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. - -### What if workflow-init suggests the wrong level? - -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. - -### Do I always need architecture for Level 2? - -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 created during planning. - -### What's the difference between Level 1 and Level 2? - -- **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 - -**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/docs/_basement/explanation/faq/planning-faq.md b/docs/_basement/explanation/faq/planning-faq.md deleted file mode 100644 index c6ab49fe3..000000000 --- a/docs/_basement/explanation/faq/planning-faq.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Planning Documents FAQ" -description: Common questions about planning documents in the BMad Method ---- - -Quick answers to common questions about planning documents in the BMad Method. - -## Questions - -- [Why no tech-spec at Level 2+?](#why-no-tech-spec-at-level-2) -- [Do I need a PRD for a bug fix?](#do-i-need-a-prd-for-a-bug-fix) -- [Can I skip the product brief?](#can-i-skip-the-product-brief) - -### Why no tech-spec at Level 2+? - -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, functional requirements, non-functional requirements) -- Architecture (system design) -- Epics+Stories (created AFTER architecture is complete) - -### Do I need a PRD for a bug fix? - -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. - -### Can I skip the product brief? - -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 - -**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/docs/_basement/explanation/faq/tools-faq.md b/docs/_basement/explanation/faq/tools-faq.md deleted file mode 100644 index 061f43e98..000000000 --- a/docs/_basement/explanation/faq/tools-faq.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -title: "Tools and Advanced FAQ" -description: Common questions about tools, IDEs, and advanced topics in the BMad Method ---- - -Quick answers to common questions about tools, IDEs, and advanced topics in the BMad Method. - -## Questions - -**Tools and Technical** - -- [Questions](#questions) -- [Tools and Technical](#tools-and-technical) - - [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering) - - [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools) - - [What IDEs/tools support BMM?](#what-idestools-support-bmm) - - [Can I customize agents?](#can-i-customize-agents) - - [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation) - - [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects) -- [Advanced](#advanced) - - [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3) - - [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches) - - [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint) - - [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations) - - [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project) - - [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it) -- [Getting Help](#getting-help) - - [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here) - - [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature) - -**Advanced** - -- [Questions](#questions) -- [Tools and Technical](#tools-and-technical) - - [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering) - - [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools) - - [What IDEs/tools support BMM?](#what-idestools-support-bmm) - - [Can I customize agents?](#can-i-customize-agents) - - [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation) - - [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects) -- [Advanced](#advanced) - - [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3) - - [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches) - - [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint) - - [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations) - - [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project) - - [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it) -- [Getting Help](#getting-help) - - [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here) - - [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature) - -**Getting Help** - -- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here) -- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature) - -## Tools and Technical - -### Why are my Mermaid diagrams not rendering? - -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. - -### Can I use BMM with GitHub Copilot / Cursor / other AI tools? - -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. - -### What IDEs/tools support BMM? - -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. - -### Can I customize agents? - -Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/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. - -### What happens to my planning docs after implementation? - -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. - -### Can I use BMM for non-software projects? - -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 - -### What if my project grows from Level 1 to Level 3? - -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. - -### Can I mix greenfield and brownfield approaches? - -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 - -### How do I handle urgent hotfixes during a sprint? - -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. - -### What if I disagree with the workflow's recommendations? - -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. - -### Can multiple developers work on the same BMM project? - -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 - -### What is party mode and when should I use it? - -Party mode is a unique multi-agent collaboration feature where ALL your installed modules agents discuss your challenges together in real-time or have some fun with any topic you have in mind. - -**How it works:** - -1. Run `/bmad:core:workflows:party-mode` (or `PM or fuzzy match on 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:** See the [Party Mode Guide](/docs/explanation/features/party-mode.md) - -## Getting Help - -### Where do I get help if my question isn't answered here? - -1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics -2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help) -3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) -4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode) - -### How do I report a bug or request a feature? - -Open a GitHub issue at: - -Please include: - -- BMM version (check your installed version) -- Steps to reproduce (for bugs) -- Expected vs actual behavior -- Relevant workflow or agent involved - -**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/docs/_basement/explanation/faq/workflows-faq.md b/docs/_basement/explanation/faq/workflows-faq.md deleted file mode 100644 index 9e92121f5..000000000 --- a/docs/_basement/explanation/faq/workflows-faq.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "Workflows FAQ" -description: Common questions about BMad Method workflows and phases ---- - -Quick answers to common questions about BMad Method workflows and phases. - -## Questions - -- [What's the difference between workflow-status and workflow-init?](#whats-the-difference-between-workflow-status-and-workflow-init) -- [Can I skip Phase 1 (Analysis)?](#can-i-skip-phase-1-analysis) -- [When is Phase 3 (Architecture) required?](#when-is-phase-3-architecture-required) -- [What happens if I skip a recommended workflow?](#what-happens-if-i-skip-a-recommended-workflow) -- [How do I know when Phase 3 is complete?](#how-do-i-know-when-phase-3-is-complete) -- [Can I run workflows in parallel?](#can-i-run-workflows-in-parallel) - -### What's the difference between workflow-status and workflow-init? - -- **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. - -### Can I skip Phase 1 (Analysis)? - -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) - -### When is Phase 3 (Architecture) required? - -- **Level 0-1** — Never (skip entirely) -- **Level 2** — Optional (only if system design needed) -- **Level 3-4** — Required (comprehensive architecture mandatory) - -### What happens if I skip a recommended workflow? - -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 - -### How do I know when Phase 3 is complete? - -For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4. - -### Can I run workflows in parallel? - -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 → epics+stories → implementation-readiness (sequential) -- **Phase 4** — Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity - -**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/docs/_basement/explanation/four-phases.md b/docs/_basement/explanation/four-phases.md deleted file mode 100644 index 59c350f06..000000000 --- a/docs/_basement/explanation/four-phases.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "The Four Phases of BMad Method" -description: Understanding the four phases of the BMad Method ---- - - -BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality. - -## Phase Overview - -| Phase | Name | Purpose | Required? | -|-------|------|---------|-----------| -| **Phase 1** | Analysis | Exploration and discovery | Optional | -| **Phase 2** | Planning | Requirements definition | Required | -| **Phase 3** | Solutioning | Technical design | Track-dependent | -| **Phase 4** | Implementation | Building the software | Required | - -## Phase 1: Analysis (Optional) - -Exploration and discovery workflows that help validate ideas and understand markets before planning. - -**Workflows:** -- `brainstorm-project` - Solution exploration -- `research` - Market/technical/competitive research -- `product-brief` - Strategic vision capture - -**When to use:** -- Starting new projects -- Exploring opportunities -- Validating market fit - -**When to skip:** -- Clear requirements -- Well-defined features -- Continuing existing work - -## Phase 2: Planning (Required) - -Requirements definition using the scale-adaptive system to match planning depth to project complexity. - -**Workflows:** -- `prd` - Product Requirements Document (BMad Method/Enterprise) -- `tech-spec` - Technical specification (Quick Flow) -- `create-ux-design` - Optional UX specification - -**Key principle:** -Define **what** to build and **why**. Leave **how** to Phase 3. - -## Phase 3: Solutioning (Track-Dependent) - -Technical architecture and design decisions that prevent agent conflicts during implementation. - -**Workflows:** -- `architecture` - System design with ADRs -- `create-epics-and-stories` - Work breakdown (after architecture) -- `implementation-readiness` - Gate check - -**Required for:** -- BMad Method (complex projects) -- Enterprise Method - -**Skip for:** -- Quick Flow (simple changes) - -**Key principle:** -Make technical decisions explicit so all agents implement consistently. - -## Phase 4: Implementation (Required) - -Iterative sprint-based development with story-centric workflow. - -**Workflows:** -- `sprint-planning` - Initialize tracking -- `create-story` - Prepare stories -- `dev-story` - Implement with tests -- `code-review` - Quality assurance -- `retrospective` - Continuous improvement - -:::tip[Key Principle] -One story at a time — complete each story's full lifecycle before starting the next. -::: - -## Phase Flow by Track - -### Quick Flow - -``` -Phase 2 (tech-spec) → Phase 4 (implement) -``` - -Skip Phases 1 and 3 for simple changes. - -### BMad Method - -``` -Phase 1 (optional) → Phase 2 (PRD) → Phase 3 (architecture) → Phase 4 (implement) -``` - -Full methodology for complex projects. - -### Enterprise - -``` -Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (implement) -``` - -Same as BMad Method with optional extended workflows. diff --git a/docs/_basement/how-to/brownfield/add-feature-to-existing.md b/docs/_basement/how-to/brownfield/add-feature-to-existing.md deleted file mode 100644 index 27c6412e0..000000000 --- a/docs/_basement/how-to/brownfield/add-feature-to-existing.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "How to Add a Feature to an Existing Project" -description: How to add new features to an existing brownfield project ---- - -Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture. - -## When to Use This - -- Adding a new feature to an existing codebase -- Major enhancements that need proper planning -- Features that touch multiple parts of the system - -:::note[Prerequisites] -- BMad Method installed -- Existing project documentation (run `document-project` first if needed) -- Clear understanding of what you want to build -::: - -## Steps - -### 1. Run workflow-init - -``` -Run workflow-init -``` - -The workflow should recognize you're in an existing project. If not, explicitly clarify that this is brownfield development. - -### 2. Choose Your Approach - -| Feature Scope | Recommended Approach | -|---------------|---------------------| -| Small (1-5 stories) | Quick Flow with tech-spec | -| Medium (5-15 stories) | BMad Method with PRD | -| Large (15+ stories) | Full BMad Method with architecture | - -### 3. Create Planning Documents - -**For Quick Flow:** -- Load PM agent -- Run tech-spec workflow -- The agent will analyze your existing codebase and create a context-aware spec - -**For BMad Method:** -- Load PM agent -- Run PRD workflow -- Ensure the agent reads your existing documentation -- Review that integration points are clearly identified - -### 4. Consider Architecture Impact - -If your feature affects system architecture: - -- Load Architect agent -- Run architecture workflow -- Ensure alignment with existing patterns -- Document any new ADRs (Architecture Decision Records) - -### 5. Implement - -Follow the standard Phase 4 implementation workflows: - -1. `sprint-planning` - Organize your work -2. `create-story` - Prepare each story -3. `dev-story` - Implement with tests -4. `code-review` - Quality assurance - -## Tips - -- Always ensure agents read your existing documentation -- Pay attention to integration points with existing code -- Follow existing conventions unless deliberately changing them -- Document why you're adding new patterns (if any) diff --git a/docs/_basement/how-to/brownfield/document-existing-project.md b/docs/_basement/how-to/brownfield/document-existing-project.md deleted file mode 100644 index b318363b1..000000000 --- a/docs/_basement/how-to/brownfield/document-existing-project.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "How to Document an Existing Project" -description: How to document an existing brownfield codebase using BMad Method ---- - -Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state. - -## When to Use This - -- Starting work on an undocumented legacy project -- Documentation is outdated and needs refresh -- AI agents need context about existing code patterns -- Onboarding new team members - -:::note[Prerequisites] -- BMad Method installed in your project -- Access to the codebase you want to document -::: - -## Steps - -### 1. Load the Analyst Agent - -Start a fresh chat and load the Analyst agent. - -### 2. Run the document-project Workflow - -Tell the agent: - -``` -Run the document-project workflow -``` - -### 3. Let the Agent Scan Your Codebase - -The workflow will: - -- Scan your codebase structure -- Identify architecture patterns -- Document the technology stack -- Create reference documentation -- Generate a PRD-like document from existing code - -### 4. Review the Generated Documentation - -The output will be saved to `project-documentation-{date}.md` in your output folder. - -Review the documentation for: - -- Accuracy of detected patterns -- Completeness of architecture description -- Any missing business rules or intent - -## What You Get - -- **Project overview** - High-level description of what the project does -- **Technology stack** - Detected frameworks, libraries, and tools -- **Architecture patterns** - Code organization and design patterns found -- **Business rules** - Logic extracted from the codebase -- **Integration points** - External APIs and services - -## Tips - -- Run this before any major brownfield work -- Keep the documentation updated as the project evolves -- Use it as input for future PRD creation diff --git a/docs/_basement/how-to/customization/customize-agents.md b/docs/_basement/how-to/customization/customize-agents.md deleted file mode 100644 index c4eec45b9..000000000 --- a/docs/_basement/how-to/customization/customize-agents.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -title: "Agent Customization Guide" ---- - -Use `.customize.yaml` files to customize BMad agents without modifying core files. All customizations persist through updates. - -## When to Use This - -- Change agent names or personas -- Add project-specific memories or context -- Add custom menu items and workflows -- Define critical actions for consistent behavior - -## Quick Start - -**1. Locate Customization Files** - -After installation, find agent customization files in: - -``` -_bmad/_config/agents/ -├── core-bmad-master.customize.yaml -├── bmm-dev.customize.yaml -├── bmm-pm.customize.yaml -└── ... (one file per installed agent) -``` - -**2. Edit Any Agent** - -Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need. - -**3. Rebuild the Agent** - -After editing, IT IS CRITICAL to rebuild the agent to apply changes: - -```bash -npx bmad-method@alpha install # and then select option to compile all agents -npx bmad-method@alpha build - -npx bmad-method@alpha build bmm-dev -npx bmad-method@alpha build core-bmad-master -npx bmad-method@alpha build bmm-pm -``` - -## What You Can Customize - -### Agent Name - -Change how the agent introduces itself: - -```yaml -agent: - metadata: - name: 'Spongebob' # Default: "Amelia" -``` - -### Persona - -Replace the agent's personality, role, and communication style: - -```yaml -persona: - role: 'Senior Full-Stack Engineer' - identity: 'Lives in a pineapple (under the sea)' - communication_style: 'Spongebob' - principles: - - 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep' - - 'Favor composition over inheritance' -``` - -**Note:** The persona section replaces the entire default persona (not merged). - -### Memories - -Add persistent context the agent will always remember: - -```yaml -memories: - - 'Works at Krusty Krab' - - 'Favorite Celebrity: David Hasslehoff' - - 'Learned in Epic 1 that its not cool to just pretend that tests have passed' -``` - -### Custom Menu Items - -Add your own workflows to the agent's menu: - -```yaml -menu: - - trigger: my-workflow - workflow: '{project-root}/my-custom/workflows/my-workflow.yaml' - description: My custom workflow - - trigger: deploy - action: '#deploy-prompt' - description: Deploy to production -``` - -**Don't include:** `*` prefix or `help`/`exit` items - these are auto-injected. - -### Critical Actions - -Add instructions that execute before the agent starts: - -```yaml -critical_actions: - - 'Always check git status before making changes' - - 'Use conventional commit messages' -``` - -### Custom Prompts - -Define reusable prompts for `action="#id"` menu handlers: - -```yaml -prompts: - - id: deploy-prompt - content: | - Deploy the current branch to production: - 1. Run all tests - 2. Build the project - 3. Execute deployment script -``` - -## Real-World Examples - -**Example 1: Customize Developer Agent for TDD** - -```yaml -agent: - metadata: - name: 'TDD Developer' - -memories: - - 'Always write tests before implementation' - - 'Project uses Jest and React Testing Library' - -critical_actions: - - 'Review test coverage before committing' -``` - -**Example 2: Add Custom Deployment Workflow** - -```yaml -menu: - - trigger: deploy-staging - workflow: '{project-root}/_bmad/deploy-staging.yaml' - description: Deploy to staging environment - - trigger: deploy-prod - workflow: '{project-root}/_bmad/deploy-prod.yaml' - description: Deploy to production (with approval) -``` - -**Example 3: Multilingual Product Manager** - -```yaml -persona: - role: 'Bilingual Product Manager' - identity: 'Expert in US and LATAM markets' - communication_style: 'Clear, strategic, with cultural awareness' - principles: - - 'Consider localization from day one' - - 'Balance business goals with user needs' - -memories: - - 'User speaks English and Spanish' - - 'Target markets: US and Latin America' -``` - -## Tips - -- **Start Small:** Customize one section at a time and rebuild to test -- **Backup:** Copy customization files before major changes -- **Update-Safe:** Your customizations in `_config/` survive all BMad updates -- **Per-Project:** Customization files are per-project, not global -- **Version Control:** Consider committing `_config/` to share customizations with your team - -## Module vs. Global Config - -**Module-Level (Recommended):** - -- Customize agents per-project in `_bmad/_config/agents/` -- Different projects can have different agent behaviors - -**Global Config (Coming Soon):** - -- Set defaults that apply across all projects -- Override with project-specific customizations - -## Troubleshooting - -**Changes not appearing?** - -- Make sure you ran `npx bmad-method build ` after editing -- Check YAML syntax is valid (indentation matters!) -- Verify the agent name matches the file name pattern - -**Agent not loading?** - -- Check for YAML syntax errors -- Ensure required fields aren't left empty if you uncommented them -- Try reverting to the template and rebuilding - -**Need to reset?** - -- Delete the `.customize.yaml` file -- Run `npx bmad-method build ` to regenerate defaults - -## Next Steps - -- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents -- **[Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md)** - Build completely custom agents -- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference diff --git a/docs/_basement/how-to/installation/install-custom-modules.md b/docs/_basement/how-to/installation/install-custom-modules.md deleted file mode 100644 index baab51bac..000000000 --- a/docs/_basement/how-to/installation/install-custom-modules.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "How to Install Custom Modules" -description: Add custom agents, workflows, and modules to BMad ---- - -Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality. - -## When to Use This - -- Adding third-party BMad modules to your project -- Installing your own custom agents or workflows -- Sharing custom content across projects or teams - -:::note[Prerequisites] -- BMad installed in your project -- Custom content with a valid `module.yaml` file -::: - -## Steps - -### 1. Prepare Your Custom Content - -Your custom content needs a `module.yaml` file. Choose the appropriate structure: - -**For a cohesive module** (agents and workflows that work together): - -``` -module-code/ - module.yaml - agents/ - workflows/ - tools/ - templates/ -``` - -**For standalone items** (unrelated agents/workflows): - -``` -module-name/ - module.yaml # Contains unitary: true - agents/ - larry/larry.agent.md - curly/curly.agent.md - workflows/ -``` - -Add `unitary: true` in your `module.yaml` to indicate items don't depend on each other. - -### 2. Run the Installer - -**New project:** - -```bash -npx bmad-method install -``` - -When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder. - -**Existing project:** - -```bash -npx bmad-method install -``` - -1. Select `Modify BMad Installation` -2. Choose the option to add, modify, or update custom modules -3. Provide the path to your module folder - -### 3. Verify Installation - -Check that your custom content appears in the `_bmad/` directory and is accessible from your AI tool. - -## What You Get - -- Custom agents available in your AI tool -- Custom workflows accessible via `*workflow-name` -- Content integrated with BMad's update system - -## Content Types - -BMad supports several categories of custom content: - -| Type | Description | -| ----------------------- | ---------------------------------------------------- | -| **Stand Alone Modules** | Complete modules with their own agents and workflows | -| **Add On Modules** | Extensions that add to existing modules | -| **Global Modules** | Content available across all modules | -| **Custom Agents** | Individual agent definitions | -| **Custom Workflows** | Individual workflow definitions | - -For detailed information about content types, see [Custom Content Types](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/explanation/bmad-builder/custom-content-types.md). - -## Updating Custom Content - -When BMad Core or module updates are available, the quick update process: - -1. Applies updates to core modules -2. Recompiles all agents with your customizations -3. Retains your custom content from cache -4. Preserves your configurations - -You don't need to keep source module files locally—just point to the updated location during updates. - -## Tips - -- **Use unique module codes** — Don't use `bmm` or other existing module codes -- **Avoid naming conflicts** — Each module needs a distinct code -- **Document dependencies** — Note any modules your custom content requires -- **Test in isolation** — Verify custom modules work before sharing -- **Version your content** — Track updates with version numbers - -:::caution[Naming Conflicts] -Don't create custom modules with codes like `bmm` (already used by BMad Method). Each custom module needs a unique code. -::: - -## Example Modules - -Find example custom modules in the `samples/sample-custom-modules/` folder of the [BMad repository](https://github.com/bmad-code-org/BMAD-METHOD). Download either sample folder to try them out. diff --git a/docs/_basement/reference/agents.md b/docs/_basement/reference/agents.md deleted file mode 100644 index 409f161c1..000000000 --- a/docs/_basement/reference/agents.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: "Agents Reference" -description: Complete reference for BMad Method agents and their commands ---- - -Quick reference of all BMad Method agents and their available commands. - -:::tip[Universal Commands] -All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration). -::: - -## Analyst (Mary) - -Business analysis and research. - -**Commands:** -- `*workflow-status` — Get workflow status or initialize tracking -- `*brainstorm-project` — Guided brainstorming session -- `*research` — Market, domain, competitive, or technical research -- `*product-brief` — Create a product brief (input for PRD) -- `*document-project` — Document existing brownfield projects - -## PM (John) - -Product requirements and planning. - -**Commands:** -- `*workflow-status` — Get workflow status or initialize tracking -- `*create-prd` — Create Product Requirements Document -- `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture) -- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment -- `*correct-course` — Course correction during implementation - -## Architect (Winston) - -System architecture and technical design. - -**Commands:** -- `*workflow-status` — Get workflow status or initialize tracking -- `*create-architecture` — Create architecture document to guide development -- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment -- `*create-excalidraw-diagram` — System architecture or technical diagrams -- `*create-excalidraw-dataflow` — Data flow diagrams - -## SM (Bob) - -Sprint planning and story preparation. - -**Commands:** -- `*sprint-planning` — Generate sprint-status.yaml from epic files -- `*create-story` — Create story from epic (prep for development) -- `*validate-create-story` — Validate story quality -- `*epic-retrospective` — Team retrospective after epic completion -- `*correct-course` — Course correction during implementation - -## DEV (Amelia) - -Story implementation and code review. - -**Commands:** -- `*dev-story` — Execute story workflow (implementation with tests) -- `*code-review` — Thorough code review - -## Quick Flow Solo Dev (Barry) - -Fast solo development without handoffs. - -**Commands:** -- `*quick-spec` — Architect technical spec with implementation-ready stories -- `*quick-dev` — Implement tech spec end-to-end solo -- `*code-review` — Review and improve code - -## TEA (Murat) - -Test architecture and quality strategy. - -**Commands:** -- `*framework` — Initialize production-ready test framework -- `*atdd` — Generate E2E tests first (before implementation) -- `*automate` — Comprehensive test automation -- `*test-design` — Create comprehensive test scenarios -- `*trace` — Map requirements to tests, quality gate decision -- `*nfr-assess` — Validate non-functional requirements -- `*ci` — Scaffold CI/CD quality pipeline -- `*test-review` — Review test quality - -## UX Designer (Sally) - -User experience and UI design. - -**Commands:** -- `*create-ux-design` — Generate UX design and UI plan from PRD -- `*validate-design` — Validate UX specification and design artifacts -- `*create-excalidraw-wireframe` — Create website or app wireframe - -## Technical Writer (Paige) - -Technical documentation and diagrams. - -**Commands:** -- `*document-project` — Comprehensive project documentation -- `*generate-mermaid` — Generate Mermaid diagrams -- `*create-excalidraw-flowchart` — Process and logic flow visualizations -- `*create-excalidraw-diagram` — System architecture or technical diagrams -- `*create-excalidraw-dataflow` — Data flow visualizations -- `*validate-doc` — Review documentation against standards -- `*improve-readme` — Review and improve README files -- `*explain-concept` — Create clear technical explanations -- `*standards-guide` — Show BMad documentation standards diff --git a/docs/_basement/reference/configuration/core-tasks.md b/docs/_basement/reference/configuration/core-tasks.md deleted file mode 100644 index fa90e484a..000000000 --- a/docs/_basement/reference/configuration/core-tasks.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Core Tasks" ---- - -Reusable task definitions that can be invoked by any BMad module, workflow, or agent. - -## Contents - -- [Index Docs](#index-docs) — Generate directory index files -- [Adversarial Review](#adversarial-review) — Critical content review -- [Shard Document](#shard-document) — Split large documents into sections - -## Index Docs - -**Generates or updates an index.md file documenting all files in a specified directory.** - -**Use it when:** -- You need navigable documentation for a folder of markdown files -- You want to maintain an updated index as content evolves - -**How it works:** -1. Scan the target directory for files and subdirectories -2. Group content by type, purpose, or location -3. Read each file to generate brief (3-10 word) descriptions -4. Create or update index.md with organized listings - -**Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description. - -## Adversarial Review - -**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.** - -**Use it when:** -- Reviewing code diffs before merging -- Finalizing specifications or user stories -- Releasing documentation -- Any artifact needs a critical eye before completion - -**How it works:** -1. Load the content to review (diff, branch, document, etc.) -2. Perform adversarial analysis — assume problems exist -3. Find at least ten issues to fix or improve -4. Output findings as a markdown list - -:::note[Unbiased Review] -This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review. -::: - -## Shard Document - -**Splits large markdown documents into smaller files based on level 2 (`##`) sections.** - -**Use it when:** -- A markdown file has grown too large to work with effectively -- You want to break a monolithic document into manageable sections -- Individual sections need to be edited independently - -**How it works:** -1. Confirm source document path (must be markdown) -2. Determine destination folder (defaults to folder named after document) -3. Execute sharding via `npx @kayvan/markdown-tree-parser` -4. Verify output files and index.md were created -5. Handle original document — delete, move to archive, or keep - -:::caution[Original File] -After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only. -::: diff --git a/docs/_basement/reference/configuration/global-config.md b/docs/_basement/reference/configuration/global-config.md deleted file mode 100644 index 5a2f243db..000000000 --- a/docs/_basement/reference/configuration/global-config.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Global Inheritable Config" ---- - -Configuration values defined in the Core Module that all other modules inherit by default. - -## Core Config Values - -These values are set during installation and recorded to the core `module.yaml`: - -| Config Key | Default | Description | -|------------|---------|-------------| -| `user_name` | System username | User's display name | -| `communication_language` | `english` | Language for agent communication | -| `document_output_language` | `english` | Language for generated documents | -| `output_folder` | `_bmad-output` | Directory for workflow outputs | - -## Inheritance Behavior - -All installed modules automatically clone these values into their own config. Modules can: - -- **Accept defaults** — Use core values as-is (recommended) -- **Override values** — Replace with module-specific settings -- **Extend values** — Build on core values with additional paths - -:::tip[Extending Config] -Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured. -::: diff --git a/docs/_basement/explanation/faq/brownfield-faq.md b/docs/explanation/brownfield-faq.md similarity index 69% rename from docs/_basement/explanation/faq/brownfield-faq.md rename to docs/explanation/brownfield-faq.md index 79e192b28..2e607d0ed 100644 --- a/docs/_basement/explanation/faq/brownfield-faq.md +++ b/docs/explanation/brownfield-faq.md @@ -6,12 +6,13 @@ Quick answers to common questions about brownfield (existing codebase) developme ## Questions -- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield) -- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield) -- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project) -- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects) -- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs) -- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices) +- [Questions](#questions) + - [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield) + - [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield) + - [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project) + - [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects) + - [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs) + - [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices) ### What is brownfield vs greenfield? @@ -25,19 +26,12 @@ 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`. +You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system. ### What if I forget to run document-project? -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. +Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date. ### Can I use Quick Spec Flow for brownfield projects? diff --git a/docs/_basement/explanation/preventing-agent-conflicts.md b/docs/explanation/preventing-agent-conflicts.md similarity index 84% rename from docs/_basement/explanation/preventing-agent-conflicts.md rename to docs/explanation/preventing-agent-conflicts.md index e81419898..4516ef6c7 100644 --- a/docs/_basement/explanation/preventing-agent-conflicts.md +++ b/docs/explanation/preventing-agent-conflicts.md @@ -3,7 +3,6 @@ title: "Preventing Agent Conflicts" description: How architecture prevents conflicts when multiple agents implement a system --- - When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards. ## Common Conflict Types @@ -86,14 +85,14 @@ Result: Consistent implementation Common decisions that prevent conflicts: -| Topic | Example Decision | -|-------|-----------------| -| API Style | GraphQL vs REST vs gRPC | -| Database | PostgreSQL vs MongoDB | -| Auth | JWT vs Sessions | -| State Management | Redux vs Context vs Zustand | -| Styling | CSS Modules vs Tailwind vs Styled Components | -| Testing | Jest + Playwright vs Vitest + Cypress | +| Topic | Example Decision | +| ---------------- | -------------------------------------------- | +| API Style | GraphQL vs REST vs gRPC | +| Database | PostgreSQL vs MongoDB | +| Auth | JWT vs Sessions | +| State Management | Redux vs Context vs Zustand | +| Styling | CSS Modules vs Tailwind vs Styled Components | +| Testing | Jest + Playwright vs Vitest + Cypress | ## Anti-Patterns to Avoid diff --git a/docs/_basement/explanation/why-solutioning-matters.md b/docs/explanation/why-solutioning-matters.md similarity index 100% rename from docs/_basement/explanation/why-solutioning-matters.md rename to docs/explanation/why-solutioning-matters.md diff --git a/docs/_basement/how-to/brownfield/index.md b/docs/how-to/brownfield/index.md similarity index 90% rename from docs/_basement/how-to/brownfield/index.md rename to docs/how-to/brownfield/index.md index ab5f30e9f..d1fc6f3f7 100644 --- a/docs/_basement/how-to/brownfield/index.md +++ b/docs/how-to/brownfield/index.md @@ -76,9 +76,7 @@ When doing architecture, ensure the architect: Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture. -## Next Steps +## More Information -- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase -- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality - **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes -- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development +- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development diff --git a/docs/_basement/how-to/brownfield/quick-fix-in-brownfield.md b/docs/how-to/brownfield/quick-fix-in-brownfield.md similarity index 78% rename from docs/_basement/how-to/brownfield/quick-fix-in-brownfield.md rename to docs/how-to/brownfield/quick-fix-in-brownfield.md index 2e8896ab2..9dc430f11 100644 --- a/docs/_basement/how-to/brownfield/quick-fix-in-brownfield.md +++ b/docs/how-to/brownfield/quick-fix-in-brownfield.md @@ -7,11 +7,10 @@ Use the **DEV agent** directly for bug fixes, refactorings, or small targeted ch ## When to Use This -- Bug fixes -- Small refactorings -- Targeted code improvements +- Simple bug fixes +- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts +- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow - Learning about your codebase -- One-off changes that don't need planning ## Steps @@ -20,7 +19,7 @@ Use the **DEV agent** directly for bug fixes, refactorings, or small targeted ch For quick fixes, you can use: - **DEV agent** - For implementation-focused work -- **Quick Flow Solo Dev** - For slightly larger changes that still need a tech-spec +- **Quick Flow Solo Dev** - For slightly larger changes that still need a quick-spec to keep the agent aligned to planning and standards ### 2. Describe the Change @@ -61,7 +60,7 @@ Explain how the authentication system works in this codebase Show me where error handling happens in the API layer ``` -LLMs are excellent at interpreting and analyzing code—whether it was AI-generated or not. Use the agent to: +LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to: - Learn about your project - Understand how things are built diff --git a/docs/how-to/customize-bmad.md b/docs/how-to/customize-bmad.md new file mode 100644 index 000000000..c466631fd --- /dev/null +++ b/docs/how-to/customize-bmad.md @@ -0,0 +1,158 @@ +--- +title: "BMad Method Customization Guide" +--- + +The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem. + +The Customization Guidance outlined here, while targeted at understanding BMad Method customization, applies to any other module use within the BMad Method. + +## Types of Customization + +Customization includes Agent Customization, Workflow/Skill customization, the addition of new MCPs or Skills to be used by existing agents. Aside from all of this, a whole other realm of customization involves creating / adding your own relevant BMad Builder workflows, skills, agents and maybe even your own net new modules to compliment the BMad Method Module. + +Warning: The reason for customizing as this guide will prescribe will allow you to continue getting updates without worrying about losing your customization changes. And by continuing to get updates as BMad modules advance, you will be able to continue to evolve as the system improves. + +## Agent Customization + +### Agent Customization Areas + +- Change agent names, personas or manner of speech +- Add project-specific memories or context +- Add custom menu items to custom or inline prompts, skills or custom BMad workflows +- Define critical actions that occur agent startup for consistent behavior + +## How to customize an agent. + +**1. Locate Customization Files** + +After installation, find agent customization files in: + +``` +_bmad/_config/agents/ +├── core-bmad-master.customize.yaml +├── bmm-dev.customize.yaml +├── bmm-pm.customize.yaml +└── ... (one file per installed agent) +``` + +**2. Edit Any Agent** + +Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need. + +**3. Rebuild the Agent** + +After editing, IT IS CRITICAL to rebuild the agent to apply changes: + +```bash +npx bmad-method install +``` + +You can either then: + +- Select `Quick Update` - This will also ensure all packages are up to date AND compile all agents to include any updates or customizations +- Select `Rebuild Agents` - This will only rebuild and apply customizations to agents, without pulling the latest + +There will be additional tools shortly after beta launch to allow install of individual agents, workflows, skills and modules without the need for using the full bmad installer. + +### What Agent Properties Can Be Customized? + +#### Agent Name + +Change how the agent introduces itself: + +```yaml +agent: + metadata: + name: 'Spongebob' # Default: "Amelia" +``` + +#### Persona + +Replace the agent's personality, role, and communication style: + +```yaml +persona: + role: 'Senior Full-Stack Engineer' + identity: 'Lives in a pineapple (under the sea)' + communication_style: 'Spongebob annoying' + principles: + - 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep' + - 'Favor composition over inheritance' +``` + +**Note:** The persona section replaces the entire default persona (not merged). + +#### Memories + +Add persistent context the agent will always remember: + +```yaml +memories: + - 'Works at Krusty Krab' + - 'Favorite Celebrity: David Hasslehoff' + - 'Learned in Epic 1 that its not cool to just pretend that tests have passed' +``` + +### Custom Menu Items + +Any custom items you add here will be included in the agents display menu. + +```yaml +menu: + - trigger: my-workflow + workflow: '{project-root}/my-custom/workflows/my-workflow.yaml' + description: My custom workflow + - trigger: deploy + action: '#deploy-prompt' + description: Deploy to production +``` + +### Critical Actions + +Add instructions that execute before the agent starts: + +```yaml +critical_actions: + - 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention' +``` + +### Custom Prompts + +Define reusable prompts for `action="#id"` menu handlers: + +```yaml +prompts: + - id: deploy-prompt + content: | + Deploy the current branch to production: + 1. Run all tests + 2. Build the project + 3. Execute deployment script +``` + +## Troubleshooting + +**Changes not appearing?** + +- Make sure you ran `npx bmad-method build ` after editing +- Check YAML syntax is valid (indentation matters!) +- Verify the agent name matches the file name pattern + +**Agent not loading?** + +- Check for YAML syntax errors +- Ensure required fields aren't left empty if you uncommented them +- Try reverting to the template and rebuilding + +**Need to reset?** + +- Remove content from the `.customize.yaml` file (or delete the file) +- Run `npx bmad-method build ` to regenerate defaults + +## Workflow Customization + +Information about customizing existing BMad MEthod workflows and skills are coming soon. + +## Module Customization + +Information on how to build expansion modules that augment BMad, or make other existing module customizations are coming soon. \ No newline at end of file diff --git a/docs/how-to/get-answers-about-bmad.md b/docs/how-to/get-answers-about-bmad.md index 6581e8173..a8dbad09b 100644 --- a/docs/how-to/get-answers-about-bmad.md +++ b/docs/how-to/get-answers-about-bmad.md @@ -3,11 +3,11 @@ title: "How to Get Answers About BMad" description: Use an LLM to quickly answer your own BMad questions --- -Use your AI tool to get answers about BMad by pointing it at the source files. +If you have successfully installed BMad and the BMad Method (+ other modules as needed) - the first step in getting answers is `/bmad-help`. This will answer upwards of 80% of all questions and is available to you in the IDE as you are working. ## When to Use This -- You have a question about how BMad works +- You have a question about how BMad works or what to do next with BMad - You want to understand a specific agent or workflow - You need quick answers without waiting for Discord @@ -19,11 +19,11 @@ An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad insta ### 1. Choose Your Source -| Source | Best For | Examples | -|--------|----------|----------| -| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" | -| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" | -| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" | +| Source | Best For | Examples | +| -------------------- | ----------------------------------------- | ---------------------------- | +| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" | +| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" | +| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" | The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead. @@ -65,12 +65,12 @@ Direct answers about BMad—how agents work, what workflows do, why things are s Tried the LLM approach and still need help? You now have a much better question to ask. -| Channel | Use For | -|---------|---------| -| `#bmad-method-help` | Quick questions (real-time chat) | -| `help-requests` forum | Detailed questions (searchable, persistent) | -| `#suggestions-feedback` | Ideas and feature requests | -| `#report-bugs-and-issues` | Bug reports | +| Channel | Use For | +| ------------------------- | ------------------------------------------- | +| `#bmad-method-help` | Quick questions (real-time chat) | +| `help-requests` forum | Detailed questions (searchable, persistent) | +| `#suggestions-feedback` | Ideas and feature requests | +| `#report-bugs-and-issues` | Bug reports | **Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) diff --git a/docs/_basement/how-to/customization/shard-large-documents.md b/docs/how-to/shard-large-documents.md similarity index 100% rename from docs/_basement/how-to/customization/shard-large-documents.md rename to docs/how-to/shard-large-documents.md diff --git a/docs/_basement/how-to/installation/upgrade-to-v6.md b/docs/how-to/upgrade-to-v6.md similarity index 100% rename from docs/_basement/how-to/installation/upgrade-to-v6.md rename to docs/how-to/upgrade-to-v6.md diff --git a/docs/reference/workflow-map-diagram.html b/docs/reference/workflow-map-diagram.html new file mode 100644 index 000000000..9335c9532 --- /dev/null +++ b/docs/reference/workflow-map-diagram.html @@ -0,0 +1,1028 @@ + + + + + + BMad Method Workflow Map + + + + +
+ +
+
+ + + + + + Workflow Map V6 +
+

BMad Method

+

Context engineering and planning for AI-powered software development

+
+ + +
+ +
+
+
+
1
+ Optional +
+

Analysis

+
+
+ Explore the problem space and validate ideas before committing to planning. +
+
+
+
+ brainstorm + Optional +
+

Brainstorm project ideas with guided facilitation

+
+
+
M
+
+
Mary
+
Business Analyst
+
+
+
brainstorming-report.md
+
+
+ +
+
+ research + Optional +
+

Validate market, technical, or domain assumptions

+
+
+
M
+
+
Mary
+
Business Analyst
+
+
+
Research findings
+
+
+ +
+
+ create-product-brief +
+

Capture strategic vision and product scope

+
+
+
M
+
+
Mary
+
Business Analyst
+
+
+
product-brief.md
+
+
+
+
+ + +
+
+
+
2
+
+

Planning

+
+
+ Define what to build, requirements, and user experience. +
+
+
+
+ create-prd +
+

Define functional and non-functional requirements

+
+
+
J
+
+
John
+
Product Manager
+
+
+
PRD.md
+
+
+ +
Has UI?
+ +
+
+ create-ux-design + If Yes +
+

Design user experience when UX matters

+
+
+
S
+
+
Sally
+
UX Designer
+
+
+
ux-spec.md
+
+
+
+
+ + +
+
+
+
3
+
+

Solutioning

+
+
+ Decide how to build it and break work into stories. +
+
+
+
+ create-architecture +
+

Make technical decisions explicit with ADRs

+
+
+
W
+
+
Winston
+
Architect
+
+
+
architecture.md
+
+
+ +
+
+ create-epics-and-stories +
+

Break requirements into implementable work

+
+
+
J
+
+
John
+
Product Manager
+
+
+
Epic files with stories
+
+
+ +
+
+ check-implementation-readiness +
+

Gate check before implementation begins

+
+
+
J
+
+
John
+
Product Manager
+
+
+
PASS/CONCERNS/FAIL
+
+
+
+
+ + +
+
+
+
4
+
+

Implementation

+
+
+ Build it, one story at a time. +
+
+
+
+ sprint-planning +
+

Initialize tracking (once per project)

+
+
+
B
+
+
Bob
+
Scrum Master
+
+
+
sprint-status.yaml
+
+
+ +
+
+ create-story +
+

Prepare next story for implementation

+
+
+
B
+
+
Bob
+
Scrum Master
+
+
+
story-[slug].md
+
+
+ +
+
+ dev-story +
+

Implement the story with code and tests

+
+
+
A
+
+
Amelia
+
Developer
+
+
+
Working code + tests
+
+
+ +
+
+ code-review +
+

Validate implementation quality

+
+
+
A
+
+
Amelia
+
Developer
+
+
+
Approved / Changes
+
+
+ +
+
+ correct-course + Ad-Hoc +
+

Handle significant mid-sprint changes

+
+
+
J
+
+
John
+
Product Manager
+
+
+
Updated plan
+
+
+ +
+
+ retrospective + Per Epic +
+

Review lessons learned after epic completion

+
+
+
B
+
+
Bob
+
Scrum Master
+
+
+
Lessons learned
+
+
+
+
+
+ + +
+
+
⚡
+
+

Quick Flow

+

Parallel track for small, well-understood changes — skip phases 1-3

+
+
+
+
+
+
B
+
+
Barry
+
Quick Flow Dev
+
+
+
+ quick-spec +
Define an ad-hoc change
+
→ tech-spec.md
+
+
+
+
+
B
+
+
Barry
+
Quick Flow Dev
+
+
+
+ quick-dev +
Implement from spec or direct instructions
+
→ Working code + tests
+
+
+
+
+ + +
+
+
📚
+

Context Management

+
+

+ Each document becomes context for the next phase. The PRD tells the architect what constraints matter. + The architecture tells the dev agent which patterns to follow. Story files give focused, complete context + for implementation. Without this structure, agents make inconsistent decisions. +

+
+ Brownfield Projects: Use document-project to create project-context.md + before Phase 4. Run it when structure, architecture, or rules change. +
+ Mary + Paige + (Business Analyst / Technical Writer) +
+
+

Additional context loaded per workflow:

+
+
create-story → epics, PRD, architecture, UX
+
dev-story → story file
+
code-review → architecture, story file
+
quick-spec → planning docs (if exist)
+
quick-dev → tech-spec
+
+
+ + +
+
+
+ Phase 1: Analysis +
+
+
+ Phase 2: Planning +
+
+
+ Phase 3: Solutioning +
+
+
+ Phase 4: Implementation +
+
+
+ Quick Flow (Parallel) +
+
+ + +
+
+
M
+ Mary +
+
+
J
+ John +
+
+
S
+ Sally +
+
+
W
+ Winston +
+
+
B
+ Bob +
+
+
A
+ Amelia +
+
+
B
+ Barry +
+
+
P
+ Paige +
+
+
+ + diff --git a/docs/reference/workflow-map.md b/docs/reference/workflow-map.md index d32d8a32d..15fc19f05 100644 --- a/docs/reference/workflow-map.md +++ b/docs/reference/workflow-map.md @@ -3,7 +3,13 @@ title: "Workflow Map" description: Visual reference for BMad Method workflow phases and outputs --- -BMAD is a context management system. AI agents work best with clear, structured context. The BMM workflow builds that context progressively - each phase produces documents that inform the next, so agents always know what to build and why. +The BMad Method (BMM) is a module in the BMad Ecosystem, targeted at following the best practices of context engineering and planning. AI agents work best with clear, structured context. The BMM system builds that context progressively across 4 distinct phases - each phase, and multiple workflows optionally within each phase, produce documents that inform the next, so agents always know what to build and why. + +The rationale and concepts come from agile methodologies that have been used across the industry with great success as a mental framework. + +If at anytime you are unsure what to do, the `/bmad-help` command will help you stay on track or know what to do next. You can always refer to this for reference also - but /bmad-help is fully interactive and much quicker if you have already installed the BMadMethod. Additionally, if you are using different modules that have extended the BMad Method or added other complimentary non extension modules - the /bmad-help evolves to know all that is available to give you the best in the moment advice. + +Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu. ![BMad Method Workflow Map](/img/workflow-map.png) @@ -11,51 +17,52 @@ BMAD is a context management system. AI agents work best with clear, structured Explore the problem space and validate ideas before committing to planning. -| Workflow | Purpose | Produces | -|----------|---------|----------| -| `research` | Validate market, technical, or domain assumptions | Research findings | -| `create-product-brief` | Capture strategic vision | `product-brief.md` | +| Workflow | Purpose | Produces | +| ---------------------- | -------------------------------------------------------------------------- | ------------------------- | +| `brainstorm` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` | +| `research` | Validate market, technical, or domain assumptions | Research findings | +| `create-product-brief` | Capture strategic vision | `product-brief.md` | ## Phase 2: Planning Define what to build and for whom. -| Workflow | Purpose | Produces | -|----------|---------|----------| -| `prd` | Define requirements (FRs/NFRs) | `PRD.md` | +| Workflow | Purpose | Produces | +| ------------------ | ---------------------------------------- | ------------ | +| `create-prd` | Define requirements (FRs/NFRs) | `PRD.md` | | `create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` | ## Phase 3: Solutioning Decide how to build it and break work into stories. -| Workflow | Purpose | Produces | -|----------|---------|----------| -| `create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs | -| `create-epics-and-stories` | Break requirements into implementable work | Epic files with stories | -| `check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision | +| Workflow | Purpose | Produces | +| -------------------------------- | ------------------------------------------ | --------------------------- | +| `create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs | +| `create-epics-and-stories` | Break requirements into implementable work | Epic files with stories | +| `check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision | ## Phase 4: Implementation Build it, one story at a time. -| Workflow | Purpose | Produces | -|----------|---------|----------| -| `sprint-planning` | Initialize tracking (once per project) | `sprint-status.yaml` | -| `create-story` | Prepare next story for implementation | `story-[slug].md` | -| `dev-story` | Implement the story | Working code + tests | -| `code-review` | Validate implementation quality | Approved or changes requested | -| `correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing | -| `retrospective` | Review after epic completion | Lessons learned | +| Workflow | Purpose | Produces | +| ----------------- | -------------------------------------- | ----------------------------- | +| `sprint-planning` | Initialize tracking (once per project) | `sprint-status.yaml` | +| `create-story` | Prepare next story for implementation | `story-[slug].md` | +| `dev-story` | Implement the story | Working code + tests | +| `code-review` | Validate implementation quality | Approved or changes requested | +| `correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing | +| `retrospective` | Review after epic completion | Lessons learned | ## Quick Flow (Parallel Track) Skip phases 1-3 for small, well-understood work. -| Workflow | Purpose | Produces | -|----------|---------|----------| -| `quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) | -| `quick-dev` | Implement from spec or direct instructions | Working code + tests | +| Workflow | Purpose | Produces | +| ------------ | ------------------------------------------ | --------------------------------------------- | +| `quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) | +| `quick-dev` | Implement from spec or direct instructions | Working code + tests | ## Context Management @@ -65,10 +72,10 @@ For brownfield projects, `document-project` creates or updates `project-context. All implementation workflows load `project-context.md` if it exists. Additional context per workflow: -| Workflow | Also Loads | -|----------|------------| +| Workflow | Also Loads | +| -------------- | ---------------------------- | | `create-story` | epics, PRD, architecture, UX | -| `dev-story` | story file | -| `code-review` | architecture, story file | -| `quick-spec` | planning docs (if exist) | -| `quick-dev` | tech-spec | +| `dev-story` | story file | +| `code-review` | architecture, story file | +| `quick-spec` | planning docs (if exist) | +| `quick-dev` | tech-spec | diff --git a/package-lock.json b/package-lock.json index a4cccb836..e4cbe9b86 100644 --- a/package-lock.json +++ b/package-lock.json @@ -244,7 +244,6 @@ "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -3973,7 +3972,6 @@ "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -4282,7 +4280,6 @@ "integrity": "sha512-6mF/YrvwwRxLTu+aMEa5pwzKUNl5ZetWbTyZCs9Um0F12HUmxUiF5UHiZPy4rifzU3gtpM3xP2DfdmkNX9eZRg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@astrojs/compiler": "^2.13.0", "@astrojs/internal-helpers": "0.7.5", @@ -5350,7 +5347,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -6666,7 +6662,6 @@ "integrity": "sha512-LEyamqS7W5HB3ujJyvi0HQK/dtVINZvd5mAAp9eT5S/ujByGjiZLCzPcHVzuXbpJDJF/cxwHlfceVUDZ2lnSTw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", @@ -10228,7 +10223,6 @@ "integrity": "sha512-p3JTemJJbkiMjXEMiFwgm0v6ym5g8K+b2oDny+6xdl300tUKySxvilJQLSea48C6OaYNmO30kH9KxpiAg5bWJw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "globby": "15.0.0", "js-yaml": "4.1.1", @@ -12292,7 +12286,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -12358,7 +12351,6 @@ "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", "dev": true, "license": "MIT", - "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -13187,7 +13179,6 @@ "integrity": "sha512-3nk8Y3a9Ea8szgKhinMlGMhGMw89mqule3KWczxhIzqudyHdCIOHw8WJlj/r329fACjKLEh13ZSk7oE22kyeIw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@types/estree": "1.0.8" }, @@ -14727,7 +14718,6 @@ "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.4", @@ -15001,7 +14991,6 @@ "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", "license": "ISC", - "peer": true, "bin": { "yaml": "bin.mjs" }, @@ -15181,7 +15170,6 @@ "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "dev": true, "license": "MIT", - "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/src/bmm/_module-installer/platform-specifics/claude-code.js b/src/bmm/_module-installer/platform-specifics/claude-code.js deleted file mode 100644 index ab96fad0b..000000000 --- a/src/bmm/_module-installer/platform-specifics/claude-code.js +++ /dev/null @@ -1,35 +0,0 @@ -const chalk = require('chalk'); - -/** - * BMM Platform-specific installer for Claude Code - * - * @param {Object} options - Installation options - * @param {string} options.projectRoot - The root directory of the target project - * @param {Object} options.config - Module configuration from module.yaml - * @param {Object} options.logger - Logger instance for output - * @param {Object} options.platformInfo - Platform metadata from global config - * @returns {Promise} - Success status - */ -async function install(options) { - const { logger, platformInfo } = options; - // projectRoot and config available for future use - - try { - const platformName = platformInfo ? platformInfo.name : 'Claude Code'; - logger.log(chalk.cyan(` BMM-${platformName} Specifics installed`)); - - // Add Claude Code specific BMM configurations here - // For example: - // - Custom command configurations - // - Agent party configurations - // - Workflow integrations - // - Template mappings - - return true; - } catch (error) { - logger.error(chalk.red(`Error installing BMM Claude Code specifics: ${error.message}`)); - return false; - } -} - -module.exports = { install }; diff --git a/src/bmm/_module-installer/platform-specifics/windsurf.js b/src/bmm/_module-installer/platform-specifics/windsurf.js deleted file mode 100644 index d1c6f0123..000000000 --- a/src/bmm/_module-installer/platform-specifics/windsurf.js +++ /dev/null @@ -1,32 +0,0 @@ -const chalk = require('chalk'); - -/** - * BMM Platform-specific installer for Windsurf - * - * @param {Object} options - Installation options - * @param {string} options.projectRoot - The root directory of the target project - * @param {Object} options.config - Module configuration from module.yaml - * @param {Object} options.logger - Logger instance for output - * @returns {Promise} - Success status - */ -async function install(options) { - const { logger } = options; - // projectRoot and config available for future use - - try { - logger.log(chalk.cyan(' BMM-Windsurf Specifics installed')); - - // Add Windsurf specific BMM configurations here - // For example: - // - Custom cascades - // - Workflow adaptations - // - Template configurations - - return true; - } catch (error) { - logger.error(chalk.red(`Error installing BMM Windsurf specifics: ${error.message}`)); - return false; - } -} - -module.exports = { install }; diff --git a/src/bmm/agents/pm.agent.yaml b/src/bmm/agents/pm.agent.yaml index 14d04612b..1fa22545e 100644 --- a/src/bmm/agents/pm.agent.yaml +++ b/src/bmm/agents/pm.agent.yaml @@ -22,15 +22,15 @@ agent: menu: - trigger: CP or fuzzy match on create-prd - exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md" description: "[CP] Create PRD: Expert led facilitation to produce your Product Requirements Document" - trigger: VP or fuzzy match on validate-prd - exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md" description: "[VP] Validate PRD: Validate a Product Requirements Document is comprehensive, lean, well organized and cohesive" - trigger: EP or fuzzy match on edit-prd - exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md" description: "[EP] Edit PRD: Update an existing Product Requirements Document" - trigger: CE or fuzzy match on epics-stories diff --git a/src/bmm/module-help.csv b/src/bmm/module-help.csv index 811da6ad5..323cd77da 100644 --- a/src/bmm/module-help.csv +++ b/src/bmm/module-help.csv @@ -9,8 +9,8 @@ bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/wor bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode research_type=technical,"Technical feasibility architecture options and implementation approaches","planning_artifacts|project-knowledge","research documents" bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_create-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief", bmm,1-analysis,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_validate-brief,false,analyst,Validate Mode,"Validates product brief completeness",planning_artifacts,"brief validation report", -bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd, -bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report", +bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md,bmad_bmm_prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd, +bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md,bmad_bmm_prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report", bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_create-ux-design,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design", bmm,2-planning,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_create-ux-design,false,ux-designer,Validate Mode,"Validates UX design deliverables",planning_artifacts,"ux validation report", ,anytime,Create Dataflow,CDF,50,_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml,bmad_bmm_create-excalidraw-dataflow,false,ux-designer,Create Mode,"Create data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentation",planning_artifacts,"dataflow diagram", diff --git a/src/bmm/sub-modules/claude-code/config.yaml b/src/bmm/sub-modules/claude-code/config.yaml deleted file mode 100644 index 26d26bf93..000000000 --- a/src/bmm/sub-modules/claude-code/config.yaml +++ /dev/null @@ -1,4 +0,0 @@ -name: bmmcc -short-title: BMM Claude Code Sub Module -author: Brian (BMad) Madison -submodule: true diff --git a/src/bmm/sub-modules/claude-code/injections.yaml b/src/bmm/sub-modules/claude-code/injections.yaml deleted file mode 100644 index e8fabbe29..000000000 --- a/src/bmm/sub-modules/claude-code/injections.yaml +++ /dev/null @@ -1,242 +0,0 @@ -# Claude Code Content Injection Configuration -# This file defines content to be injected at specific points in BMAD files -# when Claude Code is selected as the IDE during installation -# -# The installer will: -# 1. Ask users if they want to install subagents (all/selective/none) -# 2. Ask where to install (project-level .claude/agents/_bmad/ or user-level ~/.claude/agents/_bmad/) -# 3. Only inject content related to selected subagents -# 4. Templates stay in _bmad/ directory and are referenced from there -# 5. Injections are placed at specific sections where each subagent is most valuable - -injections: - # ===== PRD WORKFLOW INJECTIONS ===== - - # PRD Subagent Instructions - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "prd-subagent-instructions" - requires: "all-prd-subagents" - content: | - - **Subagent Usage**: Throughout this workflow, leverage specialized subagents at critical decision points: - - Use `bmm-requirements-analyst` when defining functional requirements - - Use `bmm-user-journey-mapper` for comprehensive journey mapping - - Use `bmm-epic-optimizer` when structuring epic boundaries - - Use `bmm-technical-decisions-curator` to capture all technical mentions - - # PRD Requirements Analysis - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "prd-requirements-analysis" - requires: "requirements-analyst" - content: | - - **Subagent Hint**: Use `bmm-requirements-analyst` to validate requirements are testable and complete. - - # PRD User Journey Mapping - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "prd-user-journey" - requires: "user-journey-mapper" - content: | - - **Subagent Hint**: Use `bmm-user-journey-mapper` to map all user types and their value paths. - - # PRD Epic Optimization - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "prd-epic-optimization" - requires: "epic-optimizer" - content: | - - **Subagent Hint**: Use `bmm-epic-optimizer` to validate epic boundaries deliver coherent value. - - # PRD Document Review - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "prd-checklist-review" - requires: "document-reviewer" - content: | - - **Subagent Hint**: Use `bmm-document-reviewer` to validate PRD completeness before finalizing. - - # Technical Decisions Curator - - file: "_bmad/bmm/workflows/prd/instructions.md" - point: "technical-decisions-curator" - requires: "technical-decisions-curator" - content: | - - **Automatic Capture**: The `bmm-technical-decisions-curator` should be invoked whenever: - - Technology, framework, or tool is mentioned - - Architecture patterns are discussed - - Infrastructure or deployment topics arise - - Integration requirements are specified - - # ===== MARKET RESEARCH TEMPLATE INJECTIONS ===== - - # Market TAM/SAM/SOM Calculations - - file: "_bmad/bmm/templates/market.md" - point: "market-tam-calculations" - requires: "data-analyst" - content: | - - - MANDATORY: Use the 'bmm-data-analyst' subagent to perform all TAM, SAM, and SOM calculations. - The subagent will apply proper methodologies, validate assumptions, and provide defensible market sizing. - - - # Market Trends Analysis - - file: "_bmad/bmm/templates/market.md" - point: "market-trends-analysis" - requires: "trend-spotter" - content: | - - - MANDATORY: Use the 'bmm-trend-spotter' subagent to identify and analyze emerging market trends. - The subagent will detect disruption signals, technology shifts, and future opportunities. - - - # Market Customer Personas - - file: "_bmad/bmm/templates/market.md" - point: "market-customer-segments" - requires: "user-researcher" - content: | - - - MANDATORY: Use the 'bmm-user-researcher' subagent to develop detailed customer segment profiles and personas. - The subagent will analyze behavior patterns, needs, and journey maps for each segment. - - - # Market Research Review - - file: "_bmad/bmm/templates/market.md" - point: "market-executive-summary" - requires: "document-reviewer" - content: | - - - MANDATORY: Before finalizing the executive summary, use the 'bmm-document-reviewer' subagent to validate all market research findings and ensure data accuracy. - - - # ===== COMPETITOR ANALYSIS TEMPLATE INJECTIONS ===== - - # Competitor Intelligence Gathering - - file: "_bmad/bmm/templates/competitor.md" - point: "competitor-intelligence" - requires: "market-researcher" - content: | - - - MANDATORY: Use the 'bmm-market-researcher' subagent to gather comprehensive competitive intelligence for each competitor profile. - The subagent will analyze positioning, strategy, and market dynamics. - - - # Competitor Technical Analysis - - file: "_bmad/bmm/templates/competitor.md" - point: "competitor-tech-stack" - requires: "technical-evaluator" - content: | - - - MANDATORY: Use the 'bmm-technical-evaluator' subagent to analyze and compare competitor technology stacks. - The subagent will identify technical differentiators and architectural advantages. - - - # Competitor Metrics Analysis - - file: "_bmad/bmm/templates/competitor.md" - point: "competitor-metrics" - requires: "data-analyst" - content: | - - - MANDATORY: Use the 'bmm-data-analyst' subagent to analyze competitor performance metrics and market share data. - - - # Competitor Analysis Review - - file: "_bmad/bmm/templates/competitor.md" - point: "competitor-executive-summary" - requires: "document-reviewer" - content: | - - - MANDATORY: Before finalizing, use the 'bmm-document-reviewer' subagent to validate competitive analysis completeness and strategic recommendations. - - - # ===== PROJECT BRIEF TEMPLATE INJECTIONS ===== - - # Brief Problem Validation - - file: "_bmad/bmm/templates/brief.md" - point: "brief-problem-validation" - requires: "market-researcher" - content: | - - - IF market research has not been provided as input, MANDATORY: Use the 'bmm-market-researcher' subagent to validate the problem statement and assess market opportunity. - - - # Brief Target User Analysis - - file: "_bmad/bmm/templates/brief.md" - point: "brief-user-analysis" - requires: "user-researcher" - content: | - - - IF target user analysis has not been provided, MANDATORY: Use the 'bmm-user-researcher' subagent to develop detailed user profiles and validate user needs. - - - # Brief Success Metrics - - file: "_bmad/bmm/templates/brief.md" - point: "brief-success-metrics" - requires: "data-analyst" - content: | - - - MANDATORY: Use the 'bmm-data-analyst' subagent to define and validate KPIs, success metrics, and measurement approaches. - - - # Brief Technical Feasibility - - file: "_bmad/bmm/templates/brief.md" - point: "brief-technical-feasibility" - requires: "technical-evaluator" - content: | - - - IF technical assumptions need validation, use the 'bmm-technical-evaluator' subagent to assess feasibility and identify technical risks. - - - # Brief Requirements Extraction - - file: "_bmad/bmm/templates/brief.md" - point: "brief-requirements" - requires: "requirements-analyst" - content: | - - - MANDATORY: Use the 'bmm-requirements-analyst' subagent to extract initial high-level requirements from the brief content. - - - # Brief Document Review - - file: "_bmad/bmm/templates/brief.md" - point: "brief-final-review" - requires: "document-reviewer" - content: | - - - MANDATORY: Before finalizing the brief, use the 'bmm-document-reviewer' subagent to ensure completeness and internal consistency. - - -# Subagents to copy -subagents: - source: "sub-agents" - target: ".claude/agents" - files: - - "market-researcher.md" - - "requirements-analyst.md" - - "technical-evaluator.md" - - "epic-optimizer.md" - - "document-reviewer.md" - - "codebase-analyzer.md" - - "dependency-mapper.md" - - "pattern-detector.md" - - "tech-debt-auditor.md" - - "api-documenter.md" - - "test-coverage-analyzer.md" - - "user-researcher.md" - - "user-journey-mapper.md" - - "technical-decisions-curator.md" - - "data-analyst.md" - - "trend-spotter.md" diff --git a/src/bmm/sub-modules/claude-code/readme.md b/src/bmm/sub-modules/claude-code/readme.md deleted file mode 100644 index c0ef2694c..000000000 --- a/src/bmm/sub-modules/claude-code/readme.md +++ /dev/null @@ -1,87 +0,0 @@ -# BMM Claude Code Sub-Module - -## Overview - -This sub-module provides Claude Code-specific enhancements for the BMM module, including specialized subagents and content injection for enhanced AI-assisted development workflows. - -## How the Installer Works - -When Claude Code is selected during BMAD installation: - -1. **Module Detection**: The installer checks for `sub-modules/claude-code/` in each selected module -2. **Configuration Loading**: Reads `injections.yaml` to understand what to inject and which subagents are available -3. **User Interaction**: Prompts users to: - - Choose subagent installation (all/selective/none) - - Select installation location (project `.claude/agents/` or user `~/.claude/agents/`) -4. **Selective Installation**: Based on user choices: - - Copies only selected subagents to Claude's agents directory - - Injects only relevant content at defined injection points - - Skips injection if no subagents selected - -## Subagent Directory - -### Product Management Subagents - -| Subagent | Purpose | Used By | Recommended For | -| ------------------------ | ---------------------------------------- | ---------- | --------------------------------------------- | -| **market-researcher** | Competitive analysis and market insights | PM Agent | PRD creation (`*create-prd`), market analysis | -| **requirements-analyst** | Extract and validate requirements | PM Agent | Requirements sections, user story creation | -| **technical-evaluator** | Technology stack evaluation | PM Agent | Technical assumptions in PRDs | -| **epic-optimizer** | Story breakdown and sizing | PM Agent | Epic details, story sequencing | -| **document-reviewer** | Quality checks and validation | PM/Analyst | Final document review before delivery | - -### Architecture and Documentation Subagents - -| Subagent | Purpose | Used By | Recommended For | -| -------------------------- | ----------------------------------------- | --------- | ---------------------------------------------- | -| **codebase-analyzer** | Project structure and tech stack analysis | Architect | `*generate-context-docs` (doc-proj task) | -| **dependency-mapper** | Module and package dependency analysis | Architect | Brownfield documentation, refactoring planning | -| **pattern-detector** | Identify patterns and conventions | Architect | Understanding existing codebases | -| **tech-debt-auditor** | Assess technical debt and risks | Architect | Brownfield architecture, migration planning | -| **api-documenter** | Document APIs and integrations | Architect | API documentation, service boundaries | -| **test-coverage-analyzer** | Analyze test suites and coverage | Architect | Test strategy, quality assessment | - -## Adding New Subagents - -1. **Create the subagent file** in `sub-agents/`: - - ```markdown - --- - name: your-subagent-name - description: Brief description. use PROACTIVELY when [specific scenario] - tools: Read, Write, Grep # Specify required tools - check claude-code docs to see what tools are available, or just leave blank to allow all - --- - - [System prompt describing the subagent's role and expertise] - ``` - -2. **Add to injections.yaml**: - - Add filename to `subagents.files` list - - Update relevant agent injection content if needed - -3. **Create injection point** (if new agent): - ```xml - - ``` - -## Injection Points - -All injection points in this module are documented in: `{project-root}{output_folder}/injection-points.md` - ensure this is kept up to date. - -Injection points allow IDE-specific content to be added during installation without modifying source files. They use HTML comment syntax and are replaced during the installation process based on user selections. - -## Configuration Files - -- **injections.yaml**: Defines what content to inject and where -- **config.yaml**: Additional Claude Code configuration (if needed) -- **sub-agents/**: Directory containing all subagent definitions - -## Testing - -To test subagent installation: - -1. Run the BMAD installer -2. Select BMM module and Claude Code -3. Verify prompts appear for subagent selection -4. Check `.claude/agents/` for installed subagents -5. Verify injection points are replaced in `.claude/commands/_bmad/` and the various tasks and templates under `_bmad/...` diff --git a/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv b/src/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv rename to src/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv diff --git a/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md b/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md rename to src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv b/src/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv rename to src/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md similarity index 98% rename from src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md index 644032974..7af674fd7 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md @@ -4,7 +4,7 @@ description: 'Discovery & Understanding - Understand what user wants to edit and # File references (ONLY variables used in this step) altStepFile: './step-e-01b-legacy-conversion.md' -prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md' advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md similarity index 98% rename from src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md index d9073d129..5be8f63a5 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md @@ -5,7 +5,7 @@ description: 'Legacy PRD Conversion Assessment - Analyze legacy PRD and propose # File references (ONLY variables used in this step) nextStepFile: './step-e-02-review.md' prdFile: '{prd_file_path}' -prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md' --- # Step E-1B: Legacy PRD Conversion Assessment diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md similarity index 98% rename from src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md index 4be9fbbaa..e89c15008 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md @@ -6,7 +6,7 @@ description: 'Deep Review & Analysis - Thoroughly review existing PRD and prepar nextStepFile: './step-e-03-edit.md' prdFile: '{prd_file_path}' validationReport: '{validation_report_path}' # If provided -prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md' advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' --- diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md similarity index 98% rename from src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md index c94880dd7..c60a1d5e7 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md @@ -5,7 +5,7 @@ description: 'Edit & Update - Apply changes to PRD following approved change pla # File references (ONLY variables used in this step) nextStepFile: './step-e-04-complete.md' prdFile: '{prd_file_path}' -prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +prdPurpose: '{project-root}/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md' --- # Step E-3: Edit & Update diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md b/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md rename to src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md b/src/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md similarity index 100% rename from src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md rename to src/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md diff --git a/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md b/src/bmm/workflows/2-plan-workflows/create-prd/validation-report-prd-workflow.md similarity index 76% rename from src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md rename to src/bmm/workflows/2-plan-workflows/create-prd/validation-report-prd-workflow.md index 73dce5aef..14407bfa2 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/validation-report-prd-workflow.md @@ -8,7 +8,7 @@ validationStatus: COMPLETE - PRODUCTION READY # PRD Workflow Validation Report -**Workflow Being Validated:** /Users/brianmadison/dev/BMAD-METHOD/src/bmm/workflows/2-plan-workflows/prd +**Workflow Being Validated:** /Users/brianmadison/dev/BMAD-METHOD/src/bmm/workflows/2-plan-workflows/create-prd **Validation Date:** 2026-01-08 **Validator:** BMAD Workflow Validation System @@ -41,55 +41,55 @@ prd/ ### File Size Analysis #### Steps-C (Create Steps) - 12 files -| File | Lines | Status | -|------|-------|--------| -| step-01-init.md | 191 | ⚠️ Approaching limit | -| step-01b-continue.md | 153 | ✅ Good | -| step-02-discovery.md | 197 | ⚠️ Approaching limit | -| step-03-success.md | 226 | ⚠️ Approaching limit | -| step-04-journeys.md | 213 | ⚠️ Approaching limit | -| step-05-domain.md | 193 | ⚠️ Approaching limit | -| step-06-innovation.md | 226 | ⚠️ Approaching limit | -| step-07-project-type.md | 225 | ⚠️ Approaching limit | -| step-08-scoping.md | 228 | ⚠️ Approaching limit | -| step-09-functional.md | 231 | ⚠️ Approaching limit | -| step-10-nonfunctional.md | 242 | ⚠️ Approaching limit | -| step-11-polish.md | 217 | ⚠️ Approaching limit | -| step-12-complete.md | 185 | ✅ Good | +| File | Lines | Status | +| ------------------------ | ----- | ------------------- | +| step-01-init.md | 191 | ⚠️ Approaching limit | +| step-01b-continue.md | 153 | ✅ Good | +| step-02-discovery.md | 197 | ⚠️ Approaching limit | +| step-03-success.md | 226 | ⚠️ Approaching limit | +| step-04-journeys.md | 213 | ⚠️ Approaching limit | +| step-05-domain.md | 193 | ⚠️ Approaching limit | +| step-06-innovation.md | 226 | ⚠️ Approaching limit | +| step-07-project-type.md | 225 | ⚠️ Approaching limit | +| step-08-scoping.md | 228 | ⚠️ Approaching limit | +| step-09-functional.md | 231 | ⚠️ Approaching limit | +| step-10-nonfunctional.md | 242 | ⚠️ Approaching limit | +| step-11-polish.md | 217 | ⚠️ Approaching limit | +| step-12-complete.md | 185 | ✅ Good | #### Steps-V (Validation Steps) - 13 files -| File | Lines | Status | -|------|-------|--------| -| step-v-01-discovery.md | 217 | ⚠️ Approaching limit | -| step-v-02-format-detection.md | 191 | ⚠️ Approaching limit | -| step-v-02b-parity-check.md | 209 | ⚠️ Approaching limit | -| step-v-03-density-validation.md | 174 | ✅ Good | -| step-v-04-brief-coverage-validation.md | 214 | ⚠️ Approaching limit | -| step-v-05-measurability-validation.md | 228 | ⚠️ Approaching limit | -| step-v-06-traceability-validation.md | 217 | ⚠️ Approaching limit | -| step-v-07-implementation-leakage-validation.md | 205 | ⚠️ Approaching limit | -| step-v-08-domain-compliance-validation.md | 243 | ⚠️ Approaching limit | -| step-v-09-project-type-validation.md | 263 | ❌ Exceeds limit | -| step-v-10-smart-validation.md | 209 | ⚠️ Approaching limit | -| step-v-11-holistic-quality-validation.md | 264 | ❌ Exceeds limit | -| step-v-12-completeness-validation.md | 242 | ⚠️ Approaching limit | -| step-v-13-report-complete.md | 231 | ⚠️ Approaching limit | +| File | Lines | Status | +| ---------------------------------------------- | ----- | ------------------- | +| step-v-01-discovery.md | 217 | ⚠️ Approaching limit | +| step-v-02-format-detection.md | 191 | ⚠️ Approaching limit | +| step-v-02b-parity-check.md | 209 | ⚠️ Approaching limit | +| step-v-03-density-validation.md | 174 | ✅ Good | +| step-v-04-brief-coverage-validation.md | 214 | ⚠️ Approaching limit | +| step-v-05-measurability-validation.md | 228 | ⚠️ Approaching limit | +| step-v-06-traceability-validation.md | 217 | ⚠️ Approaching limit | +| step-v-07-implementation-leakage-validation.md | 205 | ⚠️ Approaching limit | +| step-v-08-domain-compliance-validation.md | 243 | ⚠️ Approaching limit | +| step-v-09-project-type-validation.md | 263 | ❌ Exceeds limit | +| step-v-10-smart-validation.md | 209 | ⚠️ Approaching limit | +| step-v-11-holistic-quality-validation.md | 264 | ❌ Exceeds limit | +| step-v-12-completeness-validation.md | 242 | ⚠️ Approaching limit | +| step-v-13-report-complete.md | 231 | ⚠️ Approaching limit | #### Steps-E (Edit Steps) - 5 files -| File | Lines | Status | -|------|-------|--------| -| step-e-01-discovery.md | 206 | ⚠️ Approaching limit | -| step-e-01b-legacy-conversion.md | 208 | ⚠️ Approaching limit | -| step-e-02-review.md | 249 | ⚠️ Approaching limit | -| step-e-03-edit.md | 253 | ❌ Exceeds limit | -| step-e-04-complete.md | 168 | ✅ Good | +| File | Lines | Status | +| ------------------------------- | ----- | ------------------- | +| step-e-01-discovery.md | 206 | ⚠️ Approaching limit | +| step-e-01b-legacy-conversion.md | 208 | ⚠️ Approaching limit | +| step-e-02-review.md | 249 | ⚠️ Approaching limit | +| step-e-03-edit.md | 253 | ❌ Exceeds limit | +| step-e-04-complete.md | 168 | ✅ Good | #### Data & Templates -| File | Lines | Status | -|------|-------|--------| -| data/prd-purpose.md | 197 | ⚠️ Approaching limit | -| templates/prd-template.md | 10 | ✅ Good | -| workflow.md | 114 | ✅ Good | +| File | Lines | Status | +| ------------------------- | ----- | ------------------- | +| data/prd-purpose.md | 197 | ⚠️ Approaching limit | +| templates/prd-template.md | 10 | ✅ Good | +| workflow.md | 114 | ✅ Good | ### File Size Statistics @@ -347,14 +347,14 @@ The only true critical issue (edit workflow path) has been fixed. All other item #### Validation Scores by Category -| Category | Status | Score | Notes | -|----------|--------|-------|-------| -| **File Structure & Size** | ⚠️ WARNINGS | 7/10 | 3 files exceed 250-line limit, 23 approaching | -| **Frontmatter Validation** | ✅ PASS | 9/10 | One broken path reference | -| **Step Content Quality** | ✅ EXCELLENT | 9.5/10 | High-quality instructional design | -| **Documentation** | ✅ EXCELLENT | 9/10 | Comprehensive, minor inconsistencies | -| **Integration** | ✅ PASS | 9/10 | All paths correct (one issue fixed) | -| **BMAD Compliance** | ✅ EXCELLENT | 9.5/10 | Strong adherence to standards | +| Category | Status | Score | Notes | +| -------------------------- | ----------- | ------ | --------------------------------------------- | +| **File Structure & Size** | ⚠️ WARNINGS | 7/10 | 3 files exceed 250-line limit, 23 approaching | +| **Frontmatter Validation** | ✅ PASS | 9/10 | One broken path reference | +| **Step Content Quality** | ✅ EXCELLENT | 9.5/10 | High-quality instructional design | +| **Documentation** | ✅ EXCELLENT | 9/10 | Comprehensive, minor inconsistencies | +| **Integration** | ✅ PASS | 9/10 | All paths correct (one issue fixed) | +| **BMAD Compliance** | ✅ EXCELLENT | 9.5/10 | Strong adherence to standards | **Overall Score: 9.2/10 - EXCELLENT** diff --git a/src/bmm/workflows/2-plan-workflows/prd/workflow.md b/src/bmm/workflows/2-plan-workflows/create-prd/workflow.md similarity index 99% rename from src/bmm/workflows/2-plan-workflows/prd/workflow.md rename to src/bmm/workflows/2-plan-workflows/create-prd/workflow.md index be5a73112..b13d7a7cf 100644 --- a/src/bmm/workflows/2-plan-workflows/prd/workflow.md +++ b/src/bmm/workflows/2-plan-workflows/create-prd/workflow.md @@ -1,5 +1,5 @@ --- -name: prd +name: create-prd description: PRD tri-modal workflow - Create, Validate, or Edit comprehensive PRDs main_config: '{project-root}/_bmad/bmm/config.yaml' nextStep: './steps-c/step-01-init.md'