bmad-method 4.19.1 → 4.20.0

package/README.md

@@ -1,32 +1,73 @@
-# BMAD-METHOD
+# BMad-METHOD: Universal AI Agent Framework
 
 [![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
 [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
 
-**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
+Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, but it is so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
 
-📺 **[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)** - V4 walkthrough and comprehensive guide coming soon!
+**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
 
-⭐ **If you find this project helpful or useful, please give it a star!** It helps others discover BMAD-METHOD and you will be notified of updates!
+**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you!
 
-## 🔄 Important: Keeping Your BMAD Installation Updated
+⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-METHOD and you will be notified of updates!
 
-**Stay up-to-date effortlessly!** If you already have BMAD-METHOD installed in your project, simply run:
+## 🧭 Quick Navigation - Find Your Path
+
+### 🚨 MUST READ: Understanding the BMAD Workflow
+
+**Before diving in, review these critical workflow diagrams that explain how BMAD works:**
+
+1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
+2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
+
+> ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
+
+### What would you like to do?
+
+- **[Build software with Full Stack Agile AI Team](#-quick-start)** → Quick Start Instruction
+- **[Learn how to use BMAD](docs/user-guide.md)** → Complete user guide and walkthrough
+- **[See available AI agents](#available-agents)** → Specialized roles for your team
+- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
+- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
+- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
+- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
+- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
+
+### Popular Use Cases
+
+- **Software Development** - [Quick Start](#-quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
+- **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
+- **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
+- **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
+- **DevOps/Infrastructure** - [Infrastructure Pack](expansion-packs/bmad-infrastructure-devops/)
+
+### Quick Links
+
+- **[Installation](#installation)** → Get started in minutes
+- **[Documentation](#documentation--guides)** → All guides and references
+- **[Contributing](#contributing)** → Help improve BMAD
+- **[Support](#support)** → Get help and connect
+
+## 🔄 Important: Keeping Your BMad Installation Updated
+
+**Stay up-to-date effortlessly!** If you already have BMad-METHOD installed in your project, simply run:
 
 ```bash
 npx bmad-method install
+# OR
+npm run install:bmad
 ```
 
-The installer will:
+This will:
 
 - ✅ Automatically detect your existing v4 installation
-- ✅ Update only the files that have changed
+- ✅ Update only the files that have changed and add new files
 - ✅ Create `.bak` backup files for any custom modifications you've made
 - ✅ Preserve your project-specific configurations
 
-This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
+This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! If for some reason this fails, you can rename or remove your .bmad-code folder and run the install again. The main thing to look out for is if you have set up custom modes that are not file driven (Cursor is the only one at this time that is not done through project files lagging behind) - you will want to ensure your sm and dev custom modes especially are kept up to date.
 
 ## 🚀 Quick Start
 
@@ -45,28 +86,20 @@ This makes it easy to benefit from the latest improvements, bug fixes, and new a
 
 Run `npx bmad-method install`
 
-This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
+OR
 
-## 📋 Table of Contents
+```bash
+git clone https://github.com/bmadcode/bmad-method.git
+npm run install:bmad # build and install all to a destination folder
+```
 
-- [Overview](#overview)
-- [Installation](#installation)
-- [Available Agents](#available-agents)
-- [Usage](#usage)
-- [Project Structure](#project-structure)
-- [Contributing](#contributing)
+This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
 
 ## Overview
 
-BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.
-
-### Why BMAD?
+The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
 
-- **🎯 Specialized Expertise**: Each agent is an expert in their specific role
-- **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
-- **📦 Modular Design**: Use one agent or an entire team
-- **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, Windsurf, and Gemini
-- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
+Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile flow does so much more. With most systems, you give your idea in a few sentences at most, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM techniques and techniques also based in psychology to produce beyond the average slop LLMs and Task generators will on their own. This truly is a system of Human in the Loop produces markedly better results.
 
 ## Installation
 
@@ -91,164 +124,104 @@ Install directly into your project: `npx bmad-method install`
 
 The BMad Method works with any IDE, but has built-in integration for:
 
-- `cursor` - Cursor IDE with @agent commands
+- `cursor` - Cursor IDE with manual rule @agent commands
 - `claude-code` - Claude Code with /agent commands
-- `windsurf` - Windsurf with @agent commands
+- `cline` - Cline Rules integration
 - `gemini-cli` - Gemini with @agent commands
+- `windsurf` - Windsurf with manual rule @agent commands
 - `roo` - Roo Code with custom modes (see `.roomodes`)
-- More coming soon - BUT ITS easy to use with ANY IDE - just copy the bmad-code folder to your project, and rename it .bmad-code.
+- `windsurf` - Windsurf with @agent commands
 
 ## Available Agents
 
 ### Core Development Team
 
-| Agent       | Role               | Specialty                                     |
-| ----------- | ------------------ | --------------------------------------------- |
-| `analyst`   | Business Analyst   | market analysis, brainstorming, project brief |
-| `pm`        | Product Manager    | Product strategy, roadmaps, PRDs              |
-| `architect` | Solution Architect | System design, technical architecture         |
-| `dev`       | Developer          | Code implementation across all technologies   |
-| `qa`        | QA Specialist      | Testing strategies, quality assurance         |
-| `ux-expert` | UX Designer        | User experience, UI design, prototypes        |
-| `po`        | Product Owner      | Backlog management, story validation          |
-| `sm`        | Scrum Master       | Sprint planning, story creation               |
+| Agent       | Role               | Specialty                                                                                    |
+| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
+| `analyst`   | Business Analyst   | market analysis, brainstorming, project brief creation                                       |
+| `pm`        | Product Manager    | Product strategy, MVP Decisioning, PRD creation with Epics                                   |
+| `architect` | Solution Architect | System design, technical full stack, front end or backend architecture                       |
+| `ux-expert` | UX Designer        | User experience, UI design, prompts for V0, Lovable, and others                              |
+| `po`        | Product Owner      | Ensure PRD and Architecture are aligned, and changes from architecture end up in PRD stories |
+| `sm`        | Scrum Master       | High level epics and stories transformed into detailed dev stories with tasks and subtasks   |
+| `dev`       | Developer          | Code implementation across all technologies - follows the detailed SM created story          |
+| `qa`        | QA Specialist      | Detailed review of the devs ready for review story, refactor and propose issues and changes  |
 
-### Meta Agents
+### BMad Agents
 
-| Agent               | Role             | Specialty                                                           |
-| ------------------- | ---------------- | ------------------------------------------------------------------- |
-| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching, is part of every team bundle |
-| `bmad-master`       | Universal Expert | All capabilities without switching                                  |
-
-## Usage
-
-### With IDE Integration
-
-After installation with `--ide` flag:
-
-```bash
-# In Cursor
-@pm Create a PRD for a task management app
-
-# In Claude Code
-/architect Design a microservices architecture
-
-# In Windsurf
-@dev Implement story 1.3
-```
-
-### With Web UI (ChatGPT/Claude/Gemini)
-
-After uploading a bundle you can ask /help of the agent to learn what it can do
-
-### CLI Commands
-
-```bash
-# List all available agents
-npx bmad-method list
+| Agent               | Role             | Specialty                                                                                                                |
+| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `bmad-orchestrator` | Team Coordinator | Helps guide you and answers your questions with its massive knowledge base, and guides you through Multi-agent workflows |
+| `bmad-master`       | Universal Expert | All capabilities without switching (Except Dev)                                                                          |
 
-# Install or update (automatically detects existing installations)
-npx bmad-method install
-
-# Check installation status
-npx bmad-method status
-```
-
-### Upgrading from V3 to V4
-
-If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
+## Advanced Features
 
-```bash
-npx bmad-method install
-# The installer will automatically detect your V3 installation and offer to upgrade
-```
+### Dynamic Dependencies
 
-The upgrade process will:
+Each agent only loads the resources it needs, keeping context windows lean.
 
-1. Create a backup of your V3 files in `.bmad-v3-backup/`
-2. Install the new V4 `.bmad-core/` structure
-3. Migrate your documents (PRD, Architecture, Stories, Epics)
-4. Set up IDE integration for all V4 agents
-5. Create an install manifest for future updates
+### Template System
 
-After upgrading:
+Rich templates for all document types:
 
-1. Review your documents in the `docs/` folder - if you had a PRD or architecture in your old project, copy it from the backup to the docs folder if they are not there.
-2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent my saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}
-3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
+- Product Requirements (PRD)
+- Architecture Documents
+- User Stories
+- Test Plans
+- And more...
 
-The reason #2 and 3 are optional is because now BMad V4 makes sharding optional for the SM. See [Core Configuration](#-core-configuration-new-in-v4)
+Templates are unique in that they are embedded with the LLM instructions also for further working with you to prompt and elicit the best from you and your agile agent team member - allowing for unique coaching and customization options. While there is a single create-doc task, the possibilities are endless when you expand the templates into more doc types, or customize with your own docs embedded with the templating markup and LLM instruction framework that is core to the BMad Method.
 
-**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
+### Slash Star Commands
 
-### 🔧 Core Configuration (NEW in V4)
+Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
 
-**Critical**: V4 introduces `bmad-core/core-config.yml` - a powerful configuration file that enables BMAD to work seamlessly with any project structure, whether it's V4-optimized or legacy. You can even now use non-standard PRDs and architectures!
+### Advanced Elicitation
 
-#### What is core-config.yml?
+Many of the Agents and Templates for docs, and some tasks, include Advanced Elicitation directives based on the latest in LLM interactions and pro level prompt engineering guidance. With this, you can push the Agents further than ever before. If an agent proposes an idea, or an architecture - you can push it further with optional elicitations where it will have to really expand on, defend, or produce other options and prove its suggestion was better. This is a necessary step if you want the absolute best beyond accepting the generated average responses the LLMs think you want to hear for their first response. Some of this is interactive, and some of this is baked into the core prompting engine that powers the LLM progression through various tasks and template flows.
 
-This configuration file tells BMAD agents exactly where to find your project documents and how they're structured. It's the key to V4's flexibility and backwards compatibility.
+## Usage
 
-#### Key Features
+The BMAD Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
 
-- **Version Awareness**: Agents understand if your PRD/Architecture follows V4 conventions or earlier versions
-- **Flexible Document Locations**: Works whether your epics are embedded in PRD or properly sharded
-- **Developer Context**: Define which files the dev agent should always load
-- **Debug Support**: Built-in logging for troubleshooting story implementation
+### Quick Start Examples
 
-#### Why It Matters
+#### With IDE Integration
 
-- **Use BMAD with ANY project structure** - V3, V4, or custom layouts
-- **No forced migrations** - Keep your existing document organization
-- **Customize developer workflow** - Specify exactly which files provide context
-- **Seamless upgrades** - Start with V3 docs and gradually adopt V4 patterns
+```bash
+# In Cursor
+@pm Create a PRD for a task management app
 
-See the [detailed core-config.yml guide](docs/user-guide.md#core-configuration-coreconfigyml) for configuration examples and best practices.
+# In Claude Code
+/architect Design a microservices architecture
 
-## Teams & Workflows
+# In Windsurf
+@dev Implement story 1.3
+```
 
-### Pre-Configured Teams
+#### With Web UI
 
-Save context by using specialized teams:
+After uploading a bundle, type `/help` to see available commands.
 
-- **Team All**: Complete Agile team with all 10 agents
-- **Team Fullstack**: Frontend + Backend development focus
-- **Team No-UI**: Backend/API development without UX
+### Key Resources
 
-### Workflows
+- **[Complete User Guide](docs/user-guide.md)** - Full walkthrough from project inception to completion
+- **[CLI Commands](docs/user-guide.md#cli-commands)** - Installation, updates, and management
+- **[Upgrading from V3](docs/user-guide.md#upgrading-from-v3-to-v4)** - Migration instructions
+- **[Core Configuration](docs/user-guide.md#core-configuration-coreconfigyml)** - V4's flexible project structure support
+- **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
 
-Structured approaches for different scenarios:
+## Project Structure
 
-- **Greenfield**: Starting new projects (fullstack/service/UI)
-- **Brownfield**: Enhancing existing projects
-- **Simple**: Quick prototypes and MVPs
-- **Complex**: Enterprise and large-scale projects
+See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
 
-## Project Structure
+### Key Directories
 
-```plaintext
-.bmad-core/
-├── agents/          # Individual agent definitions
-├── agent-teams/     # Team configurations
-├── workflows/       # Development workflows
-├── templates/       # Document templates (PRD, Architecture, etc.)
-├── tasks/           # Reusable task definitions
-├── checklists/      # Quality checklists
-├── data/            # Knowledge base
-└── web-bundles/     # Optional can be added if you use the install command and select this folder as a destination for the build bundle files
-
-tools/
-├── cli.js           # Build tool
-├── installer/       # NPX installer
-└── lib/             # Build utilities
-
-expansion-packs/     # Domain-specific add-ons (Technical & Non-Technical)
-
-dist/                # 📦 PRE-BUILT BUNDLES (Ready to use!)
-├── agents/          # Individual agent bundles (.txt files)
-├── teams/           # Team bundles (.txt files)
-└── expansion-packs/ # Expansion pack bundles
-```
+- **`.bmad-core/`** - Heart of the framework (agents, templates, workflows)
+- **`dist/`** - Pre-built bundles ready for web UI use
+- **`expansion-packs/`** - Domain-specific extensions
+- **`tools/`** - Build and installation utilities
+- **`docs/`** - Your project documentation (PRD, architecture, stories)
 
 ### 📦 Pre-Built Bundles (dist/ folder)
 
@@ -270,58 +243,86 @@ dist/                # 📦 PRE-BUILT BUNDLES (Ready to use!)
 
 **For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
 
-## Advanced Features
+## Documentation & Guides
 
-### Dynamic Dependencies
+### Architecture & Technical
 
-Each agent only loads the resources it needs, keeping context windows lean.
+- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
+- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
+- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
 
-### Template System
+### Workflow Guides
 
-Rich templates for all document types:
+- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
+- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
 
-- Product Requirements (PRD)
-- Architecture Documents
-- User Stories
-- Test Plans
-- And more...
+### IDE-Specific Guides
 
-### Slash Star Commands
+- 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor
+- 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code
+- 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf
+- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
+- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
+- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
 
-Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
+## 🌟 Beyond Software Development - Expansion Packs
 
-## Expansion Packs - Beyond Software Development
+While BMAD excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMAD into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
 
-BMAD Method's natural language framework isn't limited to software development. Create specialized agents for ANY domain:
+### Available Expansion Packs
 
-### Technical Expansion Packs
+#### Technical Domains
 
-- 🎮 **Game Development** - Game designers, level creators, narrative writers
-- 🏗️ **Infrastructure/DevOps** - Cloud architects, security specialists, SRE agents
-- 📱 **Mobile Development** - iOS/Android specialists, UX designers
+- 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
+- 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
+- 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
 - 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
 
-### Non-Technical Expansion Packs
+#### Non-Technical Domains
 
 - 💼 **Business Strategy** - Strategic planners, market analysts, business coaches
 - 💪 **Health & Wellness** - Fitness coaches, nutrition advisors, meditation guides
 - 🎨 **Creative Arts** - Story writers, world builders, character developers
 - 📚 **Education** - Curriculum designers, tutors, learning coaches
 - 🧠 **Personal Development** - Life coaches, goal setters, habit builders
-- 🏢 **Professional Services** - Legal advisors, medical protocols, research assistants
+- 🏢 **Professional Services** - Legal advisors, content creators, research assistants
 
 ### Creating Your Own Expansion Pack
 
-The BMAD framework can support any domain where structured AI assistance is valuable:
+Transform your expertise into AI agents:
 
-1. Define specialized agents with domain expertise
-2. Create task procedures for common workflows
-3. Build templates for domain-specific outputs
-4. Package as an expansion pack for others to use
+1. **Identify your domain** - What knowledge do you want to share?
+2. **Design specialized agents** - Each with unique expertise and personality
+3. **Create reusable tasks** - Standard procedures in your field
+4. **Build professional templates** - Structured outputs for consistency
+5. **Share with the community** - Help others benefit from your expertise
 
-📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** for detailed examples and inspiration!
+📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
+
+## Support
 
-🛠️ **[Use the Expansion Pack Creator](expansion-packs/expansion-creator/README.md)** to build your own!
+- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
+- 📖 [Documentation](docs/)
+- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
+- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Version History
+
+- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
+- **Previous Versions**:
+  - [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
+  - [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
+  - [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
+
+See [versions.md](docs/versions.md) for detailed version history and migration guides.
+
+## Author
+
+Created by Brian (BMad) Madison
 
 ## Contributing
 
@@ -329,7 +330,7 @@ The BMAD framework can support any domain where structured AI assistance is valu
 
 ### Before Contributing - MUST READ
 
-To ensure your contribution aligns with the BMAD Method and gets merged smoothly:
+To ensure your contribution aligns with the BMad Method and gets merged smoothly:
 
 1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
 2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMAD powerful through simplicity
@@ -340,62 +341,22 @@ To ensure your contribution aligns with the BMAD Method and gets merged smoothly
 - Keep dev agents lean (save context for coding!)
 - Use small, focused files over large branching ones
 - Reuse existing tasks (like `create-doc`) instead of creating duplicates
-- Consider expansion packs for domain-specific features
-- All contributions must follow our natural language, markdown-based approach
+- Consider expansion packs for domain-specific features and not improvements to the core system (those belong in the core system)
+- All contributions must follow our natural language, markdown-based templating approach with template embedded LLM instructions and elicitations
 
 We're building something amazing together - let's keep it simple, powerful, and focused! 💪
 
 ### Development Setup
 
+Want to help improve the BMad Method. Fork n' Clone the repo
+
 ```bash
 git clone https://github.com/bmadcode/bmad-method.git
 cd bmad-method
-npm install
-```
 
-## Documentation & Guides
-
-### Architecture & Technical
-
-- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
-- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
-- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
-
-### Workflow Guides
-
-- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
-- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
-- 🎯 [Cursor Guide](docs/cursor-guide.md) - Complete workflow for Cursor users
-- 🤖 [Claude Code Guide](docs/claude-code-guide.md) - Complete workflow for Claude Code users
-- 🌊 [Windsurf Guide](docs/windsurf-guide.md) - Complete workflow for Windsurf users
-- 🦘 [Roo Code Guide](docs/roo-code-guide.md) - Complete workflow for Roo Code users
-
-## Support
-
-- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
-- 📖 [Documentation](docs/)
-- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
-- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
-
-## License
-
-MIT License - see [LICENSE](LICENSE) for details.
-
-## Version History
-
-- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
-- **Previous Versions**:
-  - [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
-  - [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
-  - [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
-
-See [versions.md](docs/versions.md) for detailed version history and migration guides.
-
-## Author
-
-Created by Brian (BMad) Madison
-
----
+npm run build # rebuild the dist folder
+npm run install:bmad # build and install all to a destination folder
+```
 
 [![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
 

package/bmad-core/agents/dev.md

@@ -50,7 +50,7 @@ task-execution:
   updates-ONLY:
     - "Checkboxes: [ ] not started | [-] in progress | [x] complete"
     - "Debug Log: | Task | File | Change | Reverted? |"
-    - "Completion Notes: Deviations only, <50 words"
+    - "Completion Notes: Deviations from AC or tasks during execution only, <50 words"
     - "Change Log: Requirement changes only"
     - "File List: CRITICAL - Maintain complete list of ALL files created/modified during implementation"
   blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config | Failing validations"

package/bmad-core/data/bmad-kb.md

@@ -719,7 +719,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
 ### Using Expansion Packs
 
 1. **Browse Available Packs**: Check `expansion-packs/` directory
-2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
+2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
 3. **Install via CLI**: 
    ```bash
    npx bmad-method install

package/bmad-core/workflows/brownfield-fullstack.yml

@@ -19,21 +19,21 @@ workflow:
       notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
 
     - agent: pm
-      creates: brownfield-prd.md
+      creates: prd.md
       uses: brownfield-prd-tmpl
       requires: existing_project_analysis
-      notes: "Creates comprehensive brownfield PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
+      notes: "Creates comprehensive PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
 
     - agent: architect
-      creates: brownfield-architecture.md
+      creates: architecture.md
       uses: brownfield-architecture-tmpl
-      requires: brownfield-prd.md
-      notes: "Creates brownfield architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
+      requires: prd.md
+      notes: "Creates architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
 
     - agent: po
       validates: all_artifacts
       uses: po-master-checklist
-      notes: "Validates all brownfield documents for integration safety and completeness. May require updates to any document."
+      notes: "Validates all documents for integration safety and completeness. May require updates to any document."
 
     - agent: various
       updates: any_flagged_documents
@@ -83,8 +83,8 @@ workflow:
     ```mermaid
     graph TD
         A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
-        B --> C[pm: brownfield-prd.md]
-        C --> D[architect: brownfield-architecture.md]
+        B --> C[pm: prd.md]
+        C --> D[architect: architecture.md]
         D --> E[po: validate with po-master-checklist]
         E --> F{PO finds issues?}
         F -->|Yes| G[Return to relevant agent for fixes]
@@ -105,8 +105,8 @@ workflow:
       - Multiple team members will work on related changes
 
   handoff_prompts:
-    analyst_to_pm: "Existing project analysis complete. Create comprehensive brownfield PRD with integration strategy."
-    pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the integration architecture."
-    architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for integration safety."
+    analyst_to_pm: "Existing project analysis complete. Create comprehensive PRD with integration strategy."
+    pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the integration architecture."
+    architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
     po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
-    complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
+    complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."