Compare commits
31 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ba9e3f3272 | ||
|
|
412f152547 | ||
|
|
1b86cd4db3 | ||
|
|
c8b26d8eae | ||
|
|
9cf8a6b72b | ||
|
|
908dcd7e9a | ||
|
|
92c9589f7d | ||
|
|
c2b5da7f6e | ||
|
|
a5ffe7b9b2 | ||
|
|
63aabe435e | ||
|
|
2601fa7205 | ||
|
|
92201ae7ed | ||
|
|
97590e5e1d | ||
|
|
746ba573fa | ||
|
|
339745c3f3 | ||
|
|
1ac0d2bd91 | ||
|
|
b78537115d | ||
|
|
0ca3f9ebbd | ||
|
|
0a61d3de4a | ||
|
|
4e03f8f982 | ||
|
|
5fc69d773a | ||
|
|
9e6940e8ee | ||
|
|
4b0a9235ab | ||
|
|
c107af0598 | ||
|
|
be9453f234 | ||
|
|
de549673a7 | ||
|
|
400f7b8f41 | ||
|
|
fae0f5ff73 | ||
|
|
b9223a4976 | ||
|
|
1bc9960808 | ||
|
|
9f53caf4c6 |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -21,8 +21,10 @@ CLAUDE.md
|
||||
test-project-install/*
|
||||
sample-project/*
|
||||
.claude
|
||||
.windsurf/
|
||||
.trae/
|
||||
.bmad-core
|
||||
.bmad-creator-tools
|
||||
.gemini
|
||||
.bmad*/.cursor/
|
||||
web-bundles/
|
||||
web-bundles/
|
||||
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@@ -32,6 +32,7 @@
|
||||
"playtesting",
|
||||
"pointerdown",
|
||||
"pointerup",
|
||||
"Polyrepo",
|
||||
"replayability",
|
||||
"roguelike",
|
||||
"roomodes",
|
||||
@@ -43,6 +44,7 @@
|
||||
"tekton",
|
||||
"tilemap",
|
||||
"tileset",
|
||||
"Trae",
|
||||
"VNET"
|
||||
]
|
||||
}
|
||||
50
CHANGELOG.md
50
CHANGELOG.md
@@ -1,3 +1,53 @@
|
||||
## [4.27.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.3...v4.27.4) (2025-07-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* doc updates ([1b86cd4](https://github.com/bmadcode/BMAD-METHOD/commit/1b86cd4db3644ca2b2b4a94821cc8b5690d78e0a))
|
||||
|
||||
## [4.27.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.2...v4.27.3) (2025-07-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove test zoo folder ([908dcd7](https://github.com/bmadcode/BMAD-METHOD/commit/908dcd7e9afae3fd23cd894c0d09855fc9c42d0e))
|
||||
|
||||
## [4.27.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.1...v4.27.2) (2025-07-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* improve output ([a5ffe7b](https://github.com/bmadcode/BMAD-METHOD/commit/a5ffe7b9b209ae02a9d97adf60fe73c0bc9701e4))
|
||||
|
||||
## [4.27.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.0...v4.27.1) (2025-07-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* build web bundles with new file extension includsion ([92201ae](https://github.com/bmadcode/BMAD-METHOD/commit/92201ae7ede620ec09b4764edaed97be42a3b78f))
|
||||
|
||||
# [4.27.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.26.0...v4.27.0) (2025-07-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* readme consolidation and version bumps ([0a61d3d](https://github.com/bmadcode/BMAD-METHOD/commit/0a61d3de4af880f6e3bf934a92b1827754ed8ce6))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* big improvement to advanced elicitation ([1bc9960](https://github.com/bmadcode/BMAD-METHOD/commit/1bc9960808098fba6b43850311799022319df841))
|
||||
* experimental doc creator v2 and template system ([b785371](https://github.com/bmadcode/BMAD-METHOD/commit/b78537115da06b01e140833fd1d73950c7f2e41f))
|
||||
* Massive improvement to the brainstorming task! ([9f53caf](https://github.com/bmadcode/BMAD-METHOD/commit/9f53caf4c6f9c67195b1aae14d54987f81d76e07))
|
||||
* WIP create-docv2 ([c107af0](https://github.com/bmadcode/BMAD-METHOD/commit/c107af05984718c1af2cf80118353e8d2e6f906f))
|
||||
|
||||
# [4.26.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.1...v4.26.0) (2025-07-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **trae:** add support for trae ide integration ([#298](https://github.com/bmadcode/BMAD-METHOD/issues/298)) ([fae0f5f](https://github.com/bmadcode/BMAD-METHOD/commit/fae0f5ff73a603dc1aacc29f184e2a4138446524))
|
||||
|
||||
## [4.25.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.0...v4.25.1) (2025-07-06)
|
||||
|
||||
|
||||
|
||||
310
README.md
310
README.md
@@ -13,9 +13,21 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-Method and you will be notified of updates!
|
||||
|
||||
## Overview
|
||||
|
||||
**BMad Method's Two Key Innovations:**
|
||||
|
||||
**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
|
||||
|
||||
**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
|
||||
|
||||
This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.
|
||||
|
||||
**📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles
|
||||
|
||||
## Quick Navigation
|
||||
|
||||
### 🚨 MUST READ: Understanding the BMad Workflow
|
||||
### Understanding the BMad Workflow
|
||||
|
||||
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
|
||||
|
||||
@@ -26,7 +38,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
### What would you like to do?
|
||||
|
||||
- **[Build software with Full Stack Agile AI Team](quick-start)** → Quick Start Instruction
|
||||
- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
|
||||
- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
|
||||
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
||||
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
||||
@@ -35,21 +47,6 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
||||
- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
|
||||
|
||||
### Popular Use Cases
|
||||
|
||||
- **Software Development** - [Quick Start](quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
|
||||
- **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
|
||||
- **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
|
||||
- **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
|
||||
- **DevOps/Infrastructure** - [Infrastructure Pack](expansion-packs/bmad-infrastructure-devops/)
|
||||
|
||||
### Quick Links
|
||||
|
||||
- **[Installation](#installation)** → Get started in minutes
|
||||
- **[Documentation](#documentation--guides)** → All guides and references
|
||||
- **[Contributing](#contributing)** → Help improve BMad
|
||||
- **[Support](#support)** → Get help and connect
|
||||
|
||||
## Important: Keep Your BMad Installation Updated
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
||||
@@ -68,7 +65,7 @@ This will:
|
||||
- ✅ Create `.bak` backup files for any custom modifications you've made
|
||||
- ✅ Preserve your project-specific configurations
|
||||
|
||||
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! If for some reason this fails, you can rename or remove your .bmad-code folder and run the install again. The main thing to look out for is if you have set up custom modes that are not file driven (Cursor is the only one at this time that is not done through project files lagging behind) - you will want to ensure your sm and dev custom modes especially are kept up to date.
|
||||
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -93,14 +90,14 @@ This single command handles:
|
||||
|
||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
||||
|
||||
### Fastest Start: Web UI (2 minutes)
|
||||
### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
|
||||
|
||||
1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
|
||||
1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
|
||||
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
||||
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
||||
|
||||
> **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
||||
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
|
||||
6. **When to moved to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
|
||||
|
||||
### Alternative: Clone and Build
|
||||
|
||||
@@ -109,283 +106,34 @@ git clone https://github.com/bmadcode/bmad-method.git
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by utilizing advanced prompt engineering techniques and critical context management at the most critical stages of development implementation. By providing specialized AI agents for every role in an Agile team, each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
|
||||
|
||||
Unlike systems like Task Master, or inbuilt Task tools, the BMad Methods agile flow does so much more. With most systems, you give your idea, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM prompt engineering advanced techniques to produce anything beyond what the average slop LLMs and Task generators will produce on their own. This truly is a system of Human in the Loop producing markedly better results.
|
||||
|
||||
## Installation
|
||||
|
||||
### Method 1: CLI Installer (For IDEs)
|
||||
|
||||
**Just run one command:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR if you already have BMad installed:
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
**This single command does everything:**
|
||||
|
||||
- Installs BMad for the first time
|
||||
- Updates existing installations
|
||||
- Adds any expansion packs from your package.json
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
||||
|
||||
### Method 2: Pre-Built Web Bundles (For Web UI)
|
||||
|
||||
For ChatGPT, Claude, or Gemini web interfaces:
|
||||
|
||||
1. Choose a bundle:
|
||||
- **Recommended**: `dist/teams/team-fullstack.txt` (complete development team)
|
||||
- Or pick from individual agents in `dist/agents/`
|
||||
2. Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
|
||||
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. Type `/help` to see available commands
|
||||
|
||||
**Supported IDEs:**
|
||||
|
||||
The BMad Method works with any IDE, but has built-in integration for:
|
||||
|
||||
- `cursor` - Cursor IDE with manual rule @agent commands
|
||||
- `claude-code` - Claude Code with /agent commands
|
||||
- `cline` - Cline Rules integration
|
||||
- `gemini-cli` - Gemini with @agent commands
|
||||
- `windsurf` - Windsurf with manual rule @agent commands
|
||||
- `trae` - Trae with manual rule @agent commands
|
||||
- `roo` - Roo Code with custom modes (see `.roomodes`)
|
||||
- `github-copilot` - GitHub Copilot agent mode integration
|
||||
|
||||
## Available Agents
|
||||
|
||||
### Core Development Team
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
|
||||
| `analyst` | Business Analyst | market analysis, brainstorming, project brief creation |
|
||||
| `pm` | Product Manager | Product strategy, MVP Decisioning, PRD creation with Epics |
|
||||
| `architect` | Solution Architect | System design, technical full stack, front end or backend architecture |
|
||||
| `ux-expert` | UX Designer | User experience, UI design, prompts for V0, Lovable, and others |
|
||||
| `po` | Product Owner | Ensure PRD and Architecture are aligned, and changes from architecture end up in PRD stories |
|
||||
| `sm` | Scrum Master | High level epics and stories transformed into detailed dev stories with tasks and subtasks |
|
||||
| `dev` | Developer | Code implementation across all technologies - follows the detailed SM created story |
|
||||
| `qa` | QA Specialist | Detailed review of the devs ready for review story, refactor and propose issues and changes |
|
||||
|
||||
### BMad Agents
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `bmad-orchestrator` | Team Coordinator | Helps guide you and answers your questions with its massive knowledge base, and guides you through Multi-agent workflows |
|
||||
| `bmad-master` | Universal Expert | All capabilities without switching (Except Dev) |
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Dynamic Dependencies
|
||||
|
||||
Each agent only loads the resources it needs, keeping context windows lean.
|
||||
|
||||
### Template System
|
||||
|
||||
Rich templates for all document types:
|
||||
|
||||
- Product Requirements (PRD)
|
||||
- Architecture Documents
|
||||
- User Stories
|
||||
- Test Plans
|
||||
- And more...
|
||||
|
||||
Templates are unique in that they are embedded with the LLM instructions also for further working with you to prompt and elicit the best from you and your agile agent team member - allowing for unique coaching and customization options. While there is a single create-doc task, the possibilities are endless when you expand the templates into more doc types, or customize with your own docs embedded with the templating markup and LLM instruction framework that is core to the BMad Method.
|
||||
|
||||
### Slash Star Commands
|
||||
|
||||
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
||||
|
||||
### Advanced Elicitation
|
||||
|
||||
Many of the Agents and Templates for docs, and some tasks, include Advanced Elicitation directives based on the latest in LLM interactions and pro level prompt engineering guidance. With this, you can push the Agents further than ever before. If an agent proposes an idea, or an architecture - you can push it further with optional elicitations where it will have to really expand on, defend, or produce other options and prove its suggestion was better. This is a necessary step if you want the absolute best beyond accepting the generated average responses the LLMs think you want to hear for their first response. Some of this is interactive, and some of this is baked into the core prompting engine that powers the LLM progression through various tasks and template flows.
|
||||
|
||||
## Usage
|
||||
|
||||
The BMad Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
|
||||
|
||||
### Quick Start Examples
|
||||
|
||||
#### With IDE Integration
|
||||
|
||||
```bash
|
||||
# In Cursor
|
||||
@pm Create a PRD for a task management app
|
||||
|
||||
# In Claude Code
|
||||
/architect Design a microservices architecture
|
||||
|
||||
# In Windsurf
|
||||
@dev Implement story 1.3
|
||||
```
|
||||
|
||||
#### With Web UI
|
||||
|
||||
After uploading a bundle, type `/help` to see available commands.
|
||||
|
||||
### Key Resources
|
||||
|
||||
- **[Complete User Guide](docs/user-guide.md)** - Full walkthrough from project inception to completion
|
||||
- **[CLI Commands](docs/user-guide.md#cli-commands)** - Installation, updates, and management
|
||||
- **[Upgrading from V3](docs/user-guide.md#upgrading-from-v3-to-v4)** - Migration instructions
|
||||
- **[Core Configuration](docs/user-guide.md#core-configuration)** - V4's flexible project structure support
|
||||
- **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
|
||||
|
||||
## Project Structure
|
||||
|
||||
See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
|
||||
|
||||
### Key Directories
|
||||
|
||||
- **`.bmad-core/`** - Heart of the framework (agents, templates, workflows)
|
||||
- **`dist/`** - Pre-built bundles ready for web UI use
|
||||
- **`expansion-packs/`** - Domain-specific extensions
|
||||
- **`tools/`** - Build and installation utilities
|
||||
- **`docs/`** - Your project documentation (PRD, architecture, stories)
|
||||
|
||||
### 📦 Pre-Built Bundles (dist/ folder)
|
||||
|
||||
**All ready-to-use bundles are in the `dist/` directory!**
|
||||
|
||||
- **Teams**: `dist/teams/` - Complete team configurations
|
||||
|
||||
- `team-fullstack.txt` - Full-stack development team
|
||||
- `team-ide-minimal.txt` - Minimal IDE workflow team
|
||||
- `team-no-ui.txt` - Backend-only team
|
||||
- `team-all.txt` - All agents included
|
||||
|
||||
- **Individual Agents**: `dist/agents/` - Single agent files
|
||||
|
||||
- One `.txt` file per agent (analyst, architect, dev, etc.)
|
||||
|
||||
- **Expansion Packs**: `dist/expansion-packs/` - Specialized domains
|
||||
- Game development, DevOps, etc.
|
||||
|
||||
**For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
|
||||
|
||||
## Documentation & Guides
|
||||
|
||||
### Architecture & Technical
|
||||
|
||||
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMad-Method effectively
|
||||
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMad to any domain beyond software development
|
||||
|
||||
### Workflow Guides
|
||||
|
||||
- 📚 [Universal BMad Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
||||
|
||||
### IDE-Specific Guides
|
||||
|
||||
- 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor
|
||||
- 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code
|
||||
- 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf
|
||||
- 🌊 [Trae Guide](docs/agentic-tools/trae-guide.md) - Setup and usage for Trae
|
||||
- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
|
||||
- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
|
||||
- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
|
||||
- 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
||||
|
||||
## 🌟 Beyond Software Development - Expansion Packs
|
||||
|
||||
While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMad into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
|
||||
BMad's natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMad-Method with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
|
||||
|
||||
### Available Expansion Packs
|
||||
## Documentation & Resources
|
||||
|
||||
#### Technical Domains
|
||||
### Essential Guides
|
||||
|
||||
- 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
|
||||
- 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
|
||||
- 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
|
||||
- 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
|
||||
|
||||
#### Non-Technical Domains
|
||||
|
||||
- 💼 **Business Strategy** - Strategic planners, market analysts, business coaches
|
||||
- 💪 **Health & Wellness** - Fitness coaches, nutrition advisors, meditation guides
|
||||
- 🎨 **Creative Arts** - Story writers, world builders, character developers
|
||||
- 📚 **Education** - Curriculum designers, tutors, learning coaches
|
||||
- 🧠 **Personal Development** - Life coaches, goal setters, habit builders
|
||||
- 🏢 **Professional Services** - Legal advisors, content creators, research assistants
|
||||
|
||||
### Creating Your Own Expansion Pack
|
||||
|
||||
Transform your expertise into AI agents:
|
||||
|
||||
1. **Identify your domain** - What knowledge do you want to share?
|
||||
2. **Design specialized agents** - Each with unique expertise and personality
|
||||
3. **Create reusable tasks** - Standard procedures in your field
|
||||
4. **Build professional templates** - Structured outputs for consistency
|
||||
5. **Share with the community** - Help others benefit from your expertise
|
||||
|
||||
📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
|
||||
- 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion
|
||||
- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
|
||||
- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
|
||||
- [IDE Specific Guides available in this folder](docs/agentic-tools/)
|
||||
|
||||
## Support
|
||||
|
||||
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
||||
- 📖 [Documentation](docs/)
|
||||
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
||||
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
## Version History
|
||||
|
||||
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
||||
- **Previous Versions**:
|
||||
- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3) - Introduced the unified BMad Agent and Gemini optimization
|
||||
- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2) - Added web agents and template separation
|
||||
- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1) - Original 7-file proof of concept
|
||||
|
||||
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
||||
|
||||
## Author
|
||||
|
||||
Created by Brian (BMad) Madison
|
||||
|
||||
## Contributing
|
||||
|
||||
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
||||
|
||||
### Before Contributing - MUST READ
|
||||
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
|
||||
|
||||
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
||||
## License
|
||||
|
||||
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMad powerful through simplicity
|
||||
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
|
||||
### Key Points to Remember
|
||||
|
||||
- Keep dev agents lean (save context for coding!)
|
||||
- Use small, focused files over large branching ones
|
||||
- Reuse existing tasks (like `create-doc`) instead of creating duplicates
|
||||
- Consider expansion packs for domain-specific features and not improvements to the core system (those belong in the core system)
|
||||
- All contributions must follow our natural language, markdown-based templating approach with template embedded LLM instructions and elicitations
|
||||
|
||||
We're building something amazing together - let's keep it simple, powerful, and focused! 💪
|
||||
|
||||
### Development Setup
|
||||
|
||||
Want to help improve the BMad Method. Fork n' Clone the repo
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
cd bmad-method
|
||||
|
||||
npm run build # rebuild the dist folder
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@ agents:
|
||||
- bmad-orchestrator
|
||||
- '*'
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-fullstack.yaml
|
||||
- brownfield-service.yaml
|
||||
- brownfield-ui.yaml
|
||||
- greenfield-fullstack.yaml
|
||||
- greenfield-service.yaml
|
||||
- greenfield-ui.yaml
|
||||
|
||||
@@ -10,9 +10,9 @@ agents:
|
||||
- architect
|
||||
- po
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-fullstack.yaml
|
||||
- brownfield-service.yaml
|
||||
- brownfield-ui.yaml
|
||||
- greenfield-fullstack.yaml
|
||||
- greenfield-service.yaml
|
||||
- greenfield-ui.yaml
|
||||
|
||||
@@ -9,5 +9,5 @@ agents:
|
||||
- architect
|
||||
- po
|
||||
workflows:
|
||||
- greenfield-service
|
||||
- brownfield-service
|
||||
- greenfield-service.yaml
|
||||
- brownfield-service.yaml
|
||||
|
||||
@@ -4,13 +4,14 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Mary
|
||||
id: analyst
|
||||
@@ -35,33 +36,31 @@ persona:
|
||||
- Maintaining a Broad Perspective - Stay aware of market trends and dynamics
|
||||
- Integrity of Information - Ensure accurate sourcing and representation
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- yolo: Toggle Yolo Mode
|
||||
- doc-out: Output full document to current destination file
|
||||
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
||||
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
||||
- research-prompt {topic}: execute task create-deep-research-prompt for architectural decisions
|
||||
- brainstorm {topic}: Facilitate structured brainstorming session
|
||||
- elicit: list the options under output set of information
|
||||
- elicit: run the task advanced-elicitation
|
||||
- document-project: Analyze and document existing project structure comprehensively
|
||||
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- brainstorming-techniques
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- advanced-elicitation
|
||||
- document-project
|
||||
- facilitate-brainstorming-session.md
|
||||
- create-deep-research-prompt.md
|
||||
- create-doc.md
|
||||
- advanced-elicitation.md
|
||||
- document-project.md
|
||||
templates:
|
||||
- project-brief-tmpl
|
||||
- market-research-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- project-brief-tmpl.yaml
|
||||
- market-research-tmpl.yaml
|
||||
- competitor-analysis-tmpl.yaml
|
||||
- brainstorming-output-tmpl.yaml
|
||||
data:
|
||||
- bmad-kb
|
||||
utils:
|
||||
- template-format
|
||||
- bmad-kb.md
|
||||
- brainstorming-techniques.md
|
||||
```
|
||||
|
||||
@@ -4,13 +4,15 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
agent:
|
||||
name: Winston
|
||||
id: architect
|
||||
@@ -34,33 +36,28 @@ persona:
|
||||
- Data-Centric Design - Let data requirements drive architecture
|
||||
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
||||
- Living Architecture - Design for change and adaptation
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- yolo: Toggle Yolo Mode
|
||||
- doc-out: Output full document to current destination file
|
||||
- execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
|
||||
- research {topic}: execute task create-deep-research-prompt for architectural decisions
|
||||
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- create-deep-research-prompt
|
||||
- document-project
|
||||
- execute-checklist
|
||||
- create-doc.md
|
||||
- create-deep-research-prompt.md
|
||||
- document-project.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
- brownfield-architecture-tmpl
|
||||
- architecture-tmpl.yaml
|
||||
- front-end-architecture-tmpl.yaml
|
||||
- fullstack-architecture-tmpl.yaml
|
||||
- brownfield-architecture-tmpl.yaml
|
||||
checklists:
|
||||
- architect-checklist
|
||||
- architect-checklist.md
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
```
|
||||
|
||||
@@ -1,11 +1,18 @@
|
||||
# bmad-master
|
||||
# BMad Master
|
||||
|
||||
CRITICAL: Read the full YAML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- Check for active workflow plan using the utils plan-management
|
||||
- If plan exists: Show brief status - Active plan {workflow} in progress
|
||||
- If plan exists: Suggest next step based on plan
|
||||
- CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded
|
||||
- CRITICAL: Do NOT run discovery tasks automatically
|
||||
agent:
|
||||
name: BMad Master
|
||||
id: bmad-master
|
||||
@@ -24,13 +31,6 @@ persona:
|
||||
- Track execution state and guide multi-step plans
|
||||
- Use numbered lists for choices
|
||||
- Process (*) commands immediately, All commands require * prefix when used (e.g., *help)
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- Check for active workflow plan using the utils plan-management
|
||||
- If plan exists: Show brief status - Active plan {workflow} in progress
|
||||
- If plan exists: Suggest next step based on plan
|
||||
- CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded
|
||||
- CRITICAL: Do NOT run discovery tasks automatically
|
||||
|
||||
commands:
|
||||
- help: Show these listed commands in a numbered list
|
||||
@@ -38,12 +38,13 @@ commands:
|
||||
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
||||
- list {task|template|util|checklist|workflow}: List resources by type ONLY from the corresponding dependencies sub item below
|
||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||
- create-prd-alpha: Execute task create-doc2 with .bmad-core/templates/prd-tmpl2.yaml (EXPERIMENTAL)
|
||||
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
||||
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
||||
- plan: Execute the task Create workflow plan
|
||||
- plan-status: Show current workflow plan progress
|
||||
- plan-update: Update workflow plan status
|
||||
- yolo: Toggle Yolo Mode off (default) abd on - on will skip doc section confirmations
|
||||
- yolo: Toggle Yolo Mode
|
||||
- doc-out: Output full document to current destination file
|
||||
- exit: Exit (confirm)
|
||||
workflow-guidance:
|
||||
@@ -58,52 +59,53 @@ execution:
|
||||
- Suggest related resources after completion
|
||||
dependencies:
|
||||
tasks:
|
||||
- advanced-elicitation
|
||||
- brainstorming-techniques
|
||||
- brownfield-create-epic
|
||||
- brownfield-create-story
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-workflow-plan
|
||||
- document-project
|
||||
- create-next-story
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
- shard-doc
|
||||
- update-workflow-plan
|
||||
- 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
|
||||
- create-workflow-plan.md
|
||||
- document-project.md
|
||||
- create-next-story.md
|
||||
- execute-checklist.md
|
||||
- generate-ai-frontend-prompt.md
|
||||
- index-docs.md
|
||||
- shard-doc.md
|
||||
- update-workflow-plan.md
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- brownfield-architecture-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- competitor-analysis-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- front-end-spec-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
- market-research-tmpl
|
||||
- prd-tmpl
|
||||
- project-brief-tmpl
|
||||
- story-tmpl
|
||||
- architecture-tmpl.yaml
|
||||
- brownfield-architecture-tmpl.yaml
|
||||
- brownfield-prd-tmpl.yaml
|
||||
- competitor-analysis-tmpl.yaml
|
||||
- front-end-architecture-tmpl.yaml
|
||||
- front-end-spec-tmpl.yaml
|
||||
- fullstack-architecture-tmpl.yaml
|
||||
- market-research-tmpl.yaml
|
||||
- prd-tmpl.yaml
|
||||
- project-brief-tmpl.yaml
|
||||
- story-tmpl.yaml
|
||||
data:
|
||||
- bmad-kb
|
||||
- technical-preferences
|
||||
- bmad-kb.md
|
||||
- brainstorming-techniques.md
|
||||
- elicitation-methods.md
|
||||
- technical-preferences.md
|
||||
utils:
|
||||
- plan-management
|
||||
- template-format
|
||||
- workflow-management
|
||||
- plan-management.md
|
||||
- workflow-management.md
|
||||
workflows:
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-fullstack.md
|
||||
- brownfield-service.md
|
||||
- brownfield-ui.md
|
||||
- greenfield-fullstack.md
|
||||
- greenfield-service.md
|
||||
- greenfield-ui.md
|
||||
checklists:
|
||||
- architect-checklist
|
||||
- change-checklist
|
||||
- pm-checklist
|
||||
- po-master-checklist
|
||||
- story-dod-checklist
|
||||
- story-draft-checklist
|
||||
- architect-checklist.md
|
||||
- change-checklist.md
|
||||
- pm-checklist.md
|
||||
- po-master-checklist.md
|
||||
- story-dod-checklist.md
|
||||
- story-draft-checklist.md
|
||||
```
|
||||
|
||||
@@ -1,11 +1,22 @@
|
||||
# bmad
|
||||
# BMad Web Orchestrator
|
||||
|
||||
CRITICAL: Read the full YAML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using {root}/utils/plan-management.md
|
||||
- "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
|
||||
- "If plan exists: Suggest next action based on plan progress"
|
||||
- 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
|
||||
@@ -27,17 +38,6 @@ persona:
|
||||
- Always use numbered lists for choices
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
- "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
|
||||
- "If plan exists: Suggest next action based on plan progress"
|
||||
- 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
|
||||
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
|
||||
@@ -126,15 +126,15 @@ workflow-guidance:
|
||||
- When *workflow-guidance is called, start an interactive session and list all available workflows with brief descriptions
|
||||
dependencies:
|
||||
tasks:
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
- create-workflow-plan
|
||||
- kb-mode-interaction
|
||||
- update-workflow-plan
|
||||
- advanced-elicitation.md
|
||||
- create-doc.md
|
||||
- create-workflow-plan.md
|
||||
- kb-mode-interaction.md
|
||||
- update-workflow-plan.md
|
||||
data:
|
||||
- bmad-kb
|
||||
- bmad-kb.md
|
||||
- elicitation-methods.md
|
||||
utils:
|
||||
- plan-management
|
||||
- workflow-management
|
||||
- template-format
|
||||
- plan-management.md
|
||||
- workflow-management.md
|
||||
```
|
||||
|
||||
@@ -4,8 +4,13 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Announce: Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
||||
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
||||
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
||||
agent:
|
||||
name: James
|
||||
id: dev
|
||||
@@ -14,11 +19,6 @@ agent:
|
||||
whenToUse: "Use for code implementation, debugging, refactoring, and development best practices"
|
||||
customization:
|
||||
|
||||
startup:
|
||||
- Announce: Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
||||
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
||||
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
||||
|
||||
persona:
|
||||
role: Expert Senior Software Engineer & Implementation Specialist
|
||||
@@ -50,8 +50,8 @@ develop-story:
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- validate-next-story
|
||||
- execute-checklist.md
|
||||
- validate-next-story.md
|
||||
checklists:
|
||||
- story-dod-checklist
|
||||
- story-dod-checklist.md
|
||||
```
|
||||
|
||||
@@ -4,13 +4,14 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: John
|
||||
id: pm
|
||||
@@ -32,32 +33,28 @@ persona:
|
||||
- Collaborative & iterative approach
|
||||
- Proactive risk identification
|
||||
- Strategic thinking & outcome-oriented
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- create-doc {template}: execute task create-doc for template provided, if no template then ONLY list dependencies.templates
|
||||
- yolo: Toggle Yolo Mode
|
||||
- doc-out: Output full document to current destination file
|
||||
- exit: Exit (confirm)
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- brownfield-create-epic
|
||||
- brownfield-create-story
|
||||
- execute-checklist
|
||||
- shard-doc
|
||||
- create-doc.md
|
||||
- correct-course.md
|
||||
- create-deep-research-prompt.md
|
||||
- brownfield-create-epic.md
|
||||
- brownfield-create-story.md
|
||||
- execute-checklist.md
|
||||
- shard-doc.md
|
||||
templates:
|
||||
- prd-tmpl
|
||||
- brownfield-prd-tmpl
|
||||
- prd-tmpl.yaml
|
||||
- brownfield-prd-tmpl.yaml
|
||||
checklists:
|
||||
- pm-checklist
|
||||
- change-checklist
|
||||
- pm-checklist.md
|
||||
- change-checklist.md
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
```
|
||||
|
||||
@@ -4,13 +4,14 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Sarah
|
||||
id: po
|
||||
@@ -34,8 +35,6 @@ persona:
|
||||
- User Collaboration for Validation - Seek input at critical checkpoints
|
||||
- Focus on Executable & Value-Driven Increments - Ensure work aligns with MVP goals
|
||||
- Documentation Ecosystem Integrity - Maintain consistency across all documents
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
@@ -51,17 +50,15 @@ commands:
|
||||
- exit: Exit (confirm)
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- shard-doc
|
||||
- correct-course
|
||||
- brownfield-create-epic
|
||||
- brownfield-create-story
|
||||
- validate-next-story
|
||||
- execute-checklist.md
|
||||
- shard-doc.md
|
||||
- correct-course.md
|
||||
- brownfield-create-epic.md
|
||||
- brownfield-create-story.md
|
||||
- validate-next-story.md
|
||||
templates:
|
||||
- story-tmpl
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- po-master-checklist
|
||||
- change-checklist
|
||||
utils:
|
||||
- template-format
|
||||
- po-master-checklist.md
|
||||
- change-checklist.md
|
||||
```
|
||||
|
||||
@@ -4,13 +4,14 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Quinn
|
||||
id: qa
|
||||
@@ -34,8 +35,6 @@ persona:
|
||||
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
||||
- Continuous Improvement - Balance perfection with pragmatism
|
||||
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
story-file-permissions:
|
||||
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
||||
- CRITICAL: DO NOT modify any other sections including Status, Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Testing, Dev Agent Record, Change Log, or any other sections
|
||||
@@ -48,9 +47,9 @@ commands:
|
||||
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- review-story
|
||||
- review-story.md
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
templates:
|
||||
- story-tmpl.yaml
|
||||
```
|
||||
|
||||
@@ -4,12 +4,13 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
|
||||
|
||||
```yaml
|
||||
root: .bmad-core
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
||||
agent:
|
||||
name: Bob
|
||||
id: sm
|
||||
@@ -26,10 +27,6 @@ persona:
|
||||
- Rigorously follow `create-next-story` procedure to generate the detailed user story
|
||||
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
|
||||
- You are NOT allowed to implement stories or modify code EVER!
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
||||
- Offer to help with story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
@@ -39,13 +36,11 @@ commands:
|
||||
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-next-story
|
||||
- execute-checklist
|
||||
- correct-course
|
||||
- create-next-story.md
|
||||
- execute-checklist.md
|
||||
- correct-course.md
|
||||
templates:
|
||||
- story-tmpl
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- story-draft-checklist
|
||||
utils:
|
||||
- template-format
|
||||
- story-draft-checklist.md
|
||||
```
|
||||
|
||||
@@ -11,6 +11,7 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Sally
|
||||
id: ux-expert
|
||||
@@ -32,9 +33,6 @@ persona:
|
||||
- You have a keen eye for detail and a deep empathy for users.
|
||||
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
||||
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
||||
# All commands require * prefix when used (e.g., *help)
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
@@ -45,14 +43,12 @@ commands:
|
||||
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- generate-ai-frontend-prompt
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt.md
|
||||
- create-deep-research-prompt.md
|
||||
- create-doc.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- front-end-spec-tmpl
|
||||
- front-end-spec-tmpl.yaml
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
```
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
version: 4.25.0
|
||||
version: 4.27.0
|
||||
markdownExploder: true
|
||||
prd:
|
||||
prdFile: docs/prd.md
|
||||
|
||||
@@ -33,13 +33,15 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
|
||||
### The Two-Phase Approach
|
||||
|
||||
**Phase 1: Planning (Web UI - Cost Effective)**
|
||||
#### Phase 1: Planning (Web UI - Cost Effective)
|
||||
|
||||
- Use large context windows (Gemini's 1M tokens)
|
||||
- Generate comprehensive documents (PRD, Architecture)
|
||||
- Leverage multiple agents for brainstorming
|
||||
- Create once, use throughout development
|
||||
|
||||
**Phase 2: Development (IDE - Implementation)**
|
||||
#### Phase 2: Development (IDE - Implementation)
|
||||
|
||||
- Shard documents into manageable pieces
|
||||
- Execute focused SM → Dev cycles
|
||||
- One story at a time, sequential progress
|
||||
@@ -69,6 +71,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
### Quick Start Options
|
||||
|
||||
#### Option 1: Web UI
|
||||
|
||||
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
||||
|
||||
1. Navigate to `dist/teams/`
|
||||
@@ -78,6 +81,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
@@ -86,6 +90,7 @@ npx bmad-method install
|
||||
```
|
||||
|
||||
**Installation Steps**:
|
||||
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE from supported options:
|
||||
- **Cursor**: Native AI integration
|
||||
@@ -94,11 +99,12 @@ npx bmad-method install
|
||||
- **Trae**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
||||
|
||||
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
||||
|
||||
**Verify Installation**:
|
||||
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
@@ -108,12 +114,14 @@ npx bmad-method install
|
||||
### Environment Selection Guide
|
||||
|
||||
**Use Web UI for**:
|
||||
|
||||
- Initial planning and documentation (PRD, architecture)
|
||||
- Cost-effective document creation (especially with Gemini)
|
||||
- Brainstorming and analysis phases
|
||||
- Multi-agent consultation and planning
|
||||
|
||||
**Use IDE for**:
|
||||
|
||||
- Active development and coding
|
||||
- File operations and project integration
|
||||
- Document sharding and story management
|
||||
@@ -126,35 +134,41 @@ npx bmad-method install
|
||||
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
||||
|
||||
**Pros of IDE-Only**:
|
||||
|
||||
- Single environment workflow
|
||||
- Direct file operations from start
|
||||
- No copy/paste between environments
|
||||
- Immediate project integration
|
||||
|
||||
**Cons of IDE-Only**:
|
||||
|
||||
- Higher token costs for large document creation
|
||||
- Smaller context windows (varies by IDE/model)
|
||||
- May hit limits during planning phases
|
||||
- Less cost-effective for brainstorming
|
||||
|
||||
**Using Web Agents in IDE**:
|
||||
|
||||
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
||||
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
||||
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
||||
|
||||
**About bmad-master and bmad-orchestrator**:
|
||||
|
||||
- **bmad-master**: CAN do any task without switching agents, BUT...
|
||||
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
||||
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
||||
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
||||
|
||||
**CRITICAL RULE for Development**:
|
||||
|
||||
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
||||
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
||||
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
||||
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
||||
|
||||
**Best Practice for IDE-Only**:
|
||||
|
||||
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
||||
2. Create documents directly in project
|
||||
3. Shard immediately after creation
|
||||
@@ -178,17 +192,20 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
||||
### Key Configuration Areas
|
||||
|
||||
#### PRD Configuration
|
||||
|
||||
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
||||
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
||||
- **prdShardedLocation**: Where to find sharded epic files
|
||||
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
||||
|
||||
#### Architecture Configuration
|
||||
|
||||
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
||||
- **architectureSharded**: Whether architecture is split into components
|
||||
- **architectureShardedLocation**: Where sharded architecture files live
|
||||
|
||||
#### Developer Files
|
||||
|
||||
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
||||
- **devDebugLog**: Where dev agent logs repeated failures
|
||||
- **agentCoreDump**: Export location for chat conversations
|
||||
@@ -203,6 +220,7 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
||||
### Common Configurations
|
||||
|
||||
**Legacy V3 Project**:
|
||||
|
||||
```yaml
|
||||
prdVersion: v3
|
||||
prdSharded: false
|
||||
@@ -211,6 +229,7 @@ architectureSharded: false
|
||||
```
|
||||
|
||||
**V4 Optimized Project**:
|
||||
|
||||
```yaml
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
@@ -276,18 +295,21 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
#### IDE-Specific Syntax
|
||||
|
||||
**Agent Loading by IDE**:
|
||||
|
||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
|
||||
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
||||
- **Roo Code**: Switch modes within the same conversation
|
||||
|
||||
**Common Task Commands**:
|
||||
|
||||
- `*help` - Show available commands
|
||||
- `*status` - Show current context/progress
|
||||
- `*exit` - Exit the agent mode
|
||||
@@ -296,6 +318,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- `*create` - Run create-next-story task (SM agent)
|
||||
|
||||
**In Web UI**:
|
||||
|
||||
```text
|
||||
/pm create-doc prd
|
||||
/architect review system design
|
||||
@@ -309,16 +332,19 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
### Pre-Built Teams
|
||||
|
||||
#### Team All
|
||||
|
||||
- **Includes**: All 10 agents + orchestrator
|
||||
- **Use Case**: Complete projects requiring all roles
|
||||
- **Bundle**: `team-all.txt`
|
||||
|
||||
#### Team Fullstack
|
||||
|
||||
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
||||
- **Use Case**: End-to-end web/mobile development
|
||||
- **Bundle**: `team-fullstack.txt`
|
||||
|
||||
#### Team No-UI
|
||||
|
||||
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
||||
- **Use Case**: Backend services, APIs, system development
|
||||
- **Bundle**: `team-no-ui.txt`
|
||||
@@ -332,22 +358,26 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
||||
### Key Architectural Components
|
||||
|
||||
#### 1. Agents (`bmad-core/agents/`)
|
||||
|
||||
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
||||
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
||||
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
||||
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
||||
|
||||
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
||||
|
||||
- **Purpose**: Define collections of agents bundled together for specific purposes
|
||||
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
||||
- **Usage**: Creates pre-packaged contexts for web UI environments
|
||||
|
||||
#### 3. Workflows (`bmad-core/workflows/`)
|
||||
|
||||
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
||||
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
||||
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
||||
|
||||
#### 4. Reusable Resources
|
||||
|
||||
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
||||
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
||||
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
||||
@@ -373,20 +403,14 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
1. **Template Format** (`utils/bmad-doc-template.md`): Defines markup language for variable substitution and AI processing directives from yaml templates
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction to transform yaml spec to final markdown output
|
||||
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
||||
|
||||
**Template Features**:
|
||||
|
||||
- **Self-contained**: Templates embed both output structure and processing instructions
|
||||
- **Variable Substitution**: `{{placeholders}}` for dynamic content
|
||||
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
|
||||
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
|
||||
|
||||
### Technical Preferences Integration
|
||||
|
||||
The `technical-preferences.md` file serves as a persistent technical profile that:
|
||||
|
||||
- Ensures consistency across all agents and projects
|
||||
- Eliminates repetitive technology specification
|
||||
- Provides personalized recommendations aligned with user preferences
|
||||
@@ -395,6 +419,7 @@ The `technical-preferences.md` file serves as a persistent technical profile tha
|
||||
### Build and Delivery Process
|
||||
|
||||
The `web-builder.js` tool creates web-ready bundles by:
|
||||
|
||||
1. Reading agent or team definition files
|
||||
2. Recursively resolving all dependencies
|
||||
3. Concatenating content into single text files with clear separators
|
||||
@@ -409,11 +434,13 @@ This architecture enables seamless operation across environments while maintaini
|
||||
**Ideal for cost efficiency with Gemini's massive context:**
|
||||
|
||||
**For Brownfield Projects - Start Here!**:
|
||||
|
||||
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Document existing system**: `/analyst` → `*document-project`
|
||||
3. **Creates comprehensive docs** from entire codebase analysis
|
||||
|
||||
**For All Projects**:
|
||||
|
||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||
@@ -424,12 +451,14 @@ This architecture enables seamless operation across environments while maintaini
|
||||
#### Example Planning Prompts
|
||||
|
||||
**For PRD Creation**:
|
||||
|
||||
```text
|
||||
"I want to build a [type] application that [core purpose].
|
||||
Help me brainstorm features and create a comprehensive PRD."
|
||||
```
|
||||
|
||||
**For Architecture Design**:
|
||||
|
||||
```text
|
||||
"Based on this PRD, design a scalable technical architecture
|
||||
that can handle [specific requirements]."
|
||||
@@ -447,7 +476,7 @@ that can handle [specific requirements]."
|
||||
|
||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||
|
||||
1. **Document Sharding** (CRITICAL STEP):
|
||||
1. **Document Sharding** (CRITICAL STEP):
|
||||
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
||||
- Two methods to shard:
|
||||
a) **Manual**: Drag `shard-doc` task + document file into chat
|
||||
@@ -461,32 +490,33 @@ that can handle [specific requirements]."
|
||||
- Source tree document and coding standards for dev agent reference
|
||||
- Sharded docs for SM agent story creation
|
||||
|
||||
**Resulting Folder Structure**:
|
||||
Resulting Folder Structure:
|
||||
|
||||
- `docs/prd/` - Broken down PRD sections
|
||||
- `docs/architecture/` - Broken down architecture sections
|
||||
- `docs/stories/` - Generated user stories
|
||||
|
||||
3. **Development Cycle** (Sequential, one story at a time):
|
||||
1. **Development Cycle** (Sequential, one story at a time):
|
||||
|
||||
**CRITICAL CONTEXT MANAGEMENT**:
|
||||
- **Context windows matter!** Always use fresh, clean context windows
|
||||
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
||||
- **ALWAYS start new chat between SM, Dev, and QA work**
|
||||
|
||||
**Step 1 - Story Creation**:
|
||||
**Step 1 - Story Creation**:
|
||||
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
||||
- SM executes create-next-story task
|
||||
- Review generated story in `docs/stories/`
|
||||
- Update status from "Draft" to "Approved"
|
||||
|
||||
**Step 2 - Story Implementation**:
|
||||
|
||||
**Step 2 - Story Implementation**:
|
||||
- **NEW CLEAN CHAT** → `@dev`
|
||||
- Agent asks which story to implement
|
||||
- Include story file content to save dev agent lookup time
|
||||
- Dev follows tasks/subtasks, marking completion
|
||||
- Dev maintains File List of all changes
|
||||
- Dev marks story as "Review" when complete with all tests passing
|
||||
|
||||
|
||||
**Step 3 - Senior QA Review**:
|
||||
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
||||
- QA performs senior developer code review
|
||||
@@ -494,7 +524,7 @@ that can handle [specific requirements]."
|
||||
- QA appends results to story's QA Results section
|
||||
- If approved: Status → "Done"
|
||||
- If changes needed: Status stays "Review" with unchecked items for dev
|
||||
|
||||
|
||||
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
||||
|
||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||
@@ -502,6 +532,7 @@ that can handle [specific requirements]."
|
||||
### Status Tracking Workflow
|
||||
|
||||
Stories progress through defined statuses:
|
||||
|
||||
- **Draft** → **Approved** → **InProgress** → **Done**
|
||||
|
||||
Each status change requires user verification and approval before proceeding.
|
||||
@@ -509,6 +540,7 @@ Each status change requires user verification and approval before proceeding.
|
||||
### Workflow Types
|
||||
|
||||
#### Greenfield Development
|
||||
|
||||
- Business analysis and market research
|
||||
- Product requirements and feature definition
|
||||
- System architecture and design
|
||||
@@ -522,6 +554,7 @@ Each status change requires user verification and approval before proceeding.
|
||||
**Complete Brownfield Workflow Options**:
|
||||
|
||||
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
||||
|
||||
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
||||
3. **Focused documentation**: `@analyst` → `*document-project`
|
||||
@@ -532,18 +565,19 @@ Each status change requires user verification and approval before proceeding.
|
||||
- Avoids bloating docs with unused code
|
||||
|
||||
**Option 2: Document-First (Good for Smaller Projects)**:
|
||||
|
||||
1. **Upload project to Gemini Web**
|
||||
2. **Document everything**: `@analyst` → `*document-project`
|
||||
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
||||
- More thorough but can create excessive documentation
|
||||
|
||||
2. **Requirements Gathering**:
|
||||
4. **Requirements Gathering**:
|
||||
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
||||
- **Analyzes**: Existing system, constraints, integration points
|
||||
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
||||
- **Creates**: Epic and story structure for changes
|
||||
|
||||
3. **Architecture Planning**:
|
||||
5. **Architecture Planning**:
|
||||
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
||||
- **Integration Strategy**: How new features integrate with existing system
|
||||
- **Migration Planning**: Gradual rollout and backwards compatibility
|
||||
@@ -552,10 +586,12 @@ Each status change requires user verification and approval before proceeding.
|
||||
**Brownfield-Specific Resources**:
|
||||
|
||||
**Templates**:
|
||||
|
||||
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
||||
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
||||
|
||||
**Tasks**:
|
||||
|
||||
- `document-project`: Generates comprehensive documentation from existing codebase
|
||||
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
||||
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
||||
@@ -563,18 +599,21 @@ Each status change requires user verification and approval before proceeding.
|
||||
**When to Use Each Approach**:
|
||||
|
||||
**Full Brownfield Workflow** (Recommended for):
|
||||
|
||||
- Major feature additions
|
||||
- System modernization
|
||||
- Complex integrations
|
||||
- Multiple related changes
|
||||
|
||||
**Quick Epic/Story Creation** (Use when):
|
||||
|
||||
- Single, focused enhancement
|
||||
- Isolated bug fixes
|
||||
- Small feature additions
|
||||
- Well-documented existing system
|
||||
|
||||
**Critical Success Factors**:
|
||||
|
||||
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
||||
2. **Context Matters**: Provide agents access to relevant code sections
|
||||
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
||||
@@ -590,6 +629,7 @@ Each status change requires user verification and approval before proceeding.
|
||||
- `docs/architecture.md` - System Architecture Document
|
||||
|
||||
**Why These Names Matter**:
|
||||
|
||||
- Agents automatically reference these files during development
|
||||
- Sharding tasks expect these specific filenames
|
||||
- Workflow automation depends on standard naming
|
||||
@@ -608,6 +648,7 @@ Each status change requires user verification and approval before proceeding.
|
||||
Templates with Level 2 headings (`##`) can be automatically sharded:
|
||||
|
||||
**Original PRD**:
|
||||
|
||||
```markdown
|
||||
## Goals and Background Context
|
||||
## Requirements
|
||||
@@ -616,6 +657,7 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
||||
```
|
||||
|
||||
**After Sharding**:
|
||||
|
||||
- `docs/prd/goals-and-background-context.md`
|
||||
- `docs/prd/requirements.md`
|
||||
- `docs/prd/user-interface-design-goals.md`
|
||||
@@ -628,12 +670,14 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
### Environment-Specific Usage
|
||||
|
||||
**Web UI Best For**:
|
||||
|
||||
- Initial planning and documentation phases
|
||||
- Cost-effective large document creation
|
||||
- Agent consultation and brainstorming
|
||||
- Multi-agent workflows with orchestrator
|
||||
|
||||
**IDE Best For**:
|
||||
|
||||
- Active development and implementation
|
||||
- File operations and project integration
|
||||
- Story management and development cycles
|
||||
@@ -668,6 +712,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
**Fork Workflow**:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create feature branches
|
||||
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
||||
@@ -675,12 +720,14 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
5. One feature/fix per PR
|
||||
|
||||
**PR Requirements**:
|
||||
|
||||
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
||||
- Use conventional commits (feat:, fix:, docs:)
|
||||
- Atomic commits - one logical change per commit
|
||||
- Must align with guiding principles
|
||||
|
||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||
|
||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||
- **Natural Language First**: Everything in markdown, no code in core
|
||||
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
||||
@@ -702,12 +749,14 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
||||
### Available Expansion Packs
|
||||
|
||||
**Technical Packs**:
|
||||
|
||||
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
||||
- **Game Development**: Game designers, level designers, narrative writers
|
||||
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
||||
- **Data Science**: ML engineers, data scientists, visualization experts
|
||||
|
||||
**Non-Technical Packs**:
|
||||
|
||||
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
||||
- **Creative Writing**: Plot architects, character developers, world builders
|
||||
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
||||
@@ -715,6 +764,7 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
||||
- **Legal Support**: Contract analysts, compliance checkers
|
||||
|
||||
**Specialty Packs**:
|
||||
|
||||
- **Expansion Creator**: Tools to build your own expansion packs
|
||||
- **RPG Game Master**: Tabletop gaming assistance
|
||||
- **Life Event Planning**: Wedding planners, event coordinators
|
||||
@@ -724,11 +774,13 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
3. **Install via CLI**:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# Select "Install expansion pack" option
|
||||
```
|
||||
|
||||
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
||||
|
||||
### Creating Custom Expansion Packs
|
||||
|
||||
36
bmad-core/data/brainstorming-techniques.md
Normal file
36
bmad-core/data/brainstorming-techniques.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Brainstorming Techniques Data
|
||||
|
||||
## Creative Expansion
|
||||
|
||||
1. **What If Scenarios**: Ask one provocative question, get their response, then ask another
|
||||
2. **Analogical Thinking**: Give one example analogy, ask them to find 2-3 more
|
||||
3. **Reversal/Inversion**: Pose the reverse question, let them work through it
|
||||
4. **First Principles Thinking**: Ask "What are the fundamentals?" and guide them to break it down
|
||||
|
||||
## Structured Frameworks
|
||||
|
||||
5. **SCAMPER Method**: Go through one letter at a time, wait for their ideas before moving to next
|
||||
6. **Six Thinking Hats**: Present one hat, ask for their thoughts, then move to next hat
|
||||
7. **Mind Mapping**: Start with central concept, ask them to suggest branches
|
||||
|
||||
## Collaborative Techniques
|
||||
|
||||
8. **"Yes, And..." Building**: They give idea, you "yes and" it, they "yes and" back - alternate
|
||||
9. **Brainwriting/Round Robin**: They suggest idea, you build on it, ask them to build on yours
|
||||
10. **Random Stimulation**: Give one random prompt/word, ask them to make connections
|
||||
|
||||
## Deep Exploration
|
||||
|
||||
11. **Five Whys**: Ask "why" and wait for their answer before asking next "why"
|
||||
12. **Morphological Analysis**: Ask them to list parameters first, then explore combinations together
|
||||
13. **Provocation Technique (PO)**: Give one provocative statement, ask them to extract useful ideas
|
||||
|
||||
## Advanced Techniques
|
||||
|
||||
14. **Forced Relationships**: Connect two unrelated concepts and ask them to find the bridge
|
||||
15. **Assumption Reversal**: Challenge their core assumptions and ask them to build from there
|
||||
16. **Role Playing**: Ask them to brainstorm from different stakeholder perspectives
|
||||
17. **Time Shifting**: "How would you solve this in 1995? 2030?"
|
||||
18. **Resource Constraints**: "What if you had only $10 and 1 hour?"
|
||||
19. **Metaphor Mapping**: Use extended metaphors to explore solutions
|
||||
20. **Question Storming**: Generate questions instead of answers first
|
||||
134
bmad-core/data/elicitation-methods.md
Normal file
134
bmad-core/data/elicitation-methods.md
Normal file
@@ -0,0 +1,134 @@
|
||||
# Elicitation Methods Data
|
||||
|
||||
## Core Reflective Methods
|
||||
|
||||
**Expand or Contract for Audience**
|
||||
- Ask whether to 'expand' (add detail, elaborate) or 'contract' (simplify, clarify)
|
||||
- Identify specific target audience if relevant
|
||||
- Tailor content complexity and depth accordingly
|
||||
|
||||
**Explain Reasoning (CoT Step-by-Step)**
|
||||
- Walk through the step-by-step thinking process
|
||||
- Reveal underlying assumptions and decision points
|
||||
- Show how conclusions were reached from current role's perspective
|
||||
|
||||
**Critique and Refine**
|
||||
- Review output for flaws, inconsistencies, or improvement areas
|
||||
- Identify specific weaknesses from role's expertise
|
||||
- Suggest refined version reflecting domain knowledge
|
||||
|
||||
## Structural Analysis Methods
|
||||
|
||||
**Analyze Logical Flow and Dependencies**
|
||||
- Examine content structure for logical progression
|
||||
- Check internal consistency and coherence
|
||||
- Identify and validate dependencies between elements
|
||||
- Confirm effective ordering and sequencing
|
||||
|
||||
**Assess Alignment with Overall Goals**
|
||||
- Evaluate content contribution to stated objectives
|
||||
- Identify any misalignments or gaps
|
||||
- Interpret alignment from specific role's perspective
|
||||
- Suggest adjustments to better serve goals
|
||||
|
||||
## Risk and Challenge Methods
|
||||
|
||||
**Identify Potential Risks and Unforeseen Issues**
|
||||
- Brainstorm potential risks from role's expertise
|
||||
- Identify overlooked edge cases or scenarios
|
||||
- Anticipate unintended consequences
|
||||
- Highlight implementation challenges
|
||||
|
||||
**Challenge from Critical Perspective**
|
||||
- Adopt critical stance on current content
|
||||
- Play devil's advocate from specified viewpoint
|
||||
- Argue against proposal highlighting weaknesses
|
||||
- Apply YAGNI principles when appropriate (scope trimming)
|
||||
|
||||
## Creative Exploration Methods
|
||||
|
||||
**Tree of Thoughts Deep Dive**
|
||||
- Break problem into discrete "thoughts" or intermediate steps
|
||||
- Explore multiple reasoning paths simultaneously
|
||||
- Use self-evaluation to classify each path as "sure", "likely", or "impossible"
|
||||
- Apply search algorithms (BFS/DFS) to find optimal solution paths
|
||||
|
||||
**Hindsight is 20/20: The 'If Only...' Reflection**
|
||||
- Imagine retrospective scenario based on current content
|
||||
- Identify the one "if only we had known/done X..." insight
|
||||
- Describe imagined consequences humorously or dramatically
|
||||
- Extract actionable learnings for current context
|
||||
|
||||
## Multi-Persona Collaboration Methods
|
||||
|
||||
**Agile Team Perspective Shift**
|
||||
- Rotate through different Scrum team member viewpoints
|
||||
- Product Owner: Focus on user value and business impact
|
||||
- Scrum Master: Examine process flow and team dynamics
|
||||
- Developer: Assess technical implementation and complexity
|
||||
- QA: Identify testing scenarios and quality concerns
|
||||
|
||||
**Stakeholder Round Table**
|
||||
- Convene virtual meeting with multiple personas
|
||||
- Each persona contributes unique perspective on content
|
||||
- Identify conflicts and synergies between viewpoints
|
||||
- Synthesize insights into actionable recommendations
|
||||
|
||||
**Meta-Prompting Analysis**
|
||||
- Step back to analyze the structure and logic of current approach
|
||||
- Question the format and methodology being used
|
||||
- Suggest alternative frameworks or mental models
|
||||
- Optimize the elicitation process itself
|
||||
|
||||
## Advanced 2025 Techniques
|
||||
|
||||
**Self-Consistency Validation**
|
||||
- Generate multiple reasoning paths for same problem
|
||||
- Compare consistency across different approaches
|
||||
- Identify most reliable and robust solution
|
||||
- Highlight areas where approaches diverge and why
|
||||
|
||||
**ReWOO (Reasoning Without Observation)**
|
||||
- Separate parametric reasoning from tool-based actions
|
||||
- Create reasoning plan without external dependencies
|
||||
- Identify what can be solved through pure reasoning
|
||||
- Optimize for efficiency and reduced token usage
|
||||
|
||||
**Persona-Pattern Hybrid**
|
||||
- Combine specific role expertise with elicitation pattern
|
||||
- Architect + Risk Analysis: Deep technical risk assessment
|
||||
- UX Expert + User Journey: End-to-end experience critique
|
||||
- PM + Stakeholder Analysis: Multi-perspective impact review
|
||||
|
||||
**Emergent Collaboration Discovery**
|
||||
- Allow multiple perspectives to naturally emerge
|
||||
- Identify unexpected insights from persona interactions
|
||||
- Explore novel combinations of viewpoints
|
||||
- Capture serendipitous discoveries from multi-agent thinking
|
||||
|
||||
## Game-Based Elicitation Methods
|
||||
|
||||
**Red Team vs Blue Team**
|
||||
- Red Team: Attack the proposal, find vulnerabilities
|
||||
- Blue Team: Defend and strengthen the approach
|
||||
- Competitive analysis reveals blind spots
|
||||
- Results in more robust, battle-tested solutions
|
||||
|
||||
**Innovation Tournament**
|
||||
- Pit multiple alternative approaches against each other
|
||||
- Score each approach across different criteria
|
||||
- Crowd-source evaluation from different personas
|
||||
- Identify winning combination of features
|
||||
|
||||
**Escape Room Challenge**
|
||||
- Present content as constraints to work within
|
||||
- Find creative solutions within tight limitations
|
||||
- Identify minimum viable approach
|
||||
- Discover innovative workarounds and optimizations
|
||||
|
||||
## Process Control
|
||||
|
||||
**Proceed / No Further Actions**
|
||||
- Acknowledge choice to finalize current work
|
||||
- Accept output as-is or move to next step
|
||||
- Prepare to continue without additional elicitation
|
||||
@@ -5,88 +5,113 @@
|
||||
- Provide optional reflective and brainstorming actions to enhance content quality
|
||||
- Enable deeper exploration of ideas through structured elicitation techniques
|
||||
- Support iterative refinement through multiple analytical perspectives
|
||||
- Usable during template-driven document creation or any chat conversation
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Template Document Creation
|
||||
|
||||
After outputting a section during document creation:
|
||||
|
||||
1. **Section Review**: Ask user to review the drafted section
|
||||
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
||||
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
||||
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
||||
|
||||
### Scenario 2: General Chat Elicitation
|
||||
|
||||
User can request advanced elicitation on any agent output:
|
||||
|
||||
- User says "do advanced elicitation" or similar
|
||||
- Agent selects 9 relevant methods for the context
|
||||
- Same simple 0-9 selection process
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Section Context and Review
|
||||
### 1. Intelligent Method Selection
|
||||
|
||||
[[LLM: When invoked after outputting a section:
|
||||
**Context Analysis**: Before presenting options, analyze:
|
||||
|
||||
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
|
||||
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
||||
- **Complexity Level**: Simple, moderate, or complex content
|
||||
- **Stakeholder Needs**: Who will use this information
|
||||
- **Risk Level**: High-impact decisions vs routine items
|
||||
- **Creative Potential**: Opportunities for innovation or alternatives
|
||||
|
||||
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
|
||||
**Method Selection Strategy**:
|
||||
|
||||
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
|
||||
1. **Always Include Core Methods** (choose 3-4):
|
||||
- Expand or Contract for Audience
|
||||
- Critique and Refine
|
||||
- Identify Potential Risks
|
||||
- Assess Alignment with Goals
|
||||
|
||||
2. **Context-Specific Methods** (choose 4-5):
|
||||
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
||||
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
||||
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
||||
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
||||
|
||||
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
||||
|
||||
### 2. Section Context and Review
|
||||
|
||||
When invoked after outputting a section:
|
||||
|
||||
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
||||
|
||||
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
||||
|
||||
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
||||
- The entire section as a whole
|
||||
- Individual items within the section (specify which item when selecting an action)
|
||||
|
||||
4. Then present the action list as specified below.]]
|
||||
### 3. Present Elicitation Options
|
||||
|
||||
### 2. Ask for Review and Present Action List
|
||||
**Review Request Process:**
|
||||
|
||||
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
|
||||
- Ask the user to review the drafted section
|
||||
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
||||
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
||||
- Keep descriptions short - just the method name
|
||||
- Await simple numeric selection
|
||||
|
||||
**Present the numbered list (0-9) with this exact format:**
|
||||
**Action List Presentation Format:**
|
||||
|
||||
```text
|
||||
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
||||
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
||||
**Advanced Elicitation Options**
|
||||
Choose a number (0-8) or 9 to proceed:
|
||||
|
||||
0. Expand or Contract for Audience
|
||||
1. Explain Reasoning (CoT Step-by-Step)
|
||||
2. Critique and Refine
|
||||
3. Analyze Logical Flow and Dependencies
|
||||
4. Assess Alignment with Overall Goals
|
||||
5. Identify Potential Risks and Unforeseen Issues
|
||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
||||
0. [Method Name]
|
||||
1. [Method Name]
|
||||
2. [Method Name]
|
||||
3. [Method Name]
|
||||
4. [Method Name]
|
||||
5. [Method Name]
|
||||
6. [Method Name]
|
||||
7. [Method Name]
|
||||
8. [Method Name]
|
||||
9. Proceed / No Further Actions
|
||||
```
|
||||
|
||||
### 2. Processing Guidelines
|
||||
**Response Handling:**
|
||||
|
||||
**Do NOT show:**
|
||||
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
||||
- **Number 9**: Proceed to next section or continue conversation
|
||||
- **Direct Feedback**: Apply user's suggested changes and continue
|
||||
|
||||
- The full protocol text with `[[LLM: ...]]` instructions
|
||||
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
||||
- Any internal template markup
|
||||
### 4. Method Execution Framework
|
||||
|
||||
**After user selection from the list:**
|
||||
**Execution Process:**
|
||||
|
||||
- Execute the chosen action according to the protocol instructions below
|
||||
- Ask if they want to select another action or proceed with option 9 once complete
|
||||
- Continue until user selects option 9 or indicates completion
|
||||
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
||||
2. **Apply Context**: Execute the method from your current role's perspective
|
||||
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
||||
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
||||
|
||||
## Action Definitions
|
||||
**Execution Guidelines:**
|
||||
|
||||
0. Expand or Contract for Audience
|
||||
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
||||
|
||||
1. Explain Reasoning (CoT Step-by-Step)
|
||||
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
|
||||
|
||||
2. Critique and Refine
|
||||
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
||||
|
||||
3. Analyze Logical Flow and Dependencies
|
||||
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
||||
|
||||
4. Assess Alignment with Overall Goals
|
||||
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
|
||||
|
||||
5. Identify Potential Risks and Unforeseen Issues
|
||||
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
||||
|
||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
||||
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
|
||||
|
||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
||||
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
||||
|
||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
||||
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
|
||||
|
||||
9. Proceed / No Further Actions
|
||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
||||
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
||||
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
||||
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
||||
- **Maintain Flow**: Keep the process moving efficiently
|
||||
|
||||
@@ -1,238 +0,0 @@
|
||||
# Brainstorming Techniques Task
|
||||
|
||||
This task provides a comprehensive toolkit of creative brainstorming techniques for ideation and innovative thinking. The analyst can use these techniques to facilitate productive brainstorming sessions with users.
|
||||
|
||||
## Process
|
||||
|
||||
### 1. Session Setup
|
||||
|
||||
[[LLM: Begin by understanding the brainstorming context and goals. Ask clarifying questions if needed to determine the best approach.]]
|
||||
|
||||
1. **Establish Context**
|
||||
|
||||
- Understand the problem space or opportunity area
|
||||
- Identify any constraints or parameters
|
||||
- Determine session goals (divergent exploration vs. focused ideation)
|
||||
|
||||
2. **Select Technique Approach**
|
||||
- Option A: User selects specific techniques
|
||||
- Option B: Analyst recommends techniques based on context
|
||||
- Option C: Random technique selection for creative variety
|
||||
- Option D: Progressive technique flow (start broad, narrow down)
|
||||
|
||||
### 2. Core Brainstorming Techniques
|
||||
|
||||
#### Creative Expansion Techniques
|
||||
|
||||
1. **"What If" Scenarios**
|
||||
[[LLM: Generate provocative what-if questions that challenge assumptions and expand thinking beyond current limitations.]]
|
||||
|
||||
- What if we had unlimited resources?
|
||||
- What if this problem didn't exist?
|
||||
- What if we approached this from a child's perspective?
|
||||
- What if we had to solve this in 24 hours?
|
||||
|
||||
2. **Analogical Thinking**
|
||||
[[LLM: Help user draw parallels between their challenge and other domains, industries, or natural systems.]]
|
||||
|
||||
- "How might this work like [X] but for [Y]?"
|
||||
- Nature-inspired solutions (biomimicry)
|
||||
- Cross-industry pattern matching
|
||||
- Historical precedent analysis
|
||||
|
||||
3. **Reversal/Inversion**
|
||||
[[LLM: Flip the problem or approach it from the opposite angle to reveal new insights.]]
|
||||
|
||||
- What if we did the exact opposite?
|
||||
- How could we make this problem worse? (then reverse)
|
||||
- Start from the end goal and work backward
|
||||
- Reverse roles or perspectives
|
||||
|
||||
4. **First Principles Thinking**
|
||||
[[LLM: Break down to fundamental truths and rebuild from scratch.]]
|
||||
- What are the absolute fundamentals here?
|
||||
- What assumptions can we challenge?
|
||||
- If we started from zero, what would we build?
|
||||
- What laws of physics/economics/human nature apply?
|
||||
|
||||
#### Structured Ideation Frameworks
|
||||
|
||||
1. **SCAMPER Method**
|
||||
[[LLM: Guide through each SCAMPER prompt systematically.]]
|
||||
|
||||
- **S** = Substitute: What can be substituted?
|
||||
- **C** = Combine: What can be combined or integrated?
|
||||
- **A** = Adapt: What can be adapted from elsewhere?
|
||||
- **M** = Modify/Magnify: What can be emphasized or reduced?
|
||||
- **P** = Put to other uses: What else could this be used for?
|
||||
- **E** = Eliminate: What can be removed or simplified?
|
||||
- **R**= Reverse/Rearrange: What can be reversed or reordered?
|
||||
|
||||
2. **Six Thinking Hats**
|
||||
[[LLM: Cycle through different thinking modes, spending focused time in each.]]
|
||||
|
||||
- White Hat: Facts and information
|
||||
- Red Hat: Emotions and intuition
|
||||
- Black Hat: Caution and critical thinking
|
||||
- Yellow Hat: Optimism and benefits
|
||||
- Green Hat: Creativity and alternatives
|
||||
- Blue Hat: Process and control
|
||||
|
||||
3. **Mind Mapping**
|
||||
[[LLM: Create text-based mind maps with clear hierarchical structure.]]
|
||||
|
||||
```plaintext
|
||||
Central Concept
|
||||
├── Branch 1
|
||||
│ ├── Sub-idea 1.1
|
||||
│ └── Sub-idea 1.2
|
||||
├── Branch 2
|
||||
│ ├── Sub-idea 2.1
|
||||
│ └── Sub-idea 2.2
|
||||
└── Branch 3
|
||||
└── Sub-idea 3.1
|
||||
```
|
||||
|
||||
#### Collaborative Techniques
|
||||
|
||||
1. **"Yes, And..." Building**
|
||||
[[LLM: Accept every idea and build upon it without judgment. Encourage wild ideas and defer criticism.]]
|
||||
|
||||
- Accept the premise of each idea
|
||||
- Add to it with "Yes, and..."
|
||||
- Build chains of connected ideas
|
||||
- Explore tangents freely
|
||||
|
||||
2. **Brainwriting/Round Robin**
|
||||
[[LLM: Simulate multiple perspectives by generating ideas from different viewpoints.]]
|
||||
|
||||
- Generate ideas from stakeholder perspectives
|
||||
- Build on previous ideas in rounds
|
||||
- Combine unrelated ideas
|
||||
- Cross-pollinate concepts
|
||||
|
||||
3. **Random Stimulation**
|
||||
[[LLM: Use random words, images, or concepts as creative triggers.]]
|
||||
- Random word association
|
||||
- Picture/metaphor inspiration
|
||||
- Forced connections between unrelated items
|
||||
- Constraint-based creativity
|
||||
|
||||
#### Deep Exploration Techniques
|
||||
|
||||
1. **Five Whys**
|
||||
[[LLM: Dig deeper into root causes and underlying motivations.]]
|
||||
|
||||
- Why does this problem exist? → Answer → Why? (repeat 5 times)
|
||||
- Uncover hidden assumptions
|
||||
- Find root causes, not symptoms
|
||||
- Identify intervention points
|
||||
|
||||
2. **Morphological Analysis**
|
||||
[[LLM: Break down into parameters and systematically explore combinations.]]
|
||||
|
||||
- List key parameters/dimensions
|
||||
- Identify possible values for each
|
||||
- Create combination matrix
|
||||
- Explore unusual combinations
|
||||
|
||||
3. **Provocation Technique (PO)**
|
||||
[[LLM: Make deliberately provocative statements to jar thinking.]]
|
||||
- PO: Cars have square wheels
|
||||
- PO: Customers pay us to take products
|
||||
- PO: The problem solves itself
|
||||
- Extract useful ideas from provocations
|
||||
|
||||
### 3. Technique Selection Guide
|
||||
|
||||
[[LLM: Help user select appropriate techniques based on their needs.]]
|
||||
|
||||
**For Initial Exploration:**
|
||||
|
||||
- What If Scenarios
|
||||
- First Principles
|
||||
- Mind Mapping
|
||||
|
||||
**For Stuck/Blocked Thinking:**
|
||||
|
||||
- Random Stimulation
|
||||
- Reversal/Inversion
|
||||
- Provocation Technique
|
||||
|
||||
**For Systematic Coverage:**
|
||||
|
||||
- SCAMPER
|
||||
- Morphological Analysis
|
||||
- Six Thinking Hats
|
||||
|
||||
**For Deep Understanding:**
|
||||
|
||||
- Five Whys
|
||||
- Analogical Thinking
|
||||
- First Principles
|
||||
|
||||
**For Team/Collaborative Settings:**
|
||||
|
||||
- Brainwriting
|
||||
- "Yes, And..."
|
||||
- Six Thinking Hats
|
||||
|
||||
### 4. Session Flow Management
|
||||
|
||||
[[LLM: Guide the brainstorming session with appropriate pacing and technique transitions.]]
|
||||
|
||||
1. **Warm-up Phase** (5-10 min)
|
||||
|
||||
- Start with accessible techniques
|
||||
- Build creative confidence
|
||||
- Establish "no judgment" atmosphere
|
||||
|
||||
2. **Divergent Phase** (20-30 min)
|
||||
|
||||
- Use expansion techniques
|
||||
- Generate quantity over quality
|
||||
- Encourage wild ideas
|
||||
|
||||
3. **Convergent Phase** (15-20 min)
|
||||
|
||||
- Group and categorize ideas
|
||||
- Identify patterns and themes
|
||||
- Select promising directions
|
||||
|
||||
4. **Synthesis Phase** (10-15 min)
|
||||
- Combine complementary ideas
|
||||
- Refine and develop concepts
|
||||
- Prepare summary of insights
|
||||
|
||||
### 5. Output Format
|
||||
|
||||
[[LLM: Present brainstorming results in an organized, actionable format.]]
|
||||
|
||||
**Session Summary:**
|
||||
|
||||
- Techniques used
|
||||
- Number of ideas generated
|
||||
- Key themes identified
|
||||
|
||||
**Idea Categories:**
|
||||
|
||||
1. **Immediate Opportunities** - Ideas that could be implemented now
|
||||
2. **Future Innovations** - Ideas requiring more development
|
||||
3. **Moonshots** - Ambitious, transformative ideas
|
||||
4. **Insights & Learnings** - Key realizations from the session
|
||||
|
||||
**Next Steps:**
|
||||
|
||||
- Which ideas to explore further
|
||||
- Recommended follow-up techniques
|
||||
- Suggested research areas
|
||||
|
||||
## Important Notes
|
||||
|
||||
- Maintain energy and momentum throughout the session
|
||||
- Defer judgment - all ideas are valid during generation
|
||||
- Quantity leads to quality - aim for many ideas
|
||||
- Build on ideas collaboratively
|
||||
- Document everything - even "silly" ideas can spark breakthroughs
|
||||
- Take breaks if energy flags
|
||||
- End with clear next actions
|
||||
136
bmad-core/tasks/facilitate-brainstorming-session.md
Normal file
136
bmad-core/tasks/facilitate-brainstorming-session.md
Normal file
@@ -0,0 +1,136 @@
|
||||
---
|
||||
docOutputLocation: docs/brainstorming-session-results.md
|
||||
template: brainstorming-output-tmpl
|
||||
---
|
||||
|
||||
# Facilitate Brainstorming Session Task
|
||||
|
||||
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
||||
|
||||
## Process
|
||||
|
||||
### Step 1: Session Setup
|
||||
|
||||
Ask 4 context questions (don't preview what happens next):
|
||||
|
||||
1. What are we brainstorming about?
|
||||
2. Any constraints or parameters?
|
||||
3. Goal: broad exploration or focused ideation?
|
||||
4. Do you want a structured document output to reference later? (Y/N)
|
||||
|
||||
### Step 2: Present Approach Options
|
||||
|
||||
After getting answers to Step 1, present 4 approach options (numbered):
|
||||
|
||||
1. User selects specific techniques
|
||||
2. Analyst recommends techniques based on context
|
||||
3. Random technique selection for creative variety
|
||||
4. Progressive technique flow (start broad, narrow down)
|
||||
|
||||
### Step 3: Execute Techniques Interactively
|
||||
|
||||
**KEY PRINCIPLES:**
|
||||
|
||||
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
||||
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
||||
- **CAPTURE OUTPUT**: If document output requested, capture all ideas generated in each technique section
|
||||
|
||||
**Technique Selection:**
|
||||
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number (e.g., "7" for Mind Mapping).
|
||||
|
||||
**Technique Execution:**
|
||||
|
||||
1. Apply selected technique according to data file description
|
||||
2. Keep engaging with technique until user indicates they want to:
|
||||
- Choose a different technique
|
||||
- Apply current ideas to a new technique
|
||||
- Move to convergent phase
|
||||
- End session
|
||||
|
||||
**Output Capture (if requested):**
|
||||
For each technique used, capture:
|
||||
|
||||
- Technique name and duration
|
||||
- Key ideas generated by user
|
||||
- Insights and patterns identified
|
||||
- User's reflections on the process
|
||||
|
||||
### Step 4: Session Flow
|
||||
|
||||
1. **Warm-up** (5-10 min) - Build creative confidence
|
||||
2. **Divergent** (20-30 min) - Generate quantity over quality
|
||||
3. **Convergent** (15-20 min) - Group and categorize ideas
|
||||
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
||||
|
||||
### Step 5: Document Output (if requested)
|
||||
|
||||
Generate structured document with these sections:
|
||||
|
||||
**Executive Summary**
|
||||
|
||||
- Session topic and goals
|
||||
- Techniques used and duration
|
||||
- Total ideas generated
|
||||
- Key themes and patterns identified
|
||||
|
||||
**Technique Sections** (for each technique used)
|
||||
|
||||
- Technique name and description
|
||||
- Ideas generated (user's own words)
|
||||
- Insights discovered
|
||||
- Notable connections or patterns
|
||||
|
||||
**Idea Categorization**
|
||||
|
||||
- **Immediate Opportunities** - Ready to implement now
|
||||
- **Future Innovations** - Requires development/research
|
||||
- **Moonshots** - Ambitious, transformative concepts
|
||||
- **Insights & Learnings** - Key realizations from session
|
||||
|
||||
**Action Planning**
|
||||
|
||||
- Top 3 priority ideas with rationale
|
||||
- Next steps for each priority
|
||||
- Resources/research needed
|
||||
- Timeline considerations
|
||||
|
||||
**Reflection & Follow-up**
|
||||
|
||||
- What worked well in this session
|
||||
- Areas for further exploration
|
||||
- Recommended follow-up techniques
|
||||
- Questions that emerged for future sessions
|
||||
|
||||
## Key Principles
|
||||
|
||||
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them
|
||||
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
||||
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
||||
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
||||
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
||||
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
||||
- Maintain energy and momentum
|
||||
- Defer judgment during generation
|
||||
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
||||
- Build on ideas collaboratively
|
||||
- Document everything if output requested
|
||||
|
||||
## Advanced Engagement Strategies
|
||||
|
||||
**Energy Management**
|
||||
|
||||
- Check engagement levels: "How are you feeling about this direction?"
|
||||
- Offer breaks or technique switches if energy flags
|
||||
- Use encouraging language and celebrate idea generation
|
||||
|
||||
**Depth vs. Breadth**
|
||||
|
||||
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
||||
- Use "Yes, and..." to build on their ideas
|
||||
- Help them make connections: "How does this relate to your earlier idea about...?"
|
||||
|
||||
**Transition Management**
|
||||
|
||||
- Always ask before switching techniques: "Ready to try a different approach?"
|
||||
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
||||
- Respect their process and timing
|
||||
@@ -1,776 +0,0 @@
|
||||
# {{Project Name}} Architecture Document
|
||||
|
||||
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
||||
|
||||
## Introduction
|
||||
|
||||
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
This document outlines the overall project architecture for {{Project Name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
||||
|
||||
**Relationship to Frontend Architecture:**
|
||||
If the project includes a significant user interface, a separate Frontend Architecture Document will detail the frontend-specific design and MUST be used in conjunction with this document. Core technology stack choices documented herein (see "Tech Stack") are definitive for the entire project, including any frontend components.
|
||||
|
||||
### Starter Template or Existing Project
|
||||
|
||||
[[LLM: Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase:
|
||||
|
||||
1. Review the PRD and brainstorming brief for any mentions of:
|
||||
|
||||
- Starter templates (e.g., Create React App, Next.js, Vue CLI, Angular CLI, etc.)
|
||||
- Existing projects or codebases being used as a foundation
|
||||
- Boilerplate projects or scaffolding tools
|
||||
- Previous projects to be cloned or adapted
|
||||
|
||||
2. If a starter template or existing project is mentioned:
|
||||
|
||||
- Ask the user to provide access via one of these methods:
|
||||
- Link to the starter template documentation
|
||||
- Upload/attach the project files (for small projects)
|
||||
- Share a link to the project repository (GitHub, GitLab, etc.)
|
||||
- Analyze the starter/existing project to understand:
|
||||
- Pre-configured technology stack and versions
|
||||
- Project structure and organization patterns
|
||||
- Built-in scripts and tooling
|
||||
- Existing architectural patterns and conventions
|
||||
- Any limitations or constraints imposed by the starter
|
||||
- Use this analysis to inform and align your architecture decisions
|
||||
|
||||
3. If no starter template is mentioned but this is a greenfield project:
|
||||
|
||||
- Suggest appropriate starter templates based on the tech stack preferences
|
||||
- Explain the benefits (faster setup, best practices, community support)
|
||||
- Let the user decide whether to use one
|
||||
|
||||
4. If the user confirms no starter template will be used:
|
||||
|
||||
- Proceed with architecture design from scratch
|
||||
- Note that manual setup will be required for all tooling and configuration
|
||||
|
||||
Document the decision here before proceeding with the architecture design. In none, just say N/A
|
||||
|
||||
After presenting this starter template section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## High Level Architecture
|
||||
|
||||
[[LLM: This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together (Introduction, Technical Summary, High Level Overview, Project Diagram, and Architectural Patterns), then apply `tasks#advanced-elicitation` protocol to the complete High Level Architecture section. The user can choose to refine the entire section or specific subsections.]]
|
||||
|
||||
### Technical Summary
|
||||
|
||||
[[LLM: Provide a brief paragraph (3-5 sentences) overview of:
|
||||
|
||||
- The system's overall architecture style
|
||||
- Key components and their relationships
|
||||
- Primary technology choices
|
||||
- Core architectural patterns being used
|
||||
- Reference back to the PRD goals and how this architecture supports them]]
|
||||
|
||||
### High Level Overview
|
||||
|
||||
[[LLM: Based on the PRD's Technical Assumptions section, describe:
|
||||
|
||||
1. The main architectural style (e.g., Monolith, Microservices, Serverless, Event-Driven)
|
||||
2. Repository structure decision from PRD (Monorepo/Polyrepo)
|
||||
3. Service architecture decision from PRD
|
||||
4. Primary user interaction flow or data flow at a conceptual level
|
||||
5. Key architectural decisions and their rationale
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### High Level Project Diagram
|
||||
|
||||
[[LLM: Create a Mermaid diagram that visualizes the high-level architecture. Consider:
|
||||
|
||||
- System boundaries
|
||||
- Major components/services
|
||||
- Data flow directions
|
||||
- External integrations
|
||||
- User entry points
|
||||
|
||||
Use appropriate Mermaid diagram type (graph TD, C4, sequence) based on what best represents the architecture
|
||||
|
||||
After presenting the diagram, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Architectural and Design Patterns
|
||||
|
||||
[[LLM: List the key high-level patterns that will guide the architecture. For each pattern:
|
||||
|
||||
1. Present 2-3 viable options if multiple exist
|
||||
2. Provide your recommendation with clear rationale
|
||||
3. Get user confirmation before finalizing
|
||||
4. These patterns should align with the PRD's technical assumptions and project goals
|
||||
|
||||
Common patterns to consider:
|
||||
|
||||
- Architectural style patterns (Serverless, Event-Driven, Microservices, CQRS, Hexagonal)
|
||||
- Code organization patterns (Dependency Injection, Repository, Module, Factory)
|
||||
- Data patterns (Event Sourcing, Saga, Database per Service)
|
||||
- Communication patterns (REST, GraphQL, Message Queue, Pub/Sub)]]
|
||||
|
||||
<<REPEAT: pattern>>
|
||||
|
||||
- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: patterns}
|
||||
|
||||
- **Serverless Architecture:** Using AWS Lambda for compute - _Rationale:_ Aligns with PRD requirement for cost optimization and automatic scaling
|
||||
- **Repository Pattern:** Abstract data access logic - _Rationale:_ Enables testing and future database migration flexibility
|
||||
- **Event-Driven Communication:** Using SNS/SQS for service decoupling - _Rationale:_ Supports async processing and system resilience
|
||||
|
||||
@{/example}
|
||||
|
||||
[[LLM: After presenting the patterns, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Tech Stack
|
||||
|
||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||
|
||||
1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences`
|
||||
2. For each category, present 2-3 viable options with pros/cons
|
||||
3. Make a clear recommendation based on project needs
|
||||
4. Get explicit user approval for each selection
|
||||
5. Document exact versions (avoid "latest" - pin specific versions)
|
||||
6. This table is the single source of truth - all other docs must reference these choices
|
||||
|
||||
Key decisions to finalize - before displaying the table, ensure you are aware of or ask the user about - let the user know if they are not sure on any that you can also provide suggestions with rationale:
|
||||
|
||||
- Starter templates (if any)
|
||||
- Languages and runtimes with exact versions
|
||||
- Frameworks and libraries / packages
|
||||
- Cloud provider and key services choices
|
||||
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
||||
- Development tools
|
||||
|
||||
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away apply `tasks#advanced-elicitation` display - this statement and the options should be rendered and then prompt right all before allowing user input.]]
|
||||
|
||||
### Cloud Infrastructure
|
||||
|
||||
- **Provider:** {{cloud_provider}}
|
||||
- **Key Services:** {{core_services_list}}
|
||||
- **Deployment Regions:** {{regions}}
|
||||
|
||||
### Technology Stack Table
|
||||
|
||||
| Category | Technology | Version | Purpose | Rationale |
|
||||
| :----------------- | :----------------- | :---------- | :---------- | :------------- |
|
||||
| **Language** | {{language}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Runtime** | {{runtime}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Framework** | {{framework}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Database** | {{database}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Cache** | {{cache}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Message Queue** | {{queue}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **API Style** | {{api_style}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Authentication** | {{auth}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Testing** | {{test_framework}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Build Tool** | {{build_tool}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **IaC Tool** | {{iac_tool}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Monitoring** | {{monitoring}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Logging** | {{logging}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
|
||||
@{example: tech_stack_row}
|
||||
| **Language** | TypeScript | 5.3.3 | Primary development language | Strong typing, excellent tooling, team expertise |
|
||||
| **Runtime** | Node.js | 20.11.0 | JavaScript runtime | LTS version, stable performance, wide ecosystem |
|
||||
| **Framework** | NestJS | 10.3.2 | Backend framework | Enterprise-ready, good DI, matches team patterns |
|
||||
@{/example}
|
||||
|
||||
## Data Models
|
||||
|
||||
[[LLM: Define the core data models/entities:
|
||||
|
||||
1. Review PRD requirements and identify key business entities
|
||||
2. For each model, explain its purpose and relationships
|
||||
3. Include key attributes and data types
|
||||
4. Show relationships between models
|
||||
5. Discuss design decisions with user
|
||||
|
||||
Create a clear conceptual model before moving to database schema.
|
||||
|
||||
After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
<<REPEAT: data_model>>
|
||||
|
||||
### {{model_name}}
|
||||
|
||||
**Purpose:** {{model_purpose}}
|
||||
|
||||
**Key Attributes:**
|
||||
|
||||
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
||||
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
||||
|
||||
**Relationships:**
|
||||
|
||||
- {{relationship_1}}
|
||||
- {{relationship_2}}
|
||||
<</REPEAT>>
|
||||
|
||||
## Components
|
||||
|
||||
[[LLM: Based on the architectural patterns, tech stack, and data models from above:
|
||||
|
||||
1. Identify major logical components/services and their responsibilities
|
||||
2. Consider the repository structure (monorepo/polyrepo) from PRD
|
||||
3. Define clear boundaries and interfaces between components
|
||||
4. For each component, specify:
|
||||
|
||||
- Primary responsibility
|
||||
- Key interfaces/APIs exposed
|
||||
- Dependencies on other components
|
||||
- Technology specifics based on tech stack choices
|
||||
|
||||
5. Create component diagrams where helpful
|
||||
6. After presenting all components, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
<<REPEAT: component>>
|
||||
|
||||
### {{component_name}}
|
||||
|
||||
**Responsibility:** {{component_description}}
|
||||
|
||||
**Key Interfaces:**
|
||||
|
||||
- {{interface_1}}
|
||||
- {{interface_2}}
|
||||
|
||||
**Dependencies:** {{dependencies}}
|
||||
|
||||
**Technology Stack:** {{component_tech_details}}
|
||||
<</REPEAT>>
|
||||
|
||||
### Component Diagrams
|
||||
|
||||
[[LLM: Create Mermaid diagrams to visualize component relationships. Options:
|
||||
|
||||
- C4 Container diagram for high-level view
|
||||
- Component diagram for detailed internal structure
|
||||
- Sequence diagrams for complex interactions
|
||||
Choose the most appropriate for clarity
|
||||
|
||||
After presenting the diagrams, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## External APIs
|
||||
|
||||
[[LLM: For each external service integration:
|
||||
|
||||
1. Identify APIs needed based on PRD requirements and component design
|
||||
2. If documentation URLs are unknown, ask user for specifics
|
||||
3. Document authentication methods and security considerations
|
||||
4. List specific endpoints that will be used
|
||||
5. Note any rate limits or usage constraints
|
||||
|
||||
If no external APIs are needed, state this explicitly and skip to next section.]]
|
||||
|
||||
^^CONDITION: has_external_apis^^
|
||||
|
||||
<<REPEAT: external_api>>
|
||||
|
||||
### {{api_name}} API
|
||||
|
||||
- **Purpose:** {{api_purpose}}
|
||||
- **Documentation:** {{api_docs_url}}
|
||||
- **Base URL(s):** {{api_base_url}}
|
||||
- **Authentication:** {{auth_method}}
|
||||
- **Rate Limits:** {{rate_limits}}
|
||||
|
||||
**Key Endpoints Used:**
|
||||
<<REPEAT: endpoint>>
|
||||
|
||||
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
||||
<</REPEAT>>
|
||||
|
||||
**Integration Notes:** {{integration_considerations}}
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: external_api}
|
||||
|
||||
### Stripe API
|
||||
|
||||
- **Purpose:** Payment processing and subscription management
|
||||
- **Documentation:** https://stripe.com/docs/api
|
||||
- **Base URL(s):** `https://api.stripe.com/v1`
|
||||
- **Authentication:** Bearer token with secret key
|
||||
- **Rate Limits:** 100 requests per second
|
||||
|
||||
**Key Endpoints Used:**
|
||||
|
||||
- `POST /customers` - Create customer profiles
|
||||
- `POST /payment_intents` - Process payments
|
||||
- `POST /subscriptions` - Manage subscriptions
|
||||
@{/example}
|
||||
|
||||
^^/CONDITION: has_external_apis^^
|
||||
|
||||
[[LLM: After presenting external APIs (or noting their absence), apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Core Workflows
|
||||
|
||||
[[LLM: Illustrate key system workflows using sequence diagrams:
|
||||
|
||||
1. Identify critical user journeys from PRD
|
||||
2. Show component interactions including external APIs
|
||||
3. Include error handling paths
|
||||
4. Document async operations
|
||||
5. Create both high-level and detailed diagrams as needed
|
||||
|
||||
Focus on workflows that clarify architecture decisions or complex interactions.
|
||||
|
||||
After presenting the workflow diagrams, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## REST API Spec
|
||||
|
||||
[[LLM: If the project includes a REST API:
|
||||
|
||||
1. Create an OpenAPI 3.0 specification
|
||||
2. Include all endpoints from epics/stories
|
||||
3. Define request/response schemas based on data models
|
||||
4. Document authentication requirements
|
||||
5. Include example requests/responses
|
||||
|
||||
Use YAML format for better readability. If no REST API, skip this section.]]
|
||||
|
||||
^^CONDITION: has_rest_api^^
|
||||
|
||||
```yaml
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title:
|
||||
'[object Object]': null
|
||||
version:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
servers:
|
||||
- url:
|
||||
'[object Object]': null
|
||||
description:
|
||||
'[object Object]': null
|
||||
```
|
||||
|
||||
^^/CONDITION: has_rest_api^^
|
||||
|
||||
[[LLM: After presenting the REST API spec (or noting its absence if not applicable), apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Database Schema
|
||||
|
||||
[[LLM: Transform the conceptual data models into concrete database schemas:
|
||||
|
||||
1. Use the database type(s) selected in Tech Stack
|
||||
2. Create schema definitions using appropriate notation
|
||||
3. Include indexes, constraints, and relationships
|
||||
4. Consider performance and scalability
|
||||
5. For NoSQL, show document structures
|
||||
|
||||
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
||||
|
||||
After presenting the database schema, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Source Tree
|
||||
|
||||
[[LLM: Create a project folder structure that reflects:
|
||||
|
||||
1. The chosen repository structure (monorepo/polyrepo)
|
||||
2. The service architecture (monolith/microservices/serverless)
|
||||
3. The selected tech stack and languages
|
||||
4. Component organization from above
|
||||
5. Best practices for the chosen frameworks
|
||||
6. Clear separation of concerns
|
||||
|
||||
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
||||
|
||||
After presenting the structure, apply `tasks#advanced-elicitation` protocol to refine based on user feedback.]]
|
||||
|
||||
```plaintext
|
||||
{{project-root}}/
|
||||
├── .github/ # CI/CD workflows
|
||||
│ └── workflows/
|
||||
│ └── main.yaml
|
||||
├── .vscode/ # VSCode settings (optional)
|
||||
│ └── settings.json
|
||||
├── build/ # Compiled output (git-ignored)
|
||||
├── config/ # Configuration files
|
||||
├── docs/ # Project documentation
|
||||
│ ├── PRD.md
|
||||
│ ├── architecture.md
|
||||
│ └── ...
|
||||
├── infra/ # Infrastructure as Code
|
||||
│ └── {{iac-structure}}
|
||||
├── {{dependencies-dir}}/ # Dependencies (git-ignored)
|
||||
├── scripts/ # Utility scripts
|
||||
├── src/ # Application source code
|
||||
│ └── {{source-structure}}
|
||||
├── tests/ # Test files
|
||||
│ ├── unit/
|
||||
│ ├── integration/
|
||||
│ └── e2e/
|
||||
├── .env.example # Environment variables template
|
||||
├── .gitignore # Git ignore rules
|
||||
├── {{package-manifest}} # Dependencies manifest
|
||||
├── {{config-files}} # Language/framework configs
|
||||
└── README.md # Project documentation
|
||||
|
||||
@{example: monorepo-structure}
|
||||
project-root/
|
||||
├── packages/
|
||||
│ ├── api/ # Backend API service
|
||||
│ ├── web/ # Frontend application
|
||||
│ ├── shared/ # Shared utilities/types
|
||||
│ └── infrastructure/ # IaC definitions
|
||||
├── scripts/ # Monorepo management scripts
|
||||
└── package.json # Root package.json with workspaces
|
||||
@{/example}
|
||||
```
|
||||
|
||||
[[LLM: After presenting the source tree structure, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Infrastructure and Deployment
|
||||
|
||||
[[LLM: Define the deployment architecture and practices:
|
||||
|
||||
1. Use IaC tool selected in Tech Stack
|
||||
2. Choose deployment strategy appropriate for the architecture
|
||||
3. Define environments and promotion flow
|
||||
4. Establish rollback procedures
|
||||
5. Consider security, monitoring, and cost optimization
|
||||
|
||||
Get user input on deployment preferences and CI/CD tool choices.]]
|
||||
|
||||
### Infrastructure as Code
|
||||
|
||||
- **Tool:** {{iac_tool}} {{version}}
|
||||
- **Location:** `{{iac_directory}}`
|
||||
- **Approach:** {{iac_approach}}
|
||||
|
||||
### Deployment Strategy
|
||||
|
||||
- **Strategy:** {{deployment_strategy}}
|
||||
- **CI/CD Platform:** {{cicd_platform}}
|
||||
- **Pipeline Configuration:** `{{pipeline_config_location}}`
|
||||
|
||||
### Environments
|
||||
|
||||
<<REPEAT: environment>>
|
||||
|
||||
- **{{env_name}}:** {{env_purpose}} - {{env_details}}
|
||||
<</REPEAT>>
|
||||
|
||||
### Environment Promotion Flow
|
||||
|
||||
```text
|
||||
{{promotion_flow_diagram}}
|
||||
```
|
||||
|
||||
### Rollback Strategy
|
||||
|
||||
- **Primary Method:** {{rollback_method}}
|
||||
- **Trigger Conditions:** {{rollback_triggers}}
|
||||
- **Recovery Time Objective:** {{rto}}
|
||||
|
||||
[[LLM: After presenting the infrastructure and deployment section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Error Handling Strategy
|
||||
|
||||
[[LLM: Define comprehensive error handling approach:
|
||||
|
||||
1. Choose appropriate patterns for the language/framework from Tech Stack
|
||||
2. Define logging standards and tools
|
||||
3. Establish error categories and handling rules
|
||||
4. Consider observability and debugging needs
|
||||
5. Ensure security (no sensitive data in logs)
|
||||
|
||||
This section guides both AI and human developers in consistent error handling.]]
|
||||
|
||||
### General Approach
|
||||
|
||||
- **Error Model:** {{error_model}}
|
||||
- **Exception Hierarchy:** {{exception_structure}}
|
||||
- **Error Propagation:** {{propagation_rules}}
|
||||
|
||||
### Logging Standards
|
||||
|
||||
- **Library:** {{logging_library}} {{version}}
|
||||
- **Format:** {{log_format}}
|
||||
- **Levels:** {{log_levels_definition}}
|
||||
- **Required Context:**
|
||||
- Correlation ID: {{correlation_id_format}}
|
||||
- Service Context: {{service_context}}
|
||||
- User Context: {{user_context_rules}}
|
||||
|
||||
### Error Handling Patterns
|
||||
|
||||
#### External API Errors
|
||||
|
||||
- **Retry Policy:** {{retry_strategy}}
|
||||
- **Circuit Breaker:** {{circuit_breaker_config}}
|
||||
- **Timeout Configuration:** {{timeout_settings}}
|
||||
- **Error Translation:** {{error_mapping_rules}}
|
||||
|
||||
#### Business Logic Errors
|
||||
|
||||
- **Custom Exceptions:** {{business_exception_types}}
|
||||
- **User-Facing Errors:** {{user_error_format}}
|
||||
- **Error Codes:** {{error_code_system}}
|
||||
|
||||
#### Data Consistency
|
||||
|
||||
- **Transaction Strategy:** {{transaction_approach}}
|
||||
- **Compensation Logic:** {{compensation_patterns}}
|
||||
- **Idempotency:** {{idempotency_approach}}
|
||||
|
||||
[[LLM: After presenting the error handling strategy, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Coding Standards
|
||||
|
||||
[[LLM: These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that:
|
||||
|
||||
1. This section directly controls AI developer behavior
|
||||
2. Keep it minimal - assume AI knows general best practices
|
||||
3. Focus on project-specific conventions and gotchas
|
||||
4. Overly detailed standards bloat context and slow development
|
||||
5. Standards will be extracted to separate file for dev agent use
|
||||
|
||||
For each standard, get explicit user confirmation it's necessary.]]
|
||||
|
||||
### Core Standards
|
||||
|
||||
- **Languages & Runtimes:** {{languages_and_versions}}
|
||||
- **Style & Linting:** {{linter_config}}
|
||||
- **Test Organization:** {{test_file_convention}}
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
[[LLM: Only include if deviating from language defaults]]
|
||||
|
||||
| Element | Convention | Example |
|
||||
| :-------- | :------------------- | :---------------- |
|
||||
| Variables | {{var_convention}} | {{var_example}} |
|
||||
| Functions | {{func_convention}} | {{func_example}} |
|
||||
| Classes | {{class_convention}} | {{class_example}} |
|
||||
| Files | {{file_convention}} | {{file_example}} |
|
||||
|
||||
### Critical Rules
|
||||
|
||||
[[LLM: List ONLY rules that AI might violate or project-specific requirements. Examples:
|
||||
|
||||
- "Never use console.log in production code - use logger"
|
||||
- "All API responses must use ApiResponse wrapper type"
|
||||
- "Database queries must use repository pattern, never direct ORM"
|
||||
|
||||
Avoid obvious rules like "use SOLID principles" or "write clean code"]]
|
||||
|
||||
<<REPEAT: critical_rule>>
|
||||
|
||||
- **{{rule_name}}:** {{rule_description}}
|
||||
<</REPEAT>>
|
||||
|
||||
### Language-Specific Guidelines
|
||||
|
||||
[[LLM: Add ONLY if critical for preventing AI mistakes. Most teams don't need this section.]]
|
||||
|
||||
^^CONDITION: has_language_specifics^^
|
||||
|
||||
#### {{language_name}} Specifics
|
||||
|
||||
<<REPEAT: language_rule>>
|
||||
|
||||
- **{{rule_topic}}:** {{rule_detail}}
|
||||
<</REPEAT>>
|
||||
|
||||
^^/CONDITION: has_language_specifics^^
|
||||
|
||||
[[LLM: After presenting the coding standards, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Test Strategy and Standards
|
||||
|
||||
[[LLM: Work with user to define comprehensive test strategy:
|
||||
|
||||
1. Use test frameworks from Tech Stack
|
||||
2. Decide on TDD vs test-after approach
|
||||
3. Define test organization and naming
|
||||
4. Establish coverage goals
|
||||
5. Determine integration test infrastructure
|
||||
6. Plan for test data and external dependencies
|
||||
|
||||
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference. Apply `tasks#advanced-elicitation` after initial draft.]]
|
||||
|
||||
### Testing Philosophy
|
||||
|
||||
- **Approach:** {{test_approach}}
|
||||
- **Coverage Goals:** {{coverage_targets}}
|
||||
- **Test Pyramid:** {{test_distribution}}
|
||||
|
||||
### Test Types and Organization
|
||||
|
||||
#### Unit Tests
|
||||
|
||||
- **Framework:** {{unit_test_framework}} {{version}}
|
||||
- **File Convention:** {{unit_test_naming}}
|
||||
- **Location:** {{unit_test_location}}
|
||||
- **Mocking Library:** {{mocking_library}}
|
||||
- **Coverage Requirement:** {{unit_coverage}}
|
||||
|
||||
**AI Agent Requirements:**
|
||||
|
||||
- Generate tests for all public methods
|
||||
- Cover edge cases and error conditions
|
||||
- Follow AAA pattern (Arrange, Act, Assert)
|
||||
- Mock all external dependencies
|
||||
|
||||
#### Integration Tests
|
||||
|
||||
- **Scope:** {{integration_scope}}
|
||||
- **Location:** {{integration_test_location}}
|
||||
- **Test Infrastructure:**
|
||||
<<REPEAT: test_dependency>>
|
||||
- **{{dependency_name}}:** {{test_approach}} ({{test_tool}})
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: test_dependencies}
|
||||
|
||||
- **Database:** In-memory H2 for unit tests, Testcontainers PostgreSQL for integration
|
||||
- **Message Queue:** Embedded Kafka for tests
|
||||
- **External APIs:** WireMock for stubbing
|
||||
@{/example}
|
||||
|
||||
#### End-to-End Tests
|
||||
|
||||
- **Framework:** {{e2e_framework}} {{version}}
|
||||
- **Scope:** {{e2e_scope}}
|
||||
- **Environment:** {{e2e_environment}}
|
||||
- **Test Data:** {{e2e_data_strategy}}
|
||||
|
||||
### Test Data Management
|
||||
|
||||
- **Strategy:** {{test_data_approach}}
|
||||
- **Fixtures:** {{fixture_location}}
|
||||
- **Factories:** {{factory_pattern}}
|
||||
- **Cleanup:** {{cleanup_strategy}}
|
||||
|
||||
### Continuous Testing
|
||||
|
||||
- **CI Integration:** {{ci_test_stages}}
|
||||
- **Performance Tests:** {{perf_test_approach}}
|
||||
- **Security Tests:** {{security_test_approach}}
|
||||
|
||||
[[LLM: After presenting the test strategy section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Security
|
||||
|
||||
[[LLM: Define MANDATORY security requirements for AI and human developers:
|
||||
|
||||
1. Focus on implementation-specific rules
|
||||
2. Reference security tools from Tech Stack
|
||||
3. Define clear patterns for common scenarios
|
||||
4. These rules directly impact code generation
|
||||
5. Work with user to ensure completeness without redundancy]]
|
||||
|
||||
### Input Validation
|
||||
|
||||
- **Validation Library:** {{validation_library}}
|
||||
- **Validation Location:** {{where_to_validate}}
|
||||
- **Required Rules:**
|
||||
- All external inputs MUST be validated
|
||||
- Validation at API boundary before processing
|
||||
- Whitelist approach preferred over blacklist
|
||||
|
||||
### Authentication & Authorization
|
||||
|
||||
- **Auth Method:** {{auth_implementation}}
|
||||
- **Session Management:** {{session_approach}}
|
||||
- **Required Patterns:**
|
||||
- {{auth_pattern_1}}
|
||||
- {{auth_pattern_2}}
|
||||
|
||||
### Secrets Management
|
||||
|
||||
- **Development:** {{dev_secrets_approach}}
|
||||
- **Production:** {{prod_secrets_service}}
|
||||
- **Code Requirements:**
|
||||
- NEVER hardcode secrets
|
||||
- Access via configuration service only
|
||||
- No secrets in logs or error messages
|
||||
|
||||
### API Security
|
||||
|
||||
- **Rate Limiting:** {{rate_limit_implementation}}
|
||||
- **CORS Policy:** {{cors_configuration}}
|
||||
- **Security Headers:** {{required_headers}}
|
||||
- **HTTPS Enforcement:** {{https_approach}}
|
||||
|
||||
### Data Protection
|
||||
|
||||
- **Encryption at Rest:** {{encryption_at_rest}}
|
||||
- **Encryption in Transit:** {{encryption_in_transit}}
|
||||
- **PII Handling:** {{pii_rules}}
|
||||
- **Logging Restrictions:** {{what_not_to_log}}
|
||||
|
||||
### Dependency Security
|
||||
|
||||
- **Scanning Tool:** {{dependency_scanner}}
|
||||
- **Update Policy:** {{update_frequency}}
|
||||
- **Approval Process:** {{new_dep_process}}
|
||||
|
||||
### Security Testing
|
||||
|
||||
- **SAST Tool:** {{static_analysis}}
|
||||
- **DAST Tool:** {{dynamic_analysis}}
|
||||
- **Penetration Testing:** {{pentest_schedule}}
|
||||
|
||||
[[LLM: After presenting the security section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Checklist Results Report
|
||||
|
||||
[[LLM: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the `architect-checklist` and populate results here.]]
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
[[LLM: After completing the architecture:
|
||||
|
||||
1. If project has UI components:
|
||||
|
||||
- Recommend engaging Design Architect agent
|
||||
- Use "Frontend Architecture Mode"
|
||||
- Provide this document as input
|
||||
|
||||
2. For all projects:
|
||||
|
||||
- Review with Product Owner
|
||||
- Begin story implementation with Dev agent
|
||||
- Set up infrastructure with DevOps agent
|
||||
|
||||
3. Include specific prompts for next agents if needed]]
|
||||
|
||||
^^CONDITION: has_ui^^
|
||||
|
||||
### Design Architect Prompt
|
||||
|
||||
[[LLM: Create a brief prompt to hand off to Design Architect for Frontend Architecture creation. Include:
|
||||
|
||||
- Reference to this architecture document
|
||||
- Key UI requirements from PRD
|
||||
- Any frontend-specific decisions made here
|
||||
- Request for detailed frontend architecture]]
|
||||
|
||||
^^/CONDITION: has_ui^^
|
||||
|
||||
### Developer Handoff
|
||||
|
||||
[[LLM: Create a brief prompt for developers starting implementation. Include:
|
||||
|
||||
- Reference to this architecture and coding standards
|
||||
- First epic/story to implement
|
||||
- Key technical decisions to follow]]
|
||||
650
bmad-core/templates/architecture-tmpl.yaml
Normal file
650
bmad-core/templates/architecture-tmpl.yaml
Normal file
@@ -0,0 +1,650 @@
|
||||
template:
|
||||
id: architecture-template-v2
|
||||
name: Architecture Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/architecture.md
|
||||
title: "{{project_name}} Architecture Document"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: |
|
||||
If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot locate docs/prd.md ask the user what docs will provide the basis for the architecture.
|
||||
sections:
|
||||
- id: intro-content
|
||||
content: |
|
||||
This document outlines the overall project architecture for {{project_name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
||||
|
||||
**Relationship to Frontend Architecture:**
|
||||
If the project includes a significant user interface, a separate Frontend Architecture Document will detail the frontend-specific design and MUST be used in conjunction with this document. Core technology stack choices documented herein (see "Tech Stack") are definitive for the entire project, including any frontend components.
|
||||
- id: starter-template
|
||||
title: Starter Template or Existing Project
|
||||
instruction: |
|
||||
Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase:
|
||||
|
||||
1. Review the PRD and brainstorming brief for any mentions of:
|
||||
- Starter templates (e.g., Create React App, Next.js, Vue CLI, Angular CLI, etc.)
|
||||
- Existing projects or codebases being used as a foundation
|
||||
- Boilerplate projects or scaffolding tools
|
||||
- Previous projects to be cloned or adapted
|
||||
|
||||
2. If a starter template or existing project is mentioned:
|
||||
- Ask the user to provide access via one of these methods:
|
||||
- Link to the starter template documentation
|
||||
- Upload/attach the project files (for small projects)
|
||||
- Share a link to the project repository (GitHub, GitLab, etc.)
|
||||
- Analyze the starter/existing project to understand:
|
||||
- Pre-configured technology stack and versions
|
||||
- Project structure and organization patterns
|
||||
- Built-in scripts and tooling
|
||||
- Existing architectural patterns and conventions
|
||||
- Any limitations or constraints imposed by the starter
|
||||
- Use this analysis to inform and align your architecture decisions
|
||||
|
||||
3. If no starter template is mentioned but this is a greenfield project:
|
||||
- Suggest appropriate starter templates based on the tech stack preferences
|
||||
- Explain the benefits (faster setup, best practices, community support)
|
||||
- Let the user decide whether to use one
|
||||
|
||||
4. If the user confirms no starter template will be used:
|
||||
- Proceed with architecture design from scratch
|
||||
- Note that manual setup will be required for all tooling and configuration
|
||||
|
||||
Document the decision here before proceeding with the architecture design. If none, just say N/A
|
||||
elicit: true
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: high-level-architecture
|
||||
title: High Level Architecture
|
||||
instruction: |
|
||||
This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together at once.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: technical-summary
|
||||
title: Technical Summary
|
||||
instruction: |
|
||||
Provide a brief paragraph (3-5 sentences) overview of:
|
||||
- The system's overall architecture style
|
||||
- Key components and their relationships
|
||||
- Primary technology choices
|
||||
- Core architectural patterns being used
|
||||
- Reference back to the PRD goals and how this architecture supports them
|
||||
- id: high-level-overview
|
||||
title: High Level Overview
|
||||
instruction: |
|
||||
Based on the PRD's Technical Assumptions section, describe:
|
||||
|
||||
1. The main architectural style (e.g., Monolith, Microservices, Serverless, Event-Driven)
|
||||
2. Repository structure decision from PRD (Monorepo/Polyrepo)
|
||||
3. Service architecture decision from PRD
|
||||
4. Primary user interaction flow or data flow at a conceptual level
|
||||
5. Key architectural decisions and their rationale
|
||||
- id: project-diagram
|
||||
title: High Level Project Diagram
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
instruction: |
|
||||
Create a Mermaid diagram that visualizes the high-level architecture. Consider:
|
||||
- System boundaries
|
||||
- Major components/services
|
||||
- Data flow directions
|
||||
- External integrations
|
||||
- User entry points
|
||||
|
||||
- id: architectural-patterns
|
||||
title: Architectural and Design Patterns
|
||||
instruction: |
|
||||
List the key high-level patterns that will guide the architecture. For each pattern:
|
||||
|
||||
1. Present 2-3 viable options if multiple exist
|
||||
2. Provide your recommendation with clear rationale
|
||||
3. Get user confirmation before finalizing
|
||||
4. These patterns should align with the PRD's technical assumptions and project goals
|
||||
|
||||
Common patterns to consider:
|
||||
- Architectural style patterns (Serverless, Event-Driven, Microservices, CQRS, Hexagonal)
|
||||
- Code organization patterns (Dependency Injection, Repository, Module, Factory)
|
||||
- Data patterns (Event Sourcing, Saga, Database per Service)
|
||||
- Communication patterns (REST, GraphQL, Message Queue, Pub/Sub)
|
||||
template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
|
||||
examples:
|
||||
- "**Serverless Architecture:** Using AWS Lambda for compute - _Rationale:_ Aligns with PRD requirement for cost optimization and automatic scaling"
|
||||
- "**Repository Pattern:** Abstract data access logic - _Rationale:_ Enables testing and future database migration flexibility"
|
||||
- "**Event-Driven Communication:** Using SNS/SQS for service decoupling - _Rationale:_ Supports async processing and system resilience"
|
||||
|
||||
- id: tech-stack
|
||||
title: Tech Stack
|
||||
instruction: |
|
||||
This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
||||
|
||||
1. Review PRD technical assumptions and any preferences from {root}/data/technical-preferences.yaml or an attached technical-preferences
|
||||
2. For each category, present 2-3 viable options with pros/cons
|
||||
3. Make a clear recommendation based on project needs
|
||||
4. Get explicit user approval for each selection
|
||||
5. Document exact versions (avoid "latest" - pin specific versions)
|
||||
6. This table is the single source of truth - all other docs must reference these choices
|
||||
|
||||
Key decisions to finalize - before displaying the table, ensure you are aware of or ask the user about - let the user know if they are not sure on any that you can also provide suggestions with rationale:
|
||||
|
||||
- Starter templates (if any)
|
||||
- Languages and runtimes with exact versions
|
||||
- Frameworks and libraries / packages
|
||||
- Cloud provider and key services choices
|
||||
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
||||
- Development tools
|
||||
|
||||
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away elicit feedback - this statement and the options should be rendered and then prompt right all before allowing user input.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: cloud-infrastructure
|
||||
title: Cloud Infrastructure
|
||||
template: |
|
||||
- **Provider:** {{cloud_provider}}
|
||||
- **Key Services:** {{core_services_list}}
|
||||
- **Deployment Regions:** {{regions}}
|
||||
- id: technology-stack-table
|
||||
title: Technology Stack Table
|
||||
type: table
|
||||
columns: [Category, Technology, Version, Purpose, Rationale]
|
||||
instruction: Populate the technology stack table with all relevant technologies
|
||||
examples:
|
||||
- "| **Language** | TypeScript | 5.3.3 | Primary development language | Strong typing, excellent tooling, team expertise |"
|
||||
- "| **Runtime** | Node.js | 20.11.0 | JavaScript runtime | LTS version, stable performance, wide ecosystem |"
|
||||
- "| **Framework** | NestJS | 10.3.2 | Backend framework | Enterprise-ready, good DI, matches team patterns |"
|
||||
|
||||
- id: data-models
|
||||
title: Data Models
|
||||
instruction: |
|
||||
Define the core data models/entities:
|
||||
|
||||
1. Review PRD requirements and identify key business entities
|
||||
2. For each model, explain its purpose and relationships
|
||||
3. Include key attributes and data types
|
||||
4. Show relationships between models
|
||||
5. Discuss design decisions with user
|
||||
|
||||
Create a clear conceptual model before moving to database schema.
|
||||
elicit: true
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: model
|
||||
title: "{{model_name}}"
|
||||
template: |
|
||||
**Purpose:** {{model_purpose}}
|
||||
|
||||
**Key Attributes:**
|
||||
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
||||
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
||||
|
||||
**Relationships:**
|
||||
- {{relationship_1}}
|
||||
- {{relationship_2}}
|
||||
|
||||
- id: components
|
||||
title: Components
|
||||
instruction: |
|
||||
Based on the architectural patterns, tech stack, and data models from above:
|
||||
|
||||
1. Identify major logical components/services and their responsibilities
|
||||
2. Consider the repository structure (monorepo/polyrepo) from PRD
|
||||
3. Define clear boundaries and interfaces between components
|
||||
4. For each component, specify:
|
||||
- Primary responsibility
|
||||
- Key interfaces/APIs exposed
|
||||
- Dependencies on other components
|
||||
- Technology specifics based on tech stack choices
|
||||
|
||||
5. Create component diagrams where helpful
|
||||
elicit: true
|
||||
sections:
|
||||
- id: component-list
|
||||
repeatable: true
|
||||
title: "{{component_name}}"
|
||||
template: |
|
||||
**Responsibility:** {{component_description}}
|
||||
|
||||
**Key Interfaces:**
|
||||
- {{interface_1}}
|
||||
- {{interface_2}}
|
||||
|
||||
**Dependencies:** {{dependencies}}
|
||||
|
||||
**Technology Stack:** {{component_tech_details}}
|
||||
- id: component-diagrams
|
||||
title: Component Diagrams
|
||||
type: mermaid
|
||||
instruction: |
|
||||
Create Mermaid diagrams to visualize component relationships. Options:
|
||||
- C4 Container diagram for high-level view
|
||||
- Component diagram for detailed internal structure
|
||||
- Sequence diagrams for complex interactions
|
||||
Choose the most appropriate for clarity
|
||||
|
||||
- id: external-apis
|
||||
title: External APIs
|
||||
condition: Project requires external API integrations
|
||||
instruction: |
|
||||
For each external service integration:
|
||||
|
||||
1. Identify APIs needed based on PRD requirements and component design
|
||||
2. If documentation URLs are unknown, ask user for specifics
|
||||
3. Document authentication methods and security considerations
|
||||
4. List specific endpoints that will be used
|
||||
5. Note any rate limits or usage constraints
|
||||
|
||||
If no external APIs are needed, state this explicitly and skip to next section.
|
||||
elicit: true
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: api
|
||||
title: "{{api_name}} API"
|
||||
template: |
|
||||
- **Purpose:** {{api_purpose}}
|
||||
- **Documentation:** {{api_docs_url}}
|
||||
- **Base URL(s):** {{api_base_url}}
|
||||
- **Authentication:** {{auth_method}}
|
||||
- **Rate Limits:** {{rate_limits}}
|
||||
|
||||
**Key Endpoints Used:**
|
||||
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
||||
|
||||
**Integration Notes:** {{integration_considerations}}
|
||||
|
||||
- id: core-workflows
|
||||
title: Core Workflows
|
||||
type: mermaid
|
||||
mermaid_type: sequence
|
||||
instruction: |
|
||||
Illustrate key system workflows using sequence diagrams:
|
||||
|
||||
1. Identify critical user journeys from PRD
|
||||
2. Show component interactions including external APIs
|
||||
3. Include error handling paths
|
||||
4. Document async operations
|
||||
5. Create both high-level and detailed diagrams as needed
|
||||
|
||||
Focus on workflows that clarify architecture decisions or complex interactions.
|
||||
elicit: true
|
||||
|
||||
- id: rest-api-spec
|
||||
title: REST API Spec
|
||||
condition: Project includes REST API
|
||||
type: code
|
||||
language: yaml
|
||||
instruction: |
|
||||
If the project includes a REST API:
|
||||
|
||||
1. Create an OpenAPI 3.0 specification
|
||||
2. Include all endpoints from epics/stories
|
||||
3. Define request/response schemas based on data models
|
||||
4. Document authentication requirements
|
||||
5. Include example requests/responses
|
||||
|
||||
Use YAML format for better readability. If no REST API, skip this section.
|
||||
elicit: true
|
||||
template: |
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title: {{api_title}}
|
||||
version: {{api_version}}
|
||||
description: {{api_description}}
|
||||
servers:
|
||||
- url: {{server_url}}
|
||||
description: {{server_description}}
|
||||
|
||||
- id: database-schema
|
||||
title: Database Schema
|
||||
instruction: |
|
||||
Transform the conceptual data models into concrete database schemas:
|
||||
|
||||
1. Use the database type(s) selected in Tech Stack
|
||||
2. Create schema definitions using appropriate notation
|
||||
3. Include indexes, constraints, and relationships
|
||||
4. Consider performance and scalability
|
||||
5. For NoSQL, show document structures
|
||||
|
||||
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
||||
elicit: true
|
||||
|
||||
- id: source-tree
|
||||
title: Source Tree
|
||||
type: code
|
||||
language: plaintext
|
||||
instruction: |
|
||||
Create a project folder structure that reflects:
|
||||
|
||||
1. The chosen repository structure (monorepo/polyrepo)
|
||||
2. The service architecture (monolith/microservices/serverless)
|
||||
3. The selected tech stack and languages
|
||||
4. Component organization from above
|
||||
5. Best practices for the chosen frameworks
|
||||
6. Clear separation of concerns
|
||||
|
||||
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
||||
elicit: true
|
||||
examples:
|
||||
- |
|
||||
project-root/
|
||||
├── packages/
|
||||
│ ├── api/ # Backend API service
|
||||
│ ├── web/ # Frontend application
|
||||
│ ├── shared/ # Shared utilities/types
|
||||
│ └── infrastructure/ # IaC definitions
|
||||
├── scripts/ # Monorepo management scripts
|
||||
└── package.json # Root package.json with workspaces
|
||||
|
||||
- id: infrastructure-deployment
|
||||
title: Infrastructure and Deployment
|
||||
instruction: |
|
||||
Define the deployment architecture and practices:
|
||||
|
||||
1. Use IaC tool selected in Tech Stack
|
||||
2. Choose deployment strategy appropriate for the architecture
|
||||
3. Define environments and promotion flow
|
||||
4. Establish rollback procedures
|
||||
5. Consider security, monitoring, and cost optimization
|
||||
|
||||
Get user input on deployment preferences and CI/CD tool choices.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: infrastructure-as-code
|
||||
title: Infrastructure as Code
|
||||
template: |
|
||||
- **Tool:** {{iac_tool}} {{version}}
|
||||
- **Location:** `{{iac_directory}}`
|
||||
- **Approach:** {{iac_approach}}
|
||||
- id: deployment-strategy
|
||||
title: Deployment Strategy
|
||||
template: |
|
||||
- **Strategy:** {{deployment_strategy}}
|
||||
- **CI/CD Platform:** {{cicd_platform}}
|
||||
- **Pipeline Configuration:** `{{pipeline_config_location}}`
|
||||
- id: environments
|
||||
title: Environments
|
||||
repeatable: true
|
||||
template: "- **{{env_name}}:** {{env_purpose}} - {{env_details}}"
|
||||
- id: promotion-flow
|
||||
title: Environment Promotion Flow
|
||||
type: code
|
||||
language: text
|
||||
template: "{{promotion_flow_diagram}}"
|
||||
- id: rollback-strategy
|
||||
title: Rollback Strategy
|
||||
template: |
|
||||
- **Primary Method:** {{rollback_method}}
|
||||
- **Trigger Conditions:** {{rollback_triggers}}
|
||||
- **Recovery Time Objective:** {{rto}}
|
||||
|
||||
- id: error-handling-strategy
|
||||
title: Error Handling Strategy
|
||||
instruction: |
|
||||
Define comprehensive error handling approach:
|
||||
|
||||
1. Choose appropriate patterns for the language/framework from Tech Stack
|
||||
2. Define logging standards and tools
|
||||
3. Establish error categories and handling rules
|
||||
4. Consider observability and debugging needs
|
||||
5. Ensure security (no sensitive data in logs)
|
||||
|
||||
This section guides both AI and human developers in consistent error handling.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: general-approach
|
||||
title: General Approach
|
||||
template: |
|
||||
- **Error Model:** {{error_model}}
|
||||
- **Exception Hierarchy:** {{exception_structure}}
|
||||
- **Error Propagation:** {{propagation_rules}}
|
||||
- id: logging-standards
|
||||
title: Logging Standards
|
||||
template: |
|
||||
- **Library:** {{logging_library}} {{version}}
|
||||
- **Format:** {{log_format}}
|
||||
- **Levels:** {{log_levels_definition}}
|
||||
- **Required Context:**
|
||||
- Correlation ID: {{correlation_id_format}}
|
||||
- Service Context: {{service_context}}
|
||||
- User Context: {{user_context_rules}}
|
||||
- id: error-patterns
|
||||
title: Error Handling Patterns
|
||||
sections:
|
||||
- id: external-api-errors
|
||||
title: External API Errors
|
||||
template: |
|
||||
- **Retry Policy:** {{retry_strategy}}
|
||||
- **Circuit Breaker:** {{circuit_breaker_config}}
|
||||
- **Timeout Configuration:** {{timeout_settings}}
|
||||
- **Error Translation:** {{error_mapping_rules}}
|
||||
- id: business-logic-errors
|
||||
title: Business Logic Errors
|
||||
template: |
|
||||
- **Custom Exceptions:** {{business_exception_types}}
|
||||
- **User-Facing Errors:** {{user_error_format}}
|
||||
- **Error Codes:** {{error_code_system}}
|
||||
- id: data-consistency
|
||||
title: Data Consistency
|
||||
template: |
|
||||
- **Transaction Strategy:** {{transaction_approach}}
|
||||
- **Compensation Logic:** {{compensation_patterns}}
|
||||
- **Idempotency:** {{idempotency_approach}}
|
||||
|
||||
- id: coding-standards
|
||||
title: Coding Standards
|
||||
instruction: |
|
||||
These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that:
|
||||
|
||||
1. This section directly controls AI developer behavior
|
||||
2. Keep it minimal - assume AI knows general best practices
|
||||
3. Focus on project-specific conventions and gotchas
|
||||
4. Overly detailed standards bloat context and slow development
|
||||
5. Standards will be extracted to separate file for dev agent use
|
||||
|
||||
For each standard, get explicit user confirmation it's necessary.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: core-standards
|
||||
title: Core Standards
|
||||
template: |
|
||||
- **Languages & Runtimes:** {{languages_and_versions}}
|
||||
- **Style & Linting:** {{linter_config}}
|
||||
- **Test Organization:** {{test_file_convention}}
|
||||
- id: naming-conventions
|
||||
title: Naming Conventions
|
||||
type: table
|
||||
columns: [Element, Convention, Example]
|
||||
instruction: Only include if deviating from language defaults
|
||||
- id: critical-rules
|
||||
title: Critical Rules
|
||||
instruction: |
|
||||
List ONLY rules that AI might violate or project-specific requirements. Examples:
|
||||
- "Never use console.log in production code - use logger"
|
||||
- "All API responses must use ApiResponse wrapper type"
|
||||
- "Database queries must use repository pattern, never direct ORM"
|
||||
|
||||
Avoid obvious rules like "use SOLID principles" or "write clean code"
|
||||
repeatable: true
|
||||
template: "- **{{rule_name}}:** {{rule_description}}"
|
||||
- id: language-specifics
|
||||
title: Language-Specific Guidelines
|
||||
condition: Critical language-specific rules needed
|
||||
instruction: Add ONLY if critical for preventing AI mistakes. Most teams don't need this section.
|
||||
sections:
|
||||
- id: language-rules
|
||||
title: "{{language_name}} Specifics"
|
||||
repeatable: true
|
||||
template: "- **{{rule_topic}}:** {{rule_detail}}"
|
||||
|
||||
- id: test-strategy
|
||||
title: Test Strategy and Standards
|
||||
instruction: |
|
||||
Work with user to define comprehensive test strategy:
|
||||
|
||||
1. Use test frameworks from Tech Stack
|
||||
2. Decide on TDD vs test-after approach
|
||||
3. Define test organization and naming
|
||||
4. Establish coverage goals
|
||||
5. Determine integration test infrastructure
|
||||
6. Plan for test data and external dependencies
|
||||
|
||||
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: testing-philosophy
|
||||
title: Testing Philosophy
|
||||
template: |
|
||||
- **Approach:** {{test_approach}}
|
||||
- **Coverage Goals:** {{coverage_targets}}
|
||||
- **Test Pyramid:** {{test_distribution}}
|
||||
- id: test-types
|
||||
title: Test Types and Organization
|
||||
sections:
|
||||
- id: unit-tests
|
||||
title: Unit Tests
|
||||
template: |
|
||||
- **Framework:** {{unit_test_framework}} {{version}}
|
||||
- **File Convention:** {{unit_test_naming}}
|
||||
- **Location:** {{unit_test_location}}
|
||||
- **Mocking Library:** {{mocking_library}}
|
||||
- **Coverage Requirement:** {{unit_coverage}}
|
||||
|
||||
**AI Agent Requirements:**
|
||||
- Generate tests for all public methods
|
||||
- Cover edge cases and error conditions
|
||||
- Follow AAA pattern (Arrange, Act, Assert)
|
||||
- Mock all external dependencies
|
||||
- id: integration-tests
|
||||
title: Integration Tests
|
||||
template: |
|
||||
- **Scope:** {{integration_scope}}
|
||||
- **Location:** {{integration_test_location}}
|
||||
- **Test Infrastructure:**
|
||||
- **{{dependency_name}}:** {{test_approach}} ({{test_tool}})
|
||||
examples:
|
||||
- "**Database:** In-memory H2 for unit tests, Testcontainers PostgreSQL for integration"
|
||||
- "**Message Queue:** Embedded Kafka for tests"
|
||||
- "**External APIs:** WireMock for stubbing"
|
||||
- id: e2e-tests
|
||||
title: End-to-End Tests
|
||||
template: |
|
||||
- **Framework:** {{e2e_framework}} {{version}}
|
||||
- **Scope:** {{e2e_scope}}
|
||||
- **Environment:** {{e2e_environment}}
|
||||
- **Test Data:** {{e2e_data_strategy}}
|
||||
- id: test-data-management
|
||||
title: Test Data Management
|
||||
template: |
|
||||
- **Strategy:** {{test_data_approach}}
|
||||
- **Fixtures:** {{fixture_location}}
|
||||
- **Factories:** {{factory_pattern}}
|
||||
- **Cleanup:** {{cleanup_strategy}}
|
||||
- id: continuous-testing
|
||||
title: Continuous Testing
|
||||
template: |
|
||||
- **CI Integration:** {{ci_test_stages}}
|
||||
- **Performance Tests:** {{perf_test_approach}}
|
||||
- **Security Tests:** {{security_test_approach}}
|
||||
|
||||
- id: security
|
||||
title: Security
|
||||
instruction: |
|
||||
Define MANDATORY security requirements for AI and human developers:
|
||||
|
||||
1. Focus on implementation-specific rules
|
||||
2. Reference security tools from Tech Stack
|
||||
3. Define clear patterns for common scenarios
|
||||
4. These rules directly impact code generation
|
||||
5. Work with user to ensure completeness without redundancy
|
||||
elicit: true
|
||||
sections:
|
||||
- id: input-validation
|
||||
title: Input Validation
|
||||
template: |
|
||||
- **Validation Library:** {{validation_library}}
|
||||
- **Validation Location:** {{where_to_validate}}
|
||||
- **Required Rules:**
|
||||
- All external inputs MUST be validated
|
||||
- Validation at API boundary before processing
|
||||
- Whitelist approach preferred over blacklist
|
||||
- id: auth-authorization
|
||||
title: Authentication & Authorization
|
||||
template: |
|
||||
- **Auth Method:** {{auth_implementation}}
|
||||
- **Session Management:** {{session_approach}}
|
||||
- **Required Patterns:**
|
||||
- {{auth_pattern_1}}
|
||||
- {{auth_pattern_2}}
|
||||
- id: secrets-management
|
||||
title: Secrets Management
|
||||
template: |
|
||||
- **Development:** {{dev_secrets_approach}}
|
||||
- **Production:** {{prod_secrets_service}}
|
||||
- **Code Requirements:**
|
||||
- NEVER hardcode secrets
|
||||
- Access via configuration service only
|
||||
- No secrets in logs or error messages
|
||||
- id: api-security
|
||||
title: API Security
|
||||
template: |
|
||||
- **Rate Limiting:** {{rate_limit_implementation}}
|
||||
- **CORS Policy:** {{cors_configuration}}
|
||||
- **Security Headers:** {{required_headers}}
|
||||
- **HTTPS Enforcement:** {{https_approach}}
|
||||
- id: data-protection
|
||||
title: Data Protection
|
||||
template: |
|
||||
- **Encryption at Rest:** {{encryption_at_rest}}
|
||||
- **Encryption in Transit:** {{encryption_in_transit}}
|
||||
- **PII Handling:** {{pii_rules}}
|
||||
- **Logging Restrictions:** {{what_not_to_log}}
|
||||
- id: dependency-security
|
||||
title: Dependency Security
|
||||
template: |
|
||||
- **Scanning Tool:** {{dependency_scanner}}
|
||||
- **Update Policy:** {{update_frequency}}
|
||||
- **Approval Process:** {{new_dep_process}}
|
||||
- id: security-testing
|
||||
title: Security Testing
|
||||
template: |
|
||||
- **SAST Tool:** {{static_analysis}}
|
||||
- **DAST Tool:** {{dynamic_analysis}}
|
||||
- **Penetration Testing:** {{pentest_schedule}}
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results Report
|
||||
instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
instruction: |
|
||||
After completing the architecture:
|
||||
|
||||
1. If project has UI components:
|
||||
- Use "Frontend Architecture Mode"
|
||||
- Provide this document as input
|
||||
|
||||
2. For all projects:
|
||||
- Review with Product Owner
|
||||
- Begin story implementation with Dev agent
|
||||
- Set up infrastructure with DevOps agent
|
||||
|
||||
3. Include specific prompts for next agents if needed
|
||||
sections:
|
||||
- id: architect-prompt
|
||||
title: Architect Prompt
|
||||
condition: Project has UI components
|
||||
instruction: |
|
||||
Create a brief prompt to hand off to Architect for Frontend Architecture creation. Include:
|
||||
- Reference to this architecture document
|
||||
- Key UI requirements from PRD
|
||||
- Any frontend-specific decisions made here
|
||||
- Request for detailed frontend architecture
|
||||
156
bmad-core/templates/brainstorming-output-tmpl.yaml
Normal file
156
bmad-core/templates/brainstorming-output-tmpl.yaml
Normal file
@@ -0,0 +1,156 @@
|
||||
template:
|
||||
id: brainstorming-output-template-v2
|
||||
name: Brainstorming Session Results
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/brainstorming-session-results.md
|
||||
title: "Brainstorming Session Results"
|
||||
|
||||
workflow:
|
||||
mode: non-interactive
|
||||
|
||||
sections:
|
||||
- id: header
|
||||
content: |
|
||||
**Session Date:** {{date}}
|
||||
**Facilitator:** {{agent_role}} {{agent_name}}
|
||||
**Participant:** {{user_name}}
|
||||
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
sections:
|
||||
- id: summary-details
|
||||
template: |
|
||||
**Topic:** {{session_topic}}
|
||||
|
||||
**Session Goals:** {{stated_goals}}
|
||||
|
||||
**Techniques Used:** {{techniques_list}}
|
||||
|
||||
**Total Ideas Generated:** {{total_ideas}}
|
||||
- id: key-themes
|
||||
title: "Key Themes Identified:"
|
||||
type: bullet-list
|
||||
template: "- {{theme}}"
|
||||
|
||||
- id: technique-sessions
|
||||
title: Technique Sessions
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: technique
|
||||
title: "{{technique_name}} - {{duration}}"
|
||||
sections:
|
||||
- id: description
|
||||
template: "**Description:** {{technique_description}}"
|
||||
- id: ideas-generated
|
||||
title: "Ideas Generated:"
|
||||
type: numbered-list
|
||||
template: "{{idea}}"
|
||||
- id: insights
|
||||
title: "Insights Discovered:"
|
||||
type: bullet-list
|
||||
template: "- {{insight}}"
|
||||
- id: connections
|
||||
title: "Notable Connections:"
|
||||
type: bullet-list
|
||||
template: "- {{connection}}"
|
||||
|
||||
- id: idea-categorization
|
||||
title: Idea Categorization
|
||||
sections:
|
||||
- id: immediate-opportunities
|
||||
title: Immediate Opportunities
|
||||
content: "*Ideas ready to implement now*"
|
||||
repeatable: true
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{idea_name}}**
|
||||
- Description: {{description}}
|
||||
- Why immediate: {{rationale}}
|
||||
- Resources needed: {{requirements}}
|
||||
- id: future-innovations
|
||||
title: Future Innovations
|
||||
content: "*Ideas requiring development/research*"
|
||||
repeatable: true
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{idea_name}}**
|
||||
- Description: {{description}}
|
||||
- Development needed: {{development_needed}}
|
||||
- Timeline estimate: {{timeline}}
|
||||
- id: moonshots
|
||||
title: Moonshots
|
||||
content: "*Ambitious, transformative concepts*"
|
||||
repeatable: true
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{idea_name}}**
|
||||
- Description: {{description}}
|
||||
- Transformative potential: {{potential}}
|
||||
- Challenges to overcome: {{challenges}}
|
||||
- id: insights-learnings
|
||||
title: Insights & Learnings
|
||||
content: "*Key realizations from the session*"
|
||||
type: bullet-list
|
||||
template: "- {{insight}}: {{description_and_implications}}"
|
||||
|
||||
- id: action-planning
|
||||
title: Action Planning
|
||||
sections:
|
||||
- id: top-priorities
|
||||
title: Top 3 Priority Ideas
|
||||
sections:
|
||||
- id: priority-1
|
||||
title: "#1 Priority: {{idea_name}}"
|
||||
template: |
|
||||
- Rationale: {{rationale}}
|
||||
- Next steps: {{next_steps}}
|
||||
- Resources needed: {{resources}}
|
||||
- Timeline: {{timeline}}
|
||||
- id: priority-2
|
||||
title: "#2 Priority: {{idea_name}}"
|
||||
template: |
|
||||
- Rationale: {{rationale}}
|
||||
- Next steps: {{next_steps}}
|
||||
- Resources needed: {{resources}}
|
||||
- Timeline: {{timeline}}
|
||||
- id: priority-3
|
||||
title: "#3 Priority: {{idea_name}}"
|
||||
template: |
|
||||
- Rationale: {{rationale}}
|
||||
- Next steps: {{next_steps}}
|
||||
- Resources needed: {{resources}}
|
||||
- Timeline: {{timeline}}
|
||||
|
||||
- id: reflection-followup
|
||||
title: Reflection & Follow-up
|
||||
sections:
|
||||
- id: what-worked
|
||||
title: What Worked Well
|
||||
type: bullet-list
|
||||
template: "- {{aspect}}"
|
||||
- id: areas-exploration
|
||||
title: Areas for Further Exploration
|
||||
type: bullet-list
|
||||
template: "- {{area}}: {{reason}}"
|
||||
- id: recommended-techniques
|
||||
title: Recommended Follow-up Techniques
|
||||
type: bullet-list
|
||||
template: "- {{technique}}: {{reason}}"
|
||||
- id: questions-emerged
|
||||
title: Questions That Emerged
|
||||
type: bullet-list
|
||||
template: "- {{question}}"
|
||||
- id: next-session
|
||||
title: Next Session Planning
|
||||
template: |
|
||||
- **Suggested topics:** {{followup_topics}}
|
||||
- **Recommended timeframe:** {{timeframe}}
|
||||
- **Preparation needed:** {{preparation}}
|
||||
|
||||
- id: footer
|
||||
content: |
|
||||
---
|
||||
|
||||
*Session facilitated using the BMAD-METHOD brainstorming framework*
|
||||
@@ -1,544 +0,0 @@
|
||||
# {{Project Name}} Brownfield Enhancement Architecture
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/architecture.md]]
|
||||
|
||||
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
|
||||
|
||||
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
|
||||
|
||||
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
|
||||
- Existing project technical documentation (from docs folder or user-provided)
|
||||
- Access to existing project structure (IDE or uploaded files)
|
||||
|
||||
3. **DEEP ANALYSIS MANDATE**: You MUST conduct thorough analysis of the existing codebase, architecture patterns, and technical constraints before making ANY architectural recommendations. Every suggestion must be based on actual project analysis, not assumptions.
|
||||
|
||||
4. **CONTINUOUS VALIDATION**: Throughout this process, explicitly validate your understanding with the user. For every architectural decision, confirm: "Based on my analysis of your existing system, I recommend [decision] because [evidence from actual project]. Does this align with your system's reality?"
|
||||
|
||||
If any required inputs are missing, request them before proceeding.]]
|
||||
|
||||
## Introduction
|
||||
|
||||
[[LLM: This section establishes the document's purpose and scope for brownfield enhancements. Keep the content below but ensure project name and enhancement details are properly substituted.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
This document outlines the architectural approach for enhancing {{Project Name}} with {{Enhancement Description}}. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development of new features while ensuring seamless integration with the existing system.
|
||||
|
||||
**Relationship to Existing Architecture:**
|
||||
This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements.
|
||||
|
||||
### Existing Project Analysis
|
||||
|
||||
[[LLM: Analyze the existing project structure and architecture:
|
||||
|
||||
1. Review existing documentation in docs folder
|
||||
2. Examine current technology stack and versions
|
||||
3. Identify existing architectural patterns and conventions
|
||||
4. Note current deployment and infrastructure setup
|
||||
5. Document any constraints or limitations
|
||||
|
||||
CRITICAL: After your analysis, explicitly validate your findings: "Based on my analysis of your project, I've identified the following about your existing system: [key findings]. Please confirm these observations are accurate before I proceed with architectural recommendations."
|
||||
|
||||
Present findings and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
**Current Project State:**
|
||||
|
||||
- **Primary Purpose:** {{existing_project_purpose}}
|
||||
- **Current Tech Stack:** {{existing_tech_summary}}
|
||||
- **Architecture Style:** {{existing_architecture_style}}
|
||||
- **Deployment Method:** {{existing_deployment_approach}}
|
||||
|
||||
**Available Documentation:**
|
||||
|
||||
- {{existing_docs_summary}}
|
||||
|
||||
**Identified Constraints:**
|
||||
|
||||
- {{constraint_1}}
|
||||
- {{constraint_2}}
|
||||
- {{constraint_3}}
|
||||
|
||||
### Change Log
|
||||
|
||||
| Change | Date | Version | Description | Author |
|
||||
| ------ | ---- | ------- | ----------- | ------ |
|
||||
|
||||
## Enhancement Scope and Integration Strategy
|
||||
|
||||
[[LLM: Define how the enhancement will integrate with the existing system:
|
||||
|
||||
1. Review the brownfield PRD enhancement scope
|
||||
2. Identify integration points with existing code
|
||||
3. Define boundaries between new and existing functionality
|
||||
4. Establish compatibility requirements
|
||||
|
||||
VALIDATION CHECKPOINT: Before presenting the integration strategy, confirm: "Based on my analysis, the integration approach I'm proposing takes into account [specific existing system characteristics]. These integration points and boundaries respect your current architecture patterns. Is this assessment accurate?"
|
||||
|
||||
Present complete integration strategy and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Enhancement Overview
|
||||
|
||||
**Enhancement Type:** {{enhancement_type}}
|
||||
**Scope:** {{enhancement_scope}}
|
||||
**Integration Impact:** {{integration_impact_level}}
|
||||
|
||||
### Integration Approach
|
||||
|
||||
**Code Integration Strategy:** {{code_integration_approach}}
|
||||
**Database Integration:** {{database_integration_approach}}
|
||||
**API Integration:** {{api_integration_approach}}
|
||||
**UI Integration:** {{ui_integration_approach}}
|
||||
|
||||
### Compatibility Requirements
|
||||
|
||||
- **Existing API Compatibility:** {{api_compatibility}}
|
||||
- **Database Schema Compatibility:** {{db_compatibility}}
|
||||
- **UI/UX Consistency:** {{ui_compatibility}}
|
||||
- **Performance Impact:** {{performance_constraints}}
|
||||
|
||||
## Tech Stack Alignment
|
||||
|
||||
[[LLM: Ensure new components align with existing technology choices:
|
||||
|
||||
1. Use existing technology stack as the foundation
|
||||
2. Only introduce new technologies if absolutely necessary
|
||||
3. Justify any new additions with clear rationale
|
||||
4. Ensure version compatibility with existing dependencies
|
||||
|
||||
Present complete tech stack alignment and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Existing Technology Stack
|
||||
|
||||
[[LLM: Document the current stack that must be maintained or integrated with]]
|
||||
|
||||
| Category | Current Technology | Version | Usage in Enhancement | Notes |
|
||||
| :----------------- | :----------------- | :---------- | :------------------- | :-------- |
|
||||
| **Language** | {{language}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Runtime** | {{runtime}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Framework** | {{framework}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Database** | {{database}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **API Style** | {{api_style}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Authentication** | {{auth}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Testing** | {{test_framework}} | {{version}} | {{usage}} | {{notes}} |
|
||||
| **Build Tool** | {{build_tool}} | {{version}} | {{usage}} | {{notes}} |
|
||||
|
||||
### New Technology Additions
|
||||
|
||||
[[LLM: Only include if new technologies are required for the enhancement]]
|
||||
|
||||
^^CONDITION: has_new_tech^^
|
||||
|
||||
| Technology | Version | Purpose | Rationale | Integration Method |
|
||||
| :----------- | :---------- | :---------- | :------------ | :----------------- |
|
||||
| {{new_tech}} | {{version}} | {{purpose}} | {{rationale}} | {{integration}} |
|
||||
|
||||
^^/CONDITION: has_new_tech^^
|
||||
|
||||
## Data Models and Schema Changes
|
||||
|
||||
[[LLM: Define new data models and how they integrate with existing schema:
|
||||
|
||||
1. Identify new entities required for the enhancement
|
||||
2. Define relationships with existing data models
|
||||
3. Plan database schema changes (additions, modifications)
|
||||
4. Ensure backward compatibility
|
||||
|
||||
Present data model changes and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### New Data Models
|
||||
|
||||
<<REPEAT: new_data_model>>
|
||||
|
||||
### {{model_name}}
|
||||
|
||||
**Purpose:** {{model_purpose}}
|
||||
**Integration:** {{integration_with_existing}}
|
||||
|
||||
**Key Attributes:**
|
||||
|
||||
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
||||
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
||||
|
||||
**Relationships:**
|
||||
|
||||
- **With Existing:** {{existing_relationships}}
|
||||
- **With New:** {{new_relationships}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Schema Integration Strategy
|
||||
|
||||
**Database Changes Required:**
|
||||
|
||||
- **New Tables:** {{new_tables_list}}
|
||||
- **Modified Tables:** {{modified_tables_list}}
|
||||
- **New Indexes:** {{new_indexes_list}}
|
||||
- **Migration Strategy:** {{migration_approach}}
|
||||
|
||||
**Backward Compatibility:**
|
||||
|
||||
- {{compatibility_measure_1}}
|
||||
- {{compatibility_measure_2}}
|
||||
|
||||
## Component Architecture
|
||||
|
||||
[[LLM: Define new components and their integration with existing architecture:
|
||||
|
||||
1. Identify new components required for the enhancement
|
||||
2. Define interfaces with existing components
|
||||
3. Establish clear boundaries and responsibilities
|
||||
4. Plan integration points and data flow
|
||||
|
||||
MANDATORY VALIDATION: Before presenting component architecture, confirm: "The new components I'm proposing follow the existing architectural patterns I identified in your codebase: [specific patterns]. The integration interfaces respect your current component structure and communication patterns. Does this match your project's reality?"
|
||||
|
||||
Present component architecture and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### New Components
|
||||
|
||||
<<REPEAT: new_component>>
|
||||
|
||||
### {{component_name}}
|
||||
|
||||
**Responsibility:** {{component_description}}
|
||||
**Integration Points:** {{integration_points}}
|
||||
|
||||
**Key Interfaces:**
|
||||
|
||||
- {{interface_1}}
|
||||
- {{interface_2}}
|
||||
|
||||
**Dependencies:**
|
||||
|
||||
- **Existing Components:** {{existing_dependencies}}
|
||||
- **New Components:** {{new_dependencies}}
|
||||
|
||||
**Technology Stack:** {{component_tech_details}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Component Interaction Diagram
|
||||
|
||||
[[LLM: Create Mermaid diagram showing how new components interact with existing ones]]
|
||||
|
||||
```mermaid
|
||||
{{component_interaction_diagram}}
|
||||
```
|
||||
|
||||
## API Design and Integration
|
||||
|
||||
[[LLM: Define new API endpoints and integration with existing APIs:
|
||||
|
||||
1. Plan new API endpoints required for the enhancement
|
||||
2. Ensure consistency with existing API patterns
|
||||
3. Define authentication and authorization integration
|
||||
4. Plan versioning strategy if needed
|
||||
|
||||
Present API design and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### New API Endpoints
|
||||
|
||||
^^CONDITION: has_new_api^^
|
||||
|
||||
**API Integration Strategy:** {{api_integration_strategy}}
|
||||
**Authentication:** {{auth_integration}}
|
||||
**Versioning:** {{versioning_approach}}
|
||||
|
||||
<<REPEAT: new_endpoint>>
|
||||
|
||||
#### {{endpoint_name}}
|
||||
|
||||
- **Method:** {{http_method}}
|
||||
- **Endpoint:** {{endpoint_path}}
|
||||
- **Purpose:** {{endpoint_purpose}}
|
||||
- **Integration:** {{integration_with_existing}}
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{{request_schema}}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{{response_schema}}
|
||||
```
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
^^/CONDITION: has_new_api^^
|
||||
|
||||
## External API Integration
|
||||
|
||||
[[LLM: Document new external API integrations required for the enhancement]]
|
||||
|
||||
^^CONDITION: has_new_external_apis^^
|
||||
|
||||
<<REPEAT: external_api>>
|
||||
|
||||
### {{api_name}} API
|
||||
|
||||
- **Purpose:** {{api_purpose}}
|
||||
- **Documentation:** {{api_docs_url}}
|
||||
- **Base URL:** {{api_base_url}}
|
||||
- **Authentication:** {{auth_method}}
|
||||
- **Integration Method:** {{integration_approach}}
|
||||
|
||||
**Key Endpoints Used:**
|
||||
|
||||
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
||||
|
||||
**Error Handling:** {{error_handling_strategy}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
^^/CONDITION: has_new_external_apis^^
|
||||
|
||||
## Source Tree Integration
|
||||
|
||||
[[LLM: Define how new code will integrate with existing project structure:
|
||||
|
||||
1. Follow existing project organization patterns
|
||||
2. Identify where new files/folders will be placed
|
||||
3. Ensure consistency with existing naming conventions
|
||||
4. Plan for minimal disruption to existing structure
|
||||
|
||||
Present integration plan and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Existing Project Structure
|
||||
|
||||
[[LLM: Document relevant parts of current structure]]
|
||||
|
||||
```plaintext
|
||||
{{existing_structure_relevant_parts}}
|
||||
```
|
||||
|
||||
### New File Organization
|
||||
|
||||
[[LLM: Show only new additions to existing structure]]
|
||||
|
||||
```plaintext
|
||||
{{project-root}}/
|
||||
├── {{existing_structure_context}}
|
||||
│ ├── {{new_folder_1}}/ # {{purpose_1}}
|
||||
│ │ ├── {{new_file_1}}
|
||||
│ │ └── {{new_file_2}}
|
||||
│ ├── {{existing_folder}}/ # Existing folder with additions
|
||||
│ │ ├── {{existing_file}} # Existing file
|
||||
│ │ └── {{new_file_3}} # New addition
|
||||
│ └── {{new_folder_2}}/ # {{purpose_2}}
|
||||
```
|
||||
|
||||
### Integration Guidelines
|
||||
|
||||
- **File Naming:** {{file_naming_consistency}}
|
||||
- **Folder Organization:** {{folder_organization_approach}}
|
||||
- **Import/Export Patterns:** {{import_export_consistency}}
|
||||
|
||||
## Infrastructure and Deployment Integration
|
||||
|
||||
[[LLM: Define how the enhancement will be deployed alongside existing infrastructure:
|
||||
|
||||
1. Use existing deployment pipeline and infrastructure
|
||||
2. Identify any infrastructure changes needed
|
||||
3. Plan deployment strategy to minimize risk
|
||||
4. Define rollback procedures
|
||||
|
||||
Present deployment integration and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Existing Infrastructure
|
||||
|
||||
**Current Deployment:** {{existing_deployment_summary}}
|
||||
**Infrastructure Tools:** {{existing_infrastructure_tools}}
|
||||
**Environments:** {{existing_environments}}
|
||||
|
||||
### Enhancement Deployment Strategy
|
||||
|
||||
**Deployment Approach:** {{deployment_approach}}
|
||||
**Infrastructure Changes:** {{infrastructure_changes}}
|
||||
**Pipeline Integration:** {{pipeline_integration}}
|
||||
|
||||
### Rollback Strategy
|
||||
|
||||
**Rollback Method:** {{rollback_method}}
|
||||
**Risk Mitigation:** {{risk_mitigation}}
|
||||
**Monitoring:** {{monitoring_approach}}
|
||||
|
||||
## Coding Standards and Conventions
|
||||
|
||||
[[LLM: Ensure new code follows existing project conventions:
|
||||
|
||||
1. Document existing coding standards from project analysis
|
||||
2. Identify any enhancement-specific requirements
|
||||
3. Ensure consistency with existing codebase patterns
|
||||
4. Define standards for new code organization
|
||||
|
||||
Present coding standards and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Existing Standards Compliance
|
||||
|
||||
**Code Style:** {{existing_code_style}}
|
||||
**Linting Rules:** {{existing_linting}}
|
||||
**Testing Patterns:** {{existing_test_patterns}}
|
||||
**Documentation Style:** {{existing_doc_style}}
|
||||
|
||||
### Enhancement-Specific Standards
|
||||
|
||||
[[LLM: Only include if new patterns are needed for the enhancement]]
|
||||
|
||||
<<REPEAT: enhancement_standard>>
|
||||
|
||||
- **{{standard_name}}:** {{standard_description}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Critical Integration Rules
|
||||
|
||||
- **Existing API Compatibility:** {{api_compatibility_rule}}
|
||||
- **Database Integration:** {{db_integration_rule}}
|
||||
- **Error Handling:** {{error_handling_integration}}
|
||||
- **Logging Consistency:** {{logging_consistency}}
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
[[LLM: Define testing approach for the enhancement:
|
||||
|
||||
1. Integrate with existing test suite
|
||||
2. Ensure existing functionality remains intact
|
||||
3. Plan for testing new features
|
||||
4. Define integration testing approach
|
||||
|
||||
Present testing strategy and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Integration with Existing Tests
|
||||
|
||||
**Existing Test Framework:** {{existing_test_framework}}
|
||||
**Test Organization:** {{existing_test_organization}}
|
||||
**Coverage Requirements:** {{existing_coverage_requirements}}
|
||||
|
||||
### New Testing Requirements
|
||||
|
||||
#### Unit Tests for New Components
|
||||
|
||||
- **Framework:** {{test_framework}}
|
||||
- **Location:** {{test_location}}
|
||||
- **Coverage Target:** {{coverage_target}}
|
||||
- **Integration with Existing:** {{test_integration}}
|
||||
|
||||
#### Integration Tests
|
||||
|
||||
- **Scope:** {{integration_test_scope}}
|
||||
- **Existing System Verification:** {{existing_system_verification}}
|
||||
- **New Feature Testing:** {{new_feature_testing}}
|
||||
|
||||
#### Regression Testing
|
||||
|
||||
- **Existing Feature Verification:** {{regression_test_approach}}
|
||||
- **Automated Regression Suite:** {{automated_regression}}
|
||||
- **Manual Testing Requirements:** {{manual_testing_requirements}}
|
||||
|
||||
## Security Integration
|
||||
|
||||
[[LLM: Ensure security consistency with existing system:
|
||||
|
||||
1. Follow existing security patterns and tools
|
||||
2. Ensure new features don't introduce vulnerabilities
|
||||
3. Maintain existing security posture
|
||||
4. Define security testing for new components
|
||||
|
||||
Present security integration and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Existing Security Measures
|
||||
|
||||
**Authentication:** {{existing_auth}}
|
||||
**Authorization:** {{existing_authz}}
|
||||
**Data Protection:** {{existing_data_protection}}
|
||||
**Security Tools:** {{existing_security_tools}}
|
||||
|
||||
### Enhancement Security Requirements
|
||||
|
||||
**New Security Measures:** {{new_security_measures}}
|
||||
**Integration Points:** {{security_integration_points}}
|
||||
**Compliance Requirements:** {{compliance_requirements}}
|
||||
|
||||
### Security Testing
|
||||
|
||||
**Existing Security Tests:** {{existing_security_tests}}
|
||||
**New Security Test Requirements:** {{new_security_tests}}
|
||||
**Penetration Testing:** {{pentest_requirements}}
|
||||
|
||||
## Risk Assessment and Mitigation
|
||||
|
||||
[[LLM: Identify and plan for risks specific to brownfield development:
|
||||
|
||||
1. Technical integration risks
|
||||
2. Deployment and operational risks
|
||||
3. User impact and compatibility risks
|
||||
4. Mitigation strategies for each risk
|
||||
|
||||
Present risk assessment and apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Technical Risks
|
||||
|
||||
<<REPEAT: technical_risk>>
|
||||
|
||||
**Risk:** {{risk_description}}
|
||||
**Impact:** {{impact_level}}
|
||||
**Likelihood:** {{likelihood}}
|
||||
**Mitigation:** {{mitigation_strategy}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Operational Risks
|
||||
|
||||
<<REPEAT: operational_risk>>
|
||||
|
||||
**Risk:** {{risk_description}}
|
||||
**Impact:** {{impact_level}}
|
||||
**Likelihood:** {{likelihood}}
|
||||
**Mitigation:** {{mitigation_strategy}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Monitoring and Alerting
|
||||
|
||||
**Enhanced Monitoring:** {{monitoring_additions}}
|
||||
**New Alerts:** {{new_alerts}}
|
||||
**Performance Monitoring:** {{performance_monitoring}}
|
||||
|
||||
## Checklist Results Report
|
||||
|
||||
[[LLM: Execute the architect-checklist and populate results here, focusing on brownfield-specific validation]]
|
||||
|
||||
## Next Steps
|
||||
|
||||
[[LLM: After completing the brownfield architecture:
|
||||
|
||||
1. Review integration points with existing system
|
||||
2. Begin story implementation with Dev agent
|
||||
3. Set up deployment pipeline integration
|
||||
4. Plan rollback and monitoring procedures]]
|
||||
|
||||
### Story Manager Handoff
|
||||
|
||||
[[LLM: Create a brief prompt for Story Manager to work with this brownfield enhancement. Include:
|
||||
|
||||
- Reference to this architecture document
|
||||
- Key integration requirements validated with user
|
||||
- Existing system constraints based on actual project analysis
|
||||
- First story to implement with clear integration checkpoints
|
||||
- Emphasis on maintaining existing system integrity throughout implementation]]
|
||||
|
||||
### Developer Handoff
|
||||
|
||||
[[LLM: Create a brief prompt for developers starting implementation. Include:
|
||||
|
||||
- Reference to this architecture and existing coding standards analyzed from actual project
|
||||
- Integration requirements with existing codebase validated with user
|
||||
- Key technical decisions based on real project constraints
|
||||
- Existing system compatibility requirements with specific verification steps
|
||||
- Clear sequencing of implementation to minimize risk to existing functionality]]
|
||||
476
bmad-core/templates/brownfield-architecture-tmpl.yaml
Normal file
476
bmad-core/templates/brownfield-architecture-tmpl.yaml
Normal file
@@ -0,0 +1,476 @@
|
||||
template:
|
||||
id: brownfield-architecture-template-v2
|
||||
name: Brownfield Enhancement Architecture
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/architecture.md
|
||||
title: "{{project_name}} Brownfield Enhancement Architecture"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: |
|
||||
IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
|
||||
|
||||
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
|
||||
|
||||
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
|
||||
- Existing project technical documentation (from docs folder or user-provided)
|
||||
- Access to existing project structure (IDE or uploaded files)
|
||||
|
||||
3. **DEEP ANALYSIS MANDATE**: You MUST conduct thorough analysis of the existing codebase, architecture patterns, and technical constraints before making ANY architectural recommendations. Every suggestion must be based on actual project analysis, not assumptions.
|
||||
|
||||
4. **CONTINUOUS VALIDATION**: Throughout this process, explicitly validate your understanding with the user. For every architectural decision, confirm: "Based on my analysis of your existing system, I recommend [decision] because [evidence from actual project]. Does this align with your system's reality?"
|
||||
|
||||
If any required inputs are missing, request them before proceeding.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: intro-content
|
||||
content: |
|
||||
This document outlines the architectural approach for enhancing {{project_name}} with {{enhancement_description}}. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development of new features while ensuring seamless integration with the existing system.
|
||||
|
||||
**Relationship to Existing Architecture:**
|
||||
This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements.
|
||||
- id: existing-project-analysis
|
||||
title: Existing Project Analysis
|
||||
instruction: |
|
||||
Analyze the existing project structure and architecture:
|
||||
|
||||
1. Review existing documentation in docs folder
|
||||
2. Examine current technology stack and versions
|
||||
3. Identify existing architectural patterns and conventions
|
||||
4. Note current deployment and infrastructure setup
|
||||
5. Document any constraints or limitations
|
||||
|
||||
CRITICAL: After your analysis, explicitly validate your findings: "Based on my analysis of your project, I've identified the following about your existing system: [key findings]. Please confirm these observations are accurate before I proceed with architectural recommendations."
|
||||
elicit: true
|
||||
sections:
|
||||
- id: current-state
|
||||
title: Current Project State
|
||||
template: |
|
||||
- **Primary Purpose:** {{existing_project_purpose}}
|
||||
- **Current Tech Stack:** {{existing_tech_summary}}
|
||||
- **Architecture Style:** {{existing_architecture_style}}
|
||||
- **Deployment Method:** {{existing_deployment_approach}}
|
||||
- id: available-docs
|
||||
title: Available Documentation
|
||||
type: bullet-list
|
||||
template: "- {{existing_docs_summary}}"
|
||||
- id: constraints
|
||||
title: Identified Constraints
|
||||
type: bullet-list
|
||||
template: "- {{constraint}}"
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Change, Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: enhancement-scope
|
||||
title: Enhancement Scope and Integration Strategy
|
||||
instruction: |
|
||||
Define how the enhancement will integrate with the existing system:
|
||||
|
||||
1. Review the brownfield PRD enhancement scope
|
||||
2. Identify integration points with existing code
|
||||
3. Define boundaries between new and existing functionality
|
||||
4. Establish compatibility requirements
|
||||
|
||||
VALIDATION CHECKPOINT: Before presenting the integration strategy, confirm: "Based on my analysis, the integration approach I'm proposing takes into account [specific existing system characteristics]. These integration points and boundaries respect your current architecture patterns. Is this assessment accurate?"
|
||||
elicit: true
|
||||
sections:
|
||||
- id: enhancement-overview
|
||||
title: Enhancement Overview
|
||||
template: |
|
||||
**Enhancement Type:** {{enhancement_type}}
|
||||
**Scope:** {{enhancement_scope}}
|
||||
**Integration Impact:** {{integration_impact_level}}
|
||||
- id: integration-approach
|
||||
title: Integration Approach
|
||||
template: |
|
||||
**Code Integration Strategy:** {{code_integration_approach}}
|
||||
**Database Integration:** {{database_integration_approach}}
|
||||
**API Integration:** {{api_integration_approach}}
|
||||
**UI Integration:** {{ui_integration_approach}}
|
||||
- id: compatibility-requirements
|
||||
title: Compatibility Requirements
|
||||
template: |
|
||||
- **Existing API Compatibility:** {{api_compatibility}}
|
||||
- **Database Schema Compatibility:** {{db_compatibility}}
|
||||
- **UI/UX Consistency:** {{ui_compatibility}}
|
||||
- **Performance Impact:** {{performance_constraints}}
|
||||
|
||||
- id: tech-stack-alignment
|
||||
title: Tech Stack Alignment
|
||||
instruction: |
|
||||
Ensure new components align with existing technology choices:
|
||||
|
||||
1. Use existing technology stack as the foundation
|
||||
2. Only introduce new technologies if absolutely necessary
|
||||
3. Justify any new additions with clear rationale
|
||||
4. Ensure version compatibility with existing dependencies
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-stack
|
||||
title: Existing Technology Stack
|
||||
type: table
|
||||
columns: [Category, Current Technology, Version, Usage in Enhancement, Notes]
|
||||
instruction: Document the current stack that must be maintained or integrated with
|
||||
- id: new-tech-additions
|
||||
title: New Technology Additions
|
||||
condition: Enhancement requires new technologies
|
||||
type: table
|
||||
columns: [Technology, Version, Purpose, Rationale, Integration Method]
|
||||
instruction: Only include if new technologies are required for the enhancement
|
||||
|
||||
- id: data-models
|
||||
title: Data Models and Schema Changes
|
||||
instruction: |
|
||||
Define new data models and how they integrate with existing schema:
|
||||
|
||||
1. Identify new entities required for the enhancement
|
||||
2. Define relationships with existing data models
|
||||
3. Plan database schema changes (additions, modifications)
|
||||
4. Ensure backward compatibility
|
||||
elicit: true
|
||||
sections:
|
||||
- id: new-models
|
||||
title: New Data Models
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: model
|
||||
title: "{{model_name}}"
|
||||
template: |
|
||||
**Purpose:** {{model_purpose}}
|
||||
**Integration:** {{integration_with_existing}}
|
||||
|
||||
**Key Attributes:**
|
||||
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
||||
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
||||
|
||||
**Relationships:**
|
||||
- **With Existing:** {{existing_relationships}}
|
||||
- **With New:** {{new_relationships}}
|
||||
- id: schema-integration
|
||||
title: Schema Integration Strategy
|
||||
template: |
|
||||
**Database Changes Required:**
|
||||
- **New Tables:** {{new_tables_list}}
|
||||
- **Modified Tables:** {{modified_tables_list}}
|
||||
- **New Indexes:** {{new_indexes_list}}
|
||||
- **Migration Strategy:** {{migration_approach}}
|
||||
|
||||
**Backward Compatibility:**
|
||||
- {{compatibility_measure_1}}
|
||||
- {{compatibility_measure_2}}
|
||||
|
||||
- id: component-architecture
|
||||
title: Component Architecture
|
||||
instruction: |
|
||||
Define new components and their integration with existing architecture:
|
||||
|
||||
1. Identify new components required for the enhancement
|
||||
2. Define interfaces with existing components
|
||||
3. Establish clear boundaries and responsibilities
|
||||
4. Plan integration points and data flow
|
||||
|
||||
MANDATORY VALIDATION: Before presenting component architecture, confirm: "The new components I'm proposing follow the existing architectural patterns I identified in your codebase: [specific patterns]. The integration interfaces respect your current component structure and communication patterns. Does this match your project's reality?"
|
||||
elicit: true
|
||||
sections:
|
||||
- id: new-components
|
||||
title: New Components
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: component
|
||||
title: "{{component_name}}"
|
||||
template: |
|
||||
**Responsibility:** {{component_description}}
|
||||
**Integration Points:** {{integration_points}}
|
||||
|
||||
**Key Interfaces:**
|
||||
- {{interface_1}}
|
||||
- {{interface_2}}
|
||||
|
||||
**Dependencies:**
|
||||
- **Existing Components:** {{existing_dependencies}}
|
||||
- **New Components:** {{new_dependencies}}
|
||||
|
||||
**Technology Stack:** {{component_tech_details}}
|
||||
- id: interaction-diagram
|
||||
title: Component Interaction Diagram
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
instruction: Create Mermaid diagram showing how new components interact with existing ones
|
||||
|
||||
- id: api-design
|
||||
title: API Design and Integration
|
||||
condition: Enhancement requires API changes
|
||||
instruction: |
|
||||
Define new API endpoints and integration with existing APIs:
|
||||
|
||||
1. Plan new API endpoints required for the enhancement
|
||||
2. Ensure consistency with existing API patterns
|
||||
3. Define authentication and authorization integration
|
||||
4. Plan versioning strategy if needed
|
||||
elicit: true
|
||||
sections:
|
||||
- id: api-strategy
|
||||
title: API Integration Strategy
|
||||
template: |
|
||||
**API Integration Strategy:** {{api_integration_strategy}}
|
||||
**Authentication:** {{auth_integration}}
|
||||
**Versioning:** {{versioning_approach}}
|
||||
- id: new-endpoints
|
||||
title: New API Endpoints
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: endpoint
|
||||
title: "{{endpoint_name}}"
|
||||
template: |
|
||||
- **Method:** {{http_method}}
|
||||
- **Endpoint:** {{endpoint_path}}
|
||||
- **Purpose:** {{endpoint_purpose}}
|
||||
- **Integration:** {{integration_with_existing}}
|
||||
sections:
|
||||
- id: request
|
||||
title: Request
|
||||
type: code
|
||||
language: json
|
||||
template: "{{request_schema}}"
|
||||
- id: response
|
||||
title: Response
|
||||
type: code
|
||||
language: json
|
||||
template: "{{response_schema}}"
|
||||
|
||||
- id: external-api-integration
|
||||
title: External API Integration
|
||||
condition: Enhancement requires new external APIs
|
||||
instruction: Document new external API integrations required for the enhancement
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: external-api
|
||||
title: "{{api_name}} API"
|
||||
template: |
|
||||
- **Purpose:** {{api_purpose}}
|
||||
- **Documentation:** {{api_docs_url}}
|
||||
- **Base URL:** {{api_base_url}}
|
||||
- **Authentication:** {{auth_method}}
|
||||
- **Integration Method:** {{integration_approach}}
|
||||
|
||||
**Key Endpoints Used:**
|
||||
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
||||
|
||||
**Error Handling:** {{error_handling_strategy}}
|
||||
|
||||
- id: source-tree-integration
|
||||
title: Source Tree Integration
|
||||
instruction: |
|
||||
Define how new code will integrate with existing project structure:
|
||||
|
||||
1. Follow existing project organization patterns
|
||||
2. Identify where new files/folders will be placed
|
||||
3. Ensure consistency with existing naming conventions
|
||||
4. Plan for minimal disruption to existing structure
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-structure
|
||||
title: Existing Project Structure
|
||||
type: code
|
||||
language: plaintext
|
||||
instruction: Document relevant parts of current structure
|
||||
template: "{{existing_structure_relevant_parts}}"
|
||||
- id: new-file-organization
|
||||
title: New File Organization
|
||||
type: code
|
||||
language: plaintext
|
||||
instruction: Show only new additions to existing structure
|
||||
template: |
|
||||
{{project-root}}/
|
||||
├── {{existing_structure_context}}
|
||||
│ ├── {{new_folder_1}}/ # {{purpose_1}}
|
||||
│ │ ├── {{new_file_1}}
|
||||
│ │ └── {{new_file_2}}
|
||||
│ ├── {{existing_folder}}/ # Existing folder with additions
|
||||
│ │ ├── {{existing_file}} # Existing file
|
||||
│ │ └── {{new_file_3}} # New addition
|
||||
│ └── {{new_folder_2}}/ # {{purpose_2}}
|
||||
- id: integration-guidelines
|
||||
title: Integration Guidelines
|
||||
template: |
|
||||
- **File Naming:** {{file_naming_consistency}}
|
||||
- **Folder Organization:** {{folder_organization_approach}}
|
||||
- **Import/Export Patterns:** {{import_export_consistency}}
|
||||
|
||||
- id: infrastructure-deployment
|
||||
title: Infrastructure and Deployment Integration
|
||||
instruction: |
|
||||
Define how the enhancement will be deployed alongside existing infrastructure:
|
||||
|
||||
1. Use existing deployment pipeline and infrastructure
|
||||
2. Identify any infrastructure changes needed
|
||||
3. Plan deployment strategy to minimize risk
|
||||
4. Define rollback procedures
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-infrastructure
|
||||
title: Existing Infrastructure
|
||||
template: |
|
||||
**Current Deployment:** {{existing_deployment_summary}}
|
||||
**Infrastructure Tools:** {{existing_infrastructure_tools}}
|
||||
**Environments:** {{existing_environments}}
|
||||
- id: enhancement-deployment
|
||||
title: Enhancement Deployment Strategy
|
||||
template: |
|
||||
**Deployment Approach:** {{deployment_approach}}
|
||||
**Infrastructure Changes:** {{infrastructure_changes}}
|
||||
**Pipeline Integration:** {{pipeline_integration}}
|
||||
- id: rollback-strategy
|
||||
title: Rollback Strategy
|
||||
template: |
|
||||
**Rollback Method:** {{rollback_method}}
|
||||
**Risk Mitigation:** {{risk_mitigation}}
|
||||
**Monitoring:** {{monitoring_approach}}
|
||||
|
||||
- id: coding-standards
|
||||
title: Coding Standards and Conventions
|
||||
instruction: |
|
||||
Ensure new code follows existing project conventions:
|
||||
|
||||
1. Document existing coding standards from project analysis
|
||||
2. Identify any enhancement-specific requirements
|
||||
3. Ensure consistency with existing codebase patterns
|
||||
4. Define standards for new code organization
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-standards
|
||||
title: Existing Standards Compliance
|
||||
template: |
|
||||
**Code Style:** {{existing_code_style}}
|
||||
**Linting Rules:** {{existing_linting}}
|
||||
**Testing Patterns:** {{existing_test_patterns}}
|
||||
**Documentation Style:** {{existing_doc_style}}
|
||||
- id: enhancement-standards
|
||||
title: Enhancement-Specific Standards
|
||||
condition: New patterns needed for enhancement
|
||||
repeatable: true
|
||||
template: "- **{{standard_name}}:** {{standard_description}}"
|
||||
- id: integration-rules
|
||||
title: Critical Integration Rules
|
||||
template: |
|
||||
- **Existing API Compatibility:** {{api_compatibility_rule}}
|
||||
- **Database Integration:** {{db_integration_rule}}
|
||||
- **Error Handling:** {{error_handling_integration}}
|
||||
- **Logging Consistency:** {{logging_consistency}}
|
||||
|
||||
- id: testing-strategy
|
||||
title: Testing Strategy
|
||||
instruction: |
|
||||
Define testing approach for the enhancement:
|
||||
|
||||
1. Integrate with existing test suite
|
||||
2. Ensure existing functionality remains intact
|
||||
3. Plan for testing new features
|
||||
4. Define integration testing approach
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-test-integration
|
||||
title: Integration with Existing Tests
|
||||
template: |
|
||||
**Existing Test Framework:** {{existing_test_framework}}
|
||||
**Test Organization:** {{existing_test_organization}}
|
||||
**Coverage Requirements:** {{existing_coverage_requirements}}
|
||||
- id: new-testing
|
||||
title: New Testing Requirements
|
||||
sections:
|
||||
- id: unit-tests
|
||||
title: Unit Tests for New Components
|
||||
template: |
|
||||
- **Framework:** {{test_framework}}
|
||||
- **Location:** {{test_location}}
|
||||
- **Coverage Target:** {{coverage_target}}
|
||||
- **Integration with Existing:** {{test_integration}}
|
||||
- id: integration-tests
|
||||
title: Integration Tests
|
||||
template: |
|
||||
- **Scope:** {{integration_test_scope}}
|
||||
- **Existing System Verification:** {{existing_system_verification}}
|
||||
- **New Feature Testing:** {{new_feature_testing}}
|
||||
- id: regression-tests
|
||||
title: Regression Testing
|
||||
template: |
|
||||
- **Existing Feature Verification:** {{regression_test_approach}}
|
||||
- **Automated Regression Suite:** {{automated_regression}}
|
||||
- **Manual Testing Requirements:** {{manual_testing_requirements}}
|
||||
|
||||
- id: security-integration
|
||||
title: Security Integration
|
||||
instruction: |
|
||||
Ensure security consistency with existing system:
|
||||
|
||||
1. Follow existing security patterns and tools
|
||||
2. Ensure new features don't introduce vulnerabilities
|
||||
3. Maintain existing security posture
|
||||
4. Define security testing for new components
|
||||
elicit: true
|
||||
sections:
|
||||
- id: existing-security
|
||||
title: Existing Security Measures
|
||||
template: |
|
||||
**Authentication:** {{existing_auth}}
|
||||
**Authorization:** {{existing_authz}}
|
||||
**Data Protection:** {{existing_data_protection}}
|
||||
**Security Tools:** {{existing_security_tools}}
|
||||
- id: enhancement-security
|
||||
title: Enhancement Security Requirements
|
||||
template: |
|
||||
**New Security Measures:** {{new_security_measures}}
|
||||
**Integration Points:** {{security_integration_points}}
|
||||
**Compliance Requirements:** {{compliance_requirements}}
|
||||
- id: security-testing
|
||||
title: Security Testing
|
||||
template: |
|
||||
**Existing Security Tests:** {{existing_security_tests}}
|
||||
**New Security Test Requirements:** {{new_security_tests}}
|
||||
**Penetration Testing:** {{pentest_requirements}}
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results Report
|
||||
instruction: Execute the architect-checklist and populate results here, focusing on brownfield-specific validation
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
instruction: |
|
||||
After completing the brownfield architecture:
|
||||
|
||||
1. Review integration points with existing system
|
||||
2. Begin story implementation with Dev agent
|
||||
3. Set up deployment pipeline integration
|
||||
4. Plan rollback and monitoring procedures
|
||||
sections:
|
||||
- id: story-manager-handoff
|
||||
title: Story Manager Handoff
|
||||
instruction: |
|
||||
Create a brief prompt for Story Manager to work with this brownfield enhancement. Include:
|
||||
- Reference to this architecture document
|
||||
- Key integration requirements validated with user
|
||||
- Existing system constraints based on actual project analysis
|
||||
- First story to implement with clear integration checkpoints
|
||||
- Emphasis on maintaining existing system integrity throughout implementation
|
||||
- id: developer-handoff
|
||||
title: Developer Handoff
|
||||
instruction: |
|
||||
Create a brief prompt for developers starting implementation. Include:
|
||||
- Reference to this architecture and existing coding standards analyzed from actual project
|
||||
- Integration requirements with existing codebase validated with user
|
||||
- Key technical decisions based on real project constraints
|
||||
- Existing system compatibility requirements with specific verification steps
|
||||
- Clear sequencing of implementation to minimize risk to existing functionality
|
||||
@@ -1,266 +0,0 @@
|
||||
# {{Project Name}} Brownfield Enhancement PRD
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
||||
|
||||
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
|
||||
|
||||
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
|
||||
|
||||
1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
|
||||
|
||||
2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
|
||||
|
||||
3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.]]
|
||||
|
||||
## Intro Project Analysis and Context
|
||||
|
||||
[[LLM: Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
|
||||
|
||||
CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
|
||||
|
||||
Do not proceed with any recommendations until the user has validated your understanding of the existing system.]]
|
||||
|
||||
### Existing Project Overview
|
||||
|
||||
[[LLM: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.]]
|
||||
|
||||
**Analysis Source**: [[LLM: Indicate one of the following:
|
||||
- Document-project output available at: {{path}}
|
||||
- IDE-based fresh analysis
|
||||
- User-provided information
|
||||
]]
|
||||
|
||||
**Current Project State**: [[LLM:
|
||||
- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
|
||||
- Otherwise: Brief description of what the project currently does and its primary purpose
|
||||
]]
|
||||
|
||||
### Available Documentation Analysis
|
||||
|
||||
[[LLM:
|
||||
If document-project was run:
|
||||
- Note: "Document-project analysis available - using existing technical documentation"
|
||||
- List key documents created by document-project
|
||||
- Skip the missing documentation check below
|
||||
|
||||
Otherwise, check for existing documentation:
|
||||
]]
|
||||
|
||||
**Available Documentation**:
|
||||
|
||||
- [ ] Tech Stack Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Source Tree/Architecture [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Coding Standards [[LLM: If from document-project, may be partial]]
|
||||
- [ ] API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] External API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] UX/UI Guidelines [[LLM: May not be in document-project]]
|
||||
- [ ] Technical Debt Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Other: \***\*\_\_\_\*\***
|
||||
|
||||
[[LLM:
|
||||
- If document-project was already run: "Using existing project analysis from document-project output."
|
||||
- If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
|
||||
]]
|
||||
|
||||
### Enhancement Scope Definition
|
||||
|
||||
[[LLM: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.]]
|
||||
|
||||
**Enhancement Type**: [[LLM: Determine with user which applies]]
|
||||
|
||||
- [ ] New Feature Addition
|
||||
- [ ] Major Feature Modification
|
||||
- [ ] Integration with New Systems
|
||||
- [ ] Performance/Scalability Improvements
|
||||
- [ ] UI/UX Overhaul
|
||||
- [ ] Technology Stack Upgrade
|
||||
- [ ] Bug Fix and Stability Improvements
|
||||
- [ ] Other: \***\*\_\_\_\*\***
|
||||
|
||||
**Enhancement Description**: [[LLM: 2-3 sentences describing what the user wants to add or change]]
|
||||
|
||||
**Impact Assessment**: [[LLM: Assess the scope of impact on existing codebase]]
|
||||
|
||||
- [ ] Minimal Impact (isolated additions)
|
||||
- [ ] Moderate Impact (some existing code changes)
|
||||
- [ ] Significant Impact (substantial existing code changes)
|
||||
- [ ] Major Impact (architectural changes required)
|
||||
|
||||
### Goals and Background Context
|
||||
|
||||
#### Goals
|
||||
|
||||
[[LLM: Bullet list of 1-line desired outcomes this enhancement will deliver if successful]]
|
||||
|
||||
#### Background Context
|
||||
|
||||
[[LLM: 1-2 short paragraphs explaining why this enhancement is needed, what problem it solves, and how it fits with the existing project]]
|
||||
|
||||
### Change Log
|
||||
|
||||
| Change | Date | Version | Description | Author |
|
||||
| ------ | ---- | ------- | ----------- | ------ |
|
||||
|
||||
## Requirements
|
||||
|
||||
[[LLM: Draft functional and non-functional requirements based on your validated understanding of the existing project. Before presenting requirements, confirm: "These requirements are based on my understanding of your existing system. Please review carefully and confirm they align with your project's reality." Then immediately execute tasks#advanced-elicitation display]]
|
||||
|
||||
### Functional
|
||||
|
||||
[[LLM: Each Requirement will be a bullet markdown with identifier starting with FR]]
|
||||
@{example: - FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality.}
|
||||
|
||||
### Non Functional
|
||||
|
||||
[[LLM: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system]]
|
||||
@{example: - NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%.}
|
||||
|
||||
### Compatibility Requirements
|
||||
|
||||
[[LLM: Critical for brownfield - what must remain compatible]]
|
||||
|
||||
- CR1: [[LLM: Existing API compatibility requirements]]
|
||||
- CR2: [[LLM: Database schema compatibility requirements]]
|
||||
- CR3: [[LLM: UI/UX consistency requirements]]
|
||||
- CR4: [[LLM: Integration compatibility requirements]]
|
||||
|
||||
^^CONDITION: has_ui^^
|
||||
|
||||
## User Interface Enhancement Goals
|
||||
|
||||
[[LLM: For UI changes, capture how they will integrate with existing UI patterns and design systems]]
|
||||
|
||||
### Integration with Existing UI
|
||||
|
||||
[[LLM: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries]]
|
||||
|
||||
### Modified/New Screens and Views
|
||||
|
||||
[[LLM: List only the screens/views that will be modified or added]]
|
||||
|
||||
### UI Consistency Requirements
|
||||
|
||||
[[LLM: Specific requirements for maintaining visual and interaction consistency with existing application]]
|
||||
|
||||
^^/CONDITION: has_ui^^
|
||||
|
||||
## Technical Constraints and Integration Requirements
|
||||
|
||||
[[LLM: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.]]
|
||||
|
||||
### Existing Technology Stack
|
||||
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
||||
- Include version numbers and any noted constraints
|
||||
|
||||
Otherwise, document the current technology stack:
|
||||
]]
|
||||
|
||||
**Languages**: [[LLM: From document-project or fresh analysis]]
|
||||
**Frameworks**: [[LLM: From document-project or fresh analysis]]
|
||||
**Database**: [[LLM: From document-project or fresh analysis]]
|
||||
**Infrastructure**: [[LLM: From document-project or fresh analysis]]
|
||||
**External Dependencies**: [[LLM: From document-project "External Services" section or fresh analysis]]
|
||||
|
||||
### Integration Approach
|
||||
|
||||
[[LLM: Define how the enhancement will integrate with existing architecture]]
|
||||
|
||||
**Database Integration Strategy**: [[LLM: How new features will interact with existing database]]
|
||||
**API Integration Strategy**: [[LLM: How new APIs will integrate with existing API structure]]
|
||||
**Frontend Integration Strategy**: [[LLM: How new UI components will integrate with existing frontend]]
|
||||
**Testing Integration Strategy**: [[LLM: How new tests will integrate with existing test suite]]
|
||||
|
||||
### Code Organization and Standards
|
||||
|
||||
[[LLM: Based on existing project analysis, define how new code will fit existing patterns]]
|
||||
|
||||
**File Structure Approach**: [[LLM: How new files will fit existing project structure]]
|
||||
**Naming Conventions**: [[LLM: Existing naming conventions that must be followed]]
|
||||
**Coding Standards**: [[LLM: Existing coding standards and linting rules]]
|
||||
**Documentation Standards**: [[LLM: How new code documentation will match existing patterns]]
|
||||
|
||||
### Deployment and Operations
|
||||
|
||||
[[LLM: How the enhancement fits existing deployment pipeline]]
|
||||
|
||||
**Build Process Integration**: [[LLM: How enhancement builds with existing process]]
|
||||
**Deployment Strategy**: [[LLM: How enhancement will be deployed alongside existing features]]
|
||||
**Monitoring and Logging**: [[LLM: How enhancement will integrate with existing monitoring]]
|
||||
**Configuration Management**: [[LLM: How new configuration will integrate with existing config]]
|
||||
|
||||
### Risk Assessment and Mitigation
|
||||
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Reference "Technical Debt and Known Issues" section
|
||||
- Include "Workarounds and Gotchas" that might impact enhancement
|
||||
- Note any identified constraints from "Critical Technical Debt"
|
||||
|
||||
Build risk assessment incorporating existing known issues:
|
||||
]]
|
||||
|
||||
**Technical Risks**: [[LLM: Include risks from document-project + new enhancement risks]]
|
||||
**Integration Risks**: [[LLM: Reference integration constraints from document-project]]
|
||||
**Deployment Risks**: [[LLM: Include deployment gotchas from document-project]]
|
||||
**Mitigation Strategies**: [[LLM: Address both existing and new risks]]
|
||||
|
||||
## Epic and Story Structure
|
||||
|
||||
[[LLM: For brownfield projects, favor a single comprehensive epic unless the user is clearly requesting multiple unrelated enhancements. Before presenting the epic structure, confirm: "Based on my analysis of your existing project, I believe this enhancement should be structured as [single epic/multiple epics] because [rationale based on actual project analysis]. Does this align with your understanding of the work required?" Then present the epic structure and immediately execute tasks#advanced-elicitation display.]]
|
||||
|
||||
### Epic Approach
|
||||
|
||||
[[LLM: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features]]
|
||||
|
||||
**Epic Structure Decision**: [[LLM: Single Epic or Multiple Epics with rationale]]
|
||||
|
||||
## Epic 1: {{enhancement_title}}
|
||||
|
||||
[[LLM: Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality]]
|
||||
|
||||
**Epic Goal**: [[LLM: 2-3 sentences describing the complete enhancement objective and value]]
|
||||
|
||||
**Integration Requirements**: [[LLM: Key integration points with existing system]]
|
||||
|
||||
[[LLM: CRITICAL STORY SEQUENCING FOR BROWNFIELD:
|
||||
|
||||
- Stories must ensure existing functionality remains intact
|
||||
- Each story should include verification that existing features still work
|
||||
- Stories should be sequenced to minimize risk to existing system
|
||||
- Include rollback considerations for each story
|
||||
- Focus on incremental integration rather than big-bang changes
|
||||
- Size stories for AI agent execution in existing codebase context
|
||||
- MANDATORY: Present the complete story sequence and ask: "This story sequence is designed to minimize risk to your existing system. Does this order make sense given your project's architecture and constraints?"
|
||||
- Stories must be logically sequential with clear dependencies identified
|
||||
- Each story must deliver value while maintaining system integrity]]
|
||||
|
||||
<<REPEAT: story>>
|
||||
|
||||
### Story 1.{{story_number}} {{story_title}}
|
||||
|
||||
As a {{user_type}},
|
||||
I want {{action}},
|
||||
so that {{benefit}}.
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
[[LLM: Define criteria that include both new functionality and existing system integrity]]
|
||||
|
||||
<<REPEAT: criteria>>
|
||||
|
||||
- {{criterion number}}: {{criteria}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
#### Integration Verification
|
||||
|
||||
[[LLM: Specific verification steps to ensure existing functionality remains intact]]
|
||||
|
||||
- IV1: [[LLM: Existing functionality verification requirement]]
|
||||
- IV2: [[LLM: Integration point verification requirement]]
|
||||
- IV3: [[LLM: Performance impact verification requirement]]
|
||||
|
||||
<</REPEAT>>
|
||||
280
bmad-core/templates/brownfield-prd-tmpl.yaml
Normal file
280
bmad-core/templates/brownfield-prd-tmpl.yaml
Normal file
@@ -0,0 +1,280 @@
|
||||
template:
|
||||
id: brownfield-prd-template-v2
|
||||
name: Brownfield Enhancement PRD
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/prd.md
|
||||
title: "{{project_name}} Brownfield Enhancement PRD"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: intro-analysis
|
||||
title: Intro Project Analysis and Context
|
||||
instruction: |
|
||||
IMPORTANT - SCOPE ASSESSMENT REQUIRED:
|
||||
|
||||
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
|
||||
|
||||
1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
|
||||
|
||||
2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
|
||||
|
||||
3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.
|
||||
|
||||
Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
|
||||
|
||||
CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
|
||||
|
||||
Do not proceed with any recommendations until the user has validated your understanding of the existing system.
|
||||
sections:
|
||||
- id: existing-project-overview
|
||||
title: Existing Project Overview
|
||||
instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.
|
||||
sections:
|
||||
- id: analysis-source
|
||||
title: Analysis Source
|
||||
instruction: |
|
||||
Indicate one of the following:
|
||||
- Document-project output available at: {{path}}
|
||||
- IDE-based fresh analysis
|
||||
- User-provided information
|
||||
- id: current-state
|
||||
title: Current Project State
|
||||
instruction: |
|
||||
- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
|
||||
- Otherwise: Brief description of what the project currently does and its primary purpose
|
||||
- id: documentation-analysis
|
||||
title: Available Documentation Analysis
|
||||
instruction: |
|
||||
If document-project was run:
|
||||
- Note: "Document-project analysis available - using existing technical documentation"
|
||||
- List key documents created by document-project
|
||||
- Skip the missing documentation check below
|
||||
|
||||
Otherwise, check for existing documentation:
|
||||
sections:
|
||||
- id: available-docs
|
||||
title: Available Documentation
|
||||
type: checklist
|
||||
items:
|
||||
- Tech Stack Documentation [[LLM: If from document-project, check ✓]]
|
||||
- Source Tree/Architecture [[LLM: If from document-project, check ✓]]
|
||||
- Coding Standards [[LLM: If from document-project, may be partial]]
|
||||
- API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- External API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- UX/UI Guidelines [[LLM: May not be in document-project]]
|
||||
- Technical Debt Documentation [[LLM: If from document-project, check ✓]]
|
||||
- "Other: {{other_docs}}"
|
||||
instruction: |
|
||||
- If document-project was already run: "Using existing project analysis from document-project output."
|
||||
- If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
|
||||
- id: enhancement-scope
|
||||
title: Enhancement Scope Definition
|
||||
instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.
|
||||
sections:
|
||||
- id: enhancement-type
|
||||
title: Enhancement Type
|
||||
type: checklist
|
||||
instruction: Determine with user which applies
|
||||
items:
|
||||
- New Feature Addition
|
||||
- Major Feature Modification
|
||||
- Integration with New Systems
|
||||
- Performance/Scalability Improvements
|
||||
- UI/UX Overhaul
|
||||
- Technology Stack Upgrade
|
||||
- Bug Fix and Stability Improvements
|
||||
- "Other: {{other_type}}"
|
||||
- id: enhancement-description
|
||||
title: Enhancement Description
|
||||
instruction: 2-3 sentences describing what the user wants to add or change
|
||||
- id: impact-assessment
|
||||
title: Impact Assessment
|
||||
type: checklist
|
||||
instruction: Assess the scope of impact on existing codebase
|
||||
items:
|
||||
- Minimal Impact (isolated additions)
|
||||
- Moderate Impact (some existing code changes)
|
||||
- Significant Impact (substantial existing code changes)
|
||||
- Major Impact (architectural changes required)
|
||||
- id: goals-context
|
||||
title: Goals and Background Context
|
||||
sections:
|
||||
- id: goals
|
||||
title: Goals
|
||||
type: bullet-list
|
||||
instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful
|
||||
- id: background
|
||||
title: Background Context
|
||||
type: paragraphs
|
||||
instruction: 1-2 short paragraphs explaining why this enhancement is needed, what problem it solves, and how it fits with the existing project
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Change, Date, Version, Description, Author]
|
||||
|
||||
- id: requirements
|
||||
title: Requirements
|
||||
instruction: |
|
||||
Draft functional and non-functional requirements based on your validated understanding of the existing project. Before presenting requirements, confirm: "These requirements are based on my understanding of your existing system. Please review carefully and confirm they align with your project's reality."
|
||||
elicit: true
|
||||
sections:
|
||||
- id: functional
|
||||
title: Functional
|
||||
type: numbered-list
|
||||
prefix: FR
|
||||
instruction: Each Requirement will be a bullet markdown with identifier starting with FR
|
||||
examples:
|
||||
- "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality."
|
||||
- id: non-functional
|
||||
title: Non Functional
|
||||
type: numbered-list
|
||||
prefix: NFR
|
||||
instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system
|
||||
examples:
|
||||
- "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%."
|
||||
- id: compatibility
|
||||
title: Compatibility Requirements
|
||||
instruction: Critical for brownfield - what must remain compatible
|
||||
type: numbered-list
|
||||
prefix: CR
|
||||
template: "{{requirement}}: {{description}}"
|
||||
items:
|
||||
- id: cr1
|
||||
template: "CR1: {{existing_api_compatibility}}"
|
||||
- id: cr2
|
||||
template: "CR2: {{database_schema_compatibility}}"
|
||||
- id: cr3
|
||||
template: "CR3: {{ui_ux_consistency}}"
|
||||
- id: cr4
|
||||
template: "CR4: {{integration_compatibility}}"
|
||||
|
||||
- id: ui-enhancement-goals
|
||||
title: User Interface Enhancement Goals
|
||||
condition: Enhancement includes UI changes
|
||||
instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems
|
||||
sections:
|
||||
- id: existing-ui-integration
|
||||
title: Integration with Existing UI
|
||||
instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries
|
||||
- id: modified-screens
|
||||
title: Modified/New Screens and Views
|
||||
instruction: List only the screens/views that will be modified or added
|
||||
- id: ui-consistency
|
||||
title: UI Consistency Requirements
|
||||
instruction: Specific requirements for maintaining visual and interaction consistency with existing application
|
||||
|
||||
- id: technical-constraints
|
||||
title: Technical Constraints and Integration Requirements
|
||||
instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.
|
||||
sections:
|
||||
- id: existing-tech-stack
|
||||
title: Existing Technology Stack
|
||||
instruction: |
|
||||
If document-project output available:
|
||||
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
||||
- Include version numbers and any noted constraints
|
||||
|
||||
Otherwise, document the current technology stack:
|
||||
template: |
|
||||
**Languages**: {{languages}}
|
||||
**Frameworks**: {{frameworks}}
|
||||
**Database**: {{database}}
|
||||
**Infrastructure**: {{infrastructure}}
|
||||
**External Dependencies**: {{external_dependencies}}
|
||||
- id: integration-approach
|
||||
title: Integration Approach
|
||||
instruction: Define how the enhancement will integrate with existing architecture
|
||||
template: |
|
||||
**Database Integration Strategy**: {{database_integration}}
|
||||
**API Integration Strategy**: {{api_integration}}
|
||||
**Frontend Integration Strategy**: {{frontend_integration}}
|
||||
**Testing Integration Strategy**: {{testing_integration}}
|
||||
- id: code-organization
|
||||
title: Code Organization and Standards
|
||||
instruction: Based on existing project analysis, define how new code will fit existing patterns
|
||||
template: |
|
||||
**File Structure Approach**: {{file_structure}}
|
||||
**Naming Conventions**: {{naming_conventions}}
|
||||
**Coding Standards**: {{coding_standards}}
|
||||
**Documentation Standards**: {{documentation_standards}}
|
||||
- id: deployment-operations
|
||||
title: Deployment and Operations
|
||||
instruction: How the enhancement fits existing deployment pipeline
|
||||
template: |
|
||||
**Build Process Integration**: {{build_integration}}
|
||||
**Deployment Strategy**: {{deployment_strategy}}
|
||||
**Monitoring and Logging**: {{monitoring_logging}}
|
||||
**Configuration Management**: {{config_management}}
|
||||
- id: risk-assessment
|
||||
title: Risk Assessment and Mitigation
|
||||
instruction: |
|
||||
If document-project output available:
|
||||
- Reference "Technical Debt and Known Issues" section
|
||||
- Include "Workarounds and Gotchas" that might impact enhancement
|
||||
- Note any identified constraints from "Critical Technical Debt"
|
||||
|
||||
Build risk assessment incorporating existing known issues:
|
||||
template: |
|
||||
**Technical Risks**: {{technical_risks}}
|
||||
**Integration Risks**: {{integration_risks}}
|
||||
**Deployment Risks**: {{deployment_risks}}
|
||||
**Mitigation Strategies**: {{mitigation_strategies}}
|
||||
|
||||
- id: epic-structure
|
||||
title: Epic and Story Structure
|
||||
instruction: |
|
||||
For brownfield projects, favor a single comprehensive epic unless the user is clearly requesting multiple unrelated enhancements. Before presenting the epic structure, confirm: "Based on my analysis of your existing project, I believe this enhancement should be structured as [single epic/multiple epics] because [rationale based on actual project analysis]. Does this align with your understanding of the work required?"
|
||||
elicit: true
|
||||
sections:
|
||||
- id: epic-approach
|
||||
title: Epic Approach
|
||||
instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features
|
||||
template: "**Epic Structure Decision**: {{epic_decision}} with rationale"
|
||||
|
||||
- id: epic-details
|
||||
title: "Epic 1: {{enhancement_title}}"
|
||||
instruction: |
|
||||
Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
|
||||
|
||||
CRITICAL STORY SEQUENCING FOR BROWNFIELD:
|
||||
- Stories must ensure existing functionality remains intact
|
||||
- Each story should include verification that existing features still work
|
||||
- Stories should be sequenced to minimize risk to existing system
|
||||
- Include rollback considerations for each story
|
||||
- Focus on incremental integration rather than big-bang changes
|
||||
- Size stories for AI agent execution in existing codebase context
|
||||
- MANDATORY: Present the complete story sequence and ask: "This story sequence is designed to minimize risk to your existing system. Does this order make sense given your project's architecture and constraints?"
|
||||
- Stories must be logically sequential with clear dependencies identified
|
||||
- Each story must deliver value while maintaining system integrity
|
||||
template: |
|
||||
**Epic Goal**: {{epic_goal}}
|
||||
|
||||
**Integration Requirements**: {{integration_requirements}}
|
||||
sections:
|
||||
- id: story
|
||||
title: "Story 1.{{story_number}} {{story_title}}"
|
||||
repeatable: true
|
||||
template: |
|
||||
As a {{user_type}},
|
||||
I want {{action}},
|
||||
so that {{benefit}}.
|
||||
sections:
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
instruction: Define criteria that include both new functionality and existing system integrity
|
||||
item_template: "{{criterion_number}}: {{criteria}}"
|
||||
- id: integration-verification
|
||||
title: Integration Verification
|
||||
instruction: Specific verification steps to ensure existing functionality remains intact
|
||||
type: numbered-list
|
||||
prefix: IV
|
||||
items:
|
||||
- template: "IV1: {{existing_functionality_verification}}"
|
||||
- template: "IV2: {{integration_point_verification}}"
|
||||
- template: "IV3: {{performance_impact_verification}}"
|
||||
@@ -1,291 +0,0 @@
|
||||
# Competitive Analysis Report: {{Project/Product Name}}
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
|
||||
|
||||
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{Provide high-level competitive insights, main threats and opportunities, and recommended strategic actions. Write this section LAST after completing all analysis.}}
|
||||
|
||||
## Analysis Scope & Methodology
|
||||
|
||||
### Analysis Purpose
|
||||
|
||||
{{Define the primary purpose:
|
||||
|
||||
- New market entry assessment
|
||||
- Product positioning strategy
|
||||
- Feature gap analysis
|
||||
- Pricing strategy development
|
||||
- Partnership/acquisition targets
|
||||
- Competitive threat assessment}}
|
||||
|
||||
### Competitor Categories Analyzed
|
||||
|
||||
{{List categories included:
|
||||
|
||||
- Direct Competitors: Same product/service, same target market
|
||||
- Indirect Competitors: Different product, same need/problem
|
||||
- Potential Competitors: Could enter market easily
|
||||
- Substitute Products: Alternative solutions
|
||||
- Aspirational Competitors: Best-in-class examples}}
|
||||
|
||||
### Research Methodology
|
||||
|
||||
{{Describe approach:
|
||||
|
||||
- Information sources used
|
||||
- Analysis timeframe
|
||||
- Confidence levels
|
||||
- Limitations}}
|
||||
|
||||
## Competitive Landscape Overview
|
||||
|
||||
### Market Structure
|
||||
|
||||
{{Describe the competitive environment:
|
||||
|
||||
- Number of active competitors
|
||||
- Market concentration (fragmented/consolidated)
|
||||
- Competitive dynamics
|
||||
- Recent market entries/exits}}
|
||||
|
||||
### Competitor Prioritization Matrix
|
||||
|
||||
[[LLM: Help categorize competitors by market share and strategic threat level]]
|
||||
|
||||
{{Create a 2x2 matrix:
|
||||
|
||||
- Priority 1 (Core Competitors): High Market Share + High Threat
|
||||
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
||||
- Priority 3 (Established Players): High Market Share + Low Threat
|
||||
- Priority 4 (Monitor Only): Low Market Share + Low Threat}}
|
||||
|
||||
## Individual Competitor Profiles
|
||||
|
||||
[[LLM: Create detailed profiles for each Priority 1 and Priority 2 competitor. For Priority 3 and 4, create condensed profiles.]]
|
||||
|
||||
### {{Competitor Name}} - Priority {{1/2/3/4}}
|
||||
|
||||
#### Company Overview
|
||||
|
||||
- **Founded:** {{Year, founders}}
|
||||
- **Headquarters:** {{Location}}
|
||||
- **Company Size:** {{Employees, revenue if known}}
|
||||
- **Funding:** {{Total raised, key investors}}
|
||||
- **Leadership:** {{Key executives}}
|
||||
|
||||
#### Business Model & Strategy
|
||||
|
||||
- **Revenue Model:** {{How they make money}}
|
||||
- **Target Market:** {{Primary customer segments}}
|
||||
- **Value Proposition:** {{Core value promise}}
|
||||
- **Go-to-Market Strategy:** {{Sales and marketing approach}}
|
||||
- **Strategic Focus:** {{Current priorities}}
|
||||
|
||||
#### Product/Service Analysis
|
||||
|
||||
- **Core Offerings:** {{Main products/services}}
|
||||
- **Key Features:** {{Standout capabilities}}
|
||||
- **User Experience:** {{UX strengths/weaknesses}}
|
||||
- **Technology Stack:** {{If relevant/known}}
|
||||
- **Pricing:** {{Model and price points}}
|
||||
|
||||
#### Strengths & Weaknesses
|
||||
|
||||
**Strengths:**
|
||||
|
||||
- {{Strength 1}}
|
||||
- {{Strength 2}}
|
||||
- {{Strength 3}}
|
||||
|
||||
**Weaknesses:**
|
||||
|
||||
- {{Weakness 1}}
|
||||
- {{Weakness 2}}
|
||||
- {{Weakness 3}}
|
||||
|
||||
#### Market Position & Performance
|
||||
|
||||
- **Market Share:** {{Estimate if available}}
|
||||
- **Customer Base:** {{Size, notable clients}}
|
||||
- **Growth Trajectory:** {{Trending up/down/stable}}
|
||||
- **Recent Developments:** {{Key news, releases}}
|
||||
|
||||
<<REPEAT for each priority competitor>>
|
||||
|
||||
## Comparative Analysis
|
||||
|
||||
### Feature Comparison Matrix
|
||||
|
||||
[[LLM: Create a detailed comparison table of key features across competitors]]
|
||||
|
||||
| Feature Category | {{Your Company}} | {{Competitor 1}} | {{Competitor 2}} | {{Competitor 3}} |
|
||||
| --------------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| **Core Functionality** |
|
||||
| Feature A | {{✓/✗/Partial}} | {{✓/✗/Partial}} | {{✓/✗/Partial}} | {{✓/✗/Partial}} |
|
||||
| Feature B | {{✓/✗/Partial}} | {{✓/✗/Partial}} | {{✓/✗/Partial}} | {{✓/✗/Partial}} |
|
||||
| **User Experience** |
|
||||
| Mobile App | {{Rating/Status}} | {{Rating/Status}} | {{Rating/Status}} | {{Rating/Status}} |
|
||||
| Onboarding Time | {{Time}} | {{Time}} | {{Time}} | {{Time}} |
|
||||
| **Integration & Ecosystem** |
|
||||
| API Availability | {{Yes/No/Limited}} | {{Yes/No/Limited}} | {{Yes/No/Limited}} | {{Yes/No/Limited}} |
|
||||
| Third-party Integrations | {{Number/Key ones}} | {{Number/Key ones}} | {{Number/Key ones}} | {{Number/Key ones}} |
|
||||
| **Pricing & Plans** |
|
||||
| Starting Price | {{$X}} | {{$X}} | {{$X}} | {{$X}} |
|
||||
| Free Tier | {{Yes/No}} | {{Yes/No}} | {{Yes/No}} | {{Yes/No}} |
|
||||
|
||||
### SWOT Comparison
|
||||
|
||||
[[LLM: Create SWOT analysis for your solution vs. top competitors]]
|
||||
|
||||
#### Your Solution
|
||||
|
||||
- **Strengths:** {{List key strengths}}
|
||||
- **Weaknesses:** {{List key weaknesses}}
|
||||
- **Opportunities:** {{List opportunities}}
|
||||
- **Threats:** {{List threats}}
|
||||
|
||||
#### vs. {{Main Competitor}}
|
||||
|
||||
- **Competitive Advantages:** {{Where you're stronger}}
|
||||
- **Competitive Disadvantages:** {{Where they're stronger}}
|
||||
- **Differentiation Opportunities:** {{How to stand out}}
|
||||
|
||||
### Positioning Map
|
||||
|
||||
[[LLM: Describe competitor positions on key dimensions]]
|
||||
|
||||
{{Create a positioning description using 2 key dimensions relevant to the market, such as:
|
||||
|
||||
- Price vs. Features
|
||||
- Ease of Use vs. Power
|
||||
- Specialization vs. Breadth
|
||||
- Self-Serve vs. High-Touch}}
|
||||
|
||||
## Strategic Analysis
|
||||
|
||||
### Competitive Advantages Assessment
|
||||
|
||||
#### Sustainable Advantages
|
||||
|
||||
{{Identify moats and defensible positions:
|
||||
|
||||
- Network effects
|
||||
- Switching costs
|
||||
- Brand strength
|
||||
- Technology barriers
|
||||
- Regulatory advantages}}
|
||||
|
||||
#### Vulnerable Points
|
||||
|
||||
{{Where competitors could be challenged:
|
||||
|
||||
- Weak customer segments
|
||||
- Missing features
|
||||
- Poor user experience
|
||||
- High prices
|
||||
- Limited geographic presence}}
|
||||
|
||||
### Blue Ocean Opportunities
|
||||
|
||||
[[LLM: Identify uncontested market spaces]]
|
||||
|
||||
{{List opportunities to create new market space:
|
||||
|
||||
- Underserved segments
|
||||
- Unaddressed use cases
|
||||
- New business models
|
||||
- Geographic expansion
|
||||
- Different value propositions}}
|
||||
|
||||
## Strategic Recommendations
|
||||
|
||||
### Differentiation Strategy
|
||||
|
||||
{{How to position against competitors:
|
||||
|
||||
- Unique value propositions to emphasize
|
||||
- Features to prioritize
|
||||
- Segments to target
|
||||
- Messaging and positioning}}
|
||||
|
||||
### Competitive Response Planning
|
||||
|
||||
#### Offensive Strategies
|
||||
|
||||
{{How to gain market share:
|
||||
|
||||
- Target competitor weaknesses
|
||||
- Win competitive deals
|
||||
- Capture their customers}}
|
||||
|
||||
#### Defensive Strategies
|
||||
|
||||
{{How to protect your position:
|
||||
|
||||
- Strengthen vulnerable areas
|
||||
- Build switching costs
|
||||
- Deepen customer relationships}}
|
||||
|
||||
### Partnership & Ecosystem Strategy
|
||||
|
||||
{{Potential collaboration opportunities:
|
||||
|
||||
- Complementary players
|
||||
- Channel partners
|
||||
- Technology integrations
|
||||
- Strategic alliances}}
|
||||
|
||||
## Monitoring & Intelligence Plan
|
||||
|
||||
### Key Competitors to Track
|
||||
|
||||
{{Priority list with rationale}}
|
||||
|
||||
### Monitoring Metrics
|
||||
|
||||
{{What to track:
|
||||
|
||||
- Product updates
|
||||
- Pricing changes
|
||||
- Customer wins/losses
|
||||
- Funding/M&A activity
|
||||
- Market messaging}}
|
||||
|
||||
### Intelligence Sources
|
||||
|
||||
{{Where to gather ongoing intelligence:
|
||||
|
||||
- Company websites/blogs
|
||||
- Customer reviews
|
||||
- Industry reports
|
||||
- Social media
|
||||
- Patent filings}}
|
||||
|
||||
### Update Cadence
|
||||
|
||||
{{Recommended review schedule:
|
||||
|
||||
- Weekly: {{What to check}}
|
||||
- Monthly: {{What to review}}
|
||||
- Quarterly: {{Deep analysis}}}}
|
||||
|
||||
---
|
||||
|
||||
[[LLM: After completing the document, offer advanced elicitation with these custom options for competitive analysis:
|
||||
|
||||
**Competitive Analysis Elicitation Actions** 0. Deep dive on a specific competitor's strategy
|
||||
|
||||
1. Analyze competitive dynamics in a specific segment
|
||||
2. War game competitive responses to your moves
|
||||
3. Explore partnership vs. competition scenarios
|
||||
4. Stress test differentiation claims
|
||||
5. Analyze disruption potential (yours or theirs)
|
||||
6. Compare to competition in adjacent markets
|
||||
7. Generate win/loss analysis insights
|
||||
8. If only we had known about [competitor X's plan]...
|
||||
9. Proceed to next section
|
||||
|
||||
These replace the standard elicitation options when working on competitive analysis documents.]]
|
||||
293
bmad-core/templates/competitor-analysis-tmpl.yaml
Normal file
293
bmad-core/templates/competitor-analysis-tmpl.yaml
Normal file
@@ -0,0 +1,293 @@
|
||||
template:
|
||||
id: competitor-analysis-template-v2
|
||||
name: Competitive Analysis Report
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/competitor-analysis.md
|
||||
title: "Competitive Analysis Report: {{project_product_name}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
custom_elicitation:
|
||||
title: "Competitive Analysis Elicitation Actions"
|
||||
options:
|
||||
- "Deep dive on a specific competitor's strategy"
|
||||
- "Analyze competitive dynamics in a specific segment"
|
||||
- "War game competitive responses to your moves"
|
||||
- "Explore partnership vs. competition scenarios"
|
||||
- "Stress test differentiation claims"
|
||||
- "Analyze disruption potential (yours or theirs)"
|
||||
- "Compare to competition in adjacent markets"
|
||||
- "Generate win/loss analysis insights"
|
||||
- "If only we had known about [competitor X's plan]..."
|
||||
- "Proceed to next section"
|
||||
|
||||
sections:
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
instruction: Provide high-level competitive insights, main threats and opportunities, and recommended strategic actions. Write this section LAST after completing all analysis.
|
||||
|
||||
- id: analysis-scope
|
||||
title: Analysis Scope & Methodology
|
||||
instruction: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.
|
||||
sections:
|
||||
- id: analysis-purpose
|
||||
title: Analysis Purpose
|
||||
instruction: |
|
||||
Define the primary purpose:
|
||||
- New market entry assessment
|
||||
- Product positioning strategy
|
||||
- Feature gap analysis
|
||||
- Pricing strategy development
|
||||
- Partnership/acquisition targets
|
||||
- Competitive threat assessment
|
||||
- id: competitor-categories
|
||||
title: Competitor Categories Analyzed
|
||||
instruction: |
|
||||
List categories included:
|
||||
- Direct Competitors: Same product/service, same target market
|
||||
- Indirect Competitors: Different product, same need/problem
|
||||
- Potential Competitors: Could enter market easily
|
||||
- Substitute Products: Alternative solutions
|
||||
- Aspirational Competitors: Best-in-class examples
|
||||
- id: research-methodology
|
||||
title: Research Methodology
|
||||
instruction: |
|
||||
Describe approach:
|
||||
- Information sources used
|
||||
- Analysis timeframe
|
||||
- Confidence levels
|
||||
- Limitations
|
||||
|
||||
- id: competitive-landscape
|
||||
title: Competitive Landscape Overview
|
||||
sections:
|
||||
- id: market-structure
|
||||
title: Market Structure
|
||||
instruction: |
|
||||
Describe the competitive environment:
|
||||
- Number of active competitors
|
||||
- Market concentration (fragmented/consolidated)
|
||||
- Competitive dynamics
|
||||
- Recent market entries/exits
|
||||
- id: prioritization-matrix
|
||||
title: Competitor Prioritization Matrix
|
||||
instruction: |
|
||||
Help categorize competitors by market share and strategic threat level
|
||||
|
||||
Create a 2x2 matrix:
|
||||
- Priority 1 (Core Competitors): High Market Share + High Threat
|
||||
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
||||
- Priority 3 (Established Players): High Market Share + Low Threat
|
||||
- Priority 4 (Monitor Only): Low Market Share + Low Threat
|
||||
|
||||
- id: competitor-profiles
|
||||
title: Individual Competitor Profiles
|
||||
instruction: Create detailed profiles for each Priority 1 and Priority 2 competitor. For Priority 3 and 4, create condensed profiles.
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: competitor
|
||||
title: "{{competitor_name}} - Priority {{priority_level}}"
|
||||
sections:
|
||||
- id: company-overview
|
||||
title: Company Overview
|
||||
template: |
|
||||
- **Founded:** {{year_founders}}
|
||||
- **Headquarters:** {{location}}
|
||||
- **Company Size:** {{employees_revenue}}
|
||||
- **Funding:** {{total_raised_investors}}
|
||||
- **Leadership:** {{key_executives}}
|
||||
- id: business-model
|
||||
title: Business Model & Strategy
|
||||
template: |
|
||||
- **Revenue Model:** {{revenue_model}}
|
||||
- **Target Market:** {{customer_segments}}
|
||||
- **Value Proposition:** {{value_promise}}
|
||||
- **Go-to-Market Strategy:** {{gtm_approach}}
|
||||
- **Strategic Focus:** {{current_priorities}}
|
||||
- id: product-analysis
|
||||
title: Product/Service Analysis
|
||||
template: |
|
||||
- **Core Offerings:** {{main_products}}
|
||||
- **Key Features:** {{standout_capabilities}}
|
||||
- **User Experience:** {{ux_assessment}}
|
||||
- **Technology Stack:** {{tech_stack}}
|
||||
- **Pricing:** {{pricing_model}}
|
||||
- id: strengths-weaknesses
|
||||
title: Strengths & Weaknesses
|
||||
sections:
|
||||
- id: strengths
|
||||
title: Strengths
|
||||
type: bullet-list
|
||||
template: "- {{strength}}"
|
||||
- id: weaknesses
|
||||
title: Weaknesses
|
||||
type: bullet-list
|
||||
template: "- {{weakness}}"
|
||||
- id: market-position
|
||||
title: Market Position & Performance
|
||||
template: |
|
||||
- **Market Share:** {{market_share_estimate}}
|
||||
- **Customer Base:** {{customer_size_notables}}
|
||||
- **Growth Trajectory:** {{growth_trend}}
|
||||
- **Recent Developments:** {{key_news}}
|
||||
|
||||
- id: comparative-analysis
|
||||
title: Comparative Analysis
|
||||
sections:
|
||||
- id: feature-comparison
|
||||
title: Feature Comparison Matrix
|
||||
instruction: Create a detailed comparison table of key features across competitors
|
||||
type: table
|
||||
columns: ["Feature Category", "{{your_company}}", "{{competitor_1}}", "{{competitor_2}}", "{{competitor_3}}"]
|
||||
rows:
|
||||
- category: "Core Functionality"
|
||||
items:
|
||||
- ["Feature A", "{{status}}", "{{status}}", "{{status}}", "{{status}}"]
|
||||
- ["Feature B", "{{status}}", "{{status}}", "{{status}}", "{{status}}"]
|
||||
- category: "User Experience"
|
||||
items:
|
||||
- ["Mobile App", "{{rating}}", "{{rating}}", "{{rating}}", "{{rating}}"]
|
||||
- ["Onboarding Time", "{{time}}", "{{time}}", "{{time}}", "{{time}}"]
|
||||
- category: "Integration & Ecosystem"
|
||||
items:
|
||||
- ["API Availability", "{{availability}}", "{{availability}}", "{{availability}}", "{{availability}}"]
|
||||
- ["Third-party Integrations", "{{number}}", "{{number}}", "{{number}}", "{{number}}"]
|
||||
- category: "Pricing & Plans"
|
||||
items:
|
||||
- ["Starting Price", "{{price}}", "{{price}}", "{{price}}", "{{price}}"]
|
||||
- ["Free Tier", "{{yes_no}}", "{{yes_no}}", "{{yes_no}}", "{{yes_no}}"]
|
||||
- id: swot-comparison
|
||||
title: SWOT Comparison
|
||||
instruction: Create SWOT analysis for your solution vs. top competitors
|
||||
sections:
|
||||
- id: your-solution
|
||||
title: Your Solution
|
||||
template: |
|
||||
- **Strengths:** {{strengths}}
|
||||
- **Weaknesses:** {{weaknesses}}
|
||||
- **Opportunities:** {{opportunities}}
|
||||
- **Threats:** {{threats}}
|
||||
- id: vs-competitor
|
||||
title: "vs. {{main_competitor}}"
|
||||
template: |
|
||||
- **Competitive Advantages:** {{your_advantages}}
|
||||
- **Competitive Disadvantages:** {{their_advantages}}
|
||||
- **Differentiation Opportunities:** {{differentiation}}
|
||||
- id: positioning-map
|
||||
title: Positioning Map
|
||||
instruction: |
|
||||
Describe competitor positions on key dimensions
|
||||
|
||||
Create a positioning description using 2 key dimensions relevant to the market, such as:
|
||||
- Price vs. Features
|
||||
- Ease of Use vs. Power
|
||||
- Specialization vs. Breadth
|
||||
- Self-Serve vs. High-Touch
|
||||
|
||||
- id: strategic-analysis
|
||||
title: Strategic Analysis
|
||||
sections:
|
||||
- id: competitive-advantages
|
||||
title: Competitive Advantages Assessment
|
||||
sections:
|
||||
- id: sustainable-advantages
|
||||
title: Sustainable Advantages
|
||||
instruction: |
|
||||
Identify moats and defensible positions:
|
||||
- Network effects
|
||||
- Switching costs
|
||||
- Brand strength
|
||||
- Technology barriers
|
||||
- Regulatory advantages
|
||||
- id: vulnerable-points
|
||||
title: Vulnerable Points
|
||||
instruction: |
|
||||
Where competitors could be challenged:
|
||||
- Weak customer segments
|
||||
- Missing features
|
||||
- Poor user experience
|
||||
- High prices
|
||||
- Limited geographic presence
|
||||
- id: blue-ocean
|
||||
title: Blue Ocean Opportunities
|
||||
instruction: |
|
||||
Identify uncontested market spaces
|
||||
|
||||
List opportunities to create new market space:
|
||||
- Underserved segments
|
||||
- Unaddressed use cases
|
||||
- New business models
|
||||
- Geographic expansion
|
||||
- Different value propositions
|
||||
|
||||
- id: strategic-recommendations
|
||||
title: Strategic Recommendations
|
||||
sections:
|
||||
- id: differentiation-strategy
|
||||
title: Differentiation Strategy
|
||||
instruction: |
|
||||
How to position against competitors:
|
||||
- Unique value propositions to emphasize
|
||||
- Features to prioritize
|
||||
- Segments to target
|
||||
- Messaging and positioning
|
||||
- id: competitive-response
|
||||
title: Competitive Response Planning
|
||||
sections:
|
||||
- id: offensive-strategies
|
||||
title: Offensive Strategies
|
||||
instruction: |
|
||||
How to gain market share:
|
||||
- Target competitor weaknesses
|
||||
- Win competitive deals
|
||||
- Capture their customers
|
||||
- id: defensive-strategies
|
||||
title: Defensive Strategies
|
||||
instruction: |
|
||||
How to protect your position:
|
||||
- Strengthen vulnerable areas
|
||||
- Build switching costs
|
||||
- Deepen customer relationships
|
||||
- id: partnership-ecosystem
|
||||
title: Partnership & Ecosystem Strategy
|
||||
instruction: |
|
||||
Potential collaboration opportunities:
|
||||
- Complementary players
|
||||
- Channel partners
|
||||
- Technology integrations
|
||||
- Strategic alliances
|
||||
|
||||
- id: monitoring-plan
|
||||
title: Monitoring & Intelligence Plan
|
||||
sections:
|
||||
- id: key-competitors
|
||||
title: Key Competitors to Track
|
||||
instruction: Priority list with rationale
|
||||
- id: monitoring-metrics
|
||||
title: Monitoring Metrics
|
||||
instruction: |
|
||||
What to track:
|
||||
- Product updates
|
||||
- Pricing changes
|
||||
- Customer wins/losses
|
||||
- Funding/M&A activity
|
||||
- Market messaging
|
||||
- id: intelligence-sources
|
||||
title: Intelligence Sources
|
||||
instruction: |
|
||||
Where to gather ongoing intelligence:
|
||||
- Company websites/blogs
|
||||
- Customer reviews
|
||||
- Industry reports
|
||||
- Social media
|
||||
- Patent filings
|
||||
- id: update-cadence
|
||||
title: Update Cadence
|
||||
instruction: |
|
||||
Recommended review schedule:
|
||||
- Weekly: {{weekly_items}}
|
||||
- Monthly: {{monthly_items}}
|
||||
- Quarterly: {{quarterly_analysis}}
|
||||
@@ -1,175 +0,0 @@
|
||||
# {{Project Name}} Frontend Architecture Document
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
|
||||
|
||||
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
|
||||
|
||||
## Template and Framework Selection
|
||||
|
||||
[[LLM: Before proceeding with frontend architecture design, check if the project is using a frontend starter template or existing codebase:
|
||||
|
||||
1. Review the PRD, main architecture document, and brainstorming brief for mentions of:
|
||||
|
||||
- Frontend starter templates (e.g., Create React App, Next.js, Vite, Vue CLI, Angular CLI, etc.)
|
||||
- UI kit or component library starters
|
||||
- Existing frontend projects being used as a foundation
|
||||
- Admin dashboard templates or other specialized starters
|
||||
- Design system implementations
|
||||
|
||||
2. If a frontend starter template or existing project is mentioned:
|
||||
|
||||
- Ask the user to provide access via one of these methods:
|
||||
- Link to the starter template documentation
|
||||
- Upload/attach the project files (for small projects)
|
||||
- Share a link to the project repository
|
||||
- Analyze the starter/existing project to understand:
|
||||
- Pre-installed dependencies and versions
|
||||
- Folder structure and file organization
|
||||
- Built-in components and utilities
|
||||
- Styling approach (CSS modules, styled-components, Tailwind, etc.)
|
||||
- State management setup (if any)
|
||||
- Routing configuration
|
||||
- Testing setup and patterns
|
||||
- Build and development scripts
|
||||
|
||||
- Use this analysis to ensure your frontend architecture aligns with the starter's patterns
|
||||
|
||||
3. If no frontend starter is mentioned but this is a new UI, ensure we know what the ui language and framework is:
|
||||
|
||||
- Based on the framework choice, suggest appropriate starters:
|
||||
- React: Create React App, Next.js, Vite + React
|
||||
- Vue: Vue CLI, Nuxt.js, Vite + Vue
|
||||
- Angular: Angular CLI
|
||||
- Or suggest popular UI templates if applicable
|
||||
- Explain benefits specific to frontend development
|
||||
|
||||
4. If the user confirms no starter template will be used:
|
||||
- Note that all tooling, bundling, and configuration will need manual setup
|
||||
- Proceed with frontend architecture from scratch
|
||||
|
||||
Document the starter template decision and any constraints it imposes before proceeding.]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Frontend Tech Stack
|
||||
|
||||
[[LLM: Extract from main architecture's Technology Stack Table. This section MUST remain synchronized with the main architecture document. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Technology Stack Table
|
||||
|
||||
| Category | Technology | Version | Purpose | Rationale |
|
||||
| :-------------------- | :------------------- | :---------- | :---------- | :------------- |
|
||||
| **Framework** | {{framework}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **UI Library** | {{ui_library}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **State Management** | {{state_management}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Routing** | {{routing_library}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Build Tool** | {{build_tool}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Styling** | {{styling_solution}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Testing** | {{test_framework}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Component Library** | {{component_lib}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Form Handling** | {{form_library}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Animation** | {{animation_lib}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
| **Dev Tools** | {{dev_tools}} | {{version}} | {{purpose}} | {{why_chosen}} |
|
||||
|
||||
[[LLM: Fill in appropriate technology choices based on the selected framework and project requirements.]]
|
||||
|
||||
## Project Structure
|
||||
|
||||
[[LLM: Define exact directory structure for AI tools based on the chosen framework. Be specific about where each type of file goes. Generate a structure that follows the framework's best practices and conventions. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Component Standards
|
||||
|
||||
[[LLM: Define exact patterns for component creation based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Component Template
|
||||
|
||||
[[LLM: Generate a minimal but complete component template following the framework's best practices. Include TypeScript types, proper imports, and basic structure.]]
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
[[LLM: Provide naming conventions specific to the chosen framework for components, files, services, state management, and other architectural elements.]]
|
||||
|
||||
## State Management
|
||||
|
||||
[[LLM: Define state management patterns based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Store Structure
|
||||
|
||||
[[LLM: Generate the state management directory structure appropriate for the chosen framework and selected state management solution.]]
|
||||
|
||||
### State Management Template
|
||||
|
||||
[[LLM: Provide a basic state management template/example following the framework's recommended patterns. Include TypeScript types and common operations like setting, updating, and clearing state.]]
|
||||
|
||||
## API Integration
|
||||
|
||||
[[LLM: Define API service patterns based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Service Template
|
||||
|
||||
[[LLM: Provide an API service template that follows the framework's conventions. Include proper TypeScript types, error handling, and async patterns.]]
|
||||
|
||||
### API Client Configuration
|
||||
|
||||
[[LLM: Show how to configure the HTTP client for the chosen framework, including authentication interceptors/middleware and error handling.]]
|
||||
|
||||
## Routing
|
||||
|
||||
[[LLM: Define routing structure and patterns based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Route Configuration
|
||||
|
||||
[[LLM: Provide routing configuration appropriate for the chosen framework. Include protected route patterns, lazy loading where applicable, and authentication guards/middleware.]]
|
||||
|
||||
## Styling Guidelines
|
||||
|
||||
[[LLM: Define styling approach based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Styling Approach
|
||||
|
||||
[[LLM: Describe the styling methodology appropriate for the chosen framework (CSS Modules, Styled Components, Tailwind, etc.) and provide basic patterns.]]
|
||||
|
||||
### Global Theme Variables
|
||||
|
||||
[[LLM: Provide a CSS custom properties (CSS variables) theme system that works across all frameworks. Include colors, spacing, typography, shadows, and dark mode support.]]
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
[[LLM: Define minimal testing requirements based on the chosen framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Component Test Template
|
||||
|
||||
[[LLM: Provide a basic component test template using the framework's recommended testing library. Include examples of rendering tests, user interaction tests, and mocking.]]
|
||||
|
||||
### Testing Best Practices
|
||||
|
||||
1. **Unit Tests**: Test individual components in isolation
|
||||
2. **Integration Tests**: Test component interactions
|
||||
3. **E2E Tests**: Test critical user flows (using Cypress/Playwright)
|
||||
4. **Coverage Goals**: Aim for 80% code coverage
|
||||
5. **Test Structure**: Arrange-Act-Assert pattern
|
||||
6. **Mock External Dependencies**: API calls, routing, state management
|
||||
|
||||
## Environment Configuration
|
||||
|
||||
[[LLM: List required environment variables based on the chosen framework. Show the appropriate format and naming conventions for the framework. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
## Frontend Developer Standards
|
||||
|
||||
### Critical Coding Rules
|
||||
|
||||
[[LLM: List essential rules that prevent common AI mistakes, including both universal rules and framework-specific ones. After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Quick Reference
|
||||
|
||||
[[LLM: Create a framework-specific cheat sheet with:
|
||||
|
||||
- Common commands (dev server, build, test)
|
||||
- Key import patterns
|
||||
- File naming conventions
|
||||
- Project-specific patterns and utilities]]
|
||||
206
bmad-core/templates/front-end-architecture-tmpl.yaml
Normal file
206
bmad-core/templates/front-end-architecture-tmpl.yaml
Normal file
@@ -0,0 +1,206 @@
|
||||
template:
|
||||
id: frontend-architecture-template-v2
|
||||
name: Frontend Architecture Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/ui-architecture.md
|
||||
title: "{{project_name}} Frontend Architecture Document"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: template-framework-selection
|
||||
title: Template and Framework Selection
|
||||
instruction: |
|
||||
Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.
|
||||
|
||||
Before proceeding with frontend architecture design, check if the project is using a frontend starter template or existing codebase:
|
||||
|
||||
1. Review the PRD, main architecture document, and brainstorming brief for mentions of:
|
||||
- Frontend starter templates (e.g., Create React App, Next.js, Vite, Vue CLI, Angular CLI, etc.)
|
||||
- UI kit or component library starters
|
||||
- Existing frontend projects being used as a foundation
|
||||
- Admin dashboard templates or other specialized starters
|
||||
- Design system implementations
|
||||
|
||||
2. If a frontend starter template or existing project is mentioned:
|
||||
- Ask the user to provide access via one of these methods:
|
||||
- Link to the starter template documentation
|
||||
- Upload/attach the project files (for small projects)
|
||||
- Share a link to the project repository
|
||||
- Analyze the starter/existing project to understand:
|
||||
- Pre-installed dependencies and versions
|
||||
- Folder structure and file organization
|
||||
- Built-in components and utilities
|
||||
- Styling approach (CSS modules, styled-components, Tailwind, etc.)
|
||||
- State management setup (if any)
|
||||
- Routing configuration
|
||||
- Testing setup and patterns
|
||||
- Build and development scripts
|
||||
- Use this analysis to ensure your frontend architecture aligns with the starter's patterns
|
||||
|
||||
3. If no frontend starter is mentioned but this is a new UI, ensure we know what the ui language and framework is:
|
||||
- Based on the framework choice, suggest appropriate starters:
|
||||
- React: Create React App, Next.js, Vite + React
|
||||
- Vue: Vue CLI, Nuxt.js, Vite + Vue
|
||||
- Angular: Angular CLI
|
||||
- Or suggest popular UI templates if applicable
|
||||
- Explain benefits specific to frontend development
|
||||
|
||||
4. If the user confirms no starter template will be used:
|
||||
- Note that all tooling, bundling, and configuration will need manual setup
|
||||
- Proceed with frontend architecture from scratch
|
||||
|
||||
Document the starter template decision and any constraints it imposes before proceeding.
|
||||
sections:
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: frontend-tech-stack
|
||||
title: Frontend Tech Stack
|
||||
instruction: Extract from main architecture's Technology Stack Table. This section MUST remain synchronized with the main architecture document.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: tech-stack-table
|
||||
title: Technology Stack Table
|
||||
type: table
|
||||
columns: [Category, Technology, Version, Purpose, Rationale]
|
||||
instruction: Fill in appropriate technology choices based on the selected framework and project requirements.
|
||||
rows:
|
||||
- ["Framework", "{{framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["UI Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["State Management", "{{state_management}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Routing", "{{routing_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Build Tool", "{{build_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Styling", "{{styling_solution}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Testing", "{{test_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Component Library", "{{component_lib}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Form Handling", "{{form_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Animation", "{{animation_lib}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
|
||||
- id: project-structure
|
||||
title: Project Structure
|
||||
instruction: Define exact directory structure for AI tools based on the chosen framework. Be specific about where each type of file goes. Generate a structure that follows the framework's best practices and conventions.
|
||||
elicit: true
|
||||
type: code
|
||||
language: plaintext
|
||||
|
||||
- id: component-standards
|
||||
title: Component Standards
|
||||
instruction: Define exact patterns for component creation based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: component-template
|
||||
title: Component Template
|
||||
instruction: Generate a minimal but complete component template following the framework's best practices. Include TypeScript types, proper imports, and basic structure.
|
||||
type: code
|
||||
language: typescript
|
||||
- id: naming-conventions
|
||||
title: Naming Conventions
|
||||
instruction: Provide naming conventions specific to the chosen framework for components, files, services, state management, and other architectural elements.
|
||||
|
||||
- id: state-management
|
||||
title: State Management
|
||||
instruction: Define state management patterns based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: store-structure
|
||||
title: Store Structure
|
||||
instruction: Generate the state management directory structure appropriate for the chosen framework and selected state management solution.
|
||||
type: code
|
||||
language: plaintext
|
||||
- id: state-template
|
||||
title: State Management Template
|
||||
instruction: Provide a basic state management template/example following the framework's recommended patterns. Include TypeScript types and common operations like setting, updating, and clearing state.
|
||||
type: code
|
||||
language: typescript
|
||||
|
||||
- id: api-integration
|
||||
title: API Integration
|
||||
instruction: Define API service patterns based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: service-template
|
||||
title: Service Template
|
||||
instruction: Provide an API service template that follows the framework's conventions. Include proper TypeScript types, error handling, and async patterns.
|
||||
type: code
|
||||
language: typescript
|
||||
- id: api-client-config
|
||||
title: API Client Configuration
|
||||
instruction: Show how to configure the HTTP client for the chosen framework, including authentication interceptors/middleware and error handling.
|
||||
type: code
|
||||
language: typescript
|
||||
|
||||
- id: routing
|
||||
title: Routing
|
||||
instruction: Define routing structure and patterns based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: route-configuration
|
||||
title: Route Configuration
|
||||
instruction: Provide routing configuration appropriate for the chosen framework. Include protected route patterns, lazy loading where applicable, and authentication guards/middleware.
|
||||
type: code
|
||||
language: typescript
|
||||
|
||||
- id: styling-guidelines
|
||||
title: Styling Guidelines
|
||||
instruction: Define styling approach based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: styling-approach
|
||||
title: Styling Approach
|
||||
instruction: Describe the styling methodology appropriate for the chosen framework (CSS Modules, Styled Components, Tailwind, etc.) and provide basic patterns.
|
||||
- id: global-theme
|
||||
title: Global Theme Variables
|
||||
instruction: Provide a CSS custom properties (CSS variables) theme system that works across all frameworks. Include colors, spacing, typography, shadows, and dark mode support.
|
||||
type: code
|
||||
language: css
|
||||
|
||||
- id: testing-requirements
|
||||
title: Testing Requirements
|
||||
instruction: Define minimal testing requirements based on the chosen framework.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: component-test-template
|
||||
title: Component Test Template
|
||||
instruction: Provide a basic component test template using the framework's recommended testing library. Include examples of rendering tests, user interaction tests, and mocking.
|
||||
type: code
|
||||
language: typescript
|
||||
- id: testing-best-practices
|
||||
title: Testing Best Practices
|
||||
type: numbered-list
|
||||
items:
|
||||
- "**Unit Tests**: Test individual components in isolation"
|
||||
- "**Integration Tests**: Test component interactions"
|
||||
- "**E2E Tests**: Test critical user flows (using Cypress/Playwright)"
|
||||
- "**Coverage Goals**: Aim for 80% code coverage"
|
||||
- "**Test Structure**: Arrange-Act-Assert pattern"
|
||||
- "**Mock External Dependencies**: API calls, routing, state management"
|
||||
|
||||
- id: environment-configuration
|
||||
title: Environment Configuration
|
||||
instruction: List required environment variables based on the chosen framework. Show the appropriate format and naming conventions for the framework.
|
||||
elicit: true
|
||||
|
||||
- id: frontend-developer-standards
|
||||
title: Frontend Developer Standards
|
||||
sections:
|
||||
- id: critical-coding-rules
|
||||
title: Critical Coding Rules
|
||||
instruction: List essential rules that prevent common AI mistakes, including both universal rules and framework-specific ones.
|
||||
elicit: true
|
||||
- id: quick-reference
|
||||
title: Quick Reference
|
||||
instruction: |
|
||||
Create a framework-specific cheat sheet with:
|
||||
- Common commands (dev server, build, test)
|
||||
- Key import patterns
|
||||
- File naming conventions
|
||||
- Project-specific patterns and utilities
|
||||
@@ -1,413 +0,0 @@
|
||||
# {{Project Name}} UI/UX Specification
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
|
||||
|
||||
[[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
|
||||
|
||||
## Introduction
|
||||
|
||||
[[LLM: Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.]]
|
||||
|
||||
This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{Project Name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
|
||||
|
||||
### Overall UX Goals & Principles
|
||||
|
||||
[[LLM: Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
||||
|
||||
1. Target User Personas - elicit details or confirm existing ones from PRD
|
||||
2. Key Usability Goals - understand what success looks like for users
|
||||
3. Core Design Principles - establish 3-5 guiding principles
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Target User Personas
|
||||
|
||||
{{persona_descriptions}}
|
||||
|
||||
@{example: personas}
|
||||
|
||||
- **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
|
||||
@{/example}
|
||||
|
||||
### Usability Goals
|
||||
|
||||
{{usability_goals}}
|
||||
|
||||
@{example: usability_goals}
|
||||
|
||||
- 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
|
||||
@{/example}
|
||||
|
||||
### Design Principles
|
||||
|
||||
{{design_principles}}
|
||||
|
||||
@{example: design_principles}
|
||||
|
||||
1. **Clarity over cleverness** - Prioritize clear communication over aesthetic innovation
|
||||
2. **Progressive disclosure** - Show only what's needed, when it's needed
|
||||
3. **Consistent patterns** - Use familiar UI patterns throughout the application
|
||||
4. **Immediate feedback** - Every action should have a clear, immediate response
|
||||
5. **Accessible by default** - Design for all users from the start
|
||||
@{/example}
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Information Architecture (IA)
|
||||
|
||||
[[LLM: Collaborate with the user to create a comprehensive information architecture:
|
||||
|
||||
1. Build a Site Map or Screen Inventory showing all major areas
|
||||
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
||||
3. Use Mermaid diagrams for visual representation
|
||||
4. Consider user mental models and expected groupings
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Site Map / Screen Inventory
|
||||
|
||||
```mermaid
|
||||
{{sitemap_diagram}}
|
||||
```
|
||||
|
||||
@{example: sitemap}
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Homepage] --> B[Dashboard]
|
||||
A --> C[Products]
|
||||
A --> D[Account]
|
||||
B --> B1[Analytics]
|
||||
B --> B2[Recent Activity]
|
||||
C --> C1[Browse]
|
||||
C --> C2[Search]
|
||||
C --> C3[Product Details]
|
||||
D --> D1[Profile]
|
||||
D --> D2[Settings]
|
||||
D --> D3[Billing]
|
||||
```
|
||||
|
||||
@{/example}
|
||||
|
||||
### Navigation Structure
|
||||
|
||||
**Primary Navigation:** {{primary_nav_description}}
|
||||
|
||||
**Secondary Navigation:** {{secondary_nav_description}}
|
||||
|
||||
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
||||
|
||||
## User Flows
|
||||
|
||||
[[LLM: For each critical user task identified in the PRD:
|
||||
|
||||
1. Define the user's goal clearly
|
||||
2. Map out all steps including decision points
|
||||
3. Consider edge cases and error states
|
||||
4. Use Mermaid flow diagrams for clarity
|
||||
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
||||
|
||||
Create subsections for each major flow. After presenting all flows, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
<<REPEAT: user_flow>>
|
||||
|
||||
### {{flow_name}}
|
||||
|
||||
**User Goal:** {{flow_goal}}
|
||||
|
||||
**Entry Points:** {{entry_points}}
|
||||
|
||||
**Success Criteria:** {{success_criteria}}
|
||||
|
||||
#### Flow Diagram
|
||||
|
||||
```mermaid
|
||||
{{flow_diagram}}
|
||||
```
|
||||
|
||||
**Edge Cases & Error Handling:**
|
||||
|
||||
- {{edge_case_1}}
|
||||
- {{edge_case_2}}
|
||||
|
||||
**Notes:** {{flow_notes}}
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: user_flow}
|
||||
|
||||
### User Registration
|
||||
|
||||
**User Goal:** Create a new account to access the platform
|
||||
|
||||
**Entry Points:** Homepage CTA, Login page link, Marketing landing pages
|
||||
|
||||
**Success Criteria:** User successfully creates account and reaches dashboard
|
||||
|
||||
#### Flow Diagram
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
Start[Landing Page] --> Click[Click Sign Up]
|
||||
Click --> Form[Registration Form]
|
||||
Form --> Fill[Fill Required Fields]
|
||||
Fill --> Submit[Submit Form]
|
||||
Submit --> Validate{Valid?}
|
||||
Validate -->|No| Error[Show Errors]
|
||||
Error --> Form
|
||||
Validate -->|Yes| Verify[Email Verification]
|
||||
Verify --> Complete[Account Created]
|
||||
Complete --> Dashboard[Redirect to Dashboard]
|
||||
```
|
||||
|
||||
**Edge Cases & Error Handling:**
|
||||
|
||||
- Duplicate email: Show inline error with password recovery option
|
||||
- Weak password: Real-time feedback on password strength
|
||||
- Network error: Preserve form data and show retry option
|
||||
@{/example}
|
||||
|
||||
## Wireframes & Mockups
|
||||
|
||||
[[LLM: Clarify where detailed visual designs will be created (Figma, Sketch, etc.) and how to reference them. If low-fidelity wireframes are needed, offer to help conceptualize layouts for key screens.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
**Primary Design Files:** {{design_tool_link}}
|
||||
|
||||
### Key Screen Layouts
|
||||
|
||||
<<REPEAT: screen_layout>>
|
||||
|
||||
#### {{screen_name}}
|
||||
|
||||
**Purpose:** {{screen_purpose}}
|
||||
|
||||
**Key Elements:**
|
||||
|
||||
- {{element_1}}
|
||||
- {{element_2}}
|
||||
- {{element_3}}
|
||||
|
||||
**Interaction Notes:** {{interaction_notes}}
|
||||
|
||||
**Design File Reference:** {{specific_frame_link}}
|
||||
<</REPEAT>>
|
||||
|
||||
## Component Library / Design System
|
||||
|
||||
[[LLM: Discuss whether to use an existing design system or create a new one. If creating new, identify foundational components and their key states. Note that detailed technical specs belong in front-end-architecture.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
**Design System Approach:** {{design_system_approach}}
|
||||
|
||||
### Core Components
|
||||
|
||||
<<REPEAT: component>>
|
||||
|
||||
#### {{component_name}}
|
||||
|
||||
**Purpose:** {{component_purpose}}
|
||||
|
||||
**Variants:** {{component_variants}}
|
||||
|
||||
**States:** {{component_states}}
|
||||
|
||||
**Usage Guidelines:** {{usage_guidelines}}
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: component}
|
||||
|
||||
#### Button
|
||||
|
||||
**Purpose:** Primary interaction element for user actions
|
||||
|
||||
**Variants:** Primary, Secondary, Tertiary, Destructive
|
||||
|
||||
**States:** Default, Hover, Active, Disabled, Loading
|
||||
|
||||
**Usage Guidelines:**
|
||||
|
||||
- Use Primary for main CTAs (one per view)
|
||||
- Secondary for supporting actions
|
||||
- Destructive only for permanent deletions with confirmation
|
||||
@{/example}
|
||||
|
||||
## Branding & Style Guide
|
||||
|
||||
[[LLM: Link to existing style guide or define key brand elements. Ensure consistency with company brand guidelines if they exist.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Visual Identity
|
||||
|
||||
**Brand Guidelines:** {{brand_guidelines_link}}
|
||||
|
||||
### Color Palette
|
||||
|
||||
| Color Type | Hex Code | Usage |
|
||||
| :------------ | :------------------ | :------------------------------- |
|
||||
| **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 |
|
||||
|
||||
### Typography
|
||||
|
||||
**Font Families:**
|
||||
|
||||
- **Primary:** {{primary_font}}
|
||||
- **Secondary:** {{secondary_font}}
|
||||
- **Monospace:** {{mono_font}}
|
||||
|
||||
**Type Scale:**
|
||||
| Element | Size | Weight | Line Height |
|
||||
|:--------|:-----|:-------|:------------|
|
||||
| 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}} |
|
||||
|
||||
### Iconography
|
||||
|
||||
**Icon Library:** {{icon_library}}
|
||||
|
||||
**Usage Guidelines:** {{icon_guidelines}}
|
||||
|
||||
### Spacing & Layout
|
||||
|
||||
**Grid System:** {{grid_system}}
|
||||
|
||||
**Spacing Scale:** {{spacing_scale}}
|
||||
|
||||
## Accessibility Requirements
|
||||
|
||||
[[LLM: Define specific accessibility requirements based on target compliance level and user needs. Be comprehensive but practical.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Compliance Target
|
||||
|
||||
**Standard:** {{compliance_standard}}
|
||||
|
||||
### Key Requirements
|
||||
|
||||
**Visual:**
|
||||
|
||||
- Color contrast ratios: {{contrast_requirements}}
|
||||
- Focus indicators: {{focus_requirements}}
|
||||
- Text sizing: {{text_requirements}}
|
||||
|
||||
**Interaction:**
|
||||
|
||||
- Keyboard navigation: {{keyboard_requirements}}
|
||||
- Screen reader support: {{screen_reader_requirements}}
|
||||
- Touch targets: {{touch_requirements}}
|
||||
|
||||
**Content:**
|
||||
|
||||
- Alternative text: {{alt_text_requirements}}
|
||||
- Heading structure: {{heading_requirements}}
|
||||
- Form labels: {{form_requirements}}
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
{{accessibility_testing}}
|
||||
|
||||
## Responsiveness Strategy
|
||||
|
||||
[[LLM: Define breakpoints and adaptation strategies for different device sizes. Consider both technical constraints and user contexts.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Breakpoints
|
||||
|
||||
| Breakpoint | Min Width | Max Width | Target 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}} |
|
||||
|
||||
### Adaptation Patterns
|
||||
|
||||
**Layout Changes:** {{layout_adaptations}}
|
||||
|
||||
**Navigation Changes:** {{nav_adaptations}}
|
||||
|
||||
**Content Priority:** {{content_adaptations}}
|
||||
|
||||
**Interaction Changes:** {{interaction_adaptations}}
|
||||
|
||||
## Animation & Micro-interactions
|
||||
|
||||
[[LLM: Define motion design principles and key interactions. Keep performance and accessibility in mind.
|
||||
|
||||
After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Motion Principles
|
||||
|
||||
{{motion_principles}}
|
||||
|
||||
### Key Animations
|
||||
|
||||
<<REPEAT: animation>>
|
||||
|
||||
- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})
|
||||
<</REPEAT>>
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
[[LLM: Define performance goals and strategies that impact UX design decisions.]]
|
||||
|
||||
### Performance Goals
|
||||
|
||||
- **Page Load:** {{load_time_goal}}
|
||||
- **Interaction Response:** {{interaction_goal}}
|
||||
- **Animation FPS:** {{animation_goal}}
|
||||
|
||||
### Design Strategies
|
||||
|
||||
{{performance_strategies}}
|
||||
|
||||
## Next Steps
|
||||
|
||||
[[LLM: After completing the UI/UX specification:
|
||||
|
||||
1. Recommend review with stakeholders
|
||||
2. Suggest creating/updating visual designs in design tool
|
||||
3. Prepare for handoff to Design Architect for frontend architecture
|
||||
4. Note any open questions or decisions needed]]
|
||||
|
||||
### Immediate Actions
|
||||
|
||||
1. {{next_step_1}}
|
||||
2. {{next_step_2}}
|
||||
3. {{next_step_3}}
|
||||
|
||||
### Design Handoff Checklist
|
||||
|
||||
- [ ] All user flows documented
|
||||
- [ ] Component inventory complete
|
||||
- [ ] Accessibility requirements defined
|
||||
- [ ] Responsive strategy clear
|
||||
- [ ] Brand guidelines incorporated
|
||||
- [ ] Performance goals established
|
||||
|
||||
## Checklist Results
|
||||
|
||||
[[LLM: If a UI/UX checklist exists, run it against this document and report results here.]]
|
||||
349
bmad-core/templates/front-end-spec-tmpl.yaml
Normal file
349
bmad-core/templates/front-end-spec-tmpl.yaml
Normal file
@@ -0,0 +1,349 @@
|
||||
template:
|
||||
id: frontend-spec-template-v2
|
||||
name: UI/UX Specification
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/front-end-spec.md
|
||||
title: "{{project_name}} UI/UX Specification"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: |
|
||||
Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
|
||||
|
||||
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
||||
content: |
|
||||
This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
|
||||
sections:
|
||||
- id: ux-goals-principles
|
||||
title: Overall UX Goals & Principles
|
||||
instruction: |
|
||||
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
||||
|
||||
1. Target User Personas - elicit details or confirm existing ones from PRD
|
||||
2. Key Usability Goals - understand what success looks like for users
|
||||
3. Core Design Principles - establish 3-5 guiding principles
|
||||
elicit: true
|
||||
sections:
|
||||
- id: user-personas
|
||||
title: Target User Personas
|
||||
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"
|
||||
- id: usability-goals
|
||||
title: 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"
|
||||
- id: design-principles
|
||||
title: Design Principles
|
||||
template: "{{design_principles}}"
|
||||
type: numbered-list
|
||||
examples:
|
||||
- "**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"
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: information-architecture
|
||||
title: Information Architecture (IA)
|
||||
instruction: |
|
||||
Collaborate with the user to create a comprehensive information architecture:
|
||||
|
||||
1. Build a Site Map or Screen Inventory showing all major areas
|
||||
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
||||
3. Use Mermaid diagrams for visual representation
|
||||
4. Consider user mental models and expected groupings
|
||||
elicit: true
|
||||
sections:
|
||||
- id: sitemap
|
||||
title: Site Map / Screen Inventory
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
template: "{{sitemap_diagram}}"
|
||||
examples:
|
||||
- |
|
||||
graph TD
|
||||
A[Homepage] --> B[Dashboard]
|
||||
A --> C[Products]
|
||||
A --> D[Account]
|
||||
B --> B1[Analytics]
|
||||
B --> B2[Recent Activity]
|
||||
C --> C1[Browse]
|
||||
C --> C2[Search]
|
||||
C --> C3[Product Details]
|
||||
D --> D1[Profile]
|
||||
D --> D2[Settings]
|
||||
D --> D3[Billing]
|
||||
- id: navigation-structure
|
||||
title: Navigation Structure
|
||||
template: |
|
||||
**Primary Navigation:** {{primary_nav_description}}
|
||||
|
||||
**Secondary Navigation:** {{secondary_nav_description}}
|
||||
|
||||
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
||||
|
||||
- id: user-flows
|
||||
title: User Flows
|
||||
instruction: |
|
||||
For each critical user task identified in the PRD:
|
||||
|
||||
1. Define the user's goal clearly
|
||||
2. Map out all steps including decision points
|
||||
3. Consider edge cases and error states
|
||||
4. Use Mermaid flow diagrams for clarity
|
||||
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
||||
|
||||
Create subsections for each major flow.
|
||||
elicit: true
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: flow
|
||||
title: "{{flow_name}}"
|
||||
template: |
|
||||
**User Goal:** {{flow_goal}}
|
||||
|
||||
**Entry Points:** {{entry_points}}
|
||||
|
||||
**Success Criteria:** {{success_criteria}}
|
||||
sections:
|
||||
- id: flow-diagram
|
||||
title: Flow Diagram
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
template: "{{flow_diagram}}"
|
||||
- id: edge-cases
|
||||
title: "Edge Cases & Error Handling:"
|
||||
type: bullet-list
|
||||
template: "- {{edge_case}}"
|
||||
- id: notes
|
||||
template: "**Notes:** {{flow_notes}}"
|
||||
|
||||
- id: wireframes-mockups
|
||||
title: Wireframes & Mockups
|
||||
instruction: |
|
||||
Clarify where detailed visual designs will be created (Figma, Sketch, etc.) and how to reference them. If low-fidelity wireframes are needed, offer to help conceptualize layouts for key screens.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: design-files
|
||||
template: "**Primary Design Files:** {{design_tool_link}}"
|
||||
- id: key-screen-layouts
|
||||
title: Key Screen Layouts
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: screen
|
||||
title: "{{screen_name}}"
|
||||
template: |
|
||||
**Purpose:** {{screen_purpose}}
|
||||
|
||||
**Key Elements:**
|
||||
- {{element_1}}
|
||||
- {{element_2}}
|
||||
- {{element_3}}
|
||||
|
||||
**Interaction Notes:** {{interaction_notes}}
|
||||
|
||||
**Design File Reference:** {{specific_frame_link}}
|
||||
|
||||
- id: component-library
|
||||
title: Component Library / Design System
|
||||
instruction: |
|
||||
Discuss whether to use an existing design system or create a new one. If creating new, identify foundational components and their key states. Note that detailed technical specs belong in front-end-architecture.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: design-system-approach
|
||||
template: "**Design System Approach:** {{design_system_approach}}"
|
||||
- id: core-components
|
||||
title: Core Components
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: component
|
||||
title: "{{component_name}}"
|
||||
template: |
|
||||
**Purpose:** {{component_purpose}}
|
||||
|
||||
**Variants:** {{component_variants}}
|
||||
|
||||
**States:** {{component_states}}
|
||||
|
||||
**Usage Guidelines:** {{usage_guidelines}}
|
||||
|
||||
- id: branding-style
|
||||
title: Branding & Style Guide
|
||||
instruction: Link to existing style guide or define key brand elements. Ensure consistency with company brand guidelines if they exist.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: visual-identity
|
||||
title: Visual Identity
|
||||
template: "**Brand Guidelines:** {{brand_guidelines_link}}"
|
||||
- id: color-palette
|
||||
title: Color Palette
|
||||
type: table
|
||||
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"]
|
||||
- id: typography
|
||||
title: Typography
|
||||
sections:
|
||||
- id: font-families
|
||||
title: Font Families
|
||||
template: |
|
||||
- **Primary:** {{primary_font}}
|
||||
- **Secondary:** {{secondary_font}}
|
||||
- **Monospace:** {{mono_font}}
|
||||
- id: type-scale
|
||||
title: Type Scale
|
||||
type: table
|
||||
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}}"]
|
||||
- id: iconography
|
||||
title: Iconography
|
||||
template: |
|
||||
**Icon Library:** {{icon_library}}
|
||||
|
||||
**Usage Guidelines:** {{icon_guidelines}}
|
||||
- id: spacing-layout
|
||||
title: Spacing & Layout
|
||||
template: |
|
||||
**Grid System:** {{grid_system}}
|
||||
|
||||
**Spacing Scale:** {{spacing_scale}}
|
||||
|
||||
- id: accessibility
|
||||
title: Accessibility Requirements
|
||||
instruction: Define specific accessibility requirements based on target compliance level and user needs. Be comprehensive but practical.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: compliance-target
|
||||
title: Compliance Target
|
||||
template: "**Standard:** {{compliance_standard}}"
|
||||
- id: key-requirements
|
||||
title: Key Requirements
|
||||
template: |
|
||||
**Visual:**
|
||||
- Color contrast ratios: {{contrast_requirements}}
|
||||
- Focus indicators: {{focus_requirements}}
|
||||
- Text sizing: {{text_requirements}}
|
||||
|
||||
**Interaction:**
|
||||
- Keyboard navigation: {{keyboard_requirements}}
|
||||
- Screen reader support: {{screen_reader_requirements}}
|
||||
- Touch targets: {{touch_requirements}}
|
||||
|
||||
**Content:**
|
||||
- Alternative text: {{alt_text_requirements}}
|
||||
- Heading structure: {{heading_requirements}}
|
||||
- Form labels: {{form_requirements}}
|
||||
- id: testing-strategy
|
||||
title: Testing Strategy
|
||||
template: "{{accessibility_testing}}"
|
||||
|
||||
- id: responsiveness
|
||||
title: Responsiveness Strategy
|
||||
instruction: Define breakpoints and adaptation strategies for different device sizes. Consider both technical constraints and user contexts.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: breakpoints
|
||||
title: Breakpoints
|
||||
type: table
|
||||
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}}"]
|
||||
- id: adaptation-patterns
|
||||
title: Adaptation Patterns
|
||||
template: |
|
||||
**Layout Changes:** {{layout_adaptations}}
|
||||
|
||||
**Navigation Changes:** {{nav_adaptations}}
|
||||
|
||||
**Content Priority:** {{content_adaptations}}
|
||||
|
||||
**Interaction Changes:** {{interaction_adaptations}}
|
||||
|
||||
- id: animation
|
||||
title: Animation & Micro-interactions
|
||||
instruction: Define motion design principles and key interactions. Keep performance and accessibility in mind.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: motion-principles
|
||||
title: Motion Principles
|
||||
template: "{{motion_principles}}"
|
||||
- id: key-animations
|
||||
title: Key Animations
|
||||
repeatable: true
|
||||
template: "- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})"
|
||||
|
||||
- id: performance
|
||||
title: Performance Considerations
|
||||
instruction: Define performance goals and strategies that impact UX design decisions.
|
||||
sections:
|
||||
- id: performance-goals
|
||||
title: Performance Goals
|
||||
template: |
|
||||
- **Page Load:** {{load_time_goal}}
|
||||
- **Interaction Response:** {{interaction_goal}}
|
||||
- **Animation FPS:** {{animation_goal}}
|
||||
- id: design-strategies
|
||||
title: Design Strategies
|
||||
template: "{{performance_strategies}}"
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
instruction: |
|
||||
After completing the UI/UX specification:
|
||||
|
||||
1. Recommend review with stakeholders
|
||||
2. Suggest creating/updating visual designs in design tool
|
||||
3. Prepare for handoff to Design Architect for frontend architecture
|
||||
4. Note any open questions or decisions needed
|
||||
sections:
|
||||
- id: immediate-actions
|
||||
title: Immediate Actions
|
||||
type: numbered-list
|
||||
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"
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results
|
||||
instruction: If a UI/UX checklist exists, run it against this document and report results here.
|
||||
File diff suppressed because it is too large
Load Diff
805
bmad-core/templates/fullstack-architecture-tmpl.yaml
Normal file
805
bmad-core/templates/fullstack-architecture-tmpl.yaml
Normal file
@@ -0,0 +1,805 @@
|
||||
template:
|
||||
id: fullstack-architecture-template-v2
|
||||
name: Fullstack Architecture Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/architecture.md
|
||||
title: "{{project_name}} Fullstack Architecture Document"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: |
|
||||
If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.
|
||||
elicit: true
|
||||
content: |
|
||||
This document outlines the complete fullstack architecture for {{project_name}}, including backend systems, frontend implementation, and their integration. It serves as the single source of truth for AI-driven development, ensuring consistency across the entire technology stack.
|
||||
|
||||
This unified approach combines what would traditionally be separate backend and frontend architecture documents, streamlining the development process for modern fullstack applications where these concerns are increasingly intertwined.
|
||||
sections:
|
||||
- id: starter-template
|
||||
title: Starter Template or Existing Project
|
||||
instruction: |
|
||||
Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases:
|
||||
|
||||
1. Review the PRD and other documents for mentions of:
|
||||
- Fullstack starter templates (e.g., T3 Stack, MEAN/MERN starters, Django + React templates)
|
||||
- Monorepo templates (e.g., Nx, Turborepo starters)
|
||||
- Platform-specific starters (e.g., Vercel templates, AWS Amplify starters)
|
||||
- Existing projects being extended or cloned
|
||||
|
||||
2. If starter templates or existing projects are mentioned:
|
||||
- Ask the user to provide access (links, repos, or files)
|
||||
- Analyze to understand pre-configured choices and constraints
|
||||
- Note any architectural decisions already made
|
||||
- Identify what can be modified vs what must be retained
|
||||
|
||||
3. If no starter is mentioned but this is greenfield:
|
||||
- Suggest appropriate fullstack starters based on tech preferences
|
||||
- Consider platform-specific options (Vercel, AWS, etc.)
|
||||
- Let user decide whether to use one
|
||||
|
||||
4. Document the decision and any constraints it imposes
|
||||
|
||||
If none, state "N/A - Greenfield project"
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: high-level-architecture
|
||||
title: High Level Architecture
|
||||
instruction: This section contains multiple subsections that establish the foundation. Present all subsections together, then elicit feedback on the complete section.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: technical-summary
|
||||
title: Technical Summary
|
||||
instruction: |
|
||||
Provide a comprehensive overview (4-6 sentences) covering:
|
||||
- Overall architectural style and deployment approach
|
||||
- Frontend framework and backend technology choices
|
||||
- Key integration points between frontend and backend
|
||||
- Infrastructure platform and services
|
||||
- How this architecture achieves PRD goals
|
||||
- id: platform-infrastructure
|
||||
title: Platform and Infrastructure Choice
|
||||
instruction: |
|
||||
Based on PRD requirements and technical assumptions, make a platform recommendation:
|
||||
|
||||
1. Consider common patterns (not an exhaustive list, use your own best judgement and search the web as needed for emerging trends):
|
||||
- **Vercel + Supabase**: For rapid development with Next.js, built-in auth/storage
|
||||
- **AWS Full Stack**: For enterprise scale with Lambda, API Gateway, S3, Cognito
|
||||
- **Azure**: For .NET ecosystems or enterprise Microsoft environments
|
||||
- **Google Cloud**: For ML/AI heavy applications or Google ecosystem integration
|
||||
|
||||
2. Present 2-3 viable options with clear pros/cons
|
||||
3. Make a recommendation with rationale
|
||||
4. Get explicit user confirmation
|
||||
|
||||
Document the choice and key services that will be used.
|
||||
template: |
|
||||
**Platform:** {{selected_platform}}
|
||||
**Key Services:** {{core_services_list}}
|
||||
**Deployment Host and Regions:** {{regions}}
|
||||
- id: repository-structure
|
||||
title: Repository Structure
|
||||
instruction: |
|
||||
Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure:
|
||||
|
||||
1. For modern fullstack apps, monorepo is often preferred
|
||||
2. Consider tooling (Nx, Turborepo, Lerna, npm workspaces)
|
||||
3. Define package/app boundaries
|
||||
4. Plan for shared code between frontend and backend
|
||||
template: |
|
||||
**Structure:** {{repo_structure_choice}}
|
||||
**Monorepo Tool:** {{monorepo_tool_if_applicable}}
|
||||
**Package Organization:** {{package_strategy}}
|
||||
- id: architecture-diagram
|
||||
title: High Level Architecture Diagram
|
||||
type: mermaid
|
||||
mermaid_type: graph
|
||||
instruction: |
|
||||
Create a Mermaid diagram showing the complete system architecture including:
|
||||
- User entry points (web, mobile)
|
||||
- Frontend application deployment
|
||||
- API layer (REST/GraphQL)
|
||||
- Backend services
|
||||
- Databases and storage
|
||||
- External integrations
|
||||
- CDN and caching layers
|
||||
|
||||
Use appropriate diagram type for clarity.
|
||||
- id: architectural-patterns
|
||||
title: Architectural Patterns
|
||||
instruction: |
|
||||
List patterns that will guide both frontend and backend development. Include patterns for:
|
||||
- Overall architecture (e.g., Jamstack, Serverless, Microservices)
|
||||
- Frontend patterns (e.g., Component-based, State management)
|
||||
- Backend patterns (e.g., Repository, CQRS, Event-driven)
|
||||
- Integration patterns (e.g., BFF, API Gateway)
|
||||
|
||||
For each pattern, provide recommendation and rationale.
|
||||
repeatable: true
|
||||
template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
|
||||
examples:
|
||||
- "**Jamstack Architecture:** Static site generation with serverless APIs - _Rationale:_ Optimal performance and scalability for content-heavy applications"
|
||||
- "**Component-Based UI:** Reusable React components with TypeScript - _Rationale:_ Maintainability and type safety across large codebases"
|
||||
- "**Repository Pattern:** Abstract data access logic - _Rationale:_ Enables testing and future database migration flexibility"
|
||||
- "**API Gateway Pattern:** Single entry point for all API calls - _Rationale:_ Centralized auth, rate limiting, and monitoring"
|
||||
|
||||
- id: tech-stack
|
||||
title: Tech Stack
|
||||
instruction: |
|
||||
This is the DEFINITIVE technology selection for the entire project. Work with user to finalize all choices. This table is the single source of truth - all development must use these exact versions.
|
||||
|
||||
Key areas to cover:
|
||||
- Frontend and backend languages/frameworks
|
||||
- Databases and caching
|
||||
- Authentication and authorization
|
||||
- API approach
|
||||
- Testing tools for both frontend and backend
|
||||
- Build and deployment tools
|
||||
- Monitoring and logging
|
||||
|
||||
Upon render, elicit feedback immediately.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: tech-stack-table
|
||||
title: Technology Stack Table
|
||||
type: table
|
||||
columns: [Category, Technology, Version, Purpose, Rationale]
|
||||
rows:
|
||||
- ["Frontend Language", "{{fe_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Frontend Framework", "{{fe_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["UI Component Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["State Management", "{{state_mgmt}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Backend Language", "{{be_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Backend Framework", "{{be_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["API Style", "{{api_style}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Database", "{{database}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Cache", "{{cache}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["File Storage", "{{storage}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Authentication", "{{auth}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Frontend Testing", "{{fe_test}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Backend Testing", "{{be_test}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["E2E Testing", "{{e2e_test}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Build Tool", "{{build_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Bundler", "{{bundler}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["IaC Tool", "{{iac_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["CI/CD", "{{cicd}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Monitoring", "{{monitoring}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["Logging", "{{logging}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
- ["CSS Framework", "{{css_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
||||
|
||||
- id: data-models
|
||||
title: Data Models
|
||||
instruction: |
|
||||
Define the core data models/entities that will be shared between frontend and backend:
|
||||
|
||||
1. Review PRD requirements and identify key business entities
|
||||
2. For each model, explain its purpose and relationships
|
||||
3. Include key attributes and data types
|
||||
4. Show relationships between models
|
||||
5. Create TypeScript interfaces that can be shared
|
||||
6. Discuss design decisions with user
|
||||
|
||||
Create a clear conceptual model before moving to database schema.
|
||||
elicit: true
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: model
|
||||
title: "{{model_name}}"
|
||||
template: |
|
||||
**Purpose:** {{model_purpose}}
|
||||
|
||||
**Key Attributes:**
|
||||
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
||||
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
||||
sections:
|
||||
- id: typescript-interface
|
||||
title: TypeScript Interface
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{model_interface}}"
|
||||
- id: relationships
|
||||
title: Relationships
|
||||
type: bullet-list
|
||||
template: "- {{relationship}}"
|
||||
|
||||
- id: api-spec
|
||||
title: API Specification
|
||||
instruction: |
|
||||
Based on the chosen API style from Tech Stack:
|
||||
|
||||
1. If REST API, create an OpenAPI 3.0 specification
|
||||
2. If GraphQL, provide the GraphQL schema
|
||||
3. If tRPC, show router definitions
|
||||
4. Include all endpoints from epics/stories
|
||||
5. Define request/response schemas based on data models
|
||||
6. Document authentication requirements
|
||||
7. Include example requests/responses
|
||||
|
||||
Use appropriate format for the chosen API style. If no API (e.g., static site), skip this section.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: rest-api
|
||||
title: REST API Specification
|
||||
condition: API style is REST
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
title: {{api_title}}
|
||||
version: {{api_version}}
|
||||
description: {{api_description}}
|
||||
servers:
|
||||
- url: {{server_url}}
|
||||
description: {{server_description}}
|
||||
- id: graphql-api
|
||||
title: GraphQL Schema
|
||||
condition: API style is GraphQL
|
||||
type: code
|
||||
language: graphql
|
||||
template: "{{graphql_schema}}"
|
||||
- id: trpc-api
|
||||
title: tRPC Router Definitions
|
||||
condition: API style is tRPC
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{trpc_routers}}"
|
||||
|
||||
- id: components
|
||||
title: Components
|
||||
instruction: |
|
||||
Based on the architectural patterns, tech stack, and data models from above:
|
||||
|
||||
1. Identify major logical components/services across the fullstack
|
||||
2. Consider both frontend and backend components
|
||||
3. Define clear boundaries and interfaces between components
|
||||
4. For each component, specify:
|
||||
- Primary responsibility
|
||||
- Key interfaces/APIs exposed
|
||||
- Dependencies on other components
|
||||
- Technology specifics based on tech stack choices
|
||||
|
||||
5. Create component diagrams where helpful
|
||||
elicit: true
|
||||
sections:
|
||||
- id: component-list
|
||||
repeatable: true
|
||||
title: "{{component_name}}"
|
||||
template: |
|
||||
**Responsibility:** {{component_description}}
|
||||
|
||||
**Key Interfaces:**
|
||||
- {{interface_1}}
|
||||
- {{interface_2}}
|
||||
|
||||
**Dependencies:** {{dependencies}}
|
||||
|
||||
**Technology Stack:** {{component_tech_details}}
|
||||
- id: component-diagrams
|
||||
title: Component Diagrams
|
||||
type: mermaid
|
||||
instruction: |
|
||||
Create Mermaid diagrams to visualize component relationships. Options:
|
||||
- C4 Container diagram for high-level view
|
||||
- Component diagram for detailed internal structure
|
||||
- Sequence diagrams for complex interactions
|
||||
Choose the most appropriate for clarity
|
||||
|
||||
- id: external-apis
|
||||
title: External APIs
|
||||
condition: Project requires external API integrations
|
||||
instruction: |
|
||||
For each external service integration:
|
||||
|
||||
1. Identify APIs needed based on PRD requirements and component design
|
||||
2. If documentation URLs are unknown, ask user for specifics
|
||||
3. Document authentication methods and security considerations
|
||||
4. List specific endpoints that will be used
|
||||
5. Note any rate limits or usage constraints
|
||||
|
||||
If no external APIs are needed, state this explicitly and skip to next section.
|
||||
elicit: true
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: api
|
||||
title: "{{api_name}} API"
|
||||
template: |
|
||||
- **Purpose:** {{api_purpose}}
|
||||
- **Documentation:** {{api_docs_url}}
|
||||
- **Base URL(s):** {{api_base_url}}
|
||||
- **Authentication:** {{auth_method}}
|
||||
- **Rate Limits:** {{rate_limits}}
|
||||
|
||||
**Key Endpoints Used:**
|
||||
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
||||
|
||||
**Integration Notes:** {{integration_considerations}}
|
||||
|
||||
- id: core-workflows
|
||||
title: Core Workflows
|
||||
type: mermaid
|
||||
mermaid_type: sequence
|
||||
instruction: |
|
||||
Illustrate key system workflows using sequence diagrams:
|
||||
|
||||
1. Identify critical user journeys from PRD
|
||||
2. Show component interactions including external APIs
|
||||
3. Include both frontend and backend flows
|
||||
4. Include error handling paths
|
||||
5. Document async operations
|
||||
6. Create both high-level and detailed diagrams as needed
|
||||
|
||||
Focus on workflows that clarify architecture decisions or complex interactions.
|
||||
elicit: true
|
||||
|
||||
- id: database-schema
|
||||
title: Database Schema
|
||||
instruction: |
|
||||
Transform the conceptual data models into concrete database schemas:
|
||||
|
||||
1. Use the database type(s) selected in Tech Stack
|
||||
2. Create schema definitions using appropriate notation
|
||||
3. Include indexes, constraints, and relationships
|
||||
4. Consider performance and scalability
|
||||
5. For NoSQL, show document structures
|
||||
|
||||
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
||||
elicit: true
|
||||
|
||||
- id: frontend-architecture
|
||||
title: Frontend Architecture
|
||||
instruction: Define frontend-specific architecture details. After each subsection, note if user wants to refine before continuing.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: component-architecture
|
||||
title: Component Architecture
|
||||
instruction: Define component organization and patterns based on chosen framework.
|
||||
sections:
|
||||
- id: component-organization
|
||||
title: Component Organization
|
||||
type: code
|
||||
language: text
|
||||
template: "{{component_structure}}"
|
||||
- id: component-template
|
||||
title: Component Template
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{component_template}}"
|
||||
- id: state-management
|
||||
title: State Management Architecture
|
||||
instruction: Detail state management approach based on chosen solution.
|
||||
sections:
|
||||
- id: state-structure
|
||||
title: State Structure
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{state_structure}}"
|
||||
- id: state-patterns
|
||||
title: State Management Patterns
|
||||
type: bullet-list
|
||||
template: "- {{pattern}}"
|
||||
- id: routing-architecture
|
||||
title: Routing Architecture
|
||||
instruction: Define routing structure based on framework choice.
|
||||
sections:
|
||||
- id: route-organization
|
||||
title: Route Organization
|
||||
type: code
|
||||
language: text
|
||||
template: "{{route_structure}}"
|
||||
- id: protected-routes
|
||||
title: Protected Route Pattern
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{protected_route_example}}"
|
||||
- id: frontend-services
|
||||
title: Frontend Services Layer
|
||||
instruction: Define how frontend communicates with backend.
|
||||
sections:
|
||||
- id: api-client-setup
|
||||
title: API Client Setup
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{api_client_setup}}"
|
||||
- id: service-example
|
||||
title: Service Example
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{service_example}}"
|
||||
|
||||
- id: backend-architecture
|
||||
title: Backend Architecture
|
||||
instruction: Define backend-specific architecture details. Consider serverless vs traditional server approaches.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: service-architecture
|
||||
title: Service Architecture
|
||||
instruction: Based on platform choice, define service organization.
|
||||
sections:
|
||||
- id: serverless-architecture
|
||||
condition: Serverless architecture chosen
|
||||
sections:
|
||||
- id: function-organization
|
||||
title: Function Organization
|
||||
type: code
|
||||
language: text
|
||||
template: "{{function_structure}}"
|
||||
- id: function-template
|
||||
title: Function Template
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{function_template}}"
|
||||
- id: traditional-server
|
||||
condition: Traditional server architecture chosen
|
||||
sections:
|
||||
- id: controller-organization
|
||||
title: Controller/Route Organization
|
||||
type: code
|
||||
language: text
|
||||
template: "{{controller_structure}}"
|
||||
- id: controller-template
|
||||
title: Controller Template
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{controller_template}}"
|
||||
- id: database-architecture
|
||||
title: Database Architecture
|
||||
instruction: Define database schema and access patterns.
|
||||
sections:
|
||||
- id: schema-design
|
||||
title: Schema Design
|
||||
type: code
|
||||
language: sql
|
||||
template: "{{database_schema}}"
|
||||
- id: data-access-layer
|
||||
title: Data Access Layer
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{repository_pattern}}"
|
||||
- id: auth-architecture
|
||||
title: Authentication and Authorization
|
||||
instruction: Define auth implementation details.
|
||||
sections:
|
||||
- id: auth-flow
|
||||
title: Auth Flow
|
||||
type: mermaid
|
||||
mermaid_type: sequence
|
||||
template: "{{auth_flow_diagram}}"
|
||||
- id: auth-middleware
|
||||
title: Middleware/Guards
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{auth_middleware}}"
|
||||
|
||||
- id: unified-project-structure
|
||||
title: Unified Project Structure
|
||||
instruction: Create a monorepo structure that accommodates both frontend and backend. Adapt based on chosen tools and frameworks.
|
||||
elicit: true
|
||||
type: code
|
||||
language: plaintext
|
||||
examples:
|
||||
- |
|
||||
{{project-name}}/
|
||||
├── .github/ # CI/CD workflows
|
||||
│ └── workflows/
|
||||
│ ├── ci.yaml
|
||||
│ └── deploy.yaml
|
||||
├── apps/ # Application packages
|
||||
│ ├── web/ # Frontend application
|
||||
│ │ ├── src/
|
||||
│ │ │ ├── components/ # UI components
|
||||
│ │ │ ├── pages/ # Page components/routes
|
||||
│ │ │ ├── hooks/ # Custom React hooks
|
||||
│ │ │ ├── services/ # API client services
|
||||
│ │ │ ├── stores/ # State management
|
||||
│ │ │ ├── styles/ # Global styles/themes
|
||||
│ │ │ └── utils/ # Frontend utilities
|
||||
│ │ ├── public/ # Static assets
|
||||
│ │ ├── tests/ # Frontend tests
|
||||
│ │ └── package.json
|
||||
│ └── api/ # Backend application
|
||||
│ ├── src/
|
||||
│ │ ├── routes/ # API routes/controllers
|
||||
│ │ ├── services/ # Business logic
|
||||
│ │ ├── models/ # Data models
|
||||
│ │ ├── middleware/ # Express/API middleware
|
||||
│ │ ├── utils/ # Backend utilities
|
||||
│ │ └── {{serverless_or_server_entry}}
|
||||
│ ├── tests/ # Backend tests
|
||||
│ └── package.json
|
||||
├── packages/ # Shared packages
|
||||
│ ├── shared/ # Shared types/utilities
|
||||
│ │ ├── src/
|
||||
│ │ │ ├── types/ # TypeScript interfaces
|
||||
│ │ │ ├── constants/ # Shared constants
|
||||
│ │ │ └── utils/ # Shared utilities
|
||||
│ │ └── package.json
|
||||
│ ├── ui/ # Shared UI components
|
||||
│ │ ├── src/
|
||||
│ │ └── package.json
|
||||
│ └── config/ # Shared configuration
|
||||
│ ├── eslint/
|
||||
│ ├── typescript/
|
||||
│ └── jest/
|
||||
├── infrastructure/ # IaC definitions
|
||||
│ └── {{iac_structure}}
|
||||
├── scripts/ # Build/deploy scripts
|
||||
├── docs/ # Documentation
|
||||
│ ├── prd.md
|
||||
│ ├── front-end-spec.md
|
||||
│ └── fullstack-architecture.md
|
||||
├── .env.example # Environment template
|
||||
├── package.json # Root package.json
|
||||
├── {{monorepo_config}} # Monorepo configuration
|
||||
└── README.md
|
||||
|
||||
- id: development-workflow
|
||||
title: Development Workflow
|
||||
instruction: Define the development setup and workflow for the fullstack application.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: local-setup
|
||||
title: Local Development Setup
|
||||
sections:
|
||||
- id: prerequisites
|
||||
title: Prerequisites
|
||||
type: code
|
||||
language: bash
|
||||
template: "{{prerequisites_commands}}"
|
||||
- id: initial-setup
|
||||
title: Initial Setup
|
||||
type: code
|
||||
language: bash
|
||||
template: "{{setup_commands}}"
|
||||
- id: dev-commands
|
||||
title: Development Commands
|
||||
type: code
|
||||
language: bash
|
||||
template: |
|
||||
# Start all services
|
||||
{{start_all_command}}
|
||||
|
||||
# Start frontend only
|
||||
{{start_frontend_command}}
|
||||
|
||||
# Start backend only
|
||||
{{start_backend_command}}
|
||||
|
||||
# Run tests
|
||||
{{test_commands}}
|
||||
- id: environment-config
|
||||
title: Environment Configuration
|
||||
sections:
|
||||
- id: env-vars
|
||||
title: Required Environment Variables
|
||||
type: code
|
||||
language: bash
|
||||
template: |
|
||||
# Frontend (.env.local)
|
||||
{{frontend_env_vars}}
|
||||
|
||||
# Backend (.env)
|
||||
{{backend_env_vars}}
|
||||
|
||||
# Shared
|
||||
{{shared_env_vars}}
|
||||
|
||||
- id: deployment-architecture
|
||||
title: Deployment Architecture
|
||||
instruction: Define deployment strategy based on platform choice.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: deployment-strategy
|
||||
title: Deployment Strategy
|
||||
template: |
|
||||
**Frontend Deployment:**
|
||||
- **Platform:** {{frontend_deploy_platform}}
|
||||
- **Build Command:** {{frontend_build_command}}
|
||||
- **Output Directory:** {{frontend_output_dir}}
|
||||
- **CDN/Edge:** {{cdn_strategy}}
|
||||
|
||||
**Backend Deployment:**
|
||||
- **Platform:** {{backend_deploy_platform}}
|
||||
- **Build Command:** {{backend_build_command}}
|
||||
- **Deployment Method:** {{deployment_method}}
|
||||
- id: cicd-pipeline
|
||||
title: CI/CD Pipeline
|
||||
type: code
|
||||
language: yaml
|
||||
template: "{{cicd_pipeline_config}}"
|
||||
- id: environments
|
||||
title: Environments
|
||||
type: table
|
||||
columns: [Environment, Frontend URL, Backend URL, Purpose]
|
||||
rows:
|
||||
- ["Development", "{{dev_fe_url}}", "{{dev_be_url}}", "Local development"]
|
||||
- ["Staging", "{{staging_fe_url}}", "{{staging_be_url}}", "Pre-production testing"]
|
||||
- ["Production", "{{prod_fe_url}}", "{{prod_be_url}}", "Live environment"]
|
||||
|
||||
- id: security-performance
|
||||
title: Security and Performance
|
||||
instruction: Define security and performance considerations for the fullstack application.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: security-requirements
|
||||
title: Security Requirements
|
||||
template: |
|
||||
**Frontend Security:**
|
||||
- CSP Headers: {{csp_policy}}
|
||||
- XSS Prevention: {{xss_strategy}}
|
||||
- Secure Storage: {{storage_strategy}}
|
||||
|
||||
**Backend Security:**
|
||||
- Input Validation: {{validation_approach}}
|
||||
- Rate Limiting: {{rate_limit_config}}
|
||||
- CORS Policy: {{cors_config}}
|
||||
|
||||
**Authentication Security:**
|
||||
- Token Storage: {{token_strategy}}
|
||||
- Session Management: {{session_approach}}
|
||||
- Password Policy: {{password_requirements}}
|
||||
- id: performance-optimization
|
||||
title: Performance Optimization
|
||||
template: |
|
||||
**Frontend Performance:**
|
||||
- Bundle Size Target: {{bundle_size}}
|
||||
- Loading Strategy: {{loading_approach}}
|
||||
- Caching Strategy: {{fe_cache_strategy}}
|
||||
|
||||
**Backend Performance:**
|
||||
- Response Time Target: {{response_target}}
|
||||
- Database Optimization: {{db_optimization}}
|
||||
- Caching Strategy: {{be_cache_strategy}}
|
||||
|
||||
- id: testing-strategy
|
||||
title: Testing Strategy
|
||||
instruction: Define comprehensive testing approach for fullstack application.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: testing-pyramid
|
||||
title: Testing Pyramid
|
||||
type: code
|
||||
language: text
|
||||
template: |
|
||||
E2E Tests
|
||||
/ \
|
||||
Integration Tests
|
||||
/ \
|
||||
Frontend Unit Backend Unit
|
||||
- id: test-organization
|
||||
title: Test Organization
|
||||
sections:
|
||||
- id: frontend-tests
|
||||
title: Frontend Tests
|
||||
type: code
|
||||
language: text
|
||||
template: "{{frontend_test_structure}}"
|
||||
- id: backend-tests
|
||||
title: Backend Tests
|
||||
type: code
|
||||
language: text
|
||||
template: "{{backend_test_structure}}"
|
||||
- id: e2e-tests
|
||||
title: E2E Tests
|
||||
type: code
|
||||
language: text
|
||||
template: "{{e2e_test_structure}}"
|
||||
- id: test-examples
|
||||
title: Test Examples
|
||||
sections:
|
||||
- id: frontend-test
|
||||
title: Frontend Component Test
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{frontend_test_example}}"
|
||||
- id: backend-test
|
||||
title: Backend API Test
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{backend_test_example}}"
|
||||
- id: e2e-test
|
||||
title: E2E Test
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{e2e_test_example}}"
|
||||
|
||||
- id: coding-standards
|
||||
title: Coding Standards
|
||||
instruction: Define MINIMAL but CRITICAL standards for AI agents. Focus only on project-specific rules that prevent common mistakes. These will be used by dev agents.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: critical-rules
|
||||
title: Critical Fullstack Rules
|
||||
repeatable: true
|
||||
template: "- **{{rule_name}}:** {{rule_description}}"
|
||||
examples:
|
||||
- "**Type Sharing:** Always define types in packages/shared and import from there"
|
||||
- "**API Calls:** Never make direct HTTP calls - use the service layer"
|
||||
- "**Environment Variables:** Access only through config objects, never process.env directly"
|
||||
- "**Error Handling:** All API routes must use the standard error handler"
|
||||
- "**State Updates:** Never mutate state directly - use proper state management patterns"
|
||||
- id: naming-conventions
|
||||
title: Naming Conventions
|
||||
type: table
|
||||
columns: [Element, Frontend, Backend, Example]
|
||||
rows:
|
||||
- ["Components", "PascalCase", "-", "`UserProfile.tsx`"]
|
||||
- ["Hooks", "camelCase with 'use'", "-", "`useAuth.ts`"]
|
||||
- ["API Routes", "-", "kebab-case", "`/api/user-profile`"]
|
||||
- ["Database Tables", "-", "snake_case", "`user_profiles`"]
|
||||
|
||||
- id: error-handling
|
||||
title: Error Handling Strategy
|
||||
instruction: Define unified error handling across frontend and backend.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: error-flow
|
||||
title: Error Flow
|
||||
type: mermaid
|
||||
mermaid_type: sequence
|
||||
template: "{{error_flow_diagram}}"
|
||||
- id: error-format
|
||||
title: Error Response Format
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
interface ApiError {
|
||||
error: {
|
||||
code: string;
|
||||
message: string;
|
||||
details?: Record<string, any>;
|
||||
timestamp: string;
|
||||
requestId: string;
|
||||
};
|
||||
}
|
||||
- id: frontend-error-handling
|
||||
title: Frontend Error Handling
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{frontend_error_handler}}"
|
||||
- id: backend-error-handling
|
||||
title: Backend Error Handling
|
||||
type: code
|
||||
language: typescript
|
||||
template: "{{backend_error_handler}}"
|
||||
|
||||
- id: monitoring
|
||||
title: Monitoring and Observability
|
||||
instruction: Define monitoring strategy for fullstack application.
|
||||
elicit: true
|
||||
sections:
|
||||
- id: monitoring-stack
|
||||
title: Monitoring Stack
|
||||
template: |
|
||||
- **Frontend Monitoring:** {{frontend_monitoring}}
|
||||
- **Backend Monitoring:** {{backend_monitoring}}
|
||||
- **Error Tracking:** {{error_tracking}}
|
||||
- **Performance Monitoring:** {{perf_monitoring}}
|
||||
- id: key-metrics
|
||||
title: Key Metrics
|
||||
template: |
|
||||
**Frontend Metrics:**
|
||||
- Core Web Vitals
|
||||
- JavaScript errors
|
||||
- API response times
|
||||
- User interactions
|
||||
|
||||
**Backend Metrics:**
|
||||
- Request rate
|
||||
- Error rate
|
||||
- Response time
|
||||
- Database query performance
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results Report
|
||||
instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.
|
||||
@@ -1,263 +0,0 @@
|
||||
# Market Research Report: {{Project/Product Name}}
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/market-research.md]]
|
||||
|
||||
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{Provide a high-level overview of key findings, market opportunity assessment, and strategic recommendations. Write this section LAST after completing all other sections.}}
|
||||
|
||||
## Research Objectives & Methodology
|
||||
|
||||
### Research Objectives
|
||||
|
||||
{{List the primary objectives of this market research:
|
||||
|
||||
- What decisions will this research inform?
|
||||
- What specific questions need to be answered?
|
||||
- What are the success criteria for this research?}}
|
||||
|
||||
### Research Methodology
|
||||
|
||||
{{Describe the research approach:
|
||||
|
||||
- Data sources used (primary/secondary)
|
||||
- Analysis frameworks applied
|
||||
- Data collection timeframe
|
||||
- Limitations and assumptions}}
|
||||
|
||||
## Market Overview
|
||||
|
||||
### Market Definition
|
||||
|
||||
{{Define the market being analyzed:
|
||||
|
||||
- Product/service category
|
||||
- Geographic scope
|
||||
- Customer segments included
|
||||
- Value chain position}}
|
||||
|
||||
### Market Size & Growth
|
||||
|
||||
[[LLM: Guide through TAM, SAM, SOM calculations with clear assumptions. Use one or more approaches:
|
||||
|
||||
- Top-down: Start with industry data, narrow down
|
||||
- Bottom-up: Build from customer/unit economics
|
||||
- Value theory: Based on value provided vs. alternatives]]
|
||||
|
||||
#### Total Addressable Market (TAM)
|
||||
|
||||
{{Calculate and explain the total market opportunity}}
|
||||
|
||||
#### Serviceable Addressable Market (SAM)
|
||||
|
||||
{{Define the portion of TAM you can realistically reach}}
|
||||
|
||||
#### Serviceable Obtainable Market (SOM)
|
||||
|
||||
{{Estimate the portion you can realistically capture}}
|
||||
|
||||
### Market Trends & Drivers
|
||||
|
||||
[[LLM: Analyze key trends shaping the market using appropriate frameworks like PESTEL]]
|
||||
|
||||
#### Key Market Trends
|
||||
|
||||
{{List and explain 3-5 major trends:
|
||||
|
||||
- Trend 1: Description and impact
|
||||
- Trend 2: Description and impact
|
||||
- etc.}}
|
||||
|
||||
#### Growth Drivers
|
||||
|
||||
{{Identify primary factors driving market growth}}
|
||||
|
||||
#### Market Inhibitors
|
||||
|
||||
{{Identify factors constraining market growth}}
|
||||
|
||||
## Customer Analysis
|
||||
|
||||
### Target Segment Profiles
|
||||
|
||||
[[LLM: For each segment, create detailed profiles including demographics/firmographics, psychographics, behaviors, needs, and willingness to pay]]
|
||||
|
||||
#### Segment 1: {{Segment Name}}
|
||||
|
||||
- **Description:** {{Brief overview}}
|
||||
- **Size:** {{Number of customers/market value}}
|
||||
- **Characteristics:** {{Key demographics/firmographics}}
|
||||
- **Needs & Pain Points:** {{Primary problems they face}}
|
||||
- **Buying Process:** {{How they make purchasing decisions}}
|
||||
- **Willingness to Pay:** {{Price sensitivity and value perception}}
|
||||
|
||||
<<REPEAT for each additional segment>>
|
||||
|
||||
### Jobs-to-be-Done Analysis
|
||||
|
||||
[[LLM: Uncover what customers are really trying to accomplish]]
|
||||
|
||||
#### Functional Jobs
|
||||
|
||||
{{List practical tasks and objectives customers need to complete}}
|
||||
|
||||
#### Emotional Jobs
|
||||
|
||||
{{Describe feelings and perceptions customers seek}}
|
||||
|
||||
#### Social Jobs
|
||||
|
||||
{{Explain how customers want to be perceived by others}}
|
||||
|
||||
### Customer Journey Mapping
|
||||
|
||||
[[LLM: Map the end-to-end customer experience for primary segments]]
|
||||
|
||||
{{For primary customer segment:
|
||||
|
||||
1. **Awareness:** How they discover solutions
|
||||
2. **Consideration:** Evaluation criteria and process
|
||||
3. **Purchase:** Decision triggers and barriers
|
||||
4. **Onboarding:** Initial experience expectations
|
||||
5. **Usage:** Ongoing interaction patterns
|
||||
6. **Advocacy:** Referral and expansion behaviors}}
|
||||
|
||||
## Competitive Landscape
|
||||
|
||||
### Market Structure
|
||||
|
||||
{{Describe the overall competitive environment:
|
||||
|
||||
- Number of competitors
|
||||
- Market concentration
|
||||
- Competitive intensity}}
|
||||
|
||||
### Major Players Analysis
|
||||
|
||||
{{For top 3-5 competitors:
|
||||
|
||||
- Company name and brief description
|
||||
- Market share estimate
|
||||
- Key strengths and weaknesses
|
||||
- Target customer focus
|
||||
- Pricing strategy}}
|
||||
|
||||
### Competitive Positioning
|
||||
|
||||
{{Analyze how competitors are positioned:
|
||||
|
||||
- Value propositions
|
||||
- Differentiation strategies
|
||||
- Market gaps and opportunities}}
|
||||
|
||||
## Industry Analysis
|
||||
|
||||
### Porter's Five Forces Assessment
|
||||
|
||||
[[LLM: Analyze each force with specific evidence and implications]]
|
||||
|
||||
#### Supplier Power: {{Low/Medium/High}}
|
||||
|
||||
{{Analysis and implications}}
|
||||
|
||||
#### Buyer Power: {{Low/Medium/High}}
|
||||
|
||||
{{Analysis and implications}}
|
||||
|
||||
#### Competitive Rivalry: {{Low/Medium/High}}
|
||||
|
||||
{{Analysis and implications}}
|
||||
|
||||
#### Threat of New Entry: {{Low/Medium/High}}
|
||||
|
||||
{{Analysis and implications}}
|
||||
|
||||
#### Threat of Substitutes: {{Low/Medium/High}}
|
||||
|
||||
{{Analysis and implications}}
|
||||
|
||||
### Technology Adoption Lifecycle Stage
|
||||
|
||||
{{Identify where the market is in the adoption curve:
|
||||
|
||||
- Current stage and evidence
|
||||
- Implications for strategy
|
||||
- Expected progression timeline}}
|
||||
|
||||
## Opportunity Assessment
|
||||
|
||||
### Market Opportunities
|
||||
|
||||
[[LLM: Identify specific opportunities based on the analysis]]
|
||||
|
||||
#### Opportunity 1: {{Name}}
|
||||
|
||||
- **Description:** {{What is the opportunity?}}
|
||||
- **Size/Potential:** {{Quantify if possible}}
|
||||
- **Requirements:** {{What's needed to capture it?}}
|
||||
- **Risks:** {{Key challenges or barriers}}
|
||||
|
||||
<<REPEAT for additional opportunities>>
|
||||
|
||||
### Strategic Recommendations
|
||||
|
||||
#### Go-to-Market Strategy
|
||||
|
||||
{{Recommend approach for market entry/expansion:
|
||||
|
||||
- Target segment prioritization
|
||||
- Positioning strategy
|
||||
- Channel strategy
|
||||
- Partnership opportunities}}
|
||||
|
||||
#### Pricing Strategy
|
||||
|
||||
{{Based on willingness to pay analysis and competitive landscape:
|
||||
|
||||
- Recommended pricing model
|
||||
- Price points/ranges
|
||||
- Value metric
|
||||
- Competitive positioning}}
|
||||
|
||||
#### Risk Mitigation
|
||||
|
||||
{{Key risks and mitigation strategies:
|
||||
|
||||
- Market risks
|
||||
- Competitive risks
|
||||
- Execution risks
|
||||
- Regulatory/compliance risks}}
|
||||
|
||||
## Appendices
|
||||
|
||||
### A. Data Sources
|
||||
|
||||
{{List all sources used in the research}}
|
||||
|
||||
### B. Detailed Calculations
|
||||
|
||||
{{Include any complex calculations or models}}
|
||||
|
||||
### C. Additional Analysis
|
||||
|
||||
{{Any supplementary analysis not included in main body}}
|
||||
|
||||
---
|
||||
|
||||
[[LLM: After completing the document, offer advanced elicitation with these custom options for market research:
|
||||
|
||||
**Market Research Elicitation Actions** 0. Expand market sizing calculations with sensitivity analysis
|
||||
|
||||
1. Deep dive into a specific customer segment
|
||||
2. Analyze an emerging market trend in detail
|
||||
3. Compare this market to an analogous market
|
||||
4. Stress test market assumptions
|
||||
5. Explore adjacent market opportunities
|
||||
6. Challenge market definition and boundaries
|
||||
7. Generate strategic scenarios (best/base/worst case)
|
||||
8. If only we had considered [X market factor]...
|
||||
9. Proceed to next section
|
||||
|
||||
These replace the standard elicitation options when working on market research documents.]]
|
||||
252
bmad-core/templates/market-research-tmpl.yaml
Normal file
252
bmad-core/templates/market-research-tmpl.yaml
Normal file
@@ -0,0 +1,252 @@
|
||||
template:
|
||||
id: market-research-template-v2
|
||||
name: Market Research Report
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/market-research.md
|
||||
title: "Market Research Report: {{project_product_name}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
custom_elicitation:
|
||||
title: "Market Research Elicitation Actions"
|
||||
options:
|
||||
- "Expand market sizing calculations with sensitivity analysis"
|
||||
- "Deep dive into a specific customer segment"
|
||||
- "Analyze an emerging market trend in detail"
|
||||
- "Compare this market to an analogous market"
|
||||
- "Stress test market assumptions"
|
||||
- "Explore adjacent market opportunities"
|
||||
- "Challenge market definition and boundaries"
|
||||
- "Generate strategic scenarios (best/base/worst case)"
|
||||
- "If only we had considered [X market factor]..."
|
||||
- "Proceed to next section"
|
||||
|
||||
sections:
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
instruction: Provide a high-level overview of key findings, market opportunity assessment, and strategic recommendations. Write this section LAST after completing all other sections.
|
||||
|
||||
- id: research-objectives
|
||||
title: Research Objectives & Methodology
|
||||
instruction: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.
|
||||
sections:
|
||||
- id: objectives
|
||||
title: Research Objectives
|
||||
instruction: |
|
||||
List the primary objectives of this market research:
|
||||
- What decisions will this research inform?
|
||||
- What specific questions need to be answered?
|
||||
- What are the success criteria for this research?
|
||||
- id: methodology
|
||||
title: Research Methodology
|
||||
instruction: |
|
||||
Describe the research approach:
|
||||
- Data sources used (primary/secondary)
|
||||
- Analysis frameworks applied
|
||||
- Data collection timeframe
|
||||
- Limitations and assumptions
|
||||
|
||||
- id: market-overview
|
||||
title: Market Overview
|
||||
sections:
|
||||
- id: market-definition
|
||||
title: Market Definition
|
||||
instruction: |
|
||||
Define the market being analyzed:
|
||||
- Product/service category
|
||||
- Geographic scope
|
||||
- Customer segments included
|
||||
- Value chain position
|
||||
- id: market-size-growth
|
||||
title: Market Size & Growth
|
||||
instruction: |
|
||||
Guide through TAM, SAM, SOM calculations with clear assumptions. Use one or more approaches:
|
||||
- Top-down: Start with industry data, narrow down
|
||||
- Bottom-up: Build from customer/unit economics
|
||||
- Value theory: Based on value provided vs. alternatives
|
||||
sections:
|
||||
- id: tam
|
||||
title: Total Addressable Market (TAM)
|
||||
instruction: Calculate and explain the total market opportunity
|
||||
- id: sam
|
||||
title: Serviceable Addressable Market (SAM)
|
||||
instruction: Define the portion of TAM you can realistically reach
|
||||
- id: som
|
||||
title: Serviceable Obtainable Market (SOM)
|
||||
instruction: Estimate the portion you can realistically capture
|
||||
- id: market-trends
|
||||
title: Market Trends & Drivers
|
||||
instruction: Analyze key trends shaping the market using appropriate frameworks like PESTEL
|
||||
sections:
|
||||
- id: key-trends
|
||||
title: Key Market Trends
|
||||
instruction: |
|
||||
List and explain 3-5 major trends:
|
||||
- Trend 1: Description and impact
|
||||
- Trend 2: Description and impact
|
||||
- etc.
|
||||
- id: growth-drivers
|
||||
title: Growth Drivers
|
||||
instruction: Identify primary factors driving market growth
|
||||
- id: market-inhibitors
|
||||
title: Market Inhibitors
|
||||
instruction: Identify factors constraining market growth
|
||||
|
||||
- id: customer-analysis
|
||||
title: Customer Analysis
|
||||
sections:
|
||||
- id: segment-profiles
|
||||
title: Target Segment Profiles
|
||||
instruction: For each segment, create detailed profiles including demographics/firmographics, psychographics, behaviors, needs, and willingness to pay
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: segment
|
||||
title: "Segment {{segment_number}}: {{segment_name}}"
|
||||
template: |
|
||||
- **Description:** {{brief_overview}}
|
||||
- **Size:** {{number_of_customers_market_value}}
|
||||
- **Characteristics:** {{key_demographics_firmographics}}
|
||||
- **Needs & Pain Points:** {{primary_problems}}
|
||||
- **Buying Process:** {{purchasing_decisions}}
|
||||
- **Willingness to Pay:** {{price_sensitivity}}
|
||||
- id: jobs-to-be-done
|
||||
title: Jobs-to-be-Done Analysis
|
||||
instruction: Uncover what customers are really trying to accomplish
|
||||
sections:
|
||||
- id: functional-jobs
|
||||
title: Functional Jobs
|
||||
instruction: List practical tasks and objectives customers need to complete
|
||||
- id: emotional-jobs
|
||||
title: Emotional Jobs
|
||||
instruction: Describe feelings and perceptions customers seek
|
||||
- id: social-jobs
|
||||
title: Social Jobs
|
||||
instruction: Explain how customers want to be perceived by others
|
||||
- id: customer-journey
|
||||
title: Customer Journey Mapping
|
||||
instruction: Map the end-to-end customer experience for primary segments
|
||||
template: |
|
||||
For primary customer segment:
|
||||
|
||||
1. **Awareness:** {{discovery_process}}
|
||||
2. **Consideration:** {{evaluation_criteria}}
|
||||
3. **Purchase:** {{decision_triggers}}
|
||||
4. **Onboarding:** {{initial_expectations}}
|
||||
5. **Usage:** {{interaction_patterns}}
|
||||
6. **Advocacy:** {{referral_behaviors}}
|
||||
|
||||
- id: competitive-landscape
|
||||
title: Competitive Landscape
|
||||
sections:
|
||||
- id: market-structure
|
||||
title: Market Structure
|
||||
instruction: |
|
||||
Describe the overall competitive environment:
|
||||
- Number of competitors
|
||||
- Market concentration
|
||||
- Competitive intensity
|
||||
- id: major-players
|
||||
title: Major Players Analysis
|
||||
instruction: |
|
||||
For top 3-5 competitors:
|
||||
- Company name and brief description
|
||||
- Market share estimate
|
||||
- Key strengths and weaknesses
|
||||
- Target customer focus
|
||||
- Pricing strategy
|
||||
- id: competitive-positioning
|
||||
title: Competitive Positioning
|
||||
instruction: |
|
||||
Analyze how competitors are positioned:
|
||||
- Value propositions
|
||||
- Differentiation strategies
|
||||
- Market gaps and opportunities
|
||||
|
||||
- id: industry-analysis
|
||||
title: Industry Analysis
|
||||
sections:
|
||||
- id: porters-five-forces
|
||||
title: Porter's Five Forces Assessment
|
||||
instruction: Analyze each force with specific evidence and implications
|
||||
sections:
|
||||
- id: supplier-power
|
||||
title: "Supplier Power: {{power_level}}"
|
||||
template: "{{analysis_and_implications}}"
|
||||
- id: buyer-power
|
||||
title: "Buyer Power: {{power_level}}"
|
||||
template: "{{analysis_and_implications}}"
|
||||
- id: competitive-rivalry
|
||||
title: "Competitive Rivalry: {{intensity_level}}"
|
||||
template: "{{analysis_and_implications}}"
|
||||
- id: threat-new-entry
|
||||
title: "Threat of New Entry: {{threat_level}}"
|
||||
template: "{{analysis_and_implications}}"
|
||||
- id: threat-substitutes
|
||||
title: "Threat of Substitutes: {{threat_level}}"
|
||||
template: "{{analysis_and_implications}}"
|
||||
- id: adoption-lifecycle
|
||||
title: Technology Adoption Lifecycle Stage
|
||||
instruction: |
|
||||
Identify where the market is in the adoption curve:
|
||||
- Current stage and evidence
|
||||
- Implications for strategy
|
||||
- Expected progression timeline
|
||||
|
||||
- id: opportunity-assessment
|
||||
title: Opportunity Assessment
|
||||
sections:
|
||||
- id: market-opportunities
|
||||
title: Market Opportunities
|
||||
instruction: Identify specific opportunities based on the analysis
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: opportunity
|
||||
title: "Opportunity {{opportunity_number}}: {{name}}"
|
||||
template: |
|
||||
- **Description:** {{what_is_the_opportunity}}
|
||||
- **Size/Potential:** {{quantified_potential}}
|
||||
- **Requirements:** {{needed_to_capture}}
|
||||
- **Risks:** {{key_challenges}}
|
||||
- id: strategic-recommendations
|
||||
title: Strategic Recommendations
|
||||
sections:
|
||||
- id: go-to-market
|
||||
title: Go-to-Market Strategy
|
||||
instruction: |
|
||||
Recommend approach for market entry/expansion:
|
||||
- Target segment prioritization
|
||||
- Positioning strategy
|
||||
- Channel strategy
|
||||
- Partnership opportunities
|
||||
- id: pricing-strategy
|
||||
title: Pricing Strategy
|
||||
instruction: |
|
||||
Based on willingness to pay analysis and competitive landscape:
|
||||
- Recommended pricing model
|
||||
- Price points/ranges
|
||||
- Value metric
|
||||
- Competitive positioning
|
||||
- id: risk-mitigation
|
||||
title: Risk Mitigation
|
||||
instruction: |
|
||||
Key risks and mitigation strategies:
|
||||
- Market risks
|
||||
- Competitive risks
|
||||
- Execution risks
|
||||
- Regulatory/compliance risks
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: data-sources
|
||||
title: A. Data Sources
|
||||
instruction: List all sources used in the research
|
||||
- id: calculations
|
||||
title: B. Detailed Calculations
|
||||
instruction: Include any complex calculations or models
|
||||
- id: additional-analysis
|
||||
title: C. Additional Analysis
|
||||
instruction: Any supplementary analysis not included in main body
|
||||
@@ -1,202 +0,0 @@
|
||||
# {{Project Name}} Product Requirements Document (PRD)
|
||||
|
||||
[[LLM: The default path and filename unless specified is docs/prd.md]]
|
||||
|
||||
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
|
||||
|
||||
## Goals and Background Context
|
||||
|
||||
[[LLM: Populate the 2 child sections based on what we have received from user description or the provided brief. Allow user to review the 2 sections and offer changes before proceeding]]
|
||||
|
||||
### Goals
|
||||
|
||||
[[LLM: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires]]
|
||||
|
||||
### Background Context
|
||||
|
||||
[[LLM: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is etc...]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Requirements
|
||||
|
||||
[[LLM: Draft the list of functional and non functional requirements under the two child sections, and immediately execute tasks#advanced-elicitation display]]
|
||||
|
||||
### Functional
|
||||
|
||||
[[LLM: Each Requirement will be a bullet markdown and an identifier sequence starting with FR`.]]
|
||||
@{example: - FR6: The Todo List uses AI to detect and warn against adding potentially duplicate todo items that are worded differently.}
|
||||
|
||||
### Non Functional
|
||||
|
||||
[[LLM: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR`.]]
|
||||
@{example: - NFR1: AWS service usage **must** aim to stay within free-tier limits where feasible.}
|
||||
|
||||
^^CONDITION: has_ui^^
|
||||
|
||||
## User Interface Design Goals
|
||||
|
||||
[[LLM: Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
|
||||
|
||||
1. Pre-fill all subsections with educated guesses based on project context
|
||||
2. Present the complete rendered section to user
|
||||
3. Clearly let the user know where assumptions were made
|
||||
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
||||
5. This is NOT detailed UI spec - focus on product vision and user goals
|
||||
6. After section completion, immediately apply `tasks#advanced-elicitation` protocol]]
|
||||
|
||||
### Overall UX Vision
|
||||
|
||||
### Key Interaction Paradigms
|
||||
|
||||
### Core Screens and Views
|
||||
|
||||
[[LLM: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories]]
|
||||
|
||||
@{example}
|
||||
|
||||
- Login Screen
|
||||
- Main Dashboard
|
||||
- Item Detail Page
|
||||
- Settings Page
|
||||
@{/example}
|
||||
|
||||
### Accessibility: { None, WCAG, etc }
|
||||
|
||||
### Branding
|
||||
|
||||
[[LLM: Any known branding elements or style guides that must be incorporated?]]
|
||||
|
||||
@{example}
|
||||
|
||||
- Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions.
|
||||
- Attached is the full color pallet and tokens for our corporate branding.
|
||||
@{/example}
|
||||
|
||||
### Target Device and Platforms
|
||||
|
||||
@{example}
|
||||
"Web Responsive, and all mobile platforms", "IPhone Only", "ASCII Windows Desktop"
|
||||
@{/example}
|
||||
|
||||
^^/CONDITION: has_ui^^
|
||||
|
||||
## Technical Assumptions
|
||||
|
||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
||||
|
||||
1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
5. These become constraints for the Architect - be specific and complete
|
||||
6. After section completion, apply `tasks#advanced-elicitation` protocol.]]
|
||||
|
||||
### Repository Structure: { Monorepo, Polyrepo, etc...}
|
||||
|
||||
### Service Architecture
|
||||
|
||||
[[LLM: CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo).]]
|
||||
|
||||
### Testing requirements
|
||||
|
||||
[[LLM: CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods).]]
|
||||
|
||||
### Additional Technical Assumptions and Requests
|
||||
|
||||
[[LLM: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items]]
|
||||
|
||||
## Epics
|
||||
|
||||
[[LLM: First, present a high-level list of all epics for user approval, the epic_list and immediately execute tasks#advanced-elicitation display. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
||||
|
||||
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
||||
|
||||
- Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
|
||||
- Epic 1 must establish foundational project infrastructure (app setup, Git, CI/CD, core services) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, even as simple as a health-check route or display of a simple canary page - remember this when we produce the stories for the first epic!
|
||||
- Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
|
||||
- Not every project needs multiple epics, an epic needs to deliver value. For example, an API completed can deliver value even if a UI is not complete and planned for a separate epic.
|
||||
- Err on the side of less epics, but let the user know your rationale and offer options for splitting them if it seems some are too large or focused on disparate things.
|
||||
- Cross Cutting Concerns should flow through epics and stories and not be final stories. For example, adding a logging framework as a last story of an epic, or at the end of a project as a final epic or story would be terrible as we would not have logging from the beginning.]]
|
||||
|
||||
<<REPEAT: epic_list>>
|
||||
|
||||
- Epic{{epic_number}} {{epic_title}}: {{short_goal}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
@{example: epic_list}
|
||||
|
||||
1. Foundation & Core Infrastructure: Establish project setup, authentication, and basic user management
|
||||
2. Core Business Entities: Create and manage primary domain objects with CRUD operations
|
||||
3. User Workflows & Interactions: Enable key user journeys and business processes
|
||||
4. Reporting & Analytics: Provide insights and data visualization for users
|
||||
|
||||
@{/example}
|
||||
|
||||
[[LLM: After the epic list is approved, present each `epic_details` with all its stories and acceptance criteria as a complete review unit and immediately execute tasks#advanced-elicitation display, before moving on to the next epic.]]
|
||||
|
||||
<<REPEAT: epic_details>>
|
||||
|
||||
## Epic {{epic_number}} {{epic_title}}
|
||||
|
||||
{{epic_goal}} [[LLM: Expanded goal - 2-3 sentences describing the objective and value all the stories will achieve]]
|
||||
|
||||
[[LLM: CRITICAL STORY SEQUENCING REQUIREMENTS:
|
||||
|
||||
- Stories within each epic MUST be logically sequential
|
||||
- Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
|
||||
- No story should depend on work from a later story or epic
|
||||
- Identify and note any direct prerequisite stories
|
||||
- Focus on "what" and "why" not "how" (leave technical implementation to Architect) yet be precise enough to support a logical sequential order of operations from story to story.
|
||||
- Ensure each story delivers clear user or business value, try to avoid enablers and build them into stories that deliver value.
|
||||
- Size stories for AI agent execution: Each story must be completable by a single AI agent in one focused session without context overflow
|
||||
- Think "junior developer working for 2-4 hours" - stories must be small, focused, and self-contained
|
||||
- If a story seems complex, break it down further as long as it can deliver a vertical slice
|
||||
- Each story should result in working, testable code before the agent's context window fills]]
|
||||
|
||||
<<REPEAT: story>>
|
||||
|
||||
### Story {{epic_number}}.{{story_number}} {{story_title}}
|
||||
|
||||
As a {{user_type}},
|
||||
I want {{action}},
|
||||
so that {{benefit}}.
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
[[LLM: Define clear, comprehensive, and testable acceptance criteria that:
|
||||
|
||||
- Precisely define what "done" means from a functional perspective
|
||||
- Are unambiguous and serve as basis for verification
|
||||
- Include any critical non-functional requirements from the PRD
|
||||
- Consider local testability for backend/data components
|
||||
- Specify UI/UX requirements and framework adherence where applicable
|
||||
- Avoid cross-cutting concerns that should be in other stories or PRD sections]]
|
||||
|
||||
<<REPEAT: criteria>>
|
||||
|
||||
- {{criterion number}}: {{criteria}}
|
||||
|
||||
<</REPEAT>>
|
||||
<</REPEAT>>
|
||||
<</REPEAT>>
|
||||
|
||||
## Checklist Results Report
|
||||
|
||||
[[LLM: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the `pm-checklist` and populate the results in this section.]]
|
||||
|
||||
## Next Steps
|
||||
|
||||
### Design Architect Prompt
|
||||
|
||||
[[LLM: This section will contain the prompt for the Design Architect, keep it short and to the point to initiate create architecture mode using this document as input.]]
|
||||
|
||||
### Architect Prompt
|
||||
|
||||
[[LLM: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.]]
|
||||
202
bmad-core/templates/prd-tmpl.yaml
Normal file
202
bmad-core/templates/prd-tmpl.yaml
Normal file
@@ -0,0 +1,202 @@
|
||||
template:
|
||||
id: prd-template-v2
|
||||
name: Product Requirements Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/prd.md
|
||||
title: "{{project_name}} Product Requirements Document (PRD)"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: goals-context
|
||||
title: Goals and Background Context
|
||||
instruction: |
|
||||
Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on PRD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired outcomes) and Background Context (1-2 paragraphs on what this solves and why) so we can determine what is and is not in scope for PRD mvp. Either way this is critical to determine the requirements. Include Change Log table.
|
||||
sections:
|
||||
- id: goals
|
||||
title: Goals
|
||||
type: bullet-list
|
||||
instruction: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires
|
||||
- id: background
|
||||
title: Background Context
|
||||
type: paragraphs
|
||||
instruction: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is
|
||||
- id: changelog
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track document versions and changes
|
||||
|
||||
- id: requirements
|
||||
title: Requirements
|
||||
instruction: Draft the list of functional and non functional requirements under the two child sections
|
||||
elicit: true
|
||||
sections:
|
||||
- id: functional
|
||||
title: Functional
|
||||
type: numbered-list
|
||||
prefix: FR
|
||||
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with FR
|
||||
examples:
|
||||
- "FR6: The Todo List uses AI to detect and warn against potentially duplicate todo items that are worded differently."
|
||||
- id: non-functional
|
||||
title: Non Functional
|
||||
type: numbered-list
|
||||
prefix: NFR
|
||||
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR
|
||||
examples:
|
||||
- "NFR1: AWS service usage must aim to stay within free-tier limits where feasible."
|
||||
|
||||
- id: ui-goals
|
||||
title: User Interface Design Goals
|
||||
condition: PRD has UX/UI requirements
|
||||
instruction: |
|
||||
Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
|
||||
|
||||
1. Pre-fill all subsections with educated guesses based on project context
|
||||
2. Present the complete rendered section to user
|
||||
3. Clearly let the user know where assumptions were made
|
||||
4. Ask targeted questions for unclear/missing elements or areas needing more specification
|
||||
5. This is NOT detailed UI spec - focus on product vision and user goals
|
||||
elicit: true
|
||||
choices:
|
||||
accessibility: [None, WCAG AA, WCAG AAA]
|
||||
platforms: [Web Responsive, Mobile Only, Desktop Only, Cross-Platform]
|
||||
sections:
|
||||
- id: ux-vision
|
||||
title: Overall UX Vision
|
||||
- id: interaction-paradigms
|
||||
title: Key Interaction Paradigms
|
||||
- id: core-screens
|
||||
title: Core Screens and Views
|
||||
instruction: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories
|
||||
examples:
|
||||
- "Login Screen"
|
||||
- "Main Dashboard"
|
||||
- "Item Detail Page"
|
||||
- "Settings Page"
|
||||
- id: accessibility
|
||||
title: "Accessibility: {None|WCAG AA|WCAG AAA|Custom Requirements}"
|
||||
- id: branding
|
||||
title: Branding
|
||||
instruction: Any known branding elements or style guides that must be incorporated?
|
||||
examples:
|
||||
- "Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions."
|
||||
- "Attached is the full color pallet and tokens for our corporate branding."
|
||||
- id: target-platforms
|
||||
title: "Target Device and Platforms: {Web Responsive|Mobile Only|Desktop Only|Cross-Platform}"
|
||||
examples:
|
||||
- "Web Responsive, and all mobile platforms"
|
||||
- "iPhone Only"
|
||||
- "ASCII Windows Desktop"
|
||||
|
||||
- id: technical-assumptions
|
||||
title: Technical Assumptions
|
||||
instruction: |
|
||||
Gather technical decisions that will guide the Architect. Steps:
|
||||
|
||||
1. Check if {root}/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
|
||||
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
||||
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||
5. These become constraints for the Architect - be specific and complete
|
||||
elicit: true
|
||||
choices:
|
||||
repository: [Monorepo, Polyrepo]
|
||||
architecture: [Monolith, Microservices, Serverless]
|
||||
testing: [Unit Only, Unit + Integration, Full Testing Pyramid]
|
||||
sections:
|
||||
- id: repository-structure
|
||||
title: "Repository Structure: {Monorepo|Polyrepo|Multi-repo}"
|
||||
- id: service-architecture
|
||||
title: Service Architecture
|
||||
instruction: "CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo)."
|
||||
- id: testing-requirements
|
||||
title: Testing Requirements
|
||||
instruction: "CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods)."
|
||||
- id: additional-assumptions
|
||||
title: Additional Technical Assumptions and Requests
|
||||
instruction: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items
|
||||
|
||||
- id: epic-list
|
||||
title: Epic List
|
||||
instruction: |
|
||||
Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
||||
|
||||
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
||||
|
||||
- Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
|
||||
- Epic 1 must establish foundational project infrastructure (app setup, Git, CI/CD, core services) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, even as simple as a health-check route or display of a simple canary page - remember this when we produce the stories for the first epic!
|
||||
- Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
|
||||
- Not every project needs multiple epics, an epic needs to deliver value. For example, an API completed can deliver value even if a UI is not complete and planned for a separate epic.
|
||||
- Err on the side of less epics, but let the user know your rationale and offer options for splitting them if it seems some are too large or focused on disparate things.
|
||||
- Cross Cutting Concerns should flow through epics and stories and not be final stories. For example, adding a logging framework as a last story of an epic, or at the end of a project as a final epic or story would be terrible as we would not have logging from the beginning.
|
||||
elicit: true
|
||||
examples:
|
||||
- "Epic 1: Foundation & Core Infrastructure: Establish project setup, authentication, and basic user management"
|
||||
- "Epic 2: Core Business Entities: Create and manage primary domain objects with CRUD operations"
|
||||
- "Epic 3: User Workflows & Interactions: Enable key user journeys and business processes"
|
||||
- "Epic 4: Reporting & Analytics: Provide insights and data visualization for users"
|
||||
|
||||
- id: epic-details
|
||||
title: Epic {{epic_number}} {{epic_title}}
|
||||
repeatable: true
|
||||
instruction: |
|
||||
After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
|
||||
|
||||
For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
|
||||
|
||||
CRITICAL STORY SEQUENCING REQUIREMENTS:
|
||||
|
||||
- Stories within each epic MUST be logically sequential
|
||||
- Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
|
||||
- No story should depend on work from a later story or epic
|
||||
- Identify and note any direct prerequisite stories
|
||||
- Focus on "what" and "why" not "how" (leave technical implementation to Architect) yet be precise enough to support a logical sequential order of operations from story to story.
|
||||
- Ensure each story delivers clear user or business value, try to avoid enablers and build them into stories that deliver value.
|
||||
- Size stories for AI agent execution: Each story must be completable by a single AI agent in one focused session without context overflow
|
||||
- Think "junior developer working for 2-4 hours" - stories must be small, focused, and self-contained
|
||||
- If a story seems complex, break it down further as long as it can deliver a vertical slice
|
||||
elicit: true
|
||||
template: "{{epic_goal}}"
|
||||
sections:
|
||||
- id: story
|
||||
title: Story {{epic_number}}.{{story_number}} {{story_title}}
|
||||
repeatable: true
|
||||
template: |
|
||||
As a {{user_type}},
|
||||
I want {{action}},
|
||||
so that {{benefit}}.
|
||||
sections:
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
item_template: "{{criterion_number}}: {{criteria}}"
|
||||
repeatable: true
|
||||
instruction: |
|
||||
Define clear, comprehensive, and testable acceptance criteria that:
|
||||
|
||||
- Precisely define what "done" means from a functional perspective
|
||||
- Are unambiguous and serve as basis for verification
|
||||
- Include any critical non-functional requirements from the PRD
|
||||
- Consider local testability for backend/data components
|
||||
- Specify UI/UX requirements and framework adherence where applicable
|
||||
- Avoid cross-cutting concerns that should be in other stories or PRD sections
|
||||
|
||||
- id: checklist-results
|
||||
title: Checklist Results Report
|
||||
instruction: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the pm-checklist and populate the results in this section.
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
sections:
|
||||
- id: ux-expert-prompt
|
||||
title: UX Expert Prompt
|
||||
instruction: This section will contain the prompt for the UX Expert, keep it short and to the point to initiate create architecture mode using this document as input.
|
||||
- id: architect-prompt
|
||||
title: Architect Prompt
|
||||
instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.
|
||||
@@ -1,232 +0,0 @@
|
||||
---
|
||||
defaultOutput: docs/brief.md
|
||||
---
|
||||
|
||||
# Project Brief: {{Project Name}}
|
||||
|
||||
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
||||
|
||||
Start by asking the user which mode they prefer:
|
||||
|
||||
1. **Interactive Mode** - Work through each section collaboratively
|
||||
2. **YOLO Mode** - Generate complete draft for review and refinement
|
||||
|
||||
Before beginning, understand what inputs are available (brainstorming results, market research, competitive analysis, initial ideas) and gather project context.]]
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[[LLM: Create a concise overview that captures the essence of the project. Include:
|
||||
|
||||
- Product concept in 1-2 sentences
|
||||
- Primary problem being solved
|
||||
- Target market identification
|
||||
- Key value proposition]]
|
||||
|
||||
{{Write executive summary based on information gathered}}
|
||||
|
||||
## Problem Statement
|
||||
|
||||
[[LLM: Articulate the problem with clarity and evidence. Address:
|
||||
|
||||
- Current state and pain points
|
||||
- Impact of the problem (quantify if possible)
|
||||
- Why existing solutions fall short
|
||||
- Urgency and importance of solving this now]]
|
||||
|
||||
{{Detailed problem description with supporting evidence}}
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
[[LLM: Describe the solution approach at a high level. Include:
|
||||
|
||||
- Core concept and approach
|
||||
- Key differentiators from existing solutions
|
||||
- Why this solution will succeed where others haven't
|
||||
- High-level vision for the product]]
|
||||
|
||||
{{Solution description focusing on the "what" and "why", not implementation details}}
|
||||
|
||||
## Target Users
|
||||
|
||||
[[LLM: Define and characterize the intended users with specificity. For each user segment include:
|
||||
|
||||
- Demographic/firmographic profile
|
||||
- Current behaviors and workflows
|
||||
- Specific needs and pain points
|
||||
- Goals they're trying to achieve]]
|
||||
|
||||
### Primary User Segment: {{Segment Name}}
|
||||
|
||||
{{Detailed description of primary users}}
|
||||
|
||||
### Secondary User Segment: {{Segment Name}}
|
||||
|
||||
{{Description of secondary users if applicable}}
|
||||
|
||||
## Goals & Success Metrics
|
||||
|
||||
[[LLM: Establish clear objectives and how to measure success. Make goals SMART (Specific, Measurable, Achievable, Relevant, Time-bound)]]
|
||||
|
||||
### Business Objectives
|
||||
|
||||
- {{Objective 1 with metric}}
|
||||
- {{Objective 2 with metric}}
|
||||
- {{Objective 3 with metric}}
|
||||
|
||||
### User Success Metrics
|
||||
|
||||
- {{How users will measure value}}
|
||||
- {{Engagement metrics}}
|
||||
- {{Satisfaction indicators}}
|
||||
|
||||
### Key Performance Indicators (KPIs)
|
||||
|
||||
- {{KPI 1: Definition and target}}
|
||||
- {{KPI 2: Definition and target}}
|
||||
- {{KPI 3: Definition and target}}
|
||||
|
||||
## MVP Scope
|
||||
|
||||
[[LLM: Define the minimum viable product clearly. Be specific about what's in and what's out. Help user distinguish must-haves from nice-to-haves.]]
|
||||
|
||||
### Core Features (Must Have)
|
||||
|
||||
- **Feature 1:** {{Brief description and why it's essential}}
|
||||
- **Feature 2:** {{Brief description and why it's essential}}
|
||||
- **Feature 3:** {{Brief description and why it's essential}}
|
||||
|
||||
### Out of Scope for MVP
|
||||
|
||||
- {{Feature/capability explicitly not in MVP}}
|
||||
- {{Feature/capability to be considered post-MVP}}
|
||||
|
||||
### MVP Success Criteria
|
||||
|
||||
{{Define what constitutes a successful MVP launch}}
|
||||
|
||||
## Post-MVP Vision
|
||||
|
||||
[[LLM: Outline the longer-term product direction without overcommitting to specifics]]
|
||||
|
||||
### Phase 2 Features
|
||||
|
||||
{{Next priority features after MVP success}}
|
||||
|
||||
### Long-term Vision
|
||||
|
||||
{{Where this product could go in 1-2 years}}
|
||||
|
||||
### Expansion Opportunities
|
||||
|
||||
{{Potential new markets, use cases, or integrations}}
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
[[LLM: Document known technical constraints and preferences. Note these are initial thoughts, not final decisions.]]
|
||||
|
||||
### Platform Requirements
|
||||
|
||||
- **Target Platforms:** {{Web, mobile, desktop, etc.}}
|
||||
- **Browser/OS Support:** {{Specific requirements}}
|
||||
- **Performance Requirements:** {{Load times, concurrent users, etc.}}
|
||||
|
||||
### Technology Preferences
|
||||
|
||||
- **Frontend:** {{If any preferences exist}}
|
||||
- **Backend:** {{If any preferences exist}}
|
||||
- **Database:** {{If any preferences exist}}
|
||||
- **Hosting/Infrastructure:** {{Cloud preferences, on-prem requirements}}
|
||||
|
||||
### Architecture Considerations
|
||||
|
||||
- **Repository Structure:** {{Initial thoughts on monorepo vs. polyrepo}}
|
||||
- **Service Architecture:** {{Initial thoughts on monolith vs. microservices}}
|
||||
- **Integration Requirements:** {{Third-party services, APIs}}
|
||||
- **Security/Compliance:** {{Any specific requirements}}
|
||||
|
||||
## Constraints & Assumptions
|
||||
|
||||
[[LLM: Clearly state limitations and assumptions to set realistic expectations]]
|
||||
|
||||
### Constraints
|
||||
|
||||
- **Budget:** {{If known}}
|
||||
- **Timeline:** {{Target launch date or development timeframe}}
|
||||
- **Resources:** {{Team size, skill constraints}}
|
||||
- **Technical:** {{Legacy systems, required tech stack}}
|
||||
|
||||
### Key Assumptions
|
||||
|
||||
- {{Assumption about users, market, or technology}}
|
||||
- {{Assumption about resources or support}}
|
||||
- {{Assumption about external dependencies}}
|
||||
|
||||
## Risks & Open Questions
|
||||
|
||||
[[LLM: Identify unknowns and potential challenges proactively]]
|
||||
|
||||
### Key Risks
|
||||
|
||||
- **Risk 1:** {{Description and potential impact}}
|
||||
- **Risk 2:** {{Description and potential impact}}
|
||||
- **Risk 3:** {{Description and potential impact}}
|
||||
|
||||
### Open Questions
|
||||
|
||||
- {{Question needing research or decision}}
|
||||
- {{Question about technical approach}}
|
||||
- {{Question about market or users}}
|
||||
|
||||
### Areas Needing Further Research
|
||||
|
||||
- {{Topic requiring deeper investigation}}
|
||||
- {{Validation needed before proceeding}}
|
||||
|
||||
## Appendices
|
||||
|
||||
### A. Research Summary
|
||||
|
||||
{{If applicable, summarize key findings from:
|
||||
|
||||
- Market research
|
||||
- Competitive analysis
|
||||
- User interviews
|
||||
- Technical feasibility studies}}
|
||||
|
||||
### B. Stakeholder Input
|
||||
|
||||
{{Key feedback or requirements from stakeholders}}
|
||||
|
||||
### C. References
|
||||
|
||||
{{Links to relevant documents, research, or examples}}
|
||||
|
||||
## Next Steps
|
||||
|
||||
### Immediate Actions
|
||||
|
||||
1. {{First concrete next step}}
|
||||
2. {{Second concrete next step}}
|
||||
3. {{Third concrete next step}}
|
||||
|
||||
### PM Handoff
|
||||
|
||||
This Project Brief provides the full context for {{Project Name}}. Please start in 'PRD Generation Mode', review the brief thoroughly to work with the user to create the PRD section by section as the template indicates, asking for any necessary clarification or suggesting improvements.
|
||||
|
||||
---
|
||||
|
||||
[[LLM: After completing each major section (not subsections), offer advanced elicitation with these custom options for project briefs:
|
||||
|
||||
**Project Brief Elicitation Actions** 0. Expand section with more specific details
|
||||
|
||||
1. Validate against similar successful products
|
||||
2. Stress test assumptions with edge cases
|
||||
3. Explore alternative solution approaches
|
||||
4. Analyze resource/constraint trade-offs
|
||||
5. Generate risk mitigation strategies
|
||||
6. Challenge scope from MVP minimalist view
|
||||
7. Brainstorm creative feature possibilities
|
||||
8. If only we had [resource/capability/time]...
|
||||
9. Proceed to next section
|
||||
|
||||
These replace the standard elicitation options when working on project brief documents.]]
|
||||
221
bmad-core/templates/project-brief-tmpl.yaml
Normal file
221
bmad-core/templates/project-brief-tmpl.yaml
Normal file
@@ -0,0 +1,221 @@
|
||||
template:
|
||||
id: project-brief-template-v2
|
||||
name: Project Brief
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/brief.md
|
||||
title: "Project Brief: {{project_name}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
custom_elicitation:
|
||||
title: "Project Brief Elicitation Actions"
|
||||
options:
|
||||
- "Expand section with more specific details"
|
||||
- "Validate against similar successful products"
|
||||
- "Stress test assumptions with edge cases"
|
||||
- "Explore alternative solution approaches"
|
||||
- "Analyze resource/constraint trade-offs"
|
||||
- "Generate risk mitigation strategies"
|
||||
- "Challenge scope from MVP minimalist view"
|
||||
- "Brainstorm creative feature possibilities"
|
||||
- "If only we had [resource/capability/time]..."
|
||||
- "Proceed to next section"
|
||||
|
||||
sections:
|
||||
- id: introduction
|
||||
instruction: |
|
||||
This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
||||
|
||||
Start by asking the user which mode they prefer:
|
||||
|
||||
1. **Interactive Mode** - Work through each section collaboratively
|
||||
2. **YOLO Mode** - Generate complete draft for review and refinement
|
||||
|
||||
Before beginning, understand what inputs are available (brainstorming results, market research, competitive analysis, initial ideas) and gather project context.
|
||||
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
instruction: |
|
||||
Create a concise overview that captures the essence of the project. Include:
|
||||
- Product concept in 1-2 sentences
|
||||
- Primary problem being solved
|
||||
- Target market identification
|
||||
- Key value proposition
|
||||
template: "{{executive_summary_content}}"
|
||||
|
||||
- id: problem-statement
|
||||
title: Problem Statement
|
||||
instruction: |
|
||||
Articulate the problem with clarity and evidence. Address:
|
||||
- Current state and pain points
|
||||
- Impact of the problem (quantify if possible)
|
||||
- Why existing solutions fall short
|
||||
- Urgency and importance of solving this now
|
||||
template: "{{detailed_problem_description}}"
|
||||
|
||||
- id: proposed-solution
|
||||
title: Proposed Solution
|
||||
instruction: |
|
||||
Describe the solution approach at a high level. Include:
|
||||
- Core concept and approach
|
||||
- Key differentiators from existing solutions
|
||||
- Why this solution will succeed where others haven't
|
||||
- High-level vision for the product
|
||||
template: "{{solution_description}}"
|
||||
|
||||
- id: target-users
|
||||
title: Target Users
|
||||
instruction: |
|
||||
Define and characterize the intended users with specificity. For each user segment include:
|
||||
- Demographic/firmographic profile
|
||||
- Current behaviors and workflows
|
||||
- Specific needs and pain points
|
||||
- Goals they're trying to achieve
|
||||
sections:
|
||||
- id: primary-segment
|
||||
title: "Primary User Segment: {{segment_name}}"
|
||||
template: "{{primary_user_description}}"
|
||||
- id: secondary-segment
|
||||
title: "Secondary User Segment: {{segment_name}}"
|
||||
condition: Has secondary user segment
|
||||
template: "{{secondary_user_description}}"
|
||||
|
||||
- id: goals-metrics
|
||||
title: Goals & Success Metrics
|
||||
instruction: Establish clear objectives and how to measure success. Make goals SMART (Specific, Measurable, Achievable, Relevant, Time-bound)
|
||||
sections:
|
||||
- id: business-objectives
|
||||
title: Business Objectives
|
||||
type: bullet-list
|
||||
template: "- {{objective_with_metric}}"
|
||||
- id: user-success-metrics
|
||||
title: User Success Metrics
|
||||
type: bullet-list
|
||||
template: "- {{user_metric}}"
|
||||
- id: kpis
|
||||
title: Key Performance Indicators (KPIs)
|
||||
type: bullet-list
|
||||
template: "- {{kpi}}: {{definition_and_target}}"
|
||||
|
||||
- id: mvp-scope
|
||||
title: MVP Scope
|
||||
instruction: Define the minimum viable product clearly. Be specific about what's in and what's out. Help user distinguish must-haves from nice-to-haves.
|
||||
sections:
|
||||
- id: core-features
|
||||
title: Core Features (Must Have)
|
||||
type: bullet-list
|
||||
template: "- **{{feature}}:** {{description_and_rationale}}"
|
||||
- id: out-of-scope
|
||||
title: Out of Scope for MVP
|
||||
type: bullet-list
|
||||
template: "- {{feature_or_capability}}"
|
||||
- id: mvp-success-criteria
|
||||
title: MVP Success Criteria
|
||||
template: "{{mvp_success_definition}}"
|
||||
|
||||
- id: post-mvp-vision
|
||||
title: Post-MVP Vision
|
||||
instruction: Outline the longer-term product direction without overcommitting to specifics
|
||||
sections:
|
||||
- id: phase-2-features
|
||||
title: Phase 2 Features
|
||||
template: "{{next_priority_features}}"
|
||||
- id: long-term-vision
|
||||
title: Long-term Vision
|
||||
template: "{{one_two_year_vision}}"
|
||||
- id: expansion-opportunities
|
||||
title: Expansion Opportunities
|
||||
template: "{{potential_expansions}}"
|
||||
|
||||
- id: technical-considerations
|
||||
title: Technical Considerations
|
||||
instruction: Document known technical constraints and preferences. Note these are initial thoughts, not final decisions.
|
||||
sections:
|
||||
- id: platform-requirements
|
||||
title: Platform Requirements
|
||||
template: |
|
||||
- **Target Platforms:** {{platforms}}
|
||||
- **Browser/OS Support:** {{specific_requirements}}
|
||||
- **Performance Requirements:** {{performance_specs}}
|
||||
- id: technology-preferences
|
||||
title: Technology Preferences
|
||||
template: |
|
||||
- **Frontend:** {{frontend_preferences}}
|
||||
- **Backend:** {{backend_preferences}}
|
||||
- **Database:** {{database_preferences}}
|
||||
- **Hosting/Infrastructure:** {{infrastructure_preferences}}
|
||||
- id: architecture-considerations
|
||||
title: Architecture Considerations
|
||||
template: |
|
||||
- **Repository Structure:** {{repo_thoughts}}
|
||||
- **Service Architecture:** {{service_thoughts}}
|
||||
- **Integration Requirements:** {{integration_needs}}
|
||||
- **Security/Compliance:** {{security_requirements}}
|
||||
|
||||
- id: constraints-assumptions
|
||||
title: Constraints & Assumptions
|
||||
instruction: Clearly state limitations and assumptions to set realistic expectations
|
||||
sections:
|
||||
- id: constraints
|
||||
title: Constraints
|
||||
template: |
|
||||
- **Budget:** {{budget_info}}
|
||||
- **Timeline:** {{timeline_info}}
|
||||
- **Resources:** {{resource_info}}
|
||||
- **Technical:** {{technical_constraints}}
|
||||
- id: key-assumptions
|
||||
title: Key Assumptions
|
||||
type: bullet-list
|
||||
template: "- {{assumption}}"
|
||||
|
||||
- id: risks-questions
|
||||
title: Risks & Open Questions
|
||||
instruction: Identify unknowns and potential challenges proactively
|
||||
sections:
|
||||
- id: key-risks
|
||||
title: Key Risks
|
||||
type: bullet-list
|
||||
template: "- **{{risk}}:** {{description_and_impact}}"
|
||||
- id: open-questions
|
||||
title: Open Questions
|
||||
type: bullet-list
|
||||
template: "- {{question}}"
|
||||
- id: research-areas
|
||||
title: Areas Needing Further Research
|
||||
type: bullet-list
|
||||
template: "- {{research_topic}}"
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: research-summary
|
||||
title: A. Research Summary
|
||||
condition: Has research findings
|
||||
instruction: |
|
||||
If applicable, summarize key findings from:
|
||||
- Market research
|
||||
- Competitive analysis
|
||||
- User interviews
|
||||
- Technical feasibility studies
|
||||
- id: stakeholder-input
|
||||
title: B. Stakeholder Input
|
||||
condition: Has stakeholder feedback
|
||||
template: "{{stakeholder_feedback}}"
|
||||
- id: references
|
||||
title: C. References
|
||||
template: "{{relevant_links_and_docs}}"
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
sections:
|
||||
- id: immediate-actions
|
||||
title: Immediate Actions
|
||||
type: numbered-list
|
||||
template: "{{action_item}}"
|
||||
- id: pm-handoff
|
||||
title: PM Handoff
|
||||
content: |
|
||||
This Project Brief provides the full context for {{project_name}}. Please start in 'PRD Generation Mode', review the brief thoroughly to work with the user to create the PRD section by section as the template indicates, asking for any necessary clarification or suggesting improvements.
|
||||
@@ -1,58 +0,0 @@
|
||||
---
|
||||
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
||||
smAgent:
|
||||
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
||||
sectionSpecificInstructions:
|
||||
"Dev Notes":
|
||||
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
||||
- Do not invent information.
|
||||
- If known add Relevant Source Tree info that relates to this story.
|
||||
- If there were important notes from previous story that are relevant to this one, include them here.
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks.
|
||||
Testing:
|
||||
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
||||
---
|
||||
|
||||
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
||||
|
||||
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
||||
|
||||
## Story
|
||||
|
||||
**As a** {{role}},\
|
||||
**I want** {{action}},\
|
||||
**so that** {{benefit}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
{{ Copy of Acceptance Criteria numbered list }}
|
||||
|
||||
## Tasks / Subtasks
|
||||
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
|
||||
## Dev Notes
|
||||
|
||||
### Testing
|
||||
|
||||
## Change Log
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Dev Agent Record
|
||||
|
||||
### Agent Model Used: {{Agent Model Name/Version}}
|
||||
|
||||
### Debug Log References
|
||||
|
||||
### Completion Notes List
|
||||
|
||||
### File List
|
||||
|
||||
## QA Results
|
||||
137
bmad-core/templates/story-tmpl.yaml
Normal file
137
bmad-core/templates/story-tmpl.yaml
Normal file
@@ -0,0 +1,137 @@
|
||||
template:
|
||||
id: story-template-v2
|
||||
name: Story Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
agent_config:
|
||||
editable_sections:
|
||||
- Status
|
||||
- Story
|
||||
- Acceptance Criteria
|
||||
- Tasks / Subtasks
|
||||
- Dev Notes
|
||||
- Testing
|
||||
- Change Log
|
||||
|
||||
sections:
|
||||
- id: status
|
||||
title: Status
|
||||
type: choice
|
||||
choices: [Draft, Approved, InProgress, Review, Done]
|
||||
instruction: Select the current status of the story
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: story
|
||||
title: Story
|
||||
type: template-text
|
||||
template: |
|
||||
**As a** {{role}},
|
||||
**I want** {{action}},
|
||||
**so that** {{benefit}}
|
||||
instruction: Define the user story using the standard format with role, action, and benefit
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
instruction: Copy the acceptance criteria numbered list from the epic file
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: tasks-subtasks
|
||||
title: Tasks / Subtasks
|
||||
type: bullet-list
|
||||
instruction: |
|
||||
Break down the story into specific tasks and subtasks needed for implementation.
|
||||
Reference applicable acceptance criteria numbers where relevant.
|
||||
template: |
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: dev-notes
|
||||
title: Dev Notes
|
||||
instruction: |
|
||||
Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
|
||||
- Do not invent information
|
||||
- If known add Relevant Source Tree info that relates to this story
|
||||
- If there were important notes from previous story that are relevant to this one, include them here
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
sections:
|
||||
- id: testing-standards
|
||||
title: Testing
|
||||
instruction: |
|
||||
List Relevant Testing Standards from Architecture the Developer needs to conform to:
|
||||
- Test file location
|
||||
- Test standards
|
||||
- Testing frameworks and patterns to use
|
||||
- Any specific testing requirements for this story
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track changes made to this story document
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent, qa-agent]
|
||||
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
instruction: This section is populated by the development agent during implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: debug-log-references
|
||||
title: Debug Log References
|
||||
instruction: Reference any debug logs or traces generated during development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: completion-notes
|
||||
title: Completion Notes List
|
||||
instruction: Notes about the completion of tasks and any issues encountered
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: file-list
|
||||
title: File List
|
||||
instruction: List all files created, modified, or affected during story implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: qa-results
|
||||
title: QA Results
|
||||
instruction: Results from QA Agent QA review of the completed story implementation
|
||||
owner: qa-agent
|
||||
editors: [qa-agent]
|
||||
@@ -8,14 +8,10 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
||||
|
||||
### 1. Check Plan Existence
|
||||
|
||||
[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
|
||||
|
||||
```
|
||||
Check for workflow plan:
|
||||
|
||||
1. Look for docs/workflow-plan.md (default location)
|
||||
2. Check core-config.yaml for custom plan location
|
||||
3. Return plan status (exists/not exists)
|
||||
```
|
||||
2. Return plan status to user (exists/not exists) - if not exists then HALT.
|
||||
|
||||
### 2. Parse Plan Status
|
||||
|
||||
@@ -56,7 +52,7 @@ Check for workflow plan:
|
||||
|
||||
**Warning Templates:**
|
||||
|
||||
```
|
||||
```text
|
||||
SEQUENCE WARNING:
|
||||
The workflow plan shows you should complete "{expected_step}" next.
|
||||
You're attempting to: "{requested_action}"
|
||||
@@ -90,7 +86,7 @@ In flexible mode: Allow with confirmation
|
||||
|
||||
**For Agents (startup sequence)**:
|
||||
|
||||
```
|
||||
```text
|
||||
1. Check if plan exists using this utility
|
||||
2. If exists:
|
||||
- Parse current status
|
||||
@@ -101,7 +97,7 @@ In flexible mode: Allow with confirmation
|
||||
|
||||
**For Tasks (pre-execution)**:
|
||||
|
||||
```
|
||||
```text
|
||||
1. Check if plan exists
|
||||
2. If exists:
|
||||
- Verify this task aligns with plan
|
||||
@@ -117,7 +113,7 @@ In flexible mode: Allow with confirmation
|
||||
|
||||
[[LLM: Standard format for showing plan status]]
|
||||
|
||||
```
|
||||
```text
|
||||
📋 Workflow Plan Status
|
||||
━━━━━━━━━━━━━━━━━━━━
|
||||
Workflow: {workflow_name}
|
||||
@@ -170,7 +166,7 @@ If user wants to abandon plan:
|
||||
|
||||
### Example 1: Agent Startup Check
|
||||
|
||||
```
|
||||
```text
|
||||
BMad Master starting...
|
||||
|
||||
[Check for plan]
|
||||
@@ -184,7 +180,7 @@ Use *agent pm to switch, or *plan-status to see full progress.
|
||||
|
||||
### Example 2: Task Sequence Warning
|
||||
|
||||
```
|
||||
```text
|
||||
User: *task create-next-story
|
||||
|
||||
[Plan check triggered]
|
||||
@@ -200,7 +196,7 @@ Would you like to:
|
||||
|
||||
### Example 3: Automatic Plan Update
|
||||
|
||||
```
|
||||
```text
|
||||
[After completing create-doc task for PRD]
|
||||
|
||||
✅ Plan Updated: Marked "Create PRD" as complete
|
||||
|
||||
@@ -136,7 +136,7 @@ workflow:
|
||||
All stories implemented and reviewed!
|
||||
Service development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
Reference: {root}/data/bmad-kb.md#IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
|
||||
@@ -1,91 +1,79 @@
|
||||
# Create Document from Template Task
|
||||
# Create Document from Template (YAML Driven)
|
||||
|
||||
## Purpose
|
||||
## CRITICAL: Mandatory Elicitation Format
|
||||
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
**When `elicit: true`, ALWAYS use this exact format:**
|
||||
|
||||
## CRITICAL RULES
|
||||
1. Present section content
|
||||
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
|
||||
3. Present numbered options 1-9:
|
||||
- **Option 1:** Always "Proceed to next section"
|
||||
- **Options 2-9:** Select 8 methods from data/elicitation-methods
|
||||
- End with: "Select 1-9 or just type your question/feedback:"
|
||||
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
**NEVER ask yes/no questions or use any other format.**
|
||||
|
||||
## Execution Flow
|
||||
## Processing Flow
|
||||
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
1. **Parse YAML template** - Load template metadata and sections
|
||||
2. **Set preferences** - Show current mode (Interactive), confirm output file
|
||||
3. **Process each section:**
|
||||
- Skip if condition unmet
|
||||
- Check agent permissions (owner/editors) - note if section is restricted to specific agents
|
||||
- Draft content using section instruction
|
||||
- Present content + detailed rationale
|
||||
- **IF elicit: true** → MANDATORY 1-9 options format
|
||||
- Save to file if possible
|
||||
4. **Continue until complete**
|
||||
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
||||
## Detailed Rationale Requirements
|
||||
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
When presenting section content, ALWAYS include rationale that explains:
|
||||
|
||||
### 1. Identify Template
|
||||
- Trade-offs and choices made (what was chosen over alternatives and why)
|
||||
- Key assumptions made during drafting
|
||||
- Interesting or questionable decisions that need user attention
|
||||
- Areas that might need validation
|
||||
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
## Elicitation Results Flow
|
||||
|
||||
### 2. Ask Interaction Mode
|
||||
After user selects elicitation method (2-9):
|
||||
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
1. Execute method from data/elicitation-methods
|
||||
2. Present results with insights
|
||||
3. Offer options:
|
||||
- **1. Apply changes and update section**
|
||||
- **2. Return to elicitation menu**
|
||||
- **3. Ask any questions or engage further with this elicitation**
|
||||
|
||||
### 3. Execute Template
|
||||
## Agent Permissions
|
||||
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
When processing sections with agent permission fields:
|
||||
|
||||
### 4. Key Execution Patterns
|
||||
- **owner**: Note which agent role initially creates/populates the section
|
||||
- **editors**: List agent roles allowed to modify the section
|
||||
- **readonly**: Mark sections that cannot be modified after creation
|
||||
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
**For sections with restricted access:**
|
||||
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
- Include a note in the generated document indicating the responsible agent
|
||||
- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
|
||||
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
## YOLO Mode
|
||||
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
||||
|
||||
### 5. Validation & Final Presentation
|
||||
## CRITICAL REMINDERS
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
**❌ NEVER:**
|
||||
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
- Ask yes/no questions for elicitation
|
||||
- Use any format other than 1-9 numbered options
|
||||
- Create new elicitation methods
|
||||
|
||||
[[LLM: After successful document creation]]
|
||||
**✅ ALWAYS:**
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
- Use exact 1-9 format when elicit: true
|
||||
- Select options 2-9 from data/elicitation-methods only
|
||||
- Provide detailed rationale explaining decisions
|
||||
- End with "Select 1-9 or just type your question/feedback:"
|
||||
|
||||
325
common/utils/bmad-doc-template.md
Normal file
325
common/utils/bmad-doc-template.md
Normal file
@@ -0,0 +1,325 @@
|
||||
# BMad Document Template Specification
|
||||
|
||||
## Overview
|
||||
|
||||
BMad document templates are defined in YAML format to drive interactive document generation and agent interaction. Templates separate structure definition from content generation, making them both human and LLM-agent-friendly.
|
||||
|
||||
## Template Structure
|
||||
|
||||
```yaml
|
||||
template:
|
||||
id: template-identifier
|
||||
name: Human Readable Template Name
|
||||
version: 1.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: default-path/to/{{filename}}.md
|
||||
title: "{{variable}} Document Title"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
sections:
|
||||
- id: section-id
|
||||
title: Section Title
|
||||
instruction: |
|
||||
Detailed instructions for the LLM on how to handle this section
|
||||
# ... additional section properties
|
||||
```
|
||||
|
||||
## Core Fields
|
||||
|
||||
### Template Metadata
|
||||
|
||||
- **id**: Unique identifier for the template
|
||||
- **name**: Human-readable name displayed in UI
|
||||
- **version**: Template version for tracking changes
|
||||
- **output.format**: Default "markdown" for document templates
|
||||
- **output.filename**: Default output file path (can include variables)
|
||||
- **output.title**: Document title (becomes H1 in markdown)
|
||||
|
||||
### Workflow Configuration
|
||||
|
||||
- **workflow.mode**: Default interaction mode ("interactive" or "yolo")
|
||||
- **workflow.elicitation**: Elicitation task to use ("advanced-elicitation")
|
||||
|
||||
## Section Properties
|
||||
|
||||
### Required Fields
|
||||
|
||||
- **id**: Unique section identifier
|
||||
- **title**: Section heading text
|
||||
- **instruction**: Detailed guidance for LLM on handling this section
|
||||
|
||||
### Optional Fields
|
||||
|
||||
#### Content Control
|
||||
|
||||
- **type**: Content type hint for structured sections
|
||||
- **template**: Fixed template text for section content
|
||||
- **item_template**: Template for repeatable items within section
|
||||
- **prefix**: Prefix for numbered items (e.g., "FR", "NFR")
|
||||
|
||||
#### Behavior Flags
|
||||
|
||||
- **elicit**: Boolean - Apply elicitation after section rendered
|
||||
- **repeatable**: Boolean - Section can be repeated multiple times
|
||||
- **condition**: String - Condition for including section (e.g., "has ui requirements")
|
||||
|
||||
#### Agent Permissions
|
||||
|
||||
- **owner**: String - Agent role that initially creates/populates this section
|
||||
- **editors**: Array - List of agent roles allowed to modify this section
|
||||
- **readonly**: Boolean - Section cannot be modified after initial creation
|
||||
|
||||
#### Content Guidance
|
||||
|
||||
- **examples**: Array of example content (not included in output)
|
||||
- **choices**: Object with choice options for common decisions
|
||||
- **placeholder**: Default placeholder text
|
||||
|
||||
#### Structure
|
||||
|
||||
- **sections**: Array of nested child sections
|
||||
|
||||
## Supported Types
|
||||
|
||||
### Content Types
|
||||
|
||||
- **bullet-list**: Unordered list items
|
||||
- **numbered-list**: Ordered list with optional prefix
|
||||
- **paragraphs**: Free-form paragraph text
|
||||
- **table**: Structured table data
|
||||
- **code-block**: Code or configuration blocks
|
||||
- **template-text**: Fixed template with variable substitution
|
||||
- **mermaid**: Mermaid diagram with specified type and details
|
||||
|
||||
### Special Types
|
||||
|
||||
- **repeatable-container**: Container for multiple instances
|
||||
- **conditional-block**: Content shown based on conditions
|
||||
- **choice-selector**: Present choices to user
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Variable Substitution
|
||||
|
||||
Use `{{variable_name}}` in titles, templates, and content:
|
||||
|
||||
```yaml
|
||||
title: "Epic {{epic_number}} {{epic_title}}"
|
||||
template: "As a {{user_type}}, I want {{action}}, so that {{benefit}}."
|
||||
```
|
||||
|
||||
### Conditional Sections
|
||||
|
||||
```yaml
|
||||
- id: ui-section
|
||||
title: User Interface Design
|
||||
condition: Project has UX/UI Requirements
|
||||
instruction: Only include if project has UI components
|
||||
```
|
||||
|
||||
### Choice Integration
|
||||
|
||||
```yaml
|
||||
choices:
|
||||
architecture: [Monolith, Microservices, Serverless]
|
||||
testing: [Unit Only, Unit + Integration, Full Pyramid]
|
||||
```
|
||||
|
||||
### Mermaid Diagrams
|
||||
|
||||
```yaml
|
||||
- id: system-architecture
|
||||
title: System Architecture Diagram
|
||||
type: mermaid
|
||||
instruction: Create a system architecture diagram showing key components and data flow
|
||||
mermaid_type: flowchart
|
||||
details: |
|
||||
Show the following components:
|
||||
- User interface layer
|
||||
- API gateway
|
||||
- Core services
|
||||
- Database layer
|
||||
- External integrations
|
||||
```
|
||||
|
||||
**Supported mermaid_type values:**
|
||||
|
||||
**Core Diagram Types:**
|
||||
|
||||
- `flowchart` - Flow charts and process diagrams
|
||||
- `sequenceDiagram` - Sequence diagrams for interactions
|
||||
- `classDiagram` - Class relationship diagrams (UML)
|
||||
- `stateDiagram` - State transition diagrams
|
||||
- `erDiagram` - Entity relationship diagrams
|
||||
- `gantt` - Gantt charts for timelines
|
||||
- `pie` - Pie charts for data visualization
|
||||
|
||||
**Advanced Diagram Types:**
|
||||
|
||||
- `journey` - User journey maps
|
||||
- `mindmap` - Mindmaps for brainstorming
|
||||
- `timeline` - Timeline diagrams for chronological events
|
||||
- `quadrantChart` - Quadrant charts for data categorization
|
||||
- `xyChart` - XY charts (bar charts, line charts)
|
||||
- `sankey` - Sankey diagrams for flow visualization
|
||||
|
||||
**Specialized Types:**
|
||||
|
||||
- `c4Context` - C4 context diagrams (experimental)
|
||||
- `requirement` - Requirement diagrams
|
||||
- `packet` - Network packet diagrams
|
||||
- `block` - Block diagrams
|
||||
- `kanban` - Kanban boards
|
||||
|
||||
### Agent Permissions Example
|
||||
|
||||
```yaml
|
||||
- id: story-details
|
||||
title: Story
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
readonly: false
|
||||
sections:
|
||||
- id: dev-notes
|
||||
title: Dev Notes
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
readonly: false
|
||||
instruction: Implementation notes and technical details
|
||||
- id: qa-results
|
||||
title: QA Results
|
||||
owner: qa-agent
|
||||
editors: [qa-agent]
|
||||
readonly: true
|
||||
instruction: Quality assurance test results
|
||||
```
|
||||
|
||||
### Repeatable Sections
|
||||
|
||||
```yaml
|
||||
- id: epic-details
|
||||
title: Epic {{epic_number}} {{epic_title}}
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: story
|
||||
title: Story {{epic_number}}.{{story_number}} {{story_title}}
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
item_template: "{{criterion_number}}: {{criteria}}"
|
||||
repeatable: true
|
||||
```
|
||||
|
||||
### Examples with Code Blocks
|
||||
|
||||
````yaml
|
||||
examples:
|
||||
- "FR6: The system must authenticate users within 2 seconds"
|
||||
- |
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant API
|
||||
participant DB
|
||||
User->>API: POST /login
|
||||
API->>DB: Validate credentials
|
||||
DB-->>API: User data
|
||||
API-->>User: JWT token
|
||||
```
|
||||
- |
|
||||
**Architecture Decision Record**
|
||||
|
||||
**Decision**: Use PostgreSQL for primary database
|
||||
**Rationale**: ACID compliance and JSON support needed
|
||||
**Consequences**: Requires database management expertise
|
||||
````
|
||||
|
||||
## Section Hierarchy
|
||||
|
||||
Templates define the complete document structure starting with the first H2 - each level in is the next H#:
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- id: overview
|
||||
title: Project Overview
|
||||
sections:
|
||||
- id: goals
|
||||
title: Goals
|
||||
- id: scope
|
||||
title: Scope
|
||||
sections:
|
||||
- id: in-scope
|
||||
title: In Scope
|
||||
- id: out-scope
|
||||
title: Out of Scope
|
||||
```
|
||||
|
||||
## Processing Flow
|
||||
|
||||
1. **Parse Template**: Load and validate YAML structure
|
||||
2. **Initialize Workflow**: Set interaction mode and elicitation
|
||||
3. **Process Sections**: Handle each section in order:
|
||||
- Check conditions
|
||||
- Apply instructions
|
||||
- Generate content
|
||||
- Handle choices and variables
|
||||
- Apply elicitation if specified
|
||||
- Process nested sections
|
||||
4. **Generate Output**: Create clean markdown document
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Template Design
|
||||
|
||||
- Keep instructions clear and specific
|
||||
- Use examples for complex content
|
||||
- Structure sections logically
|
||||
- Include all necessary guidance for LLM
|
||||
|
||||
### Content Instructions
|
||||
|
||||
- Be explicit about expected format
|
||||
- Include reasoning for decisions
|
||||
- Specify interaction patterns
|
||||
- Reference other documents when needed
|
||||
|
||||
### Variable Naming
|
||||
|
||||
- Use descriptive variable names
|
||||
- Follow consistent naming conventions
|
||||
- Document expected variable values
|
||||
|
||||
### Examples Usage
|
||||
|
||||
- Provide concrete examples for complex sections
|
||||
- Include both simple and complex cases
|
||||
- Use realistic project scenarios
|
||||
- Include code blocks and diagrams when helpful
|
||||
|
||||
## Validation
|
||||
|
||||
Templates should be validated for:
|
||||
|
||||
- Valid YAML syntax
|
||||
- Required fields present
|
||||
- Consistent section IDs
|
||||
- Proper nesting structure
|
||||
- Valid variable references
|
||||
|
||||
## Migration from Legacy
|
||||
|
||||
When converting from markdown+frontmatter templates:
|
||||
|
||||
1. Extract embedded `[[LLM:]]` instructions to `instruction` fields
|
||||
2. Convert `<<REPEAT>>` blocks to `repeatable: true` sections
|
||||
3. Extract `^^CONDITIONS^^` to `condition` fields
|
||||
4. Move `@{examples}` to `examples` arrays
|
||||
5. Convert `{{placeholders}}` to proper variable syntax
|
||||
|
||||
This specification ensures templates are both human-readable and machine-processable while maintaining the flexibility needed for complex document generation.
|
||||
@@ -1,26 +0,0 @@
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
- **{{placeholders}}**: Variables to be replaced with actual content
|
||||
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
|
||||
- **REPEAT** sections: Content blocks that may be repeated as needed
|
||||
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
|
||||
- **@{examples}**: Example content for guidance (never output to users)
|
||||
|
||||
## Processing Rules
|
||||
|
||||
- Replace all {{placeholders}} with project-specific content
|
||||
- Execute all [[LLM: instructions]] internally without showing users
|
||||
- Process conditional and repeat blocks as specified
|
||||
- Use examples for guidance but never include them in final output
|
||||
- Present only clean, formatted content to users
|
||||
|
||||
## Critical Guidelines
|
||||
|
||||
- **NEVER display template markup, LLM instructions, or examples to users**
|
||||
- Template elements are for AI processing only
|
||||
- Focus on faithful template execution and clean output
|
||||
- All template-specific instructions are embedded within templates
|
||||
2526
dist/agents/analyst.txt
vendored
2526
dist/agents/analyst.txt
vendored
File diff suppressed because it is too large
Load Diff
4901
dist/agents/architect.txt
vendored
4901
dist/agents/architect.txt
vendored
File diff suppressed because it is too large
Load Diff
9292
dist/agents/bmad-master.txt
vendored
9292
dist/agents/bmad-master.txt
vendored
File diff suppressed because it is too large
Load Diff
640
dist/agents/bmad-orchestrator.txt
vendored
640
dist/agents/bmad-orchestrator.txt
vendored
File diff suppressed because it is too large
Load Diff
45
dist/agents/dev.txt
vendored
45
dist/agents/dev.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,12 +38,14 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#dev ====================
|
||||
|
||||
==================== START: .bmad-core/agents/dev.md ====================
|
||||
# dev
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
activation-instructions: []
|
||||
agent:
|
||||
name: James
|
||||
id: dev
|
||||
@@ -51,11 +53,6 @@ agent:
|
||||
icon: 💻
|
||||
whenToUse: Use for code implementation, debugging, refactoring, and development best practices
|
||||
customization: null
|
||||
startup:
|
||||
- Announce: Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Read the following full files as these are your explicit rules for development standards for this project - {root}/core-config.yaml devLoadAlwaysFiles list
|
||||
- CRITICAL: Do NOT load any other files during startup aside from the assigned story and devLoadAlwaysFiles items, unless user requested you do or the following contradicts
|
||||
- CRITICAL: Do NOT begin development until a story is not in draft mode and you are told to proceed
|
||||
persona:
|
||||
role: Expert Senior Software Engineer & Implementation Specialist
|
||||
style: Extremely concise, pragmatic, detail-oriented, solution-focused
|
||||
@@ -82,21 +79,21 @@ develop-story:
|
||||
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'
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- validate-next-story
|
||||
- execute-checklist.md
|
||||
- validate-next-story.md
|
||||
checklists:
|
||||
- story-dod-checklist
|
||||
- story-dod-checklist.md
|
||||
```
|
||||
==================== END: agents#dev ====================
|
||||
==================== END: .bmad-core/agents/dev.md ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -105,7 +102,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- Load the appropriate checklist from .bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -183,9 +180,9 @@ The LLM will:
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: tasks#validate-next-story ====================
|
||||
==================== START: .bmad-core/tasks/validate-next-story.md ====================
|
||||
# Validate Next Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -320,9 +317,9 @@ Provide a structured validation report including:
|
||||
- **NO-GO**: Story requires fixes before implementation
|
||||
- **Implementation Readiness Score**: 1-10 scale
|
||||
- **Confidence Level**: High/Medium/Low for successful implementation
|
||||
==================== END: tasks#validate-next-story ====================
|
||||
==================== END: .bmad-core/tasks/validate-next-story.md ====================
|
||||
|
||||
==================== START: checklists#story-dod-checklist ====================
|
||||
==================== START: .bmad-core/checklists/story-dod-checklist.md ====================
|
||||
# Story Definition of Done (DoD) Checklist
|
||||
|
||||
## Instructions for Developer Agent
|
||||
@@ -424,4 +421,4 @@ After completing the checklist:
|
||||
Be honest - it's better to flag issues now than have them discovered later.]]
|
||||
|
||||
- [ ] I, the Developer Agent, confirm that all applicable items above have been addressed.
|
||||
==================== END: checklists#story-dod-checklist ====================
|
||||
==================== END: .bmad-core/checklists/story-dod-checklist.md ====================
|
||||
|
||||
1209
dist/agents/pm.txt
vendored
1209
dist/agents/pm.txt
vendored
File diff suppressed because it is too large
Load Diff
298
dist/agents/po.txt
vendored
298
dist/agents/po.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#po ====================
|
||||
|
||||
==================== START: .bmad-core/agents/po.md ====================
|
||||
# po
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
@@ -49,6 +50,7 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Sarah
|
||||
id: po
|
||||
@@ -72,8 +74,6 @@ persona:
|
||||
- User Collaboration for Validation - Seek input at critical checkpoints
|
||||
- Focus on Executable & Value-Driven Increments - Ensure work aligns with MVP goals
|
||||
- Documentation Ecosystem Integrity - Maintain consistency across all documents
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
||||
@@ -88,30 +88,28 @@ commands:
|
||||
- exit: Exit (confirm)
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- shard-doc
|
||||
- correct-course
|
||||
- brownfield-create-epic
|
||||
- brownfield-create-story
|
||||
- validate-next-story
|
||||
- execute-checklist.md
|
||||
- shard-doc.md
|
||||
- correct-course.md
|
||||
- brownfield-create-epic.md
|
||||
- brownfield-create-story.md
|
||||
- validate-next-story.md
|
||||
templates:
|
||||
- story-tmpl
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- po-master-checklist
|
||||
- change-checklist
|
||||
utils:
|
||||
- template-format
|
||||
- po-master-checklist.md
|
||||
- change-checklist.md
|
||||
```
|
||||
==================== END: agents#po ====================
|
||||
==================== END: .bmad-core/agents/po.md ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -120,7 +118,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- Load the appropriate checklist from .bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -198,9 +196,9 @@ The LLM will:
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: tasks#shard-doc ====================
|
||||
==================== START: .bmad-core/tasks/shard-doc.md ====================
|
||||
# Document Sharding Task
|
||||
|
||||
## Purpose
|
||||
@@ -392,9 +390,9 @@ Document sharded successfully:
|
||||
- Preserve ALL formatting, including whitespace where significant
|
||||
- Handle edge cases like sections with code blocks containing ## symbols
|
||||
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
||||
==================== END: tasks#shard-doc ====================
|
||||
==================== END: .bmad-core/tasks/shard-doc.md ====================
|
||||
|
||||
==================== START: tasks#correct-course ====================
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
@@ -468,9 +466,9 @@ Document sharded successfully:
|
||||
- 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: tasks#correct-course ====================
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: tasks#brownfield-create-epic ====================
|
||||
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||
# Create Brownfield Epic Task
|
||||
|
||||
## Purpose
|
||||
@@ -631,9 +629,9 @@ The epic creation is successful when:
|
||||
- If the scope grows beyond 3 stories, consider the full brownfield PRD process
|
||||
- Always prioritize existing system integrity over new functionality
|
||||
- When in doubt about scope or complexity, escalate to full brownfield planning
|
||||
==================== END: tasks#brownfield-create-epic ====================
|
||||
==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
|
||||
|
||||
==================== START: tasks#brownfield-create-story ====================
|
||||
==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||
# Create Brownfield Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -781,9 +779,9 @@ The story creation is successful when:
|
||||
- Always prioritize existing system integrity
|
||||
- When in doubt about integration complexity, use brownfield-create-epic instead
|
||||
- Stories should take no more than 4 hours of focused development work
|
||||
==================== END: tasks#brownfield-create-story ====================
|
||||
==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
|
||||
|
||||
==================== START: tasks#validate-next-story ====================
|
||||
==================== START: .bmad-core/tasks/validate-next-story.md ====================
|
||||
# Validate Next Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -918,70 +916,149 @@ Provide a structured validation report including:
|
||||
- **NO-GO**: Story requires fixes before implementation
|
||||
- **Implementation Readiness Score**: 1-10 scale
|
||||
- **Confidence Level**: High/Medium/Low for successful implementation
|
||||
==================== END: tasks#validate-next-story ====================
|
||||
==================== END: .bmad-core/tasks/validate-next-story.md ====================
|
||||
|
||||
==================== START: templates#story-tmpl ====================
|
||||
---
|
||||
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
||||
smAgent:
|
||||
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
||||
sectionSpecificInstructions:
|
||||
"Dev Notes":
|
||||
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
||||
- Do not invent information.
|
||||
- If known add Relevant Source Tree info that relates to this story.
|
||||
- If there were important notes from previous story that are relevant to this one, include them here.
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks.
|
||||
Testing:
|
||||
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
||||
---
|
||||
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
template:
|
||||
id: story-template-v2
|
||||
name: Story Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
||||
agent_config:
|
||||
editable_sections:
|
||||
- Status
|
||||
- Story
|
||||
- Acceptance Criteria
|
||||
- Tasks / Subtasks
|
||||
- Dev Notes
|
||||
- Testing
|
||||
- Change Log
|
||||
|
||||
## Story
|
||||
sections:
|
||||
- id: status
|
||||
title: Status
|
||||
type: choice
|
||||
choices: [Draft, Approved, InProgress, Review, Done]
|
||||
instruction: Select the current status of the story
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: story
|
||||
title: Story
|
||||
type: template-text
|
||||
template: |
|
||||
**As a** {{role}},
|
||||
**I want** {{action}},
|
||||
**so that** {{benefit}}
|
||||
instruction: Define the user story using the standard format with role, action, and benefit
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
instruction: Copy the acceptance criteria numbered list from the epic file
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: tasks-subtasks
|
||||
title: Tasks / Subtasks
|
||||
type: bullet-list
|
||||
instruction: |
|
||||
Break down the story into specific tasks and subtasks needed for implementation.
|
||||
Reference applicable acceptance criteria numbers where relevant.
|
||||
template: |
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: dev-notes
|
||||
title: Dev Notes
|
||||
instruction: |
|
||||
Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
|
||||
- Do not invent information
|
||||
- If known add Relevant Source Tree info that relates to this story
|
||||
- If there were important notes from previous story that are relevant to this one, include them here
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
sections:
|
||||
- id: testing-standards
|
||||
title: Testing
|
||||
instruction: |
|
||||
List Relevant Testing Standards from Architecture the Developer needs to conform to:
|
||||
- Test file location
|
||||
- Test standards
|
||||
- Testing frameworks and patterns to use
|
||||
- Any specific testing requirements for this story
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track changes made to this story document
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent, qa-agent]
|
||||
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
instruction: This section is populated by the development agent during implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: debug-log-references
|
||||
title: Debug Log References
|
||||
instruction: Reference any debug logs or traces generated during development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: completion-notes
|
||||
title: Completion Notes List
|
||||
instruction: Notes about the completion of tasks and any issues encountered
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: file-list
|
||||
title: File List
|
||||
instruction: List all files created, modified, or affected during story implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: qa-results
|
||||
title: QA Results
|
||||
instruction: Results from QA Agent QA review of the completed story implementation
|
||||
owner: qa-agent
|
||||
editors: [qa-agent]
|
||||
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
|
||||
**As a** {{role}},\
|
||||
**I want** {{action}},\
|
||||
**so that** {{benefit}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
{{ Copy of Acceptance Criteria numbered list }}
|
||||
|
||||
## Tasks / Subtasks
|
||||
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
|
||||
## Dev Notes
|
||||
|
||||
### Testing
|
||||
|
||||
## Change Log
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Dev Agent Record
|
||||
|
||||
### Agent Model Used: {{Agent Model Name/Version}}
|
||||
|
||||
### Debug Log References
|
||||
|
||||
### Completion Notes List
|
||||
|
||||
### File List
|
||||
|
||||
## QA Results
|
||||
==================== END: templates#story-tmpl ====================
|
||||
|
||||
==================== START: checklists#po-master-checklist ====================
|
||||
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
|
||||
# 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.
|
||||
@@ -1423,9 +1500,9 @@ After presenting the report, ask if the user wants:
|
||||
- **APPROVED**: The plan is comprehensive, properly sequenced, and ready for implementation.
|
||||
- **CONDITIONAL**: The plan requires specific adjustments before proceeding.
|
||||
- **REJECTED**: The plan requires significant revision to address critical deficiencies.
|
||||
==================== END: checklists#po-master-checklist ====================
|
||||
==================== END: .bmad-core/checklists/po-master-checklist.md ====================
|
||||
|
||||
==================== START: checklists#change-checklist ====================
|
||||
==================== START: .bmad-core/checklists/change-checklist.md ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||
@@ -1608,33 +1685,4 @@ Keep it action-oriented and forward-looking.]]
|
||||
- [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
|
||||
|
||||
---
|
||||
==================== END: checklists#change-checklist ====================
|
||||
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
- **{{placeholders}}**: Variables to be replaced with actual content
|
||||
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
|
||||
- **REPEAT** sections: Content blocks that may be repeated as needed
|
||||
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
|
||||
- **@{examples}**: Example content for guidance (never output to users)
|
||||
|
||||
## Processing Rules
|
||||
|
||||
- Replace all {{placeholders}} with project-specific content
|
||||
- Execute all [[LLM: instructions]] internally without showing users
|
||||
- Process conditional and repeat blocks as specified
|
||||
- Use examples for guidance but never include them in final output
|
||||
- Present only clean, formatted content to users
|
||||
|
||||
## Critical Guidelines
|
||||
|
||||
- **NEVER display template markup, LLM instructions, or examples to users**
|
||||
- Template elements are for AI processing only
|
||||
- Focus on faithful template execution and clean output
|
||||
- All template-specific instructions are embedded within templates
|
||||
==================== END: utils#template-format ====================
|
||||
==================== END: .bmad-core/checklists/change-checklist.md ====================
|
||||
|
||||
205
dist/agents/qa.txt
vendored
205
dist/agents/qa.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#qa ====================
|
||||
|
||||
==================== START: .bmad-core/agents/qa.md ====================
|
||||
# qa
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
@@ -49,6 +50,7 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
agent:
|
||||
name: Quinn
|
||||
id: qa
|
||||
@@ -72,8 +74,6 @@ persona:
|
||||
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
||||
- Continuous Improvement - Balance perfection with pragmatism
|
||||
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
story-file-permissions:
|
||||
- CRITICAL: When reviewing stories, you are ONLY authorized to update the "QA Results" section of story files
|
||||
- CRITICAL: DO NOT modify any other sections including Status, Story, Acceptance Criteria, Tasks/Subtasks, Dev Notes, Testing, Dev Agent Record, Change Log, or any other sections
|
||||
@@ -85,15 +85,15 @@ commands:
|
||||
- exit: Say goodbye as the QA Engineer, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- review-story
|
||||
- review-story.md
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
templates:
|
||||
- story-tmpl.yaml
|
||||
```
|
||||
==================== END: agents#qa ====================
|
||||
==================== END: .bmad-core/agents/qa.md ====================
|
||||
|
||||
==================== START: tasks#review-story ====================
|
||||
==================== START: .bmad-core/tasks/review-story.md ====================
|
||||
# review-story
|
||||
|
||||
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
||||
@@ -239,39 +239,150 @@ After review:
|
||||
1. If all items are checked and approved: Update story status to "Done"
|
||||
2. If unchecked items remain: Keep status as "Review" for dev to address
|
||||
3. Always provide constructive feedback and explanations for learning
|
||||
==================== END: tasks#review-story ====================
|
||||
==================== END: .bmad-core/tasks/review-story.md ====================
|
||||
|
||||
==================== START: data#technical-preferences ====================
|
||||
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
template:
|
||||
id: story-template-v2
|
||||
name: Story Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
agent_config:
|
||||
editable_sections:
|
||||
- Status
|
||||
- Story
|
||||
- Acceptance Criteria
|
||||
- Tasks / Subtasks
|
||||
- Dev Notes
|
||||
- Testing
|
||||
- Change Log
|
||||
|
||||
sections:
|
||||
- id: status
|
||||
title: Status
|
||||
type: choice
|
||||
choices: [Draft, Approved, InProgress, Review, Done]
|
||||
instruction: Select the current status of the story
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: story
|
||||
title: Story
|
||||
type: template-text
|
||||
template: |
|
||||
**As a** {{role}},
|
||||
**I want** {{action}},
|
||||
**so that** {{benefit}}
|
||||
instruction: Define the user story using the standard format with role, action, and benefit
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
instruction: Copy the acceptance criteria numbered list from the epic file
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: tasks-subtasks
|
||||
title: Tasks / Subtasks
|
||||
type: bullet-list
|
||||
instruction: |
|
||||
Break down the story into specific tasks and subtasks needed for implementation.
|
||||
Reference applicable acceptance criteria numbers where relevant.
|
||||
template: |
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: dev-notes
|
||||
title: Dev Notes
|
||||
instruction: |
|
||||
Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
|
||||
- Do not invent information
|
||||
- If known add Relevant Source Tree info that relates to this story
|
||||
- If there were important notes from previous story that are relevant to this one, include them here
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
sections:
|
||||
- id: testing-standards
|
||||
title: Testing
|
||||
instruction: |
|
||||
List Relevant Testing Standards from Architecture the Developer needs to conform to:
|
||||
- Test file location
|
||||
- Test standards
|
||||
- Testing frameworks and patterns to use
|
||||
- Any specific testing requirements for this story
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track changes made to this story document
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent, qa-agent]
|
||||
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
instruction: This section is populated by the development agent during implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: debug-log-references
|
||||
title: Debug Log References
|
||||
instruction: Reference any debug logs or traces generated during development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: completion-notes
|
||||
title: Completion Notes List
|
||||
instruction: Notes about the completion of tasks and any issues encountered
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: file-list
|
||||
title: File List
|
||||
instruction: List all files created, modified, or affected during story implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: qa-results
|
||||
title: QA Results
|
||||
instruction: Results from QA Agent QA review of the completed story implementation
|
||||
owner: qa-agent
|
||||
editors: [qa-agent]
|
||||
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
|
||||
==================== START: .bmad-core/data/technical-preferences.md ====================
|
||||
# User-Defined Preferred Patterns and Preferences
|
||||
|
||||
None Listed
|
||||
==================== END: data#technical-preferences ====================
|
||||
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
- **{{placeholders}}**: Variables to be replaced with actual content
|
||||
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
|
||||
- **REPEAT** sections: Content blocks that may be repeated as needed
|
||||
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
|
||||
- **@{examples}**: Example content for guidance (never output to users)
|
||||
|
||||
## Processing Rules
|
||||
|
||||
- Replace all {{placeholders}} with project-specific content
|
||||
- Execute all [[LLM: instructions]] internally without showing users
|
||||
- Process conditional and repeat blocks as specified
|
||||
- Use examples for guidance but never include them in final output
|
||||
- Present only clean, formatted content to users
|
||||
|
||||
## Critical Guidelines
|
||||
|
||||
- **NEVER display template markup, LLM instructions, or examples to users**
|
||||
- Template elements are for AI processing only
|
||||
- Focus on faithful template execution and clean output
|
||||
- All template-specific instructions are embedded within templates
|
||||
==================== END: utils#template-format ====================
|
||||
==================== END: .bmad-core/data/technical-preferences.md ====================
|
||||
|
||||
276
dist/agents/sm.txt
vendored
276
dist/agents/sm.txt
vendored
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-core/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-core/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#sm ====================
|
||||
|
||||
==================== START: .bmad-core/agents/sm.md ====================
|
||||
# sm
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
@@ -48,6 +49,7 @@ activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
||||
agent:
|
||||
name: Bob
|
||||
id: sm
|
||||
@@ -64,10 +66,6 @@ persona:
|
||||
- Rigorously follow `create-next-story` procedure to generate the detailed user story
|
||||
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
|
||||
- You are NOT allowed to implement stories or modify code EVER!
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
|
||||
- Offer to help with story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- draft: Execute task create-next-story
|
||||
@@ -76,19 +74,17 @@ commands:
|
||||
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-next-story
|
||||
- execute-checklist
|
||||
- correct-course
|
||||
- create-next-story.md
|
||||
- execute-checklist.md
|
||||
- correct-course.md
|
||||
templates:
|
||||
- story-tmpl
|
||||
- story-tmpl.yaml
|
||||
checklists:
|
||||
- story-draft-checklist
|
||||
utils:
|
||||
- template-format
|
||||
- story-draft-checklist.md
|
||||
```
|
||||
==================== END: agents#sm ====================
|
||||
==================== END: .bmad-core/agents/sm.md ====================
|
||||
|
||||
==================== START: tasks#create-next-story ====================
|
||||
==================== START: .bmad-core/tasks/create-next-story.md ====================
|
||||
# Create Next Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -203,16 +199,16 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
||||
- Any deviations or conflicts noted between epic and architecture
|
||||
- Checklist Results
|
||||
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `validate-next-story`
|
||||
==================== END: tasks#create-next-story ====================
|
||||
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -221,7 +217,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- Load the appropriate checklist from .bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -299,9 +295,9 @@ The LLM will:
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: tasks#correct-course ====================
|
||||
==================== START: .bmad-core/tasks/correct-course.md ====================
|
||||
# Correct Course Task
|
||||
|
||||
## Purpose
|
||||
@@ -375,70 +371,149 @@ The LLM will:
|
||||
- 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: tasks#correct-course ====================
|
||||
==================== END: .bmad-core/tasks/correct-course.md ====================
|
||||
|
||||
==================== START: templates#story-tmpl ====================
|
||||
---
|
||||
defaultOutput: docs/stories/{{EpicNum}}.{{StoryNum}}.{{Short Title Copied from Epic File specific story}}.md
|
||||
smAgent:
|
||||
editableSections: Status, Story, Acceptance Criteria, Tasks / Subtasks, Dev Notes, Testing, Change Log
|
||||
sectionSpecificInstructions:
|
||||
"Dev Notes":
|
||||
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story
|
||||
- Do not invent information.
|
||||
- If known add Relevant Source Tree info that relates to this story.
|
||||
- If there were important notes from previous story that are relevant to this one, include them here.
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks.
|
||||
Testing:
|
||||
- List Relevant Testing Standards from Architecture the Developer needs to conform to (test file location, test standards, etc)
|
||||
---
|
||||
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
template:
|
||||
id: story-template-v2
|
||||
name: Story Document
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
||||
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
||||
|
||||
# Story {{EpicNum}}.{{StoryNum}}: {{Short Title Copied from Epic File specific story}}
|
||||
workflow:
|
||||
mode: interactive
|
||||
elicitation: advanced-elicitation
|
||||
|
||||
## Status: {{ Draft | Approved | InProgress | Review | Done }}
|
||||
agent_config:
|
||||
editable_sections:
|
||||
- Status
|
||||
- Story
|
||||
- Acceptance Criteria
|
||||
- Tasks / Subtasks
|
||||
- Dev Notes
|
||||
- Testing
|
||||
- Change Log
|
||||
|
||||
## Story
|
||||
sections:
|
||||
- id: status
|
||||
title: Status
|
||||
type: choice
|
||||
choices: [Draft, Approved, InProgress, Review, Done]
|
||||
instruction: Select the current status of the story
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: story
|
||||
title: Story
|
||||
type: template-text
|
||||
template: |
|
||||
**As a** {{role}},
|
||||
**I want** {{action}},
|
||||
**so that** {{benefit}}
|
||||
instruction: Define the user story using the standard format with role, action, and benefit
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
type: numbered-list
|
||||
instruction: Copy the acceptance criteria numbered list from the epic file
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: tasks-subtasks
|
||||
title: Tasks / Subtasks
|
||||
type: bullet-list
|
||||
instruction: |
|
||||
Break down the story into specific tasks and subtasks needed for implementation.
|
||||
Reference applicable acceptance criteria numbers where relevant.
|
||||
template: |
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent]
|
||||
|
||||
- id: dev-notes
|
||||
title: Dev Notes
|
||||
instruction: |
|
||||
Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
|
||||
- Do not invent information
|
||||
- If known add Relevant Source Tree info that relates to this story
|
||||
- If there were important notes from previous story that are relevant to this one, include them here
|
||||
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
sections:
|
||||
- id: testing-standards
|
||||
title: Testing
|
||||
instruction: |
|
||||
List Relevant Testing Standards from Architecture the Developer needs to conform to:
|
||||
- Test file location
|
||||
- Test standards
|
||||
- Testing frameworks and patterns to use
|
||||
- Any specific testing requirements for this story
|
||||
elicit: true
|
||||
owner: scrum-master
|
||||
editors: [scrum-master]
|
||||
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
type: table
|
||||
columns: [Date, Version, Description, Author]
|
||||
instruction: Track changes made to this story document
|
||||
owner: scrum-master
|
||||
editors: [scrum-master, dev-agent, qa-agent]
|
||||
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
instruction: This section is populated by the development agent during implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
sections:
|
||||
- id: agent-model
|
||||
title: Agent Model Used
|
||||
template: "{{agent_model_name_version}}"
|
||||
instruction: Record the specific AI agent model and version used for development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: debug-log-references
|
||||
title: Debug Log References
|
||||
instruction: Reference any debug logs or traces generated during development
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: completion-notes
|
||||
title: Completion Notes List
|
||||
instruction: Notes about the completion of tasks and any issues encountered
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: file-list
|
||||
title: File List
|
||||
instruction: List all files created, modified, or affected during story implementation
|
||||
owner: dev-agent
|
||||
editors: [dev-agent]
|
||||
|
||||
- id: qa-results
|
||||
title: QA Results
|
||||
instruction: Results from QA Agent QA review of the completed story implementation
|
||||
owner: qa-agent
|
||||
editors: [qa-agent]
|
||||
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
|
||||
|
||||
**As a** {{role}},\
|
||||
**I want** {{action}},\
|
||||
**so that** {{benefit}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
{{ Copy of Acceptance Criteria numbered list }}
|
||||
|
||||
## Tasks / Subtasks
|
||||
|
||||
- [ ] Task 1 (AC: # if applicable)
|
||||
- [ ] Subtask1.1...
|
||||
- [ ] Task 2 (AC: # if applicable)
|
||||
- [ ] Subtask 2.1...
|
||||
- [ ] Task 3 (AC: # if applicable)
|
||||
- [ ] Subtask 3.1...
|
||||
|
||||
## Dev Notes
|
||||
|
||||
### Testing
|
||||
|
||||
## Change Log
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Dev Agent Record
|
||||
|
||||
### Agent Model Used: {{Agent Model Name/Version}}
|
||||
|
||||
### Debug Log References
|
||||
|
||||
### Completion Notes List
|
||||
|
||||
### File List
|
||||
|
||||
## QA Results
|
||||
==================== END: templates#story-tmpl ====================
|
||||
|
||||
==================== START: checklists#story-draft-checklist ====================
|
||||
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
|
||||
# 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.
|
||||
@@ -595,33 +670,4 @@ Be pragmatic - perfect documentation doesn't exist, but it must be enough to pro
|
||||
- READY: The story provides sufficient context for implementation
|
||||
- NEEDS REVISION: The story requires updates (see issues)
|
||||
- BLOCKED: External information required (specify what information)
|
||||
==================== END: checklists#story-draft-checklist ====================
|
||||
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
- **{{placeholders}}**: Variables to be replaced with actual content
|
||||
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
|
||||
- **REPEAT** sections: Content blocks that may be repeated as needed
|
||||
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
|
||||
- **@{examples}**: Example content for guidance (never output to users)
|
||||
|
||||
## Processing Rules
|
||||
|
||||
- Replace all {{placeholders}} with project-specific content
|
||||
- Execute all [[LLM: instructions]] internally without showing users
|
||||
- Process conditional and repeat blocks as specified
|
||||
- Use examples for guidance but never include them in final output
|
||||
- Present only clean, formatted content to users
|
||||
|
||||
## Critical Guidelines
|
||||
|
||||
- **NEVER display template markup, LLM instructions, or examples to users**
|
||||
- Template elements are for AI processing only
|
||||
- Focus on faithful template execution and clean output
|
||||
- All template-specific instructions are embedded within templates
|
||||
==================== END: utils#template-format ====================
|
||||
==================== END: .bmad-core/checklists/story-draft-checklist.md ====================
|
||||
|
||||
980
dist/agents/ux-expert.txt
vendored
980
dist/agents/ux-expert.txt
vendored
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-2d-phaser-game-dev/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-2d-phaser-game-dev/personas/analyst.md`, `.bmad-2d-phaser-game-dev/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-2d-phaser-game-dev/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-2d-phaser-game-dev/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#game-sm ====================
|
||||
|
||||
==================== START: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
|
||||
# game-sm
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
@@ -49,6 +50,10 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
|
||||
agent:
|
||||
name: Jordan
|
||||
id: game-sm
|
||||
@@ -68,13 +73,6 @@ core_principles:
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Game-Specific Context - Understand Phaser 3, game mechanics, and performance requirements
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically execute create-game-story tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for game dev advice'
|
||||
@@ -83,16 +81,16 @@ commands:
|
||||
- '*exit" - Say goodbye as the Game Scrum Master, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-game-story
|
||||
- execute-checklist
|
||||
- create-game-story.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- game-story-tmpl
|
||||
- game-story-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist
|
||||
- game-story-dod-checklist.md
|
||||
```
|
||||
==================== END: agents#game-sm ====================
|
||||
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
|
||||
|
||||
==================== START: tasks#create-game-story ====================
|
||||
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
|
||||
# Create Game Development Story Task
|
||||
|
||||
## Purpose
|
||||
@@ -152,7 +150,7 @@ Before creating stories, ensure you have:
|
||||
### 3. Template Execution
|
||||
|
||||
**Load Template:**
|
||||
Use `templates#game-story-tmpl` following all embedded LLM instructions
|
||||
Use `.bmad-2d-phaser-game-dev/templates/game-story-tmpl.md` following all embedded LLM instructions
|
||||
|
||||
**Key Focus Areas:**
|
||||
|
||||
@@ -188,7 +186,7 @@ Use `templates#game-story-tmpl` following all embedded LLM instructions
|
||||
### 5. Quality Assurance
|
||||
|
||||
**Apply Checklist:**
|
||||
Execute `checklists#game-story-dod-checklist` against completed story
|
||||
Execute `.bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md` against completed story
|
||||
|
||||
**Story Criteria:**
|
||||
|
||||
@@ -309,16 +307,16 @@ Execute `checklists#game-story-dod-checklist` against completed story
|
||||
- Testing → Done
|
||||
|
||||
This task ensures game development stories are immediately actionable and enable efficient AI-driven development of game features.
|
||||
==================== END: tasks#create-game-story ====================
|
||||
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-2d-phaser-game-dev/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -327,7 +325,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- Load the appropriate checklist from .bmad-2d-phaser-game-dev/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -405,247 +403,265 @@ The LLM will:
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: tasks#execute-checklist ====================
|
||||
|
||||
==================== START: templates#game-story-tmpl ====================
|
||||
# Story: {{Story Title}}
|
||||
|
||||
**Epic:** {{Epic Name}}
|
||||
**Story ID:** {{ID}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{Story Points}}
|
||||
**Status:** Draft
|
||||
|
||||
[[LLM: This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.]]
|
||||
|
||||
## Description
|
||||
|
||||
[[LLM: 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.]]
|
||||
|
||||
{{clear_description_of_what_needs_to_be_implemented}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
[[LLM: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.]]
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
- [ ] {{specific_functional_requirement_1}}
|
||||
- [ ] {{specific_functional_requirement_2}}
|
||||
- [ ] {{specific_functional_requirement_3}}
|
||||
|
||||
### Technical Requirements
|
||||
|
||||
- [ ] Code follows TypeScript strict mode standards
|
||||
- [ ] Maintains 60 FPS on target devices
|
||||
- [ ] No memory leaks or performance degradation
|
||||
- [ ] {{specific_technical_requirement}}
|
||||
|
||||
### Game Design Requirements
|
||||
|
||||
- [ ] {{gameplay_requirement_from_gdd}}
|
||||
- [ ] {{balance_requirement_if_applicable}}
|
||||
- [ ] {{player_experience_requirement}}
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
[[LLM: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.]]
|
||||
|
||||
### Files to Create/Modify
|
||||
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
|
||||
### Class/Interface Definitions
|
||||
|
||||
[[LLM: Define specific TypeScript interfaces and class structures needed]]
|
||||
|
||||
```typescript
|
||||
// {{interface_name}}
|
||||
interface {{InterfaceName}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{ClassName}} extends {{PhaseClass}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Integration Points
|
||||
|
||||
[[LLM: Specify how this feature integrates with existing systems]]
|
||||
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
## Implementation Tasks
|
||||
|
||||
[[LLM: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.]]
|
||||
|
||||
### Dev Agent Record
|
||||
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
## Game Design Context
|
||||
|
||||
[[LLM: Reference the specific sections of the GDD that this story implements]]
|
||||
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
[[LLM: Define specific testing criteria for this game feature]]
|
||||
|
||||
### Unit Tests
|
||||
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
|
||||
### Game Testing
|
||||
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
|
||||
### Performance Tests
|
||||
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
## Dependencies
|
||||
|
||||
[[LLM: List any dependencies that must be completed before this story can be implemented]]
|
||||
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
## Definition of Done
|
||||
|
||||
[[LLM: Checklist that must be completed before the story is considered finished]]
|
||||
|
||||
- [ ] 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}}
|
||||
|
||||
## Notes
|
||||
|
||||
[[LLM: Any additional context, design decisions, or implementation notes]]
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
==================== END: templates#game-story-tmpl ====================
|
||||
|
||||
==================== START: checklists#game-story-dod-checklist ====================
|
||||
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
||||
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}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
||||
|
||||
- id: story-header
|
||||
content: |
|
||||
**Epic:** {{epic_name}}
|
||||
**Story ID:** {{story_id}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{story_points}}
|
||||
**Status:** Draft
|
||||
|
||||
- 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}}"
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
instruction: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.
|
||||
sections:
|
||||
- id: functional-requirements
|
||||
title: Functional Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{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}}"
|
||||
- id: game-design-requirements
|
||||
title: Game Design Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{gameplay_requirement_from_gdd}}"
|
||||
- "{{balance_requirement_if_applicable}}"
|
||||
- "{{player_experience_requirement}}"
|
||||
|
||||
- id: technical-specifications
|
||||
title: Technical Specifications
|
||||
instruction: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.
|
||||
sections:
|
||||
- id: files-to-modify
|
||||
title: Files to Create/Modify
|
||||
template: |
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
- id: class-interface-definitions
|
||||
title: Class/Interface Definitions
|
||||
instruction: Define specific TypeScript interfaces and class structures needed
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
// {{interface_name}}
|
||||
interface {{interface_name}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{class_name}} extends {{phaser_class}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
instruction: Specify how this feature integrates with existing systems
|
||||
template: |
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
- id: implementation-tasks
|
||||
title: Implementation Tasks
|
||||
instruction: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.
|
||||
sections:
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
template: |
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
- id: game-design-context
|
||||
title: Game Design Context
|
||||
instruction: Reference the specific sections of the GDD that this story implements
|
||||
template: |
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
- id: testing-requirements
|
||||
title: Testing Requirements
|
||||
instruction: Define specific testing criteria for this game feature
|
||||
sections:
|
||||
- id: unit-tests
|
||||
title: Unit Tests
|
||||
template: |
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
- id: game-testing
|
||||
title: Game Testing
|
||||
template: |
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
- id: performance-tests
|
||||
title: Performance Tests
|
||||
template: |
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
- id: dependencies
|
||||
title: Dependencies
|
||||
instruction: List any dependencies that must be completed before this story can be implemented
|
||||
template: |
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
- id: definition-of-done
|
||||
title: Definition of Done
|
||||
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}}"
|
||||
|
||||
- id: notes
|
||||
title: Notes
|
||||
instruction: Any additional context, design decisions, or implementation notes
|
||||
template: |
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
||||
|
||||
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||
# Game Development Story Definition of Done Checklist
|
||||
|
||||
## Story Completeness
|
||||
@@ -806,4 +822,4 @@ class {{ClassName}} extends {{PhaseClass}} {
|
||||
|
||||
**Additional Notes:**
|
||||
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
||||
==================== END: checklists#game-story-dod-checklist ====================
|
||||
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
||||
|
||||
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
||||
|
||||
- `==================== START: folder#filename ====================`
|
||||
- `==================== END: folder#filename ====================`
|
||||
- `==================== START: .bmad-creator-tools/folder/filename.md ====================`
|
||||
- `==================== END: .bmad-creator-tools/folder/filename.md ====================`
|
||||
|
||||
When you need to reference a resource mentioned in your instructions:
|
||||
|
||||
- Look for the corresponding START/END tags
|
||||
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
|
||||
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
|
||||
- The format is always the full path with dot prefix (e.g., `.bmad-creator-tools/personas/analyst.md`, `.bmad-creator-tools/tasks/create-story.md`)
|
||||
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
||||
|
||||
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
||||
|
||||
@@ -29,8 +29,8 @@ dependencies:
|
||||
|
||||
These references map directly to bundle sections:
|
||||
|
||||
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
|
||||
- `utils: template-format` → Look for `==================== START: .bmad-creator-tools/utils/template-format.md ====================`
|
||||
- `tasks: create-story` → Look for `==================== START: .bmad-creator-tools/tasks/create-story.md ====================`
|
||||
|
||||
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
||||
|
||||
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
||||
|
||||
---
|
||||
|
||||
==================== START: agents#bmad-the-creator ====================
|
||||
|
||||
==================== START: .bmad-creator-tools/agents/bmad-the-creator.md ====================
|
||||
# bmad-the-creator
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
@@ -49,6 +50,9 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
agent:
|
||||
name: The Creator
|
||||
id: bmad-the-creator
|
||||
@@ -68,12 +72,6 @@ core_principles:
|
||||
- Convention Over Configuration - Follow BMad naming and structure patterns
|
||||
- Extensibility First - Design for future expansion and customization
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for framework design advice'
|
||||
@@ -84,17 +82,17 @@ commands:
|
||||
- '*exit" - Say goodbye as The Creator, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- generate-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-deep-research-prompt
|
||||
- create-agent.md
|
||||
- generate-expansion-pack.md
|
||||
- advanced-elicitation.md
|
||||
- create-deep-research-prompt.md
|
||||
templates:
|
||||
- agent-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- agent-tmpl.yaml
|
||||
- expansion-pack-plan-tmpl.yaml
|
||||
```
|
||||
==================== END: agents#bmad-the-creator ====================
|
||||
==================== END: .bmad-creator-tools/agents/bmad-the-creator.md ====================
|
||||
|
||||
==================== START: tasks#create-agent ====================
|
||||
==================== START: .bmad-creator-tools/tasks/create-agent.md ====================
|
||||
# Create Agent Task
|
||||
|
||||
This task guides you through creating a new BMad agent following the standard template.
|
||||
@@ -295,9 +293,9 @@ dependencies:
|
||||
- Test thoroughly before distribution
|
||||
- Follow existing agent patterns for consistency
|
||||
- Remember: No task = agent can't do it, No template = agent can't create it
|
||||
==================== END: tasks#create-agent ====================
|
||||
==================== END: .bmad-creator-tools/tasks/create-agent.md ====================
|
||||
|
||||
==================== START: tasks#generate-expansion-pack ====================
|
||||
==================== START: .bmad-creator-tools/tasks/generate-expansion-pack.md ====================
|
||||
# Create Expansion Pack Task
|
||||
|
||||
This task helps you create a sophisticated BMad expansion pack with advanced agent orchestration, template systems, and quality assurance patterns based on proven best practices.
|
||||
@@ -1318,9 +1316,9 @@ Embedded knowledge (automatic):
|
||||
- [ ] Template conditional content tested with different scenarios
|
||||
- [ ] Workflow decision trees validated with sample use cases
|
||||
- [ ] Character interactions tested for consistency and professional authenticity
|
||||
==================== END: tasks#generate-expansion-pack ====================
|
||||
==================== END: .bmad-creator-tools/tasks/generate-expansion-pack.md ====================
|
||||
|
||||
==================== START: tasks#advanced-elicitation ====================
|
||||
==================== START: .bmad-creator-tools/tasks/advanced-elicitation.md ====================
|
||||
# Advanced Elicitation Task
|
||||
|
||||
## Purpose
|
||||
@@ -1328,94 +1326,119 @@ Embedded knowledge (automatic):
|
||||
- Provide optional reflective and brainstorming actions to enhance content quality
|
||||
- Enable deeper exploration of ideas through structured elicitation techniques
|
||||
- Support iterative refinement through multiple analytical perspectives
|
||||
- Usable during template-driven document creation or any chat conversation
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Template Document Creation
|
||||
|
||||
After outputting a section during document creation:
|
||||
|
||||
1. **Section Review**: Ask user to review the drafted section
|
||||
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
||||
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
||||
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
||||
|
||||
### Scenario 2: General Chat Elicitation
|
||||
|
||||
User can request advanced elicitation on any agent output:
|
||||
|
||||
- User says "do advanced elicitation" or similar
|
||||
- Agent selects 9 relevant methods for the context
|
||||
- Same simple 0-9 selection process
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Section Context and Review
|
||||
### 1. Intelligent Method Selection
|
||||
|
||||
[[LLM: When invoked after outputting a section:
|
||||
**Context Analysis**: Before presenting options, analyze:
|
||||
|
||||
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
|
||||
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
||||
- **Complexity Level**: Simple, moderate, or complex content
|
||||
- **Stakeholder Needs**: Who will use this information
|
||||
- **Risk Level**: High-impact decisions vs routine items
|
||||
- **Creative Potential**: Opportunities for innovation or alternatives
|
||||
|
||||
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
|
||||
**Method Selection Strategy**:
|
||||
|
||||
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
|
||||
1. **Always Include Core Methods** (choose 3-4):
|
||||
- Expand or Contract for Audience
|
||||
- Critique and Refine
|
||||
- Identify Potential Risks
|
||||
- Assess Alignment with Goals
|
||||
|
||||
2. **Context-Specific Methods** (choose 4-5):
|
||||
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
||||
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
||||
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
||||
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
||||
|
||||
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
||||
|
||||
### 2. Section Context and Review
|
||||
|
||||
When invoked after outputting a section:
|
||||
|
||||
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
||||
|
||||
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
||||
|
||||
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
||||
- The entire section as a whole
|
||||
- Individual items within the section (specify which item when selecting an action)
|
||||
|
||||
4. Then present the action list as specified below.]]
|
||||
### 3. Present Elicitation Options
|
||||
|
||||
### 2. Ask for Review and Present Action List
|
||||
**Review Request Process:**
|
||||
|
||||
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
|
||||
- Ask the user to review the drafted section
|
||||
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
||||
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
||||
- Keep descriptions short - just the method name
|
||||
- Await simple numeric selection
|
||||
|
||||
**Present the numbered list (0-9) with this exact format:**
|
||||
**Action List Presentation Format:**
|
||||
|
||||
```text
|
||||
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
||||
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
||||
**Advanced Elicitation Options**
|
||||
Choose a number (0-8) or 9 to proceed:
|
||||
|
||||
0. Expand or Contract for Audience
|
||||
1. Explain Reasoning (CoT Step-by-Step)
|
||||
2. Critique and Refine
|
||||
3. Analyze Logical Flow and Dependencies
|
||||
4. Assess Alignment with Overall Goals
|
||||
5. Identify Potential Risks and Unforeseen Issues
|
||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
||||
0. [Method Name]
|
||||
1. [Method Name]
|
||||
2. [Method Name]
|
||||
3. [Method Name]
|
||||
4. [Method Name]
|
||||
5. [Method Name]
|
||||
6. [Method Name]
|
||||
7. [Method Name]
|
||||
8. [Method Name]
|
||||
9. Proceed / No Further Actions
|
||||
```
|
||||
|
||||
### 2. Processing Guidelines
|
||||
**Response Handling:**
|
||||
|
||||
**Do NOT show:**
|
||||
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
||||
- **Number 9**: Proceed to next section or continue conversation
|
||||
- **Direct Feedback**: Apply user's suggested changes and continue
|
||||
|
||||
- The full protocol text with `[[LLM: ...]]` instructions
|
||||
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
||||
- Any internal template markup
|
||||
### 4. Method Execution Framework
|
||||
|
||||
**After user selection from the list:**
|
||||
**Execution Process:**
|
||||
|
||||
- Execute the chosen action according to the protocol instructions below
|
||||
- Ask if they want to select another action or proceed with option 9 once complete
|
||||
- Continue until user selects option 9 or indicates completion
|
||||
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
||||
2. **Apply Context**: Execute the method from your current role's perspective
|
||||
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
||||
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
||||
|
||||
## Action Definitions
|
||||
**Execution Guidelines:**
|
||||
|
||||
0. Expand or Contract for Audience
|
||||
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
||||
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
||||
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
||||
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
||||
- **Maintain Flow**: Keep the process moving efficiently
|
||||
==================== END: .bmad-creator-tools/tasks/advanced-elicitation.md ====================
|
||||
|
||||
1. Explain Reasoning (CoT Step-by-Step)
|
||||
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
|
||||
|
||||
2. Critique and Refine
|
||||
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
||||
|
||||
3. Analyze Logical Flow and Dependencies
|
||||
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
||||
|
||||
4. Assess Alignment with Overall Goals
|
||||
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
|
||||
|
||||
5. Identify Potential Risks and Unforeseen Issues
|
||||
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
||||
|
||||
6. Challenge from Critical Perspective (Self or Other Persona)
|
||||
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
|
||||
|
||||
7. Explore Diverse Alternatives (ToT-Inspired)
|
||||
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
||||
|
||||
8. Hindsight is 20/20: The 'If Only...' Reflection
|
||||
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
|
||||
|
||||
9. Proceed / No Further Actions
|
||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
||||
==================== END: tasks#advanced-elicitation ====================
|
||||
|
||||
==================== START: tasks#create-deep-research-prompt ====================
|
||||
==================== START: .bmad-creator-tools/tasks/create-deep-research-prompt.md ====================
|
||||
# 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.
|
||||
@@ -1717,244 +1740,284 @@ Present these numbered options to the user:
|
||||
- Balance comprehensiveness with focus
|
||||
- Document assumptions and limitations clearly
|
||||
- Plan for iterative refinement based on initial findings
|
||||
==================== END: tasks#create-deep-research-prompt ====================
|
||||
==================== END: .bmad-creator-tools/tasks/create-deep-research-prompt.md ====================
|
||||
|
||||
==================== START: templates#agent-tmpl ====================
|
||||
# [AGENT_ID]
|
||||
==================== START: .bmad-creator-tools/templates/agent-tmpl.yaml ====================
|
||||
template:
|
||||
id: agent-template-v2
|
||||
name: Agent Definition
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "agents/{{agent_id}}.md"
|
||||
title: "{{agent_id}}"
|
||||
|
||||
[[LLM: This is an agent definition template. When creating a new agent:
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions]]
|
||||
sections:
|
||||
- id: header
|
||||
title: "{{agent_id}}"
|
||||
instruction: |
|
||||
This is an agent definition template. When creating a new agent:
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
- id: agent-definition
|
||||
content: |
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
sections:
|
||||
- id: yaml-definition
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
|
||||
agent:
|
||||
name: {{agent_name}}
|
||||
id: {{agent_id}}
|
||||
title: {{agent_title}}
|
||||
customization: {{optional_customization}}
|
||||
|
||||
persona:
|
||||
role: {{agent_role_description}}
|
||||
style: {{communication_style}}
|
||||
identity: {{agent_identity_description}}
|
||||
focus: {{primary_focus_areas}}
|
||||
|
||||
core_principles:
|
||||
- {{principle_1}}
|
||||
- {{principle_2}}
|
||||
- {{principle_3}}
|
||||
# Add more principles as needed
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- {{startup_instruction_1}}
|
||||
- {{startup_instruction_2}}
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) {{default_mode_description}}
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
{{custom_commands}}
|
||||
- "*exit" - Say goodbye as the {{agent_title}}, and then abandon inhabiting this persona
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
{{task_list}}
|
||||
|
||||
templates:
|
||||
{{template_list}}
|
||||
|
||||
checklists:
|
||||
{{checklist_list}}
|
||||
|
||||
data:
|
||||
{{data_list}}
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
{{util_list}}
|
||||
instruction: |
|
||||
For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process
|
||||
|
||||
Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution
|
||||
|
||||
CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
- id: example
|
||||
title: Example: Construction Contractor Agent
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
==================== END: .bmad-creator-tools/templates/agent-tmpl.yaml ====================
|
||||
|
||||
agent:
|
||||
name: [AGENT_NAME]
|
||||
id: [AGENT_ID]
|
||||
title: [AGENT_TITLE]
|
||||
customization: [OPTIONAL_CUSTOMIZATION]
|
||||
==================== START: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml ====================
|
||||
template:
|
||||
id: expansion-pack-plan-template-v2
|
||||
name: Expansion Pack Plan
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "{{pack_name}}-expansion-pack-plan.md"
|
||||
title: "{{pack_display_name}} Expansion Pack Plan"
|
||||
|
||||
persona:
|
||||
role: [AGENT_ROLE_DESCRIPTION]
|
||||
style: [COMMUNICATION_STYLE]
|
||||
identity: [AGENT_IDENTITY_DESCRIPTION]
|
||||
focus: [PRIMARY_FOCUS_AREAS]
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
core_principles:
|
||||
- [PRINCIPLE_1]
|
||||
- [PRINCIPLE_2]
|
||||
- [PRINCIPLE_3]
|
||||
# Add more principles as needed
|
||||
sections:
|
||||
- id: overview
|
||||
title: Overview
|
||||
template: |
|
||||
- **Pack Name**: {{pack_identifier}}
|
||||
- **Display Name**: {{full_expansion_pack_name}}
|
||||
- **Description**: {{brief_description}}
|
||||
- **Target Domain**: {{industry_domain}}
|
||||
- **Author**: {{author_name_organization}}
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- [STARTUP_INSTRUCTION]
|
||||
- [STARTUP_INSTRUCTION]...
|
||||
- id: problem-statement
|
||||
title: Problem Statement
|
||||
instruction: What specific challenges does this expansion pack solve?
|
||||
template: "{{problem_description}}"
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) [DEFAULT_MODE_DESCRIPTION]
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
[[LLM: For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process]]
|
||||
- [tasks] specific to the agent that are not covered by a template
|
||||
[[LLM: Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution]]
|
||||
- "*exit" - Say goodbye as the [AGENT_TITLE], and then abandon inhabiting this persona
|
||||
- id: target-users
|
||||
title: Target Users
|
||||
instruction: Who will benefit from this expansion pack?
|
||||
template: "{{target_user_description}}"
|
||||
|
||||
dependencies:
|
||||
[[LLM: CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)]]
|
||||
- id: components
|
||||
title: Components to Create
|
||||
sections:
|
||||
- id: agents
|
||||
title: Agents
|
||||
type: checklist
|
||||
instruction: List all agents to be created with their roles and dependencies
|
||||
items:
|
||||
- id: orchestrator
|
||||
template: |
|
||||
`{{pack_name}}-orchestrator` - **REQUIRED**: Master orchestrator for {{domain}} workflows
|
||||
- Key commands: {{command_list}}
|
||||
- Manages: {{orchestration_scope}}
|
||||
- id: agent-list
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{agent_name}}` - {{role_description}}
|
||||
- Tasks used: {{task_list}}
|
||||
- Templates used: {{template_list}}
|
||||
- Data required: {{data_requirements}}
|
||||
|
||||
- id: tasks
|
||||
title: Tasks
|
||||
type: checklist
|
||||
instruction: List all tasks to be created
|
||||
repeatable: true
|
||||
template: "`{{task_name}}.md` - {{purpose}} (used by: {{using_agents}})"
|
||||
|
||||
- id: templates
|
||||
title: Templates
|
||||
type: checklist
|
||||
instruction: List all templates to be created
|
||||
repeatable: true
|
||||
template: "`{{template_name}}-tmpl.md` - {{document_type}} (used by: {{using_components}})"
|
||||
|
||||
- id: checklists
|
||||
title: Checklists
|
||||
type: checklist
|
||||
instruction: List all checklists to be created
|
||||
repeatable: true
|
||||
template: "`{{checklist_name}}-checklist.md` - {{validation_purpose}}"
|
||||
|
||||
- id: data-files
|
||||
title: Data Files Required from User
|
||||
instruction: |
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
type: checklist
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{data_filename}}.{{extension}}` - {{content_description}}
|
||||
- Format: {{file_format}}
|
||||
- Purpose: {{why_needed}}
|
||||
- Example: {{brief_example}}
|
||||
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
- [TASK_1] # Custom task for non-document operations
|
||||
- [TASK_2] # Another custom task
|
||||
[[LLM: Example tasks: validate-design, analyze-requirements, execute-tests]]
|
||||
- id: workflow-overview
|
||||
title: Workflow Overview
|
||||
type: numbered-list
|
||||
instruction: Describe the typical workflow steps
|
||||
template: "{{workflow_step}}"
|
||||
|
||||
templates:
|
||||
- [TEMPLATE_1] # Template with LLM instructions for guided creation
|
||||
- [TEMPLATE_2] # Another template for different document type
|
||||
[[LLM: Example: blueprint-tmpl, contract-tmpl, report-tmpl
|
||||
Each template should include [[LLM: guidance]] and other conventions from `template-format.md` sections for user interaction]]
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
template: |
|
||||
- Depends on core agents: {{core_agent_dependencies}}
|
||||
- Extends teams: {{team_updates}}
|
||||
|
||||
checklists:
|
||||
- [CHECKLIST_1] # Quality validation for template outputs
|
||||
[[LLM: Example: blueprint-checklist, contract-checklist
|
||||
Checklists validate documents created from templates]]
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
type: checklist
|
||||
items:
|
||||
- "All components created and cross-referenced"
|
||||
- "No orphaned task/template references"
|
||||
- "Data requirements clearly documented"
|
||||
- "Orchestrator provides clear workflow"
|
||||
- "README includes setup instructions"
|
||||
|
||||
data:
|
||||
- [DATA_1] # Domain knowledge files
|
||||
[[LLM: Example: building-codes.md, legal-terminology.md
|
||||
Can be embedded in pack or required from user]]
|
||||
- id: user-approval
|
||||
title: User Approval
|
||||
type: checklist
|
||||
items:
|
||||
- "Plan reviewed by user"
|
||||
- "Approval to proceed with implementation"
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
- [UTIL_1] # Other utilities as needed
|
||||
[[LLM: Include workflow-management if agent participates in workflows]]
|
||||
```
|
||||
|
||||
@{example: Construction Contractor Agent}
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
```
|
||||
==================== END: templates#agent-tmpl ====================
|
||||
|
||||
==================== START: templates#expansion-pack-plan-tmpl ====================
|
||||
# {Pack Name} Expansion Pack Plan
|
||||
|
||||
## Overview
|
||||
|
||||
- **Pack Name**: {pack-identifier}
|
||||
- **Display Name**: {Full Expansion Pack Name}
|
||||
- **Description**: {Brief description of what this pack does}
|
||||
- **Target Domain**: {Industry/domain this serves}
|
||||
- **Author**: {Your name/organization}
|
||||
|
||||
## Problem Statement
|
||||
|
||||
{What specific challenges does this expansion pack solve?}
|
||||
|
||||
## Target Users
|
||||
|
||||
{Who will benefit from this expansion pack?}
|
||||
|
||||
## Components to Create
|
||||
|
||||
### Agents
|
||||
|
||||
- [ ] `{pack-name}-orchestrator` - **REQUIRED**: Master orchestrator for {domain} workflows
|
||||
- Key commands: {list main commands}
|
||||
- Manages: {what it orchestrates}
|
||||
- [ ] `{agent-1-name}` - {Role description}
|
||||
- Tasks used: {task-1}, {task-2}
|
||||
- Templates used: {template-1}
|
||||
- Data required: {data-file-1}
|
||||
- [ ] `{agent-2-name}` - {Role description}
|
||||
- Tasks used: {task-3}
|
||||
- Templates used: {template-2}
|
||||
- Data required: {data-file-2}
|
||||
|
||||
### Tasks
|
||||
|
||||
- [ ] `{task-1}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-2}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-3}.md` - {Purpose} (used by: {agent})
|
||||
|
||||
### Templates
|
||||
|
||||
- [ ] `{template-1}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
- [ ] `{template-2}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
|
||||
### Checklists
|
||||
|
||||
- [ ] `{checklist-1}-checklist.md` - {What it validates}
|
||||
- [ ] `{checklist-2}-checklist.md` - {What it validates}
|
||||
|
||||
### Data Files Required from User
|
||||
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
|
||||
- [ ] `{data-file-1}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
- [ ] `{data-file-2}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
1. {Step 1 - typically starts with orchestrator}
|
||||
2. {Step 2}
|
||||
3. {Step 3}
|
||||
4. {Final output/deliverable}
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Depends on core agents: {list any core BMad agents used}
|
||||
- Extends teams: {which teams to update}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- [ ] All components created and cross-referenced
|
||||
- [ ] No orphaned task/template references
|
||||
- [ ] Data requirements clearly documented
|
||||
- [ ] Orchestrator provides clear workflow
|
||||
- [ ] README includes setup instructions
|
||||
|
||||
## User Approval
|
||||
|
||||
- [ ] Plan reviewed by user
|
||||
- [ ] Approval to proceed with implementation
|
||||
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
==================== END: templates#expansion-pack-plan-tmpl ====================
|
||||
- id: next-steps
|
||||
content: |
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
==================== END: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml ====================
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
9645
dist/teams/team-all.txt
vendored
9645
dist/teams/team-all.txt
vendored
File diff suppressed because it is too large
Load Diff
9575
dist/teams/team-fullstack.txt
vendored
9575
dist/teams/team-fullstack.txt
vendored
File diff suppressed because it is too large
Load Diff
972
dist/teams/team-ide-minimal.txt
vendored
972
dist/teams/team-ide-minimal.txt
vendored
File diff suppressed because it is too large
Load Diff
8757
dist/teams/team-no-ui.txt
vendored
8757
dist/teams/team-no-ui.txt
vendored
File diff suppressed because it is too large
Load Diff
@@ -1,22 +1,42 @@
|
||||
# BMad Method Guide for Github Copilot
|
||||
# BMad Method Guide for GitHub Copilot
|
||||
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Github Copilot** as your IDE. This command will perform the following actions:
|
||||
When running `npx bmad-method install`, select **GitHub Copilot** as your IDE. This command will perform the following actions:
|
||||
|
||||
- Create the `.bmad-core/` directory with all the agent rule files.
|
||||
- Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
|
||||
- Create a chatmodes file under your .github folder for each specific agent being added
|
||||
|
||||
## Using BMad Agents in VS Code
|
||||
## Using BMAD Agents in GitHub Copilot
|
||||
|
||||
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list.
|
||||
1. **Open GitHub Copilot chat** in VS Code (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux).
|
||||
2. Select the agent you want to use from the chat input's participant selector (e.g., `@workspace` > `dev`).
|
||||
3. The agent adopts that persona for the conversation.
|
||||
4. Use `*help` to see the commands available for the selected agent.
|
||||
|
||||
## VS Code Specific Features
|
||||
## Available Agents
|
||||
|
||||
- **Dynamic Configuration**: When you first invoke an agent (e.g., `@dev`), VS Code will automatically update `.vscode/settings.json` by adding the configuration for that chat mode.
|
||||
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
|
||||
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
|
||||
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.
|
||||
You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot:
|
||||
|
||||
- `bmad-master` - Master Task Executor
|
||||
- `dev` - Development expert
|
||||
- `qa` - Quality Assurance specialist
|
||||
- `ux-expert` - UX specialist
|
||||
|
||||
## GitHub Copilot-Specific Features
|
||||
|
||||
- **Settings**: Use the `.vscode/settings.json` file to configure Copilot behavior. The installer can configure these for you.
|
||||
- `chat.agent.maxRequests`: Maximum requests per agent session (recommended: 15).
|
||||
- `github.copilot.chat.agent.runTasks`: Allow agents to run workspace tasks (e.g., from `package.json` scripts).
|
||||
- `github.copilot.chat.agent.autoFix`: Enable automatic error detection and fixing in generated code.
|
||||
- `chat.tools.autoApprove`: Auto-approve ALL tools without confirmation (use with caution).
|
||||
- **VS Code integration**: Works within VS Code's GitHub Copilot chat panel.
|
||||
- **Tool Confirmation**: Copilot will ask for confirmation before running tools that can modify files. You can approve a tool once, for the session, or always.
|
||||
|
||||
## Tips for GitHub Copilot Users
|
||||
|
||||
- You can use a `.github/copilot-instructions.md` file to provide additional context or instructions for your projects that are not covered by the BMAD framework.
|
||||
- BMAD agents can come with a pre-configured set of tools. You can see which tools an agent uses by looking at the `tools` section in its `.github/chatmodes/[agent].chatmode.md` file.
|
||||
|
||||
@@ -22,7 +22,7 @@ The BMad Method follows a structured approach to AI-assisted software developmen
|
||||
```
|
||||
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or Github Copilot)
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or GitHub Copilot)
|
||||
|
||||
2. **Verify installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
@@ -114,7 +114,7 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
### Chat Management:
|
||||
|
||||
|
||||
@@ -9,5 +9,5 @@ agents:
|
||||
- game-developer
|
||||
- game-sm
|
||||
workflows:
|
||||
- game-dev-greenfield
|
||||
- game-prototype
|
||||
- game-dev-greenfield.md
|
||||
- game-prototype.md
|
||||
|
||||
@@ -3,11 +3,19 @@
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-2d-phaser-game-dev
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game design documentation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
agent:
|
||||
name: Alex
|
||||
id: game-designer
|
||||
@@ -27,12 +35,6 @@ core_principles:
|
||||
- Technical Awareness - Design within feasible implementation constraints
|
||||
- Data-Driven Decisions - Use metrics and feedback to guide design choices
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game design documentation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for design advice'
|
||||
@@ -44,15 +46,15 @@ commands:
|
||||
- '*exit" - Say goodbye as the Game Designer, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- execute-checklist
|
||||
- game-design-brainstorming
|
||||
- create-deep-research-prompt
|
||||
- advanced-elicitation
|
||||
- create-doc.md
|
||||
- execute-checklist.md
|
||||
- game-design-brainstorming.md
|
||||
- create-deep-research-prompt.md
|
||||
- advanced-elicitation.md
|
||||
templates:
|
||||
- game-design-doc-tmpl
|
||||
- level-design-doc-tmpl
|
||||
- game-brief-tmpl
|
||||
- game-design-doc-tmpl.yaml
|
||||
- level-design-doc-tmpl.yaml
|
||||
- game-brief-tmpl.yaml
|
||||
checklists:
|
||||
- game-design-checklist
|
||||
- game-design-checklist.md
|
||||
```
|
||||
|
||||
@@ -3,11 +3,20 @@
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-2d-phaser-game-dev
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Load development guidelines to ensure consistent coding standards
|
||||
- CRITICAL: Do NOT scan docs/stories/ directory automatically during startup
|
||||
- CRITICAL: Do NOT begin any implementation tasks automatically
|
||||
- Wait for user to specify story or ask for story selection
|
||||
- Only load specific story files when user requests implementation
|
||||
agent:
|
||||
name: Maya
|
||||
id: game-developer
|
||||
@@ -28,13 +37,6 @@ core_principles:
|
||||
- Cross-Platform Optimization - Works seamlessly on desktop and mobile
|
||||
- Test-Driven Quality - Comprehensive testing of game logic and systems
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Load development guidelines to ensure consistent coding standards
|
||||
- CRITICAL: Do NOT scan docs/stories/ directory automatically during startup
|
||||
- CRITICAL: Do NOT begin any implementation tasks automatically
|
||||
- Wait for user to specify story or ask for story selection
|
||||
- Only load specific story files when user requests implementation
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode for technical advice'
|
||||
@@ -56,11 +58,11 @@ task-execution:
|
||||
done: Game feature works + Tests pass + 60 FPS + No lint errors + Follows Phaser 3 best practices
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- game-architecture-tmpl
|
||||
- game-architecture-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist
|
||||
- game-story-dod-checklist.md
|
||||
data:
|
||||
- development-guidelines
|
||||
- development-guidelines.md
|
||||
```
|
||||
|
||||
@@ -3,11 +3,20 @@
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-2d-phaser-game-dev
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically execute create-game-story tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- "CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent"
|
||||
agent:
|
||||
name: Jordan
|
||||
id: game-sm
|
||||
@@ -27,13 +36,6 @@ core_principles:
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Game-Specific Context - Understand Phaser 3, game mechanics, and performance requirements
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically execute create-game-story tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- "CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent"
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for game dev advice'
|
||||
@@ -42,10 +44,10 @@ commands:
|
||||
- '*exit" - Say goodbye as the Game Scrum Master, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-game-story
|
||||
- execute-checklist
|
||||
- create-game-story.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- game-story-tmpl
|
||||
- game-story-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist
|
||||
- game-story-dod-checklist.md
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: bmad-2d-phaser-game-dev
|
||||
version: 1.6.0
|
||||
version: 1.8.0
|
||||
short-title: 2D game development with Phaser 3 & TypeScript
|
||||
description: >-
|
||||
2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript
|
||||
|
||||
@@ -57,7 +57,7 @@ Before creating stories, ensure you have:
|
||||
### 3. Template Execution
|
||||
|
||||
**Load Template:**
|
||||
Use `templates#game-story-tmpl` following all embedded LLM instructions
|
||||
Use `{root}/templates/game-story-tmpl.md` following all embedded LLM instructions
|
||||
|
||||
**Key Focus Areas:**
|
||||
|
||||
@@ -93,7 +93,7 @@ Use `templates#game-story-tmpl` following all embedded LLM instructions
|
||||
### 5. Quality Assurance
|
||||
|
||||
**Apply Checklist:**
|
||||
Execute `checklists#game-story-dod-checklist` against completed story
|
||||
Execute `{root}/checklists/game-story-dod-checklist.md` against completed story
|
||||
|
||||
**Story Criteria:**
|
||||
|
||||
|
||||
@@ -1,560 +0,0 @@
|
||||
# {{Game Title}} Game Architecture Document
|
||||
|
||||
[[LLM: This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
||||
|
||||
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.]]
|
||||
|
||||
## Introduction
|
||||
|
||||
[[LLM: Establish the document's purpose and scope for game development]]
|
||||
|
||||
This document outlines the complete technical architecture for {{Game Title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
||||
|
||||
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Technical Overview
|
||||
|
||||
[[LLM: Present all subsections together, then apply `tasks#advanced-elicitation` protocol to the complete section.]]
|
||||
|
||||
### Architecture Summary
|
||||
|
||||
[[LLM: Provide a comprehensive overview covering:
|
||||
|
||||
- Game engine choice and configuration
|
||||
- Project structure and organization
|
||||
- Key systems and their interactions
|
||||
- Performance and optimization strategy
|
||||
- How this architecture achieves GDD requirements]]
|
||||
|
||||
### Platform Targets
|
||||
|
||||
[[LLM: Based on GDD requirements, confirm platform support]]
|
||||
|
||||
**Primary Platform:** {{primary_platform}}
|
||||
**Secondary Platforms:** {{secondary_platforms}}
|
||||
**Minimum Requirements:** {{min_specs}}
|
||||
**Target Performance:** 60 FPS on {{target_device}}
|
||||
|
||||
### Technology Stack
|
||||
|
||||
**Core Engine:** Phaser 3.70+
|
||||
**Language:** TypeScript 5.0+ (Strict Mode)
|
||||
**Build Tool:** {{build_tool}} (Webpack/Vite/Parcel)
|
||||
**Package Manager:** {{package_manager}}
|
||||
**Testing:** {{test_framework}}
|
||||
**Deployment:** {{deployment_platform}}
|
||||
|
||||
## Project Structure
|
||||
|
||||
[[LLM: Define the complete project organization that developers will follow]]
|
||||
|
||||
### Repository Organization
|
||||
|
||||
[[LLM: Design a clear folder structure for game development]]
|
||||
|
||||
```text
|
||||
{{game_name}}/
|
||||
├── src/
|
||||
│ ├── scenes/ # Game scenes
|
||||
│ ├── gameObjects/ # Custom game objects
|
||||
│ ├── systems/ # Core game systems
|
||||
│ ├── utils/ # Utility functions
|
||||
│ ├── types/ # TypeScript type definitions
|
||||
│ ├── config/ # Game configuration
|
||||
│ └── main.ts # Entry point
|
||||
├── assets/
|
||||
│ ├── images/ # Sprite assets
|
||||
│ ├── audio/ # Sound files
|
||||
│ ├── data/ # JSON data files
|
||||
│ └── fonts/ # Font files
|
||||
├── public/ # Static web assets
|
||||
├── tests/ # Test files
|
||||
├── docs/ # Documentation
|
||||
│ ├── stories/ # Development stories
|
||||
│ └── architecture/ # Technical docs
|
||||
└── dist/ # Built game files
|
||||
```
|
||||
|
||||
### Module Organization
|
||||
|
||||
[[LLM: Define how TypeScript modules should be organized]]
|
||||
|
||||
**Scene Structure:**
|
||||
|
||||
- Each scene in separate file
|
||||
- Scene-specific logic contained
|
||||
- Clear data passing between scenes
|
||||
|
||||
**Game Object Pattern:**
|
||||
|
||||
- Component-based architecture
|
||||
- Reusable game object classes
|
||||
- Type-safe property definitions
|
||||
|
||||
**System Architecture:**
|
||||
|
||||
- Singleton managers for global systems
|
||||
- Event-driven communication
|
||||
- Clear separation of concerns
|
||||
|
||||
## Core Game Systems
|
||||
|
||||
[[LLM: Detail each major system that needs to be implemented. Each system should be specific enough for developers to create implementation stories.]]
|
||||
|
||||
### Scene Management System
|
||||
|
||||
**Purpose:** Handle game flow and scene transitions
|
||||
|
||||
**Key Components:**
|
||||
|
||||
- Scene loading and unloading
|
||||
- Data passing between scenes
|
||||
- Transition effects
|
||||
- Memory management
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Preload scene for asset loading
|
||||
- Menu system with navigation
|
||||
- Gameplay scenes with state management
|
||||
- Pause/resume functionality
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/scenes/BootScene.ts`
|
||||
- `src/scenes/PreloadScene.ts`
|
||||
- `src/scenes/MenuScene.ts`
|
||||
- `src/scenes/GameScene.ts`
|
||||
- `src/systems/SceneManager.ts`
|
||||
|
||||
### Game State Management
|
||||
|
||||
**Purpose:** Track player progress and game status
|
||||
|
||||
**State Categories:**
|
||||
|
||||
- Player progress (levels, unlocks)
|
||||
- Game settings (audio, controls)
|
||||
- Session data (current level, score)
|
||||
- Persistent data (achievements, statistics)
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Save/load system with localStorage
|
||||
- State validation and error recovery
|
||||
- Cross-session data persistence
|
||||
- Settings management
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/GameState.ts`
|
||||
- `src/systems/SaveManager.ts`
|
||||
- `src/types/GameData.ts`
|
||||
|
||||
### Asset Management System
|
||||
|
||||
**Purpose:** Efficient loading and management of game assets
|
||||
|
||||
**Asset Categories:**
|
||||
|
||||
- Sprite sheets and animations
|
||||
- Audio files and music
|
||||
- Level data and configurations
|
||||
- UI assets and fonts
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Progressive loading strategy
|
||||
- Asset caching and optimization
|
||||
- Error handling for failed loads
|
||||
- Memory management for large assets
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/AssetManager.ts`
|
||||
- `src/config/AssetConfig.ts`
|
||||
- `src/utils/AssetLoader.ts`
|
||||
|
||||
### Input Management System
|
||||
|
||||
**Purpose:** Handle all player input across platforms
|
||||
|
||||
**Input Types:**
|
||||
|
||||
- Keyboard controls
|
||||
- Mouse/pointer interaction
|
||||
- Touch gestures (mobile)
|
||||
- Gamepad support (optional)
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Input mapping and configuration
|
||||
- Touch-friendly mobile controls
|
||||
- Input buffering for responsive gameplay
|
||||
- Customizable control schemes
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/InputManager.ts`
|
||||
- `src/utils/TouchControls.ts`
|
||||
- `src/types/InputTypes.ts`
|
||||
|
||||
### Game Mechanics Systems
|
||||
|
||||
[[LLM: For each major mechanic defined in the GDD, create a system specification]]
|
||||
|
||||
<<REPEAT section="mechanic_system" count="based_on_gdd">>
|
||||
|
||||
#### {{mechanic_name}} System
|
||||
|
||||
**Purpose:** {{system_purpose}}
|
||||
|
||||
**Core Functionality:**
|
||||
|
||||
- {{feature_1}}
|
||||
- {{feature_2}}
|
||||
- {{feature_3}}
|
||||
|
||||
**Dependencies:** {{required_systems}}
|
||||
|
||||
**Performance Considerations:** {{optimization_notes}}
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/{{SystemName}}.ts`
|
||||
- `src/gameObjects/{{RelatedObject}}.ts`
|
||||
- `src/types/{{SystemTypes}}.ts`
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Physics & Collision System
|
||||
|
||||
**Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
|
||||
|
||||
**Collision Categories:**
|
||||
|
||||
- Player collision
|
||||
- Enemy interactions
|
||||
- Environmental objects
|
||||
- Collectibles and items
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Optimized collision detection
|
||||
- Physics body management
|
||||
- Collision callbacks and events
|
||||
- Performance monitoring
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/PhysicsManager.ts`
|
||||
- `src/utils/CollisionGroups.ts`
|
||||
|
||||
### Audio System
|
||||
|
||||
**Audio Requirements:**
|
||||
|
||||
- Background music with looping
|
||||
- Sound effects for actions
|
||||
- Audio settings and volume control
|
||||
- Mobile audio optimization
|
||||
|
||||
**Implementation Features:**
|
||||
|
||||
- Audio sprite management
|
||||
- Dynamic music system
|
||||
- Spatial audio (if applicable)
|
||||
- Audio pooling for performance
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/AudioManager.ts`
|
||||
- `src/config/AudioConfig.ts`
|
||||
|
||||
### UI System
|
||||
|
||||
**UI Components:**
|
||||
|
||||
- HUD elements (score, health, etc.)
|
||||
- Menu navigation
|
||||
- Modal dialogs
|
||||
- Settings screens
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Responsive layout system
|
||||
- Touch-friendly interface
|
||||
- Keyboard navigation support
|
||||
- Animation and transitions
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/UIManager.ts`
|
||||
- `src/gameObjects/UI/`
|
||||
- `src/types/UITypes.ts`
|
||||
|
||||
## Performance Architecture
|
||||
|
||||
[[LLM: Define performance requirements and optimization strategies]]
|
||||
|
||||
### Performance Targets
|
||||
|
||||
**Frame Rate:** 60 FPS sustained, 30 FPS minimum
|
||||
**Memory Usage:** <{{memory_limit}}MB total
|
||||
**Load Times:** <{{initial_load}}s initial, <{{level_load}}s per level
|
||||
**Battery Optimization:** Reduced updates when not visible
|
||||
|
||||
### Optimization Strategies
|
||||
|
||||
**Object Pooling:**
|
||||
|
||||
- Bullets and projectiles
|
||||
- Particle effects
|
||||
- Enemy objects
|
||||
- UI elements
|
||||
|
||||
**Asset Optimization:**
|
||||
|
||||
- Texture atlases for sprites
|
||||
- Audio compression
|
||||
- Lazy loading for large assets
|
||||
- Progressive enhancement
|
||||
|
||||
**Rendering Optimization:**
|
||||
|
||||
- Sprite batching
|
||||
- Culling off-screen objects
|
||||
- Reduced particle counts on mobile
|
||||
- Texture resolution scaling
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/utils/ObjectPool.ts`
|
||||
- `src/utils/PerformanceMonitor.ts`
|
||||
- `src/config/OptimizationConfig.ts`
|
||||
|
||||
## Game Configuration
|
||||
|
||||
[[LLM: Define all configurable aspects of the game]]
|
||||
|
||||
### Phaser Configuration
|
||||
|
||||
```typescript
|
||||
// src/config/GameConfig.ts
|
||||
const gameConfig: Phaser.Types.Core.GameConfig = {
|
||||
type: Phaser.AUTO,
|
||||
width: {{game_width}},
|
||||
height: {{game_height}},
|
||||
scale: {
|
||||
mode: {{scale_mode}},
|
||||
autoCenter: Phaser.Scale.CENTER_BOTH
|
||||
},
|
||||
physics: {
|
||||
default: '{{physics_system}}',
|
||||
{{physics_system}}: {
|
||||
gravity: { y: {{gravity}} },
|
||||
debug: false
|
||||
}
|
||||
},
|
||||
// Additional configuration...
|
||||
};
|
||||
```
|
||||
|
||||
### Game Balance Configuration
|
||||
|
||||
[[LLM: Based on GDD, define configurable game parameters]]
|
||||
|
||||
```typescript
|
||||
// src/config/GameBalance.ts
|
||||
export const GameBalance = {
|
||||
player: {
|
||||
speed: {{player_speed}},
|
||||
health: {{player_health}},
|
||||
// Additional player parameters...
|
||||
},
|
||||
difficulty: {
|
||||
easy: {{easy_params}},
|
||||
normal: {{normal_params}},
|
||||
hard: {{hard_params}}
|
||||
},
|
||||
// Additional balance parameters...
|
||||
};
|
||||
```
|
||||
|
||||
## Development Guidelines
|
||||
|
||||
[[LLM: Provide coding standards specific to game development]]
|
||||
|
||||
### TypeScript Standards
|
||||
|
||||
**Type Safety:**
|
||||
|
||||
- Use strict mode
|
||||
- Define interfaces for all data structures
|
||||
- Avoid `any` type usage
|
||||
- Use enums for game states
|
||||
|
||||
**Code Organization:**
|
||||
|
||||
- One class per file
|
||||
- Clear naming conventions
|
||||
- Proper error handling
|
||||
- Comprehensive documentation
|
||||
|
||||
### Phaser 3 Best Practices
|
||||
|
||||
**Scene Management:**
|
||||
|
||||
- Clean up resources in shutdown()
|
||||
- Use scene data for communication
|
||||
- Implement proper event handling
|
||||
- Avoid memory leaks
|
||||
|
||||
**Game Object Design:**
|
||||
|
||||
- Extend Phaser classes appropriately
|
||||
- Use component-based architecture
|
||||
- Implement object pooling where needed
|
||||
- Follow consistent update patterns
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
**Unit Testing:**
|
||||
|
||||
- Test game logic separately from Phaser
|
||||
- Mock Phaser dependencies
|
||||
- Test utility functions
|
||||
- Validate game balance calculations
|
||||
|
||||
**Integration Testing:**
|
||||
|
||||
- Scene loading and transitions
|
||||
- Save/load functionality
|
||||
- Input handling
|
||||
- Performance benchmarks
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `tests/utils/GameLogic.test.ts`
|
||||
- `tests/systems/SaveManager.test.ts`
|
||||
- `tests/performance/FrameRate.test.ts`
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
[[LLM: Define how the game will be built and deployed]]
|
||||
|
||||
### Build Process
|
||||
|
||||
**Development Build:**
|
||||
|
||||
- Fast compilation
|
||||
- Source maps enabled
|
||||
- Debug logging active
|
||||
- Hot reload support
|
||||
|
||||
**Production Build:**
|
||||
|
||||
- Minified and optimized
|
||||
- Asset compression
|
||||
- Performance monitoring
|
||||
- Error tracking
|
||||
|
||||
### Deployment Strategy
|
||||
|
||||
**Web Deployment:**
|
||||
|
||||
- Static hosting ({{hosting_platform}})
|
||||
- CDN for assets
|
||||
- Progressive loading
|
||||
- Browser compatibility
|
||||
|
||||
**Mobile Packaging:**
|
||||
|
||||
- Cordova/Capacitor wrapper
|
||||
- Platform-specific optimization
|
||||
- App store requirements
|
||||
- Performance testing
|
||||
|
||||
## Implementation Roadmap
|
||||
|
||||
[[LLM: Break down the architecture implementation into phases that align with the GDD development phases]]
|
||||
|
||||
### Phase 1: Foundation ({{duration}})
|
||||
|
||||
**Core Systems:**
|
||||
|
||||
- Project setup and configuration
|
||||
- Basic scene management
|
||||
- Asset loading pipeline
|
||||
- Input handling framework
|
||||
|
||||
**Story Epics:**
|
||||
|
||||
- "Engine Setup and Configuration"
|
||||
- "Basic Scene Management System"
|
||||
- "Asset Loading Foundation"
|
||||
|
||||
### Phase 2: Game Systems ({{duration}})
|
||||
|
||||
**Gameplay Systems:**
|
||||
|
||||
- {{primary_mechanic}} implementation
|
||||
- Physics and collision system
|
||||
- Game state management
|
||||
- UI framework
|
||||
|
||||
**Story Epics:**
|
||||
|
||||
- "{{Primary_Mechanic}} System Implementation"
|
||||
- "Physics and Collision Framework"
|
||||
- "Game State Management System"
|
||||
|
||||
### Phase 3: Content & Polish ({{duration}})
|
||||
|
||||
**Content Systems:**
|
||||
|
||||
- Level loading and management
|
||||
- Audio system integration
|
||||
- Performance optimization
|
||||
- Final polish and testing
|
||||
|
||||
**Story Epics:**
|
||||
|
||||
- "Level Management System"
|
||||
- "Audio Integration and Optimization"
|
||||
- "Performance Optimization and Testing"
|
||||
|
||||
## Risk Assessment
|
||||
|
||||
[[LLM: Identify potential technical risks and mitigation strategies]]
|
||||
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---------------------------- | ----------- | ---------- | ------------------- |
|
||||
| Performance issues on mobile | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| Asset loading bottlenecks | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| Cross-platform compatibility | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
|
||||
## Success Criteria
|
||||
|
||||
[[LLM: Define measurable technical success criteria]]
|
||||
|
||||
**Technical Metrics:**
|
||||
|
||||
- All systems implemented per specification
|
||||
- Performance targets met consistently
|
||||
- Zero critical bugs in core systems
|
||||
- Successful deployment across target platforms
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- 90%+ test coverage on game logic
|
||||
- Zero TypeScript errors in strict mode
|
||||
- Consistent adherence to coding standards
|
||||
- Comprehensive documentation coverage
|
||||
@@ -0,0 +1,613 @@
|
||||
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"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
||||
|
||||
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
|
||||
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: Establish the document's purpose and scope for game development
|
||||
content: |
|
||||
This document outlines the complete technical architecture for {{game_title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
||||
|
||||
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
|
||||
sections:
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
- id: technical-overview
|
||||
title: Technical Overview
|
||||
instruction: Present all subsections together, then apply `tasks#advanced-elicitation` protocol to the complete section.
|
||||
sections:
|
||||
- id: architecture-summary
|
||||
title: Architecture Summary
|
||||
instruction: |
|
||||
Provide a comprehensive overview covering:
|
||||
|
||||
- Game engine choice and configuration
|
||||
- Project structure and organization
|
||||
- Key systems and their interactions
|
||||
- Performance and optimization strategy
|
||||
- How this architecture achieves GDD requirements
|
||||
- id: platform-targets
|
||||
title: Platform Targets
|
||||
instruction: Based on GDD requirements, confirm platform support
|
||||
template: |
|
||||
**Primary Platform:** {{primary_platform}}
|
||||
**Secondary Platforms:** {{secondary_platforms}}
|
||||
**Minimum Requirements:** {{min_specs}}
|
||||
**Target Performance:** 60 FPS on {{target_device}}
|
||||
- id: technology-stack
|
||||
title: Technology Stack
|
||||
template: |
|
||||
**Core Engine:** Phaser 3.70+
|
||||
**Language:** TypeScript 5.0+ (Strict Mode)
|
||||
**Build Tool:** {{build_tool}} (Webpack/Vite/Parcel)
|
||||
**Package Manager:** {{package_manager}}
|
||||
**Testing:** {{test_framework}}
|
||||
**Deployment:** {{deployment_platform}}
|
||||
|
||||
- id: project-structure
|
||||
title: Project Structure
|
||||
instruction: Define the complete project organization that developers will follow
|
||||
sections:
|
||||
- id: repository-organization
|
||||
title: Repository Organization
|
||||
instruction: Design a clear folder structure for game development
|
||||
type: code
|
||||
language: text
|
||||
template: |
|
||||
{{game_name}}/
|
||||
├── src/
|
||||
│ ├── scenes/ # Game scenes
|
||||
│ ├── gameObjects/ # Custom game objects
|
||||
│ ├── systems/ # Core game systems
|
||||
│ ├── utils/ # Utility functions
|
||||
│ ├── types/ # TypeScript type definitions
|
||||
│ ├── config/ # Game configuration
|
||||
│ └── main.ts # Entry point
|
||||
├── assets/
|
||||
│ ├── images/ # Sprite assets
|
||||
│ ├── audio/ # Sound files
|
||||
│ ├── data/ # JSON data files
|
||||
│ └── fonts/ # Font files
|
||||
├── public/ # Static web assets
|
||||
├── tests/ # Test files
|
||||
├── docs/ # Documentation
|
||||
│ ├── stories/ # Development stories
|
||||
│ └── architecture/ # Technical docs
|
||||
└── dist/ # Built game files
|
||||
- id: module-organization
|
||||
title: Module Organization
|
||||
instruction: Define how TypeScript modules should be organized
|
||||
sections:
|
||||
- id: scene-structure
|
||||
title: Scene Structure
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Each scene in separate file
|
||||
- Scene-specific logic contained
|
||||
- Clear data passing between scenes
|
||||
- id: game-object-pattern
|
||||
title: Game Object Pattern
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Component-based architecture
|
||||
- Reusable game object classes
|
||||
- Type-safe property definitions
|
||||
- id: system-architecture
|
||||
title: System Architecture
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Singleton managers for global systems
|
||||
- Event-driven communication
|
||||
- Clear separation of concerns
|
||||
|
||||
- id: core-game-systems
|
||||
title: Core Game Systems
|
||||
instruction: Detail each major system that needs to be implemented. Each system should be specific enough for developers to create implementation stories.
|
||||
sections:
|
||||
- id: scene-management
|
||||
title: Scene Management System
|
||||
template: |
|
||||
**Purpose:** Handle game flow and scene transitions
|
||||
|
||||
**Key Components:**
|
||||
|
||||
- Scene loading and unloading
|
||||
- Data passing between scenes
|
||||
- Transition effects
|
||||
- Memory management
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Preload scene for asset loading
|
||||
- Menu system with navigation
|
||||
- Gameplay scenes with state management
|
||||
- Pause/resume functionality
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/scenes/BootScene.ts`
|
||||
- `src/scenes/PreloadScene.ts`
|
||||
- `src/scenes/MenuScene.ts`
|
||||
- `src/scenes/GameScene.ts`
|
||||
- `src/systems/SceneManager.ts`
|
||||
- id: game-state-management
|
||||
title: Game State Management
|
||||
template: |
|
||||
**Purpose:** Track player progress and game status
|
||||
|
||||
**State Categories:**
|
||||
|
||||
- Player progress (levels, unlocks)
|
||||
- Game settings (audio, controls)
|
||||
- Session data (current level, score)
|
||||
- Persistent data (achievements, statistics)
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Save/load system with localStorage
|
||||
- State validation and error recovery
|
||||
- Cross-session data persistence
|
||||
- Settings management
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/GameState.ts`
|
||||
- `src/systems/SaveManager.ts`
|
||||
- `src/types/GameData.ts`
|
||||
- id: asset-management
|
||||
title: Asset Management System
|
||||
template: |
|
||||
**Purpose:** Efficient loading and management of game assets
|
||||
|
||||
**Asset Categories:**
|
||||
|
||||
- Sprite sheets and animations
|
||||
- Audio files and music
|
||||
- Level data and configurations
|
||||
- UI assets and fonts
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Progressive loading strategy
|
||||
- Asset caching and optimization
|
||||
- Error handling for failed loads
|
||||
- Memory management for large assets
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/AssetManager.ts`
|
||||
- `src/config/AssetConfig.ts`
|
||||
- `src/utils/AssetLoader.ts`
|
||||
- id: input-management
|
||||
title: Input Management System
|
||||
template: |
|
||||
**Purpose:** Handle all player input across platforms
|
||||
|
||||
**Input Types:**
|
||||
|
||||
- Keyboard controls
|
||||
- Mouse/pointer interaction
|
||||
- Touch gestures (mobile)
|
||||
- Gamepad support (optional)
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Input mapping and configuration
|
||||
- Touch-friendly mobile controls
|
||||
- Input buffering for responsive gameplay
|
||||
- Customizable control schemes
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/InputManager.ts`
|
||||
- `src/utils/TouchControls.ts`
|
||||
- `src/types/InputTypes.ts`
|
||||
- id: game-mechanics-systems
|
||||
title: Game Mechanics Systems
|
||||
instruction: For each major mechanic defined in the GDD, create a system specification
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic-system
|
||||
title: "{{mechanic_name}} System"
|
||||
template: |
|
||||
**Purpose:** {{system_purpose}}
|
||||
|
||||
**Core Functionality:**
|
||||
|
||||
- {{feature_1}}
|
||||
- {{feature_2}}
|
||||
- {{feature_3}}
|
||||
|
||||
**Dependencies:** {{required_systems}}
|
||||
|
||||
**Performance Considerations:** {{optimization_notes}}
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/{{system_name}}.ts`
|
||||
- `src/gameObjects/{{related_object}}.ts`
|
||||
- `src/types/{{system_types}}.ts`
|
||||
- id: physics-collision
|
||||
title: Physics & Collision System
|
||||
template: |
|
||||
**Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
|
||||
|
||||
**Collision Categories:**
|
||||
|
||||
- Player collision
|
||||
- Enemy interactions
|
||||
- Environmental objects
|
||||
- Collectibles and items
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Optimized collision detection
|
||||
- Physics body management
|
||||
- Collision callbacks and events
|
||||
- Performance monitoring
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/PhysicsManager.ts`
|
||||
- `src/utils/CollisionGroups.ts`
|
||||
- id: audio-system
|
||||
title: Audio System
|
||||
template: |
|
||||
**Audio Requirements:**
|
||||
|
||||
- Background music with looping
|
||||
- Sound effects for actions
|
||||
- Audio settings and volume control
|
||||
- Mobile audio optimization
|
||||
|
||||
**Implementation Features:**
|
||||
|
||||
- Audio sprite management
|
||||
- Dynamic music system
|
||||
- Spatial audio (if applicable)
|
||||
- Audio pooling for performance
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/AudioManager.ts`
|
||||
- `src/config/AudioConfig.ts`
|
||||
- id: ui-system
|
||||
title: UI System
|
||||
template: |
|
||||
**UI Components:**
|
||||
|
||||
- HUD elements (score, health, etc.)
|
||||
- Menu navigation
|
||||
- Modal dialogs
|
||||
- Settings screens
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Responsive layout system
|
||||
- Touch-friendly interface
|
||||
- Keyboard navigation support
|
||||
- Animation and transitions
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `src/systems/UIManager.ts`
|
||||
- `src/gameObjects/UI/`
|
||||
- `src/types/UITypes.ts`
|
||||
|
||||
- id: performance-architecture
|
||||
title: Performance Architecture
|
||||
instruction: Define performance requirements and optimization strategies
|
||||
sections:
|
||||
- id: performance-targets
|
||||
title: Performance Targets
|
||||
template: |
|
||||
**Frame Rate:** 60 FPS sustained, 30 FPS minimum
|
||||
**Memory Usage:** <{{memory_limit}}MB total
|
||||
**Load Times:** <{{initial_load}}s initial, <{{level_load}}s per level
|
||||
**Battery Optimization:** Reduced updates when not visible
|
||||
- id: optimization-strategies
|
||||
title: Optimization Strategies
|
||||
sections:
|
||||
- id: object-pooling
|
||||
title: Object Pooling
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Bullets and projectiles
|
||||
- Particle effects
|
||||
- Enemy objects
|
||||
- UI elements
|
||||
- id: asset-optimization
|
||||
title: Asset Optimization
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Texture atlases for sprites
|
||||
- Audio compression
|
||||
- Lazy loading for large assets
|
||||
- Progressive enhancement
|
||||
- id: rendering-optimization
|
||||
title: Rendering Optimization
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Sprite batching
|
||||
- Culling off-screen objects
|
||||
- Reduced particle counts on mobile
|
||||
- Texture resolution scaling
|
||||
- id: optimization-files
|
||||
title: Files to Create
|
||||
type: bullet-list
|
||||
template: |
|
||||
- `src/utils/ObjectPool.ts`
|
||||
- `src/utils/PerformanceMonitor.ts`
|
||||
- `src/config/OptimizationConfig.ts`
|
||||
|
||||
- id: game-configuration
|
||||
title: Game Configuration
|
||||
instruction: Define all configurable aspects of the game
|
||||
sections:
|
||||
- id: phaser-configuration
|
||||
title: Phaser Configuration
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
// src/config/GameConfig.ts
|
||||
const gameConfig: Phaser.Types.Core.GameConfig = {
|
||||
type: Phaser.AUTO,
|
||||
width: {{game_width}},
|
||||
height: {{game_height}},
|
||||
scale: {
|
||||
mode: {{scale_mode}},
|
||||
autoCenter: Phaser.Scale.CENTER_BOTH
|
||||
},
|
||||
physics: {
|
||||
default: '{{physics_system}}',
|
||||
{{physics_system}}: {
|
||||
gravity: { y: {{gravity}} },
|
||||
debug: false
|
||||
}
|
||||
},
|
||||
// Additional configuration...
|
||||
};
|
||||
- id: game-balance-configuration
|
||||
title: Game Balance Configuration
|
||||
instruction: Based on GDD, define configurable game parameters
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
// src/config/GameBalance.ts
|
||||
export const GameBalance = {
|
||||
player: {
|
||||
speed: {{player_speed}},
|
||||
health: {{player_health}},
|
||||
// Additional player parameters...
|
||||
},
|
||||
difficulty: {
|
||||
easy: {{easy_params}},
|
||||
normal: {{normal_params}},
|
||||
hard: {{hard_params}}
|
||||
},
|
||||
// Additional balance parameters...
|
||||
};
|
||||
|
||||
- id: development-guidelines
|
||||
title: Development Guidelines
|
||||
instruction: Provide coding standards specific to game development
|
||||
sections:
|
||||
- id: typescript-standards
|
||||
title: TypeScript Standards
|
||||
sections:
|
||||
- id: type-safety
|
||||
title: Type Safety
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Use strict mode
|
||||
- Define interfaces for all data structures
|
||||
- Avoid `any` type usage
|
||||
- Use enums for game states
|
||||
- id: code-organization
|
||||
title: Code Organization
|
||||
type: bullet-list
|
||||
template: |
|
||||
- One class per file
|
||||
- Clear naming conventions
|
||||
- Proper error handling
|
||||
- Comprehensive documentation
|
||||
- id: phaser-best-practices
|
||||
title: Phaser 3 Best Practices
|
||||
sections:
|
||||
- id: scene-management-practices
|
||||
title: Scene Management
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Clean up resources in shutdown()
|
||||
- Use scene data for communication
|
||||
- Implement proper event handling
|
||||
- Avoid memory leaks
|
||||
- id: game-object-design
|
||||
title: Game Object Design
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Extend Phaser classes appropriately
|
||||
- Use component-based architecture
|
||||
- Implement object pooling where needed
|
||||
- Follow consistent update patterns
|
||||
- id: testing-strategy
|
||||
title: Testing Strategy
|
||||
sections:
|
||||
- id: unit-testing
|
||||
title: Unit Testing
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Test game logic separately from Phaser
|
||||
- Mock Phaser dependencies
|
||||
- Test utility functions
|
||||
- Validate game balance calculations
|
||||
- id: integration-testing
|
||||
title: Integration Testing
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Scene loading and transitions
|
||||
- Save/load functionality
|
||||
- Input handling
|
||||
- Performance benchmarks
|
||||
- id: test-files
|
||||
title: Files to Create
|
||||
type: bullet-list
|
||||
template: |
|
||||
- `tests/utils/GameLogic.test.ts`
|
||||
- `tests/systems/SaveManager.test.ts`
|
||||
- `tests/performance/FrameRate.test.ts`
|
||||
|
||||
- id: deployment-architecture
|
||||
title: Deployment Architecture
|
||||
instruction: Define how the game will be built and deployed
|
||||
sections:
|
||||
- id: build-process
|
||||
title: Build Process
|
||||
sections:
|
||||
- id: development-build
|
||||
title: Development Build
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Fast compilation
|
||||
- Source maps enabled
|
||||
- Debug logging active
|
||||
- Hot reload support
|
||||
- id: production-build
|
||||
title: Production Build
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Minified and optimized
|
||||
- Asset compression
|
||||
- Performance monitoring
|
||||
- Error tracking
|
||||
- id: deployment-strategy
|
||||
title: Deployment Strategy
|
||||
sections:
|
||||
- id: web-deployment
|
||||
title: Web Deployment
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Static hosting ({{hosting_platform}})
|
||||
- CDN for assets
|
||||
- Progressive loading
|
||||
- Browser compatibility
|
||||
- id: mobile-packaging
|
||||
title: Mobile Packaging
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Cordova/Capacitor wrapper
|
||||
- Platform-specific optimization
|
||||
- App store requirements
|
||||
- Performance testing
|
||||
|
||||
- id: implementation-roadmap
|
||||
title: Implementation Roadmap
|
||||
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}})"
|
||||
sections:
|
||||
- id: phase-1-core
|
||||
title: Core Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Project setup and configuration
|
||||
- Basic scene management
|
||||
- Asset loading pipeline
|
||||
- Input handling framework
|
||||
- id: phase-1-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "Engine Setup and Configuration"
|
||||
- "Basic Scene Management System"
|
||||
- "Asset Loading Foundation"
|
||||
- id: phase-2-game-systems
|
||||
title: "Phase 2: Game Systems ({{duration}})"
|
||||
sections:
|
||||
- id: phase-2-gameplay
|
||||
title: Gameplay Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- {{primary_mechanic}} implementation
|
||||
- Physics and collision system
|
||||
- Game state management
|
||||
- UI framework
|
||||
- id: phase-2-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "{{primary_mechanic}} System Implementation"
|
||||
- "Physics and Collision Framework"
|
||||
- "Game State Management System"
|
||||
- id: phase-3-content-polish
|
||||
title: "Phase 3: Content & Polish ({{duration}})"
|
||||
sections:
|
||||
- id: phase-3-content
|
||||
title: Content Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Level loading and management
|
||||
- Audio system integration
|
||||
- Performance optimization
|
||||
- Final polish and testing
|
||||
- id: phase-3-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "Level Management System"
|
||||
- "Audio Integration and Optimization"
|
||||
- "Performance Optimization and Testing"
|
||||
|
||||
- id: risk-assessment
|
||||
title: Risk Assessment
|
||||
instruction: Identify potential technical risks and mitigation strategies
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---------------------------- | ----------- | ---------- | ------------------- |
|
||||
| Performance issues on mobile | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| Asset loading bottlenecks | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| Cross-platform compatibility | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
instruction: Define measurable technical success criteria
|
||||
sections:
|
||||
- id: technical-metrics
|
||||
title: Technical Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- All systems implemented per specification
|
||||
- Performance targets met consistently
|
||||
- Zero critical bugs in core systems
|
||||
- Successful deployment across target platforms
|
||||
- id: code-quality
|
||||
title: Code Quality
|
||||
type: bullet-list
|
||||
template: |
|
||||
- 90%+ test coverage on game logic
|
||||
- Zero TypeScript errors in strict mode
|
||||
- Consistent adherence to coding standards
|
||||
- Comprehensive documentation coverage
|
||||
@@ -1,345 +0,0 @@
|
||||
# {{Game Title}} Game Brief
|
||||
|
||||
[[LLM: This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||
|
||||
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.]]
|
||||
|
||||
## Game Vision
|
||||
|
||||
[[LLM: Establish the core vision and identity of the game. Present each subsection and gather user feedback before proceeding.]]
|
||||
|
||||
### Core Concept
|
||||
|
||||
[[LLM: 2-3 sentences that clearly capture what the game is and why it will be compelling to players]]
|
||||
|
||||
### Elevator Pitch
|
||||
|
||||
[[LLM: Single sentence that captures the essence of the game in a memorable way]]
|
||||
|
||||
**"{{game_description_in_one_sentence}}"**
|
||||
|
||||
### Vision Statement
|
||||
|
||||
[[LLM: Inspirational statement about what the game will achieve for players and why it matters]]
|
||||
|
||||
## Target Market
|
||||
|
||||
[[LLM: Define the audience and market context. Apply `tasks#advanced-elicitation` after presenting this section.]]
|
||||
|
||||
### Primary Audience
|
||||
|
||||
**Demographics:** {{age_range}}, {{platform_preference}}, {{gaming_experience}}
|
||||
**Psychographics:** {{interests}}, {{motivations}}, {{play_patterns}}
|
||||
**Gaming Preferences:** {{preferred_genres}}, {{session_length}}, {{difficulty_preference}}
|
||||
|
||||
### Secondary Audiences
|
||||
|
||||
**Audience 2:** {{description}}
|
||||
**Audience 3:** {{description}}
|
||||
|
||||
### Market Context
|
||||
|
||||
**Genre:** {{primary_genre}} / {{secondary_genre}}
|
||||
**Platform Strategy:** {{platform_focus}}
|
||||
**Competitive Positioning:** {{differentiation_statement}}
|
||||
|
||||
## Game Fundamentals
|
||||
|
||||
[[LLM: Define the core gameplay elements. Each subsection should be specific enough to guide detailed design work.]]
|
||||
|
||||
### Core Gameplay Pillars
|
||||
|
||||
[[LLM: 3-5 fundamental principles that guide all design decisions]]
|
||||
|
||||
1. **{{pillar_1}}** - {{description_and_rationale}}
|
||||
2. **{{pillar_2}}** - {{description_and_rationale}}
|
||||
3. **{{pillar_3}}** - {{description_and_rationale}}
|
||||
|
||||
### Primary Mechanics
|
||||
|
||||
[[LLM: List the 3-5 most important gameplay mechanics that define the player experience]]
|
||||
|
||||
**Core Mechanic 1: {{mechanic_name}}**
|
||||
|
||||
- **Description:** {{how_it_works}}
|
||||
- **Player Value:** {{why_its_fun}}
|
||||
- **Implementation Scope:** {{complexity_estimate}}
|
||||
|
||||
**Core Mechanic 2: {{mechanic_name}}**
|
||||
|
||||
- **Description:** {{how_it_works}}
|
||||
- **Player Value:** {{why_its_fun}}
|
||||
- **Implementation Scope:** {{complexity_estimate}}
|
||||
|
||||
### Player Experience Goals
|
||||
|
||||
[[LLM: Define what emotions and experiences the game should create for players]]
|
||||
|
||||
**Primary Experience:** {{main_emotional_goal}}
|
||||
**Secondary Experiences:** {{supporting_emotional_goals}}
|
||||
**Engagement Pattern:** {{how_player_engagement_evolves}}
|
||||
|
||||
## Scope and Constraints
|
||||
|
||||
[[LLM: Define the boundaries and limitations that will shape development. Apply `tasks#advanced-elicitation` to clarify any constraints.]]
|
||||
|
||||
### Project Scope
|
||||
|
||||
**Game Length:** {{estimated_content_hours}}
|
||||
**Content Volume:** {{levels_areas_content_amount}}
|
||||
**Feature Complexity:** {{simple|moderate|complex}}
|
||||
**Scope Comparison:** "Similar to {{reference_game}} but with {{key_differences}}"
|
||||
|
||||
### Technical Constraints
|
||||
|
||||
**Platform Requirements:**
|
||||
|
||||
- Primary: {{platform_1}} - {{requirements}}
|
||||
- Secondary: {{platform_2}} - {{requirements}}
|
||||
|
||||
**Technical Specifications:**
|
||||
|
||||
- Engine: Phaser 3 + TypeScript
|
||||
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
||||
- Memory Budget: <{{memory_limit}}MB
|
||||
- Load Time Goal: <{{load_time_seconds}}s
|
||||
|
||||
### Resource Constraints
|
||||
|
||||
**Team Size:** {{team_composition}}
|
||||
**Timeline:** {{development_duration}}
|
||||
**Budget Considerations:** {{budget_constraints_or_targets}}
|
||||
**Asset Requirements:** {{art_audio_content_needs}}
|
||||
|
||||
### Business Constraints
|
||||
|
||||
^^CONDITION: has_business_goals^^
|
||||
|
||||
**Monetization Model:** {{free|premium|freemium|subscription}}
|
||||
**Revenue Goals:** {{revenue_targets_if_applicable}}
|
||||
**Platform Requirements:** {{store_certification_needs}}
|
||||
**Launch Timeline:** {{target_launch_window}}
|
||||
|
||||
^^/CONDITION: has_business_goals^^
|
||||
|
||||
## Reference Framework
|
||||
|
||||
[[LLM: Provide context through references and competitive analysis]]
|
||||
|
||||
### Inspiration Games
|
||||
|
||||
**Primary References:**
|
||||
|
||||
1. **{{reference_game_1}}** - {{what_we_learn_from_it}}
|
||||
2. **{{reference_game_2}}** - {{what_we_learn_from_it}}
|
||||
3. **{{reference_game_3}}** - {{what_we_learn_from_it}}
|
||||
|
||||
### Competitive Analysis
|
||||
|
||||
**Direct Competitors:**
|
||||
|
||||
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
||||
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
||||
|
||||
**Differentiation Strategy:**
|
||||
{{how_we_differ_and_why_thats_valuable}}
|
||||
|
||||
### Market Opportunity
|
||||
|
||||
**Market Gap:** {{underserved_need_or_opportunity}}
|
||||
**Timing Factors:** {{why_now_is_the_right_time}}
|
||||
**Success Metrics:** {{how_well_measure_success}}
|
||||
|
||||
## Content Framework
|
||||
|
||||
[[LLM: Outline the content structure and progression without full design detail]]
|
||||
|
||||
### Game Structure
|
||||
|
||||
**Overall Flow:** {{linear|hub_world|open_world|procedural}}
|
||||
**Progression Model:** {{how_players_advance}}
|
||||
**Session Structure:** {{typical_play_session_flow}}
|
||||
|
||||
### Content Categories
|
||||
|
||||
**Core Content:**
|
||||
|
||||
- {{content_type_1}}: {{quantity_and_description}}
|
||||
- {{content_type_2}}: {{quantity_and_description}}
|
||||
|
||||
**Optional Content:**
|
||||
|
||||
- {{optional_content_type}}: {{quantity_and_description}}
|
||||
|
||||
**Replay Elements:**
|
||||
|
||||
- {{replayability_features}}
|
||||
|
||||
### Difficulty and Accessibility
|
||||
|
||||
**Difficulty Approach:** {{how_challenge_is_structured}}
|
||||
**Accessibility Features:** {{planned_accessibility_support}}
|
||||
**Skill Requirements:** {{what_skills_players_need}}
|
||||
|
||||
## Art and Audio Direction
|
||||
|
||||
[[LLM: Establish the aesthetic vision that will guide asset creation]]
|
||||
|
||||
### Visual Style
|
||||
|
||||
**Art Direction:** {{style_description}}
|
||||
**Reference Materials:** {{visual_inspiration_sources}}
|
||||
**Technical Approach:** {{2d_style_pixel_vector_etc}}
|
||||
**Color Strategy:** {{color_palette_mood}}
|
||||
|
||||
### Audio Direction
|
||||
|
||||
**Music Style:** {{genre_and_mood}}
|
||||
**Sound Design:** {{audio_personality}}
|
||||
**Implementation Needs:** {{technical_audio_requirements}}
|
||||
|
||||
### UI/UX Approach
|
||||
|
||||
**Interface Style:** {{ui_aesthetic}}
|
||||
**User Experience Goals:** {{ux_priorities}}
|
||||
**Platform Adaptations:** {{cross_platform_considerations}}
|
||||
|
||||
## Risk Assessment
|
||||
|
||||
[[LLM: Identify potential challenges and mitigation strategies]]
|
||||
|
||||
### Technical Risks
|
||||
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| -------------------- | ----------- | ------ | ------------------- | ------ | --- | ----- | ----------------------- |
|
||||
| {{technical_risk_1}} | {{high | med | low}} | {{high | med | low}} | {{mitigation_approach}} |
|
||||
| {{technical_risk_2}} | {{high | med | low}} | {{high | med | low}} | {{mitigation_approach}} |
|
||||
|
||||
### Design Risks
|
||||
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ----------------- | ----------- | ------ | ------------------- | ------ | --- | ----- | ----------------------- |
|
||||
| {{design_risk_1}} | {{high | med | low}} | {{high | med | low}} | {{mitigation_approach}} |
|
||||
| {{design_risk_2}} | {{high | med | low}} | {{high | med | low}} | {{mitigation_approach}} |
|
||||
|
||||
### Market Risks
|
||||
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ----------------- | ----------- | ------ | ------------------- | ------ | --- | ----- | ----------------------- |
|
||||
| {{market_risk_1}} | {{high | med | low}} | {{high | med | low}} | {{mitigation_approach}} |
|
||||
|
||||
## Success Criteria
|
||||
|
||||
[[LLM: Define measurable goals for the project]]
|
||||
|
||||
### Player Experience Metrics
|
||||
|
||||
**Engagement Goals:**
|
||||
|
||||
- Tutorial completion rate: >{{percentage}}%
|
||||
- Average session length: {{duration}} minutes
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
||||
|
||||
**Quality Benchmarks:**
|
||||
|
||||
- Player satisfaction: >{{rating}}/10
|
||||
- Completion rate: >{{percentage}}%
|
||||
- Technical performance: {{fps_target}} FPS consistent
|
||||
|
||||
### Development Metrics
|
||||
|
||||
**Technical Targets:**
|
||||
|
||||
- Zero critical bugs at launch
|
||||
- Performance targets met on all platforms
|
||||
- Load times under {{seconds}}s
|
||||
|
||||
**Process Goals:**
|
||||
|
||||
- Development timeline adherence
|
||||
- Feature scope completion
|
||||
- Quality assurance standards
|
||||
|
||||
^^CONDITION: has_business_goals^^
|
||||
|
||||
### Business Metrics
|
||||
|
||||
**Commercial Goals:**
|
||||
|
||||
- {{revenue_target}} in first {{time_period}}
|
||||
- {{user_acquisition_target}} players in first {{time_period}}
|
||||
- {{retention_target}} monthly active users
|
||||
|
||||
^^/CONDITION: has_business_goals^^
|
||||
|
||||
## Next Steps
|
||||
|
||||
[[LLM: Define immediate actions following the brief completion]]
|
||||
|
||||
### Immediate Actions
|
||||
|
||||
1. **Stakeholder Review** - {{review_process_and_timeline}}
|
||||
2. **Concept Validation** - {{validation_approach}}
|
||||
3. **Resource Planning** - {{team_and_resource_allocation}}
|
||||
|
||||
### Development Roadmap
|
||||
|
||||
**Phase 1: Pre-Production** ({{duration}})
|
||||
|
||||
- Detailed Game Design Document creation
|
||||
- Technical architecture planning
|
||||
- Art style exploration and pipeline setup
|
||||
|
||||
**Phase 2: Prototype** ({{duration}})
|
||||
|
||||
- Core mechanic implementation
|
||||
- Technical proof of concept
|
||||
- Initial playtesting and iteration
|
||||
|
||||
**Phase 3: Production** ({{duration}})
|
||||
|
||||
- Full feature development
|
||||
- Content creation and integration
|
||||
- Comprehensive testing and optimization
|
||||
|
||||
### Documentation Pipeline
|
||||
|
||||
**Required Documents:**
|
||||
|
||||
1. Game Design Document (GDD) - {{target_completion}}
|
||||
2. Technical Architecture Document - {{target_completion}}
|
||||
3. Art Style Guide - {{target_completion}}
|
||||
4. Production Plan - {{target_completion}}
|
||||
|
||||
### Validation Plan
|
||||
|
||||
**Concept Testing:**
|
||||
|
||||
- {{validation_method_1}} - {{timeline}}
|
||||
- {{validation_method_2}} - {{timeline}}
|
||||
|
||||
**Prototype Testing:**
|
||||
|
||||
- {{testing_approach}} - {{timeline}}
|
||||
- {{feedback_collection_method}} - {{timeline}}
|
||||
|
||||
## Appendices
|
||||
|
||||
### Research Materials
|
||||
|
||||
[[LLM: Include any supporting research, competitive analysis, or market data that informed the brief]]
|
||||
|
||||
### Brainstorming Session Notes
|
||||
|
||||
[[LLM: Reference any brainstorming sessions that led to this brief]]
|
||||
|
||||
### Stakeholder Input
|
||||
|
||||
[[LLM: Include key input from stakeholders that shaped the vision]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
@@ -0,0 +1,356 @@
|
||||
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"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||
|
||||
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
||||
|
||||
- id: game-vision
|
||||
title: Game Vision
|
||||
instruction: Establish the core vision and identity of the game. Present each subsection and gather user feedback before proceeding.
|
||||
sections:
|
||||
- id: core-concept
|
||||
title: Core Concept
|
||||
instruction: 2-3 sentences that clearly capture what the game is and why it will be compelling to players
|
||||
- id: elevator-pitch
|
||||
title: Elevator Pitch
|
||||
instruction: Single sentence that captures the essence of the game in a memorable way
|
||||
template: |
|
||||
**"{{game_description_in_one_sentence}}"**
|
||||
- id: vision-statement
|
||||
title: Vision Statement
|
||||
instruction: Inspirational statement about what the game will achieve for players and why it matters
|
||||
|
||||
- id: target-market
|
||||
title: Target Market
|
||||
instruction: Define the audience and market context. Apply `tasks#advanced-elicitation` after presenting this section.
|
||||
sections:
|
||||
- id: primary-audience
|
||||
title: Primary Audience
|
||||
template: |
|
||||
**Demographics:** {{age_range}}, {{platform_preference}}, {{gaming_experience}}
|
||||
**Psychographics:** {{interests}}, {{motivations}}, {{play_patterns}}
|
||||
**Gaming Preferences:** {{preferred_genres}}, {{session_length}}, {{difficulty_preference}}
|
||||
- id: secondary-audiences
|
||||
title: Secondary Audiences
|
||||
template: |
|
||||
**Audience 2:** {{description}}
|
||||
**Audience 3:** {{description}}
|
||||
- id: market-context
|
||||
title: Market Context
|
||||
template: |
|
||||
**Genre:** {{primary_genre}} / {{secondary_genre}}
|
||||
**Platform Strategy:** {{platform_focus}}
|
||||
**Competitive Positioning:** {{differentiation_statement}}
|
||||
|
||||
- id: game-fundamentals
|
||||
title: Game Fundamentals
|
||||
instruction: Define the core gameplay elements. Each subsection should be specific enough to guide detailed design work.
|
||||
sections:
|
||||
- id: core-gameplay-pillars
|
||||
title: Core Gameplay Pillars
|
||||
instruction: 3-5 fundamental principles that guide all design decisions
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{pillar_name}}** - {{description_and_rationale}}
|
||||
- id: primary-mechanics
|
||||
title: Primary Mechanics
|
||||
instruction: List the 3-5 most important gameplay mechanics that define the player experience
|
||||
repeatable: true
|
||||
template: |
|
||||
**Core Mechanic: {{mechanic_name}}**
|
||||
|
||||
- **Description:** {{how_it_works}}
|
||||
- **Player Value:** {{why_its_fun}}
|
||||
- **Implementation Scope:** {{complexity_estimate}}
|
||||
- id: player-experience-goals
|
||||
title: Player Experience Goals
|
||||
instruction: Define what emotions and experiences the game should create for players
|
||||
template: |
|
||||
**Primary Experience:** {{main_emotional_goal}}
|
||||
**Secondary Experiences:** {{supporting_emotional_goals}}
|
||||
**Engagement Pattern:** {{how_player_engagement_evolves}}
|
||||
|
||||
- id: scope-constraints
|
||||
title: Scope and Constraints
|
||||
instruction: Define the boundaries and limitations that will shape development. Apply `tasks#advanced-elicitation` to clarify any constraints.
|
||||
sections:
|
||||
- id: project-scope
|
||||
title: Project Scope
|
||||
template: |
|
||||
**Game Length:** {{estimated_content_hours}}
|
||||
**Content Volume:** {{levels_areas_content_amount}}
|
||||
**Feature Complexity:** {{simple|moderate|complex}}
|
||||
**Scope Comparison:** "Similar to {{reference_game}} but with {{key_differences}}"
|
||||
- id: technical-constraints
|
||||
title: Technical Constraints
|
||||
template: |
|
||||
**Platform Requirements:**
|
||||
|
||||
- Primary: {{platform_1}} - {{requirements}}
|
||||
- Secondary: {{platform_2}} - {{requirements}}
|
||||
|
||||
**Technical Specifications:**
|
||||
|
||||
- Engine: Phaser 3 + TypeScript
|
||||
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
||||
- Memory Budget: <{{memory_limit}}MB
|
||||
- Load Time Goal: <{{load_time_seconds}}s
|
||||
- id: resource-constraints
|
||||
title: Resource Constraints
|
||||
template: |
|
||||
**Team Size:** {{team_composition}}
|
||||
**Timeline:** {{development_duration}}
|
||||
**Budget Considerations:** {{budget_constraints_or_targets}}
|
||||
**Asset Requirements:** {{art_audio_content_needs}}
|
||||
- id: business-constraints
|
||||
title: Business Constraints
|
||||
condition: has_business_goals
|
||||
template: |
|
||||
**Monetization Model:** {{free|premium|freemium|subscription}}
|
||||
**Revenue Goals:** {{revenue_targets_if_applicable}}
|
||||
**Platform Requirements:** {{store_certification_needs}}
|
||||
**Launch Timeline:** {{target_launch_window}}
|
||||
|
||||
- id: reference-framework
|
||||
title: Reference Framework
|
||||
instruction: Provide context through references and competitive analysis
|
||||
sections:
|
||||
- id: inspiration-games
|
||||
title: Inspiration Games
|
||||
sections:
|
||||
- id: primary-references
|
||||
title: Primary References
|
||||
type: numbered-list
|
||||
repeatable: true
|
||||
template: |
|
||||
**{{reference_game}}** - {{what_we_learn_from_it}}
|
||||
- id: competitive-analysis
|
||||
title: Competitive Analysis
|
||||
template: |
|
||||
**Direct Competitors:**
|
||||
|
||||
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
||||
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
||||
|
||||
**Differentiation Strategy:**
|
||||
{{how_we_differ_and_why_thats_valuable}}
|
||||
- id: market-opportunity
|
||||
title: Market Opportunity
|
||||
template: |
|
||||
**Market Gap:** {{underserved_need_or_opportunity}}
|
||||
**Timing Factors:** {{why_now_is_the_right_time}}
|
||||
**Success Metrics:** {{how_well_measure_success}}
|
||||
|
||||
- id: content-framework
|
||||
title: Content Framework
|
||||
instruction: Outline the content structure and progression without full design detail
|
||||
sections:
|
||||
- id: game-structure
|
||||
title: Game Structure
|
||||
template: |
|
||||
**Overall Flow:** {{linear|hub_world|open_world|procedural}}
|
||||
**Progression Model:** {{how_players_advance}}
|
||||
**Session Structure:** {{typical_play_session_flow}}
|
||||
- id: content-categories
|
||||
title: Content Categories
|
||||
template: |
|
||||
**Core Content:**
|
||||
|
||||
- {{content_type_1}}: {{quantity_and_description}}
|
||||
- {{content_type_2}}: {{quantity_and_description}}
|
||||
|
||||
**Optional Content:**
|
||||
|
||||
- {{optional_content_type}}: {{quantity_and_description}}
|
||||
|
||||
**Replay Elements:**
|
||||
|
||||
- {{replayability_features}}
|
||||
- id: difficulty-accessibility
|
||||
title: Difficulty and Accessibility
|
||||
template: |
|
||||
**Difficulty Approach:** {{how_challenge_is_structured}}
|
||||
**Accessibility Features:** {{planned_accessibility_support}}
|
||||
**Skill Requirements:** {{what_skills_players_need}}
|
||||
|
||||
- id: art-audio-direction
|
||||
title: Art and Audio Direction
|
||||
instruction: Establish the aesthetic vision that will guide asset creation
|
||||
sections:
|
||||
- id: visual-style
|
||||
title: Visual Style
|
||||
template: |
|
||||
**Art Direction:** {{style_description}}
|
||||
**Reference Materials:** {{visual_inspiration_sources}}
|
||||
**Technical Approach:** {{2d_style_pixel_vector_etc}}
|
||||
**Color Strategy:** {{color_palette_mood}}
|
||||
- id: audio-direction
|
||||
title: Audio Direction
|
||||
template: |
|
||||
**Music Style:** {{genre_and_mood}}
|
||||
**Sound Design:** {{audio_personality}}
|
||||
**Implementation Needs:** {{technical_audio_requirements}}
|
||||
- id: ui-ux-approach
|
||||
title: UI/UX Approach
|
||||
template: |
|
||||
**Interface Style:** {{ui_aesthetic}}
|
||||
**User Experience Goals:** {{ux_priorities}}
|
||||
**Platform Adaptations:** {{cross_platform_considerations}}
|
||||
|
||||
- id: risk-assessment
|
||||
title: Risk Assessment
|
||||
instruction: Identify potential challenges and mitigation strategies
|
||||
sections:
|
||||
- id: technical-risks
|
||||
title: Technical Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{technical_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
- id: design-risks
|
||||
title: Design Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{design_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
- id: market-risks
|
||||
title: Market Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{market_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
instruction: Define measurable goals for the project
|
||||
sections:
|
||||
- id: player-experience-metrics
|
||||
title: Player Experience Metrics
|
||||
template: |
|
||||
**Engagement Goals:**
|
||||
|
||||
- Tutorial completion rate: >{{percentage}}%
|
||||
- Average session length: {{duration}} minutes
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
||||
|
||||
**Quality Benchmarks:**
|
||||
|
||||
- Player satisfaction: >{{rating}}/10
|
||||
- Completion rate: >{{percentage}}%
|
||||
- Technical performance: {{fps_target}} FPS consistent
|
||||
- id: development-metrics
|
||||
title: Development Metrics
|
||||
template: |
|
||||
**Technical Targets:**
|
||||
|
||||
- Zero critical bugs at launch
|
||||
- Performance targets met on all platforms
|
||||
- Load times under {{seconds}}s
|
||||
|
||||
**Process Goals:**
|
||||
|
||||
- Development timeline adherence
|
||||
- Feature scope completion
|
||||
- Quality assurance standards
|
||||
- id: business-metrics
|
||||
title: Business Metrics
|
||||
condition: has_business_goals
|
||||
template: |
|
||||
**Commercial Goals:**
|
||||
|
||||
- {{revenue_target}} in first {{time_period}}
|
||||
- {{user_acquisition_target}} players in first {{time_period}}
|
||||
- {{retention_target}} monthly active users
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
instruction: Define immediate actions following the brief completion
|
||||
sections:
|
||||
- id: immediate-actions
|
||||
title: Immediate Actions
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{action_item}}** - {{details_and_timeline}}
|
||||
- id: development-roadmap
|
||||
title: Development Roadmap
|
||||
sections:
|
||||
- id: phase-1-preproduction
|
||||
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}})"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Core mechanic implementation
|
||||
- Technical proof of concept
|
||||
- Initial playtesting and iteration
|
||||
- id: phase-3-production
|
||||
title: "Phase 3: Production ({{duration}})"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Full feature development
|
||||
- Content creation and integration
|
||||
- Comprehensive testing and optimization
|
||||
- id: documentation-pipeline
|
||||
title: Documentation Pipeline
|
||||
sections:
|
||||
- id: required-documents
|
||||
title: Required Documents
|
||||
type: numbered-list
|
||||
template: |
|
||||
Game Design Document (GDD) - {{target_completion}}
|
||||
Technical Architecture Document - {{target_completion}}
|
||||
Art Style Guide - {{target_completion}}
|
||||
Production Plan - {{target_completion}}
|
||||
- id: validation-plan
|
||||
title: Validation Plan
|
||||
template: |
|
||||
**Concept Testing:**
|
||||
|
||||
- {{validation_method_1}} - {{timeline}}
|
||||
- {{validation_method_2}} - {{timeline}}
|
||||
|
||||
**Prototype Testing:**
|
||||
|
||||
- {{testing_approach}} - {{timeline}}
|
||||
- {{feedback_collection_method}} - {{timeline}}
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: research-materials
|
||||
title: Research Materials
|
||||
instruction: Include any supporting research, competitive analysis, or market data that informed the brief
|
||||
- id: brainstorming-notes
|
||||
title: Brainstorming Session Notes
|
||||
instruction: Reference any brainstorming sessions that led to this brief
|
||||
- id: stakeholder-input
|
||||
title: Stakeholder Input
|
||||
instruction: Include key input from stakeholders that shaped the vision
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
@@ -1,331 +0,0 @@
|
||||
# {{Game Title}} Game Design Document (GDD)
|
||||
|
||||
[[LLM: This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||
|
||||
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis]]
|
||||
|
||||
## Executive Summary
|
||||
|
||||
[[LLM: Create a compelling overview that captures the essence of the game. Present this section first and get user feedback before proceeding.]]
|
||||
|
||||
### Core Concept
|
||||
|
||||
[[LLM: 2-3 sentences that clearly describe what the game is and why players will love it]]
|
||||
|
||||
### Target Audience
|
||||
|
||||
[[LLM: Define the primary and secondary audience with demographics and gaming preferences]]
|
||||
|
||||
**Primary:** {{age_range}}, {{player_type}}, {{platform_preference}}
|
||||
**Secondary:** {{secondary_audience}}
|
||||
|
||||
### Platform & Technical Requirements
|
||||
|
||||
[[LLM: Based on the technical preferences or user input, define the target platforms]]
|
||||
|
||||
**Primary Platform:** {{platform}}
|
||||
**Engine:** Phaser 3 + TypeScript
|
||||
**Performance Target:** 60 FPS on {{minimum_device}}
|
||||
**Screen Support:** {{resolution_range}}
|
||||
|
||||
### Unique Selling Points
|
||||
|
||||
[[LLM: List 3-5 key features that differentiate this game from competitors]]
|
||||
|
||||
1. {{usp_1}}
|
||||
2. {{usp_2}}
|
||||
3. {{usp_3}}
|
||||
|
||||
## Core Gameplay
|
||||
|
||||
[[LLM: This section defines the fundamental game mechanics. After presenting each subsection, apply `tasks#advanced-elicitation` protocol to ensure completeness.]]
|
||||
|
||||
### Game Pillars
|
||||
|
||||
[[LLM: Define 3-5 core pillars that guide all design decisions. These should be specific and actionable.]]
|
||||
|
||||
1. **{{pillar_1}}** - {{description}}
|
||||
2. **{{pillar_2}}** - {{description}}
|
||||
3. **{{pillar_3}}** - {{description}}
|
||||
|
||||
### Core Gameplay Loop
|
||||
|
||||
[[LLM: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.]]
|
||||
|
||||
**Primary Loop ({{duration}} seconds):**
|
||||
|
||||
1. {{action_1}} ({{time_1}}s)
|
||||
2. {{action_2}} ({{time_2}}s)
|
||||
3. {{action_3}} ({{time_3}}s)
|
||||
4. {{reward_feedback}} ({{time_4}}s)
|
||||
|
||||
### Win/Loss Conditions
|
||||
|
||||
[[LLM: Clearly define success and failure states]]
|
||||
|
||||
**Victory Conditions:**
|
||||
|
||||
- {{win_condition_1}}
|
||||
- {{win_condition_2}}
|
||||
|
||||
**Failure States:**
|
||||
|
||||
- {{loss_condition_1}}
|
||||
- {{loss_condition_2}}
|
||||
|
||||
## Game Mechanics
|
||||
|
||||
[[LLM: Detail each major mechanic that will need to be implemented. Each mechanic should be specific enough for developers to create implementation stories.]]
|
||||
|
||||
### Primary Mechanics
|
||||
|
||||
<<REPEAT section="mechanic" count="3-5">>
|
||||
|
||||
#### {{mechanic_name}}
|
||||
|
||||
**Description:** {{detailed_description}}
|
||||
|
||||
**Player Input:** {{input_method}}
|
||||
|
||||
**System Response:** {{game_response}}
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{tech_requirement_1}}
|
||||
- {{tech_requirement_2}}
|
||||
- {{performance_consideration}}
|
||||
|
||||
**Dependencies:** {{other_mechanics_needed}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Controls
|
||||
|
||||
[[LLM: Define all input methods for different platforms]]
|
||||
|
||||
| Action | Desktop | Mobile | Gamepad |
|
||||
| ------------ | ------- | ----------- | ---------- |
|
||||
| {{action_1}} | {{key}} | {{gesture}} | {{button}} |
|
||||
| {{action_2}} | {{key}} | {{gesture}} | {{button}} |
|
||||
|
||||
## Progression & Balance
|
||||
|
||||
[[LLM: Define how players advance and how difficulty scales. This section should provide clear parameters for implementation.]]
|
||||
|
||||
### Player Progression
|
||||
|
||||
**Progression Type:** {{linear|branching|metroidvania}}
|
||||
|
||||
**Key Milestones:**
|
||||
|
||||
1. **{{milestone_1}}** - {{unlock_description}}
|
||||
2. **{{milestone_2}}** - {{unlock_description}}
|
||||
3. **{{milestone_3}}** - {{unlock_description}}
|
||||
|
||||
### Difficulty Curve
|
||||
|
||||
[[LLM: Provide specific parameters for balancing]]
|
||||
|
||||
**Tutorial Phase:** {{duration}} - {{difficulty_description}}
|
||||
**Early Game:** {{duration}} - {{difficulty_description}}
|
||||
**Mid Game:** {{duration}} - {{difficulty_description}}
|
||||
**Late Game:** {{duration}} - {{difficulty_description}}
|
||||
|
||||
### Economy & Resources
|
||||
|
||||
^^CONDITION: has_economy^^
|
||||
|
||||
[[LLM: Define any in-game currencies, resources, or collectibles]]
|
||||
|
||||
| Resource | Earn Rate | Spend Rate | Purpose | Cap |
|
||||
| -------------- | --------- | ---------- | ------- | ------- |
|
||||
| {{resource_1}} | {{rate}} | {{rate}} | {{use}} | {{max}} |
|
||||
|
||||
^^/CONDITION: has_economy^^
|
||||
|
||||
## Level Design Framework
|
||||
|
||||
[[LLM: Provide guidelines for level creation that developers can use to create level implementation stories]]
|
||||
|
||||
### Level Types
|
||||
|
||||
<<REPEAT section="level_type" count="2-4">>
|
||||
|
||||
#### {{level_type_name}}
|
||||
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
**Duration:** {{target_time}}
|
||||
**Key Elements:** {{required_mechanics}}
|
||||
**Difficulty:** {{relative_difficulty}}
|
||||
|
||||
**Structure Template:**
|
||||
|
||||
- Introduction: {{intro_description}}
|
||||
- Challenge: {{main_challenge}}
|
||||
- Resolution: {{completion_requirement}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
### Level Progression
|
||||
|
||||
**World Structure:** {{linear|hub|open}}
|
||||
**Total Levels:** {{number}}
|
||||
**Unlock Pattern:** {{progression_method}}
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
[[LLM: Define technical requirements that will guide architecture and implementation decisions. Review any existing technical preferences.]]
|
||||
|
||||
### Performance Requirements
|
||||
|
||||
**Frame Rate:** 60 FPS (minimum 30 FPS on low-end devices)
|
||||
**Memory Usage:** <{{memory_limit}}MB
|
||||
**Load Times:** <{{load_time}}s initial, <{{level_load}}s between levels
|
||||
**Battery Usage:** Optimized for mobile devices
|
||||
|
||||
### Platform Specific
|
||||
|
||||
**Desktop:**
|
||||
|
||||
- Resolution: {{min_resolution}} - {{max_resolution}}
|
||||
- Input: Keyboard, Mouse, Gamepad
|
||||
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
||||
|
||||
**Mobile:**
|
||||
|
||||
- Resolution: {{mobile_min}} - {{mobile_max}}
|
||||
- Input: Touch, Tilt (optional)
|
||||
- OS: iOS 13+, Android 8+
|
||||
|
||||
### Asset Requirements
|
||||
|
||||
[[LLM: Define asset specifications for the art and audio teams]]
|
||||
|
||||
**Visual Assets:**
|
||||
|
||||
- Art Style: {{style_description}}
|
||||
- Color Palette: {{color_specification}}
|
||||
- Animation: {{animation_requirements}}
|
||||
- UI Resolution: {{ui_specs}}
|
||||
|
||||
**Audio Assets:**
|
||||
|
||||
- Music Style: {{music_genre}}
|
||||
- Sound Effects: {{sfx_requirements}}
|
||||
- Voice Acting: {{voice_needs}}
|
||||
|
||||
## Technical Architecture Requirements
|
||||
|
||||
[[LLM: Define high-level technical requirements that the game architecture must support]]
|
||||
|
||||
### Engine Configuration
|
||||
|
||||
**Phaser 3 Setup:**
|
||||
|
||||
- TypeScript: Strict mode enabled
|
||||
- Physics: {{physics_system}} (Arcade/Matter)
|
||||
- Renderer: WebGL with Canvas fallback
|
||||
- Scale Mode: {{scale_mode}}
|
||||
|
||||
### Code Architecture
|
||||
|
||||
**Required Systems:**
|
||||
|
||||
- Scene Management
|
||||
- State Management
|
||||
- Asset Loading
|
||||
- Save/Load System
|
||||
- Input Management
|
||||
- Audio System
|
||||
- Performance Monitoring
|
||||
|
||||
### Data Management
|
||||
|
||||
**Save Data:**
|
||||
|
||||
- Progress tracking
|
||||
- Settings persistence
|
||||
- Statistics collection
|
||||
- {{additional_data}}
|
||||
|
||||
## Development Phases
|
||||
|
||||
[[LLM: Break down the development into phases that can be converted to epics]]
|
||||
|
||||
### Phase 1: Core Systems ({{duration}})
|
||||
|
||||
**Epic: Foundation**
|
||||
|
||||
- Engine setup and configuration
|
||||
- Basic scene management
|
||||
- Core input handling
|
||||
- Asset loading pipeline
|
||||
|
||||
**Epic: Core Mechanics**
|
||||
|
||||
- {{primary_mechanic}} implementation
|
||||
- Basic physics and collision
|
||||
- Player controller
|
||||
|
||||
### Phase 2: Gameplay Features ({{duration}})
|
||||
|
||||
**Epic: Game Systems**
|
||||
|
||||
- {{mechanic_2}} implementation
|
||||
- {{mechanic_3}} implementation
|
||||
- Game state management
|
||||
|
||||
**Epic: Content Creation**
|
||||
|
||||
- Level loading system
|
||||
- First playable levels
|
||||
- Basic UI implementation
|
||||
|
||||
### Phase 3: Polish & Optimization ({{duration}})
|
||||
|
||||
**Epic: Performance**
|
||||
|
||||
- Optimization and profiling
|
||||
- Mobile platform testing
|
||||
- Memory management
|
||||
|
||||
**Epic: User Experience**
|
||||
|
||||
- Audio implementation
|
||||
- Visual effects and polish
|
||||
- Final UI/UX refinement
|
||||
|
||||
## Success Metrics
|
||||
|
||||
[[LLM: Define measurable goals for the game]]
|
||||
|
||||
**Technical Metrics:**
|
||||
|
||||
- Frame rate: {{fps_target}}
|
||||
- Load time: {{load_target}}
|
||||
- Crash rate: <{{crash_threshold}}%
|
||||
- Memory usage: <{{memory_target}}MB
|
||||
|
||||
**Gameplay Metrics:**
|
||||
|
||||
- Tutorial completion: {{completion_rate}}%
|
||||
- Average session: {{session_length}} minutes
|
||||
- Level completion: {{level_completion}}%
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%
|
||||
|
||||
## Appendices
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
### References
|
||||
|
||||
[[LLM: List any competitive analysis, inspiration, or research sources]]
|
||||
|
||||
- {{reference_1}}
|
||||
- {{reference_2}}
|
||||
- {{reference_3}}
|
||||
@@ -0,0 +1,343 @@
|
||||
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)"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||
|
||||
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
||||
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
instruction: Create a compelling overview that captures the essence of the game. Present this section first and get user feedback before proceeding.
|
||||
sections:
|
||||
- id: core-concept
|
||||
title: Core Concept
|
||||
instruction: 2-3 sentences that clearly describe what the game is and why players will love it
|
||||
- id: target-audience
|
||||
title: Target Audience
|
||||
instruction: Define the primary and secondary audience with demographics and gaming preferences
|
||||
template: |
|
||||
**Primary:** {{age_range}}, {{player_type}}, {{platform_preference}}
|
||||
**Secondary:** {{secondary_audience}}
|
||||
- id: platform-technical
|
||||
title: Platform & Technical Requirements
|
||||
instruction: Based on the technical preferences or user input, define the target platforms
|
||||
template: |
|
||||
**Primary Platform:** {{platform}}
|
||||
**Engine:** Phaser 3 + TypeScript
|
||||
**Performance Target:** 60 FPS on {{minimum_device}}
|
||||
**Screen Support:** {{resolution_range}}
|
||||
- id: unique-selling-points
|
||||
title: Unique Selling Points
|
||||
instruction: List 3-5 key features that differentiate this game from competitors
|
||||
type: numbered-list
|
||||
template: "{{usp}}"
|
||||
|
||||
- id: core-gameplay
|
||||
title: Core Gameplay
|
||||
instruction: This section defines the fundamental game mechanics. After presenting each subsection, apply `tasks#advanced-elicitation` protocol to ensure completeness.
|
||||
sections:
|
||||
- id: game-pillars
|
||||
title: Game Pillars
|
||||
instruction: Define 3-5 core pillars that guide all design decisions. These should be specific and actionable.
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{pillar_name}}** - {{description}}
|
||||
- id: core-gameplay-loop
|
||||
title: Core Gameplay Loop
|
||||
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
||||
template: |
|
||||
**Primary Loop ({{duration}} seconds):**
|
||||
|
||||
1. {{action_1}} ({{time_1}}s)
|
||||
2. {{action_2}} ({{time_2}}s)
|
||||
3. {{action_3}} ({{time_3}}s)
|
||||
4. {{reward_feedback}} ({{time_4}}s)
|
||||
- id: win-loss-conditions
|
||||
title: Win/Loss Conditions
|
||||
instruction: Clearly define success and failure states
|
||||
template: |
|
||||
**Victory Conditions:**
|
||||
|
||||
- {{win_condition_1}}
|
||||
- {{win_condition_2}}
|
||||
|
||||
**Failure States:**
|
||||
|
||||
- {{loss_condition_1}}
|
||||
- {{loss_condition_2}}
|
||||
|
||||
- id: game-mechanics
|
||||
title: Game Mechanics
|
||||
instruction: Detail each major mechanic that will need to be implemented. Each mechanic should be specific enough for developers to create implementation stories.
|
||||
sections:
|
||||
- id: primary-mechanics
|
||||
title: Primary Mechanics
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic
|
||||
title: "{{mechanic_name}}"
|
||||
template: |
|
||||
**Description:** {{detailed_description}}
|
||||
|
||||
**Player Input:** {{input_method}}
|
||||
|
||||
**System Response:** {{game_response}}
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{tech_requirement_1}}
|
||||
- {{tech_requirement_2}}
|
||||
- {{performance_consideration}}
|
||||
|
||||
**Dependencies:** {{other_mechanics_needed}}
|
||||
- id: controls
|
||||
title: Controls
|
||||
instruction: Define all input methods for different platforms
|
||||
type: table
|
||||
template: |
|
||||
| Action | Desktop | Mobile | Gamepad |
|
||||
| ------ | ------- | ------ | ------- |
|
||||
| {{action}} | {{key}} | {{gesture}} | {{button}} |
|
||||
|
||||
- id: progression-balance
|
||||
title: Progression & Balance
|
||||
instruction: Define how players advance and how difficulty scales. This section should provide clear parameters for implementation.
|
||||
sections:
|
||||
- id: player-progression
|
||||
title: Player Progression
|
||||
template: |
|
||||
**Progression Type:** {{linear|branching|metroidvania}}
|
||||
|
||||
**Key Milestones:**
|
||||
|
||||
1. **{{milestone_1}}** - {{unlock_description}}
|
||||
2. **{{milestone_2}}** - {{unlock_description}}
|
||||
3. **{{milestone_3}}** - {{unlock_description}}
|
||||
- id: difficulty-curve
|
||||
title: Difficulty Curve
|
||||
instruction: Provide specific parameters for balancing
|
||||
template: |
|
||||
**Tutorial Phase:** {{duration}} - {{difficulty_description}}
|
||||
**Early Game:** {{duration}} - {{difficulty_description}}
|
||||
**Mid Game:** {{duration}} - {{difficulty_description}}
|
||||
**Late Game:** {{duration}} - {{difficulty_description}}
|
||||
- id: economy-resources
|
||||
title: Economy & Resources
|
||||
condition: has_economy
|
||||
instruction: Define any in-game currencies, resources, or collectibles
|
||||
type: table
|
||||
template: |
|
||||
| Resource | Earn Rate | Spend Rate | Purpose | Cap |
|
||||
| -------- | --------- | ---------- | ------- | --- |
|
||||
| {{resource}} | {{rate}} | {{rate}} | {{use}} | {{max}} |
|
||||
|
||||
- id: level-design-framework
|
||||
title: Level Design Framework
|
||||
instruction: Provide guidelines for level creation that developers can use to create level implementation stories
|
||||
sections:
|
||||
- id: level-types
|
||||
title: Level Types
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: level-type
|
||||
title: "{{level_type_name}}"
|
||||
template: |
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
**Duration:** {{target_time}}
|
||||
**Key Elements:** {{required_mechanics}}
|
||||
**Difficulty:** {{relative_difficulty}}
|
||||
|
||||
**Structure Template:**
|
||||
|
||||
- Introduction: {{intro_description}}
|
||||
- Challenge: {{main_challenge}}
|
||||
- Resolution: {{completion_requirement}}
|
||||
- id: level-progression
|
||||
title: Level Progression
|
||||
template: |
|
||||
**World Structure:** {{linear|hub|open}}
|
||||
**Total Levels:** {{number}}
|
||||
**Unlock Pattern:** {{progression_method}}
|
||||
|
||||
- id: technical-specifications
|
||||
title: Technical Specifications
|
||||
instruction: Define technical requirements that will guide architecture and implementation decisions. Review any existing technical preferences.
|
||||
sections:
|
||||
- id: performance-requirements
|
||||
title: Performance Requirements
|
||||
template: |
|
||||
**Frame Rate:** 60 FPS (minimum 30 FPS on low-end devices)
|
||||
**Memory Usage:** <{{memory_limit}}MB
|
||||
**Load Times:** <{{load_time}}s initial, <{{level_load}}s between levels
|
||||
**Battery Usage:** Optimized for mobile devices
|
||||
- id: platform-specific
|
||||
title: Platform Specific
|
||||
template: |
|
||||
**Desktop:**
|
||||
|
||||
- Resolution: {{min_resolution}} - {{max_resolution}}
|
||||
- Input: Keyboard, Mouse, Gamepad
|
||||
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
||||
|
||||
**Mobile:**
|
||||
|
||||
- Resolution: {{mobile_min}} - {{mobile_max}}
|
||||
- Input: Touch, Tilt (optional)
|
||||
- OS: iOS 13+, Android 8+
|
||||
- id: asset-requirements
|
||||
title: Asset Requirements
|
||||
instruction: Define asset specifications for the art and audio teams
|
||||
template: |
|
||||
**Visual Assets:**
|
||||
|
||||
- Art Style: {{style_description}}
|
||||
- Color Palette: {{color_specification}}
|
||||
- Animation: {{animation_requirements}}
|
||||
- UI Resolution: {{ui_specs}}
|
||||
|
||||
**Audio Assets:**
|
||||
|
||||
- Music Style: {{music_genre}}
|
||||
- Sound Effects: {{sfx_requirements}}
|
||||
- Voice Acting: {{voice_needs}}
|
||||
|
||||
- id: technical-architecture-requirements
|
||||
title: Technical Architecture Requirements
|
||||
instruction: Define high-level technical requirements that the game architecture must support
|
||||
sections:
|
||||
- id: engine-configuration
|
||||
title: Engine Configuration
|
||||
template: |
|
||||
**Phaser 3 Setup:**
|
||||
|
||||
- TypeScript: Strict mode enabled
|
||||
- Physics: {{physics_system}} (Arcade/Matter)
|
||||
- Renderer: WebGL with Canvas fallback
|
||||
- Scale Mode: {{scale_mode}}
|
||||
- id: code-architecture
|
||||
title: Code Architecture
|
||||
template: |
|
||||
**Required Systems:**
|
||||
|
||||
- Scene Management
|
||||
- State Management
|
||||
- Asset Loading
|
||||
- Save/Load System
|
||||
- Input Management
|
||||
- Audio System
|
||||
- Performance Monitoring
|
||||
- id: data-management
|
||||
title: Data Management
|
||||
template: |
|
||||
**Save Data:**
|
||||
|
||||
- Progress tracking
|
||||
- Settings persistence
|
||||
- Statistics collection
|
||||
- {{additional_data}}
|
||||
|
||||
- id: development-phases
|
||||
title: Development Phases
|
||||
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}})"
|
||||
sections:
|
||||
- id: foundation-epic
|
||||
title: "Epic: Foundation"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Engine setup and configuration
|
||||
- Basic scene management
|
||||
- Core input handling
|
||||
- Asset loading pipeline
|
||||
- id: core-mechanics-epic
|
||||
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}})"
|
||||
sections:
|
||||
- id: game-systems-epic
|
||||
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"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Level loading system
|
||||
- First playable levels
|
||||
- Basic UI implementation
|
||||
- id: phase-3-polish-optimization
|
||||
title: "Phase 3: Polish & Optimization ({{duration}})"
|
||||
sections:
|
||||
- id: performance-epic
|
||||
title: "Epic: Performance"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Optimization and profiling
|
||||
- Mobile platform testing
|
||||
- Memory management
|
||||
- id: user-experience-epic
|
||||
title: "Epic: User Experience"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Audio implementation
|
||||
- Visual effects and polish
|
||||
- Final UI/UX refinement
|
||||
|
||||
- id: success-metrics
|
||||
title: Success Metrics
|
||||
instruction: Define measurable goals for the game
|
||||
sections:
|
||||
- id: technical-metrics
|
||||
title: Technical Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Frame rate: {{fps_target}}
|
||||
- Load time: {{load_target}}
|
||||
- Crash rate: <{{crash_threshold}}%
|
||||
- Memory usage: <{{memory_target}}MB
|
||||
- id: gameplay-metrics
|
||||
title: Gameplay Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Tutorial completion: {{completion_rate}}%
|
||||
- Average session: {{session_length}} minutes
|
||||
- Level completion: {{level_completion}}%
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
- id: references
|
||||
title: References
|
||||
instruction: List any competitive analysis, inspiration, or research sources
|
||||
type: bullet-list
|
||||
template: "{{reference}}"
|
||||
@@ -1,235 +0,0 @@
|
||||
# Story: {{Story Title}}
|
||||
|
||||
**Epic:** {{Epic Name}}
|
||||
**Story ID:** {{ID}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{Story Points}}
|
||||
**Status:** Draft
|
||||
|
||||
[[LLM: This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.]]
|
||||
|
||||
## Description
|
||||
|
||||
[[LLM: 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.]]
|
||||
|
||||
{{clear_description_of_what_needs_to_be_implemented}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
[[LLM: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.]]
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
- [ ] {{specific_functional_requirement_1}}
|
||||
- [ ] {{specific_functional_requirement_2}}
|
||||
- [ ] {{specific_functional_requirement_3}}
|
||||
|
||||
### Technical Requirements
|
||||
|
||||
- [ ] Code follows TypeScript strict mode standards
|
||||
- [ ] Maintains 60 FPS on target devices
|
||||
- [ ] No memory leaks or performance degradation
|
||||
- [ ] {{specific_technical_requirement}}
|
||||
|
||||
### Game Design Requirements
|
||||
|
||||
- [ ] {{gameplay_requirement_from_gdd}}
|
||||
- [ ] {{balance_requirement_if_applicable}}
|
||||
- [ ] {{player_experience_requirement}}
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
[[LLM: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.]]
|
||||
|
||||
### Files to Create/Modify
|
||||
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
|
||||
### Class/Interface Definitions
|
||||
|
||||
[[LLM: Define specific TypeScript interfaces and class structures needed]]
|
||||
|
||||
```typescript
|
||||
// {{interface_name}}
|
||||
interface {{InterfaceName}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{ClassName}} extends {{PhaseClass}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Integration Points
|
||||
|
||||
[[LLM: Specify how this feature integrates with existing systems]]
|
||||
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
## Implementation Tasks
|
||||
|
||||
[[LLM: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.]]
|
||||
|
||||
### Dev Agent Record
|
||||
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
## Game Design Context
|
||||
|
||||
[[LLM: Reference the specific sections of the GDD that this story implements]]
|
||||
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
[[LLM: Define specific testing criteria for this game feature]]
|
||||
|
||||
### Unit Tests
|
||||
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
|
||||
### Game Testing
|
||||
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
|
||||
### Performance Tests
|
||||
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
## Dependencies
|
||||
|
||||
[[LLM: List any dependencies that must be completed before this story can be implemented]]
|
||||
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
## Definition of Done
|
||||
|
||||
[[LLM: Checklist that must be completed before the story is considered finished]]
|
||||
|
||||
- [ ] 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}}
|
||||
|
||||
## Notes
|
||||
|
||||
[[LLM: Any additional context, design decisions, or implementation notes]]
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
@@ -0,0 +1,253 @@
|
||||
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}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
||||
|
||||
- id: story-header
|
||||
content: |
|
||||
**Epic:** {{epic_name}}
|
||||
**Story ID:** {{story_id}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{story_points}}
|
||||
**Status:** Draft
|
||||
|
||||
- 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}}"
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
instruction: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.
|
||||
sections:
|
||||
- id: functional-requirements
|
||||
title: Functional Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{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}}"
|
||||
- id: game-design-requirements
|
||||
title: Game Design Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{gameplay_requirement_from_gdd}}"
|
||||
- "{{balance_requirement_if_applicable}}"
|
||||
- "{{player_experience_requirement}}"
|
||||
|
||||
- id: technical-specifications
|
||||
title: Technical Specifications
|
||||
instruction: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.
|
||||
sections:
|
||||
- id: files-to-modify
|
||||
title: Files to Create/Modify
|
||||
template: |
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
- id: class-interface-definitions
|
||||
title: Class/Interface Definitions
|
||||
instruction: Define specific TypeScript interfaces and class structures needed
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
// {{interface_name}}
|
||||
interface {{interface_name}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{class_name}} extends {{phaser_class}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
instruction: Specify how this feature integrates with existing systems
|
||||
template: |
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
- id: implementation-tasks
|
||||
title: Implementation Tasks
|
||||
instruction: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.
|
||||
sections:
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
template: |
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
- id: game-design-context
|
||||
title: Game Design Context
|
||||
instruction: Reference the specific sections of the GDD that this story implements
|
||||
template: |
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
- id: testing-requirements
|
||||
title: Testing Requirements
|
||||
instruction: Define specific testing criteria for this game feature
|
||||
sections:
|
||||
- id: unit-tests
|
||||
title: Unit Tests
|
||||
template: |
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
- id: game-testing
|
||||
title: Game Testing
|
||||
template: |
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
- id: performance-tests
|
||||
title: Performance Tests
|
||||
template: |
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
- id: dependencies
|
||||
title: Dependencies
|
||||
instruction: List any dependencies that must be completed before this story can be implemented
|
||||
template: |
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
- id: definition-of-done
|
||||
title: Definition of Done
|
||||
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}}"
|
||||
|
||||
- id: notes
|
||||
title: Notes
|
||||
instruction: Any additional context, design decisions, or implementation notes
|
||||
template: |
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
@@ -1,470 +0,0 @@
|
||||
# {{Game Title}} Level Design Document
|
||||
|
||||
[[LLM: This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
||||
|
||||
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.]]
|
||||
|
||||
## Introduction
|
||||
|
||||
[[LLM: Establish the purpose and scope of level design for this game]]
|
||||
|
||||
This document defines the level design framework for {{Game Title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
||||
|
||||
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: Track document versions and changes]]
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## Level Design Philosophy
|
||||
|
||||
[[LLM: Establish the overall approach to level design based on the game's core pillars and mechanics. Apply `tasks#advanced-elicitation` after presenting this section.]]
|
||||
|
||||
### Design Principles
|
||||
|
||||
[[LLM: Define 3-5 core principles that guide all level design decisions]]
|
||||
|
||||
1. **{{principle_1}}** - {{description}}
|
||||
2. **{{principle_2}}** - {{description}}
|
||||
3. **{{principle_3}}** - {{description}}
|
||||
|
||||
### Player Experience Goals
|
||||
|
||||
[[LLM: Define what players should feel and learn in each level category]]
|
||||
|
||||
**Tutorial Levels:** {{experience_description}}
|
||||
**Standard Levels:** {{experience_description}}
|
||||
**Challenge Levels:** {{experience_description}}
|
||||
**Boss Levels:** {{experience_description}}
|
||||
|
||||
### Level Flow Framework
|
||||
|
||||
[[LLM: Define the standard structure for level progression]]
|
||||
|
||||
**Introduction Phase:** {{duration}} - {{purpose}}
|
||||
**Development Phase:** {{duration}} - {{purpose}}
|
||||
**Climax Phase:** {{duration}} - {{purpose}}
|
||||
**Resolution Phase:** {{duration}} - {{purpose}}
|
||||
|
||||
## Level Categories
|
||||
|
||||
[[LLM: Define different types of levels based on the GDD requirements. Each category should be specific enough for implementation.]]
|
||||
|
||||
<<REPEAT section="level_category" count="based_on_gdd">>
|
||||
|
||||
### {{category_name}} Levels
|
||||
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
|
||||
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
||||
|
||||
**Difficulty Range:** {{difficulty_scale}}
|
||||
|
||||
**Key Mechanics Featured:**
|
||||
|
||||
- {{mechanic_1}} - {{usage_description}}
|
||||
- {{mechanic_2}} - {{usage_description}}
|
||||
|
||||
**Player Objectives:**
|
||||
|
||||
- Primary: {{primary_objective}}
|
||||
- Secondary: {{secondary_objective}}
|
||||
- Hidden: {{secret_objective}}
|
||||
|
||||
**Success Criteria:**
|
||||
|
||||
- {{completion_requirement_1}}
|
||||
- {{completion_requirement_2}}
|
||||
|
||||
**Technical Requirements:**
|
||||
|
||||
- Maximum entities: {{entity_limit}}
|
||||
- Performance target: {{fps_target}} FPS
|
||||
- Memory budget: {{memory_limit}}MB
|
||||
- Asset requirements: {{asset_needs}}
|
||||
|
||||
<</REPEAT>>
|
||||
|
||||
## Level Progression System
|
||||
|
||||
[[LLM: Define how players move through levels and how difficulty scales]]
|
||||
|
||||
### World Structure
|
||||
|
||||
[[LLM: Based on GDD requirements, define the overall level organization]]
|
||||
|
||||
**Organization Type:** {{linear|hub_world|open_world}}
|
||||
|
||||
**Total Level Count:** {{number}}
|
||||
|
||||
**World Breakdown:**
|
||||
|
||||
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
|
||||
### Difficulty Progression
|
||||
|
||||
[[LLM: Define how challenge increases across the game]]
|
||||
|
||||
**Progression Curve:**
|
||||
|
||||
````text
|
||||
Difficulty
|
||||
^ ___/```
|
||||
| /
|
||||
| / ___/```
|
||||
| / /
|
||||
| / /
|
||||
|/ /
|
||||
+-----------> Level Number
|
||||
Tutorial Early Mid Late
|
||||
````
|
||||
|
||||
**Scaling Parameters:**
|
||||
|
||||
- Enemy count: {{start_count}} → {{end_count}}
|
||||
- Enemy difficulty: {{start_diff}} → {{end_diff}}
|
||||
- Level complexity: {{start_complex}} → {{end_complex}}
|
||||
- Time pressure: {{start_time}} → {{end_time}}
|
||||
|
||||
### Unlock Requirements
|
||||
|
||||
[[LLM: Define how players access new levels]]
|
||||
|
||||
**Progression Gates:**
|
||||
|
||||
- Linear progression: Complete previous level
|
||||
- Star requirements: {{star_count}} stars to unlock
|
||||
- Skill gates: Demonstrate {{skill_requirement}}
|
||||
- Optional content: {{unlock_condition}}
|
||||
|
||||
## Level Design Components
|
||||
|
||||
[[LLM: Define the building blocks used to create levels]]
|
||||
|
||||
### Environmental Elements
|
||||
|
||||
[[LLM: Define all environmental components that can be used in levels]]
|
||||
|
||||
**Terrain Types:**
|
||||
|
||||
- {{terrain_1}}: {{properties_and_usage}}
|
||||
- {{terrain_2}}: {{properties_and_usage}}
|
||||
|
||||
**Interactive Objects:**
|
||||
|
||||
- {{object_1}}: {{behavior_and_purpose}}
|
||||
- {{object_2}}: {{behavior_and_purpose}}
|
||||
|
||||
**Hazards and Obstacles:**
|
||||
|
||||
- {{hazard_1}}: {{damage_and_behavior}}
|
||||
- {{hazard_2}}: {{damage_and_behavior}}
|
||||
|
||||
### Collectibles and Rewards
|
||||
|
||||
[[LLM: Define all collectible items and their placement rules]]
|
||||
|
||||
**Collectible Types:**
|
||||
|
||||
- {{collectible_1}}: {{value_and_purpose}}
|
||||
- {{collectible_2}}: {{value_and_purpose}}
|
||||
|
||||
**Placement Guidelines:**
|
||||
|
||||
- Mandatory collectibles: {{placement_rules}}
|
||||
- Optional collectibles: {{placement_rules}}
|
||||
- Secret collectibles: {{placement_rules}}
|
||||
|
||||
**Reward Distribution:**
|
||||
|
||||
- Easy to find: {{percentage}}%
|
||||
- Moderate challenge: {{percentage}}%
|
||||
- High skill required: {{percentage}}%
|
||||
|
||||
### Enemy Placement Framework
|
||||
|
||||
[[LLM: Define how enemies should be placed and balanced in levels]]
|
||||
|
||||
**Enemy Categories:**
|
||||
|
||||
- {{enemy_type_1}}: {{behavior_and_usage}}
|
||||
- {{enemy_type_2}}: {{behavior_and_usage}}
|
||||
|
||||
**Placement Principles:**
|
||||
|
||||
- Introduction encounters: {{guideline}}
|
||||
- Standard encounters: {{guideline}}
|
||||
- Challenge encounters: {{guideline}}
|
||||
|
||||
**Difficulty Scaling:**
|
||||
|
||||
- Enemy count progression: {{scaling_rule}}
|
||||
- Enemy type introduction: {{pacing_rule}}
|
||||
- Encounter complexity: {{complexity_rule}}
|
||||
|
||||
## Level Creation Guidelines
|
||||
|
||||
[[LLM: Provide specific guidelines for creating individual levels]]
|
||||
|
||||
### Level Layout Principles
|
||||
|
||||
**Spatial Design:**
|
||||
|
||||
- Grid size: {{grid_dimensions}}
|
||||
- Minimum path width: {{width_units}}
|
||||
- Maximum vertical distance: {{height_units}}
|
||||
- Safe zones placement: {{safety_guidelines}}
|
||||
|
||||
**Navigation Design:**
|
||||
|
||||
- Clear path indication: {{visual_cues}}
|
||||
- Landmark placement: {{landmark_rules}}
|
||||
- Dead end avoidance: {{dead_end_policy}}
|
||||
- Multiple path options: {{branching_rules}}
|
||||
|
||||
### Pacing and Flow
|
||||
|
||||
[[LLM: Define how to control the rhythm and pace of gameplay within levels]]
|
||||
|
||||
**Action Sequences:**
|
||||
|
||||
- High intensity duration: {{max_duration}}
|
||||
- Rest period requirement: {{min_rest_time}}
|
||||
- Intensity variation: {{pacing_pattern}}
|
||||
|
||||
**Learning Sequences:**
|
||||
|
||||
- New mechanic introduction: {{teaching_method}}
|
||||
- Practice opportunity: {{practice_duration}}
|
||||
- Skill application: {{application_context}}
|
||||
|
||||
### Challenge Design
|
||||
|
||||
[[LLM: Define how to create appropriate challenges for each level type]]
|
||||
|
||||
**Challenge Types:**
|
||||
|
||||
- Execution challenges: {{skill_requirements}}
|
||||
- Puzzle challenges: {{complexity_guidelines}}
|
||||
- Time challenges: {{time_pressure_rules}}
|
||||
- Resource challenges: {{resource_management}}
|
||||
|
||||
**Difficulty Calibration:**
|
||||
|
||||
- Skill check frequency: {{frequency_guidelines}}
|
||||
- Failure recovery: {{retry_mechanics}}
|
||||
- Hint system integration: {{help_system}}
|
||||
|
||||
## Technical Implementation
|
||||
|
||||
[[LLM: Define technical requirements for level implementation]]
|
||||
|
||||
### Level Data Structure
|
||||
|
||||
[[LLM: Define how level data should be structured for implementation]]
|
||||
|
||||
**Level File Format:**
|
||||
|
||||
- Data format: {{json|yaml|custom}}
|
||||
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
||||
- Data organization: {{structure_description}}
|
||||
|
||||
**Required Data Fields:**
|
||||
|
||||
```json
|
||||
{
|
||||
"levelId": "{{unique_identifier}}",
|
||||
"worldId": "{{world_identifier}}",
|
||||
"difficulty": {{difficulty_value}},
|
||||
"targetTime": {{completion_time_seconds}},
|
||||
"objectives": {
|
||||
"primary": "{{primary_objective}}",
|
||||
"secondary": ["{{secondary_objectives}}"],
|
||||
"hidden": ["{{secret_objectives}}"]
|
||||
},
|
||||
"layout": {
|
||||
"width": {{grid_width}},
|
||||
"height": {{grid_height}},
|
||||
"tilemap": "{{tilemap_reference}}"
|
||||
},
|
||||
"entities": [
|
||||
{
|
||||
"type": "{{entity_type}}",
|
||||
"position": {"x": {{x}}, "y": {{y}}},
|
||||
"properties": {{entity_properties}}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Asset Integration
|
||||
|
||||
[[LLM: Define how level assets are organized and loaded]]
|
||||
|
||||
**Tilemap Requirements:**
|
||||
|
||||
- Tile size: {{tile_dimensions}}px
|
||||
- Tileset organization: {{tileset_structure}}
|
||||
- Layer organization: {{layer_system}}
|
||||
- Collision data: {{collision_format}}
|
||||
|
||||
**Audio Integration:**
|
||||
|
||||
- Background music: {{music_requirements}}
|
||||
- Ambient sounds: {{ambient_system}}
|
||||
- Dynamic audio: {{dynamic_audio_rules}}
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
[[LLM: Define performance requirements for level systems]]
|
||||
|
||||
**Entity Limits:**
|
||||
|
||||
- Maximum active entities: {{entity_limit}}
|
||||
- Maximum particles: {{particle_limit}}
|
||||
- Maximum audio sources: {{audio_limit}}
|
||||
|
||||
**Memory Management:**
|
||||
|
||||
- Texture memory budget: {{texture_memory}}MB
|
||||
- Audio memory budget: {{audio_memory}}MB
|
||||
- Level loading time: <{{load_time}}s
|
||||
|
||||
**Culling and LOD:**
|
||||
|
||||
- Off-screen culling: {{culling_distance}}
|
||||
- Level-of-detail rules: {{lod_system}}
|
||||
- Asset streaming: {{streaming_requirements}}
|
||||
|
||||
## Level Testing Framework
|
||||
|
||||
[[LLM: Define how levels should be tested and validated]]
|
||||
|
||||
### Automated Testing
|
||||
|
||||
**Performance Testing:**
|
||||
|
||||
- Frame rate validation: Maintain {{fps_target}} FPS
|
||||
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
||||
- Loading time verification: Complete in <{{load_time}}s
|
||||
|
||||
**Gameplay Testing:**
|
||||
|
||||
- Completion path validation: All objectives achievable
|
||||
- Collectible accessibility: All items reachable
|
||||
- Softlock prevention: No unwinnable states
|
||||
|
||||
### Manual Testing Protocol
|
||||
|
||||
**Playtesting Checklist:**
|
||||
|
||||
- [ ] 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)
|
||||
|
||||
**Player Experience Testing:**
|
||||
|
||||
- [ ] Tutorial levels teach effectively
|
||||
- [ ] Challenge feels fair and rewarding
|
||||
- [ ] Flow and pacing maintain engagement
|
||||
- [ ] Audio and visual feedback support gameplay
|
||||
|
||||
### Balance Validation
|
||||
|
||||
**Metrics Collection:**
|
||||
|
||||
- Completion rate: Target {{completion_percentage}}%
|
||||
- Average completion time: {{target_time}} ± {{variance}}
|
||||
- Death count per level: <{{max_deaths}}
|
||||
- Collectible discovery rate: {{discovery_percentage}}%
|
||||
|
||||
**Iteration Guidelines:**
|
||||
|
||||
- Adjustment criteria: {{criteria_for_changes}}
|
||||
- Testing sample size: {{minimum_testers}}
|
||||
- Validation period: {{testing_duration}}
|
||||
|
||||
## Content Creation Pipeline
|
||||
|
||||
[[LLM: Define the workflow for creating new levels]]
|
||||
|
||||
### Design Phase
|
||||
|
||||
**Concept Development:**
|
||||
|
||||
1. Define level purpose and goals
|
||||
2. Create rough layout sketch
|
||||
3. Identify key mechanics and challenges
|
||||
4. Estimate difficulty and duration
|
||||
|
||||
**Documentation Requirements:**
|
||||
|
||||
- Level design brief
|
||||
- Layout diagrams
|
||||
- Mechanic integration notes
|
||||
- Asset requirement list
|
||||
|
||||
### Implementation Phase
|
||||
|
||||
**Technical Implementation:**
|
||||
|
||||
1. Create level data file
|
||||
2. Build tilemap and layout
|
||||
3. Place entities and objects
|
||||
4. Configure level logic and triggers
|
||||
5. Integrate audio and visual effects
|
||||
|
||||
**Quality Assurance:**
|
||||
|
||||
1. Automated testing execution
|
||||
2. Internal playtesting
|
||||
3. Performance validation
|
||||
4. Bug fixing and polish
|
||||
|
||||
### Integration Phase
|
||||
|
||||
**Game Integration:**
|
||||
|
||||
1. Level progression integration
|
||||
2. Save system compatibility
|
||||
3. Analytics integration
|
||||
4. Achievement system integration
|
||||
|
||||
**Final Validation:**
|
||||
|
||||
1. Full game context testing
|
||||
2. Performance regression testing
|
||||
3. Platform compatibility verification
|
||||
4. Final approval and release
|
||||
|
||||
## Success Metrics
|
||||
|
||||
[[LLM: Define how to measure level design success]]
|
||||
|
||||
**Player Engagement:**
|
||||
|
||||
- Level completion rate: {{target_rate}}%
|
||||
- Replay rate: {{replay_target}}%
|
||||
- Time spent per level: {{engagement_time}}
|
||||
- Player satisfaction scores: {{satisfaction_target}}/10
|
||||
|
||||
**Technical Performance:**
|
||||
|
||||
- Frame rate consistency: {{fps_consistency}}%
|
||||
- Loading time compliance: {{load_compliance}}%
|
||||
- Memory usage efficiency: {{memory_efficiency}}%
|
||||
- Crash rate: <{{crash_threshold}}%
|
||||
|
||||
**Design Quality:**
|
||||
|
||||
- Difficulty curve adherence: {{curve_accuracy}}
|
||||
- Mechanic integration effectiveness: {{integration_score}}
|
||||
- Player guidance clarity: {{guidance_score}}
|
||||
- Content accessibility: {{accessibility_rate}}%
|
||||
@@ -0,0 +1,484 @@
|
||||
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"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
||||
|
||||
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
||||
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: Establish the purpose and scope of level design for this game
|
||||
content: |
|
||||
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
||||
|
||||
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
||||
sections:
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
- id: level-design-philosophy
|
||||
title: Level Design Philosophy
|
||||
instruction: Establish the overall approach to level design based on the game's core pillars and mechanics. Apply `tasks#advanced-elicitation` after presenting this section.
|
||||
sections:
|
||||
- id: design-principles
|
||||
title: Design Principles
|
||||
instruction: Define 3-5 core principles that guide all level design decisions
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{principle_name}}** - {{description}}
|
||||
- id: player-experience-goals
|
||||
title: Player Experience Goals
|
||||
instruction: Define what players should feel and learn in each level category
|
||||
template: |
|
||||
**Tutorial Levels:** {{experience_description}}
|
||||
**Standard Levels:** {{experience_description}}
|
||||
**Challenge Levels:** {{experience_description}}
|
||||
**Boss Levels:** {{experience_description}}
|
||||
- id: level-flow-framework
|
||||
title: Level Flow Framework
|
||||
instruction: Define the standard structure for level progression
|
||||
template: |
|
||||
**Introduction Phase:** {{duration}} - {{purpose}}
|
||||
**Development Phase:** {{duration}} - {{purpose}}
|
||||
**Climax Phase:** {{duration}} - {{purpose}}
|
||||
**Resolution Phase:** {{duration}} - {{purpose}}
|
||||
|
||||
- id: level-categories
|
||||
title: Level Categories
|
||||
instruction: Define different types of levels based on the GDD requirements. Each category should be specific enough for implementation.
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: level-category
|
||||
title: "{{category_name}} Levels"
|
||||
template: |
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
|
||||
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
||||
|
||||
**Difficulty Range:** {{difficulty_scale}}
|
||||
|
||||
**Key Mechanics Featured:**
|
||||
|
||||
- {{mechanic_1}} - {{usage_description}}
|
||||
- {{mechanic_2}} - {{usage_description}}
|
||||
|
||||
**Player Objectives:**
|
||||
|
||||
- Primary: {{primary_objective}}
|
||||
- Secondary: {{secondary_objective}}
|
||||
- Hidden: {{secret_objective}}
|
||||
|
||||
**Success Criteria:**
|
||||
|
||||
- {{completion_requirement_1}}
|
||||
- {{completion_requirement_2}}
|
||||
|
||||
**Technical Requirements:**
|
||||
|
||||
- Maximum entities: {{entity_limit}}
|
||||
- Performance target: {{fps_target}} FPS
|
||||
- Memory budget: {{memory_limit}}MB
|
||||
- Asset requirements: {{asset_needs}}
|
||||
|
||||
- id: level-progression-system
|
||||
title: Level Progression System
|
||||
instruction: Define how players move through levels and how difficulty scales
|
||||
sections:
|
||||
- id: world-structure
|
||||
title: World Structure
|
||||
instruction: Based on GDD requirements, define the overall level organization
|
||||
template: |
|
||||
**Organization Type:** {{linear|hub_world|open_world}}
|
||||
|
||||
**Total Level Count:** {{number}}
|
||||
|
||||
**World Breakdown:**
|
||||
|
||||
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
||||
- id: difficulty-progression
|
||||
title: Difficulty Progression
|
||||
instruction: Define how challenge increases across the game
|
||||
sections:
|
||||
- id: progression-curve
|
||||
title: Progression Curve
|
||||
type: code
|
||||
language: text
|
||||
template: |
|
||||
Difficulty
|
||||
^ ___/```
|
||||
| /
|
||||
| / ___/```
|
||||
| / /
|
||||
| / /
|
||||
|/ /
|
||||
+-----------> Level Number
|
||||
Tutorial Early Mid Late
|
||||
- id: scaling-parameters
|
||||
title: Scaling Parameters
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Enemy count: {{start_count}} → {{end_count}}
|
||||
- Enemy difficulty: {{start_diff}} → {{end_diff}}
|
||||
- Level complexity: {{start_complex}} → {{end_complex}}
|
||||
- Time pressure: {{start_time}} → {{end_time}}
|
||||
- id: unlock-requirements
|
||||
title: Unlock Requirements
|
||||
instruction: Define how players access new levels
|
||||
template: |
|
||||
**Progression Gates:**
|
||||
|
||||
- Linear progression: Complete previous level
|
||||
- Star requirements: {{star_count}} stars to unlock
|
||||
- Skill gates: Demonstrate {{skill_requirement}}
|
||||
- Optional content: {{unlock_condition}}
|
||||
|
||||
- id: level-design-components
|
||||
title: Level Design Components
|
||||
instruction: Define the building blocks used to create levels
|
||||
sections:
|
||||
- id: environmental-elements
|
||||
title: Environmental Elements
|
||||
instruction: Define all environmental components that can be used in levels
|
||||
template: |
|
||||
**Terrain Types:**
|
||||
|
||||
- {{terrain_1}}: {{properties_and_usage}}
|
||||
- {{terrain_2}}: {{properties_and_usage}}
|
||||
|
||||
**Interactive Objects:**
|
||||
|
||||
- {{object_1}}: {{behavior_and_purpose}}
|
||||
- {{object_2}}: {{behavior_and_purpose}}
|
||||
|
||||
**Hazards and Obstacles:**
|
||||
|
||||
- {{hazard_1}}: {{damage_and_behavior}}
|
||||
- {{hazard_2}}: {{damage_and_behavior}}
|
||||
- id: collectibles-rewards
|
||||
title: Collectibles and Rewards
|
||||
instruction: Define all collectible items and their placement rules
|
||||
template: |
|
||||
**Collectible Types:**
|
||||
|
||||
- {{collectible_1}}: {{value_and_purpose}}
|
||||
- {{collectible_2}}: {{value_and_purpose}}
|
||||
|
||||
**Placement Guidelines:**
|
||||
|
||||
- Mandatory collectibles: {{placement_rules}}
|
||||
- Optional collectibles: {{placement_rules}}
|
||||
- Secret collectibles: {{placement_rules}}
|
||||
|
||||
**Reward Distribution:**
|
||||
|
||||
- Easy to find: {{percentage}}%
|
||||
- Moderate challenge: {{percentage}}%
|
||||
- High skill required: {{percentage}}%
|
||||
- id: enemy-placement-framework
|
||||
title: Enemy Placement Framework
|
||||
instruction: Define how enemies should be placed and balanced in levels
|
||||
template: |
|
||||
**Enemy Categories:**
|
||||
|
||||
- {{enemy_type_1}}: {{behavior_and_usage}}
|
||||
- {{enemy_type_2}}: {{behavior_and_usage}}
|
||||
|
||||
**Placement Principles:**
|
||||
|
||||
- Introduction encounters: {{guideline}}
|
||||
- Standard encounters: {{guideline}}
|
||||
- Challenge encounters: {{guideline}}
|
||||
|
||||
**Difficulty Scaling:**
|
||||
|
||||
- Enemy count progression: {{scaling_rule}}
|
||||
- Enemy type introduction: {{pacing_rule}}
|
||||
- Encounter complexity: {{complexity_rule}}
|
||||
|
||||
- id: level-creation-guidelines
|
||||
title: Level Creation Guidelines
|
||||
instruction: Provide specific guidelines for creating individual levels
|
||||
sections:
|
||||
- id: level-layout-principles
|
||||
title: Level Layout Principles
|
||||
template: |
|
||||
**Spatial Design:**
|
||||
|
||||
- Grid size: {{grid_dimensions}}
|
||||
- Minimum path width: {{width_units}}
|
||||
- Maximum vertical distance: {{height_units}}
|
||||
- Safe zones placement: {{safety_guidelines}}
|
||||
|
||||
**Navigation Design:**
|
||||
|
||||
- Clear path indication: {{visual_cues}}
|
||||
- Landmark placement: {{landmark_rules}}
|
||||
- Dead end avoidance: {{dead_end_policy}}
|
||||
- Multiple path options: {{branching_rules}}
|
||||
- id: pacing-and-flow
|
||||
title: Pacing and Flow
|
||||
instruction: Define how to control the rhythm and pace of gameplay within levels
|
||||
template: |
|
||||
**Action Sequences:**
|
||||
|
||||
- High intensity duration: {{max_duration}}
|
||||
- Rest period requirement: {{min_rest_time}}
|
||||
- Intensity variation: {{pacing_pattern}}
|
||||
|
||||
**Learning Sequences:**
|
||||
|
||||
- New mechanic introduction: {{teaching_method}}
|
||||
- Practice opportunity: {{practice_duration}}
|
||||
- Skill application: {{application_context}}
|
||||
- id: challenge-design
|
||||
title: Challenge Design
|
||||
instruction: Define how to create appropriate challenges for each level type
|
||||
template: |
|
||||
**Challenge Types:**
|
||||
|
||||
- Execution challenges: {{skill_requirements}}
|
||||
- Puzzle challenges: {{complexity_guidelines}}
|
||||
- Time challenges: {{time_pressure_rules}}
|
||||
- Resource challenges: {{resource_management}}
|
||||
|
||||
**Difficulty Calibration:**
|
||||
|
||||
- Skill check frequency: {{frequency_guidelines}}
|
||||
- Failure recovery: {{retry_mechanics}}
|
||||
- Hint system integration: {{help_system}}
|
||||
|
||||
- id: technical-implementation
|
||||
title: Technical Implementation
|
||||
instruction: Define technical requirements for level implementation
|
||||
sections:
|
||||
- id: level-data-structure
|
||||
title: Level Data Structure
|
||||
instruction: Define how level data should be structured for implementation
|
||||
template: |
|
||||
**Level File Format:**
|
||||
|
||||
- Data format: {{json|yaml|custom}}
|
||||
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
||||
- Data organization: {{structure_description}}
|
||||
sections:
|
||||
- id: required-data-fields
|
||||
title: Required Data Fields
|
||||
type: code
|
||||
language: json
|
||||
template: |
|
||||
{
|
||||
"levelId": "{{unique_identifier}}",
|
||||
"worldId": "{{world_identifier}}",
|
||||
"difficulty": {{difficulty_value}},
|
||||
"targetTime": {{completion_time_seconds}},
|
||||
"objectives": {
|
||||
"primary": "{{primary_objective}}",
|
||||
"secondary": ["{{secondary_objectives}}"],
|
||||
"hidden": ["{{secret_objectives}}"]
|
||||
},
|
||||
"layout": {
|
||||
"width": {{grid_width}},
|
||||
"height": {{grid_height}},
|
||||
"tilemap": "{{tilemap_reference}}"
|
||||
},
|
||||
"entities": [
|
||||
{
|
||||
"type": "{{entity_type}}",
|
||||
"position": {"x": {{x}}, "y": {{y}}},
|
||||
"properties": {{entity_properties}}
|
||||
}
|
||||
]
|
||||
}
|
||||
- id: asset-integration
|
||||
title: Asset Integration
|
||||
instruction: Define how level assets are organized and loaded
|
||||
template: |
|
||||
**Tilemap Requirements:**
|
||||
|
||||
- Tile size: {{tile_dimensions}}px
|
||||
- Tileset organization: {{tileset_structure}}
|
||||
- Layer organization: {{layer_system}}
|
||||
- Collision data: {{collision_format}}
|
||||
|
||||
**Audio Integration:**
|
||||
|
||||
- Background music: {{music_requirements}}
|
||||
- Ambient sounds: {{ambient_system}}
|
||||
- Dynamic audio: {{dynamic_audio_rules}}
|
||||
- id: performance-optimization
|
||||
title: Performance Optimization
|
||||
instruction: Define performance requirements for level systems
|
||||
template: |
|
||||
**Entity Limits:**
|
||||
|
||||
- Maximum active entities: {{entity_limit}}
|
||||
- Maximum particles: {{particle_limit}}
|
||||
- Maximum audio sources: {{audio_limit}}
|
||||
|
||||
**Memory Management:**
|
||||
|
||||
- Texture memory budget: {{texture_memory}}MB
|
||||
- Audio memory budget: {{audio_memory}}MB
|
||||
- Level loading time: <{{load_time}}s
|
||||
|
||||
**Culling and LOD:**
|
||||
|
||||
- Off-screen culling: {{culling_distance}}
|
||||
- Level-of-detail rules: {{lod_system}}
|
||||
- Asset streaming: {{streaming_requirements}}
|
||||
|
||||
- id: level-testing-framework
|
||||
title: Level Testing Framework
|
||||
instruction: Define how levels should be tested and validated
|
||||
sections:
|
||||
- id: automated-testing
|
||||
title: Automated Testing
|
||||
template: |
|
||||
**Performance Testing:**
|
||||
|
||||
- Frame rate validation: Maintain {{fps_target}} FPS
|
||||
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
||||
- Loading time verification: Complete in <{{load_time}}s
|
||||
|
||||
**Gameplay Testing:**
|
||||
|
||||
- Completion path validation: All objectives achievable
|
||||
- Collectible accessibility: All items reachable
|
||||
- Softlock prevention: No unwinnable states
|
||||
- id: manual-testing-protocol
|
||||
title: Manual Testing Protocol
|
||||
sections:
|
||||
- id: playtesting-checklist
|
||||
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)"
|
||||
- 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"
|
||||
- id: balance-validation
|
||||
title: Balance Validation
|
||||
template: |
|
||||
**Metrics Collection:**
|
||||
|
||||
- Completion rate: Target {{completion_percentage}}%
|
||||
- Average completion time: {{target_time}} ± {{variance}}
|
||||
- Death count per level: <{{max_deaths}}
|
||||
- Collectible discovery rate: {{discovery_percentage}}%
|
||||
|
||||
**Iteration Guidelines:**
|
||||
|
||||
- Adjustment criteria: {{criteria_for_changes}}
|
||||
- Testing sample size: {{minimum_testers}}
|
||||
- Validation period: {{testing_duration}}
|
||||
|
||||
- id: content-creation-pipeline
|
||||
title: Content Creation Pipeline
|
||||
instruction: Define the workflow for creating new levels
|
||||
sections:
|
||||
- id: design-phase
|
||||
title: Design Phase
|
||||
template: |
|
||||
**Concept Development:**
|
||||
|
||||
1. Define level purpose and goals
|
||||
2. Create rough layout sketch
|
||||
3. Identify key mechanics and challenges
|
||||
4. Estimate difficulty and duration
|
||||
|
||||
**Documentation Requirements:**
|
||||
|
||||
- Level design brief
|
||||
- Layout diagrams
|
||||
- Mechanic integration notes
|
||||
- Asset requirement list
|
||||
- id: implementation-phase
|
||||
title: Implementation Phase
|
||||
template: |
|
||||
**Technical Implementation:**
|
||||
|
||||
1. Create level data file
|
||||
2. Build tilemap and layout
|
||||
3. Place entities and objects
|
||||
4. Configure level logic and triggers
|
||||
5. Integrate audio and visual effects
|
||||
|
||||
**Quality Assurance:**
|
||||
|
||||
1. Automated testing execution
|
||||
2. Internal playtesting
|
||||
3. Performance validation
|
||||
4. Bug fixing and polish
|
||||
- id: integration-phase
|
||||
title: Integration Phase
|
||||
template: |
|
||||
**Game Integration:**
|
||||
|
||||
1. Level progression integration
|
||||
2. Save system compatibility
|
||||
3. Analytics integration
|
||||
4. Achievement system integration
|
||||
|
||||
**Final Validation:**
|
||||
|
||||
1. Full game context testing
|
||||
2. Performance regression testing
|
||||
3. Platform compatibility verification
|
||||
4. Final approval and release
|
||||
|
||||
- id: success-metrics
|
||||
title: Success Metrics
|
||||
instruction: Define how to measure level design success
|
||||
sections:
|
||||
- id: player-engagement
|
||||
title: Player Engagement
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Level completion rate: {{target_rate}}%
|
||||
- Replay rate: {{replay_target}}%
|
||||
- Time spent per level: {{engagement_time}}
|
||||
- Player satisfaction scores: {{satisfaction_target}}/10
|
||||
- id: technical-performance
|
||||
title: Technical Performance
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Frame rate consistency: {{fps_consistency}}%
|
||||
- Loading time compliance: {{load_compliance}}%
|
||||
- Memory usage efficiency: {{memory_efficiency}}%
|
||||
- Crash rate: <{{crash_threshold}}%
|
||||
- id: design-quality
|
||||
title: Design Quality
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Difficulty curve adherence: {{curve_accuracy}}
|
||||
- Mechanic integration effectiveness: {{integration_score}}
|
||||
- Player guidance clarity: {{guidance_score}}
|
||||
- Content accessibility: {{accessibility_rate}}%
|
||||
@@ -3,11 +3,19 @@
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-creator-tools
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
agent:
|
||||
name: The Creator
|
||||
id: bmad-the-creator
|
||||
@@ -27,12 +35,6 @@ core_principles:
|
||||
- Convention Over Configuration - Follow BMad naming and structure patterns
|
||||
- Extensibility First - Design for future expansion and customization
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for framework design advice'
|
||||
@@ -43,11 +45,11 @@ commands:
|
||||
- '*exit" - Say goodbye as The Creator, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- generate-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-deep-research-prompt
|
||||
- create-agent.md
|
||||
- generate-expansion-pack.md
|
||||
- advanced-elicitation.md
|
||||
- create-deep-research-prompt.md
|
||||
templates:
|
||||
- agent-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- agent-tmpl.yaml
|
||||
- expansion-pack-plan-tmpl.yaml
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: bmad-creator-tools
|
||||
version: 1.5.0
|
||||
version: 1.7.0
|
||||
short-title: Tools for creating BMad framework components
|
||||
description: Tools for creating and extending BMad framework components.
|
||||
author: Brian (BMad)
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
# Agent Team Configuration Template
|
||||
|
||||
[[LLM: This template is for creating agent team configurations in YAML format. Follow the structure carefully and replace all placeholders with appropriate values. The team name should reflect the team's purpose and domain focus.]]
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: {{team-display-name}}
|
||||
[[LLM: Use format "Team [Descriptor]" for generic teams or "[Domain] Team" for specialized teams. Examples: "Team Fullstack", "Healthcare Team", "Legal Team"]]
|
||||
|
||||
icon: {{team-emoji}}
|
||||
[[LLM: Choose a single emoji that best represents the team's function or name]]
|
||||
|
||||
description: {{team-description}}
|
||||
[[LLM: Write a concise description (1 sentence) that explains:
|
||||
1. The team's primary purpose
|
||||
2. What types of projects they handle
|
||||
3. Any special capabilities or focus areas
|
||||
4. Keep it short as its displayed in menus
|
||||
Example: "Full Stack Ideation Web App Team." or "Startup Business Coaching team"]]
|
||||
|
||||
agents:
|
||||
[[LLM: List the agents that make up this team. Guidelines:
|
||||
- Use shortened agent names (e.g., 'analyst' not 'business-analyst')
|
||||
- Include 'bmad-orchestrator' for bmad-core teams as the coordinator
|
||||
- Only use '*' for an all-inclusive team (rare)
|
||||
- Order agents logically by workflow (analysis → design → development → testing)
|
||||
- For expansion packs, include both core agents and custom agents]]
|
||||
|
||||
^^CONDITION: standard-team^^
|
||||
# Core workflow agents
|
||||
- bmad-orchestrator # Team coordinator
|
||||
- analyst # Requirements and analysis
|
||||
- pm # Product management
|
||||
- architect # System design
|
||||
- dev # Development
|
||||
- qa # Quality assurance
|
||||
^^/CONDITION: standard-team^^
|
||||
|
||||
^^CONDITION: minimal-team^^
|
||||
# Minimal team for quick iterations
|
||||
- bmad-orchestrator # Team coordinator
|
||||
- architect # Design and planning
|
||||
- dev # Implementation
|
||||
^^/CONDITION: minimal-team^^
|
||||
|
||||
^^CONDITION: specialized-team^^
|
||||
# Domain-specific team composition
|
||||
- {{domain}}-orchestrator # Domain coordinator
|
||||
<<REPEAT section="specialist-agents" count="{{agent-count}}">>
|
||||
- {{agent-short-name}} # {{agent-role-description}}
|
||||
<</REPEAT>>
|
||||
^^/CONDITION: specialized-team^^
|
||||
|
||||
^^CONDITION: include-all-agents^^
|
||||
- '*' # Include all available agents
|
||||
^^/CONDITION: include-all-agents^^
|
||||
|
||||
workflows:
|
||||
[[LLM: Define the workflows this team can execute that will guide the user through a multi-step multi agent process. Guidelines:
|
||||
- Use null if the team doesn't have predefined workflows
|
||||
- Workflow names should be descriptive
|
||||
- use domain-specific workflow names]]
|
||||
|
||||
^^CONDITION: no-workflows^^
|
||||
null # No predefined workflows
|
||||
^^/CONDITION: no-workflows^^
|
||||
|
||||
^^CONDITION: standard-workflows^^
|
||||
# New project workflows
|
||||
- greenfield-fullstack # New full-stack application
|
||||
- greenfield-service # New backend service
|
||||
- greenfield-ui # New frontend application
|
||||
|
||||
# Existing project workflows
|
||||
- brownfield-fullstack # Enhance existing full-stack app
|
||||
- brownfield-service # Enhance existing service
|
||||
- brownfield-ui # Enhance existing UI
|
||||
^^/CONDITION: standard-workflows^^
|
||||
|
||||
^^CONDITION: domain-workflows^^
|
||||
# Domain-specific workflows
|
||||
<<REPEAT section="workflows" count="{{workflow-count}}">>
|
||||
- {{workflow-name}} # {{workflow-description}}
|
||||
<</REPEAT>>
|
||||
^^/CONDITION: domain-workflows^^
|
||||
```
|
||||
|
||||
@{example-1: Standard fullstack team}
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: Team Fullstack
|
||||
icon: 🚀
|
||||
description: Complete agile team for full-stack web applications. Handles everything from requirements to deployment.
|
||||
agents:
|
||||
- bmad-orchestrator
|
||||
- analyst
|
||||
- pm
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
- ux-expert
|
||||
workflows:
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
```
|
||||
|
||||
@{example-2: Healthcare expansion pack team}
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: Healthcare Compliance Team
|
||||
icon: ⚕️
|
||||
description: Specialized team for healthcare applications with HIPAA compliance focus. Manages clinical workflows and regulatory requirements.
|
||||
agents:
|
||||
- healthcare-orchestrator
|
||||
- clinical-analyst
|
||||
- compliance-officer
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
workflows:
|
||||
- healthcare-patient-portal
|
||||
- healthcare-compliance-audit
|
||||
- clinical-trial-management
|
||||
```
|
||||
|
||||
@{example-3: Minimal IDE team}
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: Team IDE Minimal
|
||||
icon: ⚡
|
||||
description: Minimal team for IDE usage. Just the essentials for quick development.
|
||||
agents:
|
||||
- bmad-orchestrator
|
||||
- architect
|
||||
- dev
|
||||
workflows: null
|
||||
```
|
||||
|
||||
[[LLM: When creating a new team configuration:
|
||||
|
||||
1. Choose the most appropriate condition block based on team type
|
||||
2. Remove all unused condition blocks
|
||||
3. Replace all placeholders with actual values
|
||||
4. Ensure agent names match available agents in the system
|
||||
5. Verify workflow names match available workflows
|
||||
6. Save as team-[descriptor].yaml or [domain]-team.yaml
|
||||
7. Place in the agent-teams directory of the appropriate location]]
|
||||
@@ -0,0 +1,178 @@
|
||||
template:
|
||||
id: agent-teams-template-v2
|
||||
name: Agent Team Configuration
|
||||
version: 2.0
|
||||
output:
|
||||
format: yaml
|
||||
filename: "agent-teams/{{team_name}}.yaml"
|
||||
title: "{{team_name}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: header
|
||||
title: Agent Team Configuration Template
|
||||
instruction: |
|
||||
This template is for creating agent team configurations in YAML format. Follow the structure carefully and replace all placeholders with appropriate values. The team name should reflect the team's purpose and domain focus.
|
||||
|
||||
- id: yaml-configuration
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
bundle:
|
||||
name: {{team_display_name}}
|
||||
icon: {{team_emoji}}
|
||||
description: {{team_description}}
|
||||
|
||||
agents:
|
||||
{{agent_list}}
|
||||
|
||||
workflows:
|
||||
{{workflow_list}}
|
||||
instruction: |
|
||||
Use format "Team [Descriptor]" for generic teams or "[Domain] Team" for specialized teams. Examples: "Team Fullstack", "Healthcare Team", "Legal Team"
|
||||
|
||||
Choose a single emoji that best represents the team's function or name
|
||||
|
||||
Write a concise description (1 sentence) that explains:
|
||||
1. The team's primary purpose
|
||||
2. What types of projects they handle
|
||||
3. Any special capabilities or focus areas
|
||||
4. Keep it short as its displayed in menus
|
||||
Example: "Full Stack Ideation Web App Team." or "Startup Business Coaching team"
|
||||
|
||||
List the agents that make up this team. Guidelines:
|
||||
- Use shortened agent names (e.g., 'analyst' not 'business-analyst')
|
||||
- Include 'bmad-orchestrator' for bmad-core teams as the coordinator
|
||||
- Only use '*' for an all-inclusive team (rare)
|
||||
- Order agents logically by workflow (analysis → design → development → testing)
|
||||
- For expansion packs, include both core agents and custom agents
|
||||
|
||||
Define the workflows this team can execute that will guide the user through a multi-step multi agent process. Guidelines:
|
||||
- Use null if the team doesn't have predefined workflows
|
||||
- Workflow names should be descriptive
|
||||
- use domain-specific workflow names
|
||||
sections:
|
||||
- id: standard-team
|
||||
condition: Standard team configuration
|
||||
template: |
|
||||
# Core workflow agents
|
||||
- bmad-orchestrator # Team coordinator
|
||||
- analyst # Requirements and analysis
|
||||
- pm # Product management
|
||||
- architect # System design
|
||||
- dev # Development
|
||||
- qa # Quality assurance
|
||||
- id: minimal-team
|
||||
condition: Minimal team configuration
|
||||
template: |
|
||||
# Minimal team for quick iterations
|
||||
- bmad-orchestrator # Team coordinator
|
||||
- architect # Design and planning
|
||||
- dev # Implementation
|
||||
- id: specialized-team
|
||||
condition: Domain-specific team
|
||||
template: |
|
||||
# Domain-specific team composition
|
||||
- {{domain}}-orchestrator # Domain coordinator
|
||||
- {{agent_short_name}} # {{agent_role_description}}
|
||||
- id: all-agents
|
||||
condition: Include all available agents
|
||||
template: |
|
||||
- '*' # Include all available agents
|
||||
- id: no-workflows
|
||||
condition: No predefined workflows
|
||||
template: |
|
||||
null # No predefined workflows
|
||||
- id: standard-workflows
|
||||
condition: Standard project workflows
|
||||
template: |
|
||||
# New project workflows
|
||||
- greenfield-fullstack # New full-stack application
|
||||
- greenfield-service # New backend service
|
||||
- greenfield-ui # New frontend application
|
||||
|
||||
# Existing project workflows
|
||||
- brownfield-fullstack # Enhance existing full-stack app
|
||||
- brownfield-service # Enhance existing service
|
||||
- brownfield-ui # Enhance existing UI
|
||||
- id: domain-workflows
|
||||
condition: Domain-specific workflows
|
||||
template: |
|
||||
# Domain-specific workflows
|
||||
- {{workflow_name}} # {{workflow_description}}
|
||||
|
||||
- id: examples
|
||||
title: Examples
|
||||
sections:
|
||||
- id: example-1
|
||||
title: "Example 1: Standard fullstack team"
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
bundle:
|
||||
name: Team Fullstack
|
||||
icon: 🚀
|
||||
description: Complete agile team for full-stack web applications. Handles everything from requirements to deployment.
|
||||
agents:
|
||||
- bmad-orchestrator
|
||||
- analyst
|
||||
- pm
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
- ux-expert
|
||||
workflows:
|
||||
- greenfield-fullstack
|
||||
- greenfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-fullstack
|
||||
- brownfield-service
|
||||
- brownfield-ui
|
||||
- id: example-2
|
||||
title: "Example 2: Healthcare expansion pack team"
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
bundle:
|
||||
name: Healthcare Compliance Team
|
||||
icon: ⚕️
|
||||
description: Specialized team for healthcare applications with HIPAA compliance focus. Manages clinical workflows and regulatory requirements.
|
||||
agents:
|
||||
- healthcare-orchestrator
|
||||
- clinical-analyst
|
||||
- compliance-officer
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
workflows:
|
||||
- healthcare-patient-portal
|
||||
- healthcare-compliance-audit
|
||||
- clinical-trial-management
|
||||
- id: example-3
|
||||
title: "Example 3: Minimal IDE team"
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
bundle:
|
||||
name: Team IDE Minimal
|
||||
icon: ⚡
|
||||
description: Minimal team for IDE usage. Just the essentials for quick development.
|
||||
agents:
|
||||
- bmad-orchestrator
|
||||
- architect
|
||||
- dev
|
||||
workflows: null
|
||||
|
||||
- id: creation-instructions
|
||||
instruction: |
|
||||
When creating a new team configuration:
|
||||
|
||||
1. Choose the most appropriate condition block based on team type
|
||||
2. Remove all unused condition blocks
|
||||
3. Replace all placeholders with actual values
|
||||
4. Ensure agent names match available agents in the system
|
||||
5. Verify workflow names match available workflows
|
||||
6. Save as team-[descriptor].yaml or [domain]-team.yaml
|
||||
7. Place in the agent-teams directory of the appropriate location
|
||||
@@ -1,143 +0,0 @@
|
||||
# [AGENT_ID]
|
||||
|
||||
[[LLM: This is an agent definition template. When creating a new agent:
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions]]
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
|
||||
agent:
|
||||
name: [AGENT_NAME]
|
||||
id: [AGENT_ID]
|
||||
title: [AGENT_TITLE]
|
||||
customization: [OPTIONAL_CUSTOMIZATION]
|
||||
|
||||
persona:
|
||||
role: [AGENT_ROLE_DESCRIPTION]
|
||||
style: [COMMUNICATION_STYLE]
|
||||
identity: [AGENT_IDENTITY_DESCRIPTION]
|
||||
focus: [PRIMARY_FOCUS_AREAS]
|
||||
|
||||
core_principles:
|
||||
- [PRINCIPLE_1]
|
||||
- [PRINCIPLE_2]
|
||||
- [PRINCIPLE_3]
|
||||
# Add more principles as needed
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- [STARTUP_INSTRUCTION]
|
||||
- [STARTUP_INSTRUCTION]...
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) [DEFAULT_MODE_DESCRIPTION]
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
[[LLM: For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process]]
|
||||
- [tasks] specific to the agent that are not covered by a template
|
||||
[[LLM: Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution]]
|
||||
- "*exit" - Say goodbye as the [AGENT_TITLE], and then abandon inhabiting this persona
|
||||
|
||||
dependencies:
|
||||
[[LLM: CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)]]
|
||||
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
- [TASK_1] # Custom task for non-document operations
|
||||
- [TASK_2] # Another custom task
|
||||
[[LLM: Example tasks: validate-design, analyze-requirements, execute-tests]]
|
||||
|
||||
templates:
|
||||
- [TEMPLATE_1] # Template with LLM instructions for guided creation
|
||||
- [TEMPLATE_2] # Another template for different document type
|
||||
[[LLM: Example: blueprint-tmpl, contract-tmpl, report-tmpl
|
||||
Each template should include [[LLM: guidance]] and other conventions from `template-format.md` sections for user interaction]]
|
||||
|
||||
checklists:
|
||||
- [CHECKLIST_1] # Quality validation for template outputs
|
||||
[[LLM: Example: blueprint-checklist, contract-checklist
|
||||
Checklists validate documents created from templates]]
|
||||
|
||||
data:
|
||||
- [DATA_1] # Domain knowledge files
|
||||
[[LLM: Example: building-codes.md, legal-terminology.md
|
||||
Can be embedded in pack or required from user]]
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
- [UTIL_1] # Other utilities as needed
|
||||
[[LLM: Include workflow-management if agent participates in workflows]]
|
||||
```
|
||||
|
||||
@{example: Construction Contractor Agent}
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
```
|
||||
154
expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml
Normal file
154
expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml
Normal file
@@ -0,0 +1,154 @@
|
||||
template:
|
||||
id: agent-template-v2
|
||||
name: Agent Definition
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "agents/{{agent_id}}.md"
|
||||
title: "{{agent_id}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: header
|
||||
title: "{{agent_id}}"
|
||||
instruction: |
|
||||
This is an agent definition template. When creating a new agent:
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions
|
||||
|
||||
- id: agent-definition
|
||||
content: |
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
sections:
|
||||
- id: yaml-definition
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
|
||||
agent:
|
||||
name: {{agent_name}}
|
||||
id: {{agent_id}}
|
||||
title: {{agent_title}}
|
||||
customization: {{optional_customization}}
|
||||
|
||||
persona:
|
||||
role: {{agent_role_description}}
|
||||
style: {{communication_style}}
|
||||
identity: {{agent_identity_description}}
|
||||
focus: {{primary_focus_areas}}
|
||||
|
||||
core_principles:
|
||||
- {{principle_1}}
|
||||
- {{principle_2}}
|
||||
- {{principle_3}}
|
||||
# Add more principles as needed
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- {{startup_instruction_1}}
|
||||
- {{startup_instruction_2}}
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) {{default_mode_description}}
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
{{custom_commands}}
|
||||
- "*exit" - Say goodbye as the {{agent_title}}, and then abandon inhabiting this persona
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
{{task_list}}
|
||||
|
||||
templates:
|
||||
{{template_list}}
|
||||
|
||||
checklists:
|
||||
{{checklist_list}}
|
||||
|
||||
data:
|
||||
{{data_list}}
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
{{util_list}}
|
||||
instruction: |
|
||||
For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process
|
||||
|
||||
Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution
|
||||
|
||||
CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)
|
||||
|
||||
- id: example
|
||||
title: Example: Construction Contractor Agent
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
@@ -1,91 +0,0 @@
|
||||
# {Pack Name} Expansion Pack Plan
|
||||
|
||||
## Overview
|
||||
|
||||
- **Pack Name**: {pack-identifier}
|
||||
- **Display Name**: {Full Expansion Pack Name}
|
||||
- **Description**: {Brief description of what this pack does}
|
||||
- **Target Domain**: {Industry/domain this serves}
|
||||
- **Author**: {Your name/organization}
|
||||
|
||||
## Problem Statement
|
||||
|
||||
{What specific challenges does this expansion pack solve?}
|
||||
|
||||
## Target Users
|
||||
|
||||
{Who will benefit from this expansion pack?}
|
||||
|
||||
## Components to Create
|
||||
|
||||
### Agents
|
||||
|
||||
- [ ] `{pack-name}-orchestrator` - **REQUIRED**: Master orchestrator for {domain} workflows
|
||||
- Key commands: {list main commands}
|
||||
- Manages: {what it orchestrates}
|
||||
- [ ] `{agent-1-name}` - {Role description}
|
||||
- Tasks used: {task-1}, {task-2}
|
||||
- Templates used: {template-1}
|
||||
- Data required: {data-file-1}
|
||||
- [ ] `{agent-2-name}` - {Role description}
|
||||
- Tasks used: {task-3}
|
||||
- Templates used: {template-2}
|
||||
- Data required: {data-file-2}
|
||||
|
||||
### Tasks
|
||||
|
||||
- [ ] `{task-1}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-2}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-3}.md` - {Purpose} (used by: {agent})
|
||||
|
||||
### Templates
|
||||
|
||||
- [ ] `{template-1}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
- [ ] `{template-2}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
|
||||
### Checklists
|
||||
|
||||
- [ ] `{checklist-1}-checklist.md` - {What it validates}
|
||||
- [ ] `{checklist-2}-checklist.md` - {What it validates}
|
||||
|
||||
### Data Files Required from User
|
||||
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
|
||||
- [ ] `{data-file-1}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
- [ ] `{data-file-2}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
1. {Step 1 - typically starts with orchestrator}
|
||||
2. {Step 2}
|
||||
3. {Step 3}
|
||||
4. {Final output/deliverable}
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Depends on core agents: {list any core BMad agents used}
|
||||
- Extends teams: {which teams to update}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- [ ] All components created and cross-referenced
|
||||
- [ ] No orphaned task/template references
|
||||
- [ ] Data requirements clearly documented
|
||||
- [ ] Orchestrator provides clear workflow
|
||||
- [ ] README includes setup instructions
|
||||
|
||||
## User Approval
|
||||
|
||||
- [ ] Plan reviewed by user
|
||||
- [ ] Approval to proceed with implementation
|
||||
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
@@ -0,0 +1,120 @@
|
||||
template:
|
||||
id: expansion-pack-plan-template-v2
|
||||
name: Expansion Pack Plan
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "{{pack_name}}-expansion-pack-plan.md"
|
||||
title: "{{pack_display_name}} Expansion Pack Plan"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: overview
|
||||
title: Overview
|
||||
template: |
|
||||
- **Pack Name**: {{pack_identifier}}
|
||||
- **Display Name**: {{full_expansion_pack_name}}
|
||||
- **Description**: {{brief_description}}
|
||||
- **Target Domain**: {{industry_domain}}
|
||||
- **Author**: {{author_name_organization}}
|
||||
|
||||
- id: problem-statement
|
||||
title: Problem Statement
|
||||
instruction: What specific challenges does this expansion pack solve?
|
||||
template: "{{problem_description}}"
|
||||
|
||||
- id: target-users
|
||||
title: Target Users
|
||||
instruction: Who will benefit from this expansion pack?
|
||||
template: "{{target_user_description}}"
|
||||
|
||||
- id: components
|
||||
title: Components to Create
|
||||
sections:
|
||||
- id: agents
|
||||
title: Agents
|
||||
type: checklist
|
||||
instruction: List all agents to be created with their roles and dependencies
|
||||
items:
|
||||
- id: orchestrator
|
||||
template: |
|
||||
`{{pack_name}}-orchestrator` - **REQUIRED**: Master orchestrator for {{domain}} workflows
|
||||
- Key commands: {{command_list}}
|
||||
- Manages: {{orchestration_scope}}
|
||||
- id: agent-list
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{agent_name}}` - {{role_description}}
|
||||
- Tasks used: {{task_list}}
|
||||
- Templates used: {{template_list}}
|
||||
- Data required: {{data_requirements}}
|
||||
|
||||
- id: tasks
|
||||
title: Tasks
|
||||
type: checklist
|
||||
instruction: List all tasks to be created
|
||||
repeatable: true
|
||||
template: "`{{task_name}}.md` - {{purpose}} (used by: {{using_agents}})"
|
||||
|
||||
- id: templates
|
||||
title: Templates
|
||||
type: checklist
|
||||
instruction: List all templates to be created
|
||||
repeatable: true
|
||||
template: "`{{template_name}}-tmpl.md` - {{document_type}} (used by: {{using_components}})"
|
||||
|
||||
- id: checklists
|
||||
title: Checklists
|
||||
type: checklist
|
||||
instruction: List all checklists to be created
|
||||
repeatable: true
|
||||
template: "`{{checklist_name}}-checklist.md` - {{validation_purpose}}"
|
||||
|
||||
- id: data-files
|
||||
title: Data Files Required from User
|
||||
instruction: |
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
type: checklist
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{data_filename}}.{{extension}}` - {{content_description}}
|
||||
- Format: {{file_format}}
|
||||
- Purpose: {{why_needed}}
|
||||
- Example: {{brief_example}}
|
||||
|
||||
- id: workflow-overview
|
||||
title: Workflow Overview
|
||||
type: numbered-list
|
||||
instruction: Describe the typical workflow steps
|
||||
template: "{{workflow_step}}"
|
||||
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
template: |
|
||||
- Depends on core agents: {{core_agent_dependencies}}
|
||||
- Extends teams: {{team_updates}}
|
||||
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
type: checklist
|
||||
items:
|
||||
- "All components created and cross-referenced"
|
||||
- "No orphaned task/template references"
|
||||
- "Data requirements clearly documented"
|
||||
- "Orchestrator provides clear workflow"
|
||||
- "README includes setup instructions"
|
||||
|
||||
- id: user-approval
|
||||
title: User Approval
|
||||
type: checklist
|
||||
items:
|
||||
- "Plan reviewed by user"
|
||||
- "Approval to proceed with implementation"
|
||||
|
||||
- id: next-steps
|
||||
content: |
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
@@ -3,11 +3,18 @@
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
```yaml
|
||||
root: .bmad-infrastructure-devops
|
||||
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Announce: Hey! I'm Alex, your DevOps Infrastructure Specialist. I love when things run secure, stable, reliable and performant. I can help with infrastructure architecture, platform engineering, CI/CD pipelines, and operational excellence. What infrastructure challenge can I help you with today?
|
||||
- "List available tasks: review-infrastructure, validate-infrastructure, create infrastructure documentation"
|
||||
- "List available templates: infrastructure-architecture, infrastructure-platform-from-arch"
|
||||
- Execute selected task or stay in persona to help guided by Core DevOps Principles
|
||||
agent:
|
||||
name: Alex
|
||||
id: infra-devops-platform
|
||||
@@ -29,11 +36,6 @@ persona:
|
||||
- CI/CD Excellence - Build robust pipelines for fast, safe, reliable software delivery through automation and testing
|
||||
- Disaster Recovery - Plan for worst-case scenarios with backup strategies and regularly tested recovery procedures
|
||||
- Collaborative Operations - Work closely with development teams fostering shared responsibility for system reliability
|
||||
startup:
|
||||
- Announce: Hey! I'm Alex, your DevOps Infrastructure Specialist. I love when things run secure, stable, reliable and performant. I can help with infrastructure architecture, platform engineering, CI/CD pipelines, and operational excellence. What infrastructure challenge can I help you with today?
|
||||
- "List available tasks: review-infrastructure, validate-infrastructure, create infrastructure documentation"
|
||||
- "List available templates: infrastructure-architecture, infrastructure-platform-from-arch"
|
||||
- Execute selected task or stay in persona to help guided by Core DevOps Principles
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - (Default) Conversational mode for infrastructure and DevOps guidance'
|
||||
@@ -44,16 +46,14 @@ commands:
|
||||
- '*exit" - Say goodbye as Alex, the DevOps Infrastructure Specialist, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- review-infrastructure
|
||||
- validate-infrastructure
|
||||
- create-doc.md
|
||||
- review-infrastructure.md
|
||||
- validate-infrastructure.md
|
||||
templates:
|
||||
- infrastructure-architecture-tmpl
|
||||
- infrastructure-platform-from-arch-tmpl
|
||||
- infrastructure-architecture-tmpl.yaml
|
||||
- infrastructure-platform-from-arch-tmpl.yaml
|
||||
checklists:
|
||||
- infrastructure-checklist
|
||||
- infrastructure-checklist.md
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
- template-format
|
||||
- technical-preferences.md
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: bmad-infrastructure-devops
|
||||
version: 1.5.0
|
||||
version: 1.7.0
|
||||
short-title: Infrastructure and DevOps capabilities
|
||||
description: >-
|
||||
This expansion pack extends BMad Method with comprehensive infrastructure and
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user