Compare commits
22 Commits
c085b9794a
...
5bfbe77110
| Author | SHA1 | Date |
|---|---|---|
|
|
5bfbe77110 | |
|
|
aa573bdbb8 | |
|
|
3f688d5669 | |
|
|
eb88384d9e | |
|
|
469a2e288c | |
|
|
8bb2615561 | |
|
|
d97b9b9cf9 | |
|
|
3aebb87ab8 | |
|
|
5c924b3af1 | |
|
|
66bae0ece4 | |
|
|
e8f76504af | |
|
|
e0b1b7cd9d | |
|
|
2159182fdf | |
|
|
bb1b470080 | |
|
|
834b417460 | |
|
|
d50b7c13dc | |
|
|
a351874068 | |
|
|
f7fd90297e | |
|
|
b75f3fbefd | |
|
|
c892eaa00c | |
|
|
124b7164bd | |
|
|
378f96cd43 |
35
CHANGELOG.md
35
CHANGELOG.md
|
|
@ -1,5 +1,40 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [6.0.0]
|
||||||
|
|
||||||
|
V6 Stable Release! The End of Beta!
|
||||||
|
|
||||||
|
### 🎁 Features
|
||||||
|
|
||||||
|
* Add PRD workflow steps 2b (vision/differentiators) and 2c (executive summary) for more complete product requirements documentation
|
||||||
|
* Add new `bmad uninstall` command with interactive and non-interactive modes for selective component removal
|
||||||
|
* Add dedicated GitHub Copilot installer that generates enriched `.agent.md`, `.prompt.md` files and project configuration
|
||||||
|
* Add TEA browser automation prerequisite prompts to guide Playwright CLI/MCP setup after configuration
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
* Fix version comparison to use semantic versioning, preventing incorrect downgrade recommendations to older beta versions
|
||||||
|
* Fix `--custom-content` flag to properly populate sources and selected files in module config
|
||||||
|
* Fix module configuration UX messaging to show accurate completion status and improve feedback timing
|
||||||
|
* Fix changelog URL in installer start message for proper GitHub resolution
|
||||||
|
* Remove incorrect `mode: primary` from OpenCode agent template and restore `name` field across all templates
|
||||||
|
* Auto-discover PRD files in validate-prd workflow to reduce manual path input
|
||||||
|
* Fix installer non-interactive mode hanging and improve IDE configuration handling during updates
|
||||||
|
* Fix workflow-level config.yaml copying for custom content modules
|
||||||
|
|
||||||
|
### ♻️ Refactoring
|
||||||
|
|
||||||
|
* Remove alias variables from Phase 4 workflows, use canonical `{implementation_artifacts}` and `{planning_artifacts}`
|
||||||
|
* Add missing `project_context` references to workflows for consistency
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
* Add post-install notes documentation for modules
|
||||||
|
* Improve project-context documentation and fix folder structure
|
||||||
|
* Add BMad Builder link to index for extenders
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [6.0.0-Beta.8]
|
## [6.0.0-Beta.8]
|
||||||
|
|
||||||
**Release: February 8, 2026**
|
**Release: February 8, 2026**
|
||||||
|
|
|
||||||
116
README.md
116
README.md
|
|
@ -5,20 +5,22 @@
|
||||||
[](https://nodejs.org)
|
[](https://nodejs.org)
|
||||||
[](https://discord.gg/gk8jAdXWmj)
|
[](https://discord.gg/gk8jAdXWmj)
|
||||||
|
|
||||||
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development module for the BMad Method Module Ecosystem, the best and most comprehensive Agile AI Driven Development framework that has true scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
||||||
|
|
||||||
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay for a gated community or courses.
|
||||||
|
|
||||||
## Why BMad?
|
## Why the BMad Method?
|
||||||
|
|
||||||
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflows act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
||||||
|
|
||||||
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
|
- **AI Intelligent Help** — Ask `/bmad-help` anytime for guidance on what's next
|
||||||
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
|
- **Scale-Domain-Adaptive** — Automatically adjusts planning depth based on project complexity
|
||||||
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
- **Structured Workflows** — Grounded in agile best practices across analysis, planning, architecture, and implementation
|
||||||
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
- **Specialized Agents** — 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
||||||
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
|
- **Party Mode** — Bring multiple agent personas into one session to collaborate and discuss
|
||||||
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
|
- **Complete Lifecycle** — From brainstorming to deployment
|
||||||
|
|
||||||
|
[Learn more at **docs.bmad-method.org**](http://docs.bmad-method.org)
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
|
@ -28,103 +30,39 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
||||||
npx bmad-method install
|
npx bmad-method install
|
||||||
```
|
```
|
||||||
|
|
||||||
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
Follow the installer prompts, then open your AI IDE (Claude Code, Codex, Windsurf, etc.) in your project folder.
|
||||||
|
|
||||||
**Non-Interactive Installation**: For CI/CD pipelines or automated deployments, use command-line flags:
|
**Non-Interactive Installation** (for CI/CD):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
||||||
```
|
```
|
||||||
|
|
||||||
See [Non-Interactive Installation Guide](http://docs.bmad-method.org/how-to/non-interactive-installation/) for all available options.
|
[See all installation options](http://docs.bmad-method.org/how-to/non-interactive-installation/)
|
||||||
|
|
||||||
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask questions like `/bmad-help I just finished the architecture, what do I do next?`
|
||||||
|
|
||||||
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
|
||||||
- `/bmad-help I just finished the architecture, I am not sure what to do next`
|
|
||||||
|
|
||||||
And the amazing thing is BMad Help evolves depending on what modules you install also!
|
|
||||||
- `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
|
|
||||||
|
|
||||||
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
|
|
||||||
|
|
||||||
### Simple Path (Quick Flow)
|
|
||||||
|
|
||||||
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
|
|
||||||
|
|
||||||
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|
|
||||||
2. `/dev-story` — implements each story
|
|
||||||
3. `/code-review` — validates quality
|
|
||||||
|
|
||||||
### Full Planning Path (BMad Method)
|
|
||||||
|
|
||||||
Products, platforms, complex features — structured planning then build:
|
|
||||||
|
|
||||||
1. `/product-brief` — define problem, users, and MVP scope
|
|
||||||
2. `/create-prd` — full requirements with personas, metrics, and risks
|
|
||||||
3. `/create-architecture` — technical decisions and system design
|
|
||||||
4. `/create-epics-and-stories` — break work into prioritized stories
|
|
||||||
5. `/sprint-planning` — initialize sprint tracking
|
|
||||||
6. **Repeat per story:** `/create-story` → `/dev-story` → `/code-review`
|
|
||||||
|
|
||||||
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/).
|
|
||||||
|
|
||||||
## Modules
|
## Modules
|
||||||
|
|
||||||
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
|
BMad Method extends with official modules for specialized domains. Available during installation or anytime after.
|
||||||
|
|
||||||
| Module | GitHub | NPM | Purpose |
|
| Module | Purpose |
|
||||||
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
||||||
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
| **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | Core framework with 34+ workflows |
|
||||||
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
| **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | Create custom BMad agents and workflows |
|
||||||
| **Test Architect (TEA)** 🆕 | [bmad-code-org/tea](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise) | [tea](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise) | Risk-based test strategy, automation, and release gates (8 workflows) |
|
| **[Test Architect (TEA)](https://github.com/bmad-code-org/tea)** | Risk-based test strategy and automation |
|
||||||
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Game development workflows (Unity, Unreal, Godot) |
|
||||||
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
| **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | Innovation, brainstorming, design thinking |
|
||||||
|
|
||||||
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
|
|
||||||
|
|
||||||
## Testing Agents
|
|
||||||
|
|
||||||
BMad provides two testing options to fit your needs:
|
|
||||||
|
|
||||||
### Quinn (QA) - Built-in
|
|
||||||
|
|
||||||
**Quick test automation for rapid coverage**
|
|
||||||
|
|
||||||
- ✅ **Always available** in BMM module (no separate install)
|
|
||||||
- ✅ **Simple**: One workflow (`QA` - Automate)
|
|
||||||
- ✅ **Beginner-friendly**: Standard test framework patterns
|
|
||||||
- ✅ **Fast**: Generate tests and ship
|
|
||||||
|
|
||||||
**Use Quinn for:** Small projects, quick coverage, standard patterns
|
|
||||||
|
|
||||||
### Test Architect (TEA) - Optional Module
|
|
||||||
|
|
||||||
**Enterprise-grade test strategy and quality engineering**
|
|
||||||
|
|
||||||
- 🆕 **Standalone module** (install separately)
|
|
||||||
- 🏗️ **Comprehensive**: 8 workflows covering full test lifecycle
|
|
||||||
- 🎯 **Advanced**: Risk-based planning, quality gates, NFR assessment
|
|
||||||
- 📚 **Knowledge-driven**: 34 testing patterns and best practices
|
|
||||||
- 📖 [Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
|
||||||
|
|
||||||
**Use TEA for:** Enterprise projects, test strategy, compliance, release gates
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
**[BMad Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
[BMad Method Docs Site](http://docs.bmad-method.org) — Tutorials, guides, concepts, and reference
|
||||||
**[Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)** — TEA standalone module documentation
|
|
||||||
|
|
||||||
|
**Quick links:**
|
||||||
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
||||||
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
||||||
- [Test Architect Migration Guide](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/migration/) — Upgrading from BMM-embedded TEA
|
- [Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||||
|
|
||||||
### For v4 Users
|
|
||||||
|
|
||||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
|
||||||
- If you need to install V4, you can do this with `npx bmad-method@4.44.3 install` - similar for any past version.
|
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ title: Welcome to the BMad Method
|
||||||
description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning
|
description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning
|
||||||
---
|
---
|
||||||
|
|
||||||
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software through the whole process from ideation and planning all the way through agentic implementation. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity, whether you're fixing a bug or building an enterprise platform.
|
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework module within the BMad Method Ecosystem that helps you build software through the whole process from ideation and planning all the way through agentic implementation. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity, whether you're fixing a bug or building an enterprise platform.
|
||||||
|
|
||||||
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
|
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
|
||||||
|
|
||||||
|
|
@ -25,6 +25,10 @@ These docs are organized into four sections based on what you're trying to do:
|
||||||
| **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. |
|
| **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. |
|
||||||
| **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. |
|
| **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. |
|
||||||
|
|
||||||
|
## Extend and Customize
|
||||||
|
|
||||||
|
Want to expand BMad with your own agents, workflows, or modules? The **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** provides the framework and tools for creating custom extensions, whether you're adding new capabilities to BMad or building entirely new modules from scratch.
|
||||||
|
|
||||||
## What You'll Need
|
## What You'll Need
|
||||||
|
|
||||||
BMad works with any AI coding assistant that supports custom system prompts or project context. Popular options include:
|
BMad works with any AI coding assistant that supports custom system prompts or project context. Popular options include:
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,12 @@
|
||||||
{
|
{
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "6.0.0-Beta.8",
|
"version": "6.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "6.0.0-Beta.8",
|
"version": "6.0.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@clack/core": "^1.0.0",
|
"@clack/core": "^1.0.0",
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"$schema": "https://json.schemastore.org/package.json",
|
"$schema": "https://json.schemastore.org/package.json",
|
||||||
"name": "bmad-method",
|
"name": "bmad-method",
|
||||||
"version": "6.0.0-Beta.8",
|
"version": "6.0.0",
|
||||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"agile",
|
"agile",
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,9 @@ Also - when searching - documents can be a single markdown file, or a folder wit
|
||||||
|
|
||||||
Try to discover the following:
|
Try to discover the following:
|
||||||
- Product Brief (`*brief*.md`)
|
- Product Brief (`*brief*.md`)
|
||||||
- Research Documents (`*prd*.md`)
|
- PRD (`*prd*.md`) - PRIMARY input: contains FRs and NFRs the UX must address
|
||||||
|
- Architecture Document (`*architecture*.md`) - Contains technical constraints that affect UX decisions (API limits, platform requirements, performance budgets)
|
||||||
|
- StRS (`*strs*.md`) - Enterprise track: contains user profiles and operational scenarios
|
||||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||||
- Project Context (`**/project-context.md`)
|
- Project Context (`**/project-context.md`)
|
||||||
|
|
||||||
|
|
@ -98,8 +100,10 @@ Report what was found:
|
||||||
|
|
||||||
**Documents Found:**
|
**Documents Found:**
|
||||||
|
|
||||||
- PRD: {number of PRD files loaded or "None found"}
|
- PRD: {number of PRD files loaded or "None found"} ← Key: FRs define what UX must address
|
||||||
- Product brief: {number of brief files loaded or "None found"}
|
- Product brief: {number of brief files loaded or "None found"}
|
||||||
|
- Architecture: {found or "None found"} ← Key: Technical constraints that affect UX
|
||||||
|
- StRS: {found or "None found"} ← Enterprise: User profiles and scenarios
|
||||||
- Other context: {number of other files loaded or "None found"}
|
- Other context: {number of other files loaded or "None found"}
|
||||||
|
|
||||||
**Files loaded:** {list of specific file names or "No additional documents found"}
|
**Files loaded:** {list of specific file names or "No additional documents found"}
|
||||||
|
|
|
||||||
|
|
@ -227,7 +227,7 @@ Show the generated responsive and accessibility content and present choices:
|
||||||
|
|
||||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||||
- Update frontmatter: append step to end of stepsCompleted array
|
- Update frontmatter: append step to end of stepsCompleted array
|
||||||
- Load `./step-14-complete.md`
|
- Load `./step-13b-requirements-validation.md`
|
||||||
|
|
||||||
## APPEND TO DOCUMENT:
|
## APPEND TO DOCUMENT:
|
||||||
|
|
||||||
|
|
@ -259,6 +259,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||||
|
|
||||||
## NEXT STEP:
|
## NEXT STEP:
|
||||||
|
|
||||||
After user selects 'C' and content is saved to document, load `./step-14-complete.md` to finalize the UX design workflow.
|
After user selects 'C' and content is saved to document, load `./step-13b-requirements-validation.md` to finalize the UX design workflow.
|
||||||
|
|
||||||
Remember: Do NOT proceed to step-14 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
Remember: Do NOT proceed to step-14 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,176 @@
|
||||||
|
# Step 13b: Requirements Validation & Handoff Checklist
|
||||||
|
|
||||||
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||||
|
|
||||||
|
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action
|
||||||
|
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||||
|
- 🎯 This step validates UX design completeness against PRD requirements
|
||||||
|
- 📋 YOU ARE A VALIDATION FACILITATOR for this step
|
||||||
|
|
||||||
|
## EXECUTION PROTOCOLS:
|
||||||
|
|
||||||
|
- 🎯 Load PRD and validate requirements coverage
|
||||||
|
- 🎯 Load Architecture document and check constraint alignment
|
||||||
|
- ⚠️ Present findings with A/P/C menu
|
||||||
|
- 💾 ONLY save when user chooses C (Continue)
|
||||||
|
- 📖 Update output file frontmatter, adding this step to stepsCompleted
|
||||||
|
- 🚫 FORBIDDEN to load next step until C is selected
|
||||||
|
|
||||||
|
## CONTEXT BOUNDARIES:
|
||||||
|
|
||||||
|
- Complete UX design specification from all previous steps is available
|
||||||
|
- PRD (if loaded at init) contains FRs/NFRs that UX must address
|
||||||
|
- Architecture (if loaded at init) contains technical constraints
|
||||||
|
- Focus on validating coverage and creating handoff artifacts
|
||||||
|
|
||||||
|
## YOUR TASK:
|
||||||
|
|
||||||
|
Validate that the UX design addresses PRD requirements, respects architecture constraints, and prepare handoff artifacts for downstream workflows (Architecture, Epics & Stories).
|
||||||
|
|
||||||
|
## VALIDATION & HANDOFF SEQUENCE:
|
||||||
|
|
||||||
|
### 1. Requirements Coverage Validation
|
||||||
|
|
||||||
|
If PRD was loaded during initialization:
|
||||||
|
|
||||||
|
**Extract PRD Functional Requirements:**
|
||||||
|
- Load the PRD and find all FRs
|
||||||
|
- For each FR, determine if the UX design addresses it
|
||||||
|
|
||||||
|
**Create Coverage Matrix:**
|
||||||
|
- Map each FR to UX design elements (user journeys, components, patterns)
|
||||||
|
- Identify FRs NOT addressed by UX design
|
||||||
|
- For unaddressed FRs, determine if they are:
|
||||||
|
- Non-UI FRs (backend-only, no UX needed) → Mark as N/A
|
||||||
|
- Missing from UX design → Flag as GAP
|
||||||
|
|
||||||
|
**Present to user:**
|
||||||
|
"I've validated your UX design against the PRD requirements:
|
||||||
|
|
||||||
|
**FR Coverage:**
|
||||||
|
|
||||||
|
| FR | Description | UX Element | Status |
|
||||||
|
|----|-------------|-----------|--------|
|
||||||
|
| FR1 | [desc] | [journey/component/pattern] | ✅ Covered |
|
||||||
|
| FR5 | [desc] | - | ⚠️ Gap (UI feature) |
|
||||||
|
| FR8 | [desc] | N/A | ➖ Backend only |
|
||||||
|
|
||||||
|
**Coverage: [X]% of UI-relevant FRs addressed**
|
||||||
|
**Gaps found: [count]**"
|
||||||
|
|
||||||
|
If PRD was NOT loaded:
|
||||||
|
- Note that requirements validation could not be performed
|
||||||
|
- Recommend running this check later when PRD is available
|
||||||
|
|
||||||
|
### 2. Architecture Constraint Alignment
|
||||||
|
|
||||||
|
If Architecture document was loaded:
|
||||||
|
|
||||||
|
**Check for conflicts:**
|
||||||
|
- API constraints vs. UX interaction patterns (e.g., real-time updates vs. REST-only API)
|
||||||
|
- Platform constraints vs. responsive strategy
|
||||||
|
- Performance budgets vs. animation/interaction complexity
|
||||||
|
- Data model constraints vs. information architecture
|
||||||
|
|
||||||
|
**Present any conflicts found:**
|
||||||
|
- Conflict description
|
||||||
|
- UX design assumption
|
||||||
|
- Architecture constraint
|
||||||
|
- Suggested resolution
|
||||||
|
|
||||||
|
If Architecture was NOT loaded:
|
||||||
|
- Note that constraint validation could not be performed
|
||||||
|
|
||||||
|
### 3. Downstream Handoff Checklist
|
||||||
|
|
||||||
|
Create handoff information for downstream workflows:
|
||||||
|
|
||||||
|
**For Architecture Workflow (Winston):**
|
||||||
|
- [ ] UX interaction patterns that require specific API design
|
||||||
|
- [ ] Real-time requirements identified in UX (WebSocket, SSE, polling)
|
||||||
|
- [ ] Data requirements from form designs and user flows
|
||||||
|
- [ ] Performance requirements from animation/interaction specs
|
||||||
|
|
||||||
|
**For Epics & Stories Workflow (John):**
|
||||||
|
- [ ] User journey → FR mapping (which journeys implement which FRs)
|
||||||
|
- [ ] Component complexity estimates (simple, moderate, complex)
|
||||||
|
- [ ] Design dependencies between components
|
||||||
|
- [ ] Phasing recommendations (what can be MVP vs. later)
|
||||||
|
|
||||||
|
**Design Decision Rationale:**
|
||||||
|
- Key design decisions and WHY they were made
|
||||||
|
- Alternatives considered and rejected (with reasons)
|
||||||
|
- Assumptions made during design
|
||||||
|
|
||||||
|
### 4. Generate Validation & Handoff Content
|
||||||
|
|
||||||
|
Append to the document:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Requirements Validation
|
||||||
|
|
||||||
|
### FR Coverage Matrix
|
||||||
|
|
||||||
|
[Table mapping FRs to UX elements]
|
||||||
|
|
||||||
|
### Architecture Constraint Alignment
|
||||||
|
|
||||||
|
[Any conflicts found and resolutions, or "No architecture document loaded"]
|
||||||
|
|
||||||
|
## Downstream Handoff
|
||||||
|
|
||||||
|
### Architecture Handoff
|
||||||
|
|
||||||
|
[UX constraints and requirements for architecture decisions]
|
||||||
|
|
||||||
|
### Epics & Stories Handoff
|
||||||
|
|
||||||
|
[User journey → FR mapping, complexity estimates, phasing recommendations]
|
||||||
|
|
||||||
|
### Design Decision Rationale
|
||||||
|
|
||||||
|
[Key decisions with reasoning for downstream teams]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Present MENU OPTIONS
|
||||||
|
|
||||||
|
Present the validation findings and handoff checklist, then display menu:
|
||||||
|
- Show coverage matrix highlights
|
||||||
|
- Show any architecture conflicts
|
||||||
|
- Show handoff readiness
|
||||||
|
|
||||||
|
Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete Workflow (Step 14)"
|
||||||
|
|
||||||
|
#### Menu Handling Logic:
|
||||||
|
- IF A: Read fully and follow Advanced Elicitation, process, ask acceptance, update or keep, redisplay
|
||||||
|
- IF P: Read fully and follow Party Mode, process, ask acceptance, update or keep, redisplay
|
||||||
|
- IF C: Append to output document, update frontmatter, then read fully and follow: `./step-14-complete.md`
|
||||||
|
- IF Any other: help user respond, then redisplay menu
|
||||||
|
|
||||||
|
## APPEND TO DOCUMENT:
|
||||||
|
|
||||||
|
When user selects 'C', append the content directly to the document.
|
||||||
|
|
||||||
|
## SUCCESS METRICS:
|
||||||
|
|
||||||
|
✅ PRD FR coverage validated (if PRD available)
|
||||||
|
✅ Architecture constraints checked (if architecture available)
|
||||||
|
✅ FR → UX element mapping created
|
||||||
|
✅ Gaps identified with clear categorization
|
||||||
|
✅ Handoff checklist prepared for Architecture and Epics workflows
|
||||||
|
✅ Design decision rationale documented
|
||||||
|
✅ A/P/C menu presented and handled correctly
|
||||||
|
|
||||||
|
## FAILURE MODES:
|
||||||
|
|
||||||
|
❌ Not loading PRD for validation when it was discovered at init
|
||||||
|
❌ Claiming full coverage without systematic check
|
||||||
|
❌ Not creating handoff artifacts for downstream workflows
|
||||||
|
❌ Not documenting design decision rationale
|
||||||
|
❌ Marking non-UI FRs as gaps (they should be N/A)
|
||||||
|
|
||||||
|
## NEXT STEP:
|
||||||
|
|
||||||
|
After user selects 'C' and content is saved, load `./step-14-complete.md` to complete the workflow.
|
||||||
|
|
||||||
|
Remember: Do NOT proceed to step-14 until user explicitly selects 'C'!
|
||||||
|
|
@ -8,6 +8,12 @@
|
||||||
- [ ] Tests cover happy path
|
- [ ] Tests cover happy path
|
||||||
- [ ] Tests cover 1-2 critical error cases
|
- [ ] Tests cover 1-2 critical error cases
|
||||||
|
|
||||||
|
## Requirements Traceability (All Tracks)
|
||||||
|
|
||||||
|
- [ ] Each acceptance criterion has at least one test
|
||||||
|
- [ ] Each FR has at least one test scenario defined
|
||||||
|
- [ ] Test descriptions reference the FR or acceptance criterion they verify
|
||||||
|
|
||||||
## Test Quality
|
## Test Quality
|
||||||
|
|
||||||
- [ ] All generated tests run successfully
|
- [ ] All generated tests run successfully
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,122 @@
|
||||||
|
# Per-Requirement Quality Checklist (ISO 29148)
|
||||||
|
|
||||||
|
Apply this checklist to EVERY individual requirement in StRS, SyRS, and PRD/SRS documents. Each requirement must satisfy all 9 quality criteria.
|
||||||
|
|
||||||
|
## The 9 Quality Criteria
|
||||||
|
|
||||||
|
### 1. Necessary
|
||||||
|
|
||||||
|
- [ ] The requirement traces to a real stakeholder need or business objective
|
||||||
|
- [ ] Removing this requirement would leave a stakeholder need unmet
|
||||||
|
- [ ] The requirement is not gold-plating (adding unnecessary complexity)
|
||||||
|
|
||||||
|
**Test:** "If we remove this requirement, would a stakeholder's need go unmet?"
|
||||||
|
|
||||||
|
### 2. Implementation-Free
|
||||||
|
|
||||||
|
- [ ] The requirement states WHAT is needed, not HOW to build it
|
||||||
|
- [ ] No technology choices are embedded (unless it IS a design constraint)
|
||||||
|
- [ ] No UI/UX specifics are included (unless it IS an interface requirement)
|
||||||
|
- [ ] The requirement could be implemented in multiple different ways
|
||||||
|
|
||||||
|
**Test:** "Could an architect choose from 3+ different implementation approaches?"
|
||||||
|
|
||||||
|
### 3. Unambiguous
|
||||||
|
|
||||||
|
- [ ] The requirement has only ONE possible interpretation
|
||||||
|
- [ ] No vague adjectives (good, fast, easy, user-friendly, intuitive, robust)
|
||||||
|
- [ ] Measurable criteria are used where applicable
|
||||||
|
- [ ] Terms are defined in the glossary or are industry-standard
|
||||||
|
|
||||||
|
**Test:** "Would 5 different engineers interpret this the same way?"
|
||||||
|
|
||||||
|
### 4. Consistent
|
||||||
|
|
||||||
|
- [ ] The requirement does NOT contradict any other requirement
|
||||||
|
- [ ] Terminology is consistent with the rest of the document
|
||||||
|
- [ ] Scope aligns with the product vision and boundaries
|
||||||
|
- [ ] No conflicting quality attribute targets (e.g., maximum security AND minimal latency)
|
||||||
|
|
||||||
|
**Test:** "Does this requirement peacefully coexist with all other requirements?"
|
||||||
|
|
||||||
|
### 5. Complete
|
||||||
|
|
||||||
|
- [ ] The requirement contains enough detail to design and test against
|
||||||
|
- [ ] All conditions and constraints are specified
|
||||||
|
- [ ] Edge cases and boundary conditions are addressed (or explicitly deferred)
|
||||||
|
- [ ] No TBD, TBC, or placeholder values remain
|
||||||
|
|
||||||
|
**Test:** "Could a developer implement this without asking clarifying questions?"
|
||||||
|
|
||||||
|
### 6. Singular
|
||||||
|
|
||||||
|
- [ ] The requirement expresses exactly ONE capability or constraint
|
||||||
|
- [ ] No compound requirements joined by "and" or "or" (split if needed)
|
||||||
|
- [ ] The requirement can be independently verified
|
||||||
|
- [ ] The requirement can be independently prioritized
|
||||||
|
|
||||||
|
**Test:** "Can I assign a single pass/fail verdict to this requirement?"
|
||||||
|
|
||||||
|
### 7. Feasible
|
||||||
|
|
||||||
|
- [ ] The requirement is technically achievable with known technology
|
||||||
|
- [ ] The requirement is achievable within the project's constraints (budget, timeline, team)
|
||||||
|
- [ ] No physical impossibilities or contradictions with laws of physics/math
|
||||||
|
- [ ] Required third-party capabilities or services are available
|
||||||
|
|
||||||
|
**Test:** "Can the team actually build this within the project constraints?"
|
||||||
|
|
||||||
|
### 8. Traceable
|
||||||
|
|
||||||
|
- [ ] The requirement has a unique identifier (ID)
|
||||||
|
- [ ] The requirement's source is documented (stakeholder, regulation, business objective)
|
||||||
|
- [ ] The requirement can be linked to downstream artifacts (design, code, tests)
|
||||||
|
- [ ] The requirement can be linked to upstream sources (StRS, business needs)
|
||||||
|
|
||||||
|
**Test:** "Can I follow this requirement from origin to implementation to test?"
|
||||||
|
|
||||||
|
### 9. Verifiable
|
||||||
|
|
||||||
|
- [ ] There exists a method to prove the requirement is satisfied
|
||||||
|
- [ ] The verification method is identified (Test, Analysis, Demonstration, Inspection)
|
||||||
|
- [ ] Acceptance criteria are clear and objective
|
||||||
|
- [ ] The verification can be performed within project constraints
|
||||||
|
|
||||||
|
**Test:** "Can I write a test or create a verification procedure for this?"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Reference Card
|
||||||
|
|
||||||
|
| # | Criterion | Key Question | Red Flags |
|
||||||
|
|---|-----------|-------------|-----------|
|
||||||
|
| 1 | Necessary | Would removing it leave a need unmet? | Gold-plating, nice-to-have disguised as must-have |
|
||||||
|
| 2 | Implementation-Free | Can it be built 3+ ways? | Technology names, UI specifics, algorithm choices |
|
||||||
|
| 3 | Unambiguous | Would 5 engineers agree? | "Good", "fast", "easy", "user-friendly", "robust" |
|
||||||
|
| 4 | Consistent | Does it conflict with others? | Contradicting metrics, overlapping scope |
|
||||||
|
| 5 | Complete | Can dev build without questions? | TBD, TBC, "details to follow", missing conditions |
|
||||||
|
| 6 | Singular | Can I give one pass/fail? | "and", "or" joining two capabilities |
|
||||||
|
| 7 | Feasible | Can the team actually build it? | Unrealistic targets, unavailable technology |
|
||||||
|
| 8 | Traceable | Can I follow origin → test? | Missing ID, no source reference |
|
||||||
|
| 9 | Verifiable | Can I test/prove it? | Subjective criteria, unmeasurable quality |
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
**When to Apply:**
|
||||||
|
- During PRD/SRS creation (Step 9: FR synthesis, Step 10: NFR synthesis)
|
||||||
|
- During PRD validation (validation workflow)
|
||||||
|
- During StRS and SyRS review steps
|
||||||
|
- During change management (new or modified requirements)
|
||||||
|
|
||||||
|
**How to Apply:**
|
||||||
|
1. Select a requirement
|
||||||
|
2. Walk through all 9 criteria
|
||||||
|
3. Mark any failures
|
||||||
|
4. Fix failures before proceeding or flag for review
|
||||||
|
5. A requirement that fails ANY criterion needs attention
|
||||||
|
|
||||||
|
**Scoring:**
|
||||||
|
- 9/9: Requirement is high quality
|
||||||
|
- 7-8/9: Minor issues, address if time permits
|
||||||
|
- 5-6/9: Significant issues, must address before approval
|
||||||
|
- <5/9: Requirement needs rewrite
|
||||||
|
|
@ -32,6 +32,16 @@ modules:
|
||||||
type: bmad-org
|
type: bmad-org
|
||||||
npmPackage: bmad-game-dev-studio
|
npmPackage: bmad-game-dev-studio
|
||||||
|
|
||||||
|
bmad-method-audit-standards-enterprise:
|
||||||
|
url: https://github.com/bmad-code-org/bmad-method-audit-standards-enterprise
|
||||||
|
module-definition: src/module.yaml
|
||||||
|
code: audit
|
||||||
|
name: "Audit Standards Enterprise"
|
||||||
|
description: "Standards Auditor for compliance, security auditing, traceability, and multi-standard governance"
|
||||||
|
defaultSelected: false
|
||||||
|
type: bmad-org
|
||||||
|
npmPackage: bmad-method-audit-standards-enterprise
|
||||||
|
|
||||||
bmad-method-test-architecture-enterprise:
|
bmad-method-test-architecture-enterprise:
|
||||||
url: https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise
|
url: https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise
|
||||||
module-definition: src/module.yaml
|
module-definition: src/module.yaml
|
||||||
|
|
|
||||||
|
|
@ -1378,8 +1378,11 @@ class Installer {
|
||||||
lines.push(
|
lines.push(
|
||||||
'',
|
'',
|
||||||
' Next steps:',
|
' Next steps:',
|
||||||
` Docs: ${color.dim('https://docs.bmad-method.org/')}`,
|
` Read our new Docs Site: ${color.dim('https://docs.bmad-method.org/')}`,
|
||||||
` Run ${color.cyan('/bmad-help')} in your IDE to get started`,
|
` Join our Discord: ${color.dim('https://discord.gg/gk8jAdXWmj')}`,
|
||||||
|
` Star us on GitHub: ${color.dim('https://github.com/bmad-code-org/BMAD-METHOD/')}`,
|
||||||
|
` Subscribe on YouTube: ${color.dim('https://www.youtube.com/@BMadCode')}`,
|
||||||
|
` Run ${color.cyan('/bmad-help')} with your IDE Agent and ask it how to get started`,
|
||||||
);
|
);
|
||||||
|
|
||||||
await prompts.note(lines.join('\n'), 'BMAD is ready to use!');
|
await prompts.note(lines.join('\n'), 'BMAD is ready to use!');
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue