bmad-method 6.0.0-alpha.21 → 6.0.0-alpha.23

package/docs/_archive/getting-started-bmadv4.md

@@ -0,0 +1,247 @@
+---
+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.

package/{website/src/pages → docs}/downloads.md

@@ -1,47 +1,44 @@
-# Downloads
+---
+title: Downloads
+---
 
-Download BMAD Method resources for offline use, AI training, or integration.
+Download BMad Method resources for offline use, AI training, or integration.
+
+## Source Bundles
+
+| File | Description |
+|------|-------------|
+| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMad source files |
+| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only |
 
 ## LLM-Optimized Files
 
 These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window.
 
-| File                                | Description                         | Use Case                   |
-| ----------------------------------- | ----------------------------------- | -------------------------- |
-| **[llms.txt](/llms.txt)**           | Documentation index with summaries  | Quick overview, navigation |
-| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading       |
+| File | Description | Use Case |
+|------|-------------|----------|
+| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation |
+| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading |
 
 ### Using with LLMs
 
 **Claude Projects:**
-
 ```
 Upload llms-full.txt as project knowledge
 ```
 
 **ChatGPT:**
-
 ```
 Paste llms.txt for navigation, or sections from llms-full.txt as needed
 ```
 
 **API Usage:**
-
 ```python
 import requests
 docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
 # Include in your system prompt or context
 ```
 
-## Source Bundles
-
-Download the complete source code for offline development or contribution.
-
-| Bundle                                              | Contents                                    |
-| --------------------------------------------------- | ------------------------------------------- |
-| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete `/src/` directory with all modules |
-| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent prompts and workflows from `/_bmad/`  |
-
 ## Installation Options
 
 ### NPM (Recommended)
@@ -50,12 +47,6 @@ Download the complete source code for offline development or contribution.
 npx bmad-method@alpha install
 ```
 
-### Manual Installation
-
-1. Download `bmad-prompts.zip`
-2. Extract to your project root
-3. Configure your IDE per the [IDE Guides](/docs/ide-info/)
-
 ## Version Information
 
 - **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
@@ -63,7 +54,7 @@ npx bmad-method@alpha install
 
 ## API Access
 
-For programmatic access to BMAD documentation:
+For programmatic access to BMad documentation:
 
 ```bash
 # Get documentation index
@@ -75,7 +66,7 @@ curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
 
 ## Contributing
 
-Want to improve BMAD Method? Check out:
+Want to improve BMad Method? Check out:
 
 - [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
 - [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)

package/{src/modules/bmm/docs/quick-flow-solo-dev.md → docs/explanation/agents/barry-quick-flow.md}

@@ -1,4 +1,7 @@
-# Quick Flow Solo Dev Agent (Barry)
+---
+title: "Quick Flow Solo Dev Agent (Barry)"
+---
+
 
 **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
 **Icon:** 🚀
@@ -8,14 +11,14 @@
 
 ## 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.
+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.
+**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.
 
@@ -32,11 +35,11 @@ Barry is the elite solo developer who lives and breathes the BMAD Quick Flow wor
 
 ## Menu Commands
 
-Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
+Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
 
-### 1. **create-tech-spec**
+### 1. **quick-spec**
 
-- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
+- **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
 
@@ -80,13 +83,13 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel
 
 ---
 
-## The BMAD Quick Flow Process
+## The BMad Quick Flow Process
 
 Barry orchestrates a simple, efficient 3-step process:
 
 ```mermaid
 flowchart LR
-    A[Requirements] --> B[create-tech-spec]
+    A[Requirements] --> B[quick-spec]
     B --> C[Tech Spec]
     C --> D[quick-dev]
     D --> E[Implementation]
@@ -104,7 +107,7 @@ flowchart LR
     style H fill:#e0f2f1
 ```
 
-### Step 1: Technical Specification (`create-tech-spec`)
+### Step 1: Technical Specification (`quick-spec`)
 
 **Goal:** Transform user requirements into implementation-ready technical specifications
 
@@ -234,7 +237,7 @@ In party mode, Barry often acts as:
 /bmad:bmm:agents:quick-flow-solo-dev
 
 # Create a tech spec
-> create-tech-spec
+> quick-spec
 
 # Quick implementation
 > quick-dev tech-spec-auth.md
@@ -307,11 +310,11 @@ Implement OAuth 2.0 authentication with JWT tokens and role-based access control
 
 ## Related Documentation
 
-- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM
-- **[Agents Guide](./agents-guide.md)** - Complete agent reference
-- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding development tracks
-- **[Workflow Implementation](./workflows-implementation.md)** - Implementation workflows
-- **[Party Mode](./party-mode.md)** - Multi-agent collaboration
+- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
+- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Complete agent reference
+- **[Four Phases](/docs/explanation/architecture/four-phases.md)** - Understanding development tracks
+- **[Workflow Implementation](/docs/how-to/workflows/run-sprint-planning.md)** - Implementation workflows
+- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
 
 ---
 

package/docs/explanation/agents/index.md

@@ -0,0 +1,28 @@
+---
+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
+
+### BMM Agents
+
+- **[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
+
+### BMGD Agents
+
+- **[Game Development Agents](/docs/explanation/game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
+
+---
+
+## Related
+
+- **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** - Core concept explanation
+- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
+- **[Customize Agents](/docs/how-to/customization/customize-agents.md)** - How to customize agent behavior

package/docs/explanation/architecture/four-phases.md

@@ -0,0 +1,126 @@
+---
+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
+
+**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.
+
+---
+
+## Related
+
+- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
+- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md)
+- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)