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

package/docs/how-to/workflows/run-test-design.md

@@ -0,0 +1,128 @@
+---
+title: "How to Run Test Design"
+description: How to create comprehensive test plans using TEA's test-design workflow
+---
+
+
+Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
+
+---
+
+## When to Use This
+
+**System-level (Phase 3):**
+- After architecture is complete
+- Before implementation-readiness gate
+- To validate architecture testability
+
+**Epic-level (Phase 4):**
+- At the start of each epic
+- Before implementing stories in the epic
+- To identify epic-specific testing needs
+
+---
+
+## Prerequisites
+
+- BMad Method installed
+- TEA agent available
+- For system-level: Architecture document complete
+- For epic-level: Epic defined with stories
+
+---
+
+## Steps
+
+### 1. Load the TEA Agent
+
+Start a fresh chat and load the TEA (Test Architect) agent.
+
+### 2. Run the Test Design Workflow
+
+```
+*test-design
+```
+
+### 3. Specify the Mode
+
+TEA will ask if you want:
+
+- **System-level** - For architecture testability review (Phase 3)
+- **Epic-level** - For epic-specific test planning (Phase 4)
+
+### 4. Provide Context
+
+For system-level:
+- Point to your architecture document
+- Reference any ADRs (Architecture Decision Records)
+
+For epic-level:
+- Specify which epic you're planning
+- Reference the epic file with stories
+
+### 5. Review the Output
+
+TEA generates a comprehensive test design document.
+
+---
+
+## What You Get
+
+### System-Level Output (`test-design-system.md`)
+
+- Testability review of architecture
+- ADR → test mapping
+- Architecturally Significant Requirements (ASRs)
+- Environment needs
+- Test infrastructure recommendations
+
+### Epic-Level Output (`test-design-epic-N.md`)
+
+- Risk assessment for the epic
+- Test priorities
+- Coverage plan
+- Regression hotspots (for brownfield)
+- Integration risks
+- Mitigation strategies
+
+---
+
+## Test Design for Different Tracks
+
+### Greenfield - BMad Method
+
+| Stage | Test Design Focus |
+|-------|-------------------|
+| Phase 3 | System-level testability review |
+| Phase 4 | Per-epic risk assessment and test plan |
+
+### Brownfield - BMad Method/Enterprise
+
+| Stage | Test Design Focus |
+|-------|-------------------|
+| Phase 3 | System-level + existing test baseline |
+| Phase 4 | Regression hotspots, integration risks |
+
+### Enterprise
+
+| Stage | Test Design Focus |
+|-------|-------------------|
+| Phase 3 | Compliance-aware testability |
+| Phase 4 | Security/performance/compliance focus |
+
+---
+
+## Tips
+
+- Run system-level test-design right after architecture
+- Run epic-level test-design at the start of each epic
+- Update test design if ADRs change
+- Use the output to guide `*atdd` and `*automate` workflows
+
+---
+
+## Related
+
+- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect
+- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - Setting up testing infrastructure
+- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow

package/docs/how-to/workflows/setup-party-mode.md

@@ -0,0 +1,117 @@
+---
+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
+
+---
+
+## 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
+
+### 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)
+
+### 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
+- **Optional TTS** - Voice configurations for each agent
+- **Graceful exit** - Personalized farewells
+
+---
+
+## Tips
+
+- Be specific about your topic for better agent selection
+- Let the conversation flow naturally
+- Ask follow-up questions to go deeper
+- Take notes on key insights
+- Use for strategic decisions, not routine tasks
+
+---
+
+## Related
+
+- [Party Mode](/docs/explanation/features/party-mode.md) - Understanding Party Mode
+- [Agent Roles](/docs/explanation/core-concepts/agent-roles.md) - Available agents

package/docs/how-to/workflows/setup-test-framework.md

@@ -0,0 +1,113 @@
+---
+title: "How to Set Up a Test Framework"
+description: How to set up a production-ready test framework using TEA
+---
+
+
+Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project.
+
+---
+
+## When to Use This
+
+- No existing test framework in your project
+- Current test setup isn't production-ready
+- Starting a new project that needs testing infrastructure
+- Phase 3 (Solutioning) after architecture is complete
+
+---
+
+## Prerequisites
+
+- BMad Method installed
+- Architecture completed (or at least tech stack decided)
+- TEA agent available
+
+---
+
+## Steps
+
+### 1. Load the TEA Agent
+
+Start a fresh chat and load the TEA (Test Architect) agent.
+
+### 2. Run the Framework Workflow
+
+```
+*framework
+```
+
+### 3. Answer TEA's Questions
+
+TEA will ask about:
+
+- Your tech stack (React, Node, etc.)
+- Preferred test framework (Playwright, Cypress, Jest)
+- Testing scope (E2E, integration, unit)
+- CI/CD platform (GitHub Actions, etc.)
+
+### 4. Review Generated Output
+
+TEA generates:
+
+- **Test scaffold** - Directory structure and config files
+- **Sample specs** - Example tests following best practices
+- **`.env.example`** - Environment variable template
+- **`.nvmrc`** - Node version specification
+- **README updates** - Testing documentation
+
+---
+
+## What You Get
+
+```
+tests/
+├── e2e/
+│   ├── example.spec.ts
+│   └── fixtures/
+├── integration/
+├── unit/
+├── playwright.config.ts  # or cypress.config.ts
+└── README.md
+```
+
+---
+
+## Optional: Playwright Utils Integration
+
+TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures:
+
+```bash
+npm install -D @seontechnologies/playwright-utils
+```
+
+Enable during BMad installation or set `tea_use_playwright_utils: true` in config.
+
+**Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor
+
+---
+
+## Optional: MCP Enhancements
+
+TEA can use Playwright MCP servers for enhanced capabilities:
+
+- `playwright` - Browser automation
+- `playwright-test` - Test runner with failure analysis
+
+Configure in your IDE's MCP settings.
+
+---
+
+## Tips
+
+- Run `*framework` only once per repository
+- Run after architecture is complete so framework aligns with tech stack
+- Follow up with `*ci` to set up CI/CD pipeline
+
+---
+
+## Related
+
+- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect
+- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans
+- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow

package/docs/index.md

@@ -1,143 +1,63 @@
-# BMad Documentation Index
-
-Complete map of all BMad Method v6 documentation with recommended reading paths.
-
 ---
-
-## 🎯 Getting Started (Start Here!)
-
-**New users:** Start with one of these based on your situation:
-
-| Your Situation         | Start Here                                         | Then Read                                                   |
-| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
-| **Brand new to BMad**  | [Quick Start Guide](./modules/bmm/quick-start)     | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
-| **Upgrading from v4**  | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)    | [Quick Start Guide](./modules/bmm/quick-start)              |
-| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start)              |
-
+title: Welcome to the BMad Method
 ---
 
-## 📋 Core Documentation
-
-### Project-Level Docs (Root)
+The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform.
 
-- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
-- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
-- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes
-
-### Installation & Setup
-
-- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
-- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
-- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
+If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
 
 ---
 
-## 🏗️ Module Documentation
-
-### BMad Method (BMM) - Software & Game Development
+## New Here? Start with a Tutorial
 
-The flagship module for agile AI-driven development.
+The fastest way to understand BMad is to try it. Choose a tutorial to walk through your first project in about 10 minutes.
 
-- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
-- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
-  - [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
-  - [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
-  - [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
-  - [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
-- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
-- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
+- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development
 
-### BMad Builder (BMB) - Create Custom Solutions
+:::tip[Already familiar with AI-assisted development?]
+Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas.
+:::
 
-Build your own agents, workflows, and modules.
-
-- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
-- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
+---
 
-### Creative Intelligence Suite (CIS) - Innovation & Creativity
+## How to Use These Docs
 
-AI-powered creative thinking and brainstorming.
+These docs are organized into four sections based on what you're trying to do:
 
-- **[CIS Module README](./modules/cis/)** - Module overview and workflows
+| Section           | Purpose                                                                                                    |
+| ----------------- | ---------------------------------------------------------------------------------------------------------- |
+| **Tutorials**     | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. |
+| **How-To Guides** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here.  |
+| **Explanation**   | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*.       |
+| **Reference**     | Information-oriented. Technical specifications for agents, workflows, and configuration.                   |
 
 ---
 
-## 🖥️ IDE-Specific Guides
-
-Instructions for loading agents and running workflows in your development environment.
+## What You'll Need
 
-**Popular IDEs:**
+BMad works with any AI coding assistant that supports custom system prompts or project context. Popular options include:
 
-- [Claude Code](./ide-info/claude-code.md)
-- [Cursor](./ide-info/cursor.md)
-- [VS Code](./ide-info/windsurf.md)
+- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
+- **[Cursor](https://cursor.sh)** — AI-first code editor
+- **[Windsurf](https://codeium.com/windsurf)** — Codeium's AI IDE
+- **[Roo Code](https://roocode.com)** — VS Code extension
 
-**Other Supported IDEs:**
-
-- [Augment](./ide-info/auggie.md)
-- [Cline](./ide-info/cline.md)
-- [Codex](./ide-info/codex.md)
-- [Crush](./ide-info/crush.md)
-- [Gemini](./ide-info/gemini.md)
-- [GitHub Copilot](./ide-info/github-copilot.md)
-- [IFlow](./ide-info/iflow.md)
-- [Kilo](./ide-info/kilo.md)
-- [OpenCode](./ide-info/opencode.md)
-- [Qwen](./ide-info/qwen.md)
-- [Roo](./ide-info/roo.md)
-- [Rovo Dev](./ide-info/rovo-dev.md)
-- [Trae](./ide-info/trae.md)
-
-**Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions.
+You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
 
 ---
 
-## 🔧 Advanced Topics
+## Join the Community
 
-### Custom Agents, Workflow and Modules
+Get help, share what you're building, or contribute to BMad:
 
-- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
-- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
+- **[Discord](https://discord.gg/gk8jAdXWmj)** — Chat with other BMad users, ask questions, share ideas
+- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Source code, issues, and contributions
+- **[YouTube](https://www.youtube.com/@BMadCode)** — Video tutorials and walkthroughs
 
 ---
 
-## 🎓 Recommended Reading Paths
-
-### Path 1: Brand New to BMad (Software Project)
-
-1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
-2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
-3. [BMM Module README](./modules/bmm/) - Understand agents
-4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
-5. [Your IDE guide](./ide-info/) - Optimize your workflow
-
-### Path 2: Game Development Project
-
-1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
-2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
-3. [BMM Module README](./modules/bmm/) - Game agents are included
-4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
-5. [Your IDE guide](./ide-info/) - Optimize your workflow
-
-### Path 3: Upgrading from v4
-
-1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
-2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
-3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
-
-### Path 4: Working with Existing Codebase (Brownfield)
-
-1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
-2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
-3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
-
-### Path 5: Building Custom Solutions
-
-1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
-2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
-3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
+## Next Step
 
-### Path 6: Contributing to BMad
+Ready to dive in? Pick a tutorial and start building.
 
-1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
-2. Relevant module README - Understand the area you're contributing to
+- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Explore the latest features