Compare commits
50 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3b6a507ab8 | ||
|
|
415026b0eb | ||
|
|
91c8e12777 | ||
|
|
458704f82b | ||
|
|
37e5fd50dd | ||
|
|
52f6889089 | ||
|
|
f09e282d72 | ||
|
|
2b247ea385 | ||
|
|
925099dd8c | ||
|
|
a19561a16c | ||
|
|
de6c14df07 | ||
|
|
f20d572216 | ||
|
|
076c104b2c | ||
|
|
87d68d31fd | ||
|
|
a05b05cec0 | ||
|
|
af36864625 | ||
|
|
5ae4c51883 | ||
|
|
ac7f2437f8 | ||
|
|
94f67000b2 | ||
|
|
155f9591ea | ||
|
|
6919049eae | ||
|
|
fbd8f1fd73 | ||
|
|
384e17ff2b | ||
|
|
b9bc196e7f | ||
|
|
0a6cbd72cc | ||
|
|
e2e8d44e5d | ||
|
|
fb70c20067 | ||
|
|
05736fa069 | ||
|
|
052e84dd4a | ||
|
|
f054d68c29 | ||
|
|
44836512e7 | ||
|
|
bf97f05190 | ||
|
|
a900d28080 | ||
|
|
ab70baca59 | ||
|
|
80d73d9093 | ||
|
|
f3cc410fb0 | ||
|
|
868ae23455 | ||
|
|
9de873777a | ||
|
|
04c485b72e | ||
|
|
68eb31da77 | ||
|
|
c00d0aec88 | ||
|
|
6543cb2a97 | ||
|
|
b6fe44b16e | ||
|
|
ac09300075 | ||
|
|
b756790c17 | ||
|
|
49347a8cde | ||
|
|
335e1da271 | ||
|
|
6e2fbc6710 | ||
|
|
45dd7d1bc5 | ||
|
|
db80eda9df |
106
.github/FORK_GUIDE.md
vendored
Normal file
106
.github/FORK_GUIDE.md
vendored
Normal 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.
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discord Community Support
|
||||
url: https://discord.gg/gk8jAdXWmj
|
||||
about: Please join our Discord server for general questions and community discussion before opening an issue.
|
||||
1
.github/workflows/discord.yaml
vendored
1
.github/workflows/discord.yaml
vendored
@@ -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
|
||||
|
||||
2
.github/workflows/format-check.yaml
vendored
2
.github/workflows/format-check.yaml
vendored
@@ -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
|
||||
|
||||
3
.github/workflows/manual-release.yaml
vendored
3
.github/workflows/manual-release.yaml
vendored
@@ -20,12 +20,13 @@ 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
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
token: ${{ secrets.GH_PAT }}
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
55
.github/workflows/pr-validation.yaml
vendored
Normal file
55
.github/workflows/pr-validation.yaml
vendored
Normal 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.`
|
||||
})
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -29,13 +29,15 @@ Thumbs.db
|
||||
# IDE and editor configs
|
||||
.windsurf/
|
||||
.trae/
|
||||
.bmad*/.cursor/
|
||||
.bmad*/
|
||||
.cursor/
|
||||
|
||||
# AI assistant files
|
||||
CLAUDE.md
|
||||
.ai/*
|
||||
.claude
|
||||
.gemini
|
||||
.iflow
|
||||
|
||||
# Project-specific
|
||||
.bmad-core
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Contributing to this project
|
||||
|
||||
Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
||||
Thank you for contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
||||
|
||||
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
||||
|
||||
@@ -8,15 +8,53 @@ Thank you for considering contributing to this project! This document outlines t
|
||||
|
||||
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
||||
|
||||
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
|
||||
|
||||
- **#general-dev** - Technical discussions, feature ideas, and development questions
|
||||
- **#bugs-issues** - Bug reports and issue discussions
|
||||
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions or search past discussions or ideas.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
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
|
||||
@@ -150,10 +188,6 @@ Fixes #[issue number] (if applicable)
|
||||
|
||||
[2-3 bullets listing HOW you implemented it]
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## Testing
|
||||
|
||||
[1-2 sentences on how you tested this]
|
||||
@@ -206,4 +240,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.
|
||||
|
||||
7
LICENSE
7
LICENSE
@@ -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.
|
||||
|
||||
40
PR-opencode-agents-generator.md
Normal file
40
PR-opencode-agents-generator.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# feat(opencode): compact AGENTS.md generator and JSON-only integration
|
||||
|
||||
## What
|
||||
|
||||
Add JSON-only OpenCode integration and a compact AGENTS.md generator (no large embeds; clickable file links) with idempotent merges for BMAD instructions, agents, and commands.
|
||||
|
||||
## Why
|
||||
|
||||
Keep OpenCode config schema‑compliant and small, avoid key collisions, and provide a readable agents/tasks index without inflating AGENTS.md.
|
||||
|
||||
## How
|
||||
|
||||
- Ensure `.bmad-core/core-config.yaml` in `instructions`
|
||||
- Merge only selected packages’ agents/commands into opencode.json file
|
||||
- Orchestrators `mode: primary`; all agents enable `write`, `edit`, `bash`
|
||||
- Descriptions from `whenToUse`/task `Purpose` with sanitization + fallbacks
|
||||
- Explicit warnings for non‑BMAD collisions; AGENTS.md uses a strict 3‑column table with links
|
||||
|
||||
## Testing
|
||||
|
||||
- Run: `npx bmad-method install -f -i opencode`
|
||||
- Verify: `opencode.json[c]` updated/created as expected, `AGENTS.md` OpenCode section is compact with links
|
||||
- Pre‑push checks:
|
||||
|
||||
```bash
|
||||
npm run pre-release
|
||||
# or individually
|
||||
npm run validate
|
||||
npm run format:check
|
||||
npm run lint
|
||||
# if anything fails
|
||||
npm run fix
|
||||
# or
|
||||
npm run format
|
||||
npm run lint:fix
|
||||
```
|
||||
|
||||
Fixes #<issue-number>
|
||||
|
||||
Targets: `next` branch
|
||||
149
README.md
149
README.md
@@ -1,4 +1,35 @@
|
||||
# BMad-Method: Universal AI Agent Framework
|
||||
# BMAD-METHOD™: Universal AI Agent Framework
|
||||
|
||||
> ## 🚨 **IMPORTANT VERSION ANNOUNCEMENT** 🚨
|
||||
>
|
||||
> ### Current Stable: v4.x | Next Major: v6 Alpha
|
||||
>
|
||||
> - **v4.x** - The current stable release version available via npm
|
||||
> - **v5** - Skipped (replaced by v6)
|
||||
> - **[v6-alpha](https://github.com/bmad-code-org/BMAD-METHOD/tree/v6-alpha)** - **NOW AVAILABLE FOR EARLY TESTING!**
|
||||
>
|
||||
> ### 🧪 Try v6 Alpha (Early Adopters Only)
|
||||
>
|
||||
> The next major version of BMAD-METHOD is now available for early experimentation and testing. This is a complete rewrite with significant architectural changes.
|
||||
>
|
||||
> **⚠️ WARNING: v6-alpha is for early adopters who are comfortable with:**
|
||||
>
|
||||
> - Potential breaking changes
|
||||
> - Daily updates and instability
|
||||
> - Incomplete features
|
||||
> - Experimental functionality
|
||||
>
|
||||
> **📅 Timeline:** Official beta version will be merged mid-October 2025
|
||||
>
|
||||
> **To try v6-alpha:**
|
||||
>
|
||||
> ```bash
|
||||
> git clone https://github.com/bmad-code-org/BMAD-METHOD.git
|
||||
> cd BMAD-METHOD
|
||||
> git checkout v6-alpha
|
||||
> ```
|
||||
>
|
||||
> ---
|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
@@ -11,11 +42,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 +71,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 +80,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
|
||||
@@ -75,8 +106,6 @@ This makes it easy to benefit from the latest improvements, bug fixes, and new a
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR explicitly use stable tag:
|
||||
npx bmad-method@stable install
|
||||
# OR if you already have BMad installed:
|
||||
git pull
|
||||
npm run install:bmad
|
||||
@@ -110,87 +139,7 @@ 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!
|
||||
|
||||
## 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.
|
||||
|
||||
### Features
|
||||
|
||||
- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
|
||||
- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
|
||||
- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
|
||||
- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
|
||||
- **Flexible Output**: Customizable output file location and naming
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
# Basic usage - creates flattened-codebase.xml in current directory
|
||||
npx bmad-method flatten
|
||||
|
||||
# Specify custom input directory
|
||||
npx bmad-method flatten --input /path/to/source/directory
|
||||
npx bmad-method flatten -i /path/to/source/directory
|
||||
|
||||
# Specify custom output file
|
||||
npx bmad-method flatten --output my-project.xml
|
||||
npx bmad-method flatten -o /path/to/output/codebase.xml
|
||||
|
||||
# Combine input and output options
|
||||
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
|
||||
```
|
||||
|
||||
### Example Output
|
||||
|
||||
The tool will display progress and provide a comprehensive summary:
|
||||
|
||||
```text
|
||||
📊 Completion Summary:
|
||||
✅ Successfully processed 156 files into flattened-codebase.xml
|
||||
📁 Output file: /path/to/your/project/flattened-codebase.xml
|
||||
📏 Total source size: 2.3 MB
|
||||
📄 Generated XML size: 2.1 MB
|
||||
📝 Total lines of code: 15,847
|
||||
🔢 Estimated tokens: 542,891
|
||||
📊 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.
|
||||
|
||||
#### Advanced Usage & Options
|
||||
|
||||
- CLI options
|
||||
- `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.
|
||||
- `-o, --output <path>`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.
|
||||
- Interactive mode
|
||||
- If you do not pass `--input` and `--output` and the terminal is interactive (TTY), the tool will attempt to detect your project root (by looking for markers like `.git`, `package.json`, etc.) and prompt you to confirm or override the paths.
|
||||
- In non-interactive contexts (e.g., CI), it will prefer the detected root silently; otherwise it falls back to the current directory and default filename.
|
||||
- File discovery and ignoring
|
||||
- Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.
|
||||
- Applies your `.gitignore` plus a curated set of default ignore patterns (e.g., `node_modules`, build outputs, caches, logs, IDE folders, lockfiles, large media/binaries, `.env*`, and previously generated XML outputs).
|
||||
- Binary handling
|
||||
- Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.
|
||||
- XML format and safety
|
||||
- UTF-8 encoded file with root element `<files>`.
|
||||
- Each text file is emitted as a `<file path="relative/path">` element whose content is wrapped in `<![CDATA[ ... ]]>`.
|
||||
- The tool safely handles occurrences of `]]>` inside content by splitting the CDATA to preserve correctness.
|
||||
- File contents are preserved as-is and indented for readability inside the XML.
|
||||
- Performance
|
||||
- Concurrency is selected automatically based on your CPU and workload size. No configuration required.
|
||||
- Running inside a git repo improves discovery performance.
|
||||
|
||||
#### Minimal XML example
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<files>
|
||||
<file path="src/index.js"><![CDATA[
|
||||
// your source content
|
||||
]]></file>
|
||||
</files>
|
||||
```
|
||||
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!
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
@@ -212,10 +161,34 @@ 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.
|
||||
|
||||
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
||||
|
||||
<sub>Built with ❤️ for the AI-assisted development community</sub>
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
bundle:
|
||||
name: Team All
|
||||
icon: 👥
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
bundle:
|
||||
name: Team Fullstack
|
||||
icon: 🚀
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
bundle:
|
||||
name: Team IDE Minimal
|
||||
icon: ⚡
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
bundle:
|
||||
name: Team No UI
|
||||
icon: 🔧
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -55,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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -27,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 (Exception: Read `bmad-core/core-config.yaml` during activation)
|
||||
- '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, 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.
|
||||
- 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
|
||||
@@ -49,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
|
||||
@@ -86,23 +100,11 @@ 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
|
||||
- brownfield-ui.md
|
||||
- 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
|
||||
- brownfield-fullstack.yaml
|
||||
- brownfield-service.yaml
|
||||
- brownfield-ui.yaml
|
||||
- greenfield-fullstack.yaml
|
||||
- greenfield-service.yaml
|
||||
- greenfield-ui.yaml
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -29,7 +31,7 @@ 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 (Exception: Read `bmad-core/core-config.yaml` during activation)
|
||||
- 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
|
||||
@@ -54,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)
|
||||
@@ -138,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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -47,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
|
||||
@@ -54,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:
|
||||
@@ -66,13 +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"
|
||||
- review-qa: run task `apply-qa-fixes.md'
|
||||
- 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
|
||||
- apply-qa-fixes.md
|
||||
checklists:
|
||||
- story-dod-checklist.md
|
||||
tasks:
|
||||
- apply-qa-fixes.md
|
||||
- execute-checklist.md
|
||||
- validate-next-story.md
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -51,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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -54,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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -33,11 +35,7 @@ agent:
|
||||
id: qa
|
||||
title: Test Architect & Quality Advisor
|
||||
icon: 🧪
|
||||
whenToUse: |
|
||||
Use for comprehensive test architecture review, quality gate decisions,
|
||||
and code improvement. Provides thorough analysis including requirements
|
||||
traceability, risk assessment, and test strategy.
|
||||
Advisory only - teams choose their quality bar.
|
||||
whenToUse: Use for comprehensive test architecture review, quality gate decisions, and code improvement. Provides thorough analysis including requirements traceability, risk assessment, and test strategy. Advisory only - teams choose their quality bar.
|
||||
customization: null
|
||||
persona:
|
||||
role: Test Architect with Quality Advisory Authority
|
||||
@@ -62,28 +60,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: 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 directory from qa.qaLocation/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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -47,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
|
||||
```
|
||||
|
||||
@@ -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,7 @@ 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: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
||||
- 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
|
||||
@@ -56,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
|
||||
```
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
@@ -13,7 +15,7 @@ First, determine the project type by checking:
|
||||
|
||||
2. Is this a BROWNFIELD project (enhancing existing system)?
|
||||
- Look for: References to existing codebase, enhancement/modification language
|
||||
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
||||
- Check for: prd.md, architecture.md, existing system analysis
|
||||
|
||||
3. Does the project include UI/UX components?
|
||||
- Check for: frontend-architecture.md, UI/UX specifications, design files
|
||||
@@ -31,8 +33,8 @@ For GREENFIELD projects:
|
||||
|
||||
For BROWNFIELD projects:
|
||||
|
||||
- brownfield-prd.md - The brownfield enhancement requirements
|
||||
- brownfield-architecture.md - The enhancement architecture
|
||||
- prd.md - The brownfield enhancement requirements
|
||||
- architecture.md - The enhancement architecture
|
||||
- Existing project codebase access (CRITICAL - cannot proceed without this)
|
||||
- Current deployment configuration and infrastructure details
|
||||
- Database schemas, API documentation, monitoring setup
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Story Definition of Done (DoD) Checklist
|
||||
|
||||
## Instructions for Developer Agent
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
markdownExploder: true
|
||||
qa:
|
||||
qaLocation: docs/qa
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -100,8 +102,9 @@ npx bmad-method install
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
||||
- **Auggie CLI (Augment Code)**: AI-powered development environment
|
||||
|
||||
**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 +112,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
|
||||
|
||||
@@ -178,7 +181,7 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
@@ -353,7 +356,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 +711,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 +743,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?
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Brainstorming Techniques Data
|
||||
|
||||
## Creative Expansion
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Elicitation Methods Data
|
||||
|
||||
## Core Reflective Methods
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# User-Defined Preferred Patterns and Preferences
|
||||
|
||||
None Listed
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Test Levels Framework
|
||||
|
||||
Comprehensive guide for determining appropriate test levels (unit, integration, E2E) for different scenarios.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Test Priorities Matrix
|
||||
|
||||
Guide for prioritizing test scenarios based on risk, criticality, and business impact.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Advanced Elicitation Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- 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.
|
||||
@@ -14,8 +16,8 @@ Implement fixes based on QA results (gate and assessments) for a specific story.
|
||||
```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`)
|
||||
- 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
|
||||
@@ -43,7 +45,7 @@ optional:
|
||||
|
||||
### 0) Load Core Config & Locate Story
|
||||
|
||||
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
|
||||
- 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
|
||||
|
||||
@@ -111,7 +113,7 @@ Status Rule:
|
||||
|
||||
## Blocking Conditions
|
||||
|
||||
- Missing `bmad-core/core-config.yaml`
|
||||
- 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)
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Brownfield Epic Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Brownfield Story Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Brownfield Story Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Next Story Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Document an Existing Project
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create AI Frontend Prompt Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Index Documentation Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -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: `bmad-core/core-config.yaml` for the `devStoryLocation`
|
||||
- story_path: `.bmad-core/core-config.yaml` for the `devStoryLocation`
|
||||
|
||||
optional:
|
||||
- architecture_refs: `bmad-core/core-config.yaml` for the `architecture.architectureFile`
|
||||
- technical_preferences: `bmad-core/core-config.yaml` for the `technicalPreferences`
|
||||
- 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
|
||||
```
|
||||
|
||||
|
||||
@@ -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** check the `bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
|
||||
**ALWAYS** check the `.bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
|
||||
|
||||
Slug rules:
|
||||
|
||||
@@ -124,7 +126,7 @@ waiver:
|
||||
|
||||
## Output Requirements
|
||||
|
||||
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `bmad-core/core-config.yaml`
|
||||
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
|
||||
|
||||
@@ -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.
|
||||
@@ -184,7 +186,7 @@ NFR assessment: qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
|
||||
**Template and Directory:**
|
||||
|
||||
- Render from `../templates/qa-gate-tmpl.yaml`
|
||||
- Create directory defined in `qa.qaLocation/gates` (see `bmad-core/core-config.yaml`) if missing
|
||||
- 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:
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# risk-profile
|
||||
|
||||
Generate a comprehensive risk assessment matrix for a story implementation using probability × impact analysis.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Document Sharding Task
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# test-design
|
||||
|
||||
Create comprehensive test scenarios with appropriate test level recommendations for story implementation.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# trace-requirements
|
||||
|
||||
Map story requirements to test cases using Given-When-Then patterns for comprehensive traceability.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Validate Next Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -19,7 +21,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
||||
|
||||
### 1. Template Completeness Validation
|
||||
|
||||
- Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
|
||||
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
||||
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
||||
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
||||
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: architecture-template-v2
|
||||
name: Architecture Document
|
||||
|
||||
@@ -153,4 +153,4 @@ sections:
|
||||
content: |
|
||||
---
|
||||
|
||||
*Session facilitated using the BMAD-METHOD brainstorming framework*
|
||||
*Session facilitated using the BMAD-METHOD™ brainstorming framework*
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: brownfield-architecture-template-v2
|
||||
name: Brownfield Enhancement Architecture
|
||||
@@ -22,7 +23,7 @@ sections:
|
||||
1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
|
||||
|
||||
2. **REQUIRED INPUTS**:
|
||||
- Completed brownfield-prd.md
|
||||
- Completed prd.md
|
||||
- Existing project technical documentation (from docs folder or user-provided)
|
||||
- Access to existing project structure (IDE or uploaded files)
|
||||
|
||||
@@ -108,8 +109,8 @@ sections:
|
||||
- **UI/UX Consistency:** {{ui_compatibility}}
|
||||
- **Performance Impact:** {{performance_constraints}}
|
||||
|
||||
- id: tech-stack-alignment
|
||||
title: Tech Stack Alignment
|
||||
- id: tech-stack
|
||||
title: Tech Stack
|
||||
instruction: |
|
||||
Ensure new components align with existing technology choices:
|
||||
|
||||
@@ -271,8 +272,8 @@ sections:
|
||||
|
||||
**Error Handling:** {{error_handling_strategy}}
|
||||
|
||||
- id: source-tree-integration
|
||||
title: Source Tree Integration
|
||||
- id: source-tree
|
||||
title: Source Tree
|
||||
instruction: |
|
||||
Define how new code will integrate with existing project structure:
|
||||
|
||||
@@ -341,7 +342,7 @@ sections:
|
||||
**Monitoring:** {{monitoring_approach}}
|
||||
|
||||
- id: coding-standards
|
||||
title: Coding Standards and Conventions
|
||||
title: Coding Standards
|
||||
instruction: |
|
||||
Ensure new code follows existing project conventions:
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: brownfield-prd-template-v2
|
||||
name: Brownfield Enhancement PRD
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: competitor-analysis-template-v2
|
||||
name: Competitive Analysis Report
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: frontend-architecture-template-v2
|
||||
name: Frontend Architecture Document
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: frontend-spec-template-v2
|
||||
name: UI/UX Specification
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: fullstack-architecture-template-v2
|
||||
name: Fullstack Architecture Document
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: market-research-template-v2
|
||||
name: Market Research Report
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: prd-template-v2
|
||||
name: Product Requirements Document
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: project-brief-template-v2
|
||||
name: Project Brief
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: qa-gate-template-v1
|
||||
name: Quality Gate Decision
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: story-template-v2
|
||||
name: Story Document
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Document from Template (YAML Driven)
|
||||
|
||||
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# BMad Document Template Specification
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Workflow Management
|
||||
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
1764
dist/agents/analyst.txt
vendored
1764
dist/agents/analyst.txt
vendored
File diff suppressed because it is too large
Load Diff
1465
dist/agents/architect.txt
vendored
1465
dist/agents/architect.txt
vendored
File diff suppressed because it is too large
Load Diff
1271
dist/agents/bmad-master.txt
vendored
1271
dist/agents/bmad-master.txt
vendored
File diff suppressed because it is too large
Load Diff
48
dist/agents/bmad-orchestrator.txt
vendored
48
dist/agents/bmad-orchestrator.txt
vendored
@@ -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,20 @@ 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 +288,7 @@ 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 +393,7 @@ 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 +472,12 @@ 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 +576,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 +584,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
|
||||
|
||||
@@ -655,7 +653,7 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
@@ -830,7 +828,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 +1183,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 +1215,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 +1282,7 @@ 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 +1440,7 @@ 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.
|
||||
|
||||
169
dist/agents/dev.txt
vendored
169
dist/agents/dev.txt
vendored
@@ -69,9 +69,6 @@ core_principles:
|
||||
- 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 +78,174 @@ 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 +335,7 @@ 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 +473,7 @@ 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
|
||||
|
||||
1548
dist/agents/pm.txt
vendored
1548
dist/agents/pm.txt
vendored
File diff suppressed because it is too large
Load Diff
545
dist/agents/po.txt
vendored
545
dist/agents/po.txt
vendored
@@ -75,30 +75,105 @@ 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 +263,7 @@ 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 +451,8 @@ 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 +590,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 +598,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 +700,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 +730,194 @@ 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.
|
||||
@@ -741,7 +933,7 @@ First, determine the project type by checking:
|
||||
|
||||
2. Is this a BROWNFIELD project (enhancing existing system)?
|
||||
- Look for: References to existing codebase, enhancement/modification language
|
||||
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
||||
- Check for: prd.md, architecture.md, existing system analysis
|
||||
|
||||
3. Does the project include UI/UX components?
|
||||
- Check for: frontend-architecture.md, UI/UX specifications, design files
|
||||
@@ -759,8 +951,8 @@ For GREENFIELD projects:
|
||||
|
||||
For BROWNFIELD projects:
|
||||
|
||||
- brownfield-prd.md - The brownfield enhancement requirements
|
||||
- brownfield-architecture.md - The enhancement architecture
|
||||
- prd.md - The brownfield enhancement requirements
|
||||
- architecture.md - The enhancement architecture
|
||||
- Existing project codebase access (CRITICAL - cannot proceed without this)
|
||||
- Current deployment configuration and infrastructure details
|
||||
- Database schemas, API documentation, monitoring setup
|
||||
@@ -1159,188 +1351,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 ====================
|
||||
|
||||
2824
dist/agents/qa.txt
vendored
2824
dist/agents/qa.txt
vendored
File diff suppressed because it is too large
Load Diff
169
dist/agents/sm.txt
vendored
169
dist/agents/sm.txt
vendored
@@ -68,23 +68,98 @@ 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 +275,7 @@ 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 +364,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 +373,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 +475,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 +506,7 @@ 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.
|
||||
|
||||
239
dist/agents/ux-expert.txt
vendored
239
dist/agents/ux-expert.txt
vendored
@@ -77,72 +77,19 @@ 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 +194,7 @@ 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 +283,63 @@ 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 +347,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 +375,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 +419,7 @@ sections:
|
||||
title: Site Map / Screen Inventory
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
template: '{{sitemap_diagram}}'
|
||||
template: "{{sitemap_diagram}}"
|
||||
examples:
|
||||
- |
|
||||
graph TD
|
||||
@@ -455,7 +459,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: flow
|
||||
title: '{{flow_name}}'
|
||||
title: "{{flow_name}}"
|
||||
template: |
|
||||
**User Goal:** {{flow_goal}}
|
||||
|
||||
@@ -467,13 +471,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 +486,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 +512,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 +535,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 +560,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 +587,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 +607,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 +617,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 +641,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 +659,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 +674,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 +692,7 @@ 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
|
||||
|
||||
@@ -95,6 +95,7 @@ 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 +200,7 @@ 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 +290,7 @@ 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 +584,7 @@ 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 +866,7 @@ 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 +980,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 +1025,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 +1070,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic
|
||||
title: '{{mechanic_name}}'
|
||||
title: "{{mechanic_name}}"
|
||||
template: |
|
||||
**Description:** {{detailed_description}}
|
||||
|
||||
@@ -1129,7 +1135,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 +1236,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 +1247,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 +1323,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 +1396,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: level-category
|
||||
title: '{{category_name}} Levels'
|
||||
title: "{{category_name}} Levels"
|
||||
template: |
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
|
||||
@@ -1694,19 +1701,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 +1815,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 +2109,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 +2175,7 @@ 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
|
||||
|
||||
@@ -102,6 +102,7 @@ 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 +192,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 +424,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic-system
|
||||
title: '{{mechanic_name}} System'
|
||||
title: "{{mechanic_name}} System"
|
||||
template: |
|
||||
**Purpose:** {{system_purpose}}
|
||||
|
||||
@@ -719,7 +721,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 +739,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 +757,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 +809,7 @@ 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 +973,7 @@ _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
|
||||
|
||||
@@ -88,6 +88,7 @@ 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 +308,7 @@ 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 +398,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 +435,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 +445,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 +625,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 +655,7 @@ 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
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -103,6 +103,7 @@ 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 +208,7 @@ 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 +490,7 @@ 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 +679,7 @@ 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 +1026,7 @@ 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 +1116,7 @@ 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 +1230,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 +1238,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 +1348,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 +1391,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 +1415,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: model
|
||||
title: '{{model_name}}'
|
||||
title: "{{model_name}}"
|
||||
template: |
|
||||
**Purpose:** {{model_purpose}}
|
||||
|
||||
@@ -1443,7 +1450,7 @@ sections:
|
||||
sections:
|
||||
- id: system-list
|
||||
repeatable: true
|
||||
title: '{{system_name}} System'
|
||||
title: "{{system_name}} System"
|
||||
template: |
|
||||
**Responsibility:** {{system_description}}
|
||||
|
||||
@@ -1967,7 +1974,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 +2086,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 +2120,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 +2134,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 +2143,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 +2264,7 @@ 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 +2659,7 @@ 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 +3249,7 @@ 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
|
||||
|
||||
@@ -100,6 +100,7 @@ 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 +205,7 @@ 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 +295,7 @@ 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 +484,7 @@ 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 +778,7 @@ 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 +1060,7 @@ 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 +1174,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 +1182,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 +1230,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 +1242,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 +1293,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 +1306,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic
|
||||
title: '{{mechanic_name}}'
|
||||
title: "{{mechanic_name}}"
|
||||
template: |
|
||||
**Description:** {{detailed_description}}
|
||||
|
||||
@@ -1321,8 +1328,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 +1384,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 +1407,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 +1431,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 +1446,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 +1478,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 +1494,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 +1517,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 +1543,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 +1585,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 +1608,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 +1632,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 +1645,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 +1663,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 +1675,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 +1688,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 +1698,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 +1711,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 +1736,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 +1761,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 +1777,7 @@ sections:
|
||||
title: Functional Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- '{{specific_functional_requirement}}'
|
||||
- "{{specific_functional_requirement}}"
|
||||
- id: technical-requirements
|
||||
title: Technical Requirements
|
||||
type: checklist
|
||||
@@ -1778,14 +1785,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 +1810,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 +1823,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 +1869,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 +1891,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 +1952,7 @@ sections:
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: level-category
|
||||
title: '{{category_name}} Levels'
|
||||
title: "{{category_name}} Levels"
|
||||
template: |
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
|
||||
@@ -2363,6 +2371,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 +2379,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 +2665,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 +2731,7 @@ 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 +2936,7 @@ _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
|
||||
|
||||
@@ -97,6 +97,7 @@ 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 +187,7 @@ 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 +325,7 @@ 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
|
||||
|
||||
@@ -88,6 +88,7 @@ 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 +276,7 @@ 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 +366,7 @@ 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 +511,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 +548,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 +558,7 @@ sections:
|
||||
title: Functional Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- '{{specific_functional_requirement}}'
|
||||
- "{{specific_functional_requirement}}"
|
||||
- id: technical-requirements
|
||||
title: Technical Requirements
|
||||
type: checklist
|
||||
@@ -562,14 +566,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 +748,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 +771,7 @@ 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.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user