Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1ac0d2bd91 | ||
|
|
b78537115d | ||
|
|
0ca3f9ebbd | ||
|
|
0a61d3de4a | ||
|
|
4e03f8f982 | ||
|
|
5fc69d773a | ||
|
|
9e6940e8ee | ||
|
|
4b0a9235ab | ||
|
|
c107af0598 | ||
|
|
be9453f234 | ||
|
|
de549673a7 | ||
|
|
400f7b8f41 | ||
|
|
fae0f5ff73 | ||
|
|
d6183b4bb1 | ||
|
|
47b9d9f3e8 | ||
|
|
b9223a4976 | ||
|
|
1bc9960808 | ||
|
|
9f53caf4c6 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -21,6 +21,8 @@ CLAUDE.md
|
|||||||
test-project-install/*
|
test-project-install/*
|
||||||
sample-project/*
|
sample-project/*
|
||||||
.claude
|
.claude
|
||||||
|
.windsurf/
|
||||||
|
.trae/
|
||||||
.bmad-core
|
.bmad-core
|
||||||
.bmad-creator-tools
|
.bmad-creator-tools
|
||||||
.gemini
|
.gemini
|
||||||
|
|||||||
39
.vscode/settings.json
vendored
39
.vscode/settings.json
vendored
@@ -7,7 +7,44 @@
|
|||||||
"chat.tools.autoApprove": false,
|
"chat.tools.autoApprove": false,
|
||||||
"cSpell.words": [
|
"cSpell.words": [
|
||||||
"Agentic",
|
"Agentic",
|
||||||
|
"atlasing",
|
||||||
|
"Biostatistician",
|
||||||
|
"Cordova",
|
||||||
|
"customresourcedefinitions",
|
||||||
|
"dashboarded",
|
||||||
|
"Decisioning",
|
||||||
|
"eksctl",
|
||||||
"elicitations",
|
"elicitations",
|
||||||
"Shardable"
|
"filecomplete",
|
||||||
|
"fintech",
|
||||||
|
"fluxcd",
|
||||||
|
"gamedev",
|
||||||
|
"gitops",
|
||||||
|
"implementability",
|
||||||
|
"inclusivity",
|
||||||
|
"ingressgateway",
|
||||||
|
"istioctl",
|
||||||
|
"metroidvania",
|
||||||
|
"NACLs",
|
||||||
|
"nodegroup",
|
||||||
|
"platformconfigs",
|
||||||
|
"Playfocus",
|
||||||
|
"playtesting",
|
||||||
|
"pointerdown",
|
||||||
|
"pointerup",
|
||||||
|
"Polyrepo",
|
||||||
|
"replayability",
|
||||||
|
"roguelike",
|
||||||
|
"roomodes",
|
||||||
|
"Runbook",
|
||||||
|
"runbooks",
|
||||||
|
"Shardable",
|
||||||
|
"Softlock",
|
||||||
|
"speedrunner",
|
||||||
|
"tekton",
|
||||||
|
"tilemap",
|
||||||
|
"tileset",
|
||||||
|
"Trae",
|
||||||
|
"VNET"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
29
CHANGELOG.md
29
CHANGELOG.md
@@ -1,3 +1,32 @@
|
|||||||
|
# [4.27.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.26.0...v4.27.0) (2025-07-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* readme consolidation and version bumps ([0a61d3d](https://github.com/bmadcode/BMAD-METHOD/commit/0a61d3de4af880f6e3bf934a92b1827754ed8ce6))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* big improvement to advanced elicitation ([1bc9960](https://github.com/bmadcode/BMAD-METHOD/commit/1bc9960808098fba6b43850311799022319df841))
|
||||||
|
* experimental doc creator v2 and template system ([b785371](https://github.com/bmadcode/BMAD-METHOD/commit/b78537115da06b01e140833fd1d73950c7f2e41f))
|
||||||
|
* Massive improvement to the brainstorming task! ([9f53caf](https://github.com/bmadcode/BMAD-METHOD/commit/9f53caf4c6f9c67195b1aae14d54987f81d76e07))
|
||||||
|
* WIP create-docv2 ([c107af0](https://github.com/bmadcode/BMAD-METHOD/commit/c107af05984718c1af2cf80118353e8d2e6f906f))
|
||||||
|
|
||||||
|
# [4.26.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.1...v4.26.0) (2025-07-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **trae:** add support for trae ide integration ([#298](https://github.com/bmadcode/BMAD-METHOD/issues/298)) ([fae0f5f](https://github.com/bmadcode/BMAD-METHOD/commit/fae0f5ff73a603dc1aacc29f184e2a4138446524))
|
||||||
|
|
||||||
|
## [4.25.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.0...v4.25.1) (2025-07-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* spelling errors in documentation. ([#297](https://github.com/bmadcode/BMAD-METHOD/issues/297)) ([47b9d9f](https://github.com/bmadcode/BMAD-METHOD/commit/47b9d9f3e87be62c8520ed6cb0048df727a9534f))
|
||||||
|
|
||||||
# [4.25.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.6...v4.25.0) (2025-07-05)
|
# [4.25.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.6...v4.25.0) (2025-07-05)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
308
README.md
308
README.md
@@ -13,9 +13,21 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|||||||
|
|
||||||
⭐ **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!
|
⭐ **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!
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
**BMad Method's Two Key Innovations:**
|
||||||
|
|
||||||
|
**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
|
||||||
|
|
||||||
|
**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
|
||||||
|
|
||||||
|
This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.
|
||||||
|
|
||||||
|
**📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles
|
||||||
|
|
||||||
## Quick Navigation
|
## Quick Navigation
|
||||||
|
|
||||||
### 🚨 MUST READ: Understanding the BMad Workflow
|
### Understanding the BMad Workflow
|
||||||
|
|
||||||
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
|
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
|
||||||
|
|
||||||
@@ -26,7 +38,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|||||||
|
|
||||||
### What would you like to do?
|
### What would you like to do?
|
||||||
|
|
||||||
- **[Build software with Full Stack Agile AI Team](quick-start)** → Quick Start Instruction
|
- **[Install and 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
|
- **[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
|
- **[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
|
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
||||||
@@ -35,21 +47,6 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|||||||
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
||||||
- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
|
- **[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: Keep Your BMad Installation Updated
|
## Important: Keep Your BMad Installation Updated
|
||||||
|
|
||||||
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
||||||
@@ -68,7 +65,7 @@ This will:
|
|||||||
- ✅ Create `.bak` backup files for any custom modifications you've made
|
- ✅ Create `.bak` backup files for any custom modifications you've made
|
||||||
- ✅ Preserve your project-specific configurations
|
- ✅ Preserve your project-specific configurations
|
||||||
|
|
||||||
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.
|
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
@@ -93,14 +90,14 @@ This single command handles:
|
|||||||
|
|
||||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
||||||
|
|
||||||
### Fastest Start: Web UI (2 minutes)
|
### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
|
||||||
|
|
||||||
1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
|
1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
|
||||||
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
||||||
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||||
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
||||||
|
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
|
||||||
> **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
6. **When to moved to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
|
||||||
|
|
||||||
### Alternative: Clone and Build
|
### Alternative: Clone and Build
|
||||||
|
|
||||||
@@ -109,281 +106,34 @@ git clone https://github.com/bmadcode/bmad-method.git
|
|||||||
npm run install:bmad # build and install all to a destination folder
|
npm run install:bmad # build and install all to a destination folder
|
||||||
```
|
```
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by utilizing advanced prompt engineering techniques and critical context management at the most critical stages of development implementation. 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.
|
|
||||||
|
|
||||||
Unlike systems like Task Master, or inbuilt Task tools, the BMad Methods agile flow does so much more. With most systems, you give your idea, 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 prompt engineering advanced techniques to produce anything beyond what the average slop LLMs and Task generators will produce on their own. This truly is a system of Human in the Loop producing markedly better results.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
### Method 1: CLI Installer (For IDEs)
|
|
||||||
|
|
||||||
**Just run one command:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
# OR if you already have BMad installed:
|
|
||||||
npm run install:bmad
|
|
||||||
```
|
|
||||||
|
|
||||||
**This single command does everything:**
|
|
||||||
|
|
||||||
- Installs BMad for the first time
|
|
||||||
- Updates existing installations
|
|
||||||
- Adds any expansion packs from your package.json
|
|
||||||
|
|
||||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
|
||||||
|
|
||||||
### Method 2: Pre-Built Web Bundles (For Web UI)
|
|
||||||
|
|
||||||
For ChatGPT, Claude, or Gemini web interfaces:
|
|
||||||
|
|
||||||
1. Choose a bundle:
|
|
||||||
- **Recommended**: `dist/teams/team-fullstack.txt` (complete development team)
|
|
||||||
- Or pick from individual agents in `dist/agents/`
|
|
||||||
2. Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
|
|
||||||
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
||||||
4. Type `/help` to see available commands
|
|
||||||
|
|
||||||
**Supported IDEs:**
|
|
||||||
|
|
||||||
The BMad Method works with any IDE, but has built-in integration for:
|
|
||||||
|
|
||||||
- `cursor` - Cursor IDE with manual rule @agent commands
|
|
||||||
- `claude-code` - Claude Code 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`)
|
|
||||||
- `github-copilot` - GitHub Copilot agent mode integration
|
|
||||||
|
|
||||||
## Available Agents
|
|
||||||
|
|
||||||
### Core Development Team
|
|
||||||
|
|
||||||
| 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 |
|
|
||||||
|
|
||||||
### BMad Agents
|
|
||||||
|
|
||||||
| 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) |
|
|
||||||
|
|
||||||
## Advanced Features
|
|
||||||
|
|
||||||
### Dynamic Dependencies
|
|
||||||
|
|
||||||
Each agent only loads the resources it needs, keeping context windows lean.
|
|
||||||
|
|
||||||
### Template System
|
|
||||||
|
|
||||||
Rich templates for all document types:
|
|
||||||
|
|
||||||
- Product Requirements (PRD)
|
|
||||||
- Architecture Documents
|
|
||||||
- User Stories
|
|
||||||
- Test Plans
|
|
||||||
- And more...
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
### Slash Star Commands
|
|
||||||
|
|
||||||
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
|
||||||
|
|
||||||
### Advanced Elicitation
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
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)**.
|
|
||||||
|
|
||||||
### Quick Start Examples
|
|
||||||
|
|
||||||
#### With IDE Integration
|
|
||||||
|
|
||||||
```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
|
|
||||||
|
|
||||||
After uploading a bundle, type `/help` to see available commands.
|
|
||||||
|
|
||||||
### Key Resources
|
|
||||||
|
|
||||||
- **[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)** - V4's flexible project structure support
|
|
||||||
- **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
|
|
||||||
|
|
||||||
## Project Structure
|
|
||||||
|
|
||||||
See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
|
|
||||||
|
|
||||||
### Key Directories
|
|
||||||
|
|
||||||
- **`.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)
|
|
||||||
|
|
||||||
**All ready-to-use bundles are in the `dist/` directory!**
|
|
||||||
|
|
||||||
- **Teams**: `dist/teams/` - Complete team configurations
|
|
||||||
|
|
||||||
- `team-fullstack.txt` - Full-stack development team
|
|
||||||
- `team-ide-minimal.txt` - Minimal IDE workflow team
|
|
||||||
- `team-no-ui.txt` - Backend-only team
|
|
||||||
- `team-all.txt` - All agents included
|
|
||||||
|
|
||||||
- **Individual Agents**: `dist/agents/` - Single agent files
|
|
||||||
|
|
||||||
- One `.txt` file per agent (analyst, architect, dev, etc.)
|
|
||||||
|
|
||||||
- **Expansion Packs**: `dist/expansion-packs/` - Specialized domains
|
|
||||||
- Game development, DevOps, etc.
|
|
||||||
|
|
||||||
**For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
### IDE-Specific Guides
|
|
||||||
|
|
||||||
- 🎯 [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
|
|
||||||
- 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
|
||||||
|
|
||||||
## 🌟 Beyond Software Development - Expansion Packs
|
## 🌟 Beyond Software Development - Expansion Packs
|
||||||
|
|
||||||
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's natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMad-Method with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
|
||||||
|
|
||||||
### Available Expansion Packs
|
## Documentation & Resources
|
||||||
|
|
||||||
#### Technical Domains
|
### Essential Guides
|
||||||
|
|
||||||
- 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
|
- 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion
|
||||||
- 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
|
- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
|
||||||
- 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
|
- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
|
||||||
- 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
|
- [IDE Specific Guides available in this folder](docs/agentic-tools/)
|
||||||
|
|
||||||
#### 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, content creators, research assistants
|
|
||||||
|
|
||||||
### Creating Your Own Expansion Pack
|
|
||||||
|
|
||||||
Transform your expertise into AI agents:
|
|
||||||
|
|
||||||
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)** - Detailed examples, inspiration, and technical details
|
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
||||||
- 📖 [Documentation](docs/)
|
|
||||||
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
||||||
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
- 💬 [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
|
## Contributing
|
||||||
|
|
||||||
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
||||||
|
|
||||||
### Before Contributing - MUST READ
|
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
|
||||||
|
|
||||||
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
## License
|
||||||
|
|
||||||
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
MIT License - see [LICENSE](LICENSE) for details.
|
||||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMad powerful through simplicity
|
|
||||||
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
|
||||||
|
|
||||||
### Key Points to Remember
|
|
||||||
|
|
||||||
- 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 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 run build # rebuild the dist folder
|
|
||||||
npm run install:bmad # build and install all to a destination folder
|
|
||||||
```
|
|
||||||
|
|
||||||
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ commands:
|
|||||||
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
||||||
dependencies:
|
dependencies:
|
||||||
tasks:
|
tasks:
|
||||||
- brainstorming-techniques
|
- facilitate-brainstorming-session
|
||||||
- create-deep-research-prompt
|
- create-deep-research-prompt
|
||||||
- create-doc
|
- create-doc
|
||||||
- advanced-elicitation
|
- advanced-elicitation
|
||||||
@@ -60,8 +60,10 @@ dependencies:
|
|||||||
- project-brief-tmpl
|
- project-brief-tmpl
|
||||||
- market-research-tmpl
|
- market-research-tmpl
|
||||||
- competitor-analysis-tmpl
|
- competitor-analysis-tmpl
|
||||||
|
- brainstorming-output-tmpl
|
||||||
data:
|
data:
|
||||||
- bmad-kb
|
- bmad-kb
|
||||||
|
- brainstorming-techniques
|
||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -38,6 +38,7 @@ commands:
|
|||||||
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
||||||
- list {task|template|util|checklist|workflow}: List resources by type ONLY from the corresponding dependencies sub item below
|
- list {task|template|util|checklist|workflow}: List resources by type ONLY from the corresponding dependencies sub item below
|
||||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||||
|
- create-prd-alpha: Execute task create-doc2 with .bmad-core/templates/prd-tmpl2.yaml (EXPERIMENTAL)
|
||||||
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
||||||
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
||||||
- plan: Execute the task Create workflow plan
|
- plan: Execute the task Create workflow plan
|
||||||
@@ -59,12 +60,13 @@ execution:
|
|||||||
dependencies:
|
dependencies:
|
||||||
tasks:
|
tasks:
|
||||||
- advanced-elicitation
|
- advanced-elicitation
|
||||||
- brainstorming-techniques
|
- facilitate-brainstorming-session
|
||||||
- brownfield-create-epic
|
- brownfield-create-epic
|
||||||
- brownfield-create-story
|
- brownfield-create-story
|
||||||
- correct-course
|
- correct-course
|
||||||
- create-deep-research-prompt
|
- create-deep-research-prompt
|
||||||
- create-doc
|
- create-doc
|
||||||
|
- create-doc2
|
||||||
- create-workflow-plan
|
- create-workflow-plan
|
||||||
- document-project
|
- document-project
|
||||||
- create-next-story
|
- create-next-story
|
||||||
@@ -83,10 +85,12 @@ dependencies:
|
|||||||
- fullstack-architecture-tmpl
|
- fullstack-architecture-tmpl
|
||||||
- market-research-tmpl
|
- market-research-tmpl
|
||||||
- prd-tmpl
|
- prd-tmpl
|
||||||
|
- prd-tmpl2
|
||||||
- project-brief-tmpl
|
- project-brief-tmpl
|
||||||
- story-tmpl
|
- story-tmpl
|
||||||
data:
|
data:
|
||||||
- bmad-kb
|
- bmad-kb
|
||||||
|
- brainstorming-techniques
|
||||||
- technical-preferences
|
- technical-preferences
|
||||||
utils:
|
utils:
|
||||||
- plan-management
|
- plan-management
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ startup:
|
|||||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||||
- Mention *help shows all available commands and options
|
- Mention *help shows all available commands and options
|
||||||
- Check for active workflow plan using utils#plan-management
|
- Check for active workflow plan using {root}/utils/plan-management.md
|
||||||
- "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
|
- "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
|
||||||
- "If plan exists: Suggest next action based on plan progress"
|
- "If plan exists: Suggest next action based on plan progress"
|
||||||
- Assess user goal against available agents and workflows in this bundle
|
- Assess user goal against available agents and workflows in this bundle
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
version: 4.25.0
|
version: 4.26.0
|
||||||
markdownExploder: true
|
markdownExploder: true
|
||||||
prd:
|
prd:
|
||||||
prdFile: docs/prd.md
|
prdFile: docs/prd.md
|
||||||
|
|||||||
@@ -33,13 +33,15 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
|
|
||||||
### The Two-Phase Approach
|
### The Two-Phase Approach
|
||||||
|
|
||||||
**Phase 1: Planning (Web UI - Cost Effective)**
|
#### Phase 1: Planning (Web UI - Cost Effective)
|
||||||
|
|
||||||
- Use large context windows (Gemini's 1M tokens)
|
- Use large context windows (Gemini's 1M tokens)
|
||||||
- Generate comprehensive documents (PRD, Architecture)
|
- Generate comprehensive documents (PRD, Architecture)
|
||||||
- Leverage multiple agents for brainstorming
|
- Leverage multiple agents for brainstorming
|
||||||
- Create once, use throughout development
|
- Create once, use throughout development
|
||||||
|
|
||||||
**Phase 2: Development (IDE - Implementation)**
|
#### Phase 2: Development (IDE - Implementation)
|
||||||
|
|
||||||
- Shard documents into manageable pieces
|
- Shard documents into manageable pieces
|
||||||
- Execute focused SM → Dev cycles
|
- Execute focused SM → Dev cycles
|
||||||
- One story at a time, sequential progress
|
- One story at a time, sequential progress
|
||||||
@@ -69,6 +71,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
### Quick Start Options
|
### Quick Start Options
|
||||||
|
|
||||||
#### Option 1: Web UI
|
#### Option 1: Web UI
|
||||||
|
|
||||||
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
||||||
|
|
||||||
1. Navigate to `dist/teams/`
|
1. Navigate to `dist/teams/`
|
||||||
@@ -78,7 +81,8 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
5. Type `/help` to see available commands
|
5. Type `/help` to see available commands
|
||||||
|
|
||||||
#### Option 2: IDE Integration
|
#### Option 2: IDE Integration
|
||||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
||||||
|
**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Interactive installation (recommended)
|
# Interactive installation (recommended)
|
||||||
@@ -86,18 +90,21 @@ npx bmad-method install
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Installation Steps**:
|
**Installation Steps**:
|
||||||
|
|
||||||
- Choose "Complete installation"
|
- Choose "Complete installation"
|
||||||
- Select your IDE from supported options:
|
- Select your IDE from supported options:
|
||||||
- **Cursor**: Native AI integration
|
- **Cursor**: Native AI integration
|
||||||
- **Claude Code**: Anthropic's official IDE
|
- **Claude Code**: Anthropic's official IDE
|
||||||
- **Windsurf**: Built-in AI capabilities
|
- **Windsurf**: Built-in AI capabilities
|
||||||
|
- **Trae**: Built-in AI capabilities
|
||||||
- **Cline**: VS Code extension with AI features
|
- **Cline**: VS Code extension with AI features
|
||||||
- **Roo Code**: Web-based IDE with agent support
|
- **Roo Code**: Web-based IDE with agent support
|
||||||
- **Github Copilot**: AI-powered coding assistant
|
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
||||||
|
|
||||||
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
||||||
|
|
||||||
**Verify Installation**:
|
**Verify Installation**:
|
||||||
|
|
||||||
- `.bmad-core/` folder created with all agents
|
- `.bmad-core/` folder created with all agents
|
||||||
- IDE-specific integration files created
|
- IDE-specific integration files created
|
||||||
- All agent commands/rules/modes available
|
- All agent commands/rules/modes available
|
||||||
@@ -107,12 +114,14 @@ npx bmad-method install
|
|||||||
### Environment Selection Guide
|
### Environment Selection Guide
|
||||||
|
|
||||||
**Use Web UI for**:
|
**Use Web UI for**:
|
||||||
|
|
||||||
- Initial planning and documentation (PRD, architecture)
|
- Initial planning and documentation (PRD, architecture)
|
||||||
- Cost-effective document creation (especially with Gemini)
|
- Cost-effective document creation (especially with Gemini)
|
||||||
- Brainstorming and analysis phases
|
- Brainstorming and analysis phases
|
||||||
- Multi-agent consultation and planning
|
- Multi-agent consultation and planning
|
||||||
|
|
||||||
**Use IDE for**:
|
**Use IDE for**:
|
||||||
|
|
||||||
- Active development and coding
|
- Active development and coding
|
||||||
- File operations and project integration
|
- File operations and project integration
|
||||||
- Document sharding and story management
|
- Document sharding and story management
|
||||||
@@ -125,35 +134,41 @@ npx bmad-method install
|
|||||||
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
||||||
|
|
||||||
**Pros of IDE-Only**:
|
**Pros of IDE-Only**:
|
||||||
|
|
||||||
- Single environment workflow
|
- Single environment workflow
|
||||||
- Direct file operations from start
|
- Direct file operations from start
|
||||||
- No copy/paste between environments
|
- No copy/paste between environments
|
||||||
- Immediate project integration
|
- Immediate project integration
|
||||||
|
|
||||||
**Cons of IDE-Only**:
|
**Cons of IDE-Only**:
|
||||||
|
|
||||||
- Higher token costs for large document creation
|
- Higher token costs for large document creation
|
||||||
- Smaller context windows (varies by IDE/model)
|
- Smaller context windows (varies by IDE/model)
|
||||||
- May hit limits during planning phases
|
- May hit limits during planning phases
|
||||||
- Less cost-effective for brainstorming
|
- Less cost-effective for brainstorming
|
||||||
|
|
||||||
**Using Web Agents in IDE**:
|
**Using Web Agents in IDE**:
|
||||||
|
|
||||||
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
||||||
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
||||||
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
||||||
|
|
||||||
**About bmad-master and bmad-orchestrator**:
|
**About bmad-master and bmad-orchestrator**:
|
||||||
|
|
||||||
- **bmad-master**: CAN do any task without switching agents, BUT...
|
- **bmad-master**: CAN do any task without switching agents, BUT...
|
||||||
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
||||||
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
||||||
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
||||||
|
|
||||||
**CRITICAL RULE for Development**:
|
**CRITICAL RULE for Development**:
|
||||||
|
|
||||||
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
||||||
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
||||||
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
||||||
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
||||||
|
|
||||||
**Best Practice for IDE-Only**:
|
**Best Practice for IDE-Only**:
|
||||||
|
|
||||||
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
||||||
2. Create documents directly in project
|
2. Create documents directly in project
|
||||||
3. Shard immediately after creation
|
3. Shard immediately after creation
|
||||||
@@ -177,17 +192,20 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|||||||
### Key Configuration Areas
|
### Key Configuration Areas
|
||||||
|
|
||||||
#### PRD Configuration
|
#### PRD Configuration
|
||||||
|
|
||||||
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
||||||
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
||||||
- **prdShardedLocation**: Where to find sharded epic files
|
- **prdShardedLocation**: Where to find sharded epic files
|
||||||
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
||||||
|
|
||||||
#### Architecture Configuration
|
#### Architecture Configuration
|
||||||
|
|
||||||
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
||||||
- **architectureSharded**: Whether architecture is split into components
|
- **architectureSharded**: Whether architecture is split into components
|
||||||
- **architectureShardedLocation**: Where sharded architecture files live
|
- **architectureShardedLocation**: Where sharded architecture files live
|
||||||
|
|
||||||
#### Developer Files
|
#### Developer Files
|
||||||
|
|
||||||
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
||||||
- **devDebugLog**: Where dev agent logs repeated failures
|
- **devDebugLog**: Where dev agent logs repeated failures
|
||||||
- **agentCoreDump**: Export location for chat conversations
|
- **agentCoreDump**: Export location for chat conversations
|
||||||
@@ -202,6 +220,7 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|||||||
### Common Configurations
|
### Common Configurations
|
||||||
|
|
||||||
**Legacy V3 Project**:
|
**Legacy V3 Project**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prdVersion: v3
|
prdVersion: v3
|
||||||
prdSharded: false
|
prdSharded: false
|
||||||
@@ -210,6 +229,7 @@ architectureSharded: false
|
|||||||
```
|
```
|
||||||
|
|
||||||
**V4 Optimized Project**:
|
**V4 Optimized Project**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prdVersion: v4
|
prdVersion: v4
|
||||||
prdSharded: true
|
prdSharded: true
|
||||||
@@ -275,17 +295,21 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
#### IDE-Specific Syntax
|
#### IDE-Specific Syntax
|
||||||
|
|
||||||
**Agent Loading by IDE**:
|
**Agent Loading by IDE**:
|
||||||
|
|
||||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
|
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||||
|
|
||||||
**Chat Management Guidelines**:
|
**Chat Management Guidelines**:
|
||||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
||||||
|
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
||||||
- **Roo Code**: Switch modes within the same conversation
|
- **Roo Code**: Switch modes within the same conversation
|
||||||
|
|
||||||
**Common Task Commands**:
|
**Common Task Commands**:
|
||||||
|
|
||||||
- `*help` - Show available commands
|
- `*help` - Show available commands
|
||||||
- `*status` - Show current context/progress
|
- `*status` - Show current context/progress
|
||||||
- `*exit` - Exit the agent mode
|
- `*exit` - Exit the agent mode
|
||||||
@@ -294,6 +318,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
- `*create` - Run create-next-story task (SM agent)
|
- `*create` - Run create-next-story task (SM agent)
|
||||||
|
|
||||||
**In Web UI**:
|
**In Web UI**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
/pm create-doc prd
|
/pm create-doc prd
|
||||||
/architect review system design
|
/architect review system design
|
||||||
@@ -307,16 +332,19 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
### Pre-Built Teams
|
### Pre-Built Teams
|
||||||
|
|
||||||
#### Team All
|
#### Team All
|
||||||
|
|
||||||
- **Includes**: All 10 agents + orchestrator
|
- **Includes**: All 10 agents + orchestrator
|
||||||
- **Use Case**: Complete projects requiring all roles
|
- **Use Case**: Complete projects requiring all roles
|
||||||
- **Bundle**: `team-all.txt`
|
- **Bundle**: `team-all.txt`
|
||||||
|
|
||||||
#### Team Fullstack
|
#### Team Fullstack
|
||||||
|
|
||||||
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
||||||
- **Use Case**: End-to-end web/mobile development
|
- **Use Case**: End-to-end web/mobile development
|
||||||
- **Bundle**: `team-fullstack.txt`
|
- **Bundle**: `team-fullstack.txt`
|
||||||
|
|
||||||
#### Team No-UI
|
#### Team No-UI
|
||||||
|
|
||||||
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
||||||
- **Use Case**: Backend services, APIs, system development
|
- **Use Case**: Backend services, APIs, system development
|
||||||
- **Bundle**: `team-no-ui.txt`
|
- **Bundle**: `team-no-ui.txt`
|
||||||
@@ -330,22 +358,26 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
|||||||
### Key Architectural Components
|
### Key Architectural Components
|
||||||
|
|
||||||
#### 1. Agents (`bmad-core/agents/`)
|
#### 1. Agents (`bmad-core/agents/`)
|
||||||
|
|
||||||
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
||||||
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
||||||
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
||||||
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
||||||
|
|
||||||
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
||||||
|
|
||||||
- **Purpose**: Define collections of agents bundled together for specific purposes
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
||||||
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
||||||
- **Usage**: Creates pre-packaged contexts for web UI environments
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
||||||
|
|
||||||
#### 3. Workflows (`bmad-core/workflows/`)
|
#### 3. Workflows (`bmad-core/workflows/`)
|
||||||
|
|
||||||
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
||||||
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
||||||
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
||||||
|
|
||||||
#### 4. Reusable Resources
|
#### 4. Reusable Resources
|
||||||
|
|
||||||
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
||||||
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
||||||
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
||||||
@@ -362,7 +394,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
|||||||
|
|
||||||
#### Web UI Environment
|
#### Web UI Environment
|
||||||
|
|
||||||
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
|
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent
|
||||||
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
||||||
- Created by the web-builder tool for upload to web interfaces
|
- Created by the web-builder tool for upload to web interfaces
|
||||||
- Provides complete context in one package
|
- Provides complete context in one package
|
||||||
@@ -385,6 +417,7 @@ BMad employs a sophisticated template system with three key components:
|
|||||||
### Technical Preferences Integration
|
### Technical Preferences Integration
|
||||||
|
|
||||||
The `technical-preferences.md` file serves as a persistent technical profile that:
|
The `technical-preferences.md` file serves as a persistent technical profile that:
|
||||||
|
|
||||||
- Ensures consistency across all agents and projects
|
- Ensures consistency across all agents and projects
|
||||||
- Eliminates repetitive technology specification
|
- Eliminates repetitive technology specification
|
||||||
- Provides personalized recommendations aligned with user preferences
|
- Provides personalized recommendations aligned with user preferences
|
||||||
@@ -393,6 +426,7 @@ The `technical-preferences.md` file serves as a persistent technical profile tha
|
|||||||
### Build and Delivery Process
|
### Build and Delivery Process
|
||||||
|
|
||||||
The `web-builder.js` tool creates web-ready bundles by:
|
The `web-builder.js` tool creates web-ready bundles by:
|
||||||
|
|
||||||
1. Reading agent or team definition files
|
1. Reading agent or team definition files
|
||||||
2. Recursively resolving all dependencies
|
2. Recursively resolving all dependencies
|
||||||
3. Concatenating content into single text files with clear separators
|
3. Concatenating content into single text files with clear separators
|
||||||
@@ -407,11 +441,13 @@ This architecture enables seamless operation across environments while maintaini
|
|||||||
**Ideal for cost efficiency with Gemini's massive context:**
|
**Ideal for cost efficiency with Gemini's massive context:**
|
||||||
|
|
||||||
**For Brownfield Projects - Start Here!**:
|
**For Brownfield Projects - Start Here!**:
|
||||||
|
|
||||||
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
||||||
2. **Document existing system**: `/analyst` → `*document-project`
|
2. **Document existing system**: `/analyst` → `*document-project`
|
||||||
3. **Creates comprehensive docs** from entire codebase analysis
|
3. **Creates comprehensive docs** from entire codebase analysis
|
||||||
|
|
||||||
**For All Projects**:
|
**For All Projects**:
|
||||||
|
|
||||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||||
@@ -422,12 +458,14 @@ This architecture enables seamless operation across environments while maintaini
|
|||||||
#### Example Planning Prompts
|
#### Example Planning Prompts
|
||||||
|
|
||||||
**For PRD Creation**:
|
**For PRD Creation**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
"I want to build a [type] application that [core purpose].
|
"I want to build a [type] application that [core purpose].
|
||||||
Help me brainstorm features and create a comprehensive PRD."
|
Help me brainstorm features and create a comprehensive PRD."
|
||||||
```
|
```
|
||||||
|
|
||||||
**For Architecture Design**:
|
**For Architecture Design**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
"Based on this PRD, design a scalable technical architecture
|
"Based on this PRD, design a scalable technical architecture
|
||||||
that can handle [specific requirements]."
|
that can handle [specific requirements]."
|
||||||
@@ -445,7 +483,7 @@ that can handle [specific requirements]."
|
|||||||
|
|
||||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||||
|
|
||||||
1. **Document Sharding** (CRITICAL STEP):
|
1. **Document Sharding** (CRITICAL STEP):
|
||||||
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
||||||
- Two methods to shard:
|
- Two methods to shard:
|
||||||
a) **Manual**: Drag `shard-doc` task + document file into chat
|
a) **Manual**: Drag `shard-doc` task + document file into chat
|
||||||
@@ -459,32 +497,33 @@ that can handle [specific requirements]."
|
|||||||
- Source tree document and coding standards for dev agent reference
|
- Source tree document and coding standards for dev agent reference
|
||||||
- Sharded docs for SM agent story creation
|
- Sharded docs for SM agent story creation
|
||||||
|
|
||||||
**Resulting Folder Structure**:
|
Resulting Folder Structure:
|
||||||
|
|
||||||
- `docs/prd/` - Broken down PRD sections
|
- `docs/prd/` - Broken down PRD sections
|
||||||
- `docs/architecture/` - Broken down architecture sections
|
- `docs/architecture/` - Broken down architecture sections
|
||||||
- `docs/stories/` - Generated user stories
|
- `docs/stories/` - Generated user stories
|
||||||
|
|
||||||
3. **Development Cycle** (Sequential, one story at a time):
|
1. **Development Cycle** (Sequential, one story at a time):
|
||||||
|
|
||||||
**CRITICAL CONTEXT MANAGEMENT**:
|
**CRITICAL CONTEXT MANAGEMENT**:
|
||||||
- **Context windows matter!** Always use fresh, clean context windows
|
- **Context windows matter!** Always use fresh, clean context windows
|
||||||
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
||||||
- **ALWAYS start new chat between SM, Dev, and QA work**
|
- **ALWAYS start new chat between SM, Dev, and QA work**
|
||||||
|
|
||||||
**Step 1 - Story Creation**:
|
**Step 1 - Story Creation**:
|
||||||
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
||||||
- SM executes create-next-story task
|
- SM executes create-next-story task
|
||||||
- Review generated story in `docs/stories/`
|
- Review generated story in `docs/stories/`
|
||||||
- Update status from "Draft" to "Approved"
|
- Update status from "Draft" to "Approved"
|
||||||
|
|
||||||
**Step 2 - Story Implementation**:
|
**Step 2 - Story Implementation**:
|
||||||
- **NEW CLEAN CHAT** → `@dev`
|
- **NEW CLEAN CHAT** → `@dev`
|
||||||
- Agent asks which story to implement
|
- Agent asks which story to implement
|
||||||
- Include story file content to save dev agent lookup time
|
- Include story file content to save dev agent lookup time
|
||||||
- Dev follows tasks/subtasks, marking completion
|
- Dev follows tasks/subtasks, marking completion
|
||||||
- Dev maintains File List of all changes
|
- Dev maintains File List of all changes
|
||||||
- Dev marks story as "Review" when complete with all tests passing
|
- Dev marks story as "Review" when complete with all tests passing
|
||||||
|
|
||||||
**Step 3 - Senior QA Review**:
|
**Step 3 - Senior QA Review**:
|
||||||
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
||||||
- QA performs senior developer code review
|
- QA performs senior developer code review
|
||||||
@@ -492,7 +531,7 @@ that can handle [specific requirements]."
|
|||||||
- QA appends results to story's QA Results section
|
- QA appends results to story's QA Results section
|
||||||
- If approved: Status → "Done"
|
- If approved: Status → "Done"
|
||||||
- If changes needed: Status stays "Review" with unchecked items for dev
|
- If changes needed: Status stays "Review" with unchecked items for dev
|
||||||
|
|
||||||
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
||||||
|
|
||||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||||
@@ -500,6 +539,7 @@ that can handle [specific requirements]."
|
|||||||
### Status Tracking Workflow
|
### Status Tracking Workflow
|
||||||
|
|
||||||
Stories progress through defined statuses:
|
Stories progress through defined statuses:
|
||||||
|
|
||||||
- **Draft** → **Approved** → **InProgress** → **Done**
|
- **Draft** → **Approved** → **InProgress** → **Done**
|
||||||
|
|
||||||
Each status change requires user verification and approval before proceeding.
|
Each status change requires user verification and approval before proceeding.
|
||||||
@@ -507,6 +547,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
### Workflow Types
|
### Workflow Types
|
||||||
|
|
||||||
#### Greenfield Development
|
#### Greenfield Development
|
||||||
|
|
||||||
- Business analysis and market research
|
- Business analysis and market research
|
||||||
- Product requirements and feature definition
|
- Product requirements and feature definition
|
||||||
- System architecture and design
|
- System architecture and design
|
||||||
@@ -520,6 +561,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**Complete Brownfield Workflow Options**:
|
**Complete Brownfield Workflow Options**:
|
||||||
|
|
||||||
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
||||||
|
|
||||||
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
||||||
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
||||||
3. **Focused documentation**: `@analyst` → `*document-project`
|
3. **Focused documentation**: `@analyst` → `*document-project`
|
||||||
@@ -530,18 +572,19 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
- Avoids bloating docs with unused code
|
- Avoids bloating docs with unused code
|
||||||
|
|
||||||
**Option 2: Document-First (Good for Smaller Projects)**:
|
**Option 2: Document-First (Good for Smaller Projects)**:
|
||||||
|
|
||||||
1. **Upload project to Gemini Web**
|
1. **Upload project to Gemini Web**
|
||||||
2. **Document everything**: `@analyst` → `*document-project`
|
2. **Document everything**: `@analyst` → `*document-project`
|
||||||
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
||||||
- More thorough but can create excessive documentation
|
- More thorough but can create excessive documentation
|
||||||
|
|
||||||
2. **Requirements Gathering**:
|
4. **Requirements Gathering**:
|
||||||
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
||||||
- **Analyzes**: Existing system, constraints, integration points
|
- **Analyzes**: Existing system, constraints, integration points
|
||||||
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
||||||
- **Creates**: Epic and story structure for changes
|
- **Creates**: Epic and story structure for changes
|
||||||
|
|
||||||
3. **Architecture Planning**:
|
5. **Architecture Planning**:
|
||||||
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
||||||
- **Integration Strategy**: How new features integrate with existing system
|
- **Integration Strategy**: How new features integrate with existing system
|
||||||
- **Migration Planning**: Gradual rollout and backwards compatibility
|
- **Migration Planning**: Gradual rollout and backwards compatibility
|
||||||
@@ -550,10 +593,12 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**Brownfield-Specific Resources**:
|
**Brownfield-Specific Resources**:
|
||||||
|
|
||||||
**Templates**:
|
**Templates**:
|
||||||
|
|
||||||
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
||||||
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
||||||
|
|
||||||
**Tasks**:
|
**Tasks**:
|
||||||
|
|
||||||
- `document-project`: Generates comprehensive documentation from existing codebase
|
- `document-project`: Generates comprehensive documentation from existing codebase
|
||||||
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
||||||
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
||||||
@@ -561,18 +606,21 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**When to Use Each Approach**:
|
**When to Use Each Approach**:
|
||||||
|
|
||||||
**Full Brownfield Workflow** (Recommended for):
|
**Full Brownfield Workflow** (Recommended for):
|
||||||
|
|
||||||
- Major feature additions
|
- Major feature additions
|
||||||
- System modernization
|
- System modernization
|
||||||
- Complex integrations
|
- Complex integrations
|
||||||
- Multiple related changes
|
- Multiple related changes
|
||||||
|
|
||||||
**Quick Epic/Story Creation** (Use when):
|
**Quick Epic/Story Creation** (Use when):
|
||||||
|
|
||||||
- Single, focused enhancement
|
- Single, focused enhancement
|
||||||
- Isolated bug fixes
|
- Isolated bug fixes
|
||||||
- Small feature additions
|
- Small feature additions
|
||||||
- Well-documented existing system
|
- Well-documented existing system
|
||||||
|
|
||||||
**Critical Success Factors**:
|
**Critical Success Factors**:
|
||||||
|
|
||||||
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
||||||
2. **Context Matters**: Provide agents access to relevant code sections
|
2. **Context Matters**: Provide agents access to relevant code sections
|
||||||
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
||||||
@@ -588,6 +636,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
- `docs/architecture.md` - System Architecture Document
|
- `docs/architecture.md` - System Architecture Document
|
||||||
|
|
||||||
**Why These Names Matter**:
|
**Why These Names Matter**:
|
||||||
|
|
||||||
- Agents automatically reference these files during development
|
- Agents automatically reference these files during development
|
||||||
- Sharding tasks expect these specific filenames
|
- Sharding tasks expect these specific filenames
|
||||||
- Workflow automation depends on standard naming
|
- Workflow automation depends on standard naming
|
||||||
@@ -606,6 +655,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
Templates with Level 2 headings (`##`) can be automatically sharded:
|
Templates with Level 2 headings (`##`) can be automatically sharded:
|
||||||
|
|
||||||
**Original PRD**:
|
**Original PRD**:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## Goals and Background Context
|
## Goals and Background Context
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -614,6 +664,7 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|||||||
```
|
```
|
||||||
|
|
||||||
**After Sharding**:
|
**After Sharding**:
|
||||||
|
|
||||||
- `docs/prd/goals-and-background-context.md`
|
- `docs/prd/goals-and-background-context.md`
|
||||||
- `docs/prd/requirements.md`
|
- `docs/prd/requirements.md`
|
||||||
- `docs/prd/user-interface-design-goals.md`
|
- `docs/prd/user-interface-design-goals.md`
|
||||||
@@ -626,12 +677,14 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|||||||
### Environment-Specific Usage
|
### Environment-Specific Usage
|
||||||
|
|
||||||
**Web UI Best For**:
|
**Web UI Best For**:
|
||||||
|
|
||||||
- Initial planning and documentation phases
|
- Initial planning and documentation phases
|
||||||
- Cost-effective large document creation
|
- Cost-effective large document creation
|
||||||
- Agent consultation and brainstorming
|
- Agent consultation and brainstorming
|
||||||
- Multi-agent workflows with orchestrator
|
- Multi-agent workflows with orchestrator
|
||||||
|
|
||||||
**IDE Best For**:
|
**IDE Best For**:
|
||||||
|
|
||||||
- Active development and implementation
|
- Active development and implementation
|
||||||
- File operations and project integration
|
- File operations and project integration
|
||||||
- Story management and development cycles
|
- Story management and development cycles
|
||||||
@@ -666,6 +719,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|||||||
For full details, see `CONTRIBUTING.md`. Key points:
|
For full details, see `CONTRIBUTING.md`. Key points:
|
||||||
|
|
||||||
**Fork Workflow**:
|
**Fork Workflow**:
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Create feature branches
|
2. Create feature branches
|
||||||
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
||||||
@@ -673,12 +727,14 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|||||||
5. One feature/fix per PR
|
5. One feature/fix per PR
|
||||||
|
|
||||||
**PR Requirements**:
|
**PR Requirements**:
|
||||||
|
|
||||||
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
||||||
- Use conventional commits (feat:, fix:, docs:)
|
- Use conventional commits (feat:, fix:, docs:)
|
||||||
- Atomic commits - one logical change per commit
|
- Atomic commits - one logical change per commit
|
||||||
- Must align with guiding principles
|
- Must align with guiding principles
|
||||||
|
|
||||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||||
|
|
||||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||||
- **Natural Language First**: Everything in markdown, no code in core
|
- **Natural Language First**: Everything in markdown, no code in core
|
||||||
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
||||||
@@ -700,12 +756,14 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
### Available Expansion Packs
|
### Available Expansion Packs
|
||||||
|
|
||||||
**Technical Packs**:
|
**Technical Packs**:
|
||||||
|
|
||||||
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
||||||
- **Game Development**: Game designers, level designers, narrative writers
|
- **Game Development**: Game designers, level designers, narrative writers
|
||||||
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
||||||
- **Data Science**: ML engineers, data scientists, visualization experts
|
- **Data Science**: ML engineers, data scientists, visualization experts
|
||||||
|
|
||||||
**Non-Technical Packs**:
|
**Non-Technical Packs**:
|
||||||
|
|
||||||
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
||||||
- **Creative Writing**: Plot architects, character developers, world builders
|
- **Creative Writing**: Plot architects, character developers, world builders
|
||||||
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
||||||
@@ -713,6 +771,7 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
- **Legal Support**: Contract analysts, compliance checkers
|
- **Legal Support**: Contract analysts, compliance checkers
|
||||||
|
|
||||||
**Specialty Packs**:
|
**Specialty Packs**:
|
||||||
|
|
||||||
- **Expansion Creator**: Tools to build your own expansion packs
|
- **Expansion Creator**: Tools to build your own expansion packs
|
||||||
- **RPG Game Master**: Tabletop gaming assistance
|
- **RPG Game Master**: Tabletop gaming assistance
|
||||||
- **Life Event Planning**: Wedding planners, event coordinators
|
- **Life Event Planning**: Wedding planners, event coordinators
|
||||||
@@ -722,11 +781,13 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
|
|
||||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||||
3. **Install via CLI**:
|
3. **Install via CLI**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method install
|
npx bmad-method install
|
||||||
# Select "Install expansion pack" option
|
# Select "Install expansion pack" option
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
||||||
|
|
||||||
### Creating Custom Expansion Packs
|
### Creating Custom Expansion Packs
|
||||||
|
|||||||
36
bmad-core/data/brainstorming-techniques.md
Normal file
36
bmad-core/data/brainstorming-techniques.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Brainstorming Techniques Data
|
||||||
|
|
||||||
|
## Creative Expansion
|
||||||
|
|
||||||
|
1. **What If Scenarios**: Ask one provocative question, get their response, then ask another
|
||||||
|
2. **Analogical Thinking**: Give one example analogy, ask them to find 2-3 more
|
||||||
|
3. **Reversal/Inversion**: Pose the reverse question, let them work through it
|
||||||
|
4. **First Principles Thinking**: Ask "What are the fundamentals?" and guide them to break it down
|
||||||
|
|
||||||
|
## Structured Frameworks
|
||||||
|
|
||||||
|
5. **SCAMPER Method**: Go through one letter at a time, wait for their ideas before moving to next
|
||||||
|
6. **Six Thinking Hats**: Present one hat, ask for their thoughts, then move to next hat
|
||||||
|
7. **Mind Mapping**: Start with central concept, ask them to suggest branches
|
||||||
|
|
||||||
|
## Collaborative Techniques
|
||||||
|
|
||||||
|
8. **"Yes, And..." Building**: They give idea, you "yes and" it, they "yes and" back - alternate
|
||||||
|
9. **Brainwriting/Round Robin**: They suggest idea, you build on it, ask them to build on yours
|
||||||
|
10. **Random Stimulation**: Give one random prompt/word, ask them to make connections
|
||||||
|
|
||||||
|
## Deep Exploration
|
||||||
|
|
||||||
|
11. **Five Whys**: Ask "why" and wait for their answer before asking next "why"
|
||||||
|
12. **Morphological Analysis**: Ask them to list parameters first, then explore combinations together
|
||||||
|
13. **Provocation Technique (PO)**: Give one provocative statement, ask them to extract useful ideas
|
||||||
|
|
||||||
|
## Advanced Techniques
|
||||||
|
|
||||||
|
14. **Forced Relationships**: Connect two unrelated concepts and ask them to find the bridge
|
||||||
|
15. **Assumption Reversal**: Challenge their core assumptions and ask them to build from there
|
||||||
|
16. **Role Playing**: Ask them to brainstorm from different stakeholder perspectives
|
||||||
|
17. **Time Shifting**: "How would you solve this in 1995? 2030?"
|
||||||
|
18. **Resource Constraints**: "What if you had only $10 and 1 hour?"
|
||||||
|
19. **Metaphor Mapping**: Use extended metaphors to explore solutions
|
||||||
|
20. **Question Storming**: Generate questions instead of answers first
|
||||||
134
bmad-core/data/elicitation-methods.md
Normal file
134
bmad-core/data/elicitation-methods.md
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
# Elicitation Methods Data
|
||||||
|
|
||||||
|
## Core Reflective Methods
|
||||||
|
|
||||||
|
**Expand or Contract for Audience**
|
||||||
|
- Ask whether to 'expand' (add detail, elaborate) or 'contract' (simplify, clarify)
|
||||||
|
- Identify specific target audience if relevant
|
||||||
|
- Tailor content complexity and depth accordingly
|
||||||
|
|
||||||
|
**Explain Reasoning (CoT Step-by-Step)**
|
||||||
|
- Walk through the step-by-step thinking process
|
||||||
|
- Reveal underlying assumptions and decision points
|
||||||
|
- Show how conclusions were reached from current role's perspective
|
||||||
|
|
||||||
|
**Critique and Refine**
|
||||||
|
- Review output for flaws, inconsistencies, or improvement areas
|
||||||
|
- Identify specific weaknesses from role's expertise
|
||||||
|
- Suggest refined version reflecting domain knowledge
|
||||||
|
|
||||||
|
## Structural Analysis Methods
|
||||||
|
|
||||||
|
**Analyze Logical Flow and Dependencies**
|
||||||
|
- Examine content structure for logical progression
|
||||||
|
- Check internal consistency and coherence
|
||||||
|
- Identify and validate dependencies between elements
|
||||||
|
- Confirm effective ordering and sequencing
|
||||||
|
|
||||||
|
**Assess Alignment with Overall Goals**
|
||||||
|
- Evaluate content contribution to stated objectives
|
||||||
|
- Identify any misalignments or gaps
|
||||||
|
- Interpret alignment from specific role's perspective
|
||||||
|
- Suggest adjustments to better serve goals
|
||||||
|
|
||||||
|
## Risk and Challenge Methods
|
||||||
|
|
||||||
|
**Identify Potential Risks and Unforeseen Issues**
|
||||||
|
- Brainstorm potential risks from role's expertise
|
||||||
|
- Identify overlooked edge cases or scenarios
|
||||||
|
- Anticipate unintended consequences
|
||||||
|
- Highlight implementation challenges
|
||||||
|
|
||||||
|
**Challenge from Critical Perspective**
|
||||||
|
- Adopt critical stance on current content
|
||||||
|
- Play devil's advocate from specified viewpoint
|
||||||
|
- Argue against proposal highlighting weaknesses
|
||||||
|
- Apply YAGNI principles when appropriate (scope trimming)
|
||||||
|
|
||||||
|
## Creative Exploration Methods
|
||||||
|
|
||||||
|
**Tree of Thoughts Deep Dive**
|
||||||
|
- Break problem into discrete "thoughts" or intermediate steps
|
||||||
|
- Explore multiple reasoning paths simultaneously
|
||||||
|
- Use self-evaluation to classify each path as "sure", "likely", or "impossible"
|
||||||
|
- Apply search algorithms (BFS/DFS) to find optimal solution paths
|
||||||
|
|
||||||
|
**Hindsight is 20/20: The 'If Only...' Reflection**
|
||||||
|
- Imagine retrospective scenario based on current content
|
||||||
|
- Identify the one "if only we had known/done X..." insight
|
||||||
|
- Describe imagined consequences humorously or dramatically
|
||||||
|
- Extract actionable learnings for current context
|
||||||
|
|
||||||
|
## Multi-Persona Collaboration Methods
|
||||||
|
|
||||||
|
**Agile Team Perspective Shift**
|
||||||
|
- Rotate through different Scrum team member viewpoints
|
||||||
|
- Product Owner: Focus on user value and business impact
|
||||||
|
- Scrum Master: Examine process flow and team dynamics
|
||||||
|
- Developer: Assess technical implementation and complexity
|
||||||
|
- QA: Identify testing scenarios and quality concerns
|
||||||
|
|
||||||
|
**Stakeholder Round Table**
|
||||||
|
- Convene virtual meeting with multiple personas
|
||||||
|
- Each persona contributes unique perspective on content
|
||||||
|
- Identify conflicts and synergies between viewpoints
|
||||||
|
- Synthesize insights into actionable recommendations
|
||||||
|
|
||||||
|
**Meta-Prompting Analysis**
|
||||||
|
- Step back to analyze the structure and logic of current approach
|
||||||
|
- Question the format and methodology being used
|
||||||
|
- Suggest alternative frameworks or mental models
|
||||||
|
- Optimize the elicitation process itself
|
||||||
|
|
||||||
|
## Advanced 2025 Techniques
|
||||||
|
|
||||||
|
**Self-Consistency Validation**
|
||||||
|
- Generate multiple reasoning paths for same problem
|
||||||
|
- Compare consistency across different approaches
|
||||||
|
- Identify most reliable and robust solution
|
||||||
|
- Highlight areas where approaches diverge and why
|
||||||
|
|
||||||
|
**ReWOO (Reasoning Without Observation)**
|
||||||
|
- Separate parametric reasoning from tool-based actions
|
||||||
|
- Create reasoning plan without external dependencies
|
||||||
|
- Identify what can be solved through pure reasoning
|
||||||
|
- Optimize for efficiency and reduced token usage
|
||||||
|
|
||||||
|
**Persona-Pattern Hybrid**
|
||||||
|
- Combine specific role expertise with elicitation pattern
|
||||||
|
- Architect + Risk Analysis: Deep technical risk assessment
|
||||||
|
- UX Expert + User Journey: End-to-end experience critique
|
||||||
|
- PM + Stakeholder Analysis: Multi-perspective impact review
|
||||||
|
|
||||||
|
**Emergent Collaboration Discovery**
|
||||||
|
- Allow multiple perspectives to naturally emerge
|
||||||
|
- Identify unexpected insights from persona interactions
|
||||||
|
- Explore novel combinations of viewpoints
|
||||||
|
- Capture serendipitous discoveries from multi-agent thinking
|
||||||
|
|
||||||
|
## Game-Based Elicitation Methods
|
||||||
|
|
||||||
|
**Red Team vs Blue Team**
|
||||||
|
- Red Team: Attack the proposal, find vulnerabilities
|
||||||
|
- Blue Team: Defend and strengthen the approach
|
||||||
|
- Competitive analysis reveals blind spots
|
||||||
|
- Results in more robust, battle-tested solutions
|
||||||
|
|
||||||
|
**Innovation Tournament**
|
||||||
|
- Pit multiple alternative approaches against each other
|
||||||
|
- Score each approach across different criteria
|
||||||
|
- Crowd-source evaluation from different personas
|
||||||
|
- Identify winning combination of features
|
||||||
|
|
||||||
|
**Escape Room Challenge**
|
||||||
|
- Present content as constraints to work within
|
||||||
|
- Find creative solutions within tight limitations
|
||||||
|
- Identify minimum viable approach
|
||||||
|
- Discover innovative workarounds and optimizations
|
||||||
|
|
||||||
|
## Process Control
|
||||||
|
|
||||||
|
**Proceed / No Further Actions**
|
||||||
|
- Acknowledge choice to finalize current work
|
||||||
|
- Accept output as-is or move to next step
|
||||||
|
- Prepare to continue without additional elicitation
|
||||||
@@ -5,88 +5,113 @@
|
|||||||
- Provide optional reflective and brainstorming actions to enhance content quality
|
- Provide optional reflective and brainstorming actions to enhance content quality
|
||||||
- Enable deeper exploration of ideas through structured elicitation techniques
|
- Enable deeper exploration of ideas through structured elicitation techniques
|
||||||
- Support iterative refinement through multiple analytical perspectives
|
- Support iterative refinement through multiple analytical perspectives
|
||||||
|
- Usable during template-driven document creation or any chat conversation
|
||||||
|
|
||||||
|
## Usage Scenarios
|
||||||
|
|
||||||
|
### Scenario 1: Template Document Creation
|
||||||
|
|
||||||
|
After outputting a section during document creation:
|
||||||
|
|
||||||
|
1. **Section Review**: Ask user to review the drafted section
|
||||||
|
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
||||||
|
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
||||||
|
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
||||||
|
|
||||||
|
### Scenario 2: General Chat Elicitation
|
||||||
|
|
||||||
|
User can request advanced elicitation on any agent output:
|
||||||
|
|
||||||
|
- User says "do advanced elicitation" or similar
|
||||||
|
- Agent selects 9 relevant methods for the context
|
||||||
|
- Same simple 0-9 selection process
|
||||||
|
|
||||||
## Task Instructions
|
## Task Instructions
|
||||||
|
|
||||||
### 1. Section Context and Review
|
### 1. Intelligent Method Selection
|
||||||
|
|
||||||
[[LLM: When invoked after outputting a section:
|
**Context Analysis**: Before presenting options, analyze:
|
||||||
|
|
||||||
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
|
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
||||||
|
- **Complexity Level**: Simple, moderate, or complex content
|
||||||
|
- **Stakeholder Needs**: Who will use this information
|
||||||
|
- **Risk Level**: High-impact decisions vs routine items
|
||||||
|
- **Creative Potential**: Opportunities for innovation or alternatives
|
||||||
|
|
||||||
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
|
**Method Selection Strategy**:
|
||||||
|
|
||||||
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
|
1. **Always Include Core Methods** (choose 3-4):
|
||||||
|
- Expand or Contract for Audience
|
||||||
|
- Critique and Refine
|
||||||
|
- Identify Potential Risks
|
||||||
|
- Assess Alignment with Goals
|
||||||
|
|
||||||
|
2. **Context-Specific Methods** (choose 4-5):
|
||||||
|
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
||||||
|
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
||||||
|
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
||||||
|
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
||||||
|
|
||||||
|
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
||||||
|
|
||||||
|
### 2. Section Context and Review
|
||||||
|
|
||||||
|
When invoked after outputting a section:
|
||||||
|
|
||||||
|
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
||||||
|
|
||||||
|
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
||||||
|
|
||||||
|
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
||||||
- The entire section as a whole
|
- The entire section as a whole
|
||||||
- Individual items within the section (specify which item when selecting an action)
|
- Individual items within the section (specify which item when selecting an action)
|
||||||
|
|
||||||
4. Then present the action list as specified below.]]
|
### 3. Present Elicitation Options
|
||||||
|
|
||||||
### 2. Ask for Review and Present Action List
|
**Review Request Process:**
|
||||||
|
|
||||||
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
|
- Ask the user to review the drafted section
|
||||||
|
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
||||||
|
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
||||||
|
- Keep descriptions short - just the method name
|
||||||
|
- Await simple numeric selection
|
||||||
|
|
||||||
**Present the numbered list (0-9) with this exact format:**
|
**Action List Presentation Format:**
|
||||||
|
|
||||||
```text
|
```text
|
||||||
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
**Advanced Elicitation Options**
|
||||||
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
Choose a number (0-8) or 9 to proceed:
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
0. [Method Name]
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
1. [Method Name]
|
||||||
2. Critique and Refine
|
2. [Method Name]
|
||||||
3. Analyze Logical Flow and Dependencies
|
3. [Method Name]
|
||||||
4. Assess Alignment with Overall Goals
|
4. [Method Name]
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
5. [Method Name]
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
6. [Method Name]
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
7. [Method Name]
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
8. [Method Name]
|
||||||
9. Proceed / No Further Actions
|
9. Proceed / No Further Actions
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Processing Guidelines
|
**Response Handling:**
|
||||||
|
|
||||||
**Do NOT show:**
|
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
||||||
|
- **Number 9**: Proceed to next section or continue conversation
|
||||||
|
- **Direct Feedback**: Apply user's suggested changes and continue
|
||||||
|
|
||||||
- The full protocol text with `[[LLM: ...]]` instructions
|
### 4. Method Execution Framework
|
||||||
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
|
||||||
- Any internal template markup
|
|
||||||
|
|
||||||
**After user selection from the list:**
|
**Execution Process:**
|
||||||
|
|
||||||
- Execute the chosen action according to the protocol instructions below
|
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
||||||
- Ask if they want to select another action or proceed with option 9 once complete
|
2. **Apply Context**: Execute the method from your current role's perspective
|
||||||
- Continue until user selects option 9 or indicates completion
|
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
||||||
|
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
||||||
|
|
||||||
## Action Definitions
|
**Execution Guidelines:**
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
||||||
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
||||||
|
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
- **Maintain Flow**: Keep the process moving efficiently
|
||||||
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
|
|
||||||
|
|
||||||
2. Critique and Refine
|
|
||||||
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
|
||||||
|
|
||||||
3. Analyze Logical Flow and Dependencies
|
|
||||||
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
|
||||||
|
|
||||||
4. Assess Alignment with Overall Goals
|
|
||||||
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
|
|
||||||
|
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
|
||||||
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
|
||||||
|
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
|
||||||
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
|
|
||||||
|
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
|
||||||
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
|
||||||
|
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
|
||||||
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
|
|
||||||
|
|
||||||
9. Proceed / No Further Actions
|
|
||||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
|
||||||
|
|||||||
@@ -1,238 +0,0 @@
|
|||||||
# Brainstorming Techniques Task
|
|
||||||
|
|
||||||
This task provides a comprehensive toolkit of creative brainstorming techniques for ideation and innovative thinking. The analyst can use these techniques to facilitate productive brainstorming sessions with users.
|
|
||||||
|
|
||||||
## Process
|
|
||||||
|
|
||||||
### 1. Session Setup
|
|
||||||
|
|
||||||
[[LLM: Begin by understanding the brainstorming context and goals. Ask clarifying questions if needed to determine the best approach.]]
|
|
||||||
|
|
||||||
1. **Establish Context**
|
|
||||||
|
|
||||||
- Understand the problem space or opportunity area
|
|
||||||
- Identify any constraints or parameters
|
|
||||||
- Determine session goals (divergent exploration vs. focused ideation)
|
|
||||||
|
|
||||||
2. **Select Technique Approach**
|
|
||||||
- Option A: User selects specific techniques
|
|
||||||
- Option B: Analyst recommends techniques based on context
|
|
||||||
- Option C: Random technique selection for creative variety
|
|
||||||
- Option D: Progressive technique flow (start broad, narrow down)
|
|
||||||
|
|
||||||
### 2. Core Brainstorming Techniques
|
|
||||||
|
|
||||||
#### Creative Expansion Techniques
|
|
||||||
|
|
||||||
1. **"What If" Scenarios**
|
|
||||||
[[LLM: Generate provocative what-if questions that challenge assumptions and expand thinking beyond current limitations.]]
|
|
||||||
|
|
||||||
- What if we had unlimited resources?
|
|
||||||
- What if this problem didn't exist?
|
|
||||||
- What if we approached this from a child's perspective?
|
|
||||||
- What if we had to solve this in 24 hours?
|
|
||||||
|
|
||||||
2. **Analogical Thinking**
|
|
||||||
[[LLM: Help user draw parallels between their challenge and other domains, industries, or natural systems.]]
|
|
||||||
|
|
||||||
- "How might this work like [X] but for [Y]?"
|
|
||||||
- Nature-inspired solutions (biomimicry)
|
|
||||||
- Cross-industry pattern matching
|
|
||||||
- Historical precedent analysis
|
|
||||||
|
|
||||||
3. **Reversal/Inversion**
|
|
||||||
[[LLM: Flip the problem or approach it from the opposite angle to reveal new insights.]]
|
|
||||||
|
|
||||||
- What if we did the exact opposite?
|
|
||||||
- How could we make this problem worse? (then reverse)
|
|
||||||
- Start from the end goal and work backward
|
|
||||||
- Reverse roles or perspectives
|
|
||||||
|
|
||||||
4. **First Principles Thinking**
|
|
||||||
[[LLM: Break down to fundamental truths and rebuild from scratch.]]
|
|
||||||
- What are the absolute fundamentals here?
|
|
||||||
- What assumptions can we challenge?
|
|
||||||
- If we started from zero, what would we build?
|
|
||||||
- What laws of physics/economics/human nature apply?
|
|
||||||
|
|
||||||
#### Structured Ideation Frameworks
|
|
||||||
|
|
||||||
1. **SCAMPER Method**
|
|
||||||
[[LLM: Guide through each SCAMPER prompt systematically.]]
|
|
||||||
|
|
||||||
- **S** = Substitute: What can be substituted?
|
|
||||||
- **C** = Combine: What can be combined or integrated?
|
|
||||||
- **A** = Adapt: What can be adapted from elsewhere?
|
|
||||||
- **M** = Modify/Magnify: What can be emphasized or reduced?
|
|
||||||
- **P** = Put to other uses: What else could this be used for?
|
|
||||||
- **E** = Eliminate: What can be removed or simplified?
|
|
||||||
- **R**= Reverse/Rearrange: What can be reversed or reordered?
|
|
||||||
|
|
||||||
2. **Six Thinking Hats**
|
|
||||||
[[LLM: Cycle through different thinking modes, spending focused time in each.]]
|
|
||||||
|
|
||||||
- White Hat: Facts and information
|
|
||||||
- Red Hat: Emotions and intuition
|
|
||||||
- Black Hat: Caution and critical thinking
|
|
||||||
- Yellow Hat: Optimism and benefits
|
|
||||||
- Green Hat: Creativity and alternatives
|
|
||||||
- Blue Hat: Process and control
|
|
||||||
|
|
||||||
3. **Mind Mapping**
|
|
||||||
[[LLM: Create text-based mind maps with clear hierarchical structure.]]
|
|
||||||
|
|
||||||
```plaintext
|
|
||||||
Central Concept
|
|
||||||
├── Branch 1
|
|
||||||
│ ├── Sub-idea 1.1
|
|
||||||
│ └── Sub-idea 1.2
|
|
||||||
├── Branch 2
|
|
||||||
│ ├── Sub-idea 2.1
|
|
||||||
│ └── Sub-idea 2.2
|
|
||||||
└── Branch 3
|
|
||||||
└── Sub-idea 3.1
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Collaborative Techniques
|
|
||||||
|
|
||||||
1. **"Yes, And..." Building**
|
|
||||||
[[LLM: Accept every idea and build upon it without judgment. Encourage wild ideas and defer criticism.]]
|
|
||||||
|
|
||||||
- Accept the premise of each idea
|
|
||||||
- Add to it with "Yes, and..."
|
|
||||||
- Build chains of connected ideas
|
|
||||||
- Explore tangents freely
|
|
||||||
|
|
||||||
2. **Brainwriting/Round Robin**
|
|
||||||
[[LLM: Simulate multiple perspectives by generating ideas from different viewpoints.]]
|
|
||||||
|
|
||||||
- Generate ideas from stakeholder perspectives
|
|
||||||
- Build on previous ideas in rounds
|
|
||||||
- Combine unrelated ideas
|
|
||||||
- Cross-pollinate concepts
|
|
||||||
|
|
||||||
3. **Random Stimulation**
|
|
||||||
[[LLM: Use random words, images, or concepts as creative triggers.]]
|
|
||||||
- Random word association
|
|
||||||
- Picture/metaphor inspiration
|
|
||||||
- Forced connections between unrelated items
|
|
||||||
- Constraint-based creativity
|
|
||||||
|
|
||||||
#### Deep Exploration Techniques
|
|
||||||
|
|
||||||
1. **Five Whys**
|
|
||||||
[[LLM: Dig deeper into root causes and underlying motivations.]]
|
|
||||||
|
|
||||||
- Why does this problem exist? → Answer → Why? (repeat 5 times)
|
|
||||||
- Uncover hidden assumptions
|
|
||||||
- Find root causes, not symptoms
|
|
||||||
- Identify intervention points
|
|
||||||
|
|
||||||
2. **Morphological Analysis**
|
|
||||||
[[LLM: Break down into parameters and systematically explore combinations.]]
|
|
||||||
|
|
||||||
- List key parameters/dimensions
|
|
||||||
- Identify possible values for each
|
|
||||||
- Create combination matrix
|
|
||||||
- Explore unusual combinations
|
|
||||||
|
|
||||||
3. **Provocation Technique (PO)**
|
|
||||||
[[LLM: Make deliberately provocative statements to jar thinking.]]
|
|
||||||
- PO: Cars have square wheels
|
|
||||||
- PO: Customers pay us to take products
|
|
||||||
- PO: The problem solves itself
|
|
||||||
- Extract useful ideas from provocations
|
|
||||||
|
|
||||||
### 3. Technique Selection Guide
|
|
||||||
|
|
||||||
[[LLM: Help user select appropriate techniques based on their needs.]]
|
|
||||||
|
|
||||||
**For Initial Exploration:**
|
|
||||||
|
|
||||||
- What If Scenarios
|
|
||||||
- First Principles
|
|
||||||
- Mind Mapping
|
|
||||||
|
|
||||||
**For Stuck/Blocked Thinking:**
|
|
||||||
|
|
||||||
- Random Stimulation
|
|
||||||
- Reversal/Inversion
|
|
||||||
- Provocation Technique
|
|
||||||
|
|
||||||
**For Systematic Coverage:**
|
|
||||||
|
|
||||||
- SCAMPER
|
|
||||||
- Morphological Analysis
|
|
||||||
- Six Thinking Hats
|
|
||||||
|
|
||||||
**For Deep Understanding:**
|
|
||||||
|
|
||||||
- Five Whys
|
|
||||||
- Analogical Thinking
|
|
||||||
- First Principles
|
|
||||||
|
|
||||||
**For Team/Collaborative Settings:**
|
|
||||||
|
|
||||||
- Brainwriting
|
|
||||||
- "Yes, And..."
|
|
||||||
- Six Thinking Hats
|
|
||||||
|
|
||||||
### 4. Session Flow Management
|
|
||||||
|
|
||||||
[[LLM: Guide the brainstorming session with appropriate pacing and technique transitions.]]
|
|
||||||
|
|
||||||
1. **Warm-up Phase** (5-10 min)
|
|
||||||
|
|
||||||
- Start with accessible techniques
|
|
||||||
- Build creative confidence
|
|
||||||
- Establish "no judgment" atmosphere
|
|
||||||
|
|
||||||
2. **Divergent Phase** (20-30 min)
|
|
||||||
|
|
||||||
- Use expansion techniques
|
|
||||||
- Generate quantity over quality
|
|
||||||
- Encourage wild ideas
|
|
||||||
|
|
||||||
3. **Convergent Phase** (15-20 min)
|
|
||||||
|
|
||||||
- Group and categorize ideas
|
|
||||||
- Identify patterns and themes
|
|
||||||
- Select promising directions
|
|
||||||
|
|
||||||
4. **Synthesis Phase** (10-15 min)
|
|
||||||
- Combine complementary ideas
|
|
||||||
- Refine and develop concepts
|
|
||||||
- Prepare summary of insights
|
|
||||||
|
|
||||||
### 5. Output Format
|
|
||||||
|
|
||||||
[[LLM: Present brainstorming results in an organized, actionable format.]]
|
|
||||||
|
|
||||||
**Session Summary:**
|
|
||||||
|
|
||||||
- Techniques used
|
|
||||||
- Number of ideas generated
|
|
||||||
- Key themes identified
|
|
||||||
|
|
||||||
**Idea Categories:**
|
|
||||||
|
|
||||||
1. **Immediate Opportunities** - Ideas that could be implemented now
|
|
||||||
2. **Future Innovations** - Ideas requiring more development
|
|
||||||
3. **Moonshots** - Ambitious, transformative ideas
|
|
||||||
4. **Insights & Learnings** - Key realizations from the session
|
|
||||||
|
|
||||||
**Next Steps:**
|
|
||||||
|
|
||||||
- Which ideas to explore further
|
|
||||||
- Recommended follow-up techniques
|
|
||||||
- Suggested research areas
|
|
||||||
|
|
||||||
## Important Notes
|
|
||||||
|
|
||||||
- Maintain energy and momentum throughout the session
|
|
||||||
- Defer judgment - all ideas are valid during generation
|
|
||||||
- Quantity leads to quality - aim for many ideas
|
|
||||||
- Build on ideas collaboratively
|
|
||||||
- Document everything - even "silly" ideas can spark breakthroughs
|
|
||||||
- Take breaks if energy flags
|
|
||||||
- End with clear next actions
|
|
||||||
136
bmad-core/tasks/facilitate-brainstorming-session.md
Normal file
136
bmad-core/tasks/facilitate-brainstorming-session.md
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
---
|
||||||
|
docOutputLocation: docs/brainstorming-session-results.md
|
||||||
|
template: brainstorming-output-tmpl
|
||||||
|
---
|
||||||
|
|
||||||
|
# Facilitate Brainstorming Session Task
|
||||||
|
|
||||||
|
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
||||||
|
|
||||||
|
## Process
|
||||||
|
|
||||||
|
### Step 1: Session Setup
|
||||||
|
|
||||||
|
Ask 4 context questions (don't preview what happens next):
|
||||||
|
|
||||||
|
1. What are we brainstorming about?
|
||||||
|
2. Any constraints or parameters?
|
||||||
|
3. Goal: broad exploration or focused ideation?
|
||||||
|
4. Do you want a structured document output to reference later? (Y/N)
|
||||||
|
|
||||||
|
### Step 2: Present Approach Options
|
||||||
|
|
||||||
|
After getting answers to Step 1, present 4 approach options (numbered):
|
||||||
|
|
||||||
|
1. User selects specific techniques
|
||||||
|
2. Analyst recommends techniques based on context
|
||||||
|
3. Random technique selection for creative variety
|
||||||
|
4. Progressive technique flow (start broad, narrow down)
|
||||||
|
|
||||||
|
### Step 3: Execute Techniques Interactively
|
||||||
|
|
||||||
|
**KEY PRINCIPLES:**
|
||||||
|
|
||||||
|
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
||||||
|
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
||||||
|
- **CAPTURE OUTPUT**: If document output requested, capture all ideas generated in each technique section
|
||||||
|
|
||||||
|
**Technique Selection:**
|
||||||
|
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number (e.g., "7" for Mind Mapping).
|
||||||
|
|
||||||
|
**Technique Execution:**
|
||||||
|
|
||||||
|
1. Apply selected technique according to data file description
|
||||||
|
2. Keep engaging with technique until user indicates they want to:
|
||||||
|
- Choose a different technique
|
||||||
|
- Apply current ideas to a new technique
|
||||||
|
- Move to convergent phase
|
||||||
|
- End session
|
||||||
|
|
||||||
|
**Output Capture (if requested):**
|
||||||
|
For each technique used, capture:
|
||||||
|
|
||||||
|
- Technique name and duration
|
||||||
|
- Key ideas generated by user
|
||||||
|
- Insights and patterns identified
|
||||||
|
- User's reflections on the process
|
||||||
|
|
||||||
|
### Step 4: Session Flow
|
||||||
|
|
||||||
|
1. **Warm-up** (5-10 min) - Build creative confidence
|
||||||
|
2. **Divergent** (20-30 min) - Generate quantity over quality
|
||||||
|
3. **Convergent** (15-20 min) - Group and categorize ideas
|
||||||
|
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
||||||
|
|
||||||
|
### Step 5: Document Output (if requested)
|
||||||
|
|
||||||
|
Generate structured document with these sections:
|
||||||
|
|
||||||
|
**Executive Summary**
|
||||||
|
|
||||||
|
- Session topic and goals
|
||||||
|
- Techniques used and duration
|
||||||
|
- Total ideas generated
|
||||||
|
- Key themes and patterns identified
|
||||||
|
|
||||||
|
**Technique Sections** (for each technique used)
|
||||||
|
|
||||||
|
- Technique name and description
|
||||||
|
- Ideas generated (user's own words)
|
||||||
|
- Insights discovered
|
||||||
|
- Notable connections or patterns
|
||||||
|
|
||||||
|
**Idea Categorization**
|
||||||
|
|
||||||
|
- **Immediate Opportunities** - Ready to implement now
|
||||||
|
- **Future Innovations** - Requires development/research
|
||||||
|
- **Moonshots** - Ambitious, transformative concepts
|
||||||
|
- **Insights & Learnings** - Key realizations from session
|
||||||
|
|
||||||
|
**Action Planning**
|
||||||
|
|
||||||
|
- Top 3 priority ideas with rationale
|
||||||
|
- Next steps for each priority
|
||||||
|
- Resources/research needed
|
||||||
|
- Timeline considerations
|
||||||
|
|
||||||
|
**Reflection & Follow-up**
|
||||||
|
|
||||||
|
- What worked well in this session
|
||||||
|
- Areas for further exploration
|
||||||
|
- Recommended follow-up techniques
|
||||||
|
- Questions that emerged for future sessions
|
||||||
|
|
||||||
|
## Key Principles
|
||||||
|
|
||||||
|
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them
|
||||||
|
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
||||||
|
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
||||||
|
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
||||||
|
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
||||||
|
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
||||||
|
- Maintain energy and momentum
|
||||||
|
- Defer judgment during generation
|
||||||
|
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
||||||
|
- Build on ideas collaboratively
|
||||||
|
- Document everything if output requested
|
||||||
|
|
||||||
|
## Advanced Engagement Strategies
|
||||||
|
|
||||||
|
**Energy Management**
|
||||||
|
|
||||||
|
- Check engagement levels: "How are you feeling about this direction?"
|
||||||
|
- Offer breaks or technique switches if energy flags
|
||||||
|
- Use encouraging language and celebrate idea generation
|
||||||
|
|
||||||
|
**Depth vs. Breadth**
|
||||||
|
|
||||||
|
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
||||||
|
- Use "Yes, and..." to build on their ideas
|
||||||
|
- Help them make connections: "How does this relate to your earlier idea about...?"
|
||||||
|
|
||||||
|
**Transition Management**
|
||||||
|
|
||||||
|
- Always ask before switching techniques: "Ready to try a different approach?"
|
||||||
|
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
||||||
|
- Respect their process and timing
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
||||||
|
|
||||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
This document outlines the overall project architecture for {{Project Name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
This document outlines the overall project architecture for {{Project Name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ If the project includes a significant user interface, a separate Frontend Archit
|
|||||||
|
|
||||||
Document the decision here before proceeding with the architecture design. In none, just say N/A
|
Document the decision here before proceeding with the architecture design. In none, just say N/A
|
||||||
|
|
||||||
After presenting this starter template section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this starter template section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Change Log
|
### Change Log
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ After presenting this starter template section, apply `tasks#advanced-elicitatio
|
|||||||
|
|
||||||
## High Level Architecture
|
## High Level Architecture
|
||||||
|
|
||||||
[[LLM: This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together (Introduction, Technical Summary, High Level Overview, Project Diagram, and Architectural Patterns), then apply `tasks#advanced-elicitation` protocol to the complete High Level Architecture section. The user can choose to refine the entire section or specific subsections.]]
|
[[LLM: This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together (Introduction, Technical Summary, High Level Overview, Project Diagram, and Architectural Patterns), then apply `{root}/tasks/advanced-elicitation.md` protocol to the complete High Level Architecture section. The user can choose to refine the entire section or specific subsections.]]
|
||||||
|
|
||||||
### Technical Summary
|
### Technical Summary
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ After presenting this starter template section, apply `tasks#advanced-elicitatio
|
|||||||
4. Primary user interaction flow or data flow at a conceptual level
|
4. Primary user interaction flow or data flow at a conceptual level
|
||||||
5. Key architectural decisions and their rationale
|
5. Key architectural decisions and their rationale
|
||||||
|
|
||||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### High Level Project Diagram
|
### High Level Project Diagram
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
|
|
||||||
Use appropriate Mermaid diagram type (graph TD, C4, sequence) based on what best represents the architecture
|
Use appropriate Mermaid diagram type (graph TD, C4, sequence) based on what best represents the architecture
|
||||||
|
|
||||||
After presenting the diagram, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the diagram, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Architectural and Design Patterns
|
### Architectural and Design Patterns
|
||||||
|
|
||||||
@@ -132,13 +132,13 @@ Common patterns to consider:
|
|||||||
|
|
||||||
@{/example}
|
@{/example}
|
||||||
|
|
||||||
[[LLM: After presenting the patterns, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the patterns, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||||
|
|
||||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences`
|
1. Review PRD technical assumptions and any preferences from `{root}/data/technical-preferences.yaml` or an attached `technical-preferences`
|
||||||
2. For each category, present 2-3 viable options with pros/cons
|
2. For each category, present 2-3 viable options with pros/cons
|
||||||
3. Make a clear recommendation based on project needs
|
3. Make a clear recommendation based on project needs
|
||||||
4. Get explicit user approval for each selection
|
4. Get explicit user approval for each selection
|
||||||
@@ -154,7 +154,7 @@ Key decisions to finalize - before displaying the table, ensure you are aware of
|
|||||||
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
||||||
- Development tools
|
- Development tools
|
||||||
|
|
||||||
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away apply `tasks#advanced-elicitation` display - this statement and the options should be rendered and then prompt right all before allowing user input.]]
|
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away apply `{root}/tasks/advanced-elicitation.md` display - this statement and the options should be rendered and then prompt right all before allowing user input.]]
|
||||||
|
|
||||||
### Cloud Infrastructure
|
### Cloud Infrastructure
|
||||||
|
|
||||||
@@ -198,7 +198,7 @@ Upon render of the table, ensure the user is aware of the importance of this sec
|
|||||||
|
|
||||||
Create a clear conceptual model before moving to database schema.
|
Create a clear conceptual model before moving to database schema.
|
||||||
|
|
||||||
After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
After presenting all data models, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
<<REPEAT: data_model>>
|
<<REPEAT: data_model>>
|
||||||
|
|
||||||
@@ -232,7 +232,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
- Technology specifics based on tech stack choices
|
- Technology specifics based on tech stack choices
|
||||||
|
|
||||||
5. Create component diagrams where helpful
|
5. Create component diagrams where helpful
|
||||||
6. After presenting all components, apply `tasks#advanced-elicitation` protocol]]
|
6. After presenting all components, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
<<REPEAT: component>>
|
<<REPEAT: component>>
|
||||||
|
|
||||||
@@ -259,7 +259,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
- Sequence diagrams for complex interactions
|
- Sequence diagrams for complex interactions
|
||||||
Choose the most appropriate for clarity
|
Choose the most appropriate for clarity
|
||||||
|
|
||||||
After presenting the diagrams, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the diagrams, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## External APIs
|
## External APIs
|
||||||
|
|
||||||
@@ -313,7 +313,7 @@ If no external APIs are needed, state this explicitly and skip to next section.]
|
|||||||
|
|
||||||
^^/CONDITION: has_external_apis^^
|
^^/CONDITION: has_external_apis^^
|
||||||
|
|
||||||
[[LLM: After presenting external APIs (or noting their absence), apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting external APIs (or noting their absence), apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Core Workflows
|
## Core Workflows
|
||||||
|
|
||||||
@@ -327,7 +327,7 @@ If no external APIs are needed, state this explicitly and skip to next section.]
|
|||||||
|
|
||||||
Focus on workflows that clarify architecture decisions or complex interactions.
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
||||||
|
|
||||||
After presenting the workflow diagrams, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the workflow diagrams, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## REST API Spec
|
## REST API Spec
|
||||||
|
|
||||||
@@ -361,7 +361,7 @@ servers:
|
|||||||
|
|
||||||
^^/CONDITION: has_rest_api^^
|
^^/CONDITION: has_rest_api^^
|
||||||
|
|
||||||
[[LLM: After presenting the REST API spec (or noting its absence if not applicable), apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the REST API spec (or noting its absence if not applicable), apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Database Schema
|
## Database Schema
|
||||||
|
|
||||||
@@ -375,7 +375,7 @@ servers:
|
|||||||
|
|
||||||
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
||||||
|
|
||||||
After presenting the database schema, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the database schema, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Source Tree
|
## Source Tree
|
||||||
|
|
||||||
@@ -390,7 +390,7 @@ After presenting the database schema, apply `tasks#advanced-elicitation` protoco
|
|||||||
|
|
||||||
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
||||||
|
|
||||||
After presenting the structure, apply `tasks#advanced-elicitation` protocol to refine based on user feedback.]]
|
After presenting the structure, apply `{root}/tasks/advanced-elicitation.md` protocol to refine based on user feedback.]]
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
{{project-root}}/
|
{{project-root}}/
|
||||||
@@ -433,7 +433,7 @@ project-root/
|
|||||||
@{/example}
|
@{/example}
|
||||||
```
|
```
|
||||||
|
|
||||||
[[LLM: After presenting the source tree structure, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the source tree structure, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Infrastructure and Deployment
|
## Infrastructure and Deployment
|
||||||
|
|
||||||
@@ -478,7 +478,7 @@ Get user input on deployment preferences and CI/CD tool choices.]]
|
|||||||
- **Trigger Conditions:** {{rollback_triggers}}
|
- **Trigger Conditions:** {{rollback_triggers}}
|
||||||
- **Recovery Time Objective:** {{rto}}
|
- **Recovery Time Objective:** {{rto}}
|
||||||
|
|
||||||
[[LLM: After presenting the infrastructure and deployment section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the infrastructure and deployment section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Error Handling Strategy
|
## Error Handling Strategy
|
||||||
|
|
||||||
@@ -529,7 +529,7 @@ This section guides both AI and human developers in consistent error handling.]]
|
|||||||
- **Compensation Logic:** {{compensation_patterns}}
|
- **Compensation Logic:** {{compensation_patterns}}
|
||||||
- **Idempotency:** {{idempotency_approach}}
|
- **Idempotency:** {{idempotency_approach}}
|
||||||
|
|
||||||
[[LLM: After presenting the error handling strategy, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the error handling strategy, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Coding Standards
|
## Coding Standards
|
||||||
|
|
||||||
@@ -590,7 +590,7 @@ Avoid obvious rules like "use SOLID principles" or "write clean code"]]
|
|||||||
|
|
||||||
^^/CONDITION: has_language_specifics^^
|
^^/CONDITION: has_language_specifics^^
|
||||||
|
|
||||||
[[LLM: After presenting the coding standards, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the coding standards, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Test Strategy and Standards
|
## Test Strategy and Standards
|
||||||
|
|
||||||
@@ -603,7 +603,7 @@ Avoid obvious rules like "use SOLID principles" or "write clean code"]]
|
|||||||
5. Determine integration test infrastructure
|
5. Determine integration test infrastructure
|
||||||
6. Plan for test data and external dependencies
|
6. Plan for test data and external dependencies
|
||||||
|
|
||||||
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference. Apply `tasks#advanced-elicitation` after initial draft.]]
|
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference. Apply `{root}/tasks/advanced-elicitation.md` after initial draft.]]
|
||||||
|
|
||||||
### Testing Philosophy
|
### Testing Philosophy
|
||||||
|
|
||||||
@@ -664,7 +664,7 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|||||||
- **Performance Tests:** {{perf_test_approach}}
|
- **Performance Tests:** {{perf_test_approach}}
|
||||||
- **Security Tests:** {{security_test_approach}}
|
- **Security Tests:** {{security_test_approach}}
|
||||||
|
|
||||||
[[LLM: After presenting the test strategy section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the test strategy section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
@@ -728,7 +728,7 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|||||||
- **DAST Tool:** {{dynamic_analysis}}
|
- **DAST Tool:** {{dynamic_analysis}}
|
||||||
- **Penetration Testing:** {{pentest_schedule}}
|
- **Penetration Testing:** {{pentest_schedule}}
|
||||||
|
|
||||||
[[LLM: After presenting the security section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the security section, apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Checklist Results Report
|
## Checklist Results Report
|
||||||
|
|
||||||
|
|||||||
149
bmad-core/templates/brainstorming-output-tmpl.md
Normal file
149
bmad-core/templates/brainstorming-output-tmpl.md
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
---
|
||||||
|
defaultOutput: docs/brainstorming-session-results.md
|
||||||
|
---
|
||||||
|
|
||||||
|
# Brainstorming Session Results
|
||||||
|
|
||||||
|
**Session Date:** [DATE]
|
||||||
|
**Facilitator:** [Agent Role] [Agent Name]
|
||||||
|
**Participant:** [USER NAME]
|
||||||
|
|
||||||
|
## Executive Summary
|
||||||
|
|
||||||
|
**Topic:** [SESSION TOPIC]
|
||||||
|
|
||||||
|
**Session Goals:** [STATED GOALS]
|
||||||
|
|
||||||
|
**Techniques Used:** [LIST OF TECHNIQUES AND DURATION]
|
||||||
|
|
||||||
|
**Total Ideas Generated:** [NUMBER]
|
||||||
|
|
||||||
|
**Key Themes Identified:**
|
||||||
|
|
||||||
|
- [THEME 1]
|
||||||
|
- [THEME 2]
|
||||||
|
- [THEME 3]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Technique Sessions
|
||||||
|
|
||||||
|
### [TECHNIQUE NAME 1] - [DURATION]
|
||||||
|
|
||||||
|
**Description:** [BRIEF DESCRIPTION OF TECHNIQUE]
|
||||||
|
|
||||||
|
**Ideas Generated:**
|
||||||
|
|
||||||
|
1. [USER IDEA 1]
|
||||||
|
2. [USER IDEA 2]
|
||||||
|
3. [USER IDEA 3]
|
||||||
|
[etc.]
|
||||||
|
|
||||||
|
**Insights Discovered:**
|
||||||
|
|
||||||
|
- [INSIGHT 1]
|
||||||
|
- [INSIGHT 2]
|
||||||
|
|
||||||
|
**Notable Connections:**
|
||||||
|
|
||||||
|
- [CONNECTION OR PATTERN IDENTIFIED]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### [TECHNIQUE NAME 2] - [DURATION]
|
||||||
|
|
||||||
|
[Repeat format for each technique used]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Idea Categorization
|
||||||
|
|
||||||
|
### Immediate Opportunities
|
||||||
|
|
||||||
|
*Ideas ready to implement now*
|
||||||
|
|
||||||
|
1. **[IDEA NAME]**
|
||||||
|
- Description: [BRIEF DESCRIPTION]
|
||||||
|
- Why immediate: [RATIONALE]
|
||||||
|
- Resources needed: [BASIC REQUIREMENTS]
|
||||||
|
|
||||||
|
### Future Innovations
|
||||||
|
|
||||||
|
*Ideas requiring development/research*
|
||||||
|
|
||||||
|
1. **[IDEA NAME]**
|
||||||
|
- Description: [BRIEF DESCRIPTION]
|
||||||
|
- Development needed: [WHAT'S REQUIRED]
|
||||||
|
- Timeline estimate: [ROUGH TIMEFRAME]
|
||||||
|
|
||||||
|
### Moonshots
|
||||||
|
|
||||||
|
*Ambitious, transformative concepts*
|
||||||
|
|
||||||
|
1. **[IDEA NAME]**
|
||||||
|
- Description: [BRIEF DESCRIPTION]
|
||||||
|
- Transformative potential: [WHY IT'S A MOONSHOT]
|
||||||
|
- Challenges to overcome: [MAJOR OBSTACLES]
|
||||||
|
|
||||||
|
### Insights & Learnings
|
||||||
|
|
||||||
|
*Key realizations from the session*
|
||||||
|
|
||||||
|
- [INSIGHT 1]: [DESCRIPTION AND IMPLICATIONS]
|
||||||
|
- [INSIGHT 2]: [DESCRIPTION AND IMPLICATIONS]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Action Planning
|
||||||
|
|
||||||
|
### Top 3 Priority Ideas
|
||||||
|
|
||||||
|
**#1 Priority: [IDEA NAME]**
|
||||||
|
|
||||||
|
- Rationale: [WHY THIS IS TOP PRIORITY]
|
||||||
|
- Next steps: [SPECIFIC ACTIONS TO TAKE]
|
||||||
|
- Resources needed: [WHAT'S REQUIRED]
|
||||||
|
- Timeline: [WHEN TO START/COMPLETE]
|
||||||
|
|
||||||
|
**#2 Priority: [IDEA NAME]**
|
||||||
|
|
||||||
|
- [Same format]
|
||||||
|
|
||||||
|
**#3 Priority: [IDEA NAME]**
|
||||||
|
|
||||||
|
- [Same format]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reflection & Follow-up
|
||||||
|
|
||||||
|
### What Worked Well
|
||||||
|
|
||||||
|
- [SUCCESSFUL ASPECT 1]
|
||||||
|
- [SUCCESSFUL ASPECT 2]
|
||||||
|
|
||||||
|
### Areas for Further Exploration
|
||||||
|
|
||||||
|
- [AREA 1]: [WHY IT NEEDS MORE EXPLORATION]
|
||||||
|
- [AREA 2]: [WHY IT NEEDS MORE EXPLORATION]
|
||||||
|
|
||||||
|
### Recommended Follow-up Techniques
|
||||||
|
|
||||||
|
- [TECHNIQUE 1]: [WHY IT WOULD BE HELPFUL]
|
||||||
|
- [TECHNIQUE 2]: [WHY IT WOULD BE HELPFUL]
|
||||||
|
|
||||||
|
### Questions That Emerged
|
||||||
|
|
||||||
|
- [QUESTION 1]
|
||||||
|
- [QUESTION 2]
|
||||||
|
- [QUESTION 3]
|
||||||
|
|
||||||
|
### Next Session Planning
|
||||||
|
|
||||||
|
- **Suggested topics:** [FOLLOW-UP TOPICS]
|
||||||
|
- **Recommended timeframe:** [WHEN TO RECONVENE]
|
||||||
|
- **Preparation needed:** [WHAT TO RESEARCH/PREPARE]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Session facilitated using the BMAD-METHOD brainstorming framework*
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
[[LLM: Draft the list of functional and non functional requirements under the two child sections, and immediately execute tasks#advanced-elicitation display]]
|
[[LLM: Draft the list of functional and non functional requirements under the two child sections, and immediately execute {root}/tasks/advanced-elicitation.md display]]
|
||||||
|
|
||||||
### Functional
|
### Functional
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@
|
|||||||
3. Clearly let the user know where assumptions were made
|
3. Clearly let the user know where assumptions were made
|
||||||
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
||||||
5. This is NOT detailed UI spec - focus on product vision and user goals
|
5. This is NOT detailed UI spec - focus on product vision and user goals
|
||||||
6. After section completion, immediately apply `tasks#advanced-elicitation` protocol]]
|
6. After section completion, immediately apply `{root}/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Overall UX Vision
|
### Overall UX Vision
|
||||||
|
|
||||||
@@ -90,12 +90,12 @@
|
|||||||
|
|
||||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
||||||
|
|
||||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
1. Check if `{root}/data/technical-preferences.yaml` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||||
5. These become constraints for the Architect - be specific and complete
|
5. These become constraints for the Architect - be specific and complete
|
||||||
6. After section completion, apply `tasks#advanced-elicitation` protocol.]]
|
6. After section completion, apply `{root}/tasks/advanced-elicitation.md` protocol.]]
|
||||||
|
|
||||||
### Repository Structure: { Monorepo, Polyrepo, etc...}
|
### Repository Structure: { Monorepo, Polyrepo, etc...}
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@
|
|||||||
|
|
||||||
## Epics
|
## Epics
|
||||||
|
|
||||||
[[LLM: First, present a high-level list of all epics for user approval, the epic_list and immediately execute tasks#advanced-elicitation display. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
[[LLM: First, present a high-level list of all epics for user approval, the epic_list and immediately execute {root}/tasks/advanced-elicitation.md display. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
||||||
|
|
||||||
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ CRITICAL: Epics MUST be logically sequential following agile best practices:
|
|||||||
|
|
||||||
@{/example}
|
@{/example}
|
||||||
|
|
||||||
[[LLM: After the epic list is approved, present each `epic_details` with all its stories and acceptance criteria as a complete review unit and immediately execute tasks#advanced-elicitation display, before moving on to the next epic.]]
|
[[LLM: After the epic list is approved, present each `epic_details` with all its stories and acceptance criteria as a complete review unit and immediately execute {root}/tasks/advanced-elicitation.md display, before moving on to the next epic.]]
|
||||||
|
|
||||||
<<REPEAT: epic_details>>
|
<<REPEAT: epic_details>>
|
||||||
|
|
||||||
|
|||||||
202
bmad-core/templates/prd-tmpl2.yaml
Normal file
202
bmad-core/templates/prd-tmpl2.yaml
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
template:
|
||||||
|
id: prd-template-v2
|
||||||
|
name: Product Requirements Document
|
||||||
|
version: 2.0
|
||||||
|
output:
|
||||||
|
format: markdown
|
||||||
|
filename: docs/prd.md
|
||||||
|
title: "{{project_name}} Product Requirements Document (PRD)"
|
||||||
|
|
||||||
|
workflow:
|
||||||
|
mode: interactive
|
||||||
|
elicitation: advanced-elicitation
|
||||||
|
|
||||||
|
sections:
|
||||||
|
- id: goals-context
|
||||||
|
title: Goals and Background Context
|
||||||
|
instruction: |
|
||||||
|
Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on PRD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired outcomes) and Background Context (1-2 paragraphs on what this solves and why) so we can determine what is and is not in scope for PRD mvp. Either way this is critical to determine the requirements. Include Change Log table.
|
||||||
|
sections:
|
||||||
|
- id: goals
|
||||||
|
title: Goals
|
||||||
|
type: bullet-list
|
||||||
|
instruction: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires
|
||||||
|
- id: background
|
||||||
|
title: Background Context
|
||||||
|
type: paragraphs
|
||||||
|
instruction: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is
|
||||||
|
- id: changelog
|
||||||
|
title: Change Log
|
||||||
|
type: table
|
||||||
|
columns: [Date, Version, Description, Author]
|
||||||
|
instruction: Track document versions and changes
|
||||||
|
|
||||||
|
- id: requirements
|
||||||
|
title: Requirements
|
||||||
|
instruction: Draft the list of functional and non functional requirements under the two child sections
|
||||||
|
elicit: true
|
||||||
|
sections:
|
||||||
|
- id: functional
|
||||||
|
title: Functional
|
||||||
|
type: numbered-list
|
||||||
|
prefix: FR
|
||||||
|
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with FR
|
||||||
|
examples:
|
||||||
|
- "FR6: The Todo List uses AI to detect and warn against potentially duplicate todo items that are worded differently."
|
||||||
|
- id: non-functional
|
||||||
|
title: Non Functional
|
||||||
|
type: numbered-list
|
||||||
|
prefix: NFR
|
||||||
|
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR
|
||||||
|
examples:
|
||||||
|
- "NFR1: AWS service usage must aim to stay within free-tier limits where feasible."
|
||||||
|
|
||||||
|
- id: ui-goals
|
||||||
|
title: User Interface Design Goals
|
||||||
|
condition: PRD has UX/UI requirements
|
||||||
|
instruction: |
|
||||||
|
Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
|
||||||
|
|
||||||
|
1. Pre-fill all subsections with educated guesses based on project context
|
||||||
|
2. Present the complete rendered section to user
|
||||||
|
3. Clearly let the user know where assumptions were made
|
||||||
|
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
||||||
|
5. This is NOT detailed UI spec - focus on product vision and user goals
|
||||||
|
elicit: true
|
||||||
|
choices:
|
||||||
|
accessibility: [None, WCAG AA, WCAG AAA]
|
||||||
|
platforms: [Web Responsive, Mobile Only, Desktop Only, Cross-Platform]
|
||||||
|
sections:
|
||||||
|
- id: ux-vision
|
||||||
|
title: Overall UX Vision
|
||||||
|
- id: interaction-paradigms
|
||||||
|
title: Key Interaction Paradigms
|
||||||
|
- id: core-screens
|
||||||
|
title: Core Screens and Views
|
||||||
|
instruction: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories
|
||||||
|
examples:
|
||||||
|
- "Login Screen"
|
||||||
|
- "Main Dashboard"
|
||||||
|
- "Item Detail Page"
|
||||||
|
- "Settings Page"
|
||||||
|
- id: accessibility
|
||||||
|
title: "Accessibility: {None|WCAG AA|WCAG AAA|Custom Requirements}"
|
||||||
|
- id: branding
|
||||||
|
title: Branding
|
||||||
|
instruction: Any known branding elements or style guides that must be incorporated?
|
||||||
|
examples:
|
||||||
|
- "Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions."
|
||||||
|
- "Attached is the full color pallet and tokens for our corporate branding."
|
||||||
|
- id: target-platforms
|
||||||
|
title: "Target Device and Platforms: {Web Responsive|Mobile Only|Desktop Only|Cross-Platform}"
|
||||||
|
examples:
|
||||||
|
- "Web Responsive, and all mobile platforms"
|
||||||
|
- "iPhone Only"
|
||||||
|
- "ASCII Windows Desktop"
|
||||||
|
|
||||||
|
- id: technical-assumptions
|
||||||
|
title: Technical Assumptions
|
||||||
|
instruction: |
|
||||||
|
Gather technical decisions that will guide the Architect. Steps:
|
||||||
|
|
||||||
|
1. Check if {root}/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
|
||||||
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||||
|
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||||
|
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||||
|
5. These become constraints for the Architect - be specific and complete
|
||||||
|
elicit: true
|
||||||
|
choices:
|
||||||
|
repository: [Monorepo, Polyrepo]
|
||||||
|
architecture: [Monolith, Microservices, Serverless]
|
||||||
|
testing: [Unit Only, Unit + Integration, Full Testing Pyramid]
|
||||||
|
sections:
|
||||||
|
- id: repository-structure
|
||||||
|
title: "Repository Structure: {Monorepo|Polyrepo|Multi-repo}"
|
||||||
|
- id: service-architecture
|
||||||
|
title: Service Architecture
|
||||||
|
instruction: "CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo)."
|
||||||
|
- id: testing-requirements
|
||||||
|
title: Testing Requirements
|
||||||
|
instruction: "CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods)."
|
||||||
|
- id: additional-assumptions
|
||||||
|
title: Additional Technical Assumptions and Requests
|
||||||
|
instruction: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items
|
||||||
|
|
||||||
|
- id: epic-list
|
||||||
|
title: Epic List
|
||||||
|
instruction: |
|
||||||
|
Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
||||||
|
|
||||||
|
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
||||||
|
|
||||||
|
- Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
|
||||||
|
- Epic 1 must establish foundational project infrastructure (app setup, Git, CI/CD, core services) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, even as simple as a health-check route or display of a simple canary page - remember this when we produce the stories for the first epic!
|
||||||
|
- Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
|
||||||
|
- Not every project needs multiple epics, an epic needs to deliver value. For example, an API completed can deliver value even if a UI is not complete and planned for a separate epic.
|
||||||
|
- Err on the side of less epics, but let the user know your rationale and offer options for splitting them if it seems some are too large or focused on disparate things.
|
||||||
|
- Cross Cutting Concerns should flow through epics and stories and not be final stories. For example, adding a logging framework as a last story of an epic, or at the end of a project as a final epic or story would be terrible as we would not have logging from the beginning.
|
||||||
|
elicit: true
|
||||||
|
examples:
|
||||||
|
- "Epic 1: Foundation & Core Infrastructure: Establish project setup, authentication, and basic user management"
|
||||||
|
- "Epic 2: Core Business Entities: Create and manage primary domain objects with CRUD operations"
|
||||||
|
- "Epic 3: User Workflows & Interactions: Enable key user journeys and business processes"
|
||||||
|
- "Epic 4: Reporting & Analytics: Provide insights and data visualization for users"
|
||||||
|
|
||||||
|
- id: epic-details
|
||||||
|
title: Epic {{epic_number}} {{epic_title}}
|
||||||
|
repeatable: true
|
||||||
|
instruction: |
|
||||||
|
After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
|
||||||
|
|
||||||
|
For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
|
||||||
|
|
||||||
|
CRITICAL STORY SEQUENCING REQUIREMENTS:
|
||||||
|
|
||||||
|
- Stories within each epic MUST be logically sequential
|
||||||
|
- Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
|
||||||
|
- No story should depend on work from a later story or epic
|
||||||
|
- Identify and note any direct prerequisite stories
|
||||||
|
- Focus on "what" and "why" not "how" (leave technical implementation to Architect) yet be precise enough to support a logical sequential order of operations from story to story.
|
||||||
|
- Ensure each story delivers clear user or business value, try to avoid enablers and build them into stories that deliver value.
|
||||||
|
- Size stories for AI agent execution: Each story must be completable by a single AI agent in one focused session without context overflow
|
||||||
|
- Think "junior developer working for 2-4 hours" - stories must be small, focused, and self-contained
|
||||||
|
- If a story seems complex, break it down further as long as it can deliver a vertical slice
|
||||||
|
elicit: true
|
||||||
|
template: "{{epic_goal}}"
|
||||||
|
sections:
|
||||||
|
- id: story
|
||||||
|
title: Story {{epic_number}}.{{story_number}} {{story_title}}
|
||||||
|
repeatable: true
|
||||||
|
template: |
|
||||||
|
As a {{user_type}},
|
||||||
|
I want {{action}},
|
||||||
|
so that {{benefit}}.
|
||||||
|
sections:
|
||||||
|
- id: acceptance-criteria
|
||||||
|
title: Acceptance Criteria
|
||||||
|
type: numbered-list
|
||||||
|
item_template: "{{criterion_number}}: {{criteria}}"
|
||||||
|
repeatable: true
|
||||||
|
instruction: |
|
||||||
|
Define clear, comprehensive, and testable acceptance criteria that:
|
||||||
|
|
||||||
|
- Precisely define what "done" means from a functional perspective
|
||||||
|
- Are unambiguous and serve as basis for verification
|
||||||
|
- Include any critical non-functional requirements from the PRD
|
||||||
|
- Consider local testability for backend/data components
|
||||||
|
- Specify UI/UX requirements and framework adherence where applicable
|
||||||
|
- Avoid cross-cutting concerns that should be in other stories or PRD sections
|
||||||
|
|
||||||
|
- id: checklist-results
|
||||||
|
title: Checklist Results Report
|
||||||
|
instruction: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the pm-checklist and populate the results in this section.
|
||||||
|
|
||||||
|
- id: next-steps
|
||||||
|
title: Next Steps
|
||||||
|
sections:
|
||||||
|
- id: design-architect-prompt
|
||||||
|
title: Design Architect Prompt
|
||||||
|
instruction: This section will contain the prompt for the Design Architect, keep it short and to the point to initiate create architecture mode using this document as input.
|
||||||
|
- id: architect-prompt
|
||||||
|
title: Architect Prompt
|
||||||
|
instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.
|
||||||
@@ -8,14 +8,10 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|||||||
|
|
||||||
### 1. Check Plan Existence
|
### 1. Check Plan Existence
|
||||||
|
|
||||||
[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
|
|
||||||
|
|
||||||
```
|
|
||||||
Check for workflow plan:
|
Check for workflow plan:
|
||||||
|
|
||||||
1. Look for docs/workflow-plan.md (default location)
|
1. Look for docs/workflow-plan.md (default location)
|
||||||
2. Check core-config.yaml for custom plan location
|
2. Return plan status to user (exists/not exists) - if not exists then HALT.
|
||||||
3. Return plan status (exists/not exists)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Parse Plan Status
|
### 2. Parse Plan Status
|
||||||
|
|
||||||
@@ -56,7 +52,7 @@ Check for workflow plan:
|
|||||||
|
|
||||||
**Warning Templates:**
|
**Warning Templates:**
|
||||||
|
|
||||||
```
|
```text
|
||||||
SEQUENCE WARNING:
|
SEQUENCE WARNING:
|
||||||
The workflow plan shows you should complete "{expected_step}" next.
|
The workflow plan shows you should complete "{expected_step}" next.
|
||||||
You're attempting to: "{requested_action}"
|
You're attempting to: "{requested_action}"
|
||||||
@@ -90,7 +86,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
**For Agents (startup sequence)**:
|
**For Agents (startup sequence)**:
|
||||||
|
|
||||||
```
|
```text
|
||||||
1. Check if plan exists using this utility
|
1. Check if plan exists using this utility
|
||||||
2. If exists:
|
2. If exists:
|
||||||
- Parse current status
|
- Parse current status
|
||||||
@@ -101,7 +97,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
**For Tasks (pre-execution)**:
|
**For Tasks (pre-execution)**:
|
||||||
|
|
||||||
```
|
```text
|
||||||
1. Check if plan exists
|
1. Check if plan exists
|
||||||
2. If exists:
|
2. If exists:
|
||||||
- Verify this task aligns with plan
|
- Verify this task aligns with plan
|
||||||
@@ -117,7 +113,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
[[LLM: Standard format for showing plan status]]
|
[[LLM: Standard format for showing plan status]]
|
||||||
|
|
||||||
```
|
```text
|
||||||
📋 Workflow Plan Status
|
📋 Workflow Plan Status
|
||||||
━━━━━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━━━━━
|
||||||
Workflow: {workflow_name}
|
Workflow: {workflow_name}
|
||||||
@@ -170,7 +166,7 @@ If user wants to abandon plan:
|
|||||||
|
|
||||||
### Example 1: Agent Startup Check
|
### Example 1: Agent Startup Check
|
||||||
|
|
||||||
```
|
```text
|
||||||
BMad Master starting...
|
BMad Master starting...
|
||||||
|
|
||||||
[Check for plan]
|
[Check for plan]
|
||||||
@@ -184,7 +180,7 @@ Use *agent pm to switch, or *plan-status to see full progress.
|
|||||||
|
|
||||||
### Example 2: Task Sequence Warning
|
### Example 2: Task Sequence Warning
|
||||||
|
|
||||||
```
|
```text
|
||||||
User: *task create-next-story
|
User: *task create-next-story
|
||||||
|
|
||||||
[Plan check triggered]
|
[Plan check triggered]
|
||||||
@@ -200,7 +196,7 @@ Would you like to:
|
|||||||
|
|
||||||
### Example 3: Automatic Plan Update
|
### Example 3: Automatic Plan Update
|
||||||
|
|
||||||
```
|
```text
|
||||||
[After completing create-doc task for PRD]
|
[After completing create-doc task for PRD]
|
||||||
|
|
||||||
✅ Plan Updated: Marked "Create PRD" as complete
|
✅ Plan Updated: Marked "Create PRD" as complete
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ workflow:
|
|||||||
All stories implemented and reviewed!
|
All stories implemented and reviewed!
|
||||||
Service development phase complete.
|
Service development phase complete.
|
||||||
|
|
||||||
Reference: data#bmad-kb:IDE Development Workflow
|
Reference: {root}/data/bmad-kb.md#IDE Development Workflow
|
||||||
|
|
||||||
flow_diagram: |
|
flow_diagram: |
|
||||||
```mermaid
|
```mermaid
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using {root}/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -26,7 +26,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `{root}/templates/*.md` or `{root}/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -44,14 +44,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute {root}/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply {root}/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
|
|||||||
65
common/tasks/create-doc2.md
Normal file
65
common/tasks/create-doc2.md
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
# Create Document from Template (YAML Driven)
|
||||||
|
|
||||||
|
## CRITICAL: Mandatory Elicitation Format
|
||||||
|
|
||||||
|
**When `elicit: true`, ALWAYS use this exact format:**
|
||||||
|
|
||||||
|
1. Present section content
|
||||||
|
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
|
||||||
|
3. Present numbered options 1-9:
|
||||||
|
- **Option 1:** Always "Proceed to next section"
|
||||||
|
- **Options 2-9:** Select 8 methods from data/elicitation-methods
|
||||||
|
- End with: "Select 1-9 or just type your question/feedback:"
|
||||||
|
|
||||||
|
**NEVER ask yes/no questions or use any other format.**
|
||||||
|
|
||||||
|
## Processing Flow
|
||||||
|
|
||||||
|
1. **Parse YAML template** - Load template metadata and sections
|
||||||
|
2. **Set preferences** - Show current mode (Interactive), confirm output file
|
||||||
|
3. **Process each section:**
|
||||||
|
- Skip if condition unmet
|
||||||
|
- Draft content using section instruction
|
||||||
|
- Present content + detailed rationale
|
||||||
|
- **IF elicit: true** → MANDATORY 1-9 options format
|
||||||
|
- Save to file if possible
|
||||||
|
4. **Continue until complete**
|
||||||
|
|
||||||
|
## Detailed Rationale Requirements
|
||||||
|
|
||||||
|
When presenting section content, ALWAYS include rationale that explains:
|
||||||
|
|
||||||
|
- Trade-offs and choices made (what was chosen over alternatives and why)
|
||||||
|
- Key assumptions made during drafting
|
||||||
|
- Interesting or questionable decisions that need user attention
|
||||||
|
- Areas that might need validation
|
||||||
|
|
||||||
|
## Elicitation Results Flow
|
||||||
|
|
||||||
|
After user selects elicitation method (2-9):
|
||||||
|
|
||||||
|
1. Execute method from data/elicitation-methods
|
||||||
|
2. Present results with insights
|
||||||
|
3. Offer options:
|
||||||
|
- **1. Apply changes and update section**
|
||||||
|
- **2. Return to elicitation menu**
|
||||||
|
- **3. Ask any questions or engage further with this elicitation**
|
||||||
|
|
||||||
|
## YOLO Mode
|
||||||
|
|
||||||
|
User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
||||||
|
|
||||||
|
## CRITICAL REMINDERS
|
||||||
|
|
||||||
|
**❌ NEVER:**
|
||||||
|
|
||||||
|
- Ask yes/no questions for elicitation
|
||||||
|
- Use any format other than 1-9 numbered options
|
||||||
|
- Create new elicitation methods
|
||||||
|
|
||||||
|
**✅ ALWAYS:**
|
||||||
|
|
||||||
|
- Use exact 1-9 format when elicit: true
|
||||||
|
- Select options 2-9 from data/elicitation-methods only
|
||||||
|
- Provide detailed rationale explaining decisions
|
||||||
|
- End with "Select 1-9 or just type your question/feedback:"
|
||||||
296
common/utils/bmad-doc-template.md
Normal file
296
common/utils/bmad-doc-template.md
Normal file
@@ -0,0 +1,296 @@
|
|||||||
|
# BMad Document Template Specification
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
BMad document templates are defined in YAML format to drive interactive document generation and agent interaction. Templates separate structure definition from content generation, making them both human and LLM-agent-friendly.
|
||||||
|
|
||||||
|
## Template Structure
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
template:
|
||||||
|
id: template-identifier
|
||||||
|
name: Human Readable Template Name
|
||||||
|
version: 1.0
|
||||||
|
output:
|
||||||
|
format: markdown
|
||||||
|
filename: default-path/to/{{filename}}.md
|
||||||
|
title: "{{variable}} Document Title"
|
||||||
|
|
||||||
|
workflow:
|
||||||
|
mode: interactive
|
||||||
|
elicitation: advanced-elicitation
|
||||||
|
|
||||||
|
sections:
|
||||||
|
- id: section-id
|
||||||
|
title: Section Title
|
||||||
|
instruction: |
|
||||||
|
Detailed instructions for the LLM on how to handle this section
|
||||||
|
# ... additional section properties
|
||||||
|
```
|
||||||
|
|
||||||
|
## Core Fields
|
||||||
|
|
||||||
|
### Template Metadata
|
||||||
|
|
||||||
|
- **id**: Unique identifier for the template
|
||||||
|
- **name**: Human-readable name displayed in UI
|
||||||
|
- **version**: Template version for tracking changes
|
||||||
|
- **output.format**: Default "markdown" for document templates
|
||||||
|
- **output.filename**: Default output file path (can include variables)
|
||||||
|
- **output.title**: Document title (becomes H1 in markdown)
|
||||||
|
|
||||||
|
### Workflow Configuration
|
||||||
|
|
||||||
|
- **workflow.mode**: Default interaction mode ("interactive" or "yolo")
|
||||||
|
- **workflow.elicitation**: Elicitation task to use ("advanced-elicitation")
|
||||||
|
|
||||||
|
## Section Properties
|
||||||
|
|
||||||
|
### Required Fields
|
||||||
|
|
||||||
|
- **id**: Unique section identifier
|
||||||
|
- **title**: Section heading text
|
||||||
|
- **instruction**: Detailed guidance for LLM on handling this section
|
||||||
|
|
||||||
|
### Optional Fields
|
||||||
|
|
||||||
|
#### Content Control
|
||||||
|
|
||||||
|
- **type**: Content type hint for structured sections
|
||||||
|
- **template**: Fixed template text for section content
|
||||||
|
- **item_template**: Template for repeatable items within section
|
||||||
|
- **prefix**: Prefix for numbered items (e.g., "FR", "NFR")
|
||||||
|
|
||||||
|
#### Behavior Flags
|
||||||
|
|
||||||
|
- **elicit**: Boolean - Apply elicitation after section rendered
|
||||||
|
- **repeatable**: Boolean - Section can be repeated multiple times
|
||||||
|
- **condition**: String - Condition for including section (e.g., "has ui requirements")
|
||||||
|
|
||||||
|
#### Content Guidance
|
||||||
|
|
||||||
|
- **examples**: Array of example content (not included in output)
|
||||||
|
- **choices**: Object with choice options for common decisions
|
||||||
|
- **placeholder**: Default placeholder text
|
||||||
|
|
||||||
|
#### Structure
|
||||||
|
|
||||||
|
- **sections**: Array of nested child sections
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### Content Types
|
||||||
|
|
||||||
|
- **bullet-list**: Unordered list items
|
||||||
|
- **numbered-list**: Ordered list with optional prefix
|
||||||
|
- **paragraphs**: Free-form paragraph text
|
||||||
|
- **table**: Structured table data
|
||||||
|
- **code-block**: Code or configuration blocks
|
||||||
|
- **template-text**: Fixed template with variable substitution
|
||||||
|
- **mermaid**: Mermaid diagram with specified type and details
|
||||||
|
|
||||||
|
### Special Types
|
||||||
|
|
||||||
|
- **repeatable-container**: Container for multiple instances
|
||||||
|
- **conditional-block**: Content shown based on conditions
|
||||||
|
- **choice-selector**: Present choices to user
|
||||||
|
|
||||||
|
## Advanced Features
|
||||||
|
|
||||||
|
### Variable Substitution
|
||||||
|
|
||||||
|
Use `{{variable_name}}` in titles, templates, and content:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
title: "Epic {{epic_number}} {{epic_title}}"
|
||||||
|
template: "As a {{user_type}}, I want {{action}}, so that {{benefit}}."
|
||||||
|
```
|
||||||
|
|
||||||
|
### Conditional Sections
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- id: ui-section
|
||||||
|
title: User Interface Design
|
||||||
|
condition: Project has UX/UI Requirements
|
||||||
|
instruction: Only include if project has UI components
|
||||||
|
```
|
||||||
|
|
||||||
|
### Choice Integration
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
choices:
|
||||||
|
architecture: [Monolith, Microservices, Serverless]
|
||||||
|
testing: [Unit Only, Unit + Integration, Full Pyramid]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mermaid Diagrams
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- id: system-architecture
|
||||||
|
title: System Architecture Diagram
|
||||||
|
type: mermaid
|
||||||
|
instruction: Create a system architecture diagram showing key components and data flow
|
||||||
|
mermaid_type: flowchart
|
||||||
|
details: |
|
||||||
|
Show the following components:
|
||||||
|
- User interface layer
|
||||||
|
- API gateway
|
||||||
|
- Core services
|
||||||
|
- Database layer
|
||||||
|
- External integrations
|
||||||
|
```
|
||||||
|
|
||||||
|
**Supported mermaid_type values:**
|
||||||
|
|
||||||
|
**Core Diagram Types:**
|
||||||
|
|
||||||
|
- `flowchart` - Flow charts and process diagrams
|
||||||
|
- `sequenceDiagram` - Sequence diagrams for interactions
|
||||||
|
- `classDiagram` - Class relationship diagrams (UML)
|
||||||
|
- `stateDiagram` - State transition diagrams
|
||||||
|
- `erDiagram` - Entity relationship diagrams
|
||||||
|
- `gantt` - Gantt charts for timelines
|
||||||
|
- `pie` - Pie charts for data visualization
|
||||||
|
|
||||||
|
**Advanced Diagram Types:**
|
||||||
|
|
||||||
|
- `journey` - User journey maps
|
||||||
|
- `mindmap` - Mindmaps for brainstorming
|
||||||
|
- `timeline` - Timeline diagrams for chronological events
|
||||||
|
- `quadrantChart` - Quadrant charts for data categorization
|
||||||
|
- `xyChart` - XY charts (bar charts, line charts)
|
||||||
|
- `sankey` - Sankey diagrams for flow visualization
|
||||||
|
|
||||||
|
**Specialized Types:**
|
||||||
|
|
||||||
|
- `c4Context` - C4 context diagrams (experimental)
|
||||||
|
- `requirement` - Requirement diagrams
|
||||||
|
- `packet` - Network packet diagrams
|
||||||
|
- `block` - Block diagrams
|
||||||
|
- `kanban` - Kanban boards
|
||||||
|
|
||||||
|
### Repeatable Sections
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- id: epic-details
|
||||||
|
title: Epic {{epic_number}} {{epic_title}}
|
||||||
|
repeatable: true
|
||||||
|
sections:
|
||||||
|
- id: story
|
||||||
|
title: Story {{epic_number}}.{{story_number}} {{story_title}}
|
||||||
|
repeatable: true
|
||||||
|
sections:
|
||||||
|
- id: criteria
|
||||||
|
title: Acceptance Criteria
|
||||||
|
type: numbered-list
|
||||||
|
item_template: "{{criterion_number}}: {{criteria}}"
|
||||||
|
repeatable: true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples with Code Blocks
|
||||||
|
|
||||||
|
````yaml
|
||||||
|
examples:
|
||||||
|
- "FR6: The system must authenticate users within 2 seconds"
|
||||||
|
- |
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant User
|
||||||
|
participant API
|
||||||
|
participant DB
|
||||||
|
User->>API: POST /login
|
||||||
|
API->>DB: Validate credentials
|
||||||
|
DB-->>API: User data
|
||||||
|
API-->>User: JWT token
|
||||||
|
```
|
||||||
|
- |
|
||||||
|
**Architecture Decision Record**
|
||||||
|
|
||||||
|
**Decision**: Use PostgreSQL for primary database
|
||||||
|
**Rationale**: ACID compliance and JSON support needed
|
||||||
|
**Consequences**: Requires database management expertise
|
||||||
|
````
|
||||||
|
|
||||||
|
## Section Hierarchy
|
||||||
|
|
||||||
|
Templates define the complete document structure starting with the first H2 - each level in is the next H#:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
sections:
|
||||||
|
- id: overview
|
||||||
|
title: Project Overview
|
||||||
|
sections:
|
||||||
|
- id: goals
|
||||||
|
title: Goals
|
||||||
|
- id: scope
|
||||||
|
title: Scope
|
||||||
|
sections:
|
||||||
|
- id: in-scope
|
||||||
|
title: In Scope
|
||||||
|
- id: out-scope
|
||||||
|
title: Out of Scope
|
||||||
|
```
|
||||||
|
|
||||||
|
## Processing Flow
|
||||||
|
|
||||||
|
1. **Parse Template**: Load and validate YAML structure
|
||||||
|
2. **Initialize Workflow**: Set interaction mode and elicitation
|
||||||
|
3. **Process Sections**: Handle each section in order:
|
||||||
|
- Check conditions
|
||||||
|
- Apply instructions
|
||||||
|
- Generate content
|
||||||
|
- Handle choices and variables
|
||||||
|
- Apply elicitation if specified
|
||||||
|
- Process nested sections
|
||||||
|
4. **Generate Output**: Create clean markdown document
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
### Template Design
|
||||||
|
|
||||||
|
- Keep instructions clear and specific
|
||||||
|
- Use examples for complex content
|
||||||
|
- Structure sections logically
|
||||||
|
- Include all necessary guidance for LLM
|
||||||
|
|
||||||
|
### Content Instructions
|
||||||
|
|
||||||
|
- Be explicit about expected format
|
||||||
|
- Include reasoning for decisions
|
||||||
|
- Specify interaction patterns
|
||||||
|
- Reference other documents when needed
|
||||||
|
|
||||||
|
### Variable Naming
|
||||||
|
|
||||||
|
- Use descriptive variable names
|
||||||
|
- Follow consistent naming conventions
|
||||||
|
- Document expected variable values
|
||||||
|
|
||||||
|
### Examples Usage
|
||||||
|
|
||||||
|
- Provide concrete examples for complex sections
|
||||||
|
- Include both simple and complex cases
|
||||||
|
- Use realistic project scenarios
|
||||||
|
- Include code blocks and diagrams when helpful
|
||||||
|
|
||||||
|
## Validation
|
||||||
|
|
||||||
|
Templates should be validated for:
|
||||||
|
|
||||||
|
- Valid YAML syntax
|
||||||
|
- Required fields present
|
||||||
|
- Consistent section IDs
|
||||||
|
- Proper nesting structure
|
||||||
|
- Valid variable references
|
||||||
|
|
||||||
|
## Migration from Legacy
|
||||||
|
|
||||||
|
When converting from markdown+frontmatter templates:
|
||||||
|
|
||||||
|
1. Extract embedded `[[LLM:]]` instructions to `instruction` fields
|
||||||
|
2. Convert `<<REPEAT>>` blocks to `repeatable: true` sections
|
||||||
|
3. Extract `^^CONDITIONS^^` to `condition` fields
|
||||||
|
4. Move `@{examples}` to `examples` arrays
|
||||||
|
5. Convert `{{placeholders}}` to proper variable syntax
|
||||||
|
|
||||||
|
This specification ensures templates are both human-readable and machine-processable while maintaining the flexibility needed for complex document generation.
|
||||||
804
dist/agents/analyst.txt
vendored
804
dist/agents/analyst.txt
vendored
File diff suppressed because it is too large
Load Diff
119
dist/agents/architect.txt
vendored
119
dist/agents/architect.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#architect ====================
|
|
||||||
|
==================== START: .bmad-core/agents/architect.md ====================
|
||||||
# architect
|
# architect
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -101,9 +102,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#architect ====================
|
==================== END: .bmad-core/agents/architect.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -123,7 +124,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-core/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -132,7 +133,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-core/templates/*.md` or `.bmad-core/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -150,14 +151,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-core/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-core/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -195,9 +196,9 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-deep-research-prompt ====================
|
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
# Create Deep Research Prompt Task
|
# Create Deep Research Prompt Task
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
||||||
@@ -499,9 +500,9 @@ Present these numbered options to the user:
|
|||||||
- Balance comprehensiveness with focus
|
- Balance comprehensiveness with focus
|
||||||
- Document assumptions and limitations clearly
|
- Document assumptions and limitations clearly
|
||||||
- Plan for iterative refinement based on initial findings
|
- Plan for iterative refinement based on initial findings
|
||||||
==================== END: tasks#create-deep-research-prompt ====================
|
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
|
|
||||||
==================== START: tasks#document-project ====================
|
==================== START: .bmad-core/tasks/document-project.md ====================
|
||||||
# Document an Existing Project
|
# Document an Existing Project
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -819,16 +820,16 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|||||||
- Documents technical debt, workarounds, and constraints honestly
|
- Documents technical debt, workarounds, and constraints honestly
|
||||||
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
||||||
- The goal is PRACTICAL documentation for AI agents doing real work
|
- The goal is PRACTICAL documentation for AI agents doing real work
|
||||||
==================== END: tasks#document-project ====================
|
==================== END: .bmad-core/tasks/document-project.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -837,7 +838,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -915,9 +916,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: templates#architecture-tmpl ====================
|
==================== START: .bmad-core/templates/architecture-tmpl.md ====================
|
||||||
# {{Project Name}} Architecture Document
|
# {{Project Name}} Architecture Document
|
||||||
|
|
||||||
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
|
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
|
||||||
@@ -928,7 +929,7 @@ The LLM will:
|
|||||||
|
|
||||||
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
||||||
|
|
||||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
This document outlines the overall project architecture for {{Project Name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
This document outlines the overall project architecture for {{Project Name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
||||||
|
|
||||||
@@ -973,7 +974,7 @@ If the project includes a significant user interface, a separate Frontend Archit
|
|||||||
|
|
||||||
Document the decision here before proceeding with the architecture design. In none, just say N/A
|
Document the decision here before proceeding with the architecture design. In none, just say N/A
|
||||||
|
|
||||||
After presenting this starter template section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this starter template section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Change Log
|
### Change Log
|
||||||
|
|
||||||
@@ -984,7 +985,7 @@ After presenting this starter template section, apply `tasks#advanced-elicitatio
|
|||||||
|
|
||||||
## High Level Architecture
|
## High Level Architecture
|
||||||
|
|
||||||
[[LLM: This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together (Introduction, Technical Summary, High Level Overview, Project Diagram, and Architectural Patterns), then apply `tasks#advanced-elicitation` protocol to the complete High Level Architecture section. The user can choose to refine the entire section or specific subsections.]]
|
[[LLM: This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together (Introduction, Technical Summary, High Level Overview, Project Diagram, and Architectural Patterns), then apply `.bmad-core/tasks/advanced-elicitation.md` protocol to the complete High Level Architecture section. The user can choose to refine the entire section or specific subsections.]]
|
||||||
|
|
||||||
### Technical Summary
|
### Technical Summary
|
||||||
|
|
||||||
@@ -1006,7 +1007,7 @@ After presenting this starter template section, apply `tasks#advanced-elicitatio
|
|||||||
4. Primary user interaction flow or data flow at a conceptual level
|
4. Primary user interaction flow or data flow at a conceptual level
|
||||||
5. Key architectural decisions and their rationale
|
5. Key architectural decisions and their rationale
|
||||||
|
|
||||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
After presenting this section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### High Level Project Diagram
|
### High Level Project Diagram
|
||||||
|
|
||||||
@@ -1020,7 +1021,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
|
|
||||||
Use appropriate Mermaid diagram type (graph TD, C4, sequence) based on what best represents the architecture
|
Use appropriate Mermaid diagram type (graph TD, C4, sequence) based on what best represents the architecture
|
||||||
|
|
||||||
After presenting the diagram, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the diagram, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Architectural and Design Patterns
|
### Architectural and Design Patterns
|
||||||
|
|
||||||
@@ -1052,13 +1053,13 @@ Common patterns to consider:
|
|||||||
|
|
||||||
@{/example}
|
@{/example}
|
||||||
|
|
||||||
[[LLM: After presenting the patterns, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the patterns, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||||
|
|
||||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences`
|
1. Review PRD technical assumptions and any preferences from `.bmad-core/data/technical-preferences.yaml` or an attached `technical-preferences`
|
||||||
2. For each category, present 2-3 viable options with pros/cons
|
2. For each category, present 2-3 viable options with pros/cons
|
||||||
3. Make a clear recommendation based on project needs
|
3. Make a clear recommendation based on project needs
|
||||||
4. Get explicit user approval for each selection
|
4. Get explicit user approval for each selection
|
||||||
@@ -1074,7 +1075,7 @@ Key decisions to finalize - before displaying the table, ensure you are aware of
|
|||||||
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
||||||
- Development tools
|
- Development tools
|
||||||
|
|
||||||
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away apply `tasks#advanced-elicitation` display - this statement and the options should be rendered and then prompt right all before allowing user input.]]
|
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away apply `.bmad-core/tasks/advanced-elicitation.md` display - this statement and the options should be rendered and then prompt right all before allowing user input.]]
|
||||||
|
|
||||||
### Cloud Infrastructure
|
### Cloud Infrastructure
|
||||||
|
|
||||||
@@ -1118,7 +1119,7 @@ Upon render of the table, ensure the user is aware of the importance of this sec
|
|||||||
|
|
||||||
Create a clear conceptual model before moving to database schema.
|
Create a clear conceptual model before moving to database schema.
|
||||||
|
|
||||||
After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
After presenting all data models, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
<<REPEAT: data_model>>
|
<<REPEAT: data_model>>
|
||||||
|
|
||||||
@@ -1152,7 +1153,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
- Technology specifics based on tech stack choices
|
- Technology specifics based on tech stack choices
|
||||||
|
|
||||||
5. Create component diagrams where helpful
|
5. Create component diagrams where helpful
|
||||||
6. After presenting all components, apply `tasks#advanced-elicitation` protocol]]
|
6. After presenting all components, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
<<REPEAT: component>>
|
<<REPEAT: component>>
|
||||||
|
|
||||||
@@ -1179,7 +1180,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
- Sequence diagrams for complex interactions
|
- Sequence diagrams for complex interactions
|
||||||
Choose the most appropriate for clarity
|
Choose the most appropriate for clarity
|
||||||
|
|
||||||
After presenting the diagrams, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the diagrams, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## External APIs
|
## External APIs
|
||||||
|
|
||||||
@@ -1233,7 +1234,7 @@ If no external APIs are needed, state this explicitly and skip to next section.]
|
|||||||
|
|
||||||
^^/CONDITION: has_external_apis^^
|
^^/CONDITION: has_external_apis^^
|
||||||
|
|
||||||
[[LLM: After presenting external APIs (or noting their absence), apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting external APIs (or noting their absence), apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Core Workflows
|
## Core Workflows
|
||||||
|
|
||||||
@@ -1247,7 +1248,7 @@ If no external APIs are needed, state this explicitly and skip to next section.]
|
|||||||
|
|
||||||
Focus on workflows that clarify architecture decisions or complex interactions.
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
||||||
|
|
||||||
After presenting the workflow diagrams, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the workflow diagrams, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## REST API Spec
|
## REST API Spec
|
||||||
|
|
||||||
@@ -1281,7 +1282,7 @@ servers:
|
|||||||
|
|
||||||
^^/CONDITION: has_rest_api^^
|
^^/CONDITION: has_rest_api^^
|
||||||
|
|
||||||
[[LLM: After presenting the REST API spec (or noting its absence if not applicable), apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the REST API spec (or noting its absence if not applicable), apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Database Schema
|
## Database Schema
|
||||||
|
|
||||||
@@ -1295,7 +1296,7 @@ servers:
|
|||||||
|
|
||||||
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
||||||
|
|
||||||
After presenting the database schema, apply `tasks#advanced-elicitation` protocol]]
|
After presenting the database schema, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Source Tree
|
## Source Tree
|
||||||
|
|
||||||
@@ -1310,7 +1311,7 @@ After presenting the database schema, apply `tasks#advanced-elicitation` protoco
|
|||||||
|
|
||||||
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
||||||
|
|
||||||
After presenting the structure, apply `tasks#advanced-elicitation` protocol to refine based on user feedback.]]
|
After presenting the structure, apply `.bmad-core/tasks/advanced-elicitation.md` protocol to refine based on user feedback.]]
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
{{project-root}}/
|
{{project-root}}/
|
||||||
@@ -1353,7 +1354,7 @@ project-root/
|
|||||||
@{/example}
|
@{/example}
|
||||||
```
|
```
|
||||||
|
|
||||||
[[LLM: After presenting the source tree structure, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the source tree structure, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Infrastructure and Deployment
|
## Infrastructure and Deployment
|
||||||
|
|
||||||
@@ -1398,7 +1399,7 @@ Get user input on deployment preferences and CI/CD tool choices.]]
|
|||||||
- **Trigger Conditions:** {{rollback_triggers}}
|
- **Trigger Conditions:** {{rollback_triggers}}
|
||||||
- **Recovery Time Objective:** {{rto}}
|
- **Recovery Time Objective:** {{rto}}
|
||||||
|
|
||||||
[[LLM: After presenting the infrastructure and deployment section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the infrastructure and deployment section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Error Handling Strategy
|
## Error Handling Strategy
|
||||||
|
|
||||||
@@ -1449,7 +1450,7 @@ This section guides both AI and human developers in consistent error handling.]]
|
|||||||
- **Compensation Logic:** {{compensation_patterns}}
|
- **Compensation Logic:** {{compensation_patterns}}
|
||||||
- **Idempotency:** {{idempotency_approach}}
|
- **Idempotency:** {{idempotency_approach}}
|
||||||
|
|
||||||
[[LLM: After presenting the error handling strategy, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the error handling strategy, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Coding Standards
|
## Coding Standards
|
||||||
|
|
||||||
@@ -1510,7 +1511,7 @@ Avoid obvious rules like "use SOLID principles" or "write clean code"]]
|
|||||||
|
|
||||||
^^/CONDITION: has_language_specifics^^
|
^^/CONDITION: has_language_specifics^^
|
||||||
|
|
||||||
[[LLM: After presenting the coding standards, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the coding standards, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Test Strategy and Standards
|
## Test Strategy and Standards
|
||||||
|
|
||||||
@@ -1523,7 +1524,7 @@ Avoid obvious rules like "use SOLID principles" or "write clean code"]]
|
|||||||
5. Determine integration test infrastructure
|
5. Determine integration test infrastructure
|
||||||
6. Plan for test data and external dependencies
|
6. Plan for test data and external dependencies
|
||||||
|
|
||||||
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference. Apply `tasks#advanced-elicitation` after initial draft.]]
|
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference. Apply `.bmad-core/tasks/advanced-elicitation.md` after initial draft.]]
|
||||||
|
|
||||||
### Testing Philosophy
|
### Testing Philosophy
|
||||||
|
|
||||||
@@ -1584,7 +1585,7 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|||||||
- **Performance Tests:** {{perf_test_approach}}
|
- **Performance Tests:** {{perf_test_approach}}
|
||||||
- **Security Tests:** {{security_test_approach}}
|
- **Security Tests:** {{security_test_approach}}
|
||||||
|
|
||||||
[[LLM: After presenting the test strategy section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the test strategy section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
@@ -1648,7 +1649,7 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|||||||
- **DAST Tool:** {{dynamic_analysis}}
|
- **DAST Tool:** {{dynamic_analysis}}
|
||||||
- **Penetration Testing:** {{pentest_schedule}}
|
- **Penetration Testing:** {{pentest_schedule}}
|
||||||
|
|
||||||
[[LLM: After presenting the security section, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the security section, apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
## Checklist Results Report
|
## Checklist Results Report
|
||||||
|
|
||||||
@@ -1694,9 +1695,9 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
|
|||||||
- Reference to this architecture and coding standards
|
- Reference to this architecture and coding standards
|
||||||
- First epic/story to implement
|
- First epic/story to implement
|
||||||
- Key technical decisions to follow]]
|
- Key technical decisions to follow]]
|
||||||
==================== END: templates#architecture-tmpl ====================
|
==================== END: .bmad-core/templates/architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#front-end-architecture-tmpl ====================
|
==================== START: .bmad-core/templates/front-end-architecture-tmpl.md ====================
|
||||||
# {{Project Name}} Frontend Architecture Document
|
# {{Project Name}} Frontend Architecture Document
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
|
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
|
||||||
@@ -1872,9 +1873,9 @@ Document the starter template decision and any constraints it imposes before pro
|
|||||||
- Key import patterns
|
- Key import patterns
|
||||||
- File naming conventions
|
- File naming conventions
|
||||||
- Project-specific patterns and utilities]]
|
- Project-specific patterns and utilities]]
|
||||||
==================== END: templates#front-end-architecture-tmpl ====================
|
==================== END: .bmad-core/templates/front-end-architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#fullstack-architecture-tmpl ====================
|
==================== START: .bmad-core/templates/fullstack-architecture-tmpl.md ====================
|
||||||
# {{Project Name}} Fullstack Architecture Document
|
# {{Project Name}} Fullstack Architecture Document
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
||||||
@@ -2893,9 +2894,9 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
## Checklist Results Report
|
## Checklist Results Report
|
||||||
|
|
||||||
[[LLM: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the `architect-checklist` and populate results here.]]
|
[[LLM: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the `architect-checklist` and populate results here.]]
|
||||||
==================== END: templates#fullstack-architecture-tmpl ====================
|
==================== END: .bmad-core/templates/fullstack-architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#brownfield-architecture-tmpl ====================
|
==================== START: .bmad-core/templates/brownfield-architecture-tmpl.md ====================
|
||||||
# {{Project Name}} Brownfield Enhancement Architecture
|
# {{Project Name}} Brownfield Enhancement Architecture
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
||||||
@@ -3440,9 +3441,9 @@ Present risk assessment and apply `tasks#advanced-elicitation` protocol]]
|
|||||||
- Key technical decisions based on real project constraints
|
- Key technical decisions based on real project constraints
|
||||||
- Existing system compatibility requirements with specific verification steps
|
- Existing system compatibility requirements with specific verification steps
|
||||||
- Clear sequencing of implementation to minimize risk to existing functionality]]
|
- Clear sequencing of implementation to minimize risk to existing functionality]]
|
||||||
==================== END: templates#brownfield-architecture-tmpl ====================
|
==================== END: .bmad-core/templates/brownfield-architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#architect-checklist ====================
|
==================== START: .bmad-core/checklists/architect-checklist.md ====================
|
||||||
# Architect Solution Validation Checklist
|
# Architect Solution Validation Checklist
|
||||||
|
|
||||||
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
|
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
|
||||||
@@ -3886,15 +3887,15 @@ Now that you've completed the checklist, generate a comprehensive validation rep
|
|||||||
- Component design clarity
|
- Component design clarity
|
||||||
|
|
||||||
After presenting the report, ask the user if they would like detailed analysis of any specific section, especially those with warnings or failures.]]
|
After presenting the report, ask the user if they would like detailed analysis of any specific section, especially those with warnings or failures.]]
|
||||||
==================== END: checklists#architect-checklist ====================
|
==================== END: .bmad-core/checklists/architect-checklist.md ====================
|
||||||
|
|
||||||
==================== START: data#technical-preferences ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# User-Defined Preferred Patterns and Preferences
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: data#technical-preferences ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -3921,4 +3922,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
1117
dist/agents/bmad-master.txt
vendored
1117
dist/agents/bmad-master.txt
vendored
File diff suppressed because it is too large
Load Diff
325
dist/agents/bmad-orchestrator.txt
vendored
325
dist/agents/bmad-orchestrator.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#bmad-orchestrator ====================
|
|
||||||
|
==================== START: .bmad-core/agents/bmad-orchestrator.md ====================
|
||||||
# bmad-orchestrator
|
# bmad-orchestrator
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -69,7 +70,7 @@ startup:
|
|||||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||||
- Mention *help shows all available commands and options
|
- Mention *help shows all available commands and options
|
||||||
- Check for active workflow plan using utils#plan-management
|
- Check for active workflow plan using .bmad-core/utils/plan-management.md
|
||||||
- 'If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details.'
|
- 'If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details.'
|
||||||
- 'If plan exists: Suggest next action based on plan progress'
|
- 'If plan exists: Suggest next action based on plan progress'
|
||||||
- Assess user goal against available agents and workflows in this bundle
|
- Assess user goal against available agents and workflows in this bundle
|
||||||
@@ -175,9 +176,9 @@ dependencies:
|
|||||||
- workflow-management
|
- workflow-management
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#bmad-orchestrator ====================
|
==================== END: .bmad-core/agents/bmad-orchestrator.md ====================
|
||||||
|
|
||||||
==================== START: tasks#advanced-elicitation ====================
|
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
|
||||||
# Advanced Elicitation Task
|
# Advanced Elicitation Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -185,94 +186,119 @@ dependencies:
|
|||||||
- Provide optional reflective and brainstorming actions to enhance content quality
|
- Provide optional reflective and brainstorming actions to enhance content quality
|
||||||
- Enable deeper exploration of ideas through structured elicitation techniques
|
- Enable deeper exploration of ideas through structured elicitation techniques
|
||||||
- Support iterative refinement through multiple analytical perspectives
|
- Support iterative refinement through multiple analytical perspectives
|
||||||
|
- Usable during template-driven document creation or any chat conversation
|
||||||
|
|
||||||
|
## Usage Scenarios
|
||||||
|
|
||||||
|
### Scenario 1: Template Document Creation
|
||||||
|
|
||||||
|
After outputting a section during document creation:
|
||||||
|
|
||||||
|
1. **Section Review**: Ask user to review the drafted section
|
||||||
|
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
||||||
|
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
||||||
|
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
||||||
|
|
||||||
|
### Scenario 2: General Chat Elicitation
|
||||||
|
|
||||||
|
User can request advanced elicitation on any agent output:
|
||||||
|
|
||||||
|
- User says "do advanced elicitation" or similar
|
||||||
|
- Agent selects 9 relevant methods for the context
|
||||||
|
- Same simple 0-9 selection process
|
||||||
|
|
||||||
## Task Instructions
|
## Task Instructions
|
||||||
|
|
||||||
### 1. Section Context and Review
|
### 1. Intelligent Method Selection
|
||||||
|
|
||||||
[[LLM: When invoked after outputting a section:
|
**Context Analysis**: Before presenting options, analyze:
|
||||||
|
|
||||||
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
|
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
||||||
|
- **Complexity Level**: Simple, moderate, or complex content
|
||||||
|
- **Stakeholder Needs**: Who will use this information
|
||||||
|
- **Risk Level**: High-impact decisions vs routine items
|
||||||
|
- **Creative Potential**: Opportunities for innovation or alternatives
|
||||||
|
|
||||||
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
|
**Method Selection Strategy**:
|
||||||
|
|
||||||
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
|
1. **Always Include Core Methods** (choose 3-4):
|
||||||
|
- Expand or Contract for Audience
|
||||||
|
- Critique and Refine
|
||||||
|
- Identify Potential Risks
|
||||||
|
- Assess Alignment with Goals
|
||||||
|
|
||||||
|
2. **Context-Specific Methods** (choose 4-5):
|
||||||
|
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
||||||
|
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
||||||
|
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
||||||
|
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
||||||
|
|
||||||
|
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
||||||
|
|
||||||
|
### 2. Section Context and Review
|
||||||
|
|
||||||
|
When invoked after outputting a section:
|
||||||
|
|
||||||
|
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
||||||
|
|
||||||
|
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
||||||
|
|
||||||
|
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
||||||
- The entire section as a whole
|
- The entire section as a whole
|
||||||
- Individual items within the section (specify which item when selecting an action)
|
- Individual items within the section (specify which item when selecting an action)
|
||||||
|
|
||||||
4. Then present the action list as specified below.]]
|
### 3. Present Elicitation Options
|
||||||
|
|
||||||
### 2. Ask for Review and Present Action List
|
**Review Request Process:**
|
||||||
|
|
||||||
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
|
- Ask the user to review the drafted section
|
||||||
|
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
||||||
|
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
||||||
|
- Keep descriptions short - just the method name
|
||||||
|
- Await simple numeric selection
|
||||||
|
|
||||||
**Present the numbered list (0-9) with this exact format:**
|
**Action List Presentation Format:**
|
||||||
|
|
||||||
```text
|
```text
|
||||||
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
**Advanced Elicitation Options**
|
||||||
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
Choose a number (0-8) or 9 to proceed:
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
0. [Method Name]
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
1. [Method Name]
|
||||||
2. Critique and Refine
|
2. [Method Name]
|
||||||
3. Analyze Logical Flow and Dependencies
|
3. [Method Name]
|
||||||
4. Assess Alignment with Overall Goals
|
4. [Method Name]
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
5. [Method Name]
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
6. [Method Name]
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
7. [Method Name]
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
8. [Method Name]
|
||||||
9. Proceed / No Further Actions
|
9. Proceed / No Further Actions
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Processing Guidelines
|
**Response Handling:**
|
||||||
|
|
||||||
**Do NOT show:**
|
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
||||||
|
- **Number 9**: Proceed to next section or continue conversation
|
||||||
|
- **Direct Feedback**: Apply user's suggested changes and continue
|
||||||
|
|
||||||
- The full protocol text with `[[LLM: ...]]` instructions
|
### 4. Method Execution Framework
|
||||||
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
|
||||||
- Any internal template markup
|
|
||||||
|
|
||||||
**After user selection from the list:**
|
**Execution Process:**
|
||||||
|
|
||||||
- Execute the chosen action according to the protocol instructions below
|
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
||||||
- Ask if they want to select another action or proceed with option 9 once complete
|
2. **Apply Context**: Execute the method from your current role's perspective
|
||||||
- Continue until user selects option 9 or indicates completion
|
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
||||||
|
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
||||||
|
|
||||||
## Action Definitions
|
**Execution Guidelines:**
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
||||||
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
||||||
|
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
||||||
|
- **Maintain Flow**: Keep the process moving efficiently
|
||||||
|
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
|
||||||
|
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||||
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
|
|
||||||
|
|
||||||
2. Critique and Refine
|
|
||||||
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
|
||||||
|
|
||||||
3. Analyze Logical Flow and Dependencies
|
|
||||||
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
|
||||||
|
|
||||||
4. Assess Alignment with Overall Goals
|
|
||||||
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
|
|
||||||
|
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
|
||||||
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
|
||||||
|
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
|
||||||
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
|
|
||||||
|
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
|
||||||
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
|
||||||
|
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
|
||||||
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
|
|
||||||
|
|
||||||
9. Proceed / No Further Actions
|
|
||||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
|
||||||
==================== END: tasks#advanced-elicitation ====================
|
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -292,7 +318,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-core/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -301,7 +327,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-core/templates/*.md` or `.bmad-core/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -319,14 +345,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-core/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-core/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -364,9 +390,9 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-workflow-plan ====================
|
==================== START: .bmad-core/tasks/create-workflow-plan.md ====================
|
||||||
# Create Workflow Plan Task
|
# Create Workflow Plan Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -656,9 +682,9 @@ BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack
|
|||||||
|
|
||||||
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
||||||
```
|
```
|
||||||
==================== END: tasks#create-workflow-plan ====================
|
==================== END: .bmad-core/tasks/create-workflow-plan.md ====================
|
||||||
|
|
||||||
==================== START: tasks#kb-mode-interaction ====================
|
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
|
||||||
# KB Mode Interaction Task
|
# KB Mode Interaction Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -729,9 +755,9 @@ Or ask me about anything else related to BMad-Method!
|
|||||||
**User**: Tell me about workflows
|
**User**: Tell me about workflows
|
||||||
|
|
||||||
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
||||||
==================== END: tasks#kb-mode-interaction ====================
|
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
|
||||||
|
|
||||||
==================== START: tasks#update-workflow-plan ====================
|
==================== START: .bmad-core/tasks/update-workflow-plan.md ====================
|
||||||
# Update Workflow Plan Task
|
# Update Workflow Plan Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -980,9 +1006,9 @@ The update is successful when:
|
|||||||
- Consider creating backup before major updates
|
- Consider creating backup before major updates
|
||||||
- Updates should enhance, not complicate, the workflow experience
|
- Updates should enhance, not complicate, the workflow experience
|
||||||
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
||||||
==================== END: tasks#update-workflow-plan ====================
|
==================== END: .bmad-core/tasks/update-workflow-plan.md ====================
|
||||||
|
|
||||||
==================== START: data#bmad-kb ====================
|
==================== START: .bmad-core/data/bmad-kb.md ====================
|
||||||
# BMad Knowledge Base
|
# BMad Knowledge Base
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
@@ -1018,13 +1044,15 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
|
|
||||||
### The Two-Phase Approach
|
### The Two-Phase Approach
|
||||||
|
|
||||||
**Phase 1: Planning (Web UI - Cost Effective)**
|
#### Phase 1: Planning (Web UI - Cost Effective)
|
||||||
|
|
||||||
- Use large context windows (Gemini's 1M tokens)
|
- Use large context windows (Gemini's 1M tokens)
|
||||||
- Generate comprehensive documents (PRD, Architecture)
|
- Generate comprehensive documents (PRD, Architecture)
|
||||||
- Leverage multiple agents for brainstorming
|
- Leverage multiple agents for brainstorming
|
||||||
- Create once, use throughout development
|
- Create once, use throughout development
|
||||||
|
|
||||||
**Phase 2: Development (IDE - Implementation)**
|
#### Phase 2: Development (IDE - Implementation)
|
||||||
|
|
||||||
- Shard documents into manageable pieces
|
- Shard documents into manageable pieces
|
||||||
- Execute focused SM → Dev cycles
|
- Execute focused SM → Dev cycles
|
||||||
- One story at a time, sequential progress
|
- One story at a time, sequential progress
|
||||||
@@ -1054,6 +1082,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
### Quick Start Options
|
### Quick Start Options
|
||||||
|
|
||||||
#### Option 1: Web UI
|
#### Option 1: Web UI
|
||||||
|
|
||||||
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
||||||
|
|
||||||
1. Navigate to `dist/teams/`
|
1. Navigate to `dist/teams/`
|
||||||
@@ -1063,7 +1092,8 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|||||||
5. Type `/help` to see available commands
|
5. Type `/help` to see available commands
|
||||||
|
|
||||||
#### Option 2: IDE Integration
|
#### Option 2: IDE Integration
|
||||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
||||||
|
**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Interactive installation (recommended)
|
# Interactive installation (recommended)
|
||||||
@@ -1071,18 +1101,21 @@ npx bmad-method install
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Installation Steps**:
|
**Installation Steps**:
|
||||||
|
|
||||||
- Choose "Complete installation"
|
- Choose "Complete installation"
|
||||||
- Select your IDE from supported options:
|
- Select your IDE from supported options:
|
||||||
- **Cursor**: Native AI integration
|
- **Cursor**: Native AI integration
|
||||||
- **Claude Code**: Anthropic's official IDE
|
- **Claude Code**: Anthropic's official IDE
|
||||||
- **Windsurf**: Built-in AI capabilities
|
- **Windsurf**: Built-in AI capabilities
|
||||||
|
- **Trae**: Built-in AI capabilities
|
||||||
- **Cline**: VS Code extension with AI features
|
- **Cline**: VS Code extension with AI features
|
||||||
- **Roo Code**: Web-based IDE with agent support
|
- **Roo Code**: Web-based IDE with agent support
|
||||||
- **Github Copilot**: AI-powered coding assistant
|
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
||||||
|
|
||||||
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
||||||
|
|
||||||
**Verify Installation**:
|
**Verify Installation**:
|
||||||
|
|
||||||
- `.bmad-core/` folder created with all agents
|
- `.bmad-core/` folder created with all agents
|
||||||
- IDE-specific integration files created
|
- IDE-specific integration files created
|
||||||
- All agent commands/rules/modes available
|
- All agent commands/rules/modes available
|
||||||
@@ -1092,12 +1125,14 @@ npx bmad-method install
|
|||||||
### Environment Selection Guide
|
### Environment Selection Guide
|
||||||
|
|
||||||
**Use Web UI for**:
|
**Use Web UI for**:
|
||||||
|
|
||||||
- Initial planning and documentation (PRD, architecture)
|
- Initial planning and documentation (PRD, architecture)
|
||||||
- Cost-effective document creation (especially with Gemini)
|
- Cost-effective document creation (especially with Gemini)
|
||||||
- Brainstorming and analysis phases
|
- Brainstorming and analysis phases
|
||||||
- Multi-agent consultation and planning
|
- Multi-agent consultation and planning
|
||||||
|
|
||||||
**Use IDE for**:
|
**Use IDE for**:
|
||||||
|
|
||||||
- Active development and coding
|
- Active development and coding
|
||||||
- File operations and project integration
|
- File operations and project integration
|
||||||
- Document sharding and story management
|
- Document sharding and story management
|
||||||
@@ -1110,35 +1145,41 @@ npx bmad-method install
|
|||||||
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
||||||
|
|
||||||
**Pros of IDE-Only**:
|
**Pros of IDE-Only**:
|
||||||
|
|
||||||
- Single environment workflow
|
- Single environment workflow
|
||||||
- Direct file operations from start
|
- Direct file operations from start
|
||||||
- No copy/paste between environments
|
- No copy/paste between environments
|
||||||
- Immediate project integration
|
- Immediate project integration
|
||||||
|
|
||||||
**Cons of IDE-Only**:
|
**Cons of IDE-Only**:
|
||||||
|
|
||||||
- Higher token costs for large document creation
|
- Higher token costs for large document creation
|
||||||
- Smaller context windows (varies by IDE/model)
|
- Smaller context windows (varies by IDE/model)
|
||||||
- May hit limits during planning phases
|
- May hit limits during planning phases
|
||||||
- Less cost-effective for brainstorming
|
- Less cost-effective for brainstorming
|
||||||
|
|
||||||
**Using Web Agents in IDE**:
|
**Using Web Agents in IDE**:
|
||||||
|
|
||||||
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
||||||
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
||||||
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
||||||
|
|
||||||
**About bmad-master and bmad-orchestrator**:
|
**About bmad-master and bmad-orchestrator**:
|
||||||
|
|
||||||
- **bmad-master**: CAN do any task without switching agents, BUT...
|
- **bmad-master**: CAN do any task without switching agents, BUT...
|
||||||
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
||||||
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
||||||
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
||||||
|
|
||||||
**CRITICAL RULE for Development**:
|
**CRITICAL RULE for Development**:
|
||||||
|
|
||||||
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
||||||
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
||||||
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
||||||
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
||||||
|
|
||||||
**Best Practice for IDE-Only**:
|
**Best Practice for IDE-Only**:
|
||||||
|
|
||||||
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
||||||
2. Create documents directly in project
|
2. Create documents directly in project
|
||||||
3. Shard immediately after creation
|
3. Shard immediately after creation
|
||||||
@@ -1162,17 +1203,20 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|||||||
### Key Configuration Areas
|
### Key Configuration Areas
|
||||||
|
|
||||||
#### PRD Configuration
|
#### PRD Configuration
|
||||||
|
|
||||||
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
||||||
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
||||||
- **prdShardedLocation**: Where to find sharded epic files
|
- **prdShardedLocation**: Where to find sharded epic files
|
||||||
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
||||||
|
|
||||||
#### Architecture Configuration
|
#### Architecture Configuration
|
||||||
|
|
||||||
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
||||||
- **architectureSharded**: Whether architecture is split into components
|
- **architectureSharded**: Whether architecture is split into components
|
||||||
- **architectureShardedLocation**: Where sharded architecture files live
|
- **architectureShardedLocation**: Where sharded architecture files live
|
||||||
|
|
||||||
#### Developer Files
|
#### Developer Files
|
||||||
|
|
||||||
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
||||||
- **devDebugLog**: Where dev agent logs repeated failures
|
- **devDebugLog**: Where dev agent logs repeated failures
|
||||||
- **agentCoreDump**: Export location for chat conversations
|
- **agentCoreDump**: Export location for chat conversations
|
||||||
@@ -1187,6 +1231,7 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|||||||
### Common Configurations
|
### Common Configurations
|
||||||
|
|
||||||
**Legacy V3 Project**:
|
**Legacy V3 Project**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prdVersion: v3
|
prdVersion: v3
|
||||||
prdSharded: false
|
prdSharded: false
|
||||||
@@ -1195,6 +1240,7 @@ architectureSharded: false
|
|||||||
```
|
```
|
||||||
|
|
||||||
**V4 Optimized Project**:
|
**V4 Optimized Project**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prdVersion: v4
|
prdVersion: v4
|
||||||
prdSharded: true
|
prdSharded: true
|
||||||
@@ -1260,17 +1306,21 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
#### IDE-Specific Syntax
|
#### IDE-Specific Syntax
|
||||||
|
|
||||||
**Agent Loading by IDE**:
|
**Agent Loading by IDE**:
|
||||||
|
|
||||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
|
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||||
|
|
||||||
**Chat Management Guidelines**:
|
**Chat Management Guidelines**:
|
||||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
||||||
|
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
||||||
- **Roo Code**: Switch modes within the same conversation
|
- **Roo Code**: Switch modes within the same conversation
|
||||||
|
|
||||||
**Common Task Commands**:
|
**Common Task Commands**:
|
||||||
|
|
||||||
- `*help` - Show available commands
|
- `*help` - Show available commands
|
||||||
- `*status` - Show current context/progress
|
- `*status` - Show current context/progress
|
||||||
- `*exit` - Exit the agent mode
|
- `*exit` - Exit the agent mode
|
||||||
@@ -1279,6 +1329,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
- `*create` - Run create-next-story task (SM agent)
|
- `*create` - Run create-next-story task (SM agent)
|
||||||
|
|
||||||
**In Web UI**:
|
**In Web UI**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
/pm create-doc prd
|
/pm create-doc prd
|
||||||
/architect review system design
|
/architect review system design
|
||||||
@@ -1292,16 +1343,19 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|||||||
### Pre-Built Teams
|
### Pre-Built Teams
|
||||||
|
|
||||||
#### Team All
|
#### Team All
|
||||||
|
|
||||||
- **Includes**: All 10 agents + orchestrator
|
- **Includes**: All 10 agents + orchestrator
|
||||||
- **Use Case**: Complete projects requiring all roles
|
- **Use Case**: Complete projects requiring all roles
|
||||||
- **Bundle**: `team-all.txt`
|
- **Bundle**: `team-all.txt`
|
||||||
|
|
||||||
#### Team Fullstack
|
#### Team Fullstack
|
||||||
|
|
||||||
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
||||||
- **Use Case**: End-to-end web/mobile development
|
- **Use Case**: End-to-end web/mobile development
|
||||||
- **Bundle**: `team-fullstack.txt`
|
- **Bundle**: `team-fullstack.txt`
|
||||||
|
|
||||||
#### Team No-UI
|
#### Team No-UI
|
||||||
|
|
||||||
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
||||||
- **Use Case**: Backend services, APIs, system development
|
- **Use Case**: Backend services, APIs, system development
|
||||||
- **Bundle**: `team-no-ui.txt`
|
- **Bundle**: `team-no-ui.txt`
|
||||||
@@ -1315,22 +1369,26 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
|||||||
### Key Architectural Components
|
### Key Architectural Components
|
||||||
|
|
||||||
#### 1. Agents (`bmad-core/agents/`)
|
#### 1. Agents (`bmad-core/agents/`)
|
||||||
|
|
||||||
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
||||||
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
||||||
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
||||||
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
||||||
|
|
||||||
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
||||||
|
|
||||||
- **Purpose**: Define collections of agents bundled together for specific purposes
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
||||||
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
||||||
- **Usage**: Creates pre-packaged contexts for web UI environments
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
||||||
|
|
||||||
#### 3. Workflows (`bmad-core/workflows/`)
|
#### 3. Workflows (`bmad-core/workflows/`)
|
||||||
|
|
||||||
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
||||||
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
||||||
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
||||||
|
|
||||||
#### 4. Reusable Resources
|
#### 4. Reusable Resources
|
||||||
|
|
||||||
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
||||||
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
||||||
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
||||||
@@ -1347,7 +1405,7 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
|||||||
|
|
||||||
#### Web UI Environment
|
#### Web UI Environment
|
||||||
|
|
||||||
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
|
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent
|
||||||
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
|
||||||
- Created by the web-builder tool for upload to web interfaces
|
- Created by the web-builder tool for upload to web interfaces
|
||||||
- Provides complete context in one package
|
- Provides complete context in one package
|
||||||
@@ -1370,6 +1428,7 @@ BMad employs a sophisticated template system with three key components:
|
|||||||
### Technical Preferences Integration
|
### Technical Preferences Integration
|
||||||
|
|
||||||
The `technical-preferences.md` file serves as a persistent technical profile that:
|
The `technical-preferences.md` file serves as a persistent technical profile that:
|
||||||
|
|
||||||
- Ensures consistency across all agents and projects
|
- Ensures consistency across all agents and projects
|
||||||
- Eliminates repetitive technology specification
|
- Eliminates repetitive technology specification
|
||||||
- Provides personalized recommendations aligned with user preferences
|
- Provides personalized recommendations aligned with user preferences
|
||||||
@@ -1378,6 +1437,7 @@ The `technical-preferences.md` file serves as a persistent technical profile tha
|
|||||||
### Build and Delivery Process
|
### Build and Delivery Process
|
||||||
|
|
||||||
The `web-builder.js` tool creates web-ready bundles by:
|
The `web-builder.js` tool creates web-ready bundles by:
|
||||||
|
|
||||||
1. Reading agent or team definition files
|
1. Reading agent or team definition files
|
||||||
2. Recursively resolving all dependencies
|
2. Recursively resolving all dependencies
|
||||||
3. Concatenating content into single text files with clear separators
|
3. Concatenating content into single text files with clear separators
|
||||||
@@ -1392,11 +1452,13 @@ This architecture enables seamless operation across environments while maintaini
|
|||||||
**Ideal for cost efficiency with Gemini's massive context:**
|
**Ideal for cost efficiency with Gemini's massive context:**
|
||||||
|
|
||||||
**For Brownfield Projects - Start Here!**:
|
**For Brownfield Projects - Start Here!**:
|
||||||
|
|
||||||
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
||||||
2. **Document existing system**: `/analyst` → `*document-project`
|
2. **Document existing system**: `/analyst` → `*document-project`
|
||||||
3. **Creates comprehensive docs** from entire codebase analysis
|
3. **Creates comprehensive docs** from entire codebase analysis
|
||||||
|
|
||||||
**For All Projects**:
|
**For All Projects**:
|
||||||
|
|
||||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||||
@@ -1407,12 +1469,14 @@ This architecture enables seamless operation across environments while maintaini
|
|||||||
#### Example Planning Prompts
|
#### Example Planning Prompts
|
||||||
|
|
||||||
**For PRD Creation**:
|
**For PRD Creation**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
"I want to build a [type] application that [core purpose].
|
"I want to build a [type] application that [core purpose].
|
||||||
Help me brainstorm features and create a comprehensive PRD."
|
Help me brainstorm features and create a comprehensive PRD."
|
||||||
```
|
```
|
||||||
|
|
||||||
**For Architecture Design**:
|
**For Architecture Design**:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
"Based on this PRD, design a scalable technical architecture
|
"Based on this PRD, design a scalable technical architecture
|
||||||
that can handle [specific requirements]."
|
that can handle [specific requirements]."
|
||||||
@@ -1430,7 +1494,7 @@ that can handle [specific requirements]."
|
|||||||
|
|
||||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||||
|
|
||||||
1. **Document Sharding** (CRITICAL STEP):
|
1. **Document Sharding** (CRITICAL STEP):
|
||||||
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
||||||
- Two methods to shard:
|
- Two methods to shard:
|
||||||
a) **Manual**: Drag `shard-doc` task + document file into chat
|
a) **Manual**: Drag `shard-doc` task + document file into chat
|
||||||
@@ -1444,32 +1508,33 @@ that can handle [specific requirements]."
|
|||||||
- Source tree document and coding standards for dev agent reference
|
- Source tree document and coding standards for dev agent reference
|
||||||
- Sharded docs for SM agent story creation
|
- Sharded docs for SM agent story creation
|
||||||
|
|
||||||
**Resulting Folder Structure**:
|
Resulting Folder Structure:
|
||||||
|
|
||||||
- `docs/prd/` - Broken down PRD sections
|
- `docs/prd/` - Broken down PRD sections
|
||||||
- `docs/architecture/` - Broken down architecture sections
|
- `docs/architecture/` - Broken down architecture sections
|
||||||
- `docs/stories/` - Generated user stories
|
- `docs/stories/` - Generated user stories
|
||||||
|
|
||||||
3. **Development Cycle** (Sequential, one story at a time):
|
1. **Development Cycle** (Sequential, one story at a time):
|
||||||
|
|
||||||
**CRITICAL CONTEXT MANAGEMENT**:
|
**CRITICAL CONTEXT MANAGEMENT**:
|
||||||
- **Context windows matter!** Always use fresh, clean context windows
|
- **Context windows matter!** Always use fresh, clean context windows
|
||||||
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
||||||
- **ALWAYS start new chat between SM, Dev, and QA work**
|
- **ALWAYS start new chat between SM, Dev, and QA work**
|
||||||
|
|
||||||
**Step 1 - Story Creation**:
|
**Step 1 - Story Creation**:
|
||||||
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
||||||
- SM executes create-next-story task
|
- SM executes create-next-story task
|
||||||
- Review generated story in `docs/stories/`
|
- Review generated story in `docs/stories/`
|
||||||
- Update status from "Draft" to "Approved"
|
- Update status from "Draft" to "Approved"
|
||||||
|
|
||||||
**Step 2 - Story Implementation**:
|
**Step 2 - Story Implementation**:
|
||||||
- **NEW CLEAN CHAT** → `@dev`
|
- **NEW CLEAN CHAT** → `@dev`
|
||||||
- Agent asks which story to implement
|
- Agent asks which story to implement
|
||||||
- Include story file content to save dev agent lookup time
|
- Include story file content to save dev agent lookup time
|
||||||
- Dev follows tasks/subtasks, marking completion
|
- Dev follows tasks/subtasks, marking completion
|
||||||
- Dev maintains File List of all changes
|
- Dev maintains File List of all changes
|
||||||
- Dev marks story as "Review" when complete with all tests passing
|
- Dev marks story as "Review" when complete with all tests passing
|
||||||
|
|
||||||
**Step 3 - Senior QA Review**:
|
**Step 3 - Senior QA Review**:
|
||||||
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
||||||
- QA performs senior developer code review
|
- QA performs senior developer code review
|
||||||
@@ -1477,7 +1542,7 @@ that can handle [specific requirements]."
|
|||||||
- QA appends results to story's QA Results section
|
- QA appends results to story's QA Results section
|
||||||
- If approved: Status → "Done"
|
- If approved: Status → "Done"
|
||||||
- If changes needed: Status stays "Review" with unchecked items for dev
|
- If changes needed: Status stays "Review" with unchecked items for dev
|
||||||
|
|
||||||
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
||||||
|
|
||||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||||
@@ -1485,6 +1550,7 @@ that can handle [specific requirements]."
|
|||||||
### Status Tracking Workflow
|
### Status Tracking Workflow
|
||||||
|
|
||||||
Stories progress through defined statuses:
|
Stories progress through defined statuses:
|
||||||
|
|
||||||
- **Draft** → **Approved** → **InProgress** → **Done**
|
- **Draft** → **Approved** → **InProgress** → **Done**
|
||||||
|
|
||||||
Each status change requires user verification and approval before proceeding.
|
Each status change requires user verification and approval before proceeding.
|
||||||
@@ -1492,6 +1558,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
### Workflow Types
|
### Workflow Types
|
||||||
|
|
||||||
#### Greenfield Development
|
#### Greenfield Development
|
||||||
|
|
||||||
- Business analysis and market research
|
- Business analysis and market research
|
||||||
- Product requirements and feature definition
|
- Product requirements and feature definition
|
||||||
- System architecture and design
|
- System architecture and design
|
||||||
@@ -1505,6 +1572,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**Complete Brownfield Workflow Options**:
|
**Complete Brownfield Workflow Options**:
|
||||||
|
|
||||||
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
||||||
|
|
||||||
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
||||||
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
||||||
3. **Focused documentation**: `@analyst` → `*document-project`
|
3. **Focused documentation**: `@analyst` → `*document-project`
|
||||||
@@ -1515,18 +1583,19 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
- Avoids bloating docs with unused code
|
- Avoids bloating docs with unused code
|
||||||
|
|
||||||
**Option 2: Document-First (Good for Smaller Projects)**:
|
**Option 2: Document-First (Good for Smaller Projects)**:
|
||||||
|
|
||||||
1. **Upload project to Gemini Web**
|
1. **Upload project to Gemini Web**
|
||||||
2. **Document everything**: `@analyst` → `*document-project`
|
2. **Document everything**: `@analyst` → `*document-project`
|
||||||
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
||||||
- More thorough but can create excessive documentation
|
- More thorough but can create excessive documentation
|
||||||
|
|
||||||
2. **Requirements Gathering**:
|
4. **Requirements Gathering**:
|
||||||
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
||||||
- **Analyzes**: Existing system, constraints, integration points
|
- **Analyzes**: Existing system, constraints, integration points
|
||||||
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
||||||
- **Creates**: Epic and story structure for changes
|
- **Creates**: Epic and story structure for changes
|
||||||
|
|
||||||
3. **Architecture Planning**:
|
5. **Architecture Planning**:
|
||||||
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
||||||
- **Integration Strategy**: How new features integrate with existing system
|
- **Integration Strategy**: How new features integrate with existing system
|
||||||
- **Migration Planning**: Gradual rollout and backwards compatibility
|
- **Migration Planning**: Gradual rollout and backwards compatibility
|
||||||
@@ -1535,10 +1604,12 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**Brownfield-Specific Resources**:
|
**Brownfield-Specific Resources**:
|
||||||
|
|
||||||
**Templates**:
|
**Templates**:
|
||||||
|
|
||||||
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
||||||
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
||||||
|
|
||||||
**Tasks**:
|
**Tasks**:
|
||||||
|
|
||||||
- `document-project`: Generates comprehensive documentation from existing codebase
|
- `document-project`: Generates comprehensive documentation from existing codebase
|
||||||
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
||||||
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
||||||
@@ -1546,18 +1617,21 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
**When to Use Each Approach**:
|
**When to Use Each Approach**:
|
||||||
|
|
||||||
**Full Brownfield Workflow** (Recommended for):
|
**Full Brownfield Workflow** (Recommended for):
|
||||||
|
|
||||||
- Major feature additions
|
- Major feature additions
|
||||||
- System modernization
|
- System modernization
|
||||||
- Complex integrations
|
- Complex integrations
|
||||||
- Multiple related changes
|
- Multiple related changes
|
||||||
|
|
||||||
**Quick Epic/Story Creation** (Use when):
|
**Quick Epic/Story Creation** (Use when):
|
||||||
|
|
||||||
- Single, focused enhancement
|
- Single, focused enhancement
|
||||||
- Isolated bug fixes
|
- Isolated bug fixes
|
||||||
- Small feature additions
|
- Small feature additions
|
||||||
- Well-documented existing system
|
- Well-documented existing system
|
||||||
|
|
||||||
**Critical Success Factors**:
|
**Critical Success Factors**:
|
||||||
|
|
||||||
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
||||||
2. **Context Matters**: Provide agents access to relevant code sections
|
2. **Context Matters**: Provide agents access to relevant code sections
|
||||||
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
||||||
@@ -1573,6 +1647,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
- `docs/architecture.md` - System Architecture Document
|
- `docs/architecture.md` - System Architecture Document
|
||||||
|
|
||||||
**Why These Names Matter**:
|
**Why These Names Matter**:
|
||||||
|
|
||||||
- Agents automatically reference these files during development
|
- Agents automatically reference these files during development
|
||||||
- Sharding tasks expect these specific filenames
|
- Sharding tasks expect these specific filenames
|
||||||
- Workflow automation depends on standard naming
|
- Workflow automation depends on standard naming
|
||||||
@@ -1591,6 +1666,7 @@ Each status change requires user verification and approval before proceeding.
|
|||||||
Templates with Level 2 headings (`##`) can be automatically sharded:
|
Templates with Level 2 headings (`##`) can be automatically sharded:
|
||||||
|
|
||||||
**Original PRD**:
|
**Original PRD**:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## Goals and Background Context
|
## Goals and Background Context
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -1599,6 +1675,7 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|||||||
```
|
```
|
||||||
|
|
||||||
**After Sharding**:
|
**After Sharding**:
|
||||||
|
|
||||||
- `docs/prd/goals-and-background-context.md`
|
- `docs/prd/goals-and-background-context.md`
|
||||||
- `docs/prd/requirements.md`
|
- `docs/prd/requirements.md`
|
||||||
- `docs/prd/user-interface-design-goals.md`
|
- `docs/prd/user-interface-design-goals.md`
|
||||||
@@ -1611,12 +1688,14 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|||||||
### Environment-Specific Usage
|
### Environment-Specific Usage
|
||||||
|
|
||||||
**Web UI Best For**:
|
**Web UI Best For**:
|
||||||
|
|
||||||
- Initial planning and documentation phases
|
- Initial planning and documentation phases
|
||||||
- Cost-effective large document creation
|
- Cost-effective large document creation
|
||||||
- Agent consultation and brainstorming
|
- Agent consultation and brainstorming
|
||||||
- Multi-agent workflows with orchestrator
|
- Multi-agent workflows with orchestrator
|
||||||
|
|
||||||
**IDE Best For**:
|
**IDE Best For**:
|
||||||
|
|
||||||
- Active development and implementation
|
- Active development and implementation
|
||||||
- File operations and project integration
|
- File operations and project integration
|
||||||
- Story management and development cycles
|
- Story management and development cycles
|
||||||
@@ -1651,6 +1730,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|||||||
For full details, see `CONTRIBUTING.md`. Key points:
|
For full details, see `CONTRIBUTING.md`. Key points:
|
||||||
|
|
||||||
**Fork Workflow**:
|
**Fork Workflow**:
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Create feature branches
|
2. Create feature branches
|
||||||
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
||||||
@@ -1658,12 +1738,14 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|||||||
5. One feature/fix per PR
|
5. One feature/fix per PR
|
||||||
|
|
||||||
**PR Requirements**:
|
**PR Requirements**:
|
||||||
|
|
||||||
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
||||||
- Use conventional commits (feat:, fix:, docs:)
|
- Use conventional commits (feat:, fix:, docs:)
|
||||||
- Atomic commits - one logical change per commit
|
- Atomic commits - one logical change per commit
|
||||||
- Must align with guiding principles
|
- Must align with guiding principles
|
||||||
|
|
||||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||||
|
|
||||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||||
- **Natural Language First**: Everything in markdown, no code in core
|
- **Natural Language First**: Everything in markdown, no code in core
|
||||||
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
||||||
@@ -1685,12 +1767,14 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
### Available Expansion Packs
|
### Available Expansion Packs
|
||||||
|
|
||||||
**Technical Packs**:
|
**Technical Packs**:
|
||||||
|
|
||||||
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
||||||
- **Game Development**: Game designers, level designers, narrative writers
|
- **Game Development**: Game designers, level designers, narrative writers
|
||||||
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
||||||
- **Data Science**: ML engineers, data scientists, visualization experts
|
- **Data Science**: ML engineers, data scientists, visualization experts
|
||||||
|
|
||||||
**Non-Technical Packs**:
|
**Non-Technical Packs**:
|
||||||
|
|
||||||
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
||||||
- **Creative Writing**: Plot architects, character developers, world builders
|
- **Creative Writing**: Plot architects, character developers, world builders
|
||||||
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
||||||
@@ -1698,6 +1782,7 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
- **Legal Support**: Contract analysts, compliance checkers
|
- **Legal Support**: Contract analysts, compliance checkers
|
||||||
|
|
||||||
**Specialty Packs**:
|
**Specialty Packs**:
|
||||||
|
|
||||||
- **Expansion Creator**: Tools to build your own expansion packs
|
- **Expansion Creator**: Tools to build your own expansion packs
|
||||||
- **RPG Game Master**: Tabletop gaming assistance
|
- **RPG Game Master**: Tabletop gaming assistance
|
||||||
- **Life Event Planning**: Wedding planners, event coordinators
|
- **Life Event Planning**: Wedding planners, event coordinators
|
||||||
@@ -1707,11 +1792,13 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|||||||
|
|
||||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||||
3. **Install via CLI**:
|
3. **Install via CLI**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method install
|
npx bmad-method install
|
||||||
# Select "Install expansion pack" option
|
# Select "Install expansion pack" option
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
||||||
|
|
||||||
### Creating Custom Expansion Packs
|
### Creating Custom Expansion Packs
|
||||||
@@ -1732,9 +1819,9 @@ Use the **expansion-creator** pack to build your own:
|
|||||||
- **Documentation**: Check `docs/` folder for project-specific context
|
- **Documentation**: Check `docs/` folder for project-specific context
|
||||||
- **Community**: Discord and GitHub resources available for support
|
- **Community**: Discord and GitHub resources available for support
|
||||||
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
||||||
==================== END: data#bmad-kb ====================
|
==================== END: .bmad-core/data/bmad-kb.md ====================
|
||||||
|
|
||||||
==================== START: utils#plan-management ====================
|
==================== START: .bmad-core/utils/plan-management.md ====================
|
||||||
# Plan Management Utility
|
# Plan Management Utility
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -1745,14 +1832,10 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|||||||
|
|
||||||
### 1. Check Plan Existence
|
### 1. Check Plan Existence
|
||||||
|
|
||||||
[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
|
|
||||||
|
|
||||||
```
|
|
||||||
Check for workflow plan:
|
Check for workflow plan:
|
||||||
|
|
||||||
1. Look for docs/workflow-plan.md (default location)
|
1. Look for docs/workflow-plan.md (default location)
|
||||||
2. Check core-config.yaml for custom plan location
|
2. Return plan status to user (exists/not exists) - if not exists then HALT.
|
||||||
3. Return plan status (exists/not exists)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Parse Plan Status
|
### 2. Parse Plan Status
|
||||||
|
|
||||||
@@ -1793,7 +1876,7 @@ Check for workflow plan:
|
|||||||
|
|
||||||
**Warning Templates:**
|
**Warning Templates:**
|
||||||
|
|
||||||
```
|
```text
|
||||||
SEQUENCE WARNING:
|
SEQUENCE WARNING:
|
||||||
The workflow plan shows you should complete "{expected_step}" next.
|
The workflow plan shows you should complete "{expected_step}" next.
|
||||||
You're attempting to: "{requested_action}"
|
You're attempting to: "{requested_action}"
|
||||||
@@ -1827,7 +1910,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
**For Agents (startup sequence)**:
|
**For Agents (startup sequence)**:
|
||||||
|
|
||||||
```
|
```text
|
||||||
1. Check if plan exists using this utility
|
1. Check if plan exists using this utility
|
||||||
2. If exists:
|
2. If exists:
|
||||||
- Parse current status
|
- Parse current status
|
||||||
@@ -1838,7 +1921,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
**For Tasks (pre-execution)**:
|
**For Tasks (pre-execution)**:
|
||||||
|
|
||||||
```
|
```text
|
||||||
1. Check if plan exists
|
1. Check if plan exists
|
||||||
2. If exists:
|
2. If exists:
|
||||||
- Verify this task aligns with plan
|
- Verify this task aligns with plan
|
||||||
@@ -1854,7 +1937,7 @@ In flexible mode: Allow with confirmation
|
|||||||
|
|
||||||
[[LLM: Standard format for showing plan status]]
|
[[LLM: Standard format for showing plan status]]
|
||||||
|
|
||||||
```
|
```text
|
||||||
📋 Workflow Plan Status
|
📋 Workflow Plan Status
|
||||||
━━━━━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━━━━━
|
||||||
Workflow: {workflow_name}
|
Workflow: {workflow_name}
|
||||||
@@ -1907,7 +1990,7 @@ If user wants to abandon plan:
|
|||||||
|
|
||||||
### Example 1: Agent Startup Check
|
### Example 1: Agent Startup Check
|
||||||
|
|
||||||
```
|
```text
|
||||||
BMad Master starting...
|
BMad Master starting...
|
||||||
|
|
||||||
[Check for plan]
|
[Check for plan]
|
||||||
@@ -1921,7 +2004,7 @@ Use *agent pm to switch, or *plan-status to see full progress.
|
|||||||
|
|
||||||
### Example 2: Task Sequence Warning
|
### Example 2: Task Sequence Warning
|
||||||
|
|
||||||
```
|
```text
|
||||||
User: *task create-next-story
|
User: *task create-next-story
|
||||||
|
|
||||||
[Plan check triggered]
|
[Plan check triggered]
|
||||||
@@ -1937,7 +2020,7 @@ Would you like to:
|
|||||||
|
|
||||||
### Example 3: Automatic Plan Update
|
### Example 3: Automatic Plan Update
|
||||||
|
|
||||||
```
|
```text
|
||||||
[After completing create-doc task for PRD]
|
[After completing create-doc task for PRD]
|
||||||
|
|
||||||
✅ Plan Updated: Marked "Create PRD" as complete
|
✅ Plan Updated: Marked "Create PRD" as complete
|
||||||
@@ -1958,9 +2041,9 @@ Would you like to:
|
|||||||
- Malformed plan: Warn but continue, treat as no plan
|
- Malformed plan: Warn but continue, treat as no plan
|
||||||
- Update failures: Log but don't block task completion
|
- Update failures: Log but don't block task completion
|
||||||
- Parse errors: Fallback to basic text search
|
- Parse errors: Fallback to basic text search
|
||||||
==================== END: utils#plan-management ====================
|
==================== END: .bmad-core/utils/plan-management.md ====================
|
||||||
|
|
||||||
==================== START: utils#workflow-management ====================
|
==================== START: .bmad-core/utils/workflow-management.md ====================
|
||||||
# Workflow Management
|
# Workflow Management
|
||||||
|
|
||||||
Enables BMad orchestrator to manage and execute team workflows.
|
Enables BMad orchestrator to manage and execute team workflows.
|
||||||
@@ -2030,9 +2113,9 @@ Handle conditional paths by asking clarifying questions when needed.
|
|||||||
## Agent Integration
|
## Agent Integration
|
||||||
|
|
||||||
Agents should be workflow-aware: know active workflow, their role, access artifacts, understand expected outputs.
|
Agents should be workflow-aware: know active workflow, their role, access artifacts, understand expected outputs.
|
||||||
==================== END: utils#workflow-management ====================
|
==================== END: .bmad-core/utils/workflow-management.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -2059,4 +2142,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
35
dist/agents/dev.txt
vendored
35
dist/agents/dev.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#dev ====================
|
|
||||||
|
==================== START: .bmad-core/agents/dev.md ====================
|
||||||
# dev
|
# dev
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -53,7 +54,7 @@ agent:
|
|||||||
customization: null
|
customization: null
|
||||||
startup:
|
startup:
|
||||||
- Announce: Greet the user with your name and role, and inform of the *help command.
|
- Announce: Greet the user with your name and role, and inform of the *help command.
|
||||||
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - .bmad-core/core-config.yaml devLoadAlwaysFiles list
|
||||||
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
||||||
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
||||||
persona:
|
persona:
|
||||||
@@ -87,16 +88,16 @@ dependencies:
|
|||||||
checklists:
|
checklists:
|
||||||
- story-dod-checklist
|
- story-dod-checklist
|
||||||
```
|
```
|
||||||
==================== END: agents#dev ====================
|
==================== END: .bmad-core/agents/dev.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -105,7 +106,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -183,9 +184,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: tasks#validate-next-story ====================
|
==================== START: .bmad-core/tasks/validate-next-story.md ====================
|
||||||
# Validate Next Story Task
|
# Validate Next Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -320,9 +321,9 @@ Provide a structured validation report including:
|
|||||||
- **NO-GO**: Story requires fixes before implementation
|
- **NO-GO**: Story requires fixes before implementation
|
||||||
- **Implementation Readiness Score**: 1-10 scale
|
- **Implementation Readiness Score**: 1-10 scale
|
||||||
- **Confidence Level**: High/Medium/Low for successful implementation
|
- **Confidence Level**: High/Medium/Low for successful implementation
|
||||||
==================== END: tasks#validate-next-story ====================
|
==================== END: .bmad-core/tasks/validate-next-story.md ====================
|
||||||
|
|
||||||
==================== START: checklists#story-dod-checklist ====================
|
==================== START: .bmad-core/checklists/story-dod-checklist.md ====================
|
||||||
# Story Definition of Done (DoD) Checklist
|
# Story Definition of Done (DoD) Checklist
|
||||||
|
|
||||||
## Instructions for Developer Agent
|
## Instructions for Developer Agent
|
||||||
@@ -424,4 +425,4 @@ After completing the checklist:
|
|||||||
Be honest - it's better to flag issues now than have them discovered later.]]
|
Be honest - it's better to flag issues now than have them discovered later.]]
|
||||||
|
|
||||||
- [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.
|
- [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.
|
||||||
==================== END: checklists#story-dod-checklist ====================
|
==================== END: .bmad-core/checklists/story-dod-checklist.md ====================
|
||||||
|
|||||||
93
dist/agents/pm.txt
vendored
93
dist/agents/pm.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#pm ====================
|
|
||||||
|
==================== START: .bmad-core/agents/pm.md ====================
|
||||||
# pm
|
# pm
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -98,9 +99,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#pm ====================
|
==================== END: .bmad-core/agents/pm.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -120,7 +121,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-core/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -129,7 +130,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-core/templates/*.md` or `.bmad-core/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -147,14 +148,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-core/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-core/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -192,9 +193,9 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#correct-course ====================
|
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||||
# Correct Course Task
|
# Correct Course Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -268,9 +269,9 @@ Templates contain precise instructions for a reason. Follow them exactly to ensu
|
|||||||
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
||||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||||
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||||
==================== END: tasks#correct-course ====================
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-deep-research-prompt ====================
|
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
# Create Deep Research Prompt Task
|
# Create Deep Research Prompt Task
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
||||||
@@ -572,9 +573,9 @@ Present these numbered options to the user:
|
|||||||
- Balance comprehensiveness with focus
|
- Balance comprehensiveness with focus
|
||||||
- Document assumptions and limitations clearly
|
- Document assumptions and limitations clearly
|
||||||
- Plan for iterative refinement based on initial findings
|
- Plan for iterative refinement based on initial findings
|
||||||
==================== END: tasks#create-deep-research-prompt ====================
|
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
|
|
||||||
==================== START: tasks#brownfield-create-epic ====================
|
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||||
# Create Brownfield Epic Task
|
# Create Brownfield Epic Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -735,9 +736,9 @@ The epic creation is successful when:
|
|||||||
- If the scope grows beyond 3 stories, consider the full brownfield PRD process
|
- If the scope grows beyond 3 stories, consider the full brownfield PRD process
|
||||||
- Always prioritize existing system integrity over new functionality
|
- Always prioritize existing system integrity over new functionality
|
||||||
- When in doubt about scope or complexity, escalate to full brownfield planning
|
- When in doubt about scope or complexity, escalate to full brownfield planning
|
||||||
==================== END: tasks#brownfield-create-epic ====================
|
==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||||
|
|
||||||
==================== START: tasks#brownfield-create-story ====================
|
==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||||
# Create Brownfield Story Task
|
# Create Brownfield Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -885,16 +886,16 @@ The story creation is successful when:
|
|||||||
- Always prioritize existing system integrity
|
- Always prioritize existing system integrity
|
||||||
- When in doubt about integration complexity, use brownfield-create-epic instead
|
- When in doubt about integration complexity, use brownfield-create-epic instead
|
||||||
- Stories should take no more than 4 hours of focused development work
|
- Stories should take no more than 4 hours of focused development work
|
||||||
==================== END: tasks#brownfield-create-story ====================
|
==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -903,7 +904,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -981,9 +982,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: tasks#shard-doc ====================
|
==================== START: .bmad-core/tasks/shard-doc.md ====================
|
||||||
# Document Sharding Task
|
# Document Sharding Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -1175,9 +1176,9 @@ Document sharded successfully:
|
|||||||
- Preserve ALL formatting, including whitespace where significant
|
- Preserve ALL formatting, including whitespace where significant
|
||||||
- Handle edge cases like sections with code blocks containing ## symbols
|
- Handle edge cases like sections with code blocks containing ## symbols
|
||||||
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
||||||
==================== END: tasks#shard-doc ====================
|
==================== END: .bmad-core/tasks/shard-doc.md ====================
|
||||||
|
|
||||||
==================== START: templates#prd-tmpl ====================
|
==================== START: .bmad-core/templates/prd-tmpl.md ====================
|
||||||
# {{Project Name}} Product Requirements Document (PRD)
|
# {{Project Name}} Product Requirements Document (PRD)
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
||||||
@@ -1205,7 +1206,7 @@ Document sharded successfully:
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
[[LLM: Draft the list of functional and non functional requirements under the two child sections, and immediately execute tasks#advanced-elicitation display]]
|
[[LLM: Draft the list of functional and non functional requirements under the two child sections, and immediately execute .bmad-core/tasks/advanced-elicitation.md display]]
|
||||||
|
|
||||||
### Functional
|
### Functional
|
||||||
|
|
||||||
@@ -1228,7 +1229,7 @@ Document sharded successfully:
|
|||||||
3. Clearly let the user know where assumptions were made
|
3. Clearly let the user know where assumptions were made
|
||||||
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
||||||
5. This is NOT detailed UI spec - focus on product vision and user goals
|
5. This is NOT detailed UI spec - focus on product vision and user goals
|
||||||
6. After section completion, immediately apply `tasks#advanced-elicitation` protocol]]
|
6. After section completion, immediately apply `.bmad-core/tasks/advanced-elicitation.md` protocol]]
|
||||||
|
|
||||||
### Overall UX Vision
|
### Overall UX Vision
|
||||||
|
|
||||||
@@ -1270,12 +1271,12 @@ Document sharded successfully:
|
|||||||
|
|
||||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
||||||
|
|
||||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
1. Check if `.bmad-core/data/technical-preferences.yaml` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||||
5. These become constraints for the Architect - be specific and complete
|
5. These become constraints for the Architect - be specific and complete
|
||||||
6. After section completion, apply `tasks#advanced-elicitation` protocol.]]
|
6. After section completion, apply `.bmad-core/tasks/advanced-elicitation.md` protocol.]]
|
||||||
|
|
||||||
### Repository Structure: { Monorepo, Polyrepo, etc...}
|
### Repository Structure: { Monorepo, Polyrepo, etc...}
|
||||||
|
|
||||||
@@ -1293,7 +1294,7 @@ Document sharded successfully:
|
|||||||
|
|
||||||
## Epics
|
## Epics
|
||||||
|
|
||||||
[[LLM: First, present a high-level list of all epics for user approval, the epic_list and immediately execute tasks#advanced-elicitation display. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
[[LLM: First, present a high-level list of all epics for user approval, the epic_list and immediately execute .bmad-core/tasks/advanced-elicitation.md display. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
||||||
|
|
||||||
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
||||||
|
|
||||||
@@ -1319,7 +1320,7 @@ CRITICAL: Epics MUST be logically sequential following agile best practices:
|
|||||||
|
|
||||||
@{/example}
|
@{/example}
|
||||||
|
|
||||||
[[LLM: After the epic list is approved, present each `epic_details` with all its stories and acceptance criteria as a complete review unit and immediately execute tasks#advanced-elicitation display, before moving on to the next epic.]]
|
[[LLM: After the epic list is approved, present each `epic_details` with all its stories and acceptance criteria as a complete review unit and immediately execute .bmad-core/tasks/advanced-elicitation.md display, before moving on to the next epic.]]
|
||||||
|
|
||||||
<<REPEAT: epic_details>>
|
<<REPEAT: epic_details>>
|
||||||
|
|
||||||
@@ -1380,9 +1381,9 @@ so that {{benefit}}.
|
|||||||
### Architect Prompt
|
### Architect Prompt
|
||||||
|
|
||||||
[[LLM: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.]]
|
[[LLM: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.]]
|
||||||
==================== END: templates#prd-tmpl ====================
|
==================== END: .bmad-core/templates/prd-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#brownfield-prd-tmpl ====================
|
==================== START: .bmad-core/templates/brownfield-prd-tmpl.md ====================
|
||||||
# {{Project Name}} Brownfield Enhancement PRD
|
# {{Project Name}} Brownfield Enhancement PRD
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
||||||
@@ -1649,9 +1650,9 @@ so that {{benefit}}.
|
|||||||
- IV3: [[LLM: Performance impact verification requirement]]
|
- IV3: [[LLM: Performance impact verification requirement]]
|
||||||
|
|
||||||
<</REPEAT>>
|
<</REPEAT>>
|
||||||
==================== END: templates#brownfield-prd-tmpl ====================
|
==================== END: .bmad-core/templates/brownfield-prd-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#pm-checklist ====================
|
==================== START: .bmad-core/checklists/pm-checklist.md ====================
|
||||||
# Product Manager (PM) Requirements Checklist
|
# Product Manager (PM) Requirements Checklist
|
||||||
|
|
||||||
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
|
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
|
||||||
@@ -2027,9 +2028,9 @@ After presenting the report, ask if the user wants:
|
|||||||
|
|
||||||
- **READY FOR ARCHITECT**: The PRD and epics are comprehensive, properly structured, and ready for architectural design.
|
- **READY FOR ARCHITECT**: The PRD and epics are comprehensive, properly structured, and ready for architectural design.
|
||||||
- **NEEDS REFINEMENT**: The requirements documentation requires additional work to address the identified deficiencies.
|
- **NEEDS REFINEMENT**: The requirements documentation requires additional work to address the identified deficiencies.
|
||||||
==================== END: checklists#pm-checklist ====================
|
==================== END: .bmad-core/checklists/pm-checklist.md ====================
|
||||||
|
|
||||||
==================== START: checklists#change-checklist ====================
|
==================== START: .bmad-core/checklists/change-checklist.md ====================
|
||||||
# Change Navigation Checklist
|
# Change Navigation Checklist
|
||||||
|
|
||||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||||
@@ -2212,15 +2213,15 @@ Keep it action-oriented and forward-looking.]]
|
|||||||
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
||||||
|
|
||||||
---
|
---
|
||||||
==================== END: checklists#change-checklist ====================
|
==================== END: .bmad-core/checklists/change-checklist.md ====================
|
||||||
|
|
||||||
==================== START: data#technical-preferences ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# User-Defined Preferred Patterns and Preferences
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: data#technical-preferences ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -2247,4 +2248,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
61
dist/agents/po.txt
vendored
61
dist/agents/po.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#po ====================
|
|
||||||
|
==================== START: .bmad-core/agents/po.md ====================
|
||||||
# po
|
# po
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -102,16 +103,16 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#po ====================
|
==================== END: .bmad-core/agents/po.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -120,7 +121,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -198,9 +199,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: tasks#shard-doc ====================
|
==================== START: .bmad-core/tasks/shard-doc.md ====================
|
||||||
# Document Sharding Task
|
# Document Sharding Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -392,9 +393,9 @@ Document sharded successfully:
|
|||||||
- Preserve ALL formatting, including whitespace where significant
|
- Preserve ALL formatting, including whitespace where significant
|
||||||
- Handle edge cases like sections with code blocks containing ## symbols
|
- Handle edge cases like sections with code blocks containing ## symbols
|
||||||
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
||||||
==================== END: tasks#shard-doc ====================
|
==================== END: .bmad-core/tasks/shard-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#correct-course ====================
|
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||||
# Correct Course Task
|
# Correct Course Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -468,9 +469,9 @@ Document sharded successfully:
|
|||||||
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
||||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||||
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||||
==================== END: tasks#correct-course ====================
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||||
|
|
||||||
==================== START: tasks#brownfield-create-epic ====================
|
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||||
# Create Brownfield Epic Task
|
# Create Brownfield Epic Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -631,9 +632,9 @@ The epic creation is successful when:
|
|||||||
- If the scope grows beyond 3 stories, consider the full brownfield PRD process
|
- If the scope grows beyond 3 stories, consider the full brownfield PRD process
|
||||||
- Always prioritize existing system integrity over new functionality
|
- Always prioritize existing system integrity over new functionality
|
||||||
- When in doubt about scope or complexity, escalate to full brownfield planning
|
- When in doubt about scope or complexity, escalate to full brownfield planning
|
||||||
==================== END: tasks#brownfield-create-epic ====================
|
==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||||
|
|
||||||
==================== START: tasks#brownfield-create-story ====================
|
==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||||
# Create Brownfield Story Task
|
# Create Brownfield Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -781,9 +782,9 @@ The story creation is successful when:
|
|||||||
- Always prioritize existing system integrity
|
- Always prioritize existing system integrity
|
||||||
- When in doubt about integration complexity, use brownfield-create-epic instead
|
- When in doubt about integration complexity, use brownfield-create-epic instead
|
||||||
- Stories should take no more than 4 hours of focused development work
|
- Stories should take no more than 4 hours of focused development work
|
||||||
==================== END: tasks#brownfield-create-story ====================
|
==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||||
|
|
||||||
==================== START: tasks#validate-next-story ====================
|
==================== START: .bmad-core/tasks/validate-next-story.md ====================
|
||||||
# Validate Next Story Task
|
# Validate Next Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -918,9 +919,9 @@ Provide a structured validation report including:
|
|||||||
- **NO-GO**: Story requires fixes before implementation
|
- **NO-GO**: Story requires fixes before implementation
|
||||||
- **Implementation Readiness Score**: 1-10 scale
|
- **Implementation Readiness Score**: 1-10 scale
|
||||||
- **Confidence Level**: High/Medium/Low for successful implementation
|
- **Confidence Level**: High/Medium/Low for successful implementation
|
||||||
==================== END: tasks#validate-next-story ====================
|
==================== END: .bmad-core/tasks/validate-next-story.md ====================
|
||||||
|
|
||||||
==================== START: templates#story-tmpl ====================
|
==================== START: .bmad-core/templates/story-tmpl.md ====================
|
||||||
---
|
---
|
||||||
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
||||||
smAgent:
|
smAgent:
|
||||||
@@ -979,9 +980,9 @@ smAgent:
|
|||||||
### File List
|
### File List
|
||||||
|
|
||||||
## QA Results
|
## QA Results
|
||||||
==================== END: templates#story-tmpl ====================
|
==================== END: .bmad-core/templates/story-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#po-master-checklist ====================
|
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
|
||||||
# Product Owner (PO) Master Validation Checklist
|
# Product Owner (PO) Master Validation Checklist
|
||||||
|
|
||||||
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
|
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
|
||||||
@@ -1423,9 +1424,9 @@ After presenting the report, ask if the user wants:
|
|||||||
- **APPROVED**: The plan is comprehensive, properly sequenced, and ready for implementation.
|
- **APPROVED**: The plan is comprehensive, properly sequenced, and ready for implementation.
|
||||||
- **CONDITIONAL**: The plan requires specific adjustments before proceeding.
|
- **CONDITIONAL**: The plan requires specific adjustments before proceeding.
|
||||||
- **REJECTED**: The plan requires significant revision to address critical deficiencies.
|
- **REJECTED**: The plan requires significant revision to address critical deficiencies.
|
||||||
==================== END: checklists#po-master-checklist ====================
|
==================== END: .bmad-core/checklists/po-master-checklist.md ====================
|
||||||
|
|
||||||
==================== START: checklists#change-checklist ====================
|
==================== START: .bmad-core/checklists/change-checklist.md ====================
|
||||||
# Change Navigation Checklist
|
# Change Navigation Checklist
|
||||||
|
|
||||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||||
@@ -1608,9 +1609,9 @@ Keep it action-oriented and forward-looking.]]
|
|||||||
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
||||||
|
|
||||||
---
|
---
|
||||||
==================== END: checklists#change-checklist ====================
|
==================== END: .bmad-core/checklists/change-checklist.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -1637,4 +1638,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
29
dist/agents/qa.txt
vendored
29
dist/agents/qa.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#qa ====================
|
|
||||||
|
==================== START: .bmad-core/agents/qa.md ====================
|
||||||
# qa
|
# qa
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -91,9 +92,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#qa ====================
|
==================== END: .bmad-core/agents/qa.md ====================
|
||||||
|
|
||||||
==================== START: tasks#review-story ====================
|
==================== START: .bmad-core/tasks/review-story.md ====================
|
||||||
# review-story
|
# review-story
|
||||||
|
|
||||||
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
||||||
@@ -239,15 +240,15 @@ After review:
|
|||||||
1. If all items are checked and approved: Update story status to "Done"
|
1. If all items are checked and approved: Update story status to "Done"
|
||||||
2. If unchecked items remain: Keep status as "Review" for dev to address
|
2. If unchecked items remain: Keep status as "Review" for dev to address
|
||||||
3. Always provide constructive feedback and explanations for learning
|
3. Always provide constructive feedback and explanations for learning
|
||||||
==================== END: tasks#review-story ====================
|
==================== END: .bmad-core/tasks/review-story.md ====================
|
||||||
|
|
||||||
==================== START: data#technical-preferences ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# User-Defined Preferred Patterns and Preferences
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: data#technical-preferences ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -274,4 +275,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
45
dist/agents/sm.txt
vendored
45
dist/agents/sm.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#sm ====================
|
|
||||||
|
==================== START: .bmad-core/agents/sm.md ====================
|
||||||
# sm
|
# sm
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -86,9 +87,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#sm ====================
|
==================== END: .bmad-core/agents/sm.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-next-story ====================
|
==================== START: .bmad-core/tasks/create-next-story.md ====================
|
||||||
# Create Next Story Task
|
# Create Next Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -203,16 +204,16 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|||||||
- Any deviations or conflicts noted between epic and architecture
|
- Any deviations or conflicts noted between epic and architecture
|
||||||
- Checklist Results
|
- Checklist Results
|
||||||
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `validate-next-story`
|
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `validate-next-story`
|
||||||
==================== END: tasks#create-next-story ====================
|
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -221,7 +222,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -299,9 +300,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: tasks#correct-course ====================
|
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||||
# Correct Course Task
|
# Correct Course Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -375,9 +376,9 @@ The LLM will:
|
|||||||
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
- A summary of the `change-checklist` analysis (issue, impact, rationale for the chosen path).
|
||||||
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
||||||
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
- **Implicit:** An annotated `change-checklist` (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
||||||
==================== END: tasks#correct-course ====================
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||||
|
|
||||||
==================== START: templates#story-tmpl ====================
|
==================== START: .bmad-core/templates/story-tmpl.md ====================
|
||||||
---
|
---
|
||||||
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
||||||
smAgent:
|
smAgent:
|
||||||
@@ -436,9 +437,9 @@ smAgent:
|
|||||||
### File List
|
### File List
|
||||||
|
|
||||||
## QA Results
|
## QA Results
|
||||||
==================== END: templates#story-tmpl ====================
|
==================== END: .bmad-core/templates/story-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#story-draft-checklist ====================
|
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
|
||||||
# Story Draft Checklist
|
# Story Draft Checklist
|
||||||
|
|
||||||
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
||||||
@@ -595,9 +596,9 @@ Be pragmatic - perfect documentation doesn't exist, but it must be enough to pro
|
|||||||
- READY: The story provides sufficient context for implementation
|
- READY: The story provides sufficient context for implementation
|
||||||
- NEEDS REVISION: The story requires updates (see issues)
|
- NEEDS REVISION: The story requires updates (see issues)
|
||||||
- BLOCKED: External information required (specify what information)
|
- BLOCKED: External information required (specify what information)
|
||||||
==================== END: checklists#story-draft-checklist ====================
|
==================== END: .bmad-core/checklists/story-draft-checklist.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -624,4 +625,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
57
dist/agents/ux-expert.txt
vendored
57
dist/agents/ux-expert.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#ux-expert ====================
|
|
||||||
|
==================== START: .bmad-core/agents/ux-expert.md ====================
|
||||||
# ux-expert
|
# ux-expert
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -93,9 +94,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#ux-expert ====================
|
==================== END: .bmad-core/agents/ux-expert.md ====================
|
||||||
|
|
||||||
==================== START: tasks#generate-ai-frontend-prompt ====================
|
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||||
# Create AI Frontend Prompt Task
|
# Create AI Frontend Prompt Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -147,9 +148,9 @@ You will now synthesize the inputs and the above principles into a final, compre
|
|||||||
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
||||||
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
||||||
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
||||||
==================== END: tasks#generate-ai-frontend-prompt ====================
|
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-deep-research-prompt ====================
|
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
# Create Deep Research Prompt Task
|
# Create Deep Research Prompt Task
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
||||||
@@ -451,9 +452,9 @@ Present these numbered options to the user:
|
|||||||
- Balance comprehensiveness with focus
|
- Balance comprehensiveness with focus
|
||||||
- Document assumptions and limitations clearly
|
- Document assumptions and limitations clearly
|
||||||
- Plan for iterative refinement based on initial findings
|
- Plan for iterative refinement based on initial findings
|
||||||
==================== END: tasks#create-deep-research-prompt ====================
|
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -473,7 +474,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-core/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -482,7 +483,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-core/templates/*.md` or `.bmad-core/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -500,14 +501,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-core/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-core/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -545,16 +546,16 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -563,7 +564,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-core/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -641,9 +642,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: templates#front-end-spec-tmpl ====================
|
==================== START: .bmad-core/templates/front-end-spec-tmpl.md ====================
|
||||||
# {{Project Name}} UI/UX Specification
|
# {{Project Name}} UI/UX Specification
|
||||||
|
|
||||||
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
|
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
|
||||||
@@ -1057,15 +1058,15 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
## Checklist Results
|
## Checklist Results
|
||||||
|
|
||||||
[[LLM: If a UI/UX checklist exists, run it against this document and report results here.]]
|
[[LLM: If a UI/UX checklist exists, run it against this document and report results here.]]
|
||||||
==================== END: templates#front-end-spec-tmpl ====================
|
==================== END: .bmad-core/templates/front-end-spec-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: data#technical-preferences ====================
|
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# User-Defined Preferred Patterns and Preferences
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: data#technical-preferences ====================
|
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-core/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -1092,4 +1093,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-core/utils/template-format.md ====================
|
||||||
|
|||||||
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-2d-phaser-game-dev/personas/analyst.md`, `.bmad-2d-phaser-game-dev/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-2d-phaser-game-dev/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-2d-phaser-game-dev/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#game-designer ====================
|
|
||||||
|
==================== START: .bmad-2d-phaser-game-dev/agents/game-designer.md ====================
|
||||||
# game-designer
|
# game-designer
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -97,9 +98,9 @@ dependencies:
|
|||||||
checklists:
|
checklists:
|
||||||
- game-design-checklist
|
- game-design-checklist
|
||||||
```
|
```
|
||||||
==================== END: agents#game-designer ====================
|
==================== END: .bmad-2d-phaser-game-dev/agents/game-designer.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -119,7 +120,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-2d-phaser-game-dev/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -128,7 +129,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-2d-phaser-game-dev/templates/*.md` or `.bmad-2d-phaser-game-dev/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -146,14 +147,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-2d-phaser-game-dev/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -191,16 +192,16 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-2d-phaser-game-dev/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -209,7 +210,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-2d-phaser-game-dev/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -287,9 +288,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: tasks#game-design-brainstorming ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
|
||||||
# Game Design Brainstorming Techniques Task
|
# Game Design Brainstorming Techniques Task
|
||||||
|
|
||||||
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
|
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
|
||||||
@@ -598,9 +599,9 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
|
|||||||
- Consider accessibility and inclusivity from the start
|
- Consider accessibility and inclusivity from the start
|
||||||
- Balance innovation with market viability
|
- Balance innovation with market viability
|
||||||
- Plan for iteration based on player feedback
|
- Plan for iteration based on player feedback
|
||||||
==================== END: tasks#game-design-brainstorming ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-deep-research-prompt ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
|
||||||
# Create Deep Research Prompt Task
|
# Create Deep Research Prompt Task
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
||||||
@@ -902,9 +903,9 @@ Present these numbered options to the user:
|
|||||||
- Balance comprehensiveness with focus
|
- Balance comprehensiveness with focus
|
||||||
- Document assumptions and limitations clearly
|
- Document assumptions and limitations clearly
|
||||||
- Plan for iterative refinement based on initial findings
|
- Plan for iterative refinement based on initial findings
|
||||||
==================== END: tasks#create-deep-research-prompt ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
|
||||||
|
|
||||||
==================== START: tasks#advanced-elicitation ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
|
||||||
# Advanced Game Design Elicitation Task
|
# Advanced Game Design Elicitation Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -1016,9 +1017,9 @@ The questions and perspectives offered should always consider:
|
|||||||
- Performance implications for 60 FPS targets
|
- Performance implications for 60 FPS targets
|
||||||
- Cross-platform compatibility (desktop and mobile)
|
- Cross-platform compatibility (desktop and mobile)
|
||||||
- Game development best practices and common pitfalls
|
- Game development best practices and common pitfalls
|
||||||
==================== END: tasks#advanced-elicitation ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
|
||||||
|
|
||||||
==================== START: templates#game-design-doc-tmpl ====================
|
==================== START: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md ====================
|
||||||
# {{Game Title}} Game Design Document (GDD)
|
# {{Game Title}} Game Design Document (GDD)
|
||||||
|
|
||||||
[[LLM: This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
[[LLM: This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||||
@@ -1350,9 +1351,9 @@ If available, review any provided documents or ask if any are optionally availab
|
|||||||
- {{reference_1}}
|
- {{reference_1}}
|
||||||
- {{reference_2}}
|
- {{reference_2}}
|
||||||
- {{reference_3}}
|
- {{reference_3}}
|
||||||
==================== END: templates#game-design-doc-tmpl ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#level-design-doc-tmpl ====================
|
==================== START: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md ====================
|
||||||
# {{Game Title}} Level Design Document
|
# {{Game Title}} Level Design Document
|
||||||
|
|
||||||
[[LLM: This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
[[LLM: This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
||||||
@@ -1823,9 +1824,9 @@ Difficulty
|
|||||||
- Mechanic integration effectiveness: {{integration_score}}
|
- Mechanic integration effectiveness: {{integration_score}}
|
||||||
- Player guidance clarity: {{guidance_score}}
|
- Player guidance clarity: {{guidance_score}}
|
||||||
- Content accessibility: {{accessibility_rate}}%
|
- Content accessibility: {{accessibility_rate}}%
|
||||||
==================== END: templates#level-design-doc-tmpl ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#game-brief-tmpl ====================
|
==================== START: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md ====================
|
||||||
# {{Game Title}} Game Brief
|
# {{Game Title}} Game Brief
|
||||||
|
|
||||||
[[LLM: This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
[[LLM: This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||||
@@ -2171,9 +2172,9 @@ This brief is typically created early in the ideation process, often after brain
|
|||||||
|
|
||||||
| Date | Version | Description | Author |
|
| Date | Version | Description | Author |
|
||||||
| :--- | :------ | :---------- | :----- |
|
| :--- | :------ | :---------- | :----- |
|
||||||
==================== END: templates#game-brief-tmpl ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#game-design-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
|
||||||
# Game Design Document Quality Checklist
|
# Game Design Document Quality Checklist
|
||||||
|
|
||||||
## Document Completeness
|
## Document Completeness
|
||||||
@@ -2375,4 +2376,4 @@ _List any critical items that need attention before moving to implementation pha
|
|||||||
|
|
||||||
**Next Steps:**
|
**Next Steps:**
|
||||||
_Outline immediate next actions for the team based on this assessment._
|
_Outline immediate next actions for the team based on this assessment._
|
||||||
==================== END: checklists#game-design-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
|
||||||
|
|||||||
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-2d-phaser-game-dev/personas/analyst.md`, `.bmad-2d-phaser-game-dev/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-2d-phaser-game-dev/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-2d-phaser-game-dev/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#game-developer ====================
|
|
||||||
|
==================== START: .bmad-2d-phaser-game-dev/agents/game-developer.md ====================
|
||||||
# game-developer
|
# game-developer
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -105,16 +106,16 @@ dependencies:
|
|||||||
data:
|
data:
|
||||||
- development-guidelines
|
- development-guidelines
|
||||||
```
|
```
|
||||||
==================== END: agents#game-developer ====================
|
==================== END: .bmad-2d-phaser-game-dev/agents/game-developer.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-2d-phaser-game-dev/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -123,7 +124,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-2d-phaser-game-dev/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -201,9 +202,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: templates#game-architecture-tmpl ====================
|
==================== START: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md ====================
|
||||||
# {{Game Title}} Game Architecture Document
|
# {{Game Title}} Game Architecture Document
|
||||||
|
|
||||||
[[LLM: This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
[[LLM: This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
||||||
@@ -764,9 +765,9 @@ export const GameBalance = {
|
|||||||
- Zero TypeScript errors in strict mode
|
- Zero TypeScript errors in strict mode
|
||||||
- Consistent adherence to coding standards
|
- Consistent adherence to coding standards
|
||||||
- Comprehensive documentation coverage
|
- Comprehensive documentation coverage
|
||||||
==================== END: templates#game-architecture-tmpl ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#game-story-dod-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||||
# Game Development Story Definition of Done Checklist
|
# Game Development Story Definition of Done Checklist
|
||||||
|
|
||||||
## Story Completeness
|
## Story Completeness
|
||||||
@@ -927,9 +928,9 @@ export const GameBalance = {
|
|||||||
|
|
||||||
**Additional Notes:**
|
**Additional Notes:**
|
||||||
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
||||||
==================== END: checklists#game-story-dod-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||||
|
|
||||||
==================== START: data#development-guidelines ====================
|
==================== START: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
|
||||||
# Game Development Guidelines
|
# Game Development Guidelines
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
@@ -1581,4 +1582,4 @@ src/
|
|||||||
- **Asset Streaming**: Background loading for upcoming content
|
- **Asset Streaming**: Background loading for upcoming content
|
||||||
|
|
||||||
These guidelines ensure consistent, high-quality game development that meets performance targets and maintains code quality across all implementation stories.
|
These guidelines ensure consistent, high-quality game development that meets performance targets and maintains code quality across all implementation stories.
|
||||||
==================== END: data#development-guidelines ====================
|
==================== END: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
|
||||||
|
|||||||
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-2d-phaser-game-dev/personas/analyst.md`, `.bmad-2d-phaser-game-dev/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-2d-phaser-game-dev/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-2d-phaser-game-dev/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#game-sm ====================
|
|
||||||
|
==================== START: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
|
||||||
# game-sm
|
# game-sm
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -90,9 +91,9 @@ dependencies:
|
|||||||
checklists:
|
checklists:
|
||||||
- game-story-dod-checklist
|
- game-story-dod-checklist
|
||||||
```
|
```
|
||||||
==================== END: agents#game-sm ====================
|
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-game-story ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
|
||||||
# Create Game Development Story Task
|
# Create Game Development Story Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -152,7 +153,7 @@ Before creating stories, ensure you have:
|
|||||||
### 3. Template Execution
|
### 3. Template Execution
|
||||||
|
|
||||||
**Load Template:**
|
**Load Template:**
|
||||||
Use `templates#game-story-tmpl` following all embedded LLM instructions
|
Use `.bmad-2d-phaser-game-dev/templates/game-story-tmpl.md` following all embedded LLM instructions
|
||||||
|
|
||||||
**Key Focus Areas:**
|
**Key Focus Areas:**
|
||||||
|
|
||||||
@@ -188,7 +189,7 @@ Use `templates#game-story-tmpl` following all embedded LLM instructions
|
|||||||
### 5. Quality Assurance
|
### 5. Quality Assurance
|
||||||
|
|
||||||
**Apply Checklist:**
|
**Apply Checklist:**
|
||||||
Execute `checklists#game-story-dod-checklist` against completed story
|
Execute `.bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md` against completed story
|
||||||
|
|
||||||
**Story Criteria:**
|
**Story Criteria:**
|
||||||
|
|
||||||
@@ -309,16 +310,16 @@ Execute `checklists#game-story-dod-checklist` against completed story
|
|||||||
- Testing → Done
|
- Testing → Done
|
||||||
|
|
||||||
This task ensures game development stories are immediately actionable and enable efficient AI-driven development of game features.
|
This task ensures game development stories are immediately actionable and enable efficient AI-driven development of game features.
|
||||||
==================== END: tasks#create-game-story ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
|
||||||
|
|
||||||
==================== START: tasks#execute-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
# Checklist Validation Task
|
# Checklist Validation Task
|
||||||
|
|
||||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||||
|
|
||||||
## Available Checklists
|
## Available Checklists
|
||||||
|
|
||||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-2d-phaser-game-dev/checklists folder to select the appropriate one to run.
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
@@ -327,7 +328,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|||||||
- If user or the task being run provides a checklist name:
|
- If user or the task being run provides a checklist name:
|
||||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||||
- If multiple matches found, ask user to clarify
|
- If multiple matches found, ask user to clarify
|
||||||
- Load the appropriate checklist from {root}/checklists/
|
- Load the appropriate checklist from .bmad-2d-phaser-game-dev/checklists/
|
||||||
- If no checklist specified:
|
- If no checklist specified:
|
||||||
- Ask the user which checklist they want to use
|
- Ask the user which checklist they want to use
|
||||||
- Present the available options from the files in the checklists folder
|
- Present the available options from the files in the checklists folder
|
||||||
@@ -405,9 +406,9 @@ The LLM will:
|
|||||||
- Execute the complete checklist validation
|
- Execute the complete checklist validation
|
||||||
- Present a final report with pass/fail rates and key findings
|
- Present a final report with pass/fail rates and key findings
|
||||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||||
==================== END: tasks#execute-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||||
|
|
||||||
==================== START: templates#game-story-tmpl ====================
|
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.md ====================
|
||||||
# Story: {{Story Title}}
|
# Story: {{Story Title}}
|
||||||
|
|
||||||
**Epic:** {{Epic Name}}
|
**Epic:** {{Epic Name}}
|
||||||
@@ -643,9 +644,9 @@ class {{ClassName}} extends {{PhaseClass}} {
|
|||||||
|
|
||||||
- {{future_enhancement_1}}
|
- {{future_enhancement_1}}
|
||||||
- {{future_optimization_1}}
|
- {{future_optimization_1}}
|
||||||
==================== END: templates#game-story-tmpl ====================
|
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#game-story-dod-checklist ====================
|
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||||
# Game Development Story Definition of Done Checklist
|
# Game Development Story Definition of Done Checklist
|
||||||
|
|
||||||
## Story Completeness
|
## Story Completeness
|
||||||
@@ -806,4 +807,4 @@ class {{ClassName}} extends {{PhaseClass}} {
|
|||||||
|
|
||||||
**Additional Notes:**
|
**Additional Notes:**
|
||||||
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
||||||
==================== END: checklists#game-story-dod-checklist ====================
|
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-creator-tools/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-creator-tools/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-creator-tools/personas/analyst.md`, `.bmad-creator-tools/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-creator-tools/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-creator-tools/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#bmad-the-creator ====================
|
|
||||||
|
==================== START: .bmad-creator-tools/agents/bmad-the-creator.md ====================
|
||||||
# bmad-the-creator
|
# bmad-the-creator
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -92,9 +93,9 @@ dependencies:
|
|||||||
- agent-tmpl
|
- agent-tmpl
|
||||||
- expansion-pack-plan-tmpl
|
- expansion-pack-plan-tmpl
|
||||||
```
|
```
|
||||||
==================== END: agents#bmad-the-creator ====================
|
==================== END: .bmad-creator-tools/agents/bmad-the-creator.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-agent ====================
|
==================== START: .bmad-creator-tools/tasks/create-agent.md ====================
|
||||||
# Create Agent Task
|
# Create Agent Task
|
||||||
|
|
||||||
This task guides you through creating a new BMad agent following the standard template.
|
This task guides you through creating a new BMad agent following the standard template.
|
||||||
@@ -295,9 +296,9 @@ dependencies:
|
|||||||
- Test thoroughly before distribution
|
- Test thoroughly before distribution
|
||||||
- Follow existing agent patterns for consistency
|
- Follow existing agent patterns for consistency
|
||||||
- Remember: No task = agent can't do it, No template = agent can't create it
|
- Remember: No task = agent can't do it, No template = agent can't create it
|
||||||
==================== END: tasks#create-agent ====================
|
==================== END: .bmad-creator-tools/tasks/create-agent.md ====================
|
||||||
|
|
||||||
==================== START: tasks#generate-expansion-pack ====================
|
==================== START: .bmad-creator-tools/tasks/generate-expansion-pack.md ====================
|
||||||
# Create Expansion Pack Task
|
# Create Expansion Pack Task
|
||||||
|
|
||||||
This task helps you create a sophisticated BMad expansion pack with advanced agent orchestration, template systems, and quality assurance patterns based on proven best practices.
|
This task helps you create a sophisticated BMad expansion pack with advanced agent orchestration, template systems, and quality assurance patterns based on proven best practices.
|
||||||
@@ -1318,9 +1319,9 @@ Embedded knowledge (automatic):
|
|||||||
- [ ] Template conditional content tested with different scenarios
|
- [ ] Template conditional content tested with different scenarios
|
||||||
- [ ] Workflow decision trees validated with sample use cases
|
- [ ] Workflow decision trees validated with sample use cases
|
||||||
- [ ] Character interactions tested for consistency and professional authenticity
|
- [ ] Character interactions tested for consistency and professional authenticity
|
||||||
==================== END: tasks#generate-expansion-pack ====================
|
==================== END: .bmad-creator-tools/tasks/generate-expansion-pack.md ====================
|
||||||
|
|
||||||
==================== START: tasks#advanced-elicitation ====================
|
==================== START: .bmad-creator-tools/tasks/advanced-elicitation.md ====================
|
||||||
# Advanced Elicitation Task
|
# Advanced Elicitation Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -1328,94 +1329,119 @@ Embedded knowledge (automatic):
|
|||||||
- Provide optional reflective and brainstorming actions to enhance content quality
|
- Provide optional reflective and brainstorming actions to enhance content quality
|
||||||
- Enable deeper exploration of ideas through structured elicitation techniques
|
- Enable deeper exploration of ideas through structured elicitation techniques
|
||||||
- Support iterative refinement through multiple analytical perspectives
|
- Support iterative refinement through multiple analytical perspectives
|
||||||
|
- Usable during template-driven document creation or any chat conversation
|
||||||
|
|
||||||
|
## Usage Scenarios
|
||||||
|
|
||||||
|
### Scenario 1: Template Document Creation
|
||||||
|
|
||||||
|
After outputting a section during document creation:
|
||||||
|
|
||||||
|
1. **Section Review**: Ask user to review the drafted section
|
||||||
|
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
||||||
|
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
||||||
|
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
||||||
|
|
||||||
|
### Scenario 2: General Chat Elicitation
|
||||||
|
|
||||||
|
User can request advanced elicitation on any agent output:
|
||||||
|
|
||||||
|
- User says "do advanced elicitation" or similar
|
||||||
|
- Agent selects 9 relevant methods for the context
|
||||||
|
- Same simple 0-9 selection process
|
||||||
|
|
||||||
## Task Instructions
|
## Task Instructions
|
||||||
|
|
||||||
### 1. Section Context and Review
|
### 1. Intelligent Method Selection
|
||||||
|
|
||||||
[[LLM: When invoked after outputting a section:
|
**Context Analysis**: Before presenting options, analyze:
|
||||||
|
|
||||||
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
|
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
||||||
|
- **Complexity Level**: Simple, moderate, or complex content
|
||||||
|
- **Stakeholder Needs**: Who will use this information
|
||||||
|
- **Risk Level**: High-impact decisions vs routine items
|
||||||
|
- **Creative Potential**: Opportunities for innovation or alternatives
|
||||||
|
|
||||||
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
|
**Method Selection Strategy**:
|
||||||
|
|
||||||
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
|
1. **Always Include Core Methods** (choose 3-4):
|
||||||
|
- Expand or Contract for Audience
|
||||||
|
- Critique and Refine
|
||||||
|
- Identify Potential Risks
|
||||||
|
- Assess Alignment with Goals
|
||||||
|
|
||||||
|
2. **Context-Specific Methods** (choose 4-5):
|
||||||
|
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
||||||
|
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
||||||
|
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
||||||
|
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
||||||
|
|
||||||
|
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
||||||
|
|
||||||
|
### 2. Section Context and Review
|
||||||
|
|
||||||
|
When invoked after outputting a section:
|
||||||
|
|
||||||
|
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
||||||
|
|
||||||
|
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
||||||
|
|
||||||
|
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
||||||
- The entire section as a whole
|
- The entire section as a whole
|
||||||
- Individual items within the section (specify which item when selecting an action)
|
- Individual items within the section (specify which item when selecting an action)
|
||||||
|
|
||||||
4. Then present the action list as specified below.]]
|
### 3. Present Elicitation Options
|
||||||
|
|
||||||
### 2. Ask for Review and Present Action List
|
**Review Request Process:**
|
||||||
|
|
||||||
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
|
- Ask the user to review the drafted section
|
||||||
|
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
||||||
|
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
||||||
|
- Keep descriptions short - just the method name
|
||||||
|
- Await simple numeric selection
|
||||||
|
|
||||||
**Present the numbered list (0-9) with this exact format:**
|
**Action List Presentation Format:**
|
||||||
|
|
||||||
```text
|
```text
|
||||||
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
**Advanced Elicitation Options**
|
||||||
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
Choose a number (0-8) or 9 to proceed:
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
0. [Method Name]
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
1. [Method Name]
|
||||||
2. Critique and Refine
|
2. [Method Name]
|
||||||
3. Analyze Logical Flow and Dependencies
|
3. [Method Name]
|
||||||
4. Assess Alignment with Overall Goals
|
4. [Method Name]
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
5. [Method Name]
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
6. [Method Name]
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
7. [Method Name]
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
8. [Method Name]
|
||||||
9. Proceed / No Further Actions
|
9. Proceed / No Further Actions
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Processing Guidelines
|
**Response Handling:**
|
||||||
|
|
||||||
**Do NOT show:**
|
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
||||||
|
- **Number 9**: Proceed to next section or continue conversation
|
||||||
|
- **Direct Feedback**: Apply user's suggested changes and continue
|
||||||
|
|
||||||
- The full protocol text with `[[LLM: ...]]` instructions
|
### 4. Method Execution Framework
|
||||||
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
|
||||||
- Any internal template markup
|
|
||||||
|
|
||||||
**After user selection from the list:**
|
**Execution Process:**
|
||||||
|
|
||||||
- Execute the chosen action according to the protocol instructions below
|
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
||||||
- Ask if they want to select another action or proceed with option 9 once complete
|
2. **Apply Context**: Execute the method from your current role's perspective
|
||||||
- Continue until user selects option 9 or indicates completion
|
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
||||||
|
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
||||||
|
|
||||||
## Action Definitions
|
**Execution Guidelines:**
|
||||||
|
|
||||||
0. Expand or Contract for Audience
|
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
||||||
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
||||||
|
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
||||||
|
- **Maintain Flow**: Keep the process moving efficiently
|
||||||
|
==================== END: .bmad-creator-tools/tasks/advanced-elicitation.md ====================
|
||||||
|
|
||||||
1. Explain Reasoning (CoT Step-by-Step)
|
==================== START: .bmad-creator-tools/tasks/create-deep-research-prompt.md ====================
|
||||||
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
|
|
||||||
|
|
||||||
2. Critique and Refine
|
|
||||||
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
|
||||||
|
|
||||||
3. Analyze Logical Flow and Dependencies
|
|
||||||
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
|
||||||
|
|
||||||
4. Assess Alignment with Overall Goals
|
|
||||||
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
|
|
||||||
|
|
||||||
5. Identify Potential Risks and Unforeseen Issues
|
|
||||||
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
|
||||||
|
|
||||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
|
||||||
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
|
|
||||||
|
|
||||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
|
||||||
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
|
||||||
|
|
||||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
|
||||||
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
|
|
||||||
|
|
||||||
9. Proceed / No Further Actions
|
|
||||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
|
||||||
==================== END: tasks#advanced-elicitation ====================
|
|
||||||
|
|
||||||
==================== START: tasks#create-deep-research-prompt ====================
|
|
||||||
# Create Deep Research Prompt Task
|
# Create Deep Research Prompt Task
|
||||||
|
|
||||||
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
||||||
@@ -1717,9 +1743,9 @@ Present these numbered options to the user:
|
|||||||
- Balance comprehensiveness with focus
|
- Balance comprehensiveness with focus
|
||||||
- Document assumptions and limitations clearly
|
- Document assumptions and limitations clearly
|
||||||
- Plan for iterative refinement based on initial findings
|
- Plan for iterative refinement based on initial findings
|
||||||
==================== END: tasks#create-deep-research-prompt ====================
|
==================== END: .bmad-creator-tools/tasks/create-deep-research-prompt.md ====================
|
||||||
|
|
||||||
==================== START: templates#agent-tmpl ====================
|
==================== START: .bmad-creator-tools/templates/agent-tmpl.md ====================
|
||||||
# [AGENT_ID]
|
# [AGENT_ID]
|
||||||
|
|
||||||
[[LLM: This is an agent definition template. When creating a new agent:
|
[[LLM: This is an agent definition template. When creating a new agent:
|
||||||
@@ -1863,9 +1889,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: templates#agent-tmpl ====================
|
==================== END: .bmad-creator-tools/templates/agent-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#expansion-pack-plan-tmpl ====================
|
==================== START: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.md ====================
|
||||||
# {Pack Name} Expansion Pack Plan
|
# {Pack Name} Expansion Pack Plan
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
@@ -1957,4 +1983,4 @@ Users must add these files to `bmad-core/data/`:
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||||
==================== END: templates#expansion-pack-plan-tmpl ====================
|
==================== END: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.md ====================
|
||||||
|
|||||||
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-infrastructure-devops/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-infrastructure-devops/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-infrastructure-devops/personas/analyst.md`, `.bmad-infrastructure-devops/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,8 +29,8 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `utils: template-format` → Look for `==================== START: .bmad-infrastructure-devops/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `tasks: create-story` → Look for `==================== START: .bmad-infrastructure-devops/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
==================== START: agents#infra-devops-platform ====================
|
|
||||||
|
==================== START: .bmad-infrastructure-devops/agents/infra-devops-platform.md ====================
|
||||||
# infra-devops-platform
|
# infra-devops-platform
|
||||||
|
|
||||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||||
@@ -98,9 +99,9 @@ dependencies:
|
|||||||
utils:
|
utils:
|
||||||
- template-format
|
- template-format
|
||||||
```
|
```
|
||||||
==================== END: agents#infra-devops-platform ====================
|
==================== END: .bmad-infrastructure-devops/agents/infra-devops-platform.md ====================
|
||||||
|
|
||||||
==================== START: tasks#create-doc ====================
|
==================== START: .bmad-infrastructure-devops/tasks/create-doc.md ====================
|
||||||
# Create Document from Template Task
|
# Create Document from Template Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -120,7 +121,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||||
|
|
||||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
- If `workflow.trackProgress: true`, check for active plan using .bmad-infrastructure-devops/utils/plan-management.md
|
||||||
- If plan exists and this document creation is part of the plan:
|
- If plan exists and this document creation is part of the plan:
|
||||||
- Verify this is the expected next step
|
- Verify this is the expected next step
|
||||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||||
@@ -129,7 +130,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 1. Identify Template
|
### 1. Identify Template
|
||||||
|
|
||||||
- Load from `templates#*` or `{root}/templates directory`
|
- Load from `.bmad-infrastructure-devops/templates/*.md` or `.bmad-infrastructure-devops/templates directory`
|
||||||
- Agent-specific templates are listed in agent's dependencies
|
- Agent-specific templates are listed in agent's dependencies
|
||||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||||
|
|
||||||
@@ -147,14 +148,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
|
|
||||||
### 4. Key Execution Patterns
|
### 4. Key Execution Patterns
|
||||||
|
|
||||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
**When you see:** `[[LLM: Draft X and immediately execute .bmad-infrastructure-devops/tasks/advanced-elicitation.md]]`
|
||||||
|
|
||||||
- Draft the content
|
- Draft the content
|
||||||
- Present it to user
|
- Present it to user
|
||||||
- IMMEDIATELY execute the task
|
- IMMEDIATELY execute the task
|
||||||
- Wait for completion before continuing
|
- Wait for completion before continuing
|
||||||
|
|
||||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
**When you see:** `[[LLM: After section completion, apply .bmad-infrastructure-devops/tasks/Y.md]]`
|
||||||
|
|
||||||
- Finish the section
|
- Finish the section
|
||||||
- STOP and execute the task
|
- STOP and execute the task
|
||||||
@@ -192,9 +193,9 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|||||||
## Remember
|
## Remember
|
||||||
|
|
||||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||||
==================== END: tasks#create-doc ====================
|
==================== END: .bmad-infrastructure-devops/tasks/create-doc.md ====================
|
||||||
|
|
||||||
==================== START: tasks#review-infrastructure ====================
|
==================== START: .bmad-infrastructure-devops/tasks/review-infrastructure.md ====================
|
||||||
# Infrastructure Review Task
|
# Infrastructure Review Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -355,9 +356,9 @@ Present the user with the following list of 'Advanced Reflective, Elicitation &
|
|||||||
After I perform the selected action, we can discuss the outcome and decide on any further revisions for this section."
|
After I perform the selected action, we can discuss the outcome and decide on any further revisions for this section."
|
||||||
|
|
||||||
REPEAT by Asking the user if they would like to perform another Reflective, Elicitation & Brainstorming Action UNTIL the user indicates it is time to proceed to the next section (or selects #8)
|
REPEAT by Asking the user if they would like to perform another Reflective, Elicitation & Brainstorming Action UNTIL the user indicates it is time to proceed to the next section (or selects #8)
|
||||||
==================== END: tasks#review-infrastructure ====================
|
==================== END: .bmad-infrastructure-devops/tasks/review-infrastructure.md ====================
|
||||||
|
|
||||||
==================== START: tasks#validate-infrastructure ====================
|
==================== START: .bmad-infrastructure-devops/tasks/validate-infrastructure.md ====================
|
||||||
# Infrastructure Validation Task
|
# Infrastructure Validation Task
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
@@ -512,9 +513,9 @@ Present the user with the following list of 'Advanced Reflective, Elicitation &
|
|||||||
After I perform the selected action, we can discuss the outcome and decide on any further revisions for this section."
|
After I perform the selected action, we can discuss the outcome and decide on any further revisions for this section."
|
||||||
|
|
||||||
REPEAT by Asking the user if they would like to perform another Reflective, Elicitation & Brainstorming Action UNTIL the user indicates it is time to proceed to the next section (or selects #8)
|
REPEAT by Asking the user if they would like to perform another Reflective, Elicitation & Brainstorming Action UNTIL the user indicates it is time to proceed to the next section (or selects #8)
|
||||||
==================== END: tasks#validate-infrastructure ====================
|
==================== END: .bmad-infrastructure-devops/tasks/validate-infrastructure.md ====================
|
||||||
|
|
||||||
==================== START: templates#infrastructure-architecture-tmpl ====================
|
==================== START: .bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md ====================
|
||||||
# {{Project Name}} Infrastructure Architecture
|
# {{Project Name}} Infrastructure Architecture
|
||||||
|
|
||||||
[[LLM: Initial Setup
|
[[LLM: Initial Setup
|
||||||
@@ -930,9 +931,9 @@ Define specific criteria for validating correct implementation:
|
|||||||
_Document Version: 1.0_
|
_Document Version: 1.0_
|
||||||
_Last Updated: {{current_date}}_
|
_Last Updated: {{current_date}}_
|
||||||
_Next Review: {{review_date}}_
|
_Next Review: {{review_date}}_
|
||||||
==================== END: templates#infrastructure-architecture-tmpl ====================
|
==================== END: .bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: templates#infrastructure-platform-from-arch-tmpl ====================
|
==================== START: .bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md ====================
|
||||||
# {{Project Name}} Platform Infrastructure Implementation
|
# {{Project Name}} Platform Infrastructure Implementation
|
||||||
|
|
||||||
[[LLM: Initial Setup
|
[[LLM: Initial Setup
|
||||||
@@ -1548,9 +1549,9 @@ _Platform Version: 1.0_
|
|||||||
_Implementation Date: {{implementation_date}}_
|
_Implementation Date: {{implementation_date}}_
|
||||||
_Next Review: {{review_date}}_
|
_Next Review: {{review_date}}_
|
||||||
_Approved by: {{architect_name}} (Architect), {{devops_name}} (DevOps/Platform Engineer)_
|
_Approved by: {{architect_name}} (Architect), {{devops_name}} (DevOps/Platform Engineer)_
|
||||||
==================== END: templates#infrastructure-platform-from-arch-tmpl ====================
|
==================== END: .bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md ====================
|
||||||
|
|
||||||
==================== START: checklists#infrastructure-checklist ====================
|
==================== START: .bmad-infrastructure-devops/checklists/infrastructure-checklist.md ====================
|
||||||
# Infrastructure Change Validation Checklist
|
# Infrastructure Change Validation Checklist
|
||||||
|
|
||||||
This checklist serves as a comprehensive framework for validating infrastructure changes before deployment to production. The DevOps/Platform Engineer should systematically work through each item, ensuring the infrastructure is secure, compliant, resilient, and properly implemented according to organizational standards.
|
This checklist serves as a comprehensive framework for validating infrastructure changes before deployment to production. The DevOps/Platform Engineer should systematically work through each item, ensuring the infrastructure is secure, compliant, resilient, and properly implemented according to organizational standards.
|
||||||
@@ -2035,15 +2036,15 @@ This checklist serves as a comprehensive framework for validating infrastructure
|
|||||||
- [ ] Local development environment compatibility verified
|
- [ ] Local development environment compatibility verified
|
||||||
- [ ] Platform component integration validated
|
- [ ] Platform component integration validated
|
||||||
- [ ] Cross-platform functionality tested and verified
|
- [ ] Cross-platform functionality tested and verified
|
||||||
==================== END: checklists#infrastructure-checklist ====================
|
==================== END: .bmad-infrastructure-devops/checklists/infrastructure-checklist.md ====================
|
||||||
|
|
||||||
==================== START: data#technical-preferences ====================
|
==================== START: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
||||||
# User-Defined Preferred Patterns and Preferences
|
# User-Defined Preferred Patterns and Preferences
|
||||||
|
|
||||||
None Listed
|
None Listed
|
||||||
==================== END: data#technical-preferences ====================
|
==================== END: .bmad-infrastructure-devops/data/technical-preferences.md ====================
|
||||||
|
|
||||||
==================== START: utils#template-format ====================
|
==================== START: .bmad-infrastructure-devops/utils/template-format.md ====================
|
||||||
# Template Format Conventions
|
# Template Format Conventions
|
||||||
|
|
||||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||||
@@ -2070,4 +2071,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|||||||
- Template elements are for AI processing only
|
- Template elements are for AI processing only
|
||||||
- Focus on faithful template execution and clean output
|
- Focus on faithful template execution and clean output
|
||||||
- All template-specific instructions are embedded within templates
|
- All template-specific instructions are embedded within templates
|
||||||
==================== END: utils#template-format ====================
|
==================== END: .bmad-infrastructure-devops/utils/template-format.md ====================
|
||||||
|
|||||||
1070
dist/teams/team-all.txt
vendored
1070
dist/teams/team-all.txt
vendored
File diff suppressed because it is too large
Load Diff
1040
dist/teams/team-fullstack.txt
vendored
1040
dist/teams/team-fullstack.txt
vendored
File diff suppressed because it is too large
Load Diff
407
dist/teams/team-ide-minimal.txt
vendored
407
dist/teams/team-ide-minimal.txt
vendored
File diff suppressed because it is too large
Load Diff
1012
dist/teams/team-no-ui.txt
vendored
1012
dist/teams/team-no-ui.txt
vendored
File diff suppressed because it is too large
Load Diff
@@ -1,22 +1,42 @@
|
|||||||
# BMad Method Guide for Github Copilot
|
# BMad Method Guide for GitHub Copilot
|
||||||
|
|
||||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
When running `npx bmad-method install`, select **Github Copilot** as your IDE. This command will perform the following actions:
|
When running `npx bmad-method install`, select **GitHub Copilot** as your IDE. This command will perform the following actions:
|
||||||
|
|
||||||
- Create the `.bmad-core/` directory with all the agent rule files.
|
- Create the `.bmad-core/` directory with all the agent rule files.
|
||||||
- Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
|
- Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
|
||||||
- Create a chatmodes file under your .github folder for each specific agent being added
|
- Create a chatmodes file under your .github folder for each specific agent being added
|
||||||
|
|
||||||
## Using BMad Agents in VS Code
|
## Using BMAD Agents in GitHub Copilot
|
||||||
|
|
||||||
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list.
|
1. **Open GitHub Copilot chat** in VS Code (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux).
|
||||||
|
2. Select the agent you want to use from the chat input's participant selector (e.g., `@workspace` > `dev`).
|
||||||
|
3. The agent adopts that persona for the conversation.
|
||||||
|
4. Use `*help` to see the commands available for the selected agent.
|
||||||
|
|
||||||
## VS Code Specific Features
|
## Available Agents
|
||||||
|
|
||||||
- **Dynamic Configuration**: When you first invoke an agent (e.g., `@dev`), VS Code will automatically update `.vscode/settings.json` by adding the configuration for that chat mode.
|
You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot:
|
||||||
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
|
|
||||||
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
|
- `bmad-master` - Master Task Executor
|
||||||
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.
|
- `dev` - Development expert
|
||||||
|
- `qa` - Quality Assurance specialist
|
||||||
|
- `ux-expert` - UX specialist
|
||||||
|
|
||||||
|
## GitHub Copilot-Specific Features
|
||||||
|
|
||||||
|
- **Settings**: Use the `.vscode/settings.json` file to configure Copilot behavior. The installer can configure these for you.
|
||||||
|
- `chat.agent.maxRequests`: Maximum requests per agent session (recommended: 15).
|
||||||
|
- `github.copilot.chat.agent.runTasks`: Allow agents to run workspace tasks (e.g., from `package.json` scripts).
|
||||||
|
- `github.copilot.chat.agent.autoFix`: Enable automatic error detection and fixing in generated code.
|
||||||
|
- `chat.tools.autoApprove`: Auto-approve ALL tools without confirmation (use with caution).
|
||||||
|
- **VS Code integration**: Works within VS Code's GitHub Copilot chat panel.
|
||||||
|
- **Tool Confirmation**: Copilot will ask for confirmation before running tools that can modify files. You can approve a tool once, for the session, or always.
|
||||||
|
|
||||||
|
## Tips for GitHub Copilot Users
|
||||||
|
|
||||||
|
- You can use a `.github/copilot-instructions.md` file to provide additional context or instructions for your projects that are not covered by the BMAD framework.
|
||||||
|
- BMAD agents can come with a pre-configured set of tools. You can see which tools an agent uses by looking at the `tools` section in its `.github/chatmodes/[agent].chatmode.md` file.
|
||||||
|
|||||||
14
docs/agentic-tools/trae-guide.md
Normal file
14
docs/agentic-tools/trae-guide.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# BMad Method Guide for Trae
|
||||||
|
|
||||||
|
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
When running `npx bmad-method install`, select **Trae** as your IDE. This creates:
|
||||||
|
|
||||||
|
- `.bmad-core/` folder with all agents
|
||||||
|
- `.trae/rules/` folder with agent rule files (`.md`)
|
||||||
|
|
||||||
|
## Using BMad Agents in Trae
|
||||||
|
|
||||||
|
Type `@agent-name` in chat to activate an agent.
|
||||||
@@ -22,7 +22,7 @@ The BMad Method follows a structured approach to AI-assisted software developmen
|
|||||||
```
|
```
|
||||||
|
|
||||||
- Choose "Complete installation"
|
- Choose "Complete installation"
|
||||||
- Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or Github Copilot)
|
- Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or GitHub Copilot)
|
||||||
|
|
||||||
2. **Verify installation**:
|
2. **Verify installation**:
|
||||||
- `.bmad-core/` folder created with all agents
|
- `.bmad-core/` folder created with all agents
|
||||||
@@ -112,12 +112,13 @@ Follow the SM → Dev cycle for systematic story development:
|
|||||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
|
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
||||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||||
|
|
||||||
### Chat Management:
|
### Chat Management:
|
||||||
|
|
||||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
||||||
- **Roo Code**: Switch modes within the same conversation
|
- **Roo Code**: Switch modes within the same conversation
|
||||||
|
|
||||||
## Available Agents
|
## Available Agents
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ dependencies:
|
|||||||
**In IDE:**
|
**In IDE:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Cursor or Windsurf (manual rules - loaded with @)
|
# Cursor, Windsurf, or Trae (manual rules - loaded with @)
|
||||||
@pm Create a PRD for a task management app
|
@pm Create a PRD for a task management app
|
||||||
@architect Design the system architecture
|
@architect Design the system architecture
|
||||||
@dev Implement the user authentication
|
@dev Implement the user authentication
|
||||||
@@ -275,7 +275,7 @@ graph TD
|
|||||||
**Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
|
**Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
|
||||||
|
|
||||||
1. **Copy Documents to Project**: Ensure `docs/prd.md` and `docs/architecture.md` are in your project
|
1. **Copy Documents to Project**: Ensure `docs/prd.md` and `docs/architecture.md` are in your project
|
||||||
2. **Switch to IDE**: Open your project in your preferred IDE (Cursor, Claude Code, Windsurf)
|
2. **Switch to IDE**: Open your project in your preferred IDE (Cursor, Claude Code, Windsurf, Trae)
|
||||||
3. **Document Sharding**: Use PO agent to shard large documents into manageable pieces
|
3. **Document Sharding**: Use PO agent to shard large documents into manageable pieces
|
||||||
4. **Begin Development**: Start the SM/Dev cycle for implementation
|
4. **Begin Development**: Start the SM/Dev cycle for implementation
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: bmad-2d-phaser-game-dev
|
name: bmad-2d-phaser-game-dev
|
||||||
version: 1.6.0
|
version: 1.7.0
|
||||||
short-title: 2D game development with Phaser 3 & TypeScript
|
short-title: 2D game development with Phaser 3 & TypeScript
|
||||||
description: >-
|
description: >-
|
||||||
2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript
|
2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ Before creating stories, ensure you have:
|
|||||||
### 3. Template Execution
|
### 3. Template Execution
|
||||||
|
|
||||||
**Load Template:**
|
**Load Template:**
|
||||||
Use `templates#game-story-tmpl` following all embedded LLM instructions
|
Use `{root}/templates/game-story-tmpl.md` following all embedded LLM instructions
|
||||||
|
|
||||||
**Key Focus Areas:**
|
**Key Focus Areas:**
|
||||||
|
|
||||||
@@ -93,7 +93,7 @@ Use `templates#game-story-tmpl` following all embedded LLM instructions
|
|||||||
### 5. Quality Assurance
|
### 5. Quality Assurance
|
||||||
|
|
||||||
**Apply Checklist:**
|
**Apply Checklist:**
|
||||||
Execute `checklists#game-story-dod-checklist` against completed story
|
Execute `{root}/checklists/game-story-dod-checklist.md` against completed story
|
||||||
|
|
||||||
**Story Criteria:**
|
**Story Criteria:**
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: bmad-creator-tools
|
name: bmad-creator-tools
|
||||||
version: 1.5.0
|
version: 1.6.0
|
||||||
short-title: Tools for creating BMad framework components
|
short-title: Tools for creating BMad framework components
|
||||||
description: Tools for creating and extending BMad framework components.
|
description: Tools for creating and extending BMad framework components.
|
||||||
author: Brian (BMad)
|
author: Brian (BMad)
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: bmad-infrastructure-devops
|
name: bmad-infrastructure-devops
|
||||||
version: 1.5.0
|
version: 1.6.0
|
||||||
short-title: Infrastructure and DevOps capabilities
|
short-title: Infrastructure and DevOps capabilities
|
||||||
description: >-
|
description: >-
|
||||||
This expansion pack extends BMad Method with comprehensive infrastructure and
|
This expansion pack extends BMad Method with comprehensive infrastructure and
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.25.0",
|
"version": "4.27.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.25.0",
|
"version": "4.27.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.25.0",
|
"version": "4.27.0",
|
||||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||||
"main": "tools/cli.js",
|
"main": "tools/cli.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
|
|||||||
@@ -21,6 +21,76 @@ class WebBuilder {
|
|||||||
return yaml.load(content);
|
return yaml.load(content);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
convertToWebPath(filePath, bundleRoot = 'bmad-core') {
|
||||||
|
// Convert absolute paths to web bundle paths with dot prefix
|
||||||
|
// All resources get installed under the bundle root, so use that path
|
||||||
|
const relativePath = path.relative(this.rootDir, filePath);
|
||||||
|
const pathParts = relativePath.split(path.sep);
|
||||||
|
|
||||||
|
let resourcePath;
|
||||||
|
if (pathParts[0] === 'expansion-packs') {
|
||||||
|
// For expansion packs, remove 'expansion-packs/packname' and use the rest
|
||||||
|
resourcePath = pathParts.slice(2).join('/');
|
||||||
|
} else {
|
||||||
|
// For bmad-core, common, etc., remove the first part
|
||||||
|
resourcePath = pathParts.slice(1).join('/');
|
||||||
|
}
|
||||||
|
|
||||||
|
return `.${bundleRoot}/${resourcePath}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
generateWebInstructions(bundleType, packName = null) {
|
||||||
|
// Generate dynamic web instructions based on bundle type
|
||||||
|
const rootExample = packName ? `.${packName}` : '.bmad-core';
|
||||||
|
const examplePath = packName ? `.${packName}/folder/filename.md` : '.bmad-core/folder/filename.md';
|
||||||
|
const personasExample = packName ? `.${packName}/personas/analyst.md` : '.bmad-core/personas/analyst.md';
|
||||||
|
const tasksExample = packName ? `.${packName}/tasks/create-story.md` : '.bmad-core/tasks/create-story.md';
|
||||||
|
const utilsExample = packName ? `.${packName}/utils/template-format.md` : '.bmad-core/utils/template-format.md';
|
||||||
|
const tasksRef = packName ? `.${packName}/tasks/create-story.md` : '.bmad-core/tasks/create-story.md';
|
||||||
|
|
||||||
|
return `# Web Agent Bundle Instructions
|
||||||
|
|
||||||
|
You are now operating as a specialized AI agent from the BMad-Method framework. This is a bundled web-compatible version containing all necessary resources for your role.
|
||||||
|
|
||||||
|
## Important Instructions
|
||||||
|
|
||||||
|
1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
|
||||||
|
|
||||||
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
|
- \`==================== START: ${examplePath} ====================\`
|
||||||
|
- \`==================== END: ${examplePath} ====================\`
|
||||||
|
|
||||||
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
|
- Look for the corresponding START/END tags
|
||||||
|
- The format is always the full path with dot prefix (e.g., \`${personasExample}\`, \`${tasksExample}\`)
|
||||||
|
- If a section is specified (e.g., \`{root}/tasks/create-story.md#section-name\`), navigate to that section within the file
|
||||||
|
|
||||||
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
|
\`\`\`yaml
|
||||||
|
dependencies:
|
||||||
|
utils:
|
||||||
|
- template-format
|
||||||
|
tasks:
|
||||||
|
- create-story
|
||||||
|
\`\`\`
|
||||||
|
|
||||||
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
|
- \`utils: template-format\` → Look for \`==================== START: ${utilsExample} ====================\`
|
||||||
|
- \`tasks: create-story\` → Look for \`==================== START: ${tasksRef} ====================\`
|
||||||
|
|
||||||
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||||
|
|
||||||
|
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
async cleanOutputDirs() {
|
async cleanOutputDirs() {
|
||||||
for (const dir of this.outputDirs) {
|
for (const dir of this.outputDirs) {
|
||||||
try {
|
try {
|
||||||
@@ -73,16 +143,18 @@ class WebBuilder {
|
|||||||
|
|
||||||
async buildAgentBundle(agentId) {
|
async buildAgentBundle(agentId) {
|
||||||
const dependencies = await this.resolver.resolveAgentDependencies(agentId);
|
const dependencies = await this.resolver.resolveAgentDependencies(agentId);
|
||||||
const template = await fs.readFile(this.templatePath, "utf8");
|
const template = this.generateWebInstructions('agent');
|
||||||
|
|
||||||
const sections = [template];
|
const sections = [template];
|
||||||
|
|
||||||
// Add agent configuration
|
// Add agent configuration
|
||||||
sections.push(this.formatSection(dependencies.agent.path, dependencies.agent.content));
|
const agentPath = this.convertToWebPath(dependencies.agent.path, 'bmad-core');
|
||||||
|
sections.push(this.formatSection(agentPath, dependencies.agent.content, 'bmad-core'));
|
||||||
|
|
||||||
// Add all dependencies
|
// Add all dependencies
|
||||||
for (const resource of dependencies.resources) {
|
for (const resource of dependencies.resources) {
|
||||||
sections.push(this.formatSection(resource.path, resource.content));
|
const resourcePath = this.convertToWebPath(resource.path, 'bmad-core');
|
||||||
|
sections.push(this.formatSection(resourcePath, resource.content, 'bmad-core'));
|
||||||
}
|
}
|
||||||
|
|
||||||
return sections.join("\n");
|
return sections.join("\n");
|
||||||
@@ -90,21 +162,24 @@ class WebBuilder {
|
|||||||
|
|
||||||
async buildTeamBundle(teamId) {
|
async buildTeamBundle(teamId) {
|
||||||
const dependencies = await this.resolver.resolveTeamDependencies(teamId);
|
const dependencies = await this.resolver.resolveTeamDependencies(teamId);
|
||||||
const template = await fs.readFile(this.templatePath, "utf8");
|
const template = this.generateWebInstructions('team');
|
||||||
|
|
||||||
const sections = [template];
|
const sections = [template];
|
||||||
|
|
||||||
// Add team configuration
|
// Add team configuration
|
||||||
sections.push(this.formatSection(dependencies.team.path, dependencies.team.content));
|
const teamPath = this.convertToWebPath(dependencies.team.path, 'bmad-core');
|
||||||
|
sections.push(this.formatSection(teamPath, dependencies.team.content, 'bmad-core'));
|
||||||
|
|
||||||
// Add all agents
|
// Add all agents
|
||||||
for (const agent of dependencies.agents) {
|
for (const agent of dependencies.agents) {
|
||||||
sections.push(this.formatSection(agent.path, agent.content));
|
const agentPath = this.convertToWebPath(agent.path, 'bmad-core');
|
||||||
|
sections.push(this.formatSection(agentPath, agent.content, 'bmad-core'));
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add all deduplicated resources
|
// Add all deduplicated resources
|
||||||
for (const resource of dependencies.resources) {
|
for (const resource of dependencies.resources) {
|
||||||
sections.push(this.formatSection(resource.path, resource.content));
|
const resourcePath = this.convertToWebPath(resource.path, 'bmad-core');
|
||||||
|
sections.push(this.formatSection(resourcePath, resource.content, 'bmad-core'));
|
||||||
}
|
}
|
||||||
|
|
||||||
return sections.join("\n");
|
return sections.join("\n");
|
||||||
@@ -161,14 +236,17 @@ class WebBuilder {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
formatSection(path, content) {
|
formatSection(path, content, bundleRoot = 'bmad-core') {
|
||||||
const separator = "====================";
|
const separator = "====================";
|
||||||
|
|
||||||
// Process agent content if this is an agent file
|
// Process agent content if this is an agent file
|
||||||
if (path.startsWith("agents#")) {
|
if (path.includes("/agents/")) {
|
||||||
content = this.processAgentContent(content);
|
content = this.processAgentContent(content);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Replace {root} references with the actual bundle root
|
||||||
|
content = this.replaceRootReferences(content, bundleRoot);
|
||||||
|
|
||||||
return [
|
return [
|
||||||
`${separator} START: ${path} ${separator}`,
|
`${separator} START: ${path} ${separator}`,
|
||||||
content.trim(),
|
content.trim(),
|
||||||
@@ -177,6 +255,11 @@ class WebBuilder {
|
|||||||
].join("\n");
|
].join("\n");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
replaceRootReferences(content, bundleRoot) {
|
||||||
|
// Replace {root} with the appropriate bundle root path
|
||||||
|
return content.replace(/\{root\}/g, `.${bundleRoot}`);
|
||||||
|
}
|
||||||
|
|
||||||
async validate() {
|
async validate() {
|
||||||
console.log("Validating agent configurations...");
|
console.log("Validating agent configurations...");
|
||||||
const agents = await this.resolver.listAgents();
|
const agents = await this.resolver.listAgents();
|
||||||
@@ -288,13 +371,14 @@ class WebBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async buildExpansionAgentBundle(packName, packDir, agentName) {
|
async buildExpansionAgentBundle(packName, packDir, agentName) {
|
||||||
const template = await fs.readFile(this.templatePath, "utf8");
|
const template = this.generateWebInstructions('expansion-agent', packName);
|
||||||
const sections = [template];
|
const sections = [template];
|
||||||
|
|
||||||
// Add agent configuration
|
// Add agent configuration
|
||||||
const agentPath = path.join(packDir, "agents", `${agentName}.md`);
|
const agentPath = path.join(packDir, "agents", `${agentName}.md`);
|
||||||
const agentContent = await fs.readFile(agentPath, "utf8");
|
const agentContent = await fs.readFile(agentPath, "utf8");
|
||||||
sections.push(this.formatSection(`agents#${agentName}`, agentContent));
|
const agentWebPath = this.convertToWebPath(agentPath, packName);
|
||||||
|
sections.push(this.formatSection(agentWebPath, agentContent, packName));
|
||||||
|
|
||||||
// Resolve and add agent dependencies
|
// Resolve and add agent dependencies
|
||||||
const yamlContent = yamlUtils.extractYamlFromAgent(agentContent);
|
const yamlContent = yamlUtils.extractYamlFromAgent(agentContent);
|
||||||
@@ -316,8 +400,9 @@ class WebBuilder {
|
|||||||
const resourcePath = path.join(packDir, resourceType, `${resourceName}${ext}`);
|
const resourcePath = path.join(packDir, resourceType, `${resourceName}${ext}`);
|
||||||
try {
|
try {
|
||||||
const resourceContent = await fs.readFile(resourcePath, "utf8");
|
const resourceContent = await fs.readFile(resourcePath, "utf8");
|
||||||
|
const resourceWebPath = this.convertToWebPath(resourcePath, packName);
|
||||||
sections.push(
|
sections.push(
|
||||||
this.formatSection(`${resourceType}#${resourceName}`, resourceContent)
|
this.formatSection(resourceWebPath, resourceContent, packName)
|
||||||
);
|
);
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
@@ -337,8 +422,9 @@ class WebBuilder {
|
|||||||
);
|
);
|
||||||
try {
|
try {
|
||||||
const coreContent = await fs.readFile(corePath, "utf8");
|
const coreContent = await fs.readFile(corePath, "utf8");
|
||||||
|
const coreWebPath = this.convertToWebPath(corePath, packName);
|
||||||
sections.push(
|
sections.push(
|
||||||
this.formatSection(`${resourceType}#${resourceName}`, coreContent)
|
this.formatSection(coreWebPath, coreContent, packName)
|
||||||
);
|
);
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
@@ -359,8 +445,9 @@ class WebBuilder {
|
|||||||
);
|
);
|
||||||
try {
|
try {
|
||||||
const commonContent = await fs.readFile(commonPath, "utf8");
|
const commonContent = await fs.readFile(commonPath, "utf8");
|
||||||
|
const commonWebPath = this.convertToWebPath(commonPath, packName);
|
||||||
sections.push(
|
sections.push(
|
||||||
this.formatSection(`${resourceType}#${resourceName}`, commonContent)
|
this.formatSection(commonWebPath, commonContent, packName)
|
||||||
);
|
);
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
@@ -388,7 +475,7 @@ class WebBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async buildExpansionTeamBundle(packName, packDir, teamConfigPath) {
|
async buildExpansionTeamBundle(packName, packDir, teamConfigPath) {
|
||||||
const template = await fs.readFile(this.templatePath, "utf8");
|
const template = this.generateWebInstructions('expansion-team', packName);
|
||||||
|
|
||||||
const sections = [template];
|
const sections = [template];
|
||||||
|
|
||||||
@@ -396,7 +483,8 @@ class WebBuilder {
|
|||||||
const teamContent = await fs.readFile(teamConfigPath, "utf8");
|
const teamContent = await fs.readFile(teamConfigPath, "utf8");
|
||||||
const teamFileName = path.basename(teamConfigPath, ".yaml");
|
const teamFileName = path.basename(teamConfigPath, ".yaml");
|
||||||
const teamConfig = this.parseYaml(teamContent);
|
const teamConfig = this.parseYaml(teamContent);
|
||||||
sections.push(this.formatSection(`agent-teams#${teamFileName}`, teamContent));
|
const teamWebPath = this.convertToWebPath(teamConfigPath, packName);
|
||||||
|
sections.push(this.formatSection(teamWebPath, teamContent, packName));
|
||||||
|
|
||||||
// Get list of expansion pack agents
|
// Get list of expansion pack agents
|
||||||
const expansionAgents = new Set();
|
const expansionAgents = new Set();
|
||||||
@@ -446,7 +534,8 @@ class WebBuilder {
|
|||||||
// Use expansion pack version (override)
|
// Use expansion pack version (override)
|
||||||
const agentPath = path.join(agentsDir, `${agentId}.md`);
|
const agentPath = path.join(agentsDir, `${agentId}.md`);
|
||||||
const agentContent = await fs.readFile(agentPath, "utf8");
|
const agentContent = await fs.readFile(agentPath, "utf8");
|
||||||
sections.push(this.formatSection(`agents#${agentId}`, agentContent));
|
const expansionAgentWebPath = this.convertToWebPath(agentPath, packName);
|
||||||
|
sections.push(this.formatSection(expansionAgentWebPath, agentContent, packName));
|
||||||
|
|
||||||
// Parse and collect dependencies from expansion agent
|
// Parse and collect dependencies from expansion agent
|
||||||
const agentYaml = agentContent.match(/```yaml\n([\s\S]*?)\n```/);
|
const agentYaml = agentContent.match(/```yaml\n([\s\S]*?)\n```/);
|
||||||
@@ -474,7 +563,8 @@ class WebBuilder {
|
|||||||
try {
|
try {
|
||||||
const coreAgentPath = path.join(this.rootDir, "bmad-core", "agents", `${agentId}.md`);
|
const coreAgentPath = path.join(this.rootDir, "bmad-core", "agents", `${agentId}.md`);
|
||||||
const coreAgentContent = await fs.readFile(coreAgentPath, "utf8");
|
const coreAgentContent = await fs.readFile(coreAgentPath, "utf8");
|
||||||
sections.push(this.formatSection(`agents#${agentId}`, coreAgentContent));
|
const coreAgentWebPath = this.convertToWebPath(coreAgentPath, packName);
|
||||||
|
sections.push(this.formatSection(coreAgentWebPath, coreAgentContent, packName));
|
||||||
|
|
||||||
// Parse and collect dependencies from core agent
|
// Parse and collect dependencies from core agent
|
||||||
const yamlContent = yamlUtils.extractYamlFromAgent(coreAgentContent, true);
|
const yamlContent = yamlUtils.extractYamlFromAgent(coreAgentContent, true);
|
||||||
@@ -516,7 +606,8 @@ class WebBuilder {
|
|||||||
const expansionPath = path.join(packDir, dep.type, `${dep.name}${ext}`);
|
const expansionPath = path.join(packDir, dep.type, `${dep.name}${ext}`);
|
||||||
try {
|
try {
|
||||||
const content = await fs.readFile(expansionPath, "utf8");
|
const content = await fs.readFile(expansionPath, "utf8");
|
||||||
sections.push(this.formatSection(key, content));
|
const expansionWebPath = this.convertToWebPath(expansionPath, packName);
|
||||||
|
sections.push(this.formatSection(expansionWebPath, content, packName));
|
||||||
console.log(` ✓ Using expansion override for ${key}`);
|
console.log(` ✓ Using expansion override for ${key}`);
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
@@ -532,7 +623,8 @@ class WebBuilder {
|
|||||||
const corePath = path.join(this.rootDir, "bmad-core", dep.type, `${dep.name}${ext}`);
|
const corePath = path.join(this.rootDir, "bmad-core", dep.type, `${dep.name}${ext}`);
|
||||||
try {
|
try {
|
||||||
const content = await fs.readFile(corePath, "utf8");
|
const content = await fs.readFile(corePath, "utf8");
|
||||||
sections.push(this.formatSection(key, content));
|
const coreWebPath = this.convertToWebPath(corePath, packName);
|
||||||
|
sections.push(this.formatSection(coreWebPath, content, packName));
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -547,7 +639,8 @@ class WebBuilder {
|
|||||||
const commonPath = path.join(this.rootDir, "common", dep.type, `${dep.name}${ext}`);
|
const commonPath = path.join(this.rootDir, "common", dep.type, `${dep.name}${ext}`);
|
||||||
try {
|
try {
|
||||||
const content = await fs.readFile(commonPath, "utf8");
|
const content = await fs.readFile(commonPath, "utf8");
|
||||||
sections.push(this.formatSection(key, content));
|
const commonWebPath = this.convertToWebPath(commonPath, packName);
|
||||||
|
sections.push(this.formatSection(commonWebPath, content, packName));
|
||||||
found = true;
|
found = true;
|
||||||
break;
|
break;
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -576,7 +669,9 @@ class WebBuilder {
|
|||||||
// Only add if not already included as a dependency
|
// Only add if not already included as a dependency
|
||||||
const resourceKey = `${resourceDir}#${fileName}`;
|
const resourceKey = `${resourceDir}#${fileName}`;
|
||||||
if (!allDependencies.has(resourceKey)) {
|
if (!allDependencies.has(resourceKey)) {
|
||||||
sections.push(this.formatSection(resourceKey, fileContent));
|
const fullResourcePath = path.join(resourcePath, resourceFile);
|
||||||
|
const resourceWebPath = this.convertToWebPath(fullResourcePath, packName);
|
||||||
|
sections.push(this.formatSection(resourceWebPath, fileContent, packName));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ program
|
|||||||
.option('-f, --full', 'Install complete BMad Method')
|
.option('-f, --full', 'Install complete BMad Method')
|
||||||
.option('-x, --expansion-only', 'Install only expansion packs (no bmad-core)')
|
.option('-x, --expansion-only', 'Install only expansion packs (no bmad-core)')
|
||||||
.option('-d, --directory <path>', 'Installation directory')
|
.option('-d, --directory <path>', 'Installation directory')
|
||||||
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini, github-copilot, other)')
|
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, trae, roo, cline, gemini, github-copilot, other)')
|
||||||
.option('-e, --expansion-packs <packs...>', 'Install specific expansion packs (can specify multiple)')
|
.option('-e, --expansion-packs <packs...>', 'Install specific expansion packs (can specify multiple)')
|
||||||
.action(async (options) => {
|
.action(async (options) => {
|
||||||
try {
|
try {
|
||||||
@@ -234,6 +234,7 @@ async function promptInstallation() {
|
|||||||
{ name: 'Cursor', value: 'cursor' },
|
{ name: 'Cursor', value: 'cursor' },
|
||||||
{ name: 'Claude Code', value: 'claude-code' },
|
{ name: 'Claude Code', value: 'claude-code' },
|
||||||
{ name: 'Windsurf', value: 'windsurf' },
|
{ name: 'Windsurf', value: 'windsurf' },
|
||||||
|
{ name: 'Trae', value: 'trae' }, // { name: 'Trae', value: 'trae'}
|
||||||
{ name: 'Roo Code', value: 'roo' },
|
{ name: 'Roo Code', value: 'roo' },
|
||||||
{ name: 'Cline', value: 'cline' },
|
{ name: 'Cline', value: 'cline' },
|
||||||
{ name: 'Gemini CLI', value: 'gemini' },
|
{ name: 'Gemini CLI', value: 'gemini' },
|
||||||
|
|||||||
@@ -37,6 +37,15 @@ ide-configurations:
|
|||||||
# To use BMad agents in Windsurf:
|
# To use BMad agents in Windsurf:
|
||||||
# 1. Type @agent-name (e.g., "@dev", "@pm")
|
# 1. Type @agent-name (e.g., "@dev", "@pm")
|
||||||
# 2. Windsurf will adopt that agent's persona
|
# 2. Windsurf will adopt that agent's persona
|
||||||
|
trae:
|
||||||
|
name: Trae
|
||||||
|
rule-dir: .trae/rules/
|
||||||
|
format: multi-file
|
||||||
|
command-suffix: .md
|
||||||
|
instructions: |
|
||||||
|
# To use BMad agents in Trae:
|
||||||
|
# 1. Type @agent-name (e.g., "@dev", "@pm", "@architect")
|
||||||
|
# 2. Trae will adopt that agent's persona
|
||||||
roo:
|
roo:
|
||||||
name: Roo Code
|
name: Roo Code
|
||||||
format: custom-modes
|
format: custom-modes
|
||||||
@@ -77,6 +86,6 @@ ide-configurations:
|
|||||||
# 1. The installer creates a .github/chatmodes/ directory in your project
|
# 1. The installer creates a .github/chatmodes/ directory in your project
|
||||||
# 2. Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
# 2. Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||||
# 3. The agent will adopt that persona for the conversation
|
# 3. The agent will adopt that persona for the conversation
|
||||||
# 4. Requires VS Code 1.99+ with `chat.agent.enabled: true` in settings
|
# 4. Requires VS Code 1.101+ with `chat.agent.enabled: true` in settings
|
||||||
# 5. Agent files are stored in .github/chatmodes/
|
# 5. Agent files are stored in .github/chatmodes/
|
||||||
# 6. Use `/help` to see available commands and agents
|
# 6. Use `*help` to see available commands and agents
|
||||||
@@ -57,6 +57,8 @@ class IdeSetup {
|
|||||||
return this.setupClaudeCode(installDir, selectedAgent);
|
return this.setupClaudeCode(installDir, selectedAgent);
|
||||||
case "windsurf":
|
case "windsurf":
|
||||||
return this.setupWindsurf(installDir, selectedAgent);
|
return this.setupWindsurf(installDir, selectedAgent);
|
||||||
|
case "trae":
|
||||||
|
return this.setupTrae(installDir, selectedAgent);
|
||||||
case "roo":
|
case "roo":
|
||||||
return this.setupRoo(installDir, selectedAgent);
|
return this.setupRoo(installDir, selectedAgent);
|
||||||
case "cline":
|
case "cline":
|
||||||
@@ -64,7 +66,7 @@ class IdeSetup {
|
|||||||
case "gemini":
|
case "gemini":
|
||||||
return this.setupGeminiCli(installDir, selectedAgent);
|
return this.setupGeminiCli(installDir, selectedAgent);
|
||||||
case "github-copilot":
|
case "github-copilot":
|
||||||
return this.setupVsCodeCopilot(installDir, selectedAgent, spinner);
|
return this.setupGitHubCopilot(installDir, selectedAgent, spinner);
|
||||||
default:
|
default:
|
||||||
console.log(chalk.yellow(`\nIDE ${ide} not yet supported`));
|
console.log(chalk.yellow(`\nIDE ${ide} not yet supported`));
|
||||||
return false;
|
return false;
|
||||||
@@ -210,6 +212,55 @@ class IdeSetup {
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async setupTrae(installDir, selectedAgent) {
|
||||||
|
const traeRulesDir = path.join(installDir, ".trae", "rules");
|
||||||
|
const agents = selectedAgent? [selectedAgent] : await this.getAllAgentIds(installDir);
|
||||||
|
|
||||||
|
await fileManager.ensureDirectory(traeRulesDir);
|
||||||
|
|
||||||
|
for (const agentId of agents) {
|
||||||
|
// Find the agent file
|
||||||
|
const agentPath = await this.findAgentPath(agentId, installDir);
|
||||||
|
|
||||||
|
if (agentPath) {
|
||||||
|
const agentContent = await fileManager.readFile(agentPath);
|
||||||
|
const mdPath = path.join(traeRulesDir, `${agentId}.md`);
|
||||||
|
|
||||||
|
// Create MD content (similar to Cursor but without frontmatter)
|
||||||
|
let mdContent = `# ${agentId.toUpperCase()} Agent Rule\n\n`;
|
||||||
|
mdContent += `This rule is triggered when the user types \`@${agentId}\` and activates the ${await this.getAgentTitle(
|
||||||
|
agentId,
|
||||||
|
installDir
|
||||||
|
)} agent persona.\n\n`;
|
||||||
|
mdContent += "## Agent Activation\n\n";
|
||||||
|
mdContent +=
|
||||||
|
"CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:\n\n";
|
||||||
|
mdContent += "```yaml\n";
|
||||||
|
// Extract just the YAML content from the agent file
|
||||||
|
const yamlContent = extractYamlFromAgent(agentContent);
|
||||||
|
if (yamlContent) {
|
||||||
|
mdContent += yamlContent;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// If no YAML found, include the whole content minus the header
|
||||||
|
mdContent += agentContent.replace(/^#.*$/m, "").trim();
|
||||||
|
}
|
||||||
|
mdContent += "\n```\n\n";
|
||||||
|
mdContent += "## File Reference\n\n";
|
||||||
|
const relativePath = path.relative(installDir, agentPath).replace(/\\/g, '/');
|
||||||
|
mdContent += `The complete agent definition is available in [${relativePath}](${relativePath}).\n\n`;
|
||||||
|
mdContent += "## Usage\n\n";
|
||||||
|
mdContent += `When the user types \`@${agentId}\`, activate this ${await this.getAgentTitle(
|
||||||
|
agentId,
|
||||||
|
installDir
|
||||||
|
)} persona and follow all instructions defined in the YAML configuration above.\n`;
|
||||||
|
|
||||||
|
await fileManager.writeFile(mdPath, mdContent);
|
||||||
|
console.log(chalk.green(`✓ Created rule: ${agentId}.md`));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async findAgentPath(agentId, installDir) {
|
async findAgentPath(agentId, installDir) {
|
||||||
// Try to find the agent file in various locations
|
// Try to find the agent file in various locations
|
||||||
const possiblePaths = [
|
const possiblePaths = [
|
||||||
@@ -515,7 +566,7 @@ class IdeSetup {
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
async setupVsCodeCopilot(installDir, selectedAgent, spinner = null) {
|
async setupGitHubCopilot(installDir, selectedAgent, spinner = null) {
|
||||||
await initializeModules();
|
await initializeModules();
|
||||||
|
|
||||||
// Configure VS Code workspace settings first to avoid UI conflicts with loading spinners
|
// Configure VS Code workspace settings first to avoid UI conflicts with loading spinners
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "4.25.0",
|
"version": "4.27.0",
|
||||||
"description": "BMad Method installer - AI-powered Agile development framework",
|
"description": "BMad Method installer - AI-powered Agile development framework",
|
||||||
"main": "lib/installer.js",
|
"main": "lib/installer.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ class DependencyResolver {
|
|||||||
const dependencies = {
|
const dependencies = {
|
||||||
agent: {
|
agent: {
|
||||||
id: agentId,
|
id: agentId,
|
||||||
path: `agents#${agentId}`,
|
path: agentPath,
|
||||||
content: agentContent,
|
content: agentContent,
|
||||||
config: agentConfig
|
config: agentConfig
|
||||||
},
|
},
|
||||||
@@ -56,7 +56,7 @@ class DependencyResolver {
|
|||||||
const dependencies = {
|
const dependencies = {
|
||||||
team: {
|
team: {
|
||||||
id: teamId,
|
id: teamId,
|
||||||
path: `agent-teams#${teamId}`,
|
path: teamPath,
|
||||||
content: teamContent,
|
content: teamContent,
|
||||||
config: teamConfig
|
config: teamConfig
|
||||||
},
|
},
|
||||||
@@ -152,7 +152,7 @@ class DependencyResolver {
|
|||||||
const resource = {
|
const resource = {
|
||||||
type,
|
type,
|
||||||
id,
|
id,
|
||||||
path: `${type}#${id}`,
|
path: filePath,
|
||||||
content
|
content
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -4,18 +4,18 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|||||||
|
|
||||||
## Important Instructions
|
## Important Instructions
|
||||||
|
|
||||||
1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
|
### **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
|
||||||
|
|
||||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
### **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||||
|
|
||||||
- `==================== START: folder#filename ====================`
|
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||||
- `==================== END: folder#filename ====================`
|
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||||
|
|
||||||
When you need to reference a resource mentioned in your instructions:
|
When you need to reference a resource mentioned in your instructions:
|
||||||
|
|
||||||
- Look for the corresponding START/END tags
|
- Look for the corresponding START/END tags
|
||||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||||
|
|
||||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||||
|
|
||||||
@@ -29,11 +29,11 @@ dependencies:
|
|||||||
|
|
||||||
These references map directly to bundle sections:
|
These references map directly to bundle sections:
|
||||||
|
|
||||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
- `dependencies.utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
- `dependencies.utils: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||||
|
|
||||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
### **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance. You have no file system to write to, so you will maintain document history being drafted in your memory unless a canvas feature is available and the user confirms its usage.
|
||||||
|
|
||||||
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
|
## **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role explicitly as defined.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -560,6 +560,7 @@ class V3ToV4Upgrader {
|
|||||||
cursor: "Rules created in .cursor/rules/",
|
cursor: "Rules created in .cursor/rules/",
|
||||||
"claude-code": "Commands created in .claude/commands/",
|
"claude-code": "Commands created in .claude/commands/",
|
||||||
windsurf: "Rules created in .windsurf/rules/",
|
windsurf: "Rules created in .windsurf/rules/",
|
||||||
|
trae: "Rules created in.trae/rules/",
|
||||||
roo: "Custom modes created in .roomodes",
|
roo: "Custom modes created in .roomodes",
|
||||||
cline: "Rules created in .clinerules/",
|
cline: "Rules created in .clinerules/",
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user