Compare commits

...

31 Commits

Author SHA1 Message Date
github-actions[bot]
d4caf35fcc release: bump to v4.42.1 2025-09-01 02:46:15 +00:00
Brian Madison
0a6cbd72cc chore: bump version to 4.42.0 for release
- Update main package.json to 4.42.0
- Update installer package.json to 4.42.0
- Add PR validation workflow and contribution checks
- Add pre-release and fix scripts
- Update CONTRIBUTING.md with validation requirements
2025-08-31 21:45:21 -05:00
Brian
e2e8d44e5d test: trigger PR validation (#533)
Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
2025-08-31 20:34:39 -05:00
Brian Madison
fb70c20067 feat: add PR validation workflow and contribution checks 2025-08-31 20:30:52 -05:00
Jonathan Borgwing
05736fa069 feat(installer): add Codex CLI + Codex Web modes, generate AGENTS.md, inject npm scripts, and docs (#529) 2025-08-31 17:48:03 -05:00
Bragatte
052e84dd4a feat: implement fork-friendly CI/CD with opt-in mechanism (#476)
- CI/CD disabled by default in forks to conserve resources
- Users can enable via ENABLE_CI_IN_FORK repository variable
- Added comprehensive Fork Guide documentation
- Updated README with Contributing section
- Created automation script for future implementations

Benefits:
- Saves GitHub Actions minutes across 1,600+ forks
- Cleaner fork experience for contributors
- Full control for fork owners
- PR validation still runs automatically

BREAKING CHANGE: CI/CD no longer runs automatically in forks.
Fork owners must set ENABLE_CI_IN_FORK=true to enable workflows.

Co-authored-by: Brian <bmadcode@gmail.com>
Co-authored-by: PinkyD <paulbeanjr@gmail.com>
2025-08-30 22:15:31 -05:00
Piatra Automation
f054d68c29 fix: correct dependency path format in bmad-master agent (#495)
- Change 'Dependencies map to root/type/name' to 'Dependencies map to {root}/{type}/{name}'
- Fixes path resolution issue where 'root' was treated as literal directory name
- Ensures proper variable interpolation for dependency file loading
- Resolves agent inability to find core-config.yaml and other project files
2025-08-30 22:14:52 -05:00
Wang-tianhao
44836512e7 Update dev.md (#491)
To avoid AI creating new folder for a new story tasks
2025-08-30 22:10:02 -05:00
Chris Calo
bf97f05190 typo in README.md (#515) 2025-08-26 23:57:41 -05:00
Kayvan Sylvan
a900d28080 chore: update project dependencies and development tooling (#508)
- Update various direct and transitive project dependencies.
- Remove the circular `bmad-method` self-dependency.
- Upgrade ESLint, Prettier, Jest, and other dev tools.
- Update semantic-release and related GitHub packages.

Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>
2025-08-24 21:45:18 -05:00
circus
ab70baca59 fix: remove incorrect else branch causing flatten command regression (#452)
This fixes a regression bug where the flatten command would fail with an
error message even when valid arguments were provided.

The bug was:
- First introduced in commit 0fdbca7
- Fixed in commit fab9d5e (v5.0.0-beta.2)
- Accidentally reintroduced in commit ed53943

The else branch at lines 130-134 was incorrectly handling the case when
users provided arguments, showing a misleading error about
'no arguments provided' when arguments were actually present.

Fixes all flatten command variations:
- npx bmad-method flatten
- npx bmad-method flatten --input /path
- npx bmad-method flatten --output file.xml
- npx bmad-method flatten --input /path --output file.xml

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-17 22:09:56 -05:00
Brian Madison
80d73d9093 fix: documentation and trademark updates 2025-08-17 19:23:50 -05:00
Brian Madison
f3cc410fb0 patch: move script to tools folder 2025-08-17 11:04:27 -05:00
Brian Madison
868ae23455 fix: previous merge set wrong default install location 2025-08-17 11:01:20 -05:00
Brian Madison
9de873777a fix: prettier fixes 2025-08-17 07:51:46 -05:00
Brian Madison
04c485b72e chore: bump to 4.39.1 to fix installer version display 2025-08-17 07:13:09 -05:00
Brian Madison
68eb31da77 fix: update installer version display to show 4.39.0 2025-08-17 07:12:53 -05:00
Brian Madison
c00d0aec88 chore: rollback to v4.39.0 from v5.x semantic versioning 2025-08-17 07:07:30 -05:00
Brian Madison
6543cb2a97 chore: bump version to 5.1.4 2025-08-17 00:30:15 -05:00
Brian Madison
b6fe44b16e fix: alphabetize agent commands and dependencies for improved organization
- Alphabetized all commands in agent files while maintaining help first and exit last
- Alphabetized all dependency categories (checklists, data, tasks, templates, utils, workflows)
- Alphabetized items within each dependency category across all 10 core agents:
  - analyst.md: commands and dependencies reorganized
  - architect.md: commands and dependencies reorganized
  - bmad-master.md: commands and dependencies reorganized, fixed YAML parsing issue
  - bmad-orchestrator.md: commands and dependencies reorganized
  - dev.md: commands and dependencies reorganized
  - pm.md: commands and dependencies reorganized
  - po.md: commands and dependencies reorganized
  - qa.md: commands and dependencies reorganized
  - sm.md: commands and dependencies reorganized
  - ux-expert.md: commands and dependencies reorganized
- Fixed YAML parsing error in bmad-master.md by properly quoting activation instructions
- Rebuilt all agent bundles and team bundles successfully
- Updated expansion pack bundles including new creative writing agents

This improves consistency and makes it easier to locate specific commands and dependencies
across all agent configurations.
2025-08-17 00:30:04 -05:00
Brian Madison
ac09300075 temporarily remove GCP agent system until it is completed in the experimental branch 2025-08-17 00:06:09 -05:00
DrBalls
b756790c17 Add Creative Writing expansion pack (#414)
* Add Creative Writing expansion pack
- 10 specialized writing agents for fiction and narrative design
- 8 complete workflows (novel, screenplay, short story, series)
- 27 quality checklists for genre and technical validation
- 22 writing tasks covering full creative process
- 8 professional templates for structured writing
- KDP publishing integration support

* Fix bmad-creative-writing expansion pack formatting and structure

- Convert all agents to standard BMAD markdown format with embedded YAML
- Add missing core dependencies (create-doc, advanced-elicitation, execute-checklist)
- Add bmad-kb.md customized for creative writing context
- Fix agent dependency references to only include existing files
- Standardize agent command syntax and activation instructions
- Clean up agent dependencies for beta-reader, dialog-specialist, editor, genre-specialist, narrative-designer, and world-builder

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 23:55:43 -05:00
Anthony
49347a8cde Feat(Expansion Pack): Part 2 - Agent System Templates (#370)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 23:47:30 -05:00
Brian, with AI
335e1da271 fix: add default current directory to installer prompt (#444)
Previously users had to manually type the full path or run pwd to get
the current directory when installing BMad. Now the installer prefills
the current working directory as the default, improving UX.

Co-authored-by: its-brianwithai <brian@ultrawideturbodev.com>
2025-08-16 22:08:06 -05:00
Brian Madison
6e2fbc6710 docs: add sync-version.sh script to troubleshooting section 2025-08-16 22:03:19 -05:00
Brian Madison
45dd7d1bc5 add: sync-version.sh script for easy version syncing 2025-08-16 22:02:12 -05:00
manjaroblack
db80eda9df refactor: centralize qa paths in core-config.yaml and update agent activation flows (#451)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-16 21:38:33 -05:00
Brian Madison
f5272f12e4 sync: update to published version 5.1.3 2025-08-16 21:35:12 -05:00
Brian Madison
26890a0a03 sync: update versions to 5.1.2 to match published release 2025-08-16 21:20:17 -05:00
Brian Madison
cf22fd98f3 fix: correct version to 5.1.1 after patch release
- npm latest tag now correctly points to 5.1.0
- package.json updated to 5.1.1 (what patch should have made)
- installer version synced
2025-08-16 21:10:46 -05:00
Brian Madison
fe318ecc07 sync: update package.json to match published version 5.0.1 2025-08-16 21:09:36 -05:00
272 changed files with 39486 additions and 18820 deletions

106
.github/FORK_GUIDE.md vendored Normal file
View File

@@ -0,0 +1,106 @@
# Fork Guide - CI/CD Configuration
## CI/CD in Forks
By default, CI/CD workflows are **disabled in forks** to conserve GitHub Actions resources and provide a cleaner fork experience.
### Why This Approach?
- **Resource efficiency**: Prevents unnecessary GitHub Actions usage across 1,600+ forks
- **Clean fork experience**: No failed workflow notifications in your fork
- **Full control**: Enable CI/CD only when you actually need it
- **PR validation**: Your changes are still fully tested when submitting PRs to the main repository
## Enabling CI/CD in Your Fork
If you need to run CI/CD workflows in your fork, follow these steps:
1. Navigate to your fork's **Settings** tab
2. Go to **Secrets and variables****Actions****Variables**
3. Click **New repository variable**
4. Create a new variable:
- **Name**: `ENABLE_CI_IN_FORK`
- **Value**: `true`
5. Click **Add variable**
That's it! CI/CD workflows will now run in your fork.
## Disabling CI/CD Again
To disable CI/CD workflows in your fork, you can either:
- **Delete the variable**: Remove the `ENABLE_CI_IN_FORK` variable entirely, or
- **Set to false**: Change the `ENABLE_CI_IN_FORK` value to `false`
## Alternative Testing Options
You don't always need to enable CI/CD in your fork. Here are alternatives:
### Local Testing
Run tests locally before pushing:
```bash
# Install dependencies
npm ci
# Run linting
npm run lint
# Run format check
npm run format:check
# Run validation
npm run validate
# Build the project
npm run build
```
### Pull Request CI
When you open a Pull Request to the main repository:
- All CI/CD workflows automatically run
- You get full validation of your changes
- No configuration needed
### GitHub Codespaces
Use GitHub Codespaces for a full development environment:
- All tools pre-configured
- Same environment as CI/CD
- No local setup required
## Frequently Asked Questions
### Q: Will my PR be tested even if CI is disabled in my fork?
**A:** Yes! When you open a PR to the main repository, all CI/CD workflows run automatically, regardless of your fork's settings.
### Q: Can I selectively enable specific workflows?
**A:** The `ENABLE_CI_IN_FORK` variable enables all workflows. For selective control, you'd need to modify individual workflow files.
### Q: Do I need to enable CI in my fork to contribute?
**A:** No! Most contributors never need to enable CI in their forks. Local testing and PR validation are sufficient for most contributions.
### Q: Will disabling CI affect my ability to merge PRs?
**A:** No! PR merge requirements are based on CI runs in the main repository, not your fork.
### Q: Why was this implemented?
**A:** With over 1,600 forks of BMAD-METHOD, this saves thousands of GitHub Actions minutes monthly while maintaining code quality standards.
## Need Help?
- Join our [Discord Community](https://discord.gg/gk8jAdXWmj) for support
- Check the [Contributing Guide](../README.md#contributing) for more information
- Open an issue if you encounter any problems
---
> 💡 **Pro Tip**: This fork-friendly approach is particularly valuable for projects using AI/LLM tools that create many experimental commits, as it prevents unnecessary CI runs while maintaining code quality standards.

View File

@@ -14,6 +14,7 @@ name: Discord Notification
jobs:
notify:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Notify Discord
uses: sarisia/actions-status-discord@v1

View File

@@ -7,6 +7,7 @@ name: format-check
jobs:
prettier:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4
@@ -25,6 +26,7 @@ jobs:
eslint:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4

View File

@@ -20,6 +20,7 @@ permissions:
jobs:
release:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4

55
.github/workflows/pr-validation.yaml vendored Normal file
View File

@@ -0,0 +1,55 @@
name: PR Validation
on:
pull_request:
branches: [main]
types: [opened, synchronize, reopened]
jobs:
validate:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
- name: Install dependencies
run: npm ci
- name: Run validation
run: npm run validate
- name: Check formatting
run: npm run format:check
- name: Run linter
run: npm run lint
- name: Run tests (if available)
run: npm test --if-present
- name: Comment on PR if checks fail
if: failure()
uses: actions/github-script@v7
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `❌ **PR Validation Failed**
This PR has validation errors that must be fixed before merging:
- Run \`npm run validate\` to check agent/team configs
- Run \`npm run format:check\` to check formatting (fix with \`npm run format\`)
- Run \`npm run lint\` to check linting issues (fix with \`npm run lint:fix\`)
Please fix these issues and push the changes.`
})

View File

@@ -17,6 +17,47 @@ Also note, we use the discussions feature in GitHub to have a community to discu
By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
## Before Submitting a PR
**IMPORTANT**: All PRs must pass validation checks before they can be merged.
### Required Checks
Before submitting your PR, run these commands locally:
```bash
# Run all validation checks
npm run pre-release
# Or run them individually:
npm run validate # Validate agent/team configs
npm run format:check # Check code formatting
npm run lint # Check for linting issues
```
### Fixing Issues
If any checks fail, use these commands to fix them:
```bash
# Fix all issues automatically
npm run fix
# Or fix individually:
npm run format # Fix formatting issues
npm run lint:fix # Fix linting issues
```
### Setup Git Hooks (Optional but Recommended)
To catch issues before committing:
```bash
# Run this once after cloning
chmod +x tools/setup-hooks.sh
./tools/setup-hooks.sh
```
## How to Contribute
### Reporting Bugs
@@ -206,4 +247,4 @@ Each commit should represent one logical change:
## License
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2025 Brian AKA BMad AKA BMad Code
Copyright (c) 2025 BMad Code, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,8 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
TRADEMARK NOTICE:
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
trademarks in this software does not grant any rights to use the trademarks
for any other purpose.

View File

@@ -1,4 +1,4 @@
# BMad-Method: Universal AI Agent Framework
# BMAD-METHOD™: Universal AI Agent Framework
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
@@ -11,11 +11,11 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! **Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.**
**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:**
**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.
@@ -40,7 +40,7 @@ This two-phase approach eliminates both **planning inconsistency** and **context
- **[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
- **[See available AI agents](/bmad-core/agents))** → Specialized roles for your team
- **[See available AI agents](/bmad-core/agents)** → Specialized roles for your team
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
- **[Create my own AI agents](docs/expansion-packs.md)** → Build agents for your domain
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
@@ -49,7 +49,7 @@ This two-phase approach eliminates both **planning inconsistency** and **context
## 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:
```bash
npx bmad-method install
@@ -110,11 +110,11 @@ npm run install:bmad # build and install all to a destination folder
## 🌟 Beyond Software Development - Expansion Packs
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!
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!
## Codebase Flattener Tool
The BMad-Method includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
The BMAD-METHOD™ includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
### Features
@@ -157,7 +157,7 @@ The tool will display progress and provide a comprehensive summary:
📊 File breakdown: 142 text, 14 binary, 0 errors
```
The generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMad-Method projects.
The generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMAD-METHOD™ projects.
#### Advanced Usage & Options
@@ -212,10 +212,50 @@ The generated XML file contains your project's text-based source files in a stru
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
### Working with Forks
When you fork this repository, CI/CD workflows are **disabled by default** to save resources. This is intentional and helps keep your fork clean.
#### Need CI/CD in Your Fork?
See our [Fork CI/CD Guide](.github/FORK_GUIDE.md) for instructions on enabling workflows in your fork.
#### Contributing Workflow
1. **Fork the repository** - Click the Fork button on GitHub
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git`
3. **Create a feature branch** - `git checkout -b feature/amazing-feature`
4. **Make your changes** - Test locally with `npm test`
5. **Commit your changes** - `git commit -m 'feat: add amazing feature'`
6. **Push to your fork** - `git push origin feature/amazing-feature`
7. **Open a Pull Request** - CI/CD will run automatically on the PR
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
## License
MIT License - see [LICENSE](LICENSE) for details.
## Trademark Notice
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
<sub>Built with ❤️ for the AI-assisted development community</sub>
#### Codex (CLI & Web)
- Two modes are supported:
- Codex (local only): `npx bmad-method install -f -i codex -d .` — keeps `.bmad-core/` ignored via `.gitignore` for local development.
- Codex Web Enabled: `npx bmad-method install -f -i codex-web -d .` — ensures `.bmad-core/` is tracked (not ignored) so it can be committed for Codex Web.
- For Codex Web, commit both `.bmad-core/` and `AGENTS.md` to the repository.
- Codex CLI: run `codex` at your project root; reference agents naturally, e.g., “As dev, implement …”.
- Codex Web: open your repo in Codex and prompt the same way — it reads `AGENTS.md` automatically.
- Refresh after changes: rerun the appropriate install command (`codex` or `codex-web`) to regenerate the BMAD section inside `AGENTS.md`.
If a `package.json` exists in your project, the installer will add helpful scripts:
- `bmad:refresh``bmad-method install -f -i codex`
- `bmad:list``bmad-method list:agents`
- `bmad:validate``bmad-method validate`

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team All
icon: 👥

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team Fullstack
icon: 🚀

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team IDE Minimal
icon:

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team No UI
icon: 🔧

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# analyst
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Mary
id: analyst
@@ -54,28 +57,28 @@ persona:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- create-project-brief: use task create-doc with project-brief-tmpl.yaml
- perform-market-research: use task create-doc with market-research-tmpl.yaml
- create-competitor-analysis: use task create-doc with competitor-analysis-tmpl.yaml
- yolo: Toggle Yolo Mode
- doc-out: Output full document in progress to current destination file
- research-prompt {topic}: execute task create-deep-research-prompt.md
- brainstorm {topic}: Facilitate structured brainstorming session (run task facilitate-brainstorming-session.md with template brainstorming-output-tmpl.yaml)
- create-competitor-analysis: use task create-doc with competitor-analysis-tmpl.yaml
- create-project-brief: use task create-doc with project-brief-tmpl.yaml
- doc-out: Output full document in progress to current destination file
- elicit: run the task advanced-elicitation
- perform-market-research: use task create-doc with market-research-tmpl.yaml
- research-prompt {topic}: execute task create-deep-research-prompt.md
- yolo: Toggle Yolo Mode
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
dependencies:
tasks:
- facilitate-brainstorming-session.md
- create-deep-research-prompt.md
- create-doc.md
- advanced-elicitation.md
- document-project.md
templates:
- project-brief-tmpl.yaml
- market-research-tmpl.yaml
- competitor-analysis-tmpl.yaml
- brainstorming-output-tmpl.yaml
data:
- bmad-kb.md
- brainstorming-techniques.md
tasks:
- advanced-elicitation.md
- create-deep-research-prompt.md
- create-doc.md
- document-project.md
- facilitate-brainstorming-session.md
templates:
- brainstorming-output-tmpl.yaml
- competitor-analysis-tmpl.yaml
- market-research-tmpl.yaml
- project-brief-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# architect
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,8 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Winston
id: architect
@@ -54,10 +56,10 @@ persona:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- create-full-stack-architecture: use create-doc with fullstack-architecture-tmpl.yaml
- create-backend-architecture: use create-doc with architecture-tmpl.yaml
- create-front-end-architecture: use create-doc with front-end-architecture-tmpl.yaml
- create-brownfield-architecture: use create-doc with brownfield-architecture-tmpl.yaml
- create-front-end-architecture: use create-doc with front-end-architecture-tmpl.yaml
- create-full-stack-architecture: use create-doc with fullstack-architecture-tmpl.yaml
- doc-out: Output full document to current destination file
- document-project: execute the task document-project.md
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
@@ -66,18 +68,18 @@ commands:
- yolo: Toggle Yolo Mode
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc.md
- create-deep-research-prompt.md
- document-project.md
- execute-checklist.md
templates:
- architecture-tmpl.yaml
- front-end-architecture-tmpl.yaml
- fullstack-architecture-tmpl.yaml
- brownfield-architecture-tmpl.yaml
checklists:
- architect-checklist.md
data:
- technical-preferences.md
tasks:
- create-deep-research-prompt.md
- create-doc.md
- document-project.md
- execute-checklist.md
templates:
- architecture-tmpl.yaml
- brownfield-architecture-tmpl.yaml
- front-end-architecture-tmpl.yaml
- fullstack-architecture-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Master
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,10 +29,10 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded
- 'CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded (Exception: Read bmad-core/core-config.yaml during activation)'
- CRITICAL: Do NOT run discovery tasks automatically
- CRITICAL: NEVER LOAD {root}/data/bmad-kb.md UNLESS USER TYPES *kb
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: NEVER LOAD root/data/bmad-kb.md UNLESS USER TYPES *kb
- CRITICAL: On activation, ONLY greet user, auto-run *help, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: BMad Master
id: bmad-master
@@ -48,28 +51,40 @@ persona:
commands:
- help: Show these listed commands in a numbered list
- kb: Toggle KB mode off (default) or on, when on will load and reference the {root}/data/bmad-kb.md and converse with the user answering his questions with this informational resource
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
- doc-out: Output full document to current destination file
- document-project: execute the task document-project.md
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
- kb: Toggle KB mode off (default) or on, when on will load and reference the {root}/data/bmad-kb.md and converse with the user answering his questions with this informational resource
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
- yolo: Toggle Yolo Mode
- exit: Exit (confirm)
dependencies:
checklists:
- architect-checklist.md
- change-checklist.md
- pm-checklist.md
- po-master-checklist.md
- story-dod-checklist.md
- story-draft-checklist.md
data:
- bmad-kb.md
- brainstorming-techniques.md
- elicitation-methods.md
- technical-preferences.md
tasks:
- advanced-elicitation.md
- facilitate-brainstorming-session.md
- brownfield-create-epic.md
- brownfield-create-story.md
- correct-course.md
- create-deep-research-prompt.md
- create-doc.md
- document-project.md
- create-next-story.md
- document-project.md
- execute-checklist.md
- facilitate-brainstorming-session.md
- generate-ai-frontend-prompt.md
- index-docs.md
- shard-doc.md
@@ -85,11 +100,6 @@ dependencies:
- prd-tmpl.yaml
- project-brief-tmpl.yaml
- story-tmpl.yaml
data:
- bmad-kb.md
- brainstorming-techniques.md
- elicitation-methods.md
- technical-preferences.md
workflows:
- brownfield-fullstack.md
- brownfield-service.md
@@ -97,11 +107,4 @@ dependencies:
- greenfield-fullstack.md
- greenfield-service.md
- greenfield-ui.md
checklists:
- architect-checklist.md
- change-checklist.md
- pm-checklist.md
- po-master-checklist.md
- story-dod-checklist.md
- story-draft-checklist.md
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Web Orchestrator
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -28,8 +31,8 @@ activation-instructions:
- Assess user goal against available agents and workflows in this bundle
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- Load resources only when needed - never pre-load (Exception: Read `bmad-core/core-config.yaml` during activation)
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: BMad Orchestrator
id: bmad-orchestrator
@@ -53,21 +56,16 @@ persona:
- Always remind users that commands require * prefix
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMad knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
exit: Return to BMad or exit session
task: Run a specific task (list if name not specified)
workflow: Start a specific workflow (list if name not specified)
workflow-guidance: Get personalized help selecting the right workflow
plan: Create detailed workflow plan before starting
plan-status: Show current workflow plan progress
plan-update: Update workflow plan status
chat-mode: Start conversational mode for detailed assistance
checklist: Execute a checklist (list if name not specified)
yolo: Toggle skip confirmations mode
party-mode: Group chat with all agents
doc-out: Output full document
kb-mode: Load full BMad knowledge base
party-mode: Group chat with all agents
status: Show current context, active agent, and progress
task: Run a specific task (list if name not specified)
yolo: Toggle skip confirmations mode
exit: Return to BMad or exit session
help-display-template: |
=== BMad Orchestrator Commands ===
All commands must start with * (asterisk)
@@ -137,13 +135,13 @@ workflow-guidance:
- Only recommend workflows that actually exist in the current bundle
- When *workflow-guidance is called, start an interactive session and list all available workflows with brief descriptions
dependencies:
data:
- bmad-kb.md
- elicitation-methods.md
tasks:
- advanced-elicitation.md
- create-doc.md
- kb-mode-interaction.md
data:
- bmad-kb.md
- elicitation-methods.md
utils:
- workflow-management.md
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# dev
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -29,7 +32,7 @@ activation-instructions:
- 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: 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: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: James
id: dev
@@ -46,6 +49,7 @@ persona:
core_principles:
- CRITICAL: Story has ALL info you will need aside from what you loaded during the startup commands. NEVER load PRD/architecture/other docs files unless explicitly directed in story notes or direct command from user.
- CRITICAL: ALWAYS check current folder structure before starting your story tasks, don't create new working directory if it already exists. Create new one when you're sure it's a brand new project.
- CRITICAL: ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- CRITICAL: FOLLOW THE develop-story command when the user tells you to implement the story
- Numbered Options - Always use numbered lists when presenting choices to the user
@@ -53,9 +57,6 @@ core_principles:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- run-tests: Execute linting and tests
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
- develop-story:
- order-of-execution: 'Read (first or next) task→Implement Task and its subtasks→Write tests→Execute validations→Only if ALL pass, then update the task checkbox with [x]→Update story section File List to ensure it lists and new or modified or deleted source file→repeat order-of-execution until complete'
- story-file-updates-ONLY:
@@ -65,11 +66,16 @@ commands:
- blocking: 'HALT for: Unapproved deps needed, confirm with user | Ambiguous after story check | 3 failures attempting to implement or fix something repeatedly | Missing config | Failing regression'
- ready-for-review: 'Code matches requirements + All validations pass + Follows standards + File List complete'
- completion: "All Tasks and Subtasks marked [x] and have tests→Validations and full regression passes (DON'T BE LAZY, EXECUTE ALL TESTS and CONFIRM)→Ensure File List is Complete→run the task execute-checklist for the checklist story-dod-checklist→set story status: 'Ready for Review'→HALT"
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
- review-qa: run task `apply-qa-fixes.md'
- run-tests: Execute linting and tests
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist.md
- validate-next-story.md
checklists:
- story-dod-checklist.md
tasks:
- apply-qa-fixes.md
- execute-checklist.md
- validate-next-story.md
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# pm
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: John
id: pm
@@ -50,32 +53,32 @@ persona:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- create-prd: run task create-doc.md with template prd-tmpl.yaml
- create-brownfield-prd: run task create-doc.md with template brownfield-prd-tmpl.yaml
- correct-course: execute the correct-course task
- create-brownfield-epic: run task brownfield-create-epic.md
- create-brownfield-prd: run task create-doc.md with template brownfield-prd-tmpl.yaml
- create-brownfield-story: run task brownfield-create-story.md
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-prd: run task create-doc.md with template prd-tmpl.yaml
- create-story: Create user story from requirements (task brownfield-create-story)
- doc-out: Output full document to current destination file
- shard-prd: run the task shard-doc.md for the provided prd.md (ask if not found)
- correct-course: execute the correct-course task
- yolo: Toggle Yolo Mode
- exit: Exit (confirm)
dependencies:
checklists:
- change-checklist.md
- pm-checklist.md
data:
- technical-preferences.md
tasks:
- create-doc.md
- correct-course.md
- create-deep-research-prompt.md
- brownfield-create-epic.md
- brownfield-create-story.md
- correct-course.md
- create-deep-research-prompt.md
- create-doc.md
- execute-checklist.md
- shard-doc.md
templates:
- prd-tmpl.yaml
- brownfield-prd-tmpl.yaml
checklists:
- pm-checklist.md
- change-checklist.md
data:
- technical-preferences.md
- prd-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# po
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Sarah
id: po
@@ -53,24 +56,24 @@ persona:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
- correct-course: execute the correct-course task
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- doc-out: Output full document to current destination file
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
- validate-story-draft {story}: run the task validate-next-story against the provided story file
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
- exit: Exit (confirm)
dependencies:
checklists:
- change-checklist.md
- po-master-checklist.md
tasks:
- correct-course.md
- execute-checklist.md
- shard-doc.md
- correct-course.md
- validate-next-story.md
templates:
- story-tmpl.yaml
checklists:
- po-master-checklist.md
- change-checklist.md
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# qa
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Quinn
id: qa
@@ -61,28 +64,28 @@ story-file-permissions:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- gate {story}: Execute qa-gate task to write/update quality gate decision in directory from qa.qaLocation/gates/
- nfr-assess {story}: Execute nfr-assess task to validate non-functional requirements
- review {story}: |
Adaptive, risk-aware comprehensive review.
Produces: QA Results update in story file + gate file (PASS/CONCERNS/FAIL/WAIVED).
Gate file location: docs/qa/gates/{epic}.{story}-{slug}.yml
Gate file location: qa.qaLocation/gates/{epic}.{story}-{slug}.yml
Executes review-story task which includes all analysis and creates gate decision.
- gate {story}: Execute qa-gate task to write/update quality gate decision in docs/qa/gates/
- trace {story}: Execute trace-requirements task to map requirements to tests using Given-When-Then
- risk-profile {story}: Execute risk-profile task to generate risk assessment matrix
- test-design {story}: Execute test-design task to create comprehensive test scenarios
- nfr-assess {story}: Execute nfr-assess task to validate non-functional requirements
- trace {story}: Execute trace-requirements task to map requirements to tests using Given-When-Then
- exit: Say goodbye as the Test Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- review-story.md
- qa-gate.md
- trace-requirements.md
- risk-profile.md
- test-design.md
- nfr-assess.md
data:
- technical-preferences.md
tasks:
- nfr-assess.md
- qa-gate.md
- review-story.md
- risk-profile.md
- test-design.md
- trace-requirements.md
templates:
- story-tmpl.yaml
- qa-gate-tmpl.yaml
- story-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# sm
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Bob
id: sm
@@ -46,17 +49,17 @@ persona:
# All commands require * prefix when used (e.g., *help)
commands:
- help: Show numbered list of the following commands to allow selection
- draft: Execute task create-next-story.md
- correct-course: Execute task correct-course.md
- draft: Execute task create-next-story.md
- story-checklist: Execute task execute-checklist.md with checklist story-draft-checklist.md
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
dependencies:
tasks:
- create-next-story.md
- execute-checklist.md
- correct-course.md
templates:
- story-tmpl.yaml
checklists:
- story-draft-checklist.md
tasks:
- correct-course.md
- create-next-story.md
- execute-checklist.md
templates:
- story-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# ux-expert
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Greet user with your name/role and mention `*help` command
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -26,7 +29,7 @@ activation-instructions:
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: Sally
id: ux-expert
@@ -55,12 +58,12 @@ commands:
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
dependencies:
tasks:
- generate-ai-frontend-prompt.md
- create-doc.md
- execute-checklist.md
templates:
- front-end-spec-tmpl.yaml
data:
- technical-preferences.md
tasks:
- create-doc.md
- execute-checklist.md
- generate-ai-frontend-prompt.md
templates:
- front-end-spec-tmpl.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,4 +1,7 @@
# <!-- Powered by BMAD™ Core -->
markdownExploder: true
qa:
qaLocation: docs/qa
prd:
prdFile: docs/prd.md
prdVersion: v4

View File

@@ -1,8 +1,10 @@
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -101,7 +103,7 @@ npx bmad-method install
- **Roo Code**: Web-based IDE with agent support
- **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**:
@@ -109,7 +111,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -353,7 +355,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -708,7 +710,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -740,7 +742,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Brainstorming Techniques Data
## Creative Expansion

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Test Levels Framework
Comprehensive guide for determining appropriate test levels (unit, integration, E2E) for different scenarios.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Test Priorities Matrix
Guide for prioritizing test scenarios based on risk, criticality, and business impact.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose

View File

@@ -0,0 +1,150 @@
<!-- Powered by BMAD™ Core -->
# apply-qa-fixes
Implement fixes based on QA results (gate and assessments) for a specific story. This task is for the Dev agent to systematically consume QA outputs and apply code/test changes while only updating allowed sections in the story file.
## Purpose
- Read QA outputs for a story (gate YAML + assessment markdowns)
- Create a prioritized, deterministic fix plan
- Apply code and test changes to close gaps and address issues
- Update only the allowed story sections for the Dev agent
## Inputs
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "2.2"
- qa_root: from `bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
optional:
- story_title: '{title}' # derive from story H1 if missing
- story_slug: '{slug}' # derive from title (lowercase, hyphenated) if missing
```
## QA Sources to Read
- Gate (YAML): `{qa_root}/gates/{epic}.{story}-*.yml`
- If multiple, use the most recent by modified time
- Assessments (Markdown):
- Test Design: `{qa_root}/assessments/{epic}.{story}-test-design-*.md`
- Traceability: `{qa_root}/assessments/{epic}.{story}-trace-*.md`
- Risk Profile: `{qa_root}/assessments/{epic}.{story}-risk-*.md`
- NFR Assessment: `{qa_root}/assessments/{epic}.{story}-nfr-*.md`
## Prerequisites
- Repository builds and tests run locally (Deno 2)
- Lint and test commands available:
- `deno lint`
- `deno test -A`
## Process (Do not skip steps)
### 0) Load Core Config & Locate Story
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Locate story file in `{story_root}/{epic}.{story}.*.md`
- HALT if missing and ask for correct story id/path
### 1) Collect QA Findings
- Parse the latest gate YAML:
- `gate` (PASS|CONCERNS|FAIL|WAIVED)
- `top_issues[]` with `id`, `severity`, `finding`, `suggested_action`
- `nfr_validation.*.status` and notes
- `trace` coverage summary/gaps
- `test_design.coverage_gaps[]`
- `risk_summary.recommendations.must_fix[]` (if present)
- Read any present assessment markdowns and extract explicit gaps/recommendations
### 2) Build Deterministic Fix Plan (Priority Order)
Apply in order, highest priority first:
1. High severity items in `top_issues` (security/perf/reliability/maintainability)
2. NFR statuses: all FAIL must be fixed → then CONCERNS
3. Test Design `coverage_gaps` (prioritize P0 scenarios if specified)
4. Trace uncovered requirements (AC-level)
5. Risk `must_fix` recommendations
6. Medium severity issues, then low
Guidance:
- Prefer tests closing coverage gaps before/with code changes
- Keep changes minimal and targeted; follow project architecture and TS/Deno rules
### 3) Apply Changes
- Implement code fixes per plan
- Add missing tests to close coverage gaps (unit first; integration where required by AC)
- Keep imports centralized via `deps.ts` (see `docs/project/typescript-rules.md`)
- Follow DI boundaries in `src/core/di.ts` and existing patterns
### 4) Validate
- Run `deno lint` and fix issues
- Run `deno test -A` until all tests pass
- Iterate until clean
### 5) Update Story (Allowed Sections ONLY)
CRITICAL: Dev agent is ONLY authorized to update these sections of the story file. Do not modify any other sections (e.g., QA Results, Story, Acceptance Criteria, Dev Notes, Testing):
- Tasks / Subtasks Checkboxes (mark any fix subtask you added as done)
- Dev Agent Record →
- Agent Model Used (if changed)
- Debug Log References (commands/results, e.g., lint/tests)
- Completion Notes List (what changed, why, how)
- File List (all added/modified/deleted files)
- Change Log (new dated entry describing applied fixes)
- Status (see Rule below)
Status Rule:
- If gate was PASS and all identified gaps are closed → set `Status: Ready for Done`
- Otherwise → set `Status: Ready for Review` and notify QA to re-run the review
### 6) Do NOT Edit Gate Files
- Dev does not modify gate YAML. If fixes address issues, request QA to re-run `review-story` to update the gate
## Blocking Conditions
- Missing `bmad-core/core-config.yaml`
- Story file not found for `story_id`
- No QA artifacts found (neither gate nor assessments)
- HALT and request QA to generate at least a gate file (or proceed only with clear developer-provided fix list)
## Completion Checklist
- deno lint: 0 problems
- deno test -A: all tests pass
- All high severity `top_issues` addressed
- NFR FAIL → resolved; CONCERNS minimized or documented
- Coverage gaps closed or explicitly documented with rationale
- Story updated (allowed sections only) including File List and Change Log
- Status set according to Status Rule
## Example: Story 2.2
Given gate `docs/project/qa/gates/2.2-*.yml` shows
- `coverage_gaps`: Back action behavior untested (AC2)
- `coverage_gaps`: Centralized dependencies enforcement untested (AC4)
Fix plan:
- Add a test ensuring the Toolkit Menu "Back" action returns to Main Menu
- Add a static test verifying imports for service/view go through `deps.ts`
- Re-run lint/tests and update Dev Agent Record + File List accordingly
## Key Principles
- Deterministic, risk-first prioritization
- Minimal, maintainable changes
- Tests validate behavior and close gaps
- Strict adherence to allowed story update areas
- Gate ownership remains with QA; Dev signals readiness via Status

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Epic Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Next Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose

View File

@@ -1,6 +1,8 @@
---
## <!-- Powered by BMAD™ Core -->
docOutputLocation: docs/brainstorming-session-results.md
template: '{root}/templates/brainstorming-output-tmpl.yaml'
---
# Facilitate Brainstorming Session Task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create AI Frontend Prompt Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Index Documentation Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# KB Mode Interaction Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# nfr-assess
Quick NFR validation focused on the core four: security, performance, reliability, maintainability.
@@ -7,11 +9,11 @@ Quick NFR validation focused on the core four: security, performance, reliabilit
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "1.3"
- story_path: 'docs/stories/{epic}.{story}.*.md'
- story_path: `bmad-core/core-config.yaml` for the `devStoryLocation`
optional:
- architecture_refs: 'docs/architecture/*.md'
- technical_preferences: 'docs/technical-preferences.md'
- architecture_refs: `bmad-core/core-config.yaml` for the `architecture.architectureFile`
- technical_preferences: `bmad-core/core-config.yaml` for the `technicalPreferences`
- acceptance_criteria: From story file
```
@@ -20,7 +22,7 @@ optional:
Assess non-functional requirements for a story and generate:
1. YAML block for the gate file's `nfr_validation` section
2. Brief markdown assessment saved to `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
2. Brief markdown assessment saved to `qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
## Process
@@ -123,7 +125,7 @@ If `technical-preferences.md` defines custom weights, use those instead.
## Output 2: Brief Assessment Report
**ALWAYS save to:** `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
**ALWAYS save to:** `qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
```markdown
# NFR Assessment: {epic}.{story}
@@ -162,7 +164,7 @@ Reviewer: Quinn
**End with this line for the review task to quote:**
```
NFR assessment: docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
NFR assessment: qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
```
## Output 4: Gate Integration Line
@@ -170,7 +172,7 @@ NFR assessment: docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
**Always print at the end:**
```
Gate NFR block ready → paste into docs/qa/gates/{epic}.{story}-{slug}.yml under nfr_validation
Gate NFR block ready → paste into qa.qaLocation/gates/{epic}.{story}-{slug}.yml under nfr_validation
```
## Assessment Criteria

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# qa-gate
Create or update a quality gate decision file for a story based on review findings.
@@ -14,7 +16,7 @@ Generate a standalone quality gate file that provides a clear pass/fail decision
## Gate File Location
**ALWAYS** create file at: `docs/qa/gates/{epic}.{story}-{slug}.yml`
**ALWAYS** check the `bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
Slug rules:
@@ -124,11 +126,13 @@ waiver:
## Output Requirements
1. **ALWAYS** create gate file at: `docs/qa/gates/{epic}.{story}-{slug}.yml`
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `bmad-core/core-config.yaml`
2. **ALWAYS** append this exact format to story's QA Results section:
```text
Gate: {STATUS} → qa.qaLocation/gates/{epic}.{story}-{slug}.yml
```
Gate: {STATUS} → docs/qa/gates/{epic}.{story}-{slug}.yml
```
3. Keep status_reason to 1-2 sentences maximum
4. Use severity values exactly: `low`, `medium`, or `high`
@@ -147,7 +151,7 @@ After creating gate file, append to story's QA Results section:
### Gate Status
Gate: CONCERNS → docs/qa/gates/1.3-user-auth-login.yml
Gate: CONCERNS → qa.qaLocation/gates/{epic}.{story}-{slug}.yml
```
## Key Principles

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# review-story
Perform a comprehensive test architecture review with quality gate decision. This adaptive, risk-aware review creates both a story update and a detailed gate file.
@@ -167,9 +169,9 @@ After review and any refactoring, append your results to the story file in the Q
### Gate Status
Gate: {STATUS} → docs/qa/gates/{epic}.{story}-{slug}.yml
Risk profile: docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
NFR assessment: docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
Gate: {STATUS} → qa.qaLocation/gates/{epic}.{story}-{slug}.yml
Risk profile: qa.qaLocation/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
NFR assessment: qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
# Note: Paths should reference core-config.yaml for custom configurations
@@ -183,9 +185,9 @@ NFR assessment: docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
**Template and Directory:**
- Render from `templates/qa-gate-tmpl.yaml`
- Create `docs/qa/gates/` directory if missing (or configure in core-config.yaml)
- Save to: `docs/qa/gates/{epic}.{story}-{slug}.yml`
- Render from `../templates/qa-gate-tmpl.yaml`
- Create directory defined in `qa.qaLocation/gates` (see `bmad-core/core-config.yaml`) if missing
- Save to: `qa.qaLocation/gates/{epic}.{story}-{slug}.yml`
Gate file structure:
@@ -308,7 +310,7 @@ Stop the review and request clarification if:
After review:
1. Update the QA Results section in the story file
2. Create the gate file in `docs/qa/gates/`
2. Create the gate file in directory from `qa.qaLocation/gates`
3. Recommend status: "Ready for Done" or "Changes Required" (owner decides)
4. If files were modified, list them in QA Results and ask Dev to update File List
5. Always provide constructive feedback and actionable recommendations

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# risk-profile
Generate a comprehensive risk assessment matrix for a story implementation using probability × impact analysis.
@@ -105,7 +107,7 @@ Evaluate each risk using probability × impact:
- `Medium (2)`: Moderate consequences (degraded performance, minor data issues)
- `Low (1)`: Minor consequences (cosmetic issues, slight inconvenience)
**Risk Score = Probability × Impact**
### Risk Score = Probability × Impact
- 9: Critical Risk (Red)
- 6: High Risk (Orange)
@@ -182,7 +184,7 @@ risk_summary:
### Output 2: Markdown Report
**Save to:** `docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md`
**Save to:** `qa.qaLocation/assessments/{epic}.{story}-risk-{YYYYMMDD}.md`
```markdown
# Risk Profile: Story {epic}.{story}
@@ -290,7 +292,7 @@ Review and update risk profile when:
Calculate overall story risk score:
```
```text
Base Score = 100
For each risk:
- Critical (9): Deduct 20 points
@@ -339,8 +341,8 @@ Based on risk profile, recommend:
**Print this line for review task to quote:**
```
Risk profile: docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
```text
Risk profile: qa.qaLocation/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
```
## Key Principles

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# test-design
Create comprehensive test scenarios with appropriate test level recommendations for story implementation.
@@ -84,7 +86,7 @@ Ensure:
### Output 1: Test Design Document
**Save to:** `docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md`
**Save to:** `qa.qaLocation/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md`
```markdown
# Test Design: Story {epic}.{story}
@@ -150,7 +152,7 @@ test_design:
Print for use by trace-requirements task:
```text
Test design matrix: docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md
Test design matrix: qa.qaLocation/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md
P0 tests identified: {count}
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# trace-requirements
Map story requirements to test cases using Given-When-Then patterns for comprehensive traceability.
@@ -95,16 +97,16 @@ trace:
full: Y
partial: Z
none: W
planning_ref: 'docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md'
planning_ref: 'qa.qaLocation/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md'
uncovered:
- ac: 'AC3'
reason: 'No test found for password reset timing'
notes: 'See docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md'
notes: 'See qa.qaLocation/assessments/{epic}.{story}-trace-{YYYYMMDD}.md'
```
### Output 2: Traceability Report
**Save to:** `docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md`
**Save to:** `qa.qaLocation/assessments/{epic}.{story}-trace-{YYYYMMDD}.md`
Create a traceability report with:
@@ -250,7 +252,7 @@ This traceability feeds into quality gates:
**Print this line for review task to quote:**
```text
Trace matrix: docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md
Trace matrix: qa.qaLocation/assessments/{epic}.{story}-trace-{YYYYMMDD}.md
```
- Full coverage → PASS contribution

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: architecture-template-v2
name: Architecture Document

View File

@@ -153,4 +153,4 @@ sections:
content: |
---
*Session facilitated using the BMAD-METHOD brainstorming framework*
*Session facilitated using the BMAD-METHOD brainstorming framework*

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-architecture-template-v2
name: Brownfield Enhancement Architecture

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-prd-template-v2
name: Brownfield Enhancement PRD

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: competitor-analysis-template-v2
name: Competitive Analysis Report

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-architecture-template-v2
name: Frontend Architecture Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-spec-template-v2
name: UI/UX Specification

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: fullstack-architecture-template-v2
name: Fullstack Architecture Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: market-research-template-v2
name: Market Research Report

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: prd-template-v2
name: Product Requirements Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: project-brief-template-v2
name: Project Brief

View File

@@ -1,10 +1,11 @@
# <!-- Powered by BMAD™ Core -->
template:
id: qa-gate-template-v1
name: Quality Gate Decision
version: 1.0
output:
format: yaml
filename: docs/qa/gates/{{epic_num}}.{{story_num}}-{{story_slug}}.yml
filename: qa.qaLocation/gates/{{epic_num}}.{{story_num}}-{{story_slug}}.yml
title: "Quality Gate: {{epic_num}}.{{story_num}}"
# Required fields (keep these first)

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-fullstack
name: Brownfield Full-Stack Enhancement
@@ -159,7 +160,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -176,7 +177,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-service
name: Brownfield Service/API Enhancement
@@ -105,7 +106,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -122,7 +123,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-ui
name: Brownfield UI/Frontend Enhancement
@@ -112,7 +113,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -129,7 +130,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-fullstack
name: Greenfield Full-Stack Application Development
@@ -64,12 +65,12 @@ workflow:
condition: po_checklist_issues
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
- project_setup_guidance:
- step: project_setup_guidance
action: guide_project_structure
condition: user_has_generated_ui
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo alongside backend repo. For monorepo, place in apps/web or packages/frontend directory. Review architecture document for specific guidance."
- development_order_guidance:
- step: development_order_guidance
action: guide_development_sequence
notes: "Based on PRD stories: If stories are frontend-heavy, start with frontend project/directory first. If backend-heavy or API-first, start with backend. For tightly coupled features, follow story sequence in monorepo setup. Reference sharded PRD epics for development order."
@@ -137,7 +138,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -154,7 +155,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-service
name: Greenfield Service/API Development
@@ -113,7 +114,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -130,7 +131,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-ui
name: Greenfield UI/Frontend Development
@@ -63,7 +64,7 @@ workflow:
condition: po_checklist_issues
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
- project_setup_guidance:
- step: project_setup_guidance
action: guide_project_structure
condition: user_has_generated_ui
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo. For monorepo, place in apps/web or frontend/ directory. Review architecture document for specific guidance."
@@ -132,7 +133,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -149,7 +150,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Document Template Specification
## Overview

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Workflow Management
Enables BMad orchestrator to manage and execute team workflows.

1767
dist/agents/analyst.txt vendored

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -53,7 +53,6 @@ activation-instructions:
- Assess user goal against available agents and workflows in this bundle
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
agent:
name: BMad Orchestrator
id: bmad-orchestrator
@@ -77,21 +76,16 @@ persona:
- Always remind users that commands require * prefix
commands:
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMad knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
exit: Return to BMad or exit session
task: Run a specific task (list if name not specified)
workflow: Start a specific workflow (list if name not specified)
workflow-guidance: Get personalized help selecting the right workflow
plan: Create detailed workflow plan before starting
plan-status: Show current workflow plan progress
plan-update: Update workflow plan status
chat-mode: Start conversational mode for detailed assistance
checklist: Execute a checklist (list if name not specified)
yolo: Toggle skip confirmations mode
party-mode: Group chat with all agents
doc-out: Output full document
kb-mode: Load full BMad knowledge base
party-mode: Group chat with all agents
status: Show current context, active agent, and progress
task: Run a specific task (list if name not specified)
yolo: Toggle skip confirmations mode
exit: Return to BMad or exit session
help-display-template: |
=== BMad Orchestrator Commands ===
All commands must start with * (asterisk)
@@ -160,19 +154,21 @@ workflow-guidance:
- Only recommend workflows that actually exist in the current bundle
- When *workflow-guidance is called, start an interactive session and list all available workflows with brief descriptions
dependencies:
data:
- bmad-kb.md
- elicitation-methods.md
tasks:
- advanced-elicitation.md
- create-doc.md
- kb-mode-interaction.md
data:
- bmad-kb.md
- elicitation-methods.md
utils:
- workflow-management.md
```
==================== END: .bmad-core/agents/bmad-orchestrator.md ====================
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose
@@ -293,6 +289,8 @@ Choose a number (0-8) or 9 to proceed:
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -397,6 +395,8 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
<!-- Powered by BMAD™ Core -->
# KB Mode Interaction Task
## Purpose
@@ -475,11 +475,13 @@ Or ask me about anything else related to BMad-Method!
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
==================== START: .bmad-core/data/bmad-kb.md ====================
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -578,7 +580,7 @@ npx bmad-method install
- **Roo Code**: Web-based IDE with agent support
- **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**:
@@ -586,7 +588,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -830,7 +832,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -1185,7 +1187,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -1217,7 +1219,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?
@@ -1284,6 +1286,8 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/bmad-kb.md ====================
==================== START: .bmad-core/data/elicitation-methods.md ====================
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods
@@ -1441,6 +1445,8 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/elicitation-methods.md ====================
==================== START: .bmad-core/utils/workflow-management.md ====================
<!-- Powered by BMAD™ Core -->
# Workflow Management
Enables BMad orchestrator to manage and execute team workflows.

174
dist/agents/dev.txt vendored
View File

@@ -64,14 +64,12 @@ persona:
focus: Executing story tasks with precision, updating Dev Agent Record sections only, maintaining minimal context overhead
core_principles:
- CRITICAL: Story has ALL info you will need aside from what you loaded during the startup commands. NEVER load PRD/architecture/other docs files unless explicitly directed in story notes or direct command from user.
- CRITICAL: ALWAYS check current folder structure before starting your story tasks, don't create new working directory if it already exists. Create new one when you're sure it's a brand new project.
- CRITICAL: ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- CRITICAL: FOLLOW THE develop-story command when the user tells you to implement the story
- Numbered Options - Always use numbered lists when presenting choices to the user
commands:
- help: Show numbered list of the following commands to allow selection
- run-tests: Execute linting and tests
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
- develop-story:
- order-of-execution: Read (first or next) task→Implement Task and its subtasks→Write tests→Execute validations→Only if ALL pass, then update the task checkbox with [x]→Update story section File List to ensure it lists and new or modified or deleted source file→repeat order-of-execution until complete
- story-file-updates-ONLY:
@@ -81,16 +79,176 @@ commands:
- blocking: 'HALT for: Unapproved deps needed, confirm with user | Ambiguous after story check | 3 failures attempting to implement or fix something repeatedly | Missing config | Failing regression'
- ready-for-review: Code matches requirements + All validations pass + Follows standards + File List complete
- completion: 'All Tasks and Subtasks marked [x] and have tests→Validations and full regression passes (DON''T BE LAZY, EXECUTE ALL TESTS and CONFIRM)→Ensure File List is Complete→run the task execute-checklist for the checklist story-dod-checklist→set story status: ''Ready for Review''→HALT'
- explain: teach me what and why you did whatever you just did in detail so I can learn. Explain to me as if you were training a junior engineer.
- review-qa: run task `apply-qa-fixes.md'
- run-tests: Execute linting and tests
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist.md
- validate-next-story.md
checklists:
- story-dod-checklist.md
tasks:
- apply-qa-fixes.md
- execute-checklist.md
- validate-next-story.md
```
==================== END: .bmad-core/agents/dev.md ====================
==================== START: .bmad-core/tasks/apply-qa-fixes.md ====================
<!-- Powered by BMAD™ Core -->
# apply-qa-fixes
Implement fixes based on QA results (gate and assessments) for a specific story. This task is for the Dev agent to systematically consume QA outputs and apply code/test changes while only updating allowed sections in the story file.
## Purpose
- Read QA outputs for a story (gate YAML + assessment markdowns)
- Create a prioritized, deterministic fix plan
- Apply code and test changes to close gaps and address issues
- Update only the allowed story sections for the Dev agent
## Inputs
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "2.2"
- qa_root: from `bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
optional:
- story_title: '{title}' # derive from story H1 if missing
- story_slug: '{slug}' # derive from title (lowercase, hyphenated) if missing
```
## QA Sources to Read
- Gate (YAML): `{qa_root}/gates/{epic}.{story}-*.yml`
- If multiple, use the most recent by modified time
- Assessments (Markdown):
- Test Design: `{qa_root}/assessments/{epic}.{story}-test-design-*.md`
- Traceability: `{qa_root}/assessments/{epic}.{story}-trace-*.md`
- Risk Profile: `{qa_root}/assessments/{epic}.{story}-risk-*.md`
- NFR Assessment: `{qa_root}/assessments/{epic}.{story}-nfr-*.md`
## Prerequisites
- Repository builds and tests run locally (Deno 2)
- Lint and test commands available:
- `deno lint`
- `deno test -A`
## Process (Do not skip steps)
### 0) Load Core Config & Locate Story
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Locate story file in `{story_root}/{epic}.{story}.*.md`
- HALT if missing and ask for correct story id/path
### 1) Collect QA Findings
- Parse the latest gate YAML:
- `gate` (PASS|CONCERNS|FAIL|WAIVED)
- `top_issues[]` with `id`, `severity`, `finding`, `suggested_action`
- `nfr_validation.*.status` and notes
- `trace` coverage summary/gaps
- `test_design.coverage_gaps[]`
- `risk_summary.recommendations.must_fix[]` (if present)
- Read any present assessment markdowns and extract explicit gaps/recommendations
### 2) Build Deterministic Fix Plan (Priority Order)
Apply in order, highest priority first:
1. High severity items in `top_issues` (security/perf/reliability/maintainability)
2. NFR statuses: all FAIL must be fixed → then CONCERNS
3. Test Design `coverage_gaps` (prioritize P0 scenarios if specified)
4. Trace uncovered requirements (AC-level)
5. Risk `must_fix` recommendations
6. Medium severity issues, then low
Guidance:
- Prefer tests closing coverage gaps before/with code changes
- Keep changes minimal and targeted; follow project architecture and TS/Deno rules
### 3) Apply Changes
- Implement code fixes per plan
- Add missing tests to close coverage gaps (unit first; integration where required by AC)
- Keep imports centralized via `deps.ts` (see `docs/project/typescript-rules.md`)
- Follow DI boundaries in `src/core/di.ts` and existing patterns
### 4) Validate
- Run `deno lint` and fix issues
- Run `deno test -A` until all tests pass
- Iterate until clean
### 5) Update Story (Allowed Sections ONLY)
CRITICAL: Dev agent is ONLY authorized to update these sections of the story file. Do not modify any other sections (e.g., QA Results, Story, Acceptance Criteria, Dev Notes, Testing):
- Tasks / Subtasks Checkboxes (mark any fix subtask you added as done)
- Dev Agent Record →
- Agent Model Used (if changed)
- Debug Log References (commands/results, e.g., lint/tests)
- Completion Notes List (what changed, why, how)
- File List (all added/modified/deleted files)
- Change Log (new dated entry describing applied fixes)
- Status (see Rule below)
Status Rule:
- If gate was PASS and all identified gaps are closed → set `Status: Ready for Done`
- Otherwise → set `Status: Ready for Review` and notify QA to re-run the review
### 6) Do NOT Edit Gate Files
- Dev does not modify gate YAML. If fixes address issues, request QA to re-run `review-story` to update the gate
## Blocking Conditions
- Missing `bmad-core/core-config.yaml`
- Story file not found for `story_id`
- No QA artifacts found (neither gate nor assessments)
- HALT and request QA to generate at least a gate file (or proceed only with clear developer-provided fix list)
## Completion Checklist
- deno lint: 0 problems
- deno test -A: all tests pass
- All high severity `top_issues` addressed
- NFR FAIL → resolved; CONCERNS minimized or documented
- Coverage gaps closed or explicitly documented with rationale
- Story updated (allowed sections only) including File List and Change Log
- Status set according to Status Rule
## Example: Story 2.2
Given gate `docs/project/qa/gates/2.2-*.yml` shows
- `coverage_gaps`: Back action behavior untested (AC2)
- `coverage_gaps`: Centralized dependencies enforcement untested (AC4)
Fix plan:
- Add a test ensuring the Toolkit Menu "Back" action returns to Main Menu
- Add a static test verifying imports for service/view go through `deps.ts`
- Re-run lint/tests and update Dev Agent Record + File List accordingly
## Key Principles
- Deterministic, risk-first prioritization
- Minimal, maintainable changes
- Tests validate behavior and close gaps
- Strict adherence to allowed story update areas
- Gate ownership remains with QA; Dev signals readiness via Status
==================== END: .bmad-core/tasks/apply-qa-fixes.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -180,6 +338,8 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -317,6 +477,8 @@ Provide a structured validation report including:
==================== END: .bmad-core/tasks/validate-next-story.md ====================
==================== START: .bmad-core/checklists/story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

1556
dist/agents/pm.txt vendored

File diff suppressed because it is too large Load Diff

545
dist/agents/po.txt vendored
View File

@@ -75,30 +75,107 @@ persona:
- Documentation Ecosystem Integrity - Maintain consistency across all documents
commands:
- help: Show numbered list of the following commands to allow selection
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
- correct-course: execute the correct-course task
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- doc-out: Output full document to current destination file
- execute-checklist-po: Run task execute-checklist (checklist po-master-checklist)
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
- validate-story-draft {story}: run the task validate-next-story against the provided story file
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
- exit: Exit (confirm)
dependencies:
checklists:
- change-checklist.md
- po-master-checklist.md
tasks:
- correct-course.md
- execute-checklist.md
- shard-doc.md
- correct-course.md
- validate-next-story.md
templates:
- story-tmpl.yaml
checklists:
- po-master-checklist.md
- change-checklist.md
```
==================== END: .bmad-core/agents/po.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
## Instructions
### 1. Initial Setup & Mode Selection
- **Acknowledge Task & Inputs:**
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
- **Establish Interaction Mode:**
- Ask the user their preferred interaction mode for this task:
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
- For each checklist item or logical group of items (depending on interaction mode):
- Present the relevant prompt(s) or considerations from the checklist to the user.
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
- Discuss your findings for each item with the user.
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
### 3. Draft Proposed Changes (Iteratively or Batched)
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
- Revising user story text, acceptance criteria, or priority.
- Adding, removing, reordering, or splitting user stories within epics.
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
### 4. Generate "Sprint Change Proposal" with Edits
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
- The proposal must clearly present:
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
### 5. Finalize & Determine Next Steps
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
- Provide the finalized "Sprint Change Proposal" document to the user.
- **Based on the nature of the approved changes:**
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
## Output Deliverables
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
- 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.
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -188,6 +265,8 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -375,80 +454,9 @@ Document sharded successfully:
- Ensure the sharding is reversible (could reconstruct the original from shards)
==================== END: .bmad-core/tasks/shard-doc.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
# Correct Course Task
## Purpose
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
## Instructions
### 1. Initial Setup & Mode Selection
- **Acknowledge Task & Inputs:**
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
- **Establish Interaction Mode:**
- Ask the user their preferred interaction mode for this task:
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
- For each checklist item or logical group of items (depending on interaction mode):
- Present the relevant prompt(s) or considerations from the checklist to the user.
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
- Discuss your findings for each item with the user.
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
### 3. Draft Proposed Changes (Iteratively or Batched)
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
- Revising user story text, acceptance criteria, or priority.
- Adding, removing, reordering, or splitting user stories within epics.
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
### 4. Generate "Sprint Change Proposal" with Edits
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
- The proposal must clearly present:
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
### 5. Finalize & Determine Next Steps
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
- Provide the finalized "Sprint Change Proposal" document to the user.
- **Based on the nature of the approved changes:**
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
## Output Deliverables
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
- 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.
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -586,6 +594,7 @@ Provide a structured validation report including:
==================== END: .bmad-core/tasks/validate-next-story.md ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -593,7 +602,7 @@ template:
output:
format: markdown
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
title: 'Story {{epic_num}}.{{story_num}}: {{story_title_short}}'
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
workflow:
mode: interactive
@@ -695,7 +704,7 @@ sections:
sections:
- id: agent-model
title: Agent Model Used
template: '{{agent_model_name_version}}'
template: "{{agent_model_name_version}}"
instruction: Record the specific AI agent model and version used for development
owner: dev-agent
editors: [dev-agent]
@@ -725,7 +734,196 @@ sections:
editors: [qa-agent]
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/checklists/change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
[[LLM: INITIALIZATION INSTRUCTIONS - CHANGE NAVIGATION
Changes during development are inevitable, but how we handle them determines project success or failure.
Before proceeding, understand:
1. This checklist is for SIGNIFICANT changes that affect the project direction
2. Minor adjustments within a story don't require this process
3. The goal is to minimize wasted work while adapting to new realities
4. User buy-in is critical - they must understand and approve changes
Required context:
- The triggering story or issue
- Current project state (completed stories, current epic)
- Access to PRD, architecture, and other key documents
- Understanding of remaining work planned
APPROACH:
This is an interactive process with the user. Work through each section together, discussing implications and options. The user makes final decisions, but provide expert guidance on technical feasibility and impact.
REMEMBER: Changes are opportunities to improve, not failures. Handle them professionally and constructively.]]
---
## 1. Understand the Trigger & Context
[[LLM: Start by fully understanding what went wrong and why. Don't jump to solutions yet. Ask probing questions:
- What exactly happened that triggered this review?
- Is this a one-time issue or symptomatic of a larger problem?
- Could this have been anticipated earlier?
- What assumptions were incorrect?
Be specific and factual, not blame-oriented.]]
- [ ] **Identify Triggering Story:** Clearly identify the story (or stories) that revealed the issue.
- [ ] **Define the Issue:** Articulate the core problem precisely.
- [ ] Is it a technical limitation/dead-end?
- [ ] Is it a newly discovered requirement?
- [ ] Is it a fundamental misunderstanding of existing requirements?
- [ ] Is it a necessary pivot based on feedback or new information?
- [ ] Is it a failed/abandoned story needing a new approach?
- [ ] **Assess Initial Impact:** Describe the immediate observed consequences (e.g., blocked progress, incorrect functionality, non-viable tech).
- [ ] **Gather Evidence:** Note any specific logs, error messages, user feedback, or analysis that supports the issue definition.
## 2. Epic Impact Assessment
[[LLM: Changes ripple through the project structure. Systematically evaluate:
1. Can we salvage the current epic with modifications?
2. Do future epics still make sense given this change?
3. Are we creating or eliminating dependencies?
4. Does the epic sequence need reordering?
Think about both immediate and downstream effects.]]
- [ ] **Analyze Current Epic:**
- [ ] Can the current epic containing the trigger story still be completed?
- [ ] Does the current epic need modification (story changes, additions, removals)?
- [ ] Should the current epic be abandoned or fundamentally redefined?
- [ ] **Analyze Future Epics:**
- [ ] Review all remaining planned epics.
- [ ] Does the issue require changes to planned stories in future epics?
- [ ] Does the issue invalidate any future epics?
- [ ] Does the issue necessitate the creation of entirely new epics?
- [ ] Should the order/priority of future epics be changed?
- [ ] **Summarize Epic Impact:** Briefly document the overall effect on the project's epic structure and flow.
## 3. Artifact Conflict & Impact Analysis
[[LLM: Documentation drives development in BMad. Check each artifact:
1. Does this change invalidate documented decisions?
2. Are architectural assumptions still valid?
3. Do user flows need rethinking?
4. Are technical constraints different than documented?
Be thorough - missed conflicts cause future problems.]]
- [ ] **Review PRD:**
- [ ] Does the issue conflict with the core goals or requirements stated in the PRD?
- [ ] Does the PRD need clarification or updates based on the new understanding?
- [ ] **Review Architecture Document:**
- [ ] Does the issue conflict with the documented architecture (components, patterns, tech choices)?
- [ ] Are specific components/diagrams/sections impacted?
- [ ] Does the technology list need updating?
- [ ] Do data models or schemas need revision?
- [ ] Are external API integrations affected?
- [ ] **Review Frontend Spec (if applicable):**
- [ ] Does the issue conflict with the FE architecture, component library choice, or UI/UX design?
- [ ] Are specific FE components or user flows impacted?
- [ ] **Review Other Artifacts (if applicable):**
- [ ] Consider impact on deployment scripts, IaC, monitoring setup, etc.
- [ ] **Summarize Artifact Impact:** List all artifacts requiring updates and the nature of the changes needed.
## 4. Path Forward Evaluation
[[LLM: Present options clearly with pros/cons. For each path:
1. What's the effort required?
2. What work gets thrown away?
3. What risks are we taking?
4. How does this affect timeline?
5. Is this sustainable long-term?
Be honest about trade-offs. There's rarely a perfect solution.]]
- [ ] **Option 1: Direct Adjustment / Integration:**
- [ ] Can the issue be addressed by modifying/adding future stories within the existing plan?
- [ ] Define the scope and nature of these adjustments.
- [ ] Assess feasibility, effort, and risks of this path.
- [ ] **Option 2: Potential Rollback:**
- [ ] Would reverting completed stories significantly simplify addressing the issue?
- [ ] Identify specific stories/commits to consider for rollback.
- [ ] Assess the effort required for rollback.
- [ ] Assess the impact of rollback (lost work, data implications).
- [ ] Compare the net benefit/cost vs. Direct Adjustment.
- [ ] **Option 3: PRD MVP Review & Potential Re-scoping:**
- [ ] Is the original PRD MVP still achievable given the issue and constraints?
- [ ] Does the MVP scope need reduction (removing features/epics)?
- [ ] Do the core MVP goals need modification?
- [ ] Are alternative approaches needed to meet the original MVP intent?
- [ ] **Extreme Case:** Does the issue necessitate a fundamental replan or potentially a new PRD V2 (to be handled by PM)?
- [ ] **Select Recommended Path:** Based on the evaluation, agree on the most viable path forward.
## 5. Sprint Change Proposal Components
[[LLM: The proposal must be actionable and clear. Ensure:
1. The issue is explained in plain language
2. Impacts are quantified where possible
3. The recommended path has clear rationale
4. Next steps are specific and assigned
5. Success criteria for the change are defined
This proposal guides all subsequent work.]]
(Ensure all agreed-upon points from previous sections are captured in the proposal)
- [ ] **Identified Issue Summary:** Clear, concise problem statement.
- [ ] **Epic Impact Summary:** How epics are affected.
- [ ] **Artifact Adjustment Needs:** List of documents to change.
- [ ] **Recommended Path Forward:** Chosen solution with rationale.
- [ ] **PRD MVP Impact:** Changes to scope/goals (if any).
- [ ] **High-Level Action Plan:** Next steps for stories/updates.
- [ ] **Agent Handoff Plan:** Identify roles needed (PM, Arch, Design Arch, PO).
## 6. Final Review & Handoff
[[LLM: Changes require coordination. Before concluding:
1. Is the user fully aligned with the plan?
2. Do all stakeholders understand the impacts?
3. Are handoffs to other agents clear?
4. Is there a rollback plan if the change fails?
5. How will we validate the change worked?
Get explicit approval - implicit agreement causes problems.
FINAL REPORT:
After completing the checklist, provide a concise summary:
- What changed and why
- What we're doing about it
- Who needs to do what
- When we'll know if it worked
Keep it action-oriented and forward-looking.]]
- [ ] **Review Checklist:** Confirm all relevant items were discussed.
- [ ] **Review Sprint Change Proposal:** Ensure it accurately reflects the discussion and decisions.
- [ ] **User Approval:** Obtain explicit user approval for the proposal.
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
---
==================== END: .bmad-core/checklists/change-checklist.md ====================
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -1159,188 +1357,3 @@ After presenting the report, ask if the user wants:
- **CONDITIONAL**: The plan requires specific adjustments before proceeding.
- **REJECTED**: The plan requires significant revision to address critical deficiencies.
==================== END: .bmad-core/checklists/po-master-checklist.md ====================
==================== START: .bmad-core/checklists/change-checklist.md ====================
# 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.
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
[[LLM: INITIALIZATION INSTRUCTIONS - CHANGE NAVIGATION
Changes during development are inevitable, but how we handle them determines project success or failure.
Before proceeding, understand:
1. This checklist is for SIGNIFICANT changes that affect the project direction
2. Minor adjustments within a story don't require this process
3. The goal is to minimize wasted work while adapting to new realities
4. User buy-in is critical - they must understand and approve changes
Required context:
- The triggering story or issue
- Current project state (completed stories, current epic)
- Access to PRD, architecture, and other key documents
- Understanding of remaining work planned
APPROACH:
This is an interactive process with the user. Work through each section together, discussing implications and options. The user makes final decisions, but provide expert guidance on technical feasibility and impact.
REMEMBER: Changes are opportunities to improve, not failures. Handle them professionally and constructively.]]
---
## 1. Understand the Trigger & Context
[[LLM: Start by fully understanding what went wrong and why. Don't jump to solutions yet. Ask probing questions:
- What exactly happened that triggered this review?
- Is this a one-time issue or symptomatic of a larger problem?
- Could this have been anticipated earlier?
- What assumptions were incorrect?
Be specific and factual, not blame-oriented.]]
- [ ] **Identify Triggering Story:** Clearly identify the story (or stories) that revealed the issue.
- [ ] **Define the Issue:** Articulate the core problem precisely.
- [ ] Is it a technical limitation/dead-end?
- [ ] Is it a newly discovered requirement?
- [ ] Is it a fundamental misunderstanding of existing requirements?
- [ ] Is it a necessary pivot based on feedback or new information?
- [ ] Is it a failed/abandoned story needing a new approach?
- [ ] **Assess Initial Impact:** Describe the immediate observed consequences (e.g., blocked progress, incorrect functionality, non-viable tech).
- [ ] **Gather Evidence:** Note any specific logs, error messages, user feedback, or analysis that supports the issue definition.
## 2. Epic Impact Assessment
[[LLM: Changes ripple through the project structure. Systematically evaluate:
1. Can we salvage the current epic with modifications?
2. Do future epics still make sense given this change?
3. Are we creating or eliminating dependencies?
4. Does the epic sequence need reordering?
Think about both immediate and downstream effects.]]
- [ ] **Analyze Current Epic:**
- [ ] Can the current epic containing the trigger story still be completed?
- [ ] Does the current epic need modification (story changes, additions, removals)?
- [ ] Should the current epic be abandoned or fundamentally redefined?
- [ ] **Analyze Future Epics:**
- [ ] Review all remaining planned epics.
- [ ] Does the issue require changes to planned stories in future epics?
- [ ] Does the issue invalidate any future epics?
- [ ] Does the issue necessitate the creation of entirely new epics?
- [ ] Should the order/priority of future epics be changed?
- [ ] **Summarize Epic Impact:** Briefly document the overall effect on the project's epic structure and flow.
## 3. Artifact Conflict & Impact Analysis
[[LLM: Documentation drives development in BMad. Check each artifact:
1. Does this change invalidate documented decisions?
2. Are architectural assumptions still valid?
3. Do user flows need rethinking?
4. Are technical constraints different than documented?
Be thorough - missed conflicts cause future problems.]]
- [ ] **Review PRD:**
- [ ] Does the issue conflict with the core goals or requirements stated in the PRD?
- [ ] Does the PRD need clarification or updates based on the new understanding?
- [ ] **Review Architecture Document:**
- [ ] Does the issue conflict with the documented architecture (components, patterns, tech choices)?
- [ ] Are specific components/diagrams/sections impacted?
- [ ] Does the technology list need updating?
- [ ] Do data models or schemas need revision?
- [ ] Are external API integrations affected?
- [ ] **Review Frontend Spec (if applicable):**
- [ ] Does the issue conflict with the FE architecture, component library choice, or UI/UX design?
- [ ] Are specific FE components or user flows impacted?
- [ ] **Review Other Artifacts (if applicable):**
- [ ] Consider impact on deployment scripts, IaC, monitoring setup, etc.
- [ ] **Summarize Artifact Impact:** List all artifacts requiring updates and the nature of the changes needed.
## 4. Path Forward Evaluation
[[LLM: Present options clearly with pros/cons. For each path:
1. What's the effort required?
2. What work gets thrown away?
3. What risks are we taking?
4. How does this affect timeline?
5. Is this sustainable long-term?
Be honest about trade-offs. There's rarely a perfect solution.]]
- [ ] **Option 1: Direct Adjustment / Integration:**
- [ ] Can the issue be addressed by modifying/adding future stories within the existing plan?
- [ ] Define the scope and nature of these adjustments.
- [ ] Assess feasibility, effort, and risks of this path.
- [ ] **Option 2: Potential Rollback:**
- [ ] Would reverting completed stories significantly simplify addressing the issue?
- [ ] Identify specific stories/commits to consider for rollback.
- [ ] Assess the effort required for rollback.
- [ ] Assess the impact of rollback (lost work, data implications).
- [ ] Compare the net benefit/cost vs. Direct Adjustment.
- [ ] **Option 3: PRD MVP Review & Potential Re-scoping:**
- [ ] Is the original PRD MVP still achievable given the issue and constraints?
- [ ] Does the MVP scope need reduction (removing features/epics)?
- [ ] Do the core MVP goals need modification?
- [ ] Are alternative approaches needed to meet the original MVP intent?
- [ ] **Extreme Case:** Does the issue necessitate a fundamental replan or potentially a new PRD V2 (to be handled by PM)?
- [ ] **Select Recommended Path:** Based on the evaluation, agree on the most viable path forward.
## 5. Sprint Change Proposal Components
[[LLM: The proposal must be actionable and clear. Ensure:
1. The issue is explained in plain language
2. Impacts are quantified where possible
3. The recommended path has clear rationale
4. Next steps are specific and assigned
5. Success criteria for the change are defined
This proposal guides all subsequent work.]]
(Ensure all agreed-upon points from previous sections are captured in the proposal)
- [ ] **Identified Issue Summary:** Clear, concise problem statement.
- [ ] **Epic Impact Summary:** How epics are affected.
- [ ] **Artifact Adjustment Needs:** List of documents to change.
- [ ] **Recommended Path Forward:** Chosen solution with rationale.
- [ ] **PRD MVP Impact:** Changes to scope/goals (if any).
- [ ] **High-Level Action Plan:** Next steps for stories/updates.
- [ ] **Agent Handoff Plan:** Identify roles needed (PM, Arch, Design Arch, PO).
## 6. Final Review & Handoff
[[LLM: Changes require coordination. Before concluding:
1. Is the user fully aligned with the plan?
2. Do all stakeholders understand the impacts?
3. Are handoffs to other agents clear?
4. Is there a rollback plan if the change fails?
5. How will we validate the change worked?
Get explicit approval - implicit agreement causes problems.
FINAL REPORT:
After completing the checklist, provide a concise summary:
- What changed and why
- What we're doing about it
- Who needs to do what
- When we'll know if it worked
Keep it action-oriented and forward-looking.]]
- [ ] **Review Checklist:** Confirm all relevant items were discussed.
- [ ] **Review Sprint Change Proposal:** Ensure it accurately reflects the discussion and decisions.
- [ ] **User Approval:** Obtain explicit user approval for the proposal.
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
---
==================== END: .bmad-core/checklists/change-checklist.md ====================

2828
dist/agents/qa.txt vendored

File diff suppressed because it is too large Load Diff

173
dist/agents/sm.txt vendored
View File

@@ -68,23 +68,100 @@ persona:
- You are NOT allowed to implement stories or modify code EVER!
commands:
- help: Show numbered list of the following commands to allow selection
- draft: Execute task create-next-story.md
- correct-course: Execute task correct-course.md
- draft: Execute task create-next-story.md
- story-checklist: Execute task execute-checklist.md with checklist story-draft-checklist.md
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
dependencies:
tasks:
- create-next-story.md
- execute-checklist.md
- correct-course.md
templates:
- story-tmpl.yaml
checklists:
- story-draft-checklist.md
tasks:
- correct-course.md
- create-next-story.md
- execute-checklist.md
templates:
- story-tmpl.yaml
```
==================== END: .bmad-core/agents/sm.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
## Instructions
### 1. Initial Setup & Mode Selection
- **Acknowledge Task & Inputs:**
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
- **Establish Interaction Mode:**
- Ask the user their preferred interaction mode for this task:
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
- For each checklist item or logical group of items (depending on interaction mode):
- Present the relevant prompt(s) or considerations from the checklist to the user.
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
- Discuss your findings for each item with the user.
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
### 3. Draft Proposed Changes (Iteratively or Batched)
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
- Revising user story text, acceptance criteria, or priority.
- Adding, removing, reordering, or splitting user stories within epics.
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
### 4. Generate "Sprint Change Proposal" with Edits
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
- The proposal must clearly present:
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
### 5. Finalize & Determine Next Steps
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
- Provide the finalized "Sprint Change Proposal" document to the user.
- **Based on the nature of the approved changes:**
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
## Output Deliverables
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
- 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.
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/create-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Next Story Task
## Purpose
@@ -200,6 +277,8 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
==================== END: .bmad-core/tasks/create-next-story.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -288,80 +367,8 @@ The LLM will:
- Offer to provide detailed analysis of any section, especially those with warnings or failures
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
# Correct Course Task
## Purpose
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
## Instructions
### 1. Initial Setup & Mode Selection
- **Acknowledge Task & Inputs:**
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
- **Establish Interaction Mode:**
- Ask the user their preferred interaction mode for this task:
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
- For each checklist item or logical group of items (depending on interaction mode):
- Present the relevant prompt(s) or considerations from the checklist to the user.
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
- Discuss your findings for each item with the user.
- Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
- Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
### 3. Draft Proposed Changes (Iteratively or Batched)
- Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
- Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
- **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
- Revising user story text, acceptance criteria, or priority.
- Adding, removing, reordering, or splitting user stories within epics.
- Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
- Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
- Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
- If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
- If in "YOLO Mode," compile all drafted edits for presentation in the next step.
### 4. Generate "Sprint Change Proposal" with Edits
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
- The proposal must clearly present:
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
- Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
### 5. Finalize & Determine Next Steps
- Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
- Provide the finalized "Sprint Change Proposal" document to the user.
- **Based on the nature of the approved changes:**
- **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
- **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
## Output Deliverables
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
- 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.
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -369,7 +376,7 @@ template:
output:
format: markdown
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
title: 'Story {{epic_num}}.{{story_num}}: {{story_title_short}}'
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
workflow:
mode: interactive
@@ -471,7 +478,7 @@ sections:
sections:
- id: agent-model
title: Agent Model Used
template: '{{agent_model_name_version}}'
template: "{{agent_model_name_version}}"
instruction: Record the specific AI agent model and version used for development
owner: dev-agent
editors: [dev-agent]
@@ -502,6 +509,8 @@ sections:
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.

View File

@@ -77,72 +77,20 @@ commands:
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
dependencies:
tasks:
- generate-ai-frontend-prompt.md
- create-doc.md
- execute-checklist.md
templates:
- front-end-spec-tmpl.yaml
data:
- technical-preferences.md
tasks:
- create-doc.md
- execute-checklist.md
- generate-ai-frontend-prompt.md
templates:
- front-end-spec-tmpl.yaml
```
==================== END: .bmad-core/agents/ux-expert.md ====================
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
# Create AI Frontend Prompt Task
## Purpose
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
## Inputs
- Completed UI/UX Specification (`front-end-spec.md`)
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
## Key Activities & Instructions
### 1. Core Prompting Principles
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
### 2. The Structured Prompting Framework
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
### 3. Assembling the Master Prompt
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
1. **Gather Foundational Context**:
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
2. **Describe the Visuals**:
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
3. **Build the Prompt using the Structured Framework**:
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
4. **Present and Refine**:
- 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.
- <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: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -247,6 +195,8 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -335,7 +285,64 @@ The LLM will:
- Offer to provide detailed analysis of any section, especially those with warnings or failures
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create AI Frontend Prompt Task
## Purpose
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
## Inputs
- Completed UI/UX Specification (`front-end-spec.md`)
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
## Key Activities & Instructions
### 1. Core Prompting Principles
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
### 2. The Structured Prompting Framework
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
### 3. Assembling the Master Prompt
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
1. **Gather Foundational Context**:
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
2. **Describe the Visuals**:
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
3. **Build the Prompt using the Structured Framework**:
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
4. **Present and Refine**:
- 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.
- <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: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
==================== START: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-spec-template-v2
name: UI/UX Specification
@@ -343,7 +350,7 @@ template:
output:
format: markdown
filename: docs/front-end-spec.md
title: '{{project_name}} UI/UX Specification'
title: "{{project_name}} UI/UX Specification"
workflow:
mode: interactive
@@ -371,29 +378,29 @@ sections:
sections:
- id: user-personas
title: Target User Personas
template: '{{persona_descriptions}}'
template: "{{persona_descriptions}}"
examples:
- '**Power User:** Technical professionals who need advanced features and efficiency'
- '**Casual User:** Occasional users who prioritize ease of use and clear guidance'
- '**Administrator:** System managers who need control and oversight capabilities'
- "**Power User:** Technical professionals who need advanced features and efficiency"
- "**Casual User:** Occasional users who prioritize ease of use and clear guidance"
- "**Administrator:** System managers who need control and oversight capabilities"
- id: usability-goals
title: Usability Goals
template: '{{usability_goals}}'
template: "{{usability_goals}}"
examples:
- 'Ease of learning: New users can complete core tasks within 5 minutes'
- 'Efficiency of use: Power users can complete frequent tasks with minimal clicks'
- 'Error prevention: Clear validation and confirmation for destructive actions'
- 'Memorability: Infrequent users can return without relearning'
- "Ease of learning: New users can complete core tasks within 5 minutes"
- "Efficiency of use: Power users can complete frequent tasks with minimal clicks"
- "Error prevention: Clear validation and confirmation for destructive actions"
- "Memorability: Infrequent users can return without relearning"
- id: design-principles
title: Design Principles
template: '{{design_principles}}'
template: "{{design_principles}}"
type: numbered-list
examples:
- '**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation'
- "**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation"
- "**Progressive disclosure** - Show only what's needed, when it's needed"
- '**Consistent patterns** - Use familiar UI patterns throughout the application'
- '**Immediate feedback** - Every action should have a clear, immediate response'
- '**Accessible by default** - Design for all users from the start'
- "**Consistent patterns** - Use familiar UI patterns throughout the application"
- "**Immediate feedback** - Every action should have a clear, immediate response"
- "**Accessible by default** - Design for all users from the start"
- id: changelog
title: Change Log
type: table
@@ -415,7 +422,7 @@ sections:
title: Site Map / Screen Inventory
type: mermaid
mermaid_type: graph
template: '{{sitemap_diagram}}'
template: "{{sitemap_diagram}}"
examples:
- |
graph TD
@@ -455,7 +462,7 @@ sections:
repeatable: true
sections:
- id: flow
title: '{{flow_name}}'
title: "{{flow_name}}"
template: |
**User Goal:** {{flow_goal}}
@@ -467,13 +474,13 @@ sections:
title: Flow Diagram
type: mermaid
mermaid_type: graph
template: '{{flow_diagram}}'
template: "{{flow_diagram}}"
- id: edge-cases
title: 'Edge Cases & Error Handling:'
title: "Edge Cases & Error Handling:"
type: bullet-list
template: '- {{edge_case}}'
template: "- {{edge_case}}"
- id: notes
template: '**Notes:** {{flow_notes}}'
template: "**Notes:** {{flow_notes}}"
- id: wireframes-mockups
title: Wireframes & Mockups
@@ -482,13 +489,13 @@ sections:
elicit: true
sections:
- id: design-files
template: '**Primary Design Files:** {{design_tool_link}}'
template: "**Primary Design Files:** {{design_tool_link}}"
- id: key-screen-layouts
title: Key Screen Layouts
repeatable: true
sections:
- id: screen
title: '{{screen_name}}'
title: "{{screen_name}}"
template: |
**Purpose:** {{screen_purpose}}
@@ -508,13 +515,13 @@ sections:
elicit: true
sections:
- id: design-system-approach
template: '**Design System Approach:** {{design_system_approach}}'
template: "**Design System Approach:** {{design_system_approach}}"
- id: core-components
title: Core Components
repeatable: true
sections:
- id: component
title: '{{component_name}}'
title: "{{component_name}}"
template: |
**Purpose:** {{component_purpose}}
@@ -531,19 +538,19 @@ sections:
sections:
- id: visual-identity
title: Visual Identity
template: '**Brand Guidelines:** {{brand_guidelines_link}}'
template: "**Brand Guidelines:** {{brand_guidelines_link}}"
- id: color-palette
title: Color Palette
type: table
columns: ['Color Type', 'Hex Code', 'Usage']
columns: ["Color Type", "Hex Code", "Usage"]
rows:
- ['Primary', '{{primary_color}}', '{{primary_usage}}']
- ['Secondary', '{{secondary_color}}', '{{secondary_usage}}']
- ['Accent', '{{accent_color}}', '{{accent_usage}}']
- ['Success', '{{success_color}}', 'Positive feedback, confirmations']
- ['Warning', '{{warning_color}}', 'Cautions, important notices']
- ['Error', '{{error_color}}', 'Errors, destructive actions']
- ['Neutral', '{{neutral_colors}}', 'Text, borders, backgrounds']
- ["Primary", "{{primary_color}}", "{{primary_usage}}"]
- ["Secondary", "{{secondary_color}}", "{{secondary_usage}}"]
- ["Accent", "{{accent_color}}", "{{accent_usage}}"]
- ["Success", "{{success_color}}", "Positive feedback, confirmations"]
- ["Warning", "{{warning_color}}", "Cautions, important notices"]
- ["Error", "{{error_color}}", "Errors, destructive actions"]
- ["Neutral", "{{neutral_colors}}", "Text, borders, backgrounds"]
- id: typography
title: Typography
sections:
@@ -556,13 +563,13 @@ sections:
- id: type-scale
title: Type Scale
type: table
columns: ['Element', 'Size', 'Weight', 'Line Height']
columns: ["Element", "Size", "Weight", "Line Height"]
rows:
- ['H1', '{{h1_size}}', '{{h1_weight}}', '{{h1_line}}']
- ['H2', '{{h2_size}}', '{{h2_weight}}', '{{h2_line}}']
- ['H3', '{{h3_size}}', '{{h3_weight}}', '{{h3_line}}']
- ['Body', '{{body_size}}', '{{body_weight}}', '{{body_line}}']
- ['Small', '{{small_size}}', '{{small_weight}}', '{{small_line}}']
- ["H1", "{{h1_size}}", "{{h1_weight}}", "{{h1_line}}"]
- ["H2", "{{h2_size}}", "{{h2_weight}}", "{{h2_line}}"]
- ["H3", "{{h3_size}}", "{{h3_weight}}", "{{h3_line}}"]
- ["Body", "{{body_size}}", "{{body_weight}}", "{{body_line}}"]
- ["Small", "{{small_size}}", "{{small_weight}}", "{{small_line}}"]
- id: iconography
title: Iconography
template: |
@@ -583,7 +590,7 @@ sections:
sections:
- id: compliance-target
title: Compliance Target
template: '**Standard:** {{compliance_standard}}'
template: "**Standard:** {{compliance_standard}}"
- id: key-requirements
title: Key Requirements
template: |
@@ -603,7 +610,7 @@ sections:
- Form labels: {{form_requirements}}
- id: testing-strategy
title: Testing Strategy
template: '{{accessibility_testing}}'
template: "{{accessibility_testing}}"
- id: responsiveness
title: Responsiveness Strategy
@@ -613,12 +620,12 @@ sections:
- id: breakpoints
title: Breakpoints
type: table
columns: ['Breakpoint', 'Min Width', 'Max Width', 'Target Devices']
columns: ["Breakpoint", "Min Width", "Max Width", "Target Devices"]
rows:
- ['Mobile', '{{mobile_min}}', '{{mobile_max}}', '{{mobile_devices}}']
- ['Tablet', '{{tablet_min}}', '{{tablet_max}}', '{{tablet_devices}}']
- ['Desktop', '{{desktop_min}}', '{{desktop_max}}', '{{desktop_devices}}']
- ['Wide', '{{wide_min}}', '-', '{{wide_devices}}']
- ["Mobile", "{{mobile_min}}", "{{mobile_max}}", "{{mobile_devices}}"]
- ["Tablet", "{{tablet_min}}", "{{tablet_max}}", "{{tablet_devices}}"]
- ["Desktop", "{{desktop_min}}", "{{desktop_max}}", "{{desktop_devices}}"]
- ["Wide", "{{wide_min}}", "-", "{{wide_devices}}"]
- id: adaptation-patterns
title: Adaptation Patterns
template: |
@@ -637,11 +644,11 @@ sections:
sections:
- id: motion-principles
title: Motion Principles
template: '{{motion_principles}}'
template: "{{motion_principles}}"
- id: key-animations
title: Key Animations
repeatable: true
template: '- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})'
template: "- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})"
- id: performance
title: Performance Considerations
@@ -655,7 +662,7 @@ sections:
- **Animation FPS:** {{animation_goal}}
- id: design-strategies
title: Design Strategies
template: '{{performance_strategies}}'
template: "{{performance_strategies}}"
- id: next-steps
title: Next Steps
@@ -670,17 +677,17 @@ sections:
- id: immediate-actions
title: Immediate Actions
type: numbered-list
template: '{{action}}'
template: "{{action}}"
- id: design-handoff-checklist
title: Design Handoff Checklist
type: checklist
items:
- 'All user flows documented'
- 'Component inventory complete'
- 'Accessibility requirements defined'
- 'Responsive strategy clear'
- 'Brand guidelines incorporated'
- 'Performance goals established'
- "All user flows documented"
- "Component inventory complete"
- "Accessibility requirements defined"
- "Responsive strategy clear"
- "Brand guidelines incorporated"
- "Performance goals established"
- id: checklist-results
title: Checklist Results
@@ -688,6 +695,8 @@ sections:
==================== END: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -95,6 +95,8 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-designer.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -199,6 +201,8 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -288,6 +292,8 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -581,6 +587,8 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -862,6 +870,8 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -975,14 +985,15 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v2
name: Game Design Document (GDD)
version: 2.0
output:
format: markdown
filename: 'docs/{{game_name}}-game-design-document.md'
title: '{{game_title}} Game Design Document (GDD)'
filename: "docs/{{game_name}}-game-design-document.md"
title: "{{game_title}} Game Design Document (GDD)"
workflow:
mode: interactive
@@ -1019,7 +1030,7 @@ sections:
title: Unique Selling Points
instruction: List 3-5 key features that differentiate this game from competitors
type: numbered-list
template: '{{usp}}'
template: "{{usp}}"
- id: core-gameplay
title: Core Gameplay
@@ -1064,7 +1075,7 @@ sections:
repeatable: true
sections:
- id: mechanic
title: '{{mechanic_name}}'
title: "{{mechanic_name}}"
template: |
**Description:** {{detailed_description}}
@@ -1129,7 +1140,7 @@ sections:
repeatable: true
sections:
- id: level-type
title: '{{level_type_name}}'
title: "{{level_type_name}}"
template: |
**Purpose:** {{gameplay_purpose}}
**Duration:** {{target_time}}
@@ -1230,10 +1241,10 @@ sections:
instruction: Break down the development into phases that can be converted to epics
sections:
- id: phase-1-core-systems
title: 'Phase 1: Core Systems ({{duration}})'
title: "Phase 1: Core Systems ({{duration}})"
sections:
- id: foundation-epic
title: 'Epic: Foundation'
title: "Epic: Foundation"
type: bullet-list
template: |
- Engine setup and configuration
@@ -1241,41 +1252,41 @@ sections:
- Core input handling
- Asset loading pipeline
- id: core-mechanics-epic
title: 'Epic: Core Mechanics'
title: "Epic: Core Mechanics"
type: bullet-list
template: |
- {{primary_mechanic}} implementation
- Basic physics and collision
- Player controller
- id: phase-2-gameplay-features
title: 'Phase 2: Gameplay Features ({{duration}})'
title: "Phase 2: Gameplay Features ({{duration}})"
sections:
- id: game-systems-epic
title: 'Epic: Game Systems'
title: "Epic: Game Systems"
type: bullet-list
template: |
- {{mechanic_2}} implementation
- {{mechanic_3}} implementation
- Game state management
- id: content-creation-epic
title: 'Epic: Content Creation'
title: "Epic: Content Creation"
type: bullet-list
template: |
- Level loading system
- First playable levels
- Basic UI implementation
- id: phase-3-polish-optimization
title: 'Phase 3: Polish & Optimization ({{duration}})'
title: "Phase 3: Polish & Optimization ({{duration}})"
sections:
- id: performance-epic
title: 'Epic: Performance'
title: "Epic: Performance"
type: bullet-list
template: |
- Optimization and profiling
- Mobile platform testing
- Memory management
- id: user-experience-epic
title: 'Epic: User Experience'
title: "Epic: User Experience"
type: bullet-list
template: |
- Audio implementation
@@ -1317,18 +1328,19 @@ sections:
title: References
instruction: List any competitive analysis, inspiration, or research sources
type: bullet-list
template: '{{reference}}'
template: "{{reference}}"
==================== END: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
version: 2.0
output:
format: markdown
filename: 'docs/{{game_name}}-level-design-document.md'
title: '{{game_title}} Level Design Document'
filename: "docs/{{game_name}}-level-design-document.md"
title: "{{game_title}} Level Design Document"
workflow:
mode: interactive
@@ -1389,7 +1401,7 @@ sections:
repeatable: true
sections:
- id: level-category
title: '{{category_name}} Levels'
title: "{{category_name}} Levels"
template: |
**Purpose:** {{gameplay_purpose}}
@@ -1694,19 +1706,19 @@ sections:
title: Playtesting Checklist
type: checklist
items:
- 'Level completes within target time range'
- 'All mechanics function correctly'
- 'Difficulty feels appropriate for level category'
- 'Player guidance is clear and effective'
- 'No exploits or sequence breaks (unless intended)'
- "Level completes within target time range"
- "All mechanics function correctly"
- "Difficulty feels appropriate for level category"
- "Player guidance is clear and effective"
- "No exploits or sequence breaks (unless intended)"
- id: player-experience-testing
title: Player Experience Testing
type: checklist
items:
- 'Tutorial levels teach effectively'
- 'Challenge feels fair and rewarding'
- 'Flow and pacing maintain engagement'
- 'Audio and visual feedback support gameplay'
- "Tutorial levels teach effectively"
- "Challenge feels fair and rewarding"
- "Flow and pacing maintain engagement"
- "Audio and visual feedback support gameplay"
- id: balance-validation
title: Balance Validation
template: |
@@ -1808,14 +1820,15 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v2
name: Game Brief
version: 2.0
output:
format: markdown
filename: 'docs/{{game_name}}-game-brief.md'
title: '{{game_title}} Game Brief'
filename: "docs/{{game_name}}-game-brief.md"
title: "{{game_title}} Game Brief"
workflow:
mode: interactive
@@ -2101,21 +2114,21 @@ sections:
title: Development Roadmap
sections:
- id: phase-1-preproduction
title: 'Phase 1: Pre-Production ({{duration}})'
title: "Phase 1: Pre-Production ({{duration}})"
type: bullet-list
template: |
- Detailed Game Design Document creation
- Technical architecture planning
- Art style exploration and pipeline setup
- id: phase-2-prototype
title: 'Phase 2: Prototype ({{duration}})'
title: "Phase 2: Prototype ({{duration}})"
type: bullet-list
template: |
- Core mechanic implementation
- Technical proof of concept
- Initial playtesting and iteration
- id: phase-3-production
title: 'Phase 3: Production ({{duration}})'
title: "Phase 3: Production ({{duration}})"
type: bullet-list
template: |
- Full feature development
@@ -2167,6 +2180,8 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness

View File

@@ -102,6 +102,8 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-developer.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -191,14 +193,15 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v2
name: Game Architecture Document
version: 2.0
output:
format: markdown
filename: 'docs/{{game_name}}-game-architecture.md'
title: '{{game_title}} Game Architecture Document'
filename: "docs/{{game_name}}-game-architecture.md"
title: "{{game_title}} Game Architecture Document"
workflow:
mode: interactive
@@ -422,7 +425,7 @@ sections:
repeatable: true
sections:
- id: mechanic-system
title: '{{mechanic_name}} System'
title: "{{mechanic_name}} System"
template: |
**Purpose:** {{system_purpose}}
@@ -719,7 +722,7 @@ sections:
instruction: Break down the architecture implementation into phases that align with the GDD development phases
sections:
- id: phase-1-foundation
title: 'Phase 1: Foundation ({{duration}})'
title: "Phase 1: Foundation ({{duration}})"
sections:
- id: phase-1-core
title: Core Systems
@@ -737,7 +740,7 @@ sections:
- "Basic Scene Management System"
- "Asset Loading Foundation"
- id: phase-2-game-systems
title: 'Phase 2: Game Systems ({{duration}})'
title: "Phase 2: Game Systems ({{duration}})"
sections:
- id: phase-2-gameplay
title: Gameplay Systems
@@ -755,7 +758,7 @@ sections:
- "Physics and Collision Framework"
- "Game State Management System"
- id: phase-3-content-polish
title: 'Phase 3: Content & Polish ({{duration}})'
title: "Phase 3: Content & Polish ({{duration}})"
sections:
- id: phase-3-content
title: Content Systems
@@ -807,6 +810,8 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness
@@ -970,6 +975,8 @@ _Any specific concerns, recommendations, or clarifications needed before develop
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines
## Overview

View File

@@ -88,6 +88,8 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Development Story Task
## Purpose
@@ -307,6 +309,8 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -396,14 +400,15 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v2
name: Game Development Story
version: 2.0
output:
format: markdown
filename: 'stories/{{epic_name}}/{{story_id}}-{{story_name}}.md'
title: 'Story: {{story_title}}'
filename: "stories/{{epic_name}}/{{story_id}}-{{story_name}}.md"
title: "Story: {{story_title}}"
workflow:
mode: interactive
@@ -432,7 +437,7 @@ sections:
- id: description
title: Description
instruction: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature.
template: '{{clear_description_of_what_needs_to_be_implemented}}'
template: "{{clear_description_of_what_needs_to_be_implemented}}"
- id: acceptance-criteria
title: Acceptance Criteria
@@ -442,22 +447,22 @@ sections:
title: Functional Requirements
type: checklist
items:
- '{{specific_functional_requirement}}'
- "{{specific_functional_requirement}}"
- id: technical-requirements
title: Technical Requirements
type: checklist
items:
- 'Code follows TypeScript strict mode standards'
- 'Maintains 60 FPS on target devices'
- 'No memory leaks or performance degradation'
- '{{specific_technical_requirement}}'
- "Code follows TypeScript strict mode standards"
- "Maintains 60 FPS on target devices"
- "No memory leaks or performance degradation"
- "{{specific_technical_requirement}}"
- id: game-design-requirements
title: Game Design Requirements
type: checklist
items:
- '{{gameplay_requirement_from_gdd}}'
- '{{balance_requirement_if_applicable}}'
- '{{player_experience_requirement}}'
- "{{gameplay_requirement_from_gdd}}"
- "{{balance_requirement_if_applicable}}"
- "{{player_experience_requirement}}"
- id: technical-specifications
title: Technical Specifications
@@ -622,14 +627,14 @@ sections:
instruction: Checklist that must be completed before the story is considered finished
type: checklist
items:
- 'All acceptance criteria met'
- 'Code reviewed and approved'
- 'Unit tests written and passing'
- 'Integration tests passing'
- 'Performance targets met'
- 'No linting errors'
- 'Documentation updated'
- '{{game_specific_dod_item}}'
- "All acceptance criteria met"
- "Code reviewed and approved"
- "Unit tests written and passing"
- "Integration tests passing"
- "Performance targets met"
- "No linting errors"
- "Documentation updated"
- "{{game_specific_dod_item}}"
- id: notes
title: Notes
@@ -652,6 +657,8 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness

View File

@@ -103,6 +103,8 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-architect.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -207,6 +209,8 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -488,6 +492,8 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -676,6 +682,8 @@ Document sharded successfully:
==================== END: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -1022,6 +1030,8 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-2d-unity-game-dev/tasks/document-project.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -1111,6 +1121,8 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -1224,6 +1236,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v3
name: Game Architecture Document
@@ -1231,7 +1244,7 @@ template:
output:
format: markdown
filename: docs/game-architecture.md
title: '{{project_name}} Game Architecture Document'
title: "{{project_name}} Game Architecture Document"
workflow:
mode: interactive
@@ -1341,11 +1354,11 @@ sections:
- Game management patterns (Singleton managers, Event systems, State machines)
- Data patterns (ScriptableObject configuration, Save/Load systems)
- Unity-specific patterns (Object pooling, Coroutines, Unity Events)
template: '- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}'
template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
examples:
- "**Component-Based Architecture:** Using MonoBehaviour components for game logic - _Rationale:_ Aligns with Unity's design philosophy and enables reusable, testable game systems"
- '**ScriptableObject Data:** Using ScriptableObjects for game configuration - _Rationale:_ Enables data-driven design and easy balancing without code changes'
- '**Event-Driven Communication:** Using Unity Events and C# events for system decoupling - _Rationale:_ Supports modular architecture and easier testing'
- "**ScriptableObject Data:** Using ScriptableObjects for game configuration - _Rationale:_ Enables data-driven design and easy balancing without code changes"
- "**Event-Driven Communication:** Using Unity Events and C# events for system decoupling - _Rationale:_ Supports modular architecture and easier testing"
- id: tech-stack
title: Tech Stack
@@ -1384,13 +1397,13 @@ sections:
columns: [Category, Technology, Version, Purpose, Rationale]
instruction: Populate the technology stack table with all relevant Unity technologies
examples:
- '| **Game Engine** | Unity | 2022.3.21f1 | Core game development platform | Latest LTS version, stable 2D tooling, comprehensive package ecosystem |'
- "| **Game Engine** | Unity | 2022.3.21f1 | Core game development platform | Latest LTS version, stable 2D tooling, comprehensive package ecosystem |"
- "| **Language** | C# | 10.0 | Primary scripting language | Unity's native language, strong typing, excellent tooling |"
- '| **Render Pipeline** | Universal Render Pipeline (URP) | 14.0.10 | 2D/3D rendering | Optimized for mobile, excellent 2D features, future-proof |'
- '| **Input System** | Unity Input System | 1.7.0 | Cross-platform input handling | Modern input system, supports multiple devices, rebindable controls |'
- '| **Physics** | Unity 2D Physics | Built-in | 2D collision and physics | Integrated Box2D, optimized for 2D games |'
- '| **Audio** | Unity Audio | Built-in | Audio playback and mixing | Built-in audio system with mixer support |'
- '| **Testing** | Unity Test Framework | 1.1.33 | Unit and integration testing | Built-in testing framework based on NUnit |'
- "| **Render Pipeline** | Universal Render Pipeline (URP) | 14.0.10 | 2D/3D rendering | Optimized for mobile, excellent 2D features, future-proof |"
- "| **Input System** | Unity Input System | 1.7.0 | Cross-platform input handling | Modern input system, supports multiple devices, rebindable controls |"
- "| **Physics** | Unity 2D Physics | Built-in | 2D collision and physics | Integrated Box2D, optimized for 2D games |"
- "| **Audio** | Unity Audio | Built-in | Audio playback and mixing | Built-in audio system with mixer support |"
- "| **Testing** | Unity Test Framework | 1.1.33 | Unit and integration testing | Built-in testing framework based on NUnit |"
- id: data-models
title: Game Data Models
@@ -1408,7 +1421,7 @@ sections:
repeatable: true
sections:
- id: model
title: '{{model_name}}'
title: "{{model_name}}"
template: |
**Purpose:** {{model_purpose}}
@@ -1443,7 +1456,7 @@ sections:
sections:
- id: system-list
repeatable: true
title: '{{system_name}} System'
title: "{{system_name}} System"
template: |
**Responsibility:** {{system_description}}
@@ -1967,7 +1980,7 @@ sections:
repeatable: true
sections:
- id: integration
title: '{{service_name}} Integration'
title: "{{service_name}} Integration"
template: |
- **Purpose:** {{service_purpose}}
- **Documentation:** {{service_docs_url}}
@@ -2079,12 +2092,12 @@ sections:
- id: environments
title: Build Environments
repeatable: true
template: '- **{{env_name}}:** {{env_purpose}} - {{platform_settings}}'
template: "- **{{env_name}}:** {{env_purpose}} - {{platform_settings}}"
- id: platform-specific-builds
title: Platform-Specific Build Settings
type: code
language: text
template: '{{platform_build_configurations}}'
template: "{{platform_build_configurations}}"
- id: coding-standards
title: Coding Standards
@@ -2113,9 +2126,9 @@ sections:
columns: [Element, Convention, Example]
instruction: Only include if deviating from Unity defaults
examples:
- '| MonoBehaviour | PascalCase + Component suffix | PlayerController, HealthSystem |'
- '| ScriptableObject | PascalCase + Data/Config suffix | PlayerData, GameConfig |'
- '| Prefab | PascalCase descriptive | PlayerCharacter, EnvironmentTile |'
- "| MonoBehaviour | PascalCase + Component suffix | PlayerController, HealthSystem |"
- "| ScriptableObject | PascalCase + Data/Config suffix | PlayerData, GameConfig |"
- "| Prefab | PascalCase descriptive | PlayerCharacter, EnvironmentTile |"
- id: critical-rules
title: Critical Unity Rules
instruction: |
@@ -2127,7 +2140,7 @@ sections:
Avoid obvious rules like "follow SOLID principles" or "optimize performance"
repeatable: true
template: '- **{{rule_name}}:** {{rule_description}}'
template: "- **{{rule_name}}:** {{rule_description}}"
- id: unity-specifics
title: Unity-Specific Guidelines
condition: Critical Unity-specific rules needed
@@ -2136,7 +2149,7 @@ sections:
- id: unity-lifecycle
title: Unity Lifecycle Rules
repeatable: true
template: '- **{{lifecycle_method}}:** {{usage_rule}}'
template: "- **{{lifecycle_method}}:** {{usage_rule}}"
- id: test-strategy
title: Test Strategy and Standards
@@ -2257,6 +2270,8 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-architect-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Game Architect to validate the technical design and architecture before game development execution. The Game Architect should systematically work through each item, ensuring the game architecture is robust, scalable, performant, and aligned with the Game Design Document requirements.
@@ -2651,6 +2666,8 @@ After presenting the report, ask the user if they would like detailed analysis o
==================== END: .bmad-2d-unity-game-dev/checklists/game-architect-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines (Unity & C#)
## Overview
@@ -3240,6 +3257,8 @@ These guidelines ensure consistent, high-quality game development that meets per
==================== END: .bmad-2d-unity-game-dev/data/development-guidelines.md ====================
==================== START: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# BMad Knowledge Base - 2D Unity Game Development
## Overview

View File

@@ -100,6 +100,8 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-designer.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -204,6 +206,8 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -293,6 +297,8 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -481,6 +487,8 @@ Document sharded successfully:
==================== END: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -774,6 +782,8 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -1055,6 +1065,8 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -1168,6 +1180,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v3
name: Game Design Document (GDD)
@@ -1175,7 +1188,7 @@ template:
output:
format: markdown
filename: docs/game-design-document.md
title: '{{game_title}} Game Design Document (GDD)'
title: "{{game_title}} Game Design Document (GDD)"
workflow:
mode: interactive
@@ -1223,8 +1236,8 @@ sections:
**Primary:** {{age_range}}, {{player_type}}, {{platform_preference}}
**Secondary:** {{secondary_audience}}
examples:
- 'Primary: Ages 8-16, casual mobile gamers, prefer short play sessions'
- 'Secondary: Adult puzzle enthusiasts, educators looking for teaching tools'
- "Primary: Ages 8-16, casual mobile gamers, prefer short play sessions"
- "Secondary: Adult puzzle enthusiasts, educators looking for teaching tools"
- id: platform-technical
title: Platform & Technical Requirements
instruction: Based on the technical preferences or user input, define the target platforms and Unity-specific requirements
@@ -1235,7 +1248,7 @@ sections:
**Screen Support:** {{resolution_range}}
**Build Targets:** {{build_targets}}
examples:
- 'Primary Platform: Mobile (iOS/Android), Engine: Unity 2022.3 LTS & C#, Performance: 60 FPS on iPhone 8/Galaxy S8'
- "Primary Platform: Mobile (iOS/Android), Engine: Unity 2022.3 LTS & C#, Performance: 60 FPS on iPhone 8/Galaxy S8"
- id: unique-selling-points
title: Unique Selling Points
instruction: List 3-5 key features that differentiate this game from competitors
@@ -1286,8 +1299,8 @@ sections:
- {{loss_condition_1}} - Trigger: {{unity_trigger}}
- {{loss_condition_2}} - Trigger: {{unity_trigger}}
examples:
- 'Victory: Player reaches exit portal - Unity Event: OnTriggerEnter2D with Portal tag'
- 'Failure: Health reaches zero - Trigger: Health component value <= 0'
- "Victory: Player reaches exit portal - Unity Event: OnTriggerEnter2D with Portal tag"
- "Failure: Health reaches zero - Trigger: Health component value <= 0"
- id: game-mechanics
title: Game Mechanics
@@ -1299,7 +1312,7 @@ sections:
repeatable: true
sections:
- id: mechanic
title: '{{mechanic_name}}'
title: "{{mechanic_name}}"
template: |
**Description:** {{detailed_description}}
@@ -1321,8 +1334,8 @@ sections:
- {{script_name}}.cs - {{responsibility}}
- {{manager_script}}.cs - {{management_role}}
examples:
- 'Components Needed: Rigidbody2D, BoxCollider2D, PlayerMovement script'
- 'Physics Requirements: 2D Physics material for ground friction, Gravity scale 3'
- "Components Needed: Rigidbody2D, BoxCollider2D, PlayerMovement script"
- "Physics Requirements: 2D Physics material for ground friction, Gravity scale 3"
- id: controls
title: Controls
instruction: Define all input methods for different platforms using Unity's Input System
@@ -1377,7 +1390,7 @@ sections:
**Late Game:** {{duration}} - {{difficulty_description}}
- Unity Config: {{scriptable_object_values}}
examples:
- 'enemy speed: 2.0f, jump height: 4.5f, obstacle density: 0.3f'
- "enemy speed: 2.0f, jump height: 4.5f, obstacle density: 0.3f"
- id: economy-resources
title: Economy & Resources
condition: has_economy
@@ -1400,7 +1413,7 @@ sections:
repeatable: true
sections:
- id: level-type
title: '{{level_type_name}}'
title: "{{level_type_name}}"
template: |
**Purpose:** {{gameplay_purpose}}
**Target Duration:** {{target_time}}
@@ -1424,7 +1437,7 @@ sections:
- {{prefab_name}} - {{prefab_purpose}}
examples:
- 'Environment: TilemapRenderer with Platform tileset, Lighting: 2D Global Light + Point Lights'
- "Environment: TilemapRenderer with Platform tileset, Lighting: 2D Global Light + Point Lights"
- id: level-progression
title: Level Progression
template: |
@@ -1439,7 +1452,7 @@ sections:
- Addressable Assets: {{addressable_groups}}
- Loading Screens: {{loading_implementation}}
examples:
- 'Scene Naming: World{X}_Level{Y}_Name, Addressable Groups: Levels_World1, World_Environments'
- "Scene Naming: World{X}_Level{Y}_Name, Addressable Groups: Levels_World1, World_Environments"
- id: technical-specifications
title: Technical Specifications
@@ -1471,7 +1484,7 @@ sections:
- Physics Settings: {{physics_config}}
examples:
- com.unity.addressables 1.20.5 - Asset loading and memory management
- 'Color Space: Linear, Quality: Mobile/Desktop presets, Gravity: -20'
- "Color Space: Linear, Quality: Mobile/Desktop presets, Gravity: -20"
- id: performance-requirements
title: Performance Requirements
template: |
@@ -1487,7 +1500,7 @@ sections:
- GC Allocs: <{{gc_limit}}KB per frame
- Draw Calls: <{{draw_calls}} per frame
examples:
- '60 FPS (minimum 30), CPU: <16.67ms, GPU: <16.67ms, GC: <4KB, Draws: <50'
- "60 FPS (minimum 30), CPU: <16.67ms, GPU: <16.67ms, GC: <4KB, Draws: <50"
- id: platform-specific
title: Platform Specific Requirements
template: |
@@ -1510,7 +1523,7 @@ sections:
- Browser Support: {{browser_list}}
- Compression: {{compression_format}}
examples:
- 'Resolution: 1280x720 - 4K, Gamepad: Xbox/PlayStation controllers via Input System'
- "Resolution: 1280x720 - 4K, Gamepad: Xbox/PlayStation controllers via Input System"
- id: asset-requirements
title: Asset Requirements
instruction: Define asset specifications for Unity pipeline optimization
@@ -1536,7 +1549,7 @@ sections:
- Font: {{font_requirements}}
- Icon Sizes: {{icon_specifications}}
examples:
- 'Sprites: 32x32 to 256x256 at 16 PPU, Format: RGBA32 for quality/RGBA16 for performance'
- "Sprites: 32x32 to 256x256 at 16 PPU, Format: RGBA32 for quality/RGBA16 for performance"
- id: technical-architecture-requirements
title: Technical Architecture Requirements
@@ -1578,8 +1591,8 @@ sections:
- Prefabs: {{prefab_naming}}
- Scenes: {{scene_naming}}
examples:
- 'Architecture: Component-Based with ScriptableObject data containers'
- 'Scripts: PascalCase (PlayerController), Prefabs: Player_Prefab, Scenes: Level_01_Forest'
- "Architecture: Component-Based with ScriptableObject data containers"
- "Scripts: PascalCase (PlayerController), Prefabs: Player_Prefab, Scenes: Level_01_Forest"
- id: unity-systems-integration
title: Unity Systems Integration
template: |
@@ -1601,8 +1614,8 @@ sections:
- **Memory Management:** {{memory_strategy}}
- **Build Pipeline:** {{build_automation}}
examples:
- 'Input System: Action Maps for Menu/Gameplay contexts with device switching'
- 'DOTween: Smooth UI transitions and gameplay animations'
- "Input System: Action Maps for Menu/Gameplay contexts with device switching"
- "DOTween: Smooth UI transitions and gameplay animations"
- id: data-management
title: Data Management
template: |
@@ -1625,8 +1638,8 @@ sections:
- **Memory Pools:** {{pooling_objects}}
- **Asset References:** {{asset_reference_system}}
examples:
- 'Save Data: JSON format with AES encryption, stored in persistent data path'
- 'ScriptableObjects: Game settings, level configurations, character data'
- "Save Data: JSON format with AES encryption, stored in persistent data path"
- "ScriptableObjects: Game settings, level configurations, character data"
- id: development-phases
title: Development Phases & Epic Planning
@@ -1638,15 +1651,15 @@ sections:
instruction: Present a high-level list of all phases for user approval. Each phase's design should deliver significant Unity functionality.
type: numbered-list
examples:
- 'Phase 1: Unity Foundation & Core Systems: Project setup, input handling, basic scene management'
- 'Phase 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop'
- 'Phase 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression'
- 'Phase 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment'
- "Phase 1: Unity Foundation & Core Systems: Project setup, input handling, basic scene management"
- "Phase 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop"
- "Phase 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression"
- "Phase 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment"
- id: phase-1-foundation
title: 'Phase 1: Unity Foundation & Core Systems ({{duration}})'
title: "Phase 1: Unity Foundation & Core Systems ({{duration}})"
sections:
- id: foundation-design
title: 'Design: Unity Project Foundation'
title: "Design: Unity Project Foundation"
type: bullet-list
template: |
- Unity project setup with proper folder structure and naming conventions
@@ -1656,9 +1669,9 @@ sections:
- Development tools setup (debugging, profiling integration)
- Initial build pipeline and platform configuration
examples:
- 'Input System: Configure PlayerInput component with Action Maps for movement and UI'
- "Input System: Configure PlayerInput component with Action Maps for movement and UI"
- id: core-systems-design
title: 'Design: Essential Game Systems'
title: "Design: Essential Game Systems"
type: bullet-list
template: |
- Save/Load system implementation with {{save_format}} format
@@ -1668,10 +1681,10 @@ sections:
- Basic UI framework and canvas configuration
- Settings and configuration management with ScriptableObjects
- id: phase-2-gameplay
title: 'Phase 2: Core Gameplay Implementation ({{duration}})'
title: "Phase 2: Core Gameplay Implementation ({{duration}})"
sections:
- id: gameplay-mechanics-design
title: 'Design: Primary Game Mechanics'
title: "Design: Primary Game Mechanics"
type: bullet-list
template: |
- Player controller with {{movement_type}} movement system
@@ -1681,7 +1694,7 @@ sections:
- Basic collision detection and response systems
- Animation system integration with Animator controllers
- id: level-systems-design
title: 'Design: Level & Content Systems'
title: "Design: Level & Content Systems"
type: bullet-list
template: |
- Scene loading and transition system
@@ -1691,10 +1704,10 @@ sections:
- Collectibles and pickup systems
- Victory/defeat condition implementation
- id: phase-3-polish
title: 'Phase 3: Polish & Optimization ({{duration}})'
title: "Phase 3: Polish & Optimization ({{duration}})"
sections:
- id: performance-design
title: 'Design: Performance & Platform Optimization'
title: "Design: Performance & Platform Optimization"
type: bullet-list
template: |
- Unity Profiler analysis and optimization passes
@@ -1704,7 +1717,7 @@ sections:
- Build size optimization and asset bundling
- Quality settings configuration for different device tiers
- id: user-experience-design
title: 'Design: User Experience & Polish'
title: "Design: User Experience & Polish"
type: bullet-list
template: |
- Complete UI/UX implementation with responsive design
@@ -1729,10 +1742,10 @@ sections:
- 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: Unity Foundation & Core Systems: Project setup, input handling, basic scene management'
- 'Epic 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop'
- 'Epic 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression'
- 'Epic 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment'
- "Epic 1: Unity Foundation & Core Systems: Project setup, input handling, basic scene management"
- "Epic 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop"
- "Epic 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression"
- "Epic 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment"
- id: epic-details
title: Epic {{epic_number}} {{epic_title}}
@@ -1754,13 +1767,13 @@ sections:
- 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}}'
template: "{{epic_goal}}"
sections:
- id: story
title: Story {{epic_number}}.{{story_number}} {{story_title}}
repeatable: true
instruction: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature and reference the gamearchitecture section for additional implementation and integration specifics.
template: '{{clear_description_of_what_needs_to_be_implemented}}'
template: "{{clear_description_of_what_needs_to_be_implemented}}"
sections:
- id: acceptance-criteria
title: Acceptance Criteria
@@ -1770,7 +1783,7 @@ sections:
title: Functional Requirements
type: checklist
items:
- '{{specific_functional_requirement}}'
- "{{specific_functional_requirement}}"
- id: technical-requirements
title: Technical Requirements
type: checklist
@@ -1778,14 +1791,14 @@ sections:
- Code follows C# best practices
- Maintains stable frame rate on target devices
- No memory leaks or performance degradation
- '{{specific_technical_requirement}}'
- "{{specific_technical_requirement}}"
- id: game-design-requirements
title: Game Design Requirements
type: checklist
items:
- '{{gameplay_requirement_from_gdd}}'
- '{{balance_requirement_if_applicable}}'
- '{{player_experience_requirement}}'
- "{{gameplay_requirement_from_gdd}}"
- "{{balance_requirement_if_applicable}}"
- "{{player_experience_requirement}}"
- id: success-metrics
title: Success Metrics & Quality Assurance
@@ -1803,8 +1816,8 @@ sections:
- **Build Size:** Final build <{{size_limit}}MB for mobile, <{{desktop_limit}}MB for desktop
- **Battery Life:** Mobile gameplay sessions >{{battery_target}} hours on average device
examples:
- 'Frame Rate: Consistent 60 FPS with <5% drops below 45 FPS on target hardware'
- 'Crash Rate: <0.5% across iOS/Android, <0.1% on desktop platforms'
- "Frame Rate: Consistent 60 FPS with <5% drops below 45 FPS on target hardware"
- "Crash Rate: <0.5% across iOS/Android, <0.1% on desktop platforms"
- id: gameplay-metrics
title: Gameplay & User Engagement Metrics
type: bullet-list
@@ -1816,8 +1829,8 @@ sections:
- **Gameplay Completion:** {{completion_rate}}% complete main game content
- **Control Responsiveness:** Input lag <{{input_lag}}ms on all platforms
examples:
- 'Tutorial Completion: 85% of players complete movement and basic mechanics tutorial'
- 'Session Duration: Average 15-20 minutes per session for mobile, 30-45 minutes for desktop'
- "Tutorial Completion: 85% of players complete movement and basic mechanics tutorial"
- "Session Duration: Average 15-20 minutes per session for mobile, 30-45 minutes for desktop"
- id: platform-specific-metrics
title: Platform-Specific Quality Metrics
type: table
@@ -1862,20 +1875,21 @@ sections:
- Consider cross-platform testing requirements
- Account for Unity build and deployment steps
examples:
- 'Foundation stories: Individual Unity systems (Input, Audio, Scene Management) - 1-2 days each'
- 'Feature stories: Complete gameplay mechanics with UI and feedback - 2-4 days each'
- "Foundation stories: Individual Unity systems (Input, Audio, Scene Management) - 1-2 days each"
- "Feature stories: Complete gameplay mechanics with UI and feedback - 2-4 days each"
- id: recommended-agents
title: Recommended BMad Agent Sequence
type: numbered-list
template: |
1. **{{agent_name}}**: {{agent_responsibility}}
examples:
- 'Unity Architect: Create detailed technical architecture document with specific Unity implementation patterns'
- 'Unity Developer: Implement core systems and gameplay mechanics according to architecture'
- 'QA Tester: Validate performance metrics and cross-platform functionality'
- "Unity Architect: Create detailed technical architecture document with specific Unity implementation patterns"
- "Unity Developer: Implement core systems and gameplay mechanics according to architecture"
- "QA Tester: Validate performance metrics and cross-platform functionality"
==================== END: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
@@ -1883,7 +1897,7 @@ template:
output:
format: markdown
filename: docs/level-design-document.md
title: '{{game_title}} Level Design Document'
title: "{{game_title}} Level Design Document"
workflow:
mode: interactive
@@ -1944,7 +1958,7 @@ sections:
repeatable: true
sections:
- id: level-category
title: '{{category_name}} Levels'
title: "{{category_name}} Levels"
template: |
**Purpose:** {{gameplay_purpose}}
@@ -2363,6 +2377,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v3
name: Game Brief
@@ -2370,7 +2385,7 @@ template:
output:
format: markdown
filename: docs/game-brief.md
title: '{{game_title}} Game Brief'
title: "{{game_title}} Game Brief"
workflow:
mode: interactive
@@ -2656,21 +2671,21 @@ sections:
title: Development Roadmap
sections:
- id: phase-1-preproduction
title: 'Phase 1: Pre-Production ({{duration}})'
title: "Phase 1: Pre-Production ({{duration}})"
type: bullet-list
template: |
- Detailed Game Design Document creation
- Technical architecture planning
- Art style exploration and pipeline setup
- id: phase-2-prototype
title: 'Phase 2: Prototype ({{duration}})'
title: "Phase 2: Prototype ({{duration}})"
type: bullet-list
template: |
- Core mechanic implementation
- Technical proof of concept
- Initial playtesting and iteration
- id: phase-3-production
title: 'Phase 3: Production ({{duration}})'
title: "Phase 3: Production ({{duration}})"
type: bullet-list
template: |
- Full feature development
@@ -2722,6 +2737,8 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness
@@ -2926,6 +2943,8 @@ _Outline immediate next actions for the team based on this assessment._
==================== END: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# BMad Knowledge Base - 2D Unity Game Development
## Overview

View File

@@ -97,6 +97,8 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-developer.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -186,6 +188,8 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -323,6 +327,8 @@ Provide a structured validation report including:
==================== END: .bmad-2d-unity-game-dev/tasks/validate-next-story.md ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

View File

@@ -88,6 +88,8 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-sm.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Story Task
## Purpose
@@ -275,6 +277,8 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-unity-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
@@ -364,6 +368,8 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/correct-course-game.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task - Game Development
## Purpose
@@ -508,14 +514,15 @@ Based on the analysis and agreed path forward:
==================== END: .bmad-2d-unity-game-dev/tasks/correct-course-game.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v3
name: Game Development Story
version: 3.0
output:
format: markdown
filename: 'stories/{{epic_name}}/{{story_id}}-{{story_name}}.md'
title: 'Story: {{story_title}}'
filename: "stories/{{epic_name}}/{{story_id}}-{{story_name}}.md"
title: "Story: {{story_title}}"
workflow:
mode: interactive
@@ -544,7 +551,7 @@ sections:
- id: description
title: Description
instruction: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature.
template: '{{clear_description_of_what_needs_to_be_implemented}}'
template: "{{clear_description_of_what_needs_to_be_implemented}}"
- id: acceptance-criteria
title: Acceptance Criteria
@@ -554,7 +561,7 @@ sections:
title: Functional Requirements
type: checklist
items:
- '{{specific_functional_requirement}}'
- "{{specific_functional_requirement}}"
- id: technical-requirements
title: Technical Requirements
type: checklist
@@ -562,14 +569,14 @@ sections:
- Code follows C# best practices
- Maintains stable frame rate on target devices
- No memory leaks or performance degradation
- '{{specific_technical_requirement}}'
- "{{specific_technical_requirement}}"
- id: game-design-requirements
title: Game Design Requirements
type: checklist
items:
- '{{gameplay_requirement_from_gdd}}'
- '{{balance_requirement_if_applicable}}'
- '{{player_experience_requirement}}'
- "{{gameplay_requirement_from_gdd}}"
- "{{balance_requirement_if_applicable}}"
- "{{player_experience_requirement}}"
- id: technical-specifications
title: Technical Specifications
@@ -744,7 +751,7 @@ sections:
- Performance targets met
- No C# compiler errors or warnings
- Documentation updated
- '{{game_specific_dod_item}}'
- "{{game_specific_dod_item}}"
- id: notes
title: Notes
@@ -767,6 +774,8 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Change Navigation Checklist
**Purpose:** To systematically guide the Game SM agent and user through analysis and planning when a significant change (performance issue, platform constraint, technical blocker, gameplay feedback) is identified during Unity game development.

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,921 @@
# 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: .bmad-creative-writing/folder/filename.md ====================`
- `==================== END: .bmad-creative-writing/folder/filename.md ====================`
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., `.bmad-creative-writing/personas/analyst.md`, `.bmad-creative-writing/tasks/create-story.md`)
- 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: .bmad-creative-writing/utils/template-format.md ====================`
- `tasks: create-story` → Look for `==================== START: .bmad-creative-writing/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.
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.
---
==================== START: .bmad-creative-writing/agents/beta-reader.md ====================
# beta-reader
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:
```yaml
activation-instructions:
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- STAY IN CHARACTER!
agent:
name: Beta Reader
id: beta-reader
title: Reader Experience Simulator
icon: 👓
whenToUse: Use for reader perspective, plot hole detection, confusion points, and engagement analysis
customization: null
persona:
role: Advocate for the reader's experience
style: Honest, constructive, reader-focused, intuitive
identity: Simulates target audience reactions and identifies issues
focus: Ensuring story resonates with intended readers
core_principles:
- Reader confusion is author's responsibility
- First impressions matter
- Emotional engagement trumps technical perfection
- Plot holes break immersion
- Promises made must be kept
- Numbered Options Protocol - Always use numbered lists for user selections
commands:
- '*help - Show numbered list of available commands for selection'
- '*first-read - Simulate first-time reader experience'
- '*plot-holes - Identify logical inconsistencies'
- '*confusion-points - Flag unclear sections'
- '*engagement-curve - Map reader engagement'
- '*promise-audit - Check setup/payoff balance'
- '*genre-expectations - Verify genre satisfaction'
- '*emotional-impact - Assess emotional resonance'
- '*yolo - Toggle Yolo Mode'
- '*exit - Say goodbye as the Beta Reader, and then abandon inhabiting this persona'
dependencies:
tasks:
- create-doc.md
- provide-feedback.md
- quick-feedback.md
- analyze-reader-feedback.md
- execute-checklist.md
- advanced-elicitation.md
templates:
- beta-feedback-form.yaml
checklists:
- beta-feedback-closure-checklist.md
data:
- bmad-kb.md
- story-structures.md
```
## Startup Context
You are the Beta Reader, the story's first audience. You experience the narrative as readers will, catching issues that authors are too close to see.
Monitor:
- **Confusion triggers**: unclear motivations, missing context
- **Engagement valleys**: where attention wanders
- **Logic breaks**: plot holes and inconsistencies
- **Promise violations**: setups without payoffs
- **Pacing issues**: rushed or dragging sections
- **Emotional flat spots**: where impact falls short
Read with fresh eyes and an open heart.
Remember to present all options as numbered lists for easy selection.
==================== END: .bmad-creative-writing/agents/beta-reader.md ====================
==================== START: .bmad-creative-writing/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
**THIS IS AN EXECUTABLE WORKFLOW - NOT REFERENCE MATERIAL**
When this task is invoked:
1. **DISABLE ALL EFFICIENCY OPTIMIZATIONS** - This workflow requires full user interaction
2. **MANDATORY STEP-BY-STEP EXECUTION** - Each section must be processed sequentially with user feedback
3. **ELICITATION IS REQUIRED** - When `elicit: true`, you MUST use the 1-9 format and wait for user response
4. **NO SHORTCUTS ALLOWED** - Complete documents cannot be created without following this workflow
**VIOLATION INDICATOR:** If you create a complete document without user interaction, you have violated this workflow.
## Critical: Template Discovery
If a YAML Template has not been provided, list all templates from .bmad-creative-writing/templates or ask the user to provide another.
## CRITICAL: Mandatory Elicitation Format
**When `elicit: true`, this is a HARD STOP requiring user interaction:**
**YOU MUST:**
1. Present section content
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
3. **STOP and 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:"
4. **WAIT FOR USER RESPONSE** - Do not proceed until user selects option or provides feedback
**WORKFLOW VIOLATION:** Creating content for elicit=true sections without user interaction violates this task.
**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
- Check agent permissions (owner/editors) - note if section is restricted to specific agents
- 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**
## Agent Permissions
When processing sections with agent permission fields:
- **owner**: Note which agent role initially creates/populates the section
- **editors**: List agent roles allowed to modify the section
- **readonly**: Mark sections that cannot be modified after creation
**For sections with restricted access:**
- Include a note in the generated document indicating the responsible agent
- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
## 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:"
==================== END: .bmad-creative-writing/tasks/create-doc.md ====================
==================== START: .bmad-creative-writing/tasks/provide-feedback.md ====================
<!-- Powered by BMAD™ Core -->
# ------------------------------------------------------------
# 5. Provide Feedback (Beta)
# ------------------------------------------------------------
---
task:
id: provide-feedback
name: Provide Feedback (Beta)
description: Simulate betareader feedback using beta-feedback-form-tmpl.
persona_default: beta-reader
inputs:
- draft-manuscript.md | chapter-draft.md
steps:
- Read provided text.
- Fill feedback form objectively.
- Save as beta-notes.md or chapter-notes.md.
output: beta-notes.md
...
==================== END: .bmad-creative-writing/tasks/provide-feedback.md ====================
==================== START: .bmad-creative-writing/tasks/quick-feedback.md ====================
<!-- Powered by BMAD™ Core -->
# ------------------------------------------------------------
# 13. Quick Feedback (Serial)
# ------------------------------------------------------------
---
task:
id: quick-feedback
name: Quick Feedback (Serial)
description: Fast beta feedback focused on pacing and hooks.
persona_default: beta-reader
inputs:
- chapter-dialog.md
steps:
- Use condensed beta-feedback-form.
output: chapter-notes.md
...
==================== END: .bmad-creative-writing/tasks/quick-feedback.md ====================
==================== START: .bmad-creative-writing/tasks/analyze-reader-feedback.md ====================
<!-- Powered by BMAD™ Core -->
# ------------------------------------------------------------
# 16. Analyze Reader Feedback
# ------------------------------------------------------------
---
task:
id: analyze-reader-feedback
name: Analyze Reader Feedback
description: Summarize reader comments, identify trends, update story bible.
persona_default: beta-reader
inputs:
- publication-log.md
steps:
- Cluster comments by theme.
- Suggest course corrections.
output: retro.md
...
==================== END: .bmad-creative-writing/tasks/analyze-reader-feedback.md ====================
==================== START: .bmad-creative-writing/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# 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.
## 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 .bmad-creative-writing/checklists folder to select the appropriate one to run.
## Instructions
1. **Initial Assessment**
- If user or the task being run provides a checklist name:
- Try fuzzy matching (e.g. "plot checklist" -> "plot-structure-checklist")
- If multiple matches found, ask user to clarify
- Load the appropriate checklist from .bmad-creative-writing/checklists/
- If no checklist specified:
- Ask the user which checklist they want to use
- Present the available options from the files in the checklists folder
- Confirm if they want to work through the checklist:
- Section by section (interactive mode - very time consuming)
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
2. **Document and Artifact Gathering**
- Each checklist will specify its required documents/artifacts at the beginning
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
3. **Checklist Processing**
If in interactive mode:
- Work through each section of the checklist one at a time
- For each section:
- Review all items in the section following instructions for that section embedded in the checklist
- Check each item against the relevant documentation or artifacts as appropriate
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
If in YOLO mode:
- Process all sections at once
- Create a comprehensive report of all findings
- Present the complete analysis to the user
4. **Validation Approach**
For each checklist item:
- Read and understand the requirement
- Look for evidence in the documentation that satisfies the requirement
- Consider both explicit mentions and implicit coverage
- Aside from this, follow all checklist llm instructions
- Mark items as:
- ✅ PASS: Requirement clearly met
- ❌ FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- N/A: Not applicable to this case
5. **Section Analysis**
For each section:
- think step by step to calculate pass rate
- Identify common themes in failed items
- Provide specific recommendations for improvement
- In interactive mode, discuss findings with user
- Document any user decisions or explanations
6. **Final Report**
Prepare a summary that includes:
- Overall checklist completion status
- Pass rates by section
- List of failed items with context
- Specific recommendations for improvement
- Any sections or items marked as N/A with justification
## Checklist Execution Methodology
Each checklist now contains embedded LLM prompts and instructions that will:
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
3. **Provide contextual guidance** - Section-specific prompts for better validation
4. **Generate comprehensive reports** - Final summary with detailed findings
The LLM will:
- Execute the complete checklist validation
- 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
==================== END: .bmad-creative-writing/tasks/execute-checklist.md ====================
==================== START: .bmad-creative-writing/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose
- Provide optional reflective and brainstorming actions to enhance content quality
- Enable deeper exploration of ideas through structured elicitation techniques
- 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
### 1. Intelligent Method Selection
**Context Analysis**: Before presenting options, analyze:
- **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
**Method Selection Strategy**:
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
- Individual items within the section (specify which item when selecting an action)
### 3. Present Elicitation Options
**Review Request Process:**
- 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
**Action List Presentation Format:**
```text
**Advanced Elicitation Options**
Choose a number (0-8) or 9 to proceed:
0. [Method Name]
1. [Method Name]
2. [Method Name]
3. [Method Name]
4. [Method Name]
5. [Method Name]
6. [Method Name]
7. [Method Name]
8. [Method Name]
9. Proceed / No Further Actions
```
**Response Handling:**
- **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
### 4. Method Execution Framework
**Execution Process:**
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
2. **Apply Context**: Execute the method from your current role's perspective
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
**Execution Guidelines:**
- **Be Concise**: Focus on actionable insights, not lengthy explanations
- **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-creative-writing/tasks/advanced-elicitation.md ====================
==================== START: .bmad-creative-writing/templates/beta-feedback-form.yaml ====================
# <!-- Powered by BMAD™ Core -->
---
template:
id: beta-feedback-form-tmpl
name: Beta Feedback Form
version: 1.0
description: Structured questionnaire for beta readers
output:
format: markdown
filename: "beta-feedback-{{reader_name}}.md"
workflow:
elicitation: true
allow_skip: true
sections:
- id: reader_info
title: Reader Information
instruction: |
Collect reader details:
- Reader name
- Reading experience level
- Genre preferences
- Date of feedback
elicit: true
- id: overall_impressions
title: Overall Impressions
instruction: |
Gather general reactions:
- What worked well overall
- What confused or bored you
- Most memorable moments
- Overall rating (1-10)
elicit: true
- id: characters
title: Character Feedback
instruction: |
Evaluate character development:
- Favorite character and why
- Least engaging character and why
- Character believability
- Character arc satisfaction
- Dialogue authenticity
elicit: true
- id: plot_pacing
title: Plot & Pacing
instruction: |
Assess story structure:
- High-point scenes
- Slowest sections
- Plot holes or confusion
- Pacing issues
- Predictability concerns
elicit: true
- id: world_setting
title: World & Setting
instruction: |
Review world-building:
- Setting clarity
- World consistency
- Immersion level
- Description balance
elicit: true
- id: emotional_response
title: Emotional Response
instruction: |
Document emotional impact:
- Strong emotions felt
- Scenes that moved you
- Connection to characters
- Satisfaction with ending
elicit: true
- id: technical_issues
title: Technical Issues
instruction: |
Note any technical problems:
- Grammar/spelling errors
- Continuity issues
- Formatting problems
- Confusing passages
elicit: true
- id: suggestions
title: Final Suggestions
instruction: |
Provide improvement recommendations:
- Top three improvements needed
- Would you recommend to others
- Comparison to similar books
- Additional comments
elicit: true
==================== END: .bmad-creative-writing/templates/beta-feedback-form.yaml ====================
==================== START: .bmad-creative-writing/checklists/beta-feedback-closure-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# ------------------------------------------------------------
# 6. BetaFeedback Closure Checklist
# ------------------------------------------------------------
---
checklist:
id: beta-feedback-closure-checklist
name: BetaFeedback Closure Checklist
description: Ensure all beta reader notes are addressed or consciously deferred.
items:
- "[ ] Each beta note categorized (Fix/Ignore/Consider)"
- "[ ] Fixes implemented in manuscript"
- "[ ] Ignore notes documented with rationale"
- "[ ] Consider notes scheduled for future pass"
- "[ ] Beta readers acknowledged in back matter"
- "[ ] Summary of changes logged in retro.md"
...
==================== END: .bmad-creative-writing/checklists/beta-feedback-closure-checklist.md ====================
==================== START: .bmad-creative-writing/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# BMad Creative Writing Knowledge Base
## Overview
BMad Creative Writing Extension adapts the BMad-Method framework for fiction writing, narrative design, and creative storytelling projects. This extension provides specialized agents, workflows, and tools designed specifically for creative writers.
### Key Features
- **Specialized Writing Agents**: Plot architects, character psychologists, world builders, and more
- **Complete Writing Workflows**: From premise to publication-ready manuscript
- **Genre-Specific Support**: Tailored checklists and templates for various genres
- **Publishing Integration**: KDP-ready formatting and cover design support
- **Interactive Development**: Elicitation-driven character and plot development
### When to Use BMad Creative Writing
- **Novel Writing**: Complete novels from concept to final draft
- **Screenplay Development**: Industry-standard screenplay formatting
- **Short Story Creation**: Focused narrative development
- **Series Planning**: Multi-book continuity management
- **Interactive Fiction**: Branching narrative design
- **Publishing Preparation**: KDP and eBook formatting
## How BMad Creative Writing Works
### The Core Method
BMad Creative Writing transforms you into a "Creative Director" - orchestrating specialized AI agents through the creative process:
1. **You Create, AI Supports**: You provide creative vision; agents handle structure and consistency
2. **Specialized Agents**: Each agent masters one aspect (plot, character, dialogue, etc.)
3. **Structured Workflows**: Proven narrative patterns guide your creative process
4. **Iterative Refinement**: Multiple passes ensure quality and coherence
### The Three-Phase Approach
#### Phase 1: Ideation & Planning
- Brainstorm premises and concepts
- Develop character profiles and backstories
- Build worlds and settings
- Create comprehensive story outlines
#### Phase 2: Drafting & Development
- Generate scene-by-scene content
- Workshop dialogue and voice
- Maintain consistency across chapters
- Track character arcs and plot threads
#### Phase 3: Revision & Polish
- Beta reader simulation and feedback
- Line editing and style refinement
- Genre compliance checking
- Publication preparation
## Agent Specializations
### Core Writing Team
- **Plot Architect**: Story structure, pacing, narrative arcs
- **Character Psychologist**: Deep character development, motivation
- **World Builder**: Settings, cultures, consistent universes
- **Editor**: Style, grammar, narrative flow
- **Beta Reader**: Reader perspective simulation
### Specialist Agents
- **Dialog Specialist**: Natural dialogue, voice distinction
- **Narrative Designer**: Interactive storytelling, branching paths
- **Genre Specialist**: Genre conventions, market awareness
- **Book Critic**: Professional literary analysis
- **Cover Designer**: Visual storytelling, KDP compliance
## Writing Workflows
### Novel Development
1. **Premise Development**: Brainstorm and expand initial concept
2. **World Building**: Create setting and environment
3. **Character Creation**: Develop protagonist, antagonist, supporting cast
4. **Story Architecture**: Three-act structure, scene breakdown
5. **Chapter Drafting**: Sequential scene development
6. **Dialog Pass**: Voice refinement and authenticity
7. **Beta Feedback**: Simulated reader responses
8. **Final Polish**: Professional editing pass
### Screenplay Workflow
- Industry-standard formatting
- Visual storytelling emphasis
- Dialogue-driven narrative
- Scene/location optimization
### Series Planning
- Multi-book continuity tracking
- Character evolution across volumes
- World expansion management
- Overarching plot coordination
## Templates & Tools
### Character Development
- Comprehensive character profiles
- Backstory builders
- Voice and dialogue patterns
- Relationship mapping
### Story Structure
- Three-act outlines
- Save the Cat beat sheets
- Hero's Journey mapping
- Scene-by-scene breakdowns
### World Building
- Setting documentation
- Magic/technology systems
- Cultural development
- Timeline tracking
### Publishing Support
- KDP formatting guidelines
- Cover design briefs
- Marketing copy templates
- Beta feedback forms
## Genre Support
### Built-in Genre Checklists
- Fantasy & Sci-Fi
- Romance & Thriller
- Mystery & Horror
- Literary Fiction
- Young Adult
Each genre includes:
- Trope management
- Reader expectations
- Market positioning
- Style guidelines
## Best Practices
### Character Development
1. Start with internal conflict
2. Build from wound/lie/want/need
3. Create unique voice patterns
4. Track arc progression
### Plot Construction
1. Begin with clear story question
2. Escalate stakes progressively
3. Plant setup/payoff pairs
4. Balance pacing with character moments
### World Building
1. Maintain internal consistency
2. Show through character experience
3. Build only what serves story
4. Track all established rules
### Revision Process
1. Complete draft before major edits
2. Address structure before prose
3. Read dialogue aloud
4. Get distance between drafts
## Integration with Core BMad
The Creative Writing extension maintains compatibility with core BMad features:
- Uses standard agent format
- Supports slash commands
- Integrates with workflows
- Shares elicitation methods
- Compatible with YOLO mode
## Quick Start Commands
- `*help` - Show available agent commands
- `*create-outline` - Start story structure
- `*create-profile` - Develop character
- `*analyze-structure` - Review plot mechanics
- `*workshop-dialog` - Refine character voices
- `*yolo` - Toggle fast-drafting mode
## Tips for Success
1. **Trust the Process**: Follow workflows even when inspired
2. **Use Elicitation**: Deep-dive when stuck
3. **Layer Development**: Build story in passes
4. **Track Everything**: Use templates to maintain consistency
5. **Iterate Freely**: First drafts are for discovery
Remember: BMad Creative Writing provides structure to liberate creativity, not constrain it.
==================== END: .bmad-creative-writing/data/bmad-kb.md ====================
==================== START: .bmad-creative-writing/data/story-structures.md ====================
<!-- Powered by BMAD™ Core -->
# Story Structure Patterns
## Three-Act Structure
- **Act 1 (25%)**: Setup, inciting incident
- **Act 2 (50%)**: Confrontation, complications
- **Act 3 (25%)**: Resolution
## Save the Cat Beats
1. Opening Image (0-1%)
2. Setup (1-10%)
3. Theme Stated (5%)
4. Catalyst (10%)
5. Debate (10-20%)
6. Break into Two (20%)
7. B Story (22%)
8. Fun and Games (20-50%)
9. Midpoint (50%)
10. Bad Guys Close In (50-75%)
11. All Is Lost (75%)
12. Dark Night of Soul (75-80%)
13. Break into Three (80%)
14. Finale (80-99%)
15. Final Image (99-100%)
## Hero's Journey
1. Ordinary World
2. Call to Adventure
3. Refusal of Call
4. Meeting Mentor
5. Crossing Threshold
6. Tests, Allies, Enemies
7. Approach to Cave
8. Ordeal
9. Reward
10. Road Back
11. Resurrection
12. Return with Elixir
## Seven-Point Structure
1. Hook
2. Plot Turn 1
3. Pinch Point 1
4. Midpoint
5. Pinch Point 2
6. Plot Turn 2
7. Resolution
## Freytag's Pyramid
1. Exposition
2. Rising Action
3. Climax
4. Falling Action
5. Denouement
## Kishōtenketsu (Japanese)
- **Ki**: Introduction
- **Shō**: Development
- **Ten**: Twist
- **Ketsu**: Conclusion
==================== END: .bmad-creative-writing/data/story-structures.md ====================

View File

@@ -0,0 +1,81 @@
# 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: .bmad-creative-writing/folder/filename.md ====================`
- `==================== END: .bmad-creative-writing/folder/filename.md ====================`
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., `.bmad-creative-writing/personas/analyst.md`, `.bmad-creative-writing/tasks/create-story.md`)
- 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: .bmad-creative-writing/utils/template-format.md ====================`
- `tasks: create-story` → Look for `==================== START: .bmad-creative-writing/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.
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.
---
==================== START: .bmad-creative-writing/agents/book-critic.md ====================
# book-critic
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:
```yaml
agent:
name: Evelyn Clarke
id: book-critic
title: Renowned Literary Critic
icon: 📚
whenToUse: Use to obtain a thorough, professional review of a finished manuscript or chapter, including holistic and categoryspecific ratings with detailed rationale.
customization: null
persona:
role: Widely Respected Professional Book Critic
style: Incisive, articulate, contextaware, culturally attuned, fair but unflinching
identity: Internationally syndicated critic known for balancing scholarly insight with mainstream readability
focus: Evaluating manuscripts against reader expectations, genre standards, market competition, and cultural zeitgeist
core_principles:
- Audience Alignment Judge how well the work meets the needs and tastes of its intended readership
- Genre Awareness Compare against current and classic exemplars in the genre
- Cultural Relevance Consider themes in light of presentday conversations and sensitivities
- Critical Transparency Always justify scores with specific textual evidence
- Constructive Insight Highlight strengths as well as areas for growth
- Holistic & Component Scoring Provide overall rating plus subratings for plot, character, prose, pacing, originality, emotional impact, and thematic depth
startup:
- Greet the user, explain ratings range (e.g., 110 or AF), and list subrating categories.
- Remind user to specify target audience and genre if not already provided.
commands:
- help: Show available commands
- critique {file|text}: Provide full critical review with ratings and rationale (default)
- quick-take {file|text}: Short paragraph verdict with overall rating only
- exit: Say goodbye as the Book Critic and abandon persona
dependencies:
tasks:
- critical-review
checklists:
- genre-tropes-checklist
```
==================== END: .bmad-creative-writing/agents/book-critic.md ====================

Some files were not shown because too many files have changed in this diff Show More