Merge branch 'main' into feat/mistral-support
This commit is contained in:
commit
414319dd57
|
|
@ -0,0 +1,271 @@
|
||||||
|
# Augment Code Review Guidelines for BMAD-METHOD
|
||||||
|
# https://docs.augmentcode.com/codereview/overview
|
||||||
|
# Focus: Workflow validation and quality
|
||||||
|
|
||||||
|
file_paths_to_ignore:
|
||||||
|
# --- Shared baseline: tool configs ---
|
||||||
|
- ".coderabbit.yaml"
|
||||||
|
- ".augment/**"
|
||||||
|
- "eslint.config.mjs"
|
||||||
|
# --- Shared baseline: build output ---
|
||||||
|
- "dist/**"
|
||||||
|
- "build/**"
|
||||||
|
- "coverage/**"
|
||||||
|
# --- Shared baseline: vendored/generated ---
|
||||||
|
- "node_modules/**"
|
||||||
|
- "**/*.min.js"
|
||||||
|
- "**/*.generated.*"
|
||||||
|
- "**/*.bundle.md"
|
||||||
|
# --- Shared baseline: package metadata ---
|
||||||
|
- "package-lock.json"
|
||||||
|
# --- Shared baseline: binary/media ---
|
||||||
|
- "*.png"
|
||||||
|
- "*.jpg"
|
||||||
|
- "*.svg"
|
||||||
|
# --- Shared baseline: test fixtures ---
|
||||||
|
- "test/fixtures/**"
|
||||||
|
- "test/template-test-generator/**"
|
||||||
|
- "tools/template-test-generator/test-scenarios/**"
|
||||||
|
# --- Shared baseline: non-project dirs ---
|
||||||
|
- "_bmad*/**"
|
||||||
|
- "website/**"
|
||||||
|
- "z*/**"
|
||||||
|
- "sample-project/**"
|
||||||
|
- "test-project-install/**"
|
||||||
|
# --- Shared baseline: AI assistant dirs ---
|
||||||
|
- ".claude/**"
|
||||||
|
- ".codex/**"
|
||||||
|
- ".agent/**"
|
||||||
|
- ".agentvibes/**"
|
||||||
|
- ".kiro/**"
|
||||||
|
- ".roo/**"
|
||||||
|
- ".github/chatmodes/**"
|
||||||
|
# --- Shared baseline: build temp ---
|
||||||
|
- ".bundler-temp/**"
|
||||||
|
# --- Shared baseline: generated reports ---
|
||||||
|
- "**/validation-report-*.md"
|
||||||
|
- "CHANGELOG.md"
|
||||||
|
|
||||||
|
areas:
|
||||||
|
# ============================================
|
||||||
|
# WORKFLOW STRUCTURE RULES
|
||||||
|
# ============================================
|
||||||
|
workflow_structure:
|
||||||
|
description: "Workflow folder organization and required components"
|
||||||
|
globs:
|
||||||
|
- "src/**/workflows/**"
|
||||||
|
rules:
|
||||||
|
- id: "workflow_entry_point_required"
|
||||||
|
description: "Every workflow folder must have workflow.yaml, workflow.md, or workflow.xml as entry point"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "sharded_workflow_steps_folder"
|
||||||
|
description: "Sharded workflows (using workflow.md) must have steps/ folder with numbered files (step-01-*.md, step-02-*.md)"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "standard_workflow_instructions"
|
||||||
|
description: "Standard workflows using workflow.yaml must include instructions.md for execution guidance"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "workflow_step_limit"
|
||||||
|
description: "Workflows should have 5-10 steps maximum to prevent context loss in LLM execution"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# WORKFLOW ENTRY FILE RULES
|
||||||
|
# ============================================
|
||||||
|
workflow_definitions:
|
||||||
|
description: "Workflow entry files (workflow.yaml, workflow.md, workflow.xml)"
|
||||||
|
globs:
|
||||||
|
- "src/**/workflows/**/workflow.yaml"
|
||||||
|
- "src/**/workflows/**/workflow.md"
|
||||||
|
- "src/**/workflows/**/workflow.xml"
|
||||||
|
rules:
|
||||||
|
- id: "workflow_name_required"
|
||||||
|
description: "Workflow entry files must define 'name' field in frontmatter or root element"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "workflow_description_required"
|
||||||
|
description: "Workflow entry files must include 'description' explaining the workflow's purpose"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "workflow_config_source"
|
||||||
|
description: "Workflows should reference config_source for variable resolution (e.g., {project-root}/_bmad/module/config.yaml)"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "workflow_installed_path"
|
||||||
|
description: "Workflows should define installed_path for relative file references within the workflow"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "valid_step_references"
|
||||||
|
description: "Step file references in workflow entry must point to existing files"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# SHARDED WORKFLOW STEP RULES
|
||||||
|
# ============================================
|
||||||
|
workflow_steps:
|
||||||
|
description: "Individual step files in sharded workflows"
|
||||||
|
globs:
|
||||||
|
- "src/**/workflows/**/steps/step-*.md"
|
||||||
|
rules:
|
||||||
|
- id: "step_goal_required"
|
||||||
|
description: "Each step must clearly state its goal (## STEP GOAL, ## YOUR TASK, or step n='X' goal='...')"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "step_mandatory_rules"
|
||||||
|
description: "Step files should include MANDATORY EXECUTION RULES section with universal agent behavior rules"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "step_context_boundaries"
|
||||||
|
description: "Step files should define CONTEXT BOUNDARIES explaining available context and limits"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "step_success_metrics"
|
||||||
|
description: "Step files should include SUCCESS METRICS section with ✅ checkmarks for validation criteria"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "step_failure_modes"
|
||||||
|
description: "Step files should include FAILURE MODES section with ❌ marks for anti-patterns to avoid"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "step_next_step_reference"
|
||||||
|
description: "Step files should reference the next step file path for sequential execution"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "step_no_forward_loading"
|
||||||
|
description: "Steps must NOT load future step files until current step completes - just-in-time loading only"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "valid_file_references"
|
||||||
|
description: "File path references using {variable}/filename.md must point to existing files"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "step_naming"
|
||||||
|
description: "Step files must be named step-NN-description.md (e.g., step-01-init.md, step-02-context.md)"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "halt_before_menu"
|
||||||
|
description: "Steps presenting user menus ([C] Continue, [a] Advanced, etc.) must HALT and wait for response"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# XML WORKFLOW/TASK RULES
|
||||||
|
# ============================================
|
||||||
|
xml_workflows:
|
||||||
|
description: "XML-based workflows and tasks"
|
||||||
|
globs:
|
||||||
|
- "src/**/workflows/**/*.xml"
|
||||||
|
- "src/**/tasks/**/*.xml"
|
||||||
|
rules:
|
||||||
|
- id: "xml_task_id_required"
|
||||||
|
description: "XML tasks must have unique 'id' attribute on root task element"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "xml_llm_instructions"
|
||||||
|
description: "XML workflows should include <llm> section with critical execution instructions for the agent"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "xml_step_numbering"
|
||||||
|
description: "XML steps should use n='X' attribute for sequential numbering"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "xml_action_tags"
|
||||||
|
description: "Use <action> for required actions, <ask> for user input (must HALT), <goto> for jumps, <check if='...'> for conditionals"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "xml_ask_must_halt"
|
||||||
|
description: "<ask> tags require agent to HALT and wait for user response before continuing"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# WORKFLOW CONTENT QUALITY
|
||||||
|
# ============================================
|
||||||
|
workflow_content:
|
||||||
|
description: "Content quality and consistency rules for all workflow files"
|
||||||
|
globs:
|
||||||
|
- "src/**/workflows/**/*.md"
|
||||||
|
- "src/**/workflows/**/*.yaml"
|
||||||
|
rules:
|
||||||
|
- id: "communication_language_variable"
|
||||||
|
description: "Workflows should use {communication_language} variable for agent output language consistency"
|
||||||
|
severity: "low"
|
||||||
|
|
||||||
|
- id: "path_placeholders_required"
|
||||||
|
description: "Use path placeholders (e.g. {project-root}, {installed_path}, {output_folder}) instead of hardcoded paths"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "no_time_estimates"
|
||||||
|
description: "Workflows should NOT include time estimates - AI development speed varies significantly"
|
||||||
|
severity: "low"
|
||||||
|
|
||||||
|
- id: "facilitator_not_generator"
|
||||||
|
description: "Workflow agents should act as facilitators (guide user input) not content generators (create without input)"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "no_skip_optimization"
|
||||||
|
description: "Workflows must execute steps sequentially - no skipping or 'optimizing' step order"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# AGENT DEFINITIONS
|
||||||
|
# ============================================
|
||||||
|
agent_definitions:
|
||||||
|
description: "Agent YAML configuration files"
|
||||||
|
globs:
|
||||||
|
- "src/**/*.agent.yaml"
|
||||||
|
rules:
|
||||||
|
- id: "agent_metadata_required"
|
||||||
|
description: "Agent files must have metadata section with id, name, title, icon, and module"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "agent_persona_required"
|
||||||
|
description: "Agent files must define persona with role, identity, communication_style, and principles"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
- id: "agent_menu_valid_workflows"
|
||||||
|
description: "Menu triggers must reference valid workflow paths that exist"
|
||||||
|
severity: "high"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# TEMPLATES
|
||||||
|
# ============================================
|
||||||
|
templates:
|
||||||
|
description: "Template files for workflow outputs"
|
||||||
|
globs:
|
||||||
|
- "src/**/template*.md"
|
||||||
|
- "src/**/templates/**/*.md"
|
||||||
|
rules:
|
||||||
|
- id: "placeholder_syntax"
|
||||||
|
description: "Use {variable_name} or {{variable_name}} syntax consistently for placeholders"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
- id: "template_sections_marked"
|
||||||
|
description: "Template sections that need generation should be clearly marked (e.g., <!-- GENERATE: section_name -->)"
|
||||||
|
severity: "low"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# DOCUMENTATION
|
||||||
|
# ============================================
|
||||||
|
documentation:
|
||||||
|
description: "Documentation files"
|
||||||
|
globs:
|
||||||
|
- "docs/**/*.md"
|
||||||
|
- "README.md"
|
||||||
|
- "CONTRIBUTING.md"
|
||||||
|
rules:
|
||||||
|
- id: "valid_internal_links"
|
||||||
|
description: "Internal markdown links must point to existing files"
|
||||||
|
severity: "medium"
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# BUILD TOOLS
|
||||||
|
# ============================================
|
||||||
|
build_tools:
|
||||||
|
description: "Build scripts and tooling"
|
||||||
|
globs:
|
||||||
|
- "tools/**"
|
||||||
|
rules:
|
||||||
|
- id: "script_error_handling"
|
||||||
|
description: "Scripts should handle errors gracefully with proper exit codes"
|
||||||
|
severity: "medium"
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
name: changelog-social
|
name: bmad-os-changelog-social
|
||||||
description: Generate social media announcements for Discord, Twitter, and LinkedIn from the latest changelog entry. Use when user asks to create release announcements, social posts, or share changelog updates. Reads CHANGELOG.md in current working directory. Reference examples/ for tone and format.
|
description: Generate social media announcements for Discord, Twitter, and LinkedIn from the latest changelog entry. Use when user asks to create release announcements, social posts, or share changelog updates. Reads CHANGELOG.md in current working directory. Reference examples/ for tone and format.
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
@ -154,7 +154,13 @@ Read the appropriate example file before generating to match the established sty
|
||||||
|
|
||||||
## Output Format
|
## Output Format
|
||||||
|
|
||||||
Present both announcements in clearly labeled sections:
|
**CRITICAL: ALWAYS write to files** - Create files in `_bmad-output/social/` directory:
|
||||||
|
|
||||||
|
1. `{repo-name}-discord-{version}.md` - Discord announcement
|
||||||
|
2. `{repo-name}-twitter-{version}.md` - Twitter post
|
||||||
|
3. `{repo-name}-linkedin-{version}.md` - LinkedIn post (if applicable)
|
||||||
|
|
||||||
|
Also present a preview in the chat:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## Discord Announcement
|
## Discord Announcement
|
||||||
|
|
@ -166,4 +172,7 @@ Present both announcements in clearly labeled sections:
|
||||||
[paste Twitter content here]
|
[paste Twitter content here]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Files created:
|
||||||
|
- `_bmad-output/social/{filename}`
|
||||||
|
|
||||||
Offer to make adjustments if the user wants different emphasis, tone, or content.
|
Offer to make adjustments if the user wants different emphasis, tone, or content.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
name: draft-changelog
|
name: bmad-os-draft-changelog
|
||||||
description: Analyzes changes since the last release and generates a draft changelog entry
|
description: Analyzes changes since last release and updates CHANGELOG.md ONLY. Does NOT trigger releases.
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,17 @@
|
||||||
# Draft Changelog Execution
|
# Draft Changelog Execution
|
||||||
|
|
||||||
|
## ⚠️ IMPORTANT - READ FIRST
|
||||||
|
|
||||||
|
**This skill ONLY updates CHANGELOG.md. That is its entire purpose.**
|
||||||
|
|
||||||
|
- **DO** update CHANGELOG.md with the new version entry
|
||||||
|
- **DO** present the draft for user review before editing
|
||||||
|
- **DO NOT** trigger any GitHub release workflows
|
||||||
|
- **DO NOT** run any other skills or workflows automatically
|
||||||
|
- **DO NOT** make any commits
|
||||||
|
|
||||||
|
After the changelog is complete, you may suggest the user can run `/release-module` if they want to proceed with the actual release — but NEVER trigger it yourself.
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
Project path (or run from project root)
|
Project path (or run from project root)
|
||||||
|
|
||||||
|
|
@ -53,6 +65,18 @@ Guidelines:
|
||||||
- Clear, concise language
|
- Clear, concise language
|
||||||
- For breaking changes, clearly indicate impact
|
- For breaking changes, clearly indicate impact
|
||||||
|
|
||||||
## Step 4: Present Draft
|
## Step 4: Present Draft & Update CHANGELOG.md
|
||||||
|
|
||||||
Show the draft with current version, last tag, commit count, and options to edit/retry.
|
Show the draft with current version, last tag, commit count, and options to edit/retry.
|
||||||
|
|
||||||
|
When user accepts:
|
||||||
|
1. Update CHANGELOG.md with the new entry (insert at top, after `# Changelog` header)
|
||||||
|
2. STOP. That's it. You're done.
|
||||||
|
|
||||||
|
You may optionally suggest: *"When ready, you can run `/release-module` to create the actual release."*
|
||||||
|
|
||||||
|
**DO NOT:**
|
||||||
|
- Trigger any GitHub workflows
|
||||||
|
- Run any other skills
|
||||||
|
- Make any commits
|
||||||
|
- Do anything beyond updating CHANGELOG.md
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
name: gh-triage
|
name: bmad-os-gh-triage
|
||||||
description: Fetch all GitHub issues via gh CLI and use AI agents to deeply analyze, cluster, and prioritize issues
|
description: Fetch all GitHub issues via gh CLI and use AI agents to deeply analyze, cluster, and prioritize issues
|
||||||
license: MIT
|
license: MIT
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
name: release-module
|
name: bmad-os-release-module
|
||||||
description: Automates the complete release process for npm modules - version bump, changelog, git tag, npm publish, GitHub release
|
description: Automates the complete release process for npm modules - version bump, changelog, git tag, npm publish, GitHub release
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -42,26 +42,6 @@ Publish the package.
|
||||||
|
|
||||||
Create release with changelog notes using `gh release create`.
|
Create release with changelog notes using `gh release create`.
|
||||||
|
|
||||||
### Step 10: Create Social Announcement
|
|
||||||
|
|
||||||
Create a social media announcement file at `_bmad-output/social/{repo-name}-release.md`.
|
|
||||||
|
|
||||||
Format:
|
|
||||||
```markdown
|
|
||||||
# {name} v{version} Released
|
|
||||||
|
|
||||||
## Highlights
|
|
||||||
{2-3 bullet points of key features/changes}
|
|
||||||
|
|
||||||
## Links
|
|
||||||
- GitHub: {release-url}
|
|
||||||
- npm: {npm-url}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 11: Confirm Completion
|
|
||||||
|
|
||||||
Show npm, GitHub, and social announcement file paths.
|
|
||||||
|
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
Stop immediately on any step failure. Inform user and suggest fix.
|
Stop immediately on any step failure. Inform user and suggest fix.
|
||||||
|
|
|
||||||
|
|
@ -17,21 +17,66 @@ reviews:
|
||||||
base_branches:
|
base_branches:
|
||||||
- main
|
- main
|
||||||
path_filters:
|
path_filters:
|
||||||
|
# --- Shared baseline: tool configs ---
|
||||||
|
- "!.coderabbit.yaml"
|
||||||
|
- "!.augment/**"
|
||||||
|
- "!eslint.config.mjs"
|
||||||
|
# --- Shared baseline: build output ---
|
||||||
|
- "!dist/**"
|
||||||
|
- "!build/**"
|
||||||
|
- "!coverage/**"
|
||||||
|
# --- Shared baseline: vendored/generated ---
|
||||||
- "!**/node_modules/**"
|
- "!**/node_modules/**"
|
||||||
|
- "!**/*.min.js"
|
||||||
|
- "!**/*.generated.*"
|
||||||
|
- "!**/*.bundle.md"
|
||||||
|
# --- Shared baseline: package metadata ---
|
||||||
|
- "!package-lock.json"
|
||||||
|
# --- Shared baseline: binary/media ---
|
||||||
|
- "!*.png"
|
||||||
|
- "!*.jpg"
|
||||||
|
- "!*.svg"
|
||||||
|
# --- Shared baseline: test fixtures ---
|
||||||
|
- "!test/fixtures/**"
|
||||||
|
- "!test/template-test-generator/**"
|
||||||
|
- "!tools/template-test-generator/test-scenarios/**"
|
||||||
|
# --- Shared baseline: non-project dirs ---
|
||||||
|
- "!_bmad*/**"
|
||||||
|
- "!website/**"
|
||||||
|
- "!z*/**"
|
||||||
|
- "!sample-project/**"
|
||||||
|
- "!test-project-install/**"
|
||||||
|
# --- Shared baseline: AI assistant dirs ---
|
||||||
|
- "!.claude/**"
|
||||||
|
- "!.codex/**"
|
||||||
|
- "!.agent/**"
|
||||||
|
- "!.agentvibes/**"
|
||||||
|
- "!.kiro/**"
|
||||||
|
- "!.roo/**"
|
||||||
|
- "!.github/chatmodes/**"
|
||||||
|
# --- Shared baseline: build temp ---
|
||||||
|
- "!.bundler-temp/**"
|
||||||
|
# --- Shared baseline: generated reports ---
|
||||||
|
- "!**/validation-report-*.md"
|
||||||
|
- "!CHANGELOG.md"
|
||||||
path_instructions:
|
path_instructions:
|
||||||
- path: "**/*"
|
- path: "**/*"
|
||||||
instructions: |
|
instructions: |
|
||||||
Focus on inconsistencies, contradictions, edge cases and serious issues.
|
You are a cynical, jaded reviewer with zero patience for sloppy work.
|
||||||
Avoid commenting on minor issues such as linting, formatting and style issues.
|
This PR was submitted by a clueless weasel and you expect to find problems.
|
||||||
When providing code suggestions, use GitHub's suggestion format:
|
Be skeptical of everything.
|
||||||
```suggestion
|
Look for what's missing, not just what's wrong.
|
||||||
<code changes>
|
Use a precise, professional tone — no profanity or personal attacks.
|
||||||
```
|
|
||||||
- path: "**/*.js"
|
Review with extreme skepticism — assume problems exist.
|
||||||
instructions: |
|
Find at least 10 issues to fix or improve.
|
||||||
CLI tooling code. Check for: missing error handling on fs operations,
|
|
||||||
path.join vs string concatenation, proper cleanup in error paths.
|
Do NOT:
|
||||||
Flag any process.exit() without error message.
|
- Comment on formatting, linting, or style
|
||||||
|
- Give "looks good" passes
|
||||||
|
- Anchor on any specific ruleset — reason freely
|
||||||
|
|
||||||
|
If you find zero issues, re-analyze — this is suspicious.
|
||||||
chat:
|
chat:
|
||||||
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
||||||
issue_enrichment:
|
issue_enrichment:
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
## What
|
||||||
|
<!-- 1-2 sentences describing WHAT changed -->
|
||||||
|
|
||||||
|
## Why
|
||||||
|
<!-- 1-2 sentences explaining WHY this change is needed -->
|
||||||
|
<!-- Fixes `#issue_number` (if applicable) -->
|
||||||
|
|
||||||
|
## How
|
||||||
|
<!-- 2-3 bullets listing HOW you implemented it -->
|
||||||
|
-
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
<!-- 1-2 sentences on how you tested this -->
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
name: Trigger CodeRabbit on Ready for Review
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types: [ready_for_review]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
trigger-review:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
steps:
|
||||||
|
- name: Request CodeRabbit review
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
await github.rest.issues.createComment({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
issue_number: context.payload.pull_request.number,
|
||||||
|
body: '@coderabbitai review'
|
||||||
|
});
|
||||||
|
|
@ -8,7 +8,7 @@ on:
|
||||||
- "docs/**"
|
- "docs/**"
|
||||||
- "src/modules/*/docs/**"
|
- "src/modules/*/docs/**"
|
||||||
- "website/**"
|
- "website/**"
|
||||||
- "tools/build-docs.js"
|
- "tools/build-docs.mjs"
|
||||||
- ".github/workflows/docs.yaml"
|
- ".github/workflows/docs.yaml"
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,193 +0,0 @@
|
||||||
name: Manual Release
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
version_bump:
|
|
||||||
description: Version bump type
|
|
||||||
required: true
|
|
||||||
default: beta
|
|
||||||
type: choice
|
|
||||||
options:
|
|
||||||
- beta
|
|
||||||
- alpha
|
|
||||||
- patch
|
|
||||||
- minor
|
|
||||||
- major
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
packages: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: ".nvmrc"
|
|
||||||
cache: npm
|
|
||||||
registry-url: https://registry.npmjs.org
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Run tests and validation
|
|
||||||
run: |
|
|
||||||
npm run validate
|
|
||||||
npm run format:check
|
|
||||||
npm run lint
|
|
||||||
|
|
||||||
- name: Configure Git
|
|
||||||
run: |
|
|
||||||
git config user.name "github-actions[bot]"
|
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
||||||
|
|
||||||
- name: Bump version
|
|
||||||
run: |
|
|
||||||
case "${{ github.event.inputs.version_bump }}" in
|
|
||||||
alpha|beta) npm version prerelease --no-git-tag-version --preid=${{ github.event.inputs.version_bump }} ;;
|
|
||||||
*) npm version ${{ github.event.inputs.version_bump }} --no-git-tag-version ;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
- name: Get new version and previous tag
|
|
||||||
id: version
|
|
||||||
run: |
|
|
||||||
echo "new_version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
|
||||||
echo "previous_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Update installer package.json
|
|
||||||
run: |
|
|
||||||
sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
|
|
||||||
|
|
||||||
# TODO: Re-enable web bundles once tools/cli/bundlers/ is restored
|
|
||||||
# - name: Generate web bundles
|
|
||||||
# run: npm run bundle
|
|
||||||
|
|
||||||
- name: Commit version bump
|
|
||||||
run: |
|
|
||||||
git add .
|
|
||||||
git commit -m "release: bump to v${{ steps.version.outputs.new_version }}"
|
|
||||||
|
|
||||||
- name: Generate release notes
|
|
||||||
id: release_notes
|
|
||||||
run: |
|
|
||||||
# Get commits since last tag
|
|
||||||
COMMITS=$(git log ${{ steps.version.outputs.previous_tag }}..HEAD --pretty=format:"- %s" --reverse)
|
|
||||||
|
|
||||||
# Categorize commits
|
|
||||||
FEATURES=$(echo "$COMMITS" | grep -E "^- (feat|Feature)" || true)
|
|
||||||
FIXES=$(echo "$COMMITS" | grep -E "^- (fix|Fix)" || true)
|
|
||||||
CHORES=$(echo "$COMMITS" | grep -E "^- (chore|Chore)" || true)
|
|
||||||
OTHERS=$(echo "$COMMITS" | grep -v -E "^- (feat|Feature|fix|Fix|chore|Chore|release:|Release:)" || true)
|
|
||||||
|
|
||||||
# Build release notes
|
|
||||||
cat > release_notes.md << 'EOF'
|
|
||||||
## 🚀 What's New in v${{ steps.version.outputs.new_version }}
|
|
||||||
|
|
||||||
EOF
|
|
||||||
|
|
||||||
if [ ! -z "$FEATURES" ]; then
|
|
||||||
echo "### ✨ New Features" >> release_notes.md
|
|
||||||
echo "$FEATURES" >> release_notes.md
|
|
||||||
echo "" >> release_notes.md
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -z "$FIXES" ]; then
|
|
||||||
echo "### 🐛 Bug Fixes" >> release_notes.md
|
|
||||||
echo "$FIXES" >> release_notes.md
|
|
||||||
echo "" >> release_notes.md
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -z "$OTHERS" ]; then
|
|
||||||
echo "### 📦 Other Changes" >> release_notes.md
|
|
||||||
echo "$OTHERS" >> release_notes.md
|
|
||||||
echo "" >> release_notes.md
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -z "$CHORES" ]; then
|
|
||||||
echo "### 🔧 Maintenance" >> release_notes.md
|
|
||||||
echo "$CHORES" >> release_notes.md
|
|
||||||
echo "" >> release_notes.md
|
|
||||||
fi
|
|
||||||
|
|
||||||
cat >> release_notes.md << 'EOF'
|
|
||||||
|
|
||||||
## 📦 Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/bmad-code-org/BMAD-METHOD/compare/${{ steps.version.outputs.previous_tag }}...v${{ steps.version.outputs.new_version }}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Output for GitHub Actions
|
|
||||||
echo "RELEASE_NOTES<<EOF" >> $GITHUB_OUTPUT
|
|
||||||
cat release_notes.md >> $GITHUB_OUTPUT
|
|
||||||
echo "EOF" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Create and push tag
|
|
||||||
run: |
|
|
||||||
# Check if tag already exists
|
|
||||||
if git rev-parse "v${{ steps.version.outputs.new_version }}" >/dev/null 2>&1; then
|
|
||||||
echo "Tag v${{ steps.version.outputs.new_version }} already exists, skipping tag creation"
|
|
||||||
else
|
|
||||||
git tag -a "v${{ steps.version.outputs.new_version }}" -m "Release v${{ steps.version.outputs.new_version }}"
|
|
||||||
git push origin "v${{ steps.version.outputs.new_version }}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Push changes to main
|
|
||||||
run: |
|
|
||||||
if git push origin HEAD:main 2>/dev/null; then
|
|
||||||
echo "✅ Successfully pushed to main branch"
|
|
||||||
else
|
|
||||||
echo "⚠️ Could not push to main (protected branch). This is expected."
|
|
||||||
echo "📝 Version bump and tag were created successfully."
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Publish to NPM
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
run: |
|
|
||||||
VERSION="${{ steps.version.outputs.new_version }}"
|
|
||||||
if [[ "$VERSION" == *"alpha"* ]]; then
|
|
||||||
echo "Publishing alpha prerelease version with --tag alpha"
|
|
||||||
npm publish --tag alpha
|
|
||||||
elif [[ "$VERSION" == *"beta"* ]]; then
|
|
||||||
echo "Publishing beta prerelease version with --tag latest"
|
|
||||||
npm publish --tag latest
|
|
||||||
else
|
|
||||||
echo "Publishing stable version with --tag latest"
|
|
||||||
npm publish --tag latest
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Create GitHub Release
|
|
||||||
uses: softprops/action-gh-release@v2
|
|
||||||
with:
|
|
||||||
tag_name: v${{ steps.version.outputs.new_version }}
|
|
||||||
name: "BMad Method v${{ steps.version.outputs.new_version }}"
|
|
||||||
body: |
|
|
||||||
${{ steps.release_notes.outputs.RELEASE_NOTES }}
|
|
||||||
draft: false
|
|
||||||
prerelease: ${{ contains(steps.version.outputs.new_version, 'alpha') || contains(steps.version.outputs.new_version, 'beta') }}
|
|
||||||
|
|
||||||
- name: Summary
|
|
||||||
run: |
|
|
||||||
echo "## 🎉 Successfully released v${{ steps.version.outputs.new_version }}!" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "### 📦 Distribution" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "- **NPM**: Published with @latest tag" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "- **GitHub Release**: https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v${{ steps.version.outputs.new_version }}" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "### ✅ Installation" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "npx bmad-method@${{ steps.version.outputs.new_version }} install" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
|
|
||||||
|
|
@ -43,7 +43,9 @@ z*/
|
||||||
_bmad
|
_bmad
|
||||||
_bmad-output
|
_bmad-output
|
||||||
.clinerules
|
.clinerules
|
||||||
.augment
|
# .augment/ is gitignored except tracked config files — add exceptions explicitly
|
||||||
|
.augment/*
|
||||||
|
!.augment/code_review_guidelines.yaml
|
||||||
.crush
|
.crush
|
||||||
.cursor
|
.cursor
|
||||||
.iflow
|
.iflow
|
||||||
|
|
|
||||||
|
|
@ -58,8 +58,7 @@
|
||||||
"tmpl",
|
"tmpl",
|
||||||
"Trae",
|
"Trae",
|
||||||
"Unsharded",
|
"Unsharded",
|
||||||
"VNET",
|
"VNET"
|
||||||
"webskip"
|
|
||||||
],
|
],
|
||||||
"json.schemas": [
|
"json.schemas": [
|
||||||
{
|
{
|
||||||
|
|
|
||||||
66
CHANGELOG.md
66
CHANGELOG.md
|
|
@ -1,5 +1,70 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [6.0.0-Beta.7]
|
||||||
|
|
||||||
|
**Release: February 4, 2026**
|
||||||
|
|
||||||
|
### 🌟 Key Highlights
|
||||||
|
|
||||||
|
1. **Direct Workflow Invocation** — Agent workflows can now be run directly via slash commands instead of only through agent orchestration
|
||||||
|
2. **Installer Workflow Support** — Installer now picks up `workflow-*.md` files, enabling multiple workflow files per directory
|
||||||
|
|
||||||
|
### 🎁 Features
|
||||||
|
|
||||||
|
* **Slash Command Workflow Access** — Research and PRD workflows now accessible via direct slash commands: `/domain-research`, `/market-research`, `/technical-research`, `/create-prd`, `/edit-prd`, `/validate-prd` (bd620e38, 731bee26)
|
||||||
|
* **Version Checking** — CLI now checks npm for newer versions and displays a warning banner when updates are available (d37ee7f2)
|
||||||
|
|
||||||
|
### ♻️ Refactoring
|
||||||
|
|
||||||
|
* **Workflow File Splitting** — Split monolithic `workflow.md` files into specific `workflow-*.md` files for individual workflow invocation (bd620e38)
|
||||||
|
* **Installer Multi-Workflow Support** — Installer manifest generator now supports `workflow-*.md` pattern, allowing multiple workflow files per directory (731bee26)
|
||||||
|
* **Internal Skill Renaming** — Renamed internal project skills to use `bmad-os-` prefix for consistent naming (5276d58b)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [6.0.0-Beta.6]
|
||||||
|
|
||||||
|
**Release: February 4, 2026**
|
||||||
|
|
||||||
|
### 🌟 Key Highlights
|
||||||
|
|
||||||
|
1. **Cross-File Reference Validator**: Comprehensive tool to detect broken file references, preventing 59 known bugs (~25% of historical issues)
|
||||||
|
2. **New AutocompleteMultiselect Prompt**: Searchable multi-select with improved tool/IDE selection UX
|
||||||
|
3. **Critical Installer Fixes**: Windows CRLF parsing, Gemini CLI TOML support, file extension preservation
|
||||||
|
4. **Codebase Cleanup**: Removed dead Excalidraw/flattener artifacts (-3,798 lines)
|
||||||
|
|
||||||
|
### 🎁 Features
|
||||||
|
|
||||||
|
* **Cross-File Reference Validator** — Validates ~483 references across ~217 source files, detecting absolute path leaks and broken references (PR #1494)
|
||||||
|
* **AutocompleteMultiselect Prompt** — Upgraded `@clack/prompts` to v1.0.0 with custom searchable multiselect, Tab-to-fill-placeholder behavior, and improved tool/IDE selection UX (PR #1514)
|
||||||
|
* **OT Domains** — Added `process_control` and `building_automation` domains with high complexity ratings (PR #1510)
|
||||||
|
* **Documentation Reference Pages** — Added `docs/reference/agents.md`, `commands.md`, and `testing.md` (PR #1525)
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
* **Critical Installer Fixes** — Fixed CRLF line ending parsing on Windows, Gemini CLI TOML support, file extension preservation, Codex task generation, Windows path handling, and CSV parsing (PR #1492)
|
||||||
|
* **Double Tool Questioning** — Removed redundant tool questioning during installation (df176d42)
|
||||||
|
* **QA Agent Rename** — Renamed Quinn agent to `qa` for naming consistency (PR #1508)
|
||||||
|
* **Documentation Organization** — Fixed documentation ordering and links, hide BMGD pages from main LLM docs (PR #1525)
|
||||||
|
|
||||||
|
### ♻️ Refactoring
|
||||||
|
|
||||||
|
* **Excalidraw/Flattener Removal** — Removed dead artifacts no longer supported beyond beta: Excalidraw workflows, flattener tool, and 12+ diagram creation workflows (-3,798 lines) (f699a368)
|
||||||
|
* **Centralized Constants** — Centralized `BMAD_FOLDER_NAME` to reduce hardcoded strings (PR #1492)
|
||||||
|
* **Cross-Platform Paths** — Fixed path separator inconsistencies in agent IDs (PR #1492)
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
* **BMGD Diataxis Refactor** — Refactored BMGD documentation using Diataxis principles for better organization (PR #1502)
|
||||||
|
* **Generate Project Context** — Restored `generate-project-context` workflow for brownfield project analysis (PR #1491)
|
||||||
|
|
||||||
|
### 🔧 Maintenance
|
||||||
|
|
||||||
|
* **Dependency Updates** — Upgraded `@clack/prompts` from v0.11.0 to v1.0.0 and added `@clack/core` (PR #1514)
|
||||||
|
* **CI Integration** — Added `validate:refs` to CI quality workflow with warning annotations (PR #1494)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [6.0.0-Beta.5]
|
## [6.0.0-Beta.5]
|
||||||
|
|
||||||
### 🎁 Features
|
### 🎁 Features
|
||||||
|
|
@ -1201,7 +1266,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
||||||
|
|
||||||
- **Workflow Vendoring**: Web bundler performs automatic cross-module dependency vendoring
|
- **Workflow Vendoring**: Web bundler performs automatic cross-module dependency vendoring
|
||||||
- **BMGD Module Extraction**: Game development split into standalone 4-phase structure
|
- **BMGD Module Extraction**: Game development split into standalone 4-phase structure
|
||||||
- **Enhanced Dependency Resolution**: Better handling of web_bundle: false workflows
|
|
||||||
- **Advanced Elicitation Fix**: Added missing CSV files to workflow bundles
|
- **Advanced Elicitation Fix**: Added missing CSV files to workflow bundles
|
||||||
- **Claude Code Fix**: Resolved README slash command installation regression
|
- **Claude Code Fix**: Resolved README slash command installation regression
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -30,6 +30,14 @@ 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, Cursor, Windsurf, etc.) in the project folder.
|
||||||
|
|
||||||
|
**Non-Interactive Installation**: For CI/CD pipelines or automated deployments, use command-line flags:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
See [Non-Interactive Installation Guide](docs/non-interactive-installation.md) for all available options.
|
||||||
|
|
||||||
> **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 it questions like:
|
||||||
|
|
||||||
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Documentation Style Guide"
|
title: "Documentation Style Guide"
|
||||||
|
description: Project-specific documentation conventions based on Google style and Diataxis structure
|
||||||
---
|
---
|
||||||
|
|
||||||
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
|
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
|
||||||
|
|
@ -147,7 +148,7 @@ your-project/
|
||||||
| **Concept** | `what-are-agents.md` |
|
| **Concept** | `what-are-agents.md` |
|
||||||
| **Feature** | `quick-flow.md` |
|
| **Feature** | `quick-flow.md` |
|
||||||
| **Philosophy** | `why-solutioning-matters.md` |
|
| **Philosophy** | `why-solutioning-matters.md` |
|
||||||
| **FAQ** | `brownfield-faq.md` |
|
| **FAQ** | `established-projects-faq.md` |
|
||||||
|
|
||||||
### General Template
|
### General Template
|
||||||
|
|
||||||
|
|
@ -325,7 +326,7 @@ Add italic context at definition start for limited-scope terms:
|
||||||
- `*BMad Method/Enterprise.*`
|
- `*BMad Method/Enterprise.*`
|
||||||
- `*Phase N.*`
|
- `*Phase N.*`
|
||||||
- `*BMGD.*`
|
- `*BMGD.*`
|
||||||
- `*Brownfield.*`
|
- `*Established projects.*`
|
||||||
|
|
||||||
### Glossary Checklist
|
### Glossary Checklist
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
---
|
---
|
||||||
title: "Game Types Reference"
|
title: "Game Types Reference"
|
||||||
|
description: 24 game type templates with genre-specific GDD sections for BMGD
|
||||||
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
||||||
BMGD supports 24 game type templates. Each adds genre-specific sections to your GDD.
|
BMGD supports 24 game type templates. Each adds genre-specific sections to your GDD.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
title: "BMGD Quick Guide"
|
title: "BMGD Quick Guide"
|
||||||
description: Quick reference for BMad Game Dev Studio
|
description: Quick reference for BMad Game Dev Studio
|
||||||
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
||||||

|

|
||||||
|
|
@ -110,4 +111,3 @@ Each template provides genre-specific GDD sections, mechanics patterns, testing
|
||||||
|
|
||||||
- [Game Types Guide](game-types.md)
|
- [Game Types Guide](game-types.md)
|
||||||
- [Quick-Flow Guide](quick-flow-workflows.md)
|
- [Quick-Flow Guide](quick-flow-workflows.md)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
---
|
---
|
||||||
title: "Quick Flow Workflows"
|
title: "Quick Flow Workflows"
|
||||||
|
description: Create tech specs and execute implementations with BMGD Quick Flow
|
||||||
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
||||||
How to create tech specs and execute implementations with Quick Flow.
|
How to create tech specs and execute implementations with Quick Flow.
|
||||||
|
|
|
||||||
|
|
@ -1,74 +0,0 @@
|
||||||
---
|
|
||||||
title: Downloads
|
|
||||||
---
|
|
||||||
|
|
||||||
Download BMad Method resources for offline use, AI training, or integration.
|
|
||||||
|
|
||||||
## Source Bundles
|
|
||||||
|
|
||||||
Download these from the `downloads/` folder on the documentation site.
|
|
||||||
|
|
||||||
| File | Description |
|
|
||||||
| ------------------ | ------------------------------- |
|
|
||||||
| `bmad-sources.zip` | Complete BMad source files |
|
|
||||||
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
|
||||||
|
|
||||||
## LLM-Optimized Files
|
|
||||||
|
|
||||||
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
|
|
||||||
|
|
||||||
| File | Description | Use Case |
|
|
||||||
| --------------- | ----------------------------------- | -------------------------- |
|
|
||||||
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
|
||||||
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
|
||||||
|
|
||||||
### Using with LLMs
|
|
||||||
|
|
||||||
**Claude Projects:**
|
|
||||||
```
|
|
||||||
Upload llms-full.txt as project knowledge
|
|
||||||
```
|
|
||||||
|
|
||||||
**ChatGPT:**
|
|
||||||
```
|
|
||||||
Paste llms.txt for navigation, or sections from llms-full.txt as needed
|
|
||||||
```
|
|
||||||
|
|
||||||
**API Usage:**
|
|
||||||
```python
|
|
||||||
import requests
|
|
||||||
docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
|
|
||||||
# Include in your system prompt or context
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation Options
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
|
|
||||||
[More details](/docs/how-to/install-bmad.md)
|
|
||||||
|
|
||||||
## Version Information
|
|
||||||
|
|
||||||
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
|
||||||
- **Release Notes:** Available on [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases)
|
|
||||||
|
|
||||||
## API Access
|
|
||||||
|
|
||||||
For programmatic access to BMad documentation:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Get documentation index
|
|
||||||
curl https://bmad-code-org.github.io/BMAD-METHOD/llms.txt
|
|
||||||
|
|
||||||
# Get full documentation
|
|
||||||
curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Want to improve BMad Method? Check out:
|
|
||||||
|
|
||||||
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
|
|
||||||
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
---
|
|
||||||
title: "Brownfield Development FAQ"
|
|
||||||
description: Common questions about brownfield development in the BMad Method
|
|
||||||
---
|
|
||||||
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [Questions](#questions)
|
|
||||||
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
|
||||||
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
|
||||||
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
|
||||||
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
|
||||||
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
|
||||||
|
|
||||||
### What is brownfield vs greenfield?
|
|
||||||
|
|
||||||
- **Greenfield** — New project, starting from scratch, clean slate
|
|
||||||
- **Brownfield** — Existing project, working with established codebase and patterns
|
|
||||||
|
|
||||||
### Do I have to run document-project for brownfield?
|
|
||||||
|
|
||||||
Highly recommended, especially if:
|
|
||||||
|
|
||||||
- No existing documentation
|
|
||||||
- Documentation is outdated
|
|
||||||
- AI agents need context about existing code
|
|
||||||
|
|
||||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
|
||||||
|
|
||||||
### What if I forget to run document-project?
|
|
||||||
|
|
||||||
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
|
||||||
|
|
||||||
### Can I use Quick Spec Flow for brownfield projects?
|
|
||||||
|
|
||||||
Yes! Quick Spec Flow works great for brownfield. It will:
|
|
||||||
|
|
||||||
- Auto-detect your existing stack
|
|
||||||
- Analyze brownfield code patterns
|
|
||||||
- Detect conventions and ask for confirmation
|
|
||||||
- Generate context-rich tech-spec that respects existing code
|
|
||||||
|
|
||||||
Perfect for bug fixes and small features in existing codebases.
|
|
||||||
|
|
||||||
### What if my existing code doesn't follow best practices?
|
|
||||||
|
|
||||||
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
|
||||||
|
|
||||||
- **Yes** → Maintain consistency with current codebase
|
|
||||||
- **No** → Establish new standards (document why in tech-spec)
|
|
||||||
|
|
||||||
BMM respects your choice — it won't force modernization, but it will offer it.
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
---
|
||||||
|
title: "Established Projects FAQ"
|
||||||
|
description: Common questions about using BMad Method on established projects
|
||||||
|
---
|
||||||
|
Quick answers to common questions about working on established projects with the BMad Method (BMM).
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
- [Do I have to run document-project first?](#do-i-have-to-run-document-project-first)
|
||||||
|
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
||||||
|
- [Can I use Quick Flow for established projects?](#can-i-use-quick-flow-for-established-projects)
|
||||||
|
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||||
|
|
||||||
|
### Do I have to run document-project first?
|
||||||
|
|
||||||
|
Highly recommended, especially if:
|
||||||
|
|
||||||
|
- No existing documentation
|
||||||
|
- Documentation is outdated
|
||||||
|
- AI agents need context about existing code
|
||||||
|
|
||||||
|
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
||||||
|
|
||||||
|
### What if I forget to run document-project?
|
||||||
|
|
||||||
|
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
||||||
|
|
||||||
|
### Can I use Quick Flow for established projects?
|
||||||
|
|
||||||
|
Yes! Quick Flow works great for established projects. It will:
|
||||||
|
|
||||||
|
- Auto-detect your existing stack
|
||||||
|
- Analyze existing code patterns
|
||||||
|
- Detect conventions and ask for confirmation
|
||||||
|
- Generate context-rich tech-spec that respects existing code
|
||||||
|
|
||||||
|
Perfect for bug fixes and small features in existing codebases.
|
||||||
|
|
||||||
|
### What if my existing code doesn't follow best practices?
|
||||||
|
|
||||||
|
Quick Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||||
|
|
||||||
|
- **Yes** → Maintain consistency with current codebase
|
||||||
|
- **No** → Establish new standards (document why in tech-spec)
|
||||||
|
|
||||||
|
BMM respects your choice — it won't force modernization, but it will offer it.
|
||||||
|
|
||||||
|
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "BMad Method Customization Guide"
|
title: "BMad Method Customization Guide"
|
||||||
|
description: Customize agents, workflows, and modules while preserving update compatibility
|
||||||
---
|
---
|
||||||
|
|
||||||
The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem.
|
The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem.
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Brownfield Development"
|
title: "Established Projects"
|
||||||
description: How to use BMad Method on existing codebases
|
description: How to use BMad Method on existing codebases
|
||||||
---
|
---
|
||||||
|
|
||||||
Use BMad Method effectively when working on existing projects and legacy codebases.
|
Use BMad Method effectively when working on existing projects and legacy codebases, sometimes also referred to as brownfield projects.
|
||||||
|
|
||||||
## What is Brownfield Development?
|
This guide covers the essential workflow for onboarding to existing projects with BMad Method.
|
||||||
|
|
||||||
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
|
||||||
|
|
||||||
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
|
||||||
|
|
||||||
:::note[Prerequisites]
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
|
|
@ -80,5 +76,5 @@ Pay close attention here to prevent reinventing the wheel or making decisions th
|
||||||
|
|
||||||
## More Information
|
## More Information
|
||||||
|
|
||||||
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
- **[Quick Fixes](/docs/how-to/quick-fixes.md)** - Bug fixes and ad-hoc changes
|
||||||
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development
|
- **[Established Projects FAQ](/docs/explanation/established-projects-faq.md)** - Common questions about working on established projects
|
||||||
|
|
@ -42,8 +42,6 @@ Fetch `llms-full.txt` into your session:
|
||||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
|
||||||
|
|
||||||
### 3. Ask Your Question
|
### 3. Ask Your Question
|
||||||
|
|
||||||
:::note[Example]
|
:::note[Example]
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,8 @@ description: Step-by-step guide to installing BMad in your project
|
||||||
|
|
||||||
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
||||||
|
|
||||||
|
If you want to use a non interactive installer and provide all install options on the command line, [this guide](/docs/non-interactive-installation.md).
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Starting a new project with BMad
|
- Starting a new project with BMad
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "How to Make Quick Fixes in Brownfield Projects"
|
title: "Quick Fixes"
|
||||||
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
description: How to make quick fixes and ad-hoc changes
|
||||||
---
|
---
|
||||||
|
|
||||||
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
||||||
|
|
@ -1,24 +1,19 @@
|
||||||
---
|
---
|
||||||
title: "Document Sharding Guide"
|
title: "Document Sharding Guide"
|
||||||
|
description: Split large markdown files into smaller organized files for better context management
|
||||||
---
|
---
|
||||||
|
|
||||||
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
|
Use the `shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
||||||
|
|
||||||
|
This is no longer recommended, and soon with updated workflows and most major llms and tools supporting sub processes this will be unnecessary.
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Very large complex PRDs
|
Only use this if you notice your chosen tool / model combination are failing to load and read all the documents as input when needed.
|
||||||
- Architecture documents with multiple system layers
|
|
||||||
- Epic files with 4+ epics (especially for Phase 4)
|
|
||||||
- UX design specs covering multiple subsystems
|
|
||||||
|
|
||||||
## What is Document Sharding?
|
## What is Document Sharding?
|
||||||
|
|
||||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`).
|
||||||
|
|
||||||
- **Selective Loading** - Workflows load only the sections they need
|
|
||||||
- **Reduced Token Usage** - Massive efficiency gains for large projects
|
|
||||||
- **Better Organization** - Logical section-based file structure
|
|
||||||
- **Maintained Context** - Index file preserves document structure
|
|
||||||
|
|
||||||
### Architecture
|
### Architecture
|
||||||
|
|
||||||
|
|
@ -61,28 +56,6 @@ Agent: Sharding PRD.md...
|
||||||
✓ Complete!
|
✓ Complete!
|
||||||
```
|
```
|
||||||
|
|
||||||
## What You Get
|
|
||||||
|
|
||||||
**index.md structure:**
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
|
|
||||||
## Sections
|
|
||||||
|
|
||||||
1. [Overview](./overview.md) - Project vision and objectives
|
|
||||||
2. [User Requirements](./user-requirements.md) - Feature specifications
|
|
||||||
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
|
|
||||||
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
**Individual section files:**
|
|
||||||
|
|
||||||
- Named from heading text (kebab-case)
|
|
||||||
- Contains complete section content
|
|
||||||
- Preserves all markdown formatting
|
|
||||||
- Can be read independently
|
|
||||||
|
|
||||||
## How Workflow Discovery Works
|
## How Workflow Discovery Works
|
||||||
|
|
||||||
BMad workflows use a **dual discovery system**:
|
BMad workflows use a **dual discovery system**:
|
||||||
|
|
|
||||||
|
|
@ -20,14 +20,7 @@ Use the BMad installer to upgrade from v4 to v6, which includes automatic detect
|
||||||
|
|
||||||
### 1. Run the Installer
|
### 1. Run the Installer
|
||||||
|
|
||||||
```bash
|
Follow the [Installer Instructions](/docs/how-to/install-bmad.md).
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
|
|
||||||
The installer automatically detects:
|
|
||||||
|
|
||||||
- **Legacy v4 folder**: `.bmad-method`
|
|
||||||
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
|
|
||||||
|
|
||||||
### 2. Handle Legacy Installation
|
### 2. Handle Legacy Installation
|
||||||
|
|
||||||
|
|
@ -35,21 +28,16 @@ When v4 is detected, you can:
|
||||||
|
|
||||||
- Allow the installer to back up and remove `.bmad-method`
|
- Allow the installer to back up and remove `.bmad-method`
|
||||||
- Exit and handle cleanup manually
|
- Exit and handle cleanup manually
|
||||||
- Keep both (not recommended for same project)
|
|
||||||
|
If you named your bmad method folder something else - you will need to manual remove the folder yourself.
|
||||||
|
|
||||||
### 3. Clean Up IDE Commands
|
### 3. Clean Up IDE Commands
|
||||||
|
|
||||||
Manually remove legacy v4 IDE commands:
|
Manually remove legacy v4 IDE commands - for example if you have claude, look for any nested folders that start with bmad and remove them:
|
||||||
|
|
||||||
- `.claude/commands/BMad/agents`
|
- `.claude/commands/BMad/agents`
|
||||||
- `.claude/commands/BMad/tasks`
|
- `.claude/commands/BMad/tasks`
|
||||||
|
|
||||||
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
|
|
||||||
|
|
||||||
:::tip[Accidentally Deleted Commands?]
|
|
||||||
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 4. Migrate Planning Artifacts
|
### 4. Migrate Planning Artifacts
|
||||||
|
|
||||||
**If you have planning documents (Brief/PRD/UX/Architecture):**
|
**If you have planning documents (Brief/PRD/UX/Architecture):**
|
||||||
|
|
@ -71,24 +59,6 @@ If you have stories created or implemented:
|
||||||
3. Run the Scrum Master's `sprint-planning` workflow
|
3. Run the Scrum Master's `sprint-planning` workflow
|
||||||
4. Tell the SM which epics/stories are already complete
|
4. Tell the SM which epics/stories are already complete
|
||||||
|
|
||||||
### 6. Migrate Agent Customizations
|
|
||||||
|
|
||||||
**v4:** Modified agent files directly in `_bmad-*` folders
|
|
||||||
|
|
||||||
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# _bmad/_config/agents/bmm-pm.customize.yaml
|
|
||||||
persona:
|
|
||||||
name: 'Captain Jack'
|
|
||||||
role: 'Swashbuckling Product Owner'
|
|
||||||
communication_style: |
|
|
||||||
- Talk like a pirate
|
|
||||||
- Use nautical metaphors
|
|
||||||
```
|
|
||||||
|
|
||||||
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
**v6 unified structure:**
|
**v6 unified structure:**
|
||||||
|
|
@ -107,25 +77,19 @@ your-project/
|
||||||
|
|
||||||
## Module Migration
|
## Module Migration
|
||||||
|
|
||||||
| v4 Module | v6 Status |
|
| v4 Module | v6 Status |
|
||||||
|-----------|-----------|
|
| ----------------------------- | ----------------------------------------- |
|
||||||
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
| `.bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
||||||
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
| `.bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
||||||
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
|
| `.bmad-godot-game-dev` | Integrated into BMGD Module |
|
||||||
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
| `.bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
||||||
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
| `.bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
||||||
|
|
||||||
## Key Changes
|
## Key Changes
|
||||||
|
|
||||||
| Concept | v4 | v6 |
|
| Concept | v4 | v6 |
|
||||||
|---------|----|----|
|
| ------------- | ------------------------------------- | ------------------------------------ |
|
||||||
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
|
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
|
||||||
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||||
| **Config** | Modified files directly | `config.yaml` per module |
|
| **Config** | Modified files directly | `config.yaml` per module |
|
||||||
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
|
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- **Back up first** — Keep your v4 installation until you verify v6 works
|
|
||||||
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
|
|
||||||
- **Rebuild after customizing** — Always run the installer after changing customize files
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,9 @@
|
||||||
---
|
---
|
||||||
title: Welcome to the BMad Method
|
title: Welcome to the BMad Method
|
||||||
|
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 faster and smarter. 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 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.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,314 @@
|
||||||
|
---
|
||||||
|
title: Non-Interactive Installation
|
||||||
|
description: Install BMAD using command-line flags for CI/CD pipelines and automated deployments
|
||||||
|
---
|
||||||
|
|
||||||
|
# Non-Interactive Installation
|
||||||
|
|
||||||
|
BMAD now supports non-interactive installation through command-line flags. This is particularly useful for:
|
||||||
|
|
||||||
|
- Automated deployments and CI/CD pipelines
|
||||||
|
- Scripted installations
|
||||||
|
- Batch installations across multiple projects
|
||||||
|
- Quick installations with known configurations
|
||||||
|
|
||||||
|
## Installation Modes
|
||||||
|
|
||||||
|
### 1. Fully Interactive (Default)
|
||||||
|
|
||||||
|
Run without any flags to use the traditional interactive prompts:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Fully Non-Interactive
|
||||||
|
|
||||||
|
Provide all required flags to skip all prompts:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory /path/to/project \
|
||||||
|
--modules bmm,bmb \
|
||||||
|
--tools claude-code,cursor \
|
||||||
|
--user-name "John Doe" \
|
||||||
|
--communication-language English \
|
||||||
|
--document-output-language English \
|
||||||
|
--output-folder _bmad-output
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Semi-Interactive (Graceful Fallback)
|
||||||
|
|
||||||
|
Provide some flags and let BMAD prompt for the rest:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory /path/to/project \
|
||||||
|
--modules bmm
|
||||||
|
```
|
||||||
|
|
||||||
|
In this case, BMAD will:
|
||||||
|
- Use the provided directory and modules
|
||||||
|
- Prompt for tool selection
|
||||||
|
- Prompt for core configuration
|
||||||
|
|
||||||
|
### 4. Quick Install with Defaults
|
||||||
|
|
||||||
|
Use the `-y` or `--yes` flag to accept all defaults:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
This will:
|
||||||
|
- Install to the current directory
|
||||||
|
- Skip custom content prompts
|
||||||
|
- Use default values for all configuration
|
||||||
|
- Use previously configured tools (or skip tool configuration if none exist)
|
||||||
|
|
||||||
|
### 5. Install Without Tools
|
||||||
|
|
||||||
|
To skip tool/IDE configuration entirely:
|
||||||
|
|
||||||
|
**Option 1: Use --tools none**
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --directory ~/myapp --modules bmm --tools none
|
||||||
|
```
|
||||||
|
|
||||||
|
**Option 2: Use --yes flag (if no tools were previously configured)**
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
**Option 3: Omit --tools and select "None" in the interactive prompt**
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --directory ~/myapp --modules bmm
|
||||||
|
# Then select "⚠ None - I am not installing any tools" when prompted
|
||||||
|
```
|
||||||
|
|
||||||
|
## Available Flags
|
||||||
|
|
||||||
|
### Installation Options
|
||||||
|
|
||||||
|
| Flag | Description | Example |
|
||||||
|
|------|-------------|---------|
|
||||||
|
| `--directory <path>` | Installation directory | `--directory ~/projects/myapp` |
|
||||||
|
| `--modules <modules>` | Comma-separated module IDs | `--modules bmm,bmb` |
|
||||||
|
| `--tools <tools>` | Comma-separated tool/IDE IDs (use "none" to skip) | `--tools claude-code,cursor` or `--tools none` |
|
||||||
|
| `--custom-content <paths>` | Comma-separated paths to custom modules | `--custom-content ~/my-module,~/another-module` |
|
||||||
|
| `--action <type>` | Action for existing installations | `--action quick-update` |
|
||||||
|
|
||||||
|
### Core Configuration
|
||||||
|
|
||||||
|
| Flag | Description | Default |
|
||||||
|
|------|-------------|---------|
|
||||||
|
| `--user-name <name>` | Name for agents to use | System username |
|
||||||
|
| `--communication-language <lang>` | Agent communication language | English |
|
||||||
|
| `--document-output-language <lang>` | Document output language | English |
|
||||||
|
| `--output-folder <path>` | Output folder path | _bmad-output |
|
||||||
|
|
||||||
|
### Other Options
|
||||||
|
|
||||||
|
| Flag | Description |
|
||||||
|
|------|-------------|
|
||||||
|
| `-y, --yes` | Accept all defaults and skip prompts |
|
||||||
|
| `-d, --debug` | Enable debug output for manifest generation |
|
||||||
|
|
||||||
|
## Action Types
|
||||||
|
|
||||||
|
When working with existing installations, use the `--action` flag:
|
||||||
|
|
||||||
|
- `install` - Fresh installation (default for new directories)
|
||||||
|
- `update` - Modify existing installation (change modules/config)
|
||||||
|
- `quick-update` - Refresh installation without changing configuration
|
||||||
|
- `compile-agents` - Recompile agents with customizations only
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install --action quick-update
|
||||||
|
```
|
||||||
|
|
||||||
|
## Module IDs
|
||||||
|
|
||||||
|
Available module IDs for the `--modules` flag:
|
||||||
|
|
||||||
|
### Core Modules
|
||||||
|
- `bmm` - BMad Method Master
|
||||||
|
- `bmb` - BMad Builder
|
||||||
|
|
||||||
|
### External Modules
|
||||||
|
Check the [BMad registry](https://github.com/bmad-code-org) for available external modules.
|
||||||
|
|
||||||
|
## Tool/IDE IDs
|
||||||
|
|
||||||
|
Available tool IDs for the `--tools` flag:
|
||||||
|
|
||||||
|
- `claude-code` - Claude Code CLI
|
||||||
|
- `cursor` - Cursor IDE
|
||||||
|
- `windsurf` - Windsurf IDE
|
||||||
|
- `vscode` - Visual Studio Code
|
||||||
|
- `jetbrains` - JetBrains IDEs
|
||||||
|
- And more...
|
||||||
|
|
||||||
|
Run the interactive installer once to see all available tools.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Basic Installation
|
||||||
|
|
||||||
|
Install BMM module with Claude Code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--modules bmm \
|
||||||
|
--tools claude-code \
|
||||||
|
--user-name "Development Team"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installation Without Tools
|
||||||
|
|
||||||
|
Install without configuring any tools/IDEs:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--modules bmm \
|
||||||
|
--tools none \
|
||||||
|
--user-name "Development Team"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Full Installation with Multiple Modules
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--modules bmm,bmb \
|
||||||
|
--tools claude-code,cursor \
|
||||||
|
--user-name "John Doe" \
|
||||||
|
--communication-language English \
|
||||||
|
--document-output-language English \
|
||||||
|
--output-folder _output
|
||||||
|
```
|
||||||
|
|
||||||
|
### Update Existing Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--action update \
|
||||||
|
--modules bmm,bmb,custom-module
|
||||||
|
```
|
||||||
|
|
||||||
|
### Quick Update (Preserve Settings)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--action quick-update
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installation with Custom Content
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory ~/projects/myapp \
|
||||||
|
--modules bmm \
|
||||||
|
--custom-content ~/my-custom-module,~/another-module \
|
||||||
|
--tools claude-code
|
||||||
|
```
|
||||||
|
|
||||||
|
### CI/CD Pipeline Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/bin/bash
|
||||||
|
# install-bmad.sh
|
||||||
|
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory "${GITHUB_WORKSPACE}" \
|
||||||
|
--modules bmm \
|
||||||
|
--tools claude-code \
|
||||||
|
--user-name "CI Bot" \
|
||||||
|
--communication-language English \
|
||||||
|
--document-output-language English \
|
||||||
|
--output-folder _bmad-output \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment-Specific Installations
|
||||||
|
|
||||||
|
### Development Environment
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory . \
|
||||||
|
--modules bmm,bmb \
|
||||||
|
--tools claude-code,cursor \
|
||||||
|
--user-name "${USER}"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Production Environment
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install \
|
||||||
|
--directory /opt/app \
|
||||||
|
--modules bmm \
|
||||||
|
--tools claude-code \
|
||||||
|
--user-name "Production Team" \
|
||||||
|
--output-folder /var/bmad-output
|
||||||
|
```
|
||||||
|
|
||||||
|
## Validation and Error Handling
|
||||||
|
|
||||||
|
BMAD validates all provided flags:
|
||||||
|
|
||||||
|
- **Directory**: Must be a valid path with write permissions
|
||||||
|
- **Modules**: Will warn about invalid module IDs (but won't fail)
|
||||||
|
- **Tools**: Will warn about invalid tool IDs (but won't fail)
|
||||||
|
- **Custom Content**: Each path must contain a valid `module.yaml` file
|
||||||
|
- **Action**: Must be one of: install, update, quick-update, compile-agents
|
||||||
|
|
||||||
|
Invalid values will either:
|
||||||
|
1. Show an error and exit (for critical options like directory)
|
||||||
|
2. Show a warning and skip (for optional items like custom content)
|
||||||
|
3. Fall back to interactive prompts (for missing required values)
|
||||||
|
|
||||||
|
## Tips and Best Practices
|
||||||
|
|
||||||
|
1. **Use absolute paths** for `--directory` to avoid ambiguity
|
||||||
|
2. **Test flags locally** before using in CI/CD pipelines
|
||||||
|
3. **Combine with `-y`** for truly unattended installations
|
||||||
|
4. **Check module availability** by running the interactive installer once
|
||||||
|
5. **Use `--debug`** flag if you encounter issues during installation
|
||||||
|
6. **Skip tool configuration** with `--tools none` for server/CI environments where IDEs aren't needed
|
||||||
|
7. **Partial flags are OK** - Omit flags and let BMAD prompt for missing values interactively
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Installation fails with "Invalid directory"
|
||||||
|
|
||||||
|
Check that:
|
||||||
|
- The directory path exists or its parent exists
|
||||||
|
- You have write permissions
|
||||||
|
- The path is absolute or correctly relative to current directory
|
||||||
|
|
||||||
|
### Module not found
|
||||||
|
|
||||||
|
- Verify the module ID is correct (check available modules in interactive mode)
|
||||||
|
- External modules may need to be available in the registry
|
||||||
|
|
||||||
|
### Custom content path invalid
|
||||||
|
|
||||||
|
Ensure each custom content path:
|
||||||
|
- Points to a directory
|
||||||
|
- Contains a `module.yaml` file in the root
|
||||||
|
- Has a `code` field in the `module.yaml`
|
||||||
|
|
||||||
|
## Feedback and Issues
|
||||||
|
|
||||||
|
If you encounter any issues with non-interactive installation:
|
||||||
|
|
||||||
|
1. Run with `--debug` flag for detailed output
|
||||||
|
2. Try the interactive mode to verify the issue
|
||||||
|
3. Report issues on GitHub: <https://github.com/bmad-code-org/BMAD-METHOD/issues>
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
---
|
||||||
|
title: Agents
|
||||||
|
description: Default BMM agents with their menu triggers and primary workflows
|
||||||
|
---
|
||||||
|
|
||||||
|
This page lists the default BMM (Agile suite) agents that install with BMAD Method, along with their menu triggers and primary workflows.
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu.
|
||||||
|
- Slash commands are generated separately. See `docs/reference/commands.md` for the slash command list and where they are defined.
|
||||||
|
- QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.
|
||||||
|
|
||||||
|
| Agent | Triggers | Primary workflows |
|
||||||
|
| --------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
||||||
|
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
||||||
|
| Architect (Winston) | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
||||||
|
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
||||||
|
| Developer (Amelia) | `DS`, `CR` | Dev Story, Code Review |
|
||||||
|
| QA Engineer (Quinn) | `QA` | Automate (generate tests for existing features) |
|
||||||
|
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
||||||
|
| UX Designer (Sally) | `CU` | Create UX Design |
|
||||||
|
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
title: Commands
|
||||||
|
description: How BMAD commands are generated and where to find them.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Commands
|
||||||
|
|
||||||
|
BMAD slash commands are generated by the installer for your IDE and **reflect the modules you have installed**.
|
||||||
|
That means the authoritative list lives **in your project**, not in a static docs page.
|
||||||
|
|
||||||
|
## How to Discover Commands (Recommended)
|
||||||
|
|
||||||
|
- Type `/bmad` in your IDE and use autocomplete to browse agents/workflows.
|
||||||
|
- Run `/bmad-help` to get guided next steps and context-aware recommendations.
|
||||||
|
|
||||||
|
## Where Commands Are Generated
|
||||||
|
|
||||||
|
The installer writes command files into your project (example paths for Claude Code):
|
||||||
|
|
||||||
|
- `.claude/commands/bmad/<module>/agents/`
|
||||||
|
- `.claude/commands/bmad/<module>/workflows/`
|
||||||
|
|
||||||
|
These folders are the **canonical, project-specific command list**.
|
||||||
|
|
||||||
|
## Common Commands
|
||||||
|
|
||||||
|
- `/bmad-help` - Interactive help and next-step guidance
|
||||||
|
- `/bmad:<module>:agents:<agent>` - Load an agent (e.g. `/bmad:bmm:agents:dev`)
|
||||||
|
- `/bmad:<module>:workflows:<workflow>` - Run a workflow (e.g. `/bmad:bmm:workflows:create-prd`)
|
||||||
|
|
||||||
|
## Why This Page Is Short
|
||||||
|
|
||||||
|
BMAD is modular, so the exact commands vary by install.
|
||||||
|
Use your IDE's autocomplete or the generated command folders above to see *everything* available.
|
||||||
|
|
@ -0,0 +1,74 @@
|
||||||
|
---
|
||||||
|
title: Official Modules
|
||||||
|
description: Add-on modules for building custom agents, creative intelligence, game development, and testing
|
||||||
|
---
|
||||||
|
|
||||||
|
BMad extends through official modules that you select during installation. These add-on modules provide specialized agents, workflows, and tasks for specific domains beyond the built-in core and BMM (Agile suite).
|
||||||
|
|
||||||
|
:::tip[Installing Modules]
|
||||||
|
Run `npx bmad-method install` and select the modules you want. The installer handles downloading, configuration, and IDE integration automatically.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## BMad Builder
|
||||||
|
|
||||||
|
Create custom agents, workflows, and domain-specific modules with guided assistance. BMad Builder is the meta-module for extending the framework itself.
|
||||||
|
|
||||||
|
- **Code:** `bmb`
|
||||||
|
- **npm:** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||||
|
- **GitHub:** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||||
|
|
||||||
|
**Provides:**
|
||||||
|
|
||||||
|
- Agent Builder -- create specialized AI agents with custom expertise and tool access
|
||||||
|
- Workflow Builder -- design structured processes with steps and decision points
|
||||||
|
- Module Builder -- package agents and workflows into shareable, publishable modules
|
||||||
|
- Interactive setup with YAML configuration and npm publishing support
|
||||||
|
|
||||||
|
## Creative Intelligence Suite
|
||||||
|
|
||||||
|
AI-powered tools for structured creativity, ideation, and innovation during early-stage development. The suite provides multiple agents that facilitate brainstorming, design thinking, and problem-solving using proven frameworks.
|
||||||
|
|
||||||
|
- **Code:** `cis`
|
||||||
|
- **npm:** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||||
|
- **GitHub:** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||||
|
|
||||||
|
**Provides:**
|
||||||
|
|
||||||
|
- Innovation Strategist, Design Thinking Coach, and Brainstorming Coach agents
|
||||||
|
- Problem Solver and Creative Problem Solver for systematic and lateral thinking
|
||||||
|
- Storyteller and Presentation Master for narratives and pitches
|
||||||
|
- Ideation frameworks including SCAMPER, Reverse Brainstorming, and problem reframing
|
||||||
|
|
||||||
|
## Game Dev Studio
|
||||||
|
|
||||||
|
Structured game development workflows adapted for Unity, Unreal, Godot, and custom engines. Supports rapid prototyping through Quick Flow and full-scale production with epic-driven sprints.
|
||||||
|
|
||||||
|
- **Code:** `gds`
|
||||||
|
- **npm:** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||||
|
- **GitHub:** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||||
|
|
||||||
|
**Provides:**
|
||||||
|
|
||||||
|
- Game Design Document (GDD) generation workflow
|
||||||
|
- Quick Dev mode for rapid prototyping
|
||||||
|
- Narrative design support for characters, dialogue, and world-building
|
||||||
|
- Coverage for 21+ game types with engine-specific architecture guidance
|
||||||
|
|
||||||
|
## Test Architect (TEA)
|
||||||
|
|
||||||
|
Enterprise-grade test strategy, automation guidance, and release gate decisions through an expert agent and nine structured workflows. TEA goes well beyond the built-in QA agent with risk-based prioritization and requirements traceability.
|
||||||
|
|
||||||
|
- **Code:** `tea`
|
||||||
|
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||||
|
- **GitHub:** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||||
|
|
||||||
|
**Provides:**
|
||||||
|
|
||||||
|
- Murat agent (Master Test Architect and Quality Advisor)
|
||||||
|
- Workflows for test design, ATDD, automation, test review, and traceability
|
||||||
|
- NFR assessment, CI setup, and framework scaffolding
|
||||||
|
- P0-P3 prioritization with optional Playwright Utils and MCP integrations
|
||||||
|
|
||||||
|
## Community Modules
|
||||||
|
|
||||||
|
Community modules and a module marketplace are coming. Check the [BMad GitHub organization](https://github.com/bmad-code-org) for updates.
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
---
|
||||||
|
title: Testing Options
|
||||||
|
description: Built-in QA agent and the standalone Test Architect module for advanced testing
|
||||||
|
---
|
||||||
|
|
||||||
|
# Testing Options
|
||||||
|
|
||||||
|
BMad provides a built-in QA agent for quick test automation and a separate Test Architect (TEA) module for advanced testing.
|
||||||
|
|
||||||
|
## Built-in QA (Quinn)
|
||||||
|
|
||||||
|
Use the built-in QA agent for fast, straightforward test coverage:
|
||||||
|
|
||||||
|
- Trigger: `QA` or `bmad-bmm-qa-automate`
|
||||||
|
- Best for: small projects, quick coverage, standard patterns
|
||||||
|
|
||||||
|
## Test Architect (TEA) Module
|
||||||
|
|
||||||
|
TEA is a standalone module with advanced testing workflows (test design, ATDD, automate, review, trace, NFR assessment).
|
||||||
|
|
||||||
|
- Documentation: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
||||||
|
- Install: `npx bmad-method@alpha install` and select the TEA module
|
||||||
|
|
@ -73,7 +73,7 @@ Skip phases 1-3 for small, well-understood work.
|
||||||
|
|
||||||
Each document becomes context for the next phase. The PRD tells the architect what constraints matter. The architecture tells the dev agent which patterns to follow. Story files give focused, complete context for implementation. Without this structure, agents make inconsistent decisions.
|
Each document becomes context for the next phase. The PRD tells the architect what constraints matter. The architecture tells the dev agent which patterns to follow. Story files give focused, complete context for implementation. Without this structure, agents make inconsistent decisions.
|
||||||
|
|
||||||
For brownfield projects, `document-project` creates or updates `project-context.md` - what exists in the codebase and the rules all implementation workflows must observe. Run it just before Phase 4, and again when something significant changes - structure, architecture, or those rules. You can also edit `project-context.md` by hand.
|
For established projects, `document-project` creates or updates `project-context.md` - what exists in the codebase and the rules all implementation workflows must observe. Run it just before Phase 4, and again when something significant changes - structure, architecture, or those rules. You can also edit `project-context.md` by hand.
|
||||||
|
|
||||||
All implementation workflows load `project-context.md` if it exists. Additional context per workflow:
|
All implementation workflows load `project-context.md` if it exists. Additional context per workflow:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,11 +12,7 @@ export default [
|
||||||
'coverage/**',
|
'coverage/**',
|
||||||
'**/*.min.js',
|
'**/*.min.js',
|
||||||
'test/template-test-generator/**',
|
'test/template-test-generator/**',
|
||||||
'test/template-test-generator/**/*.js',
|
|
||||||
'test/template-test-generator/**/*.md',
|
|
||||||
'test/fixtures/**',
|
'test/fixtures/**',
|
||||||
'test/fixtures/**/*.yaml',
|
|
||||||
'_bmad/**',
|
|
||||||
'_bmad*/**',
|
'_bmad*/**',
|
||||||
// Build output
|
// Build output
|
||||||
'build/**',
|
'build/**',
|
||||||
|
|
@ -36,6 +32,10 @@ export default [
|
||||||
'tools/template-test-generator/test-scenarios/**',
|
'tools/template-test-generator/test-scenarios/**',
|
||||||
'src/modules/*/sub-modules/**',
|
'src/modules/*/sub-modules/**',
|
||||||
'.bundler-temp/**',
|
'.bundler-temp/**',
|
||||||
|
// Augment vendor config — not project code, naming conventions
|
||||||
|
// are dictated by Augment and can't be changed, so exclude
|
||||||
|
// the entire directory from linting
|
||||||
|
'.augment/**',
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
18
package.json
18
package.json
|
|
@ -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.5",
|
"version": "6.0.0-Beta.7",
|
||||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"agile",
|
"agile",
|
||||||
|
|
@ -26,7 +26,7 @@
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"bmad:install": "node tools/cli/bmad-cli.js install",
|
"bmad:install": "node tools/cli/bmad-cli.js install",
|
||||||
"bundle": "node tools/cli/bundlers/bundle-web.js all",
|
"bundle": "node tools/cli/bundlers/bundle-web.js all",
|
||||||
"docs:build": "node tools/build-docs.js",
|
"docs:build": "node tools/build-docs.mjs",
|
||||||
"docs:dev": "astro dev --root website",
|
"docs:dev": "astro dev --root website",
|
||||||
"docs:fix-links": "node tools/fix-doc-links.js",
|
"docs:fix-links": "node tools/fix-doc-links.js",
|
||||||
"docs:preview": "astro preview --root website",
|
"docs:preview": "astro preview --root website",
|
||||||
|
|
@ -41,10 +41,6 @@
|
||||||
"lint:md": "markdownlint-cli2 \"**/*.md\"",
|
"lint:md": "markdownlint-cli2 \"**/*.md\"",
|
||||||
"prepare": "command -v husky >/dev/null 2>&1 && husky || exit 0",
|
"prepare": "command -v husky >/dev/null 2>&1 && husky || exit 0",
|
||||||
"rebundle": "node tools/cli/bundlers/bundle-web.js rebundle",
|
"rebundle": "node tools/cli/bundlers/bundle-web.js rebundle",
|
||||||
"release:major": "gh workflow run \"Manual Release\" -f version_bump=major",
|
|
||||||
"release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor",
|
|
||||||
"release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch",
|
|
||||||
"release:watch": "gh run watch",
|
|
||||||
"test": "npm run test:schemas && npm run test:install && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
|
"test": "npm run test:schemas && npm run test:install && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
|
||||||
"test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
|
"test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
|
||||||
"test:install": "node test/test-installation-components.js",
|
"test:install": "node test/test-installation-components.js",
|
||||||
|
|
@ -69,21 +65,18 @@
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@clack/prompts": "^0.11.0",
|
"@clack/core": "^1.0.0",
|
||||||
|
"@clack/prompts": "^1.0.0",
|
||||||
"@kayvan/markdown-tree-parser": "^1.6.1",
|
"@kayvan/markdown-tree-parser": "^1.6.1",
|
||||||
"boxen": "^5.1.2",
|
|
||||||
"chalk": "^4.1.2",
|
"chalk": "^4.1.2",
|
||||||
"cli-table3": "^0.6.5",
|
|
||||||
"commander": "^14.0.0",
|
"commander": "^14.0.0",
|
||||||
"csv-parse": "^6.1.0",
|
"csv-parse": "^6.1.0",
|
||||||
"figlet": "^1.8.0",
|
|
||||||
"fs-extra": "^11.3.0",
|
"fs-extra": "^11.3.0",
|
||||||
"glob": "^11.0.3",
|
"glob": "^11.0.3",
|
||||||
"ignore": "^7.0.5",
|
"ignore": "^7.0.5",
|
||||||
"js-yaml": "^4.1.0",
|
"js-yaml": "^4.1.0",
|
||||||
"ora": "^5.4.1",
|
"picocolors": "^1.1.1",
|
||||||
"semver": "^7.6.3",
|
"semver": "^7.6.3",
|
||||||
"wrap-ansi": "^7.0.0",
|
|
||||||
"xml2js": "^0.6.2",
|
"xml2js": "^0.6.2",
|
||||||
"yaml": "^2.7.0"
|
"yaml": "^2.7.0"
|
||||||
},
|
},
|
||||||
|
|
@ -91,7 +84,6 @@
|
||||||
"@astrojs/sitemap": "^3.6.0",
|
"@astrojs/sitemap": "^3.6.0",
|
||||||
"@astrojs/starlight": "^0.37.5",
|
"@astrojs/starlight": "^0.37.5",
|
||||||
"@eslint/js": "^9.33.0",
|
"@eslint/js": "^9.33.0",
|
||||||
"archiver": "^7.0.1",
|
|
||||||
"astro": "^5.16.0",
|
"astro": "^5.16.0",
|
||||||
"c8": "^10.1.3",
|
"c8": "^10.1.3",
|
||||||
"eslint": "^9.33.0",
|
"eslint": "^9.33.0",
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
# Business Analyst Agent Definition
|
|
||||||
|
|
||||||
agent:
|
agent:
|
||||||
metadata:
|
metadata:
|
||||||
id: "_bmad/bmm/agents/analyst.md"
|
id: "_bmad/bmm/agents/analyst.md"
|
||||||
|
|
@ -23,9 +21,17 @@ agent:
|
||||||
data: "{project-root}/_bmad/bmm/data/project-context-template.md"
|
data: "{project-root}/_bmad/bmm/data/project-context-template.md"
|
||||||
description: "[BP] Brainstorm Project: Expert Guided Facilitation through a single or multiple techniques with a final report"
|
description: "[BP] Brainstorm Project: Expert Guided Facilitation through a single or multiple techniques with a final report"
|
||||||
|
|
||||||
- trigger: RS or fuzzy match on research
|
- trigger: MR or fuzzy match on market-research
|
||||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-market-research.md"
|
||||||
description: "[RS] Research: Choose from or specify market, domain, competitive analysis, or technical research"
|
description: "[MR] Market Research: Market analysis, competitive landscape, customer needs and trends"
|
||||||
|
|
||||||
|
- trigger: DR or fuzzy match on domain-research
|
||||||
|
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md"
|
||||||
|
description: "[DR] Domain Research: Industry domain deep dive, subject matter expertise and terminology"
|
||||||
|
|
||||||
|
- trigger: TR or fuzzy match on technical-research
|
||||||
|
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md"
|
||||||
|
description: "[TR] Technical Research: Technical feasibility, architecture options and implementation approaches"
|
||||||
|
|
||||||
- trigger: CB or fuzzy match on product-brief
|
- trigger: CB or fuzzy match on product-brief
|
||||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
# Dev Implementation Agent Definition (v6)
|
# Dev Implementation Agent Definition (v6)
|
||||||
|
|
||||||
agent:
|
agent:
|
||||||
webskip: true
|
|
||||||
metadata:
|
metadata:
|
||||||
id: "_bmad/bmm/agents/dev.md"
|
id: "_bmad/bmm/agents/dev.md"
|
||||||
name: Amelia
|
name: Amelia
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,3 @@
|
||||||
# Product Manager Agent Definition
|
|
||||||
# This file defines the PM agent for the BMAD BMM module
|
|
||||||
|
|
||||||
agent:
|
agent:
|
||||||
metadata:
|
metadata:
|
||||||
id: "_bmad/bmm/agents/pm.md"
|
id: "_bmad/bmm/agents/pm.md"
|
||||||
|
|
@ -22,15 +19,15 @@ agent:
|
||||||
|
|
||||||
menu:
|
menu:
|
||||||
- trigger: CP or fuzzy match on create-prd
|
- trigger: CP or fuzzy match on create-prd
|
||||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md"
|
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md"
|
||||||
description: "[CP] Create PRD: Expert led facilitation to produce your Product Requirements Document"
|
description: "[CP] Create PRD: Expert led facilitation to produce your Product Requirements Document"
|
||||||
|
|
||||||
- trigger: VP or fuzzy match on validate-prd
|
- trigger: VP or fuzzy match on validate-prd
|
||||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md"
|
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md"
|
||||||
description: "[VP] Validate PRD: Validate a Product Requirements Document is comprehensive, lean, well organized and cohesive"
|
description: "[VP] Validate PRD: Validate a Product Requirements Document is comprehensive, lean, well organized and cohesive"
|
||||||
|
|
||||||
- trigger: EP or fuzzy match on edit-prd
|
- trigger: EP or fuzzy match on edit-prd
|
||||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md"
|
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md"
|
||||||
description: "[EP] Edit PRD: Update an existing Product Requirements Document"
|
description: "[EP] Edit PRD: Update an existing Product Requirements Document"
|
||||||
|
|
||||||
- trigger: CE or fuzzy match on epics-stories
|
- trigger: CE or fuzzy match on epics-stories
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ agent:
|
||||||
- Focus on realistic user scenarios
|
- Focus on realistic user scenarios
|
||||||
|
|
||||||
menu:
|
menu:
|
||||||
- trigger: qa
|
- trigger: QA or fuzzy match on qa-automate
|
||||||
workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml"
|
workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml"
|
||||||
description: "[QA] Automate - Generate tests for existing features (simplified)"
|
description: "[QA] Automate - Generate tests for existing features (simplified)"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,29 +4,22 @@ bmm,anytime,Generate Project Context,GPC,,_bmad/bmm/workflows/generate-project-c
|
||||||
bmm,anytime,Quick Spec,QS,,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad-bmm-quick-spec,false,quick-flow-solo-dev,Create Mode,"Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps brownfield additions to well established patterns utilities without extensive planning",planning_artifacts,"tech spec",
|
bmm,anytime,Quick Spec,QS,,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad-bmm-quick-spec,false,quick-flow-solo-dev,Create Mode,"Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps brownfield additions to well established patterns utilities without extensive planning",planning_artifacts,"tech spec",
|
||||||
bmm,anytime,Quick Dev,QD,,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad-bmm-quick-dev,false,quick-flow-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,,
|
bmm,anytime,Quick Dev,QD,,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad-bmm-quick-dev,false,quick-flow-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,,
|
||||||
bmm,anytime,Correct Course,CC,,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad-bmm-correct-course,false,sm,Create Mode,"Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories",planning_artifacts,"change proposal",
|
bmm,anytime,Correct Course,CC,,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad-bmm-correct-course,false,sm,Create Mode,"Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories",planning_artifacts,"change proposal",
|
||||||
bmm,anytime,Create Dataflow,CDF,,_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml,bmad-bmm-create-excalidraw-dataflow,false,ux-designer,Create Mode,"Create data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentation",planning_artifacts,"dataflow diagram",
|
bmm,anytime,Write Document,WD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,,"Describe in detail what you want, and the agent will follow the documentation best practices defined in agent memory. Multi-turn conversation with subprocess for research/review.",project-knowledge,"document",
|
||||||
bmm,anytime,Create Diagram,CED,,_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml,bmad-bmm-create-excalidraw-diagram,false,ux-designer,Create Mode,"Create system architecture diagrams ERDs UML diagrams or general technical diagrams in Excalidraw format - use anytime or call from architecture workflow to add visual documentation",planning_artifacts,"diagram",
|
bmm,anytime,Update Standards,US,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,,"Update agent memory documentation-standards.md with your specific preferences if you discover missing document conventions.",_bmad/_memory/tech-writer-sidecar,"standards",
|
||||||
bmm,anytime,Create Flowchart,CFC,,_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml,bmad-bmm-create-excalidraw-flowchart,false,ux-designer,Create Mode,"Create a flowchart visualization in Excalidraw format for processes pipelines or logic flows - use anytime or during architecture to add process documentation",planning_artifacts,"flowchart",
|
bmm,anytime,Mermaid Generate,MG,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,,"Create a Mermaid diagram based on user description. Will suggest diagram types if not specified.",planning_artifacts,"mermaid diagram",
|
||||||
bmm,anytime,Create Wireframe,CEW,,_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml,bmad-bmm-create-excalidraw-wireframe,false,ux-designer,Create Mode,"Create website or app wireframes in Excalidraw format - use anytime standalone or call from UX workflow to add UI mockups",planning_artifacts,"wireframe",
|
bmm,anytime,Validate Document,VD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,,"Review the specified document against documentation standards and best practices. Returns specific actionable improvement suggestions organized by priority.",planning_artifacts,"validation report",
|
||||||
bmm,anytime,Write Document,WD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,bmad-bmm-write-document,false,tech-writer,,"Describe in detail what you want, and the agent will follow the documentation best practices defined in agent memory. Multi-turn conversation with subprocess for research/review.",project-knowledge,"document",
|
bmm,anytime,Explain Concept,EC,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,,false,tech-writer,,"Create clear technical explanations with examples and diagrams for complex concepts. Breaks down into digestible sections using task-oriented approach.",project_knowledge,"explanation",
|
||||||
bmm,anytime,Update Standards,US,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,bmad-bmm-update-standards,false,tech-writer,,"Update agent memory documentation-standards.md with your specific preferences if you discover missing document conventions.",_bmad/_memory/tech-writer-sidecar,"standards",
|
|
||||||
bmm,anytime,Mermaid Generate,MG,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,bmad-bmm-mermaid-generate,false,tech-writer,,"Create a Mermaid diagram based on user description. Will suggest diagram types if not specified.",planning_artifacts,"mermaid diagram",
|
|
||||||
bmm,anytime,Validate Document,VD,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,bmad-bmm-validate-document,false,tech-writer,,"Review the specified document against documentation standards and best practices. Returns specific actionable improvement suggestions organized by priority.",planning_artifacts,"validation report",
|
|
||||||
bmm,anytime,Explain Concept,EC,,_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml,bmad-bmm-explain-concept,false,tech-writer,,"Create clear technical explanations with examples and diagrams for complex concepts. Breaks down into digestible sections using task-oriented approach.",project_knowledge,"explanation",
|
|
||||||
bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,data=_bmad/bmm/data/project-context-template.md,"Expert Guided Facilitation through a single or multiple techniques",planning_artifacts,"brainstorming session",
|
bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,data=_bmad/bmm/data/project-context-template.md,"Expert Guided Facilitation through a single or multiple techniques",planning_artifacts,"brainstorming session",
|
||||||
bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad-bmm-research,false,analyst,Create Mode research_type=market,"Market analysis competitive landscape customer needs and trends","planning_artifacts|project-knowledge","research documents",
|
bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow-market-research.md,bmad-bmm-market-research,false,analyst,Create Mode,"Market analysis competitive landscape customer needs and trends","planning_artifacts|project-knowledge","research documents",
|
||||||
bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad-bmm-research,false,analyst,Create Mode research_type=domain,"Industry domain deep dive subject matter expertise and terminology","planning_artifacts|project_knowledge","research documents",
|
bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md,bmad-bmm-domain-research,false,analyst,Create Mode,"Industry domain deep dive subject matter expertise and terminology","planning_artifacts|project_knowledge","research documents",
|
||||||
bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad-bmm-research,false,analyst,Create Mode research_type=technical,"Technical feasibility architecture options and implementation approaches","planning_artifacts|project_knowledge","research documents",
|
bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md,bmad-bmm-technical-research,false,analyst,Create Mode,"Technical feasibility architecture options and implementation approaches","planning_artifacts|project_knowledge","research documents",
|
||||||
bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad-bmm-create-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief",
|
bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad-bmm-create-product-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief",
|
||||||
bmm,1-analysis,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad-bmm-validate-brief,false,analyst,Validate Mode,"Validates product brief completeness",planning_artifacts,"brief validation report",
|
bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md,bmad-bmm-create-prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd,
|
||||||
bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md,bmad-bmm-create-prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd,
|
bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md,bmad-bmm-validate-prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report",
|
||||||
bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.md,bmad-bmm-validate-prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report",
|
bmm,2-planning,Edit PRD,EP,25,_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md,bmad-bmm-edit-prd,false,pm,Edit Mode,"Improve and enhance an existing PRD",planning_artifacts,"updated prd",
|
||||||
bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad-bmm-create-ux-design,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design",
|
bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad-bmm-create-ux-design,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design",
|
||||||
bmm,2-planning,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad-bmm-create-ux-design,false,ux-designer,Validate Mode,"Validates UX design deliverables",planning_artifacts,"ux validation report",
|
|
||||||
bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad-bmm-create-architecture,true,architect,Create Mode,"Guided Workflow to document technical decisions",planning_artifacts,architecture,
|
bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad-bmm-create-architecture,true,architect,Create Mode,"Guided Workflow to document technical decisions",planning_artifacts,architecture,
|
||||||
bmm,3-solutioning,Validate Architecture,VA,20,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad-bmm-create-architecture,false,architect,Validate Mode,"Validates architecture completeness",planning_artifacts,"architecture validation report",
|
|
||||||
bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad-bmm-create-epics-and-stories,true,pm,Create Mode,"Create the Epics and Stories Listing",planning_artifacts,"epics and stories",
|
bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad-bmm-create-epics-and-stories,true,pm,Create Mode,"Create the Epics and Stories Listing",planning_artifacts,"epics and stories",
|
||||||
bmm,3-solutioning,Validate Epics and Stories,VE,40,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad-bmm-create-epics-and-stories,false,pm,Validate Mode,"Validates epics and stories completeness",planning_artifacts,"epics validation report",
|
|
||||||
bmm,3-solutioning,Check Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad-bmm-check-implementation-readiness,true,architect,Validate Mode,"Ensure PRD UX Architecture and Epics Stories are aligned",planning_artifacts,"readiness report",
|
bmm,3-solutioning,Check Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad-bmm-check-implementation-readiness,true,architect,Validate Mode,"Ensure PRD UX Architecture and Epics Stories are aligned",planning_artifacts,"readiness report",
|
||||||
bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad-bmm-sprint-planning,true,sm,Create Mode,"Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.",implementation_artifacts,"sprint status",
|
bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad-bmm-sprint-planning,true,sm,Create Mode,"Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.",implementation_artifacts,"sprint status",
|
||||||
bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad-bmm-sprint-status,false,sm,Create Mode,"Anytime: Summarize sprint status and route to next workflow",,,
|
bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad-bmm-sprint-status,false,sm,Create Mode,"Anytime: Summarize sprint status and route to next workflow",,,
|
||||||
|
|
|
||||||
|
|
|
@ -128,7 +128,7 @@ Recap that the brief captures everything needed to guide subsequent product deve
|
||||||
|
|
||||||
### 5. Suggest next steps
|
### 5. Suggest next steps
|
||||||
|
|
||||||
Product Brief complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Validate PRD`.
|
Product Brief complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Validate PRD`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: create-product-brief
|
name: create-product-brief
|
||||||
description: Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
|
description: Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
|
||||||
web_bundle: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Product Brief Workflow
|
# Product Brief Workflow
|
||||||
|
|
|
||||||
|
|
@ -155,7 +155,7 @@ Show the generated architectural patterns and present continue option:
|
||||||
#### If 'C' (Continue):
|
#### If 'C' (Continue):
|
||||||
|
|
||||||
- Append the final content to the research document
|
- Append the final content to the research document
|
||||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||||
- Load: `./step-05-implementation-research.md`
|
- Load: `./step-05-implementation-research.md`
|
||||||
|
|
||||||
## APPEND TO DOCUMENT:
|
## APPEND TO DOCUMENT:
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# Technical Research Step 4: Implementation Research
|
# Technical Research Step 5: Implementation Research
|
||||||
|
|
||||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||||
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
- 🎯 Show web search analysis before presenting findings
|
- 🎯 Show web search analysis before presenting findings
|
||||||
- ⚠️ Present [C] complete option after implementation research content generation
|
- ⚠️ Present [C] complete option after implementation research content generation
|
||||||
- 💾 ONLY save when user chooses C (Complete)
|
- 💾 ONLY save when user chooses C (Complete)
|
||||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before completing workflow
|
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before completing workflow
|
||||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||||
|
|
||||||
## CONTEXT BOUNDARIES:
|
## CONTEXT BOUNDARIES:
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
- Current document and frontmatter from previous steps are available
|
- Current document and frontmatter from previous steps are available
|
||||||
- Focus on implementation approaches and technology adoption strategies
|
- Focus on implementation approaches and technology adoption strategies
|
||||||
- Web search capabilities with source verification are enabled
|
- Web search capabilities with source verification are enabled
|
||||||
- This is the final step in the technical research workflow
|
- This step prepares for the final synthesis step
|
||||||
|
|
||||||
## YOUR TASK:
|
## YOUR TASK:
|
||||||
|
|
||||||
|
|
@ -149,10 +149,10 @@ _Source: [URL]_
|
||||||
[Success measurement framework]
|
[Success measurement framework]
|
||||||
```
|
```
|
||||||
|
|
||||||
### 6. Present Analysis and Complete Option
|
### 6. Present Analysis and Continue Option
|
||||||
|
|
||||||
Show the generated implementation research and present complete option:
|
Show the generated implementation research and present continue option:
|
||||||
"I've completed the **implementation research and technology adoption** analysis, finalizing our comprehensive technical research.
|
"I've completed the **implementation research and technology adoption** analysis for {{research_topic}}.
|
||||||
|
|
||||||
**Implementation Highlights:**
|
**Implementation Highlights:**
|
||||||
|
|
||||||
|
|
@ -162,23 +162,24 @@ Show the generated implementation research and present complete option:
|
||||||
- Team organization and skill requirements identified
|
- Team organization and skill requirements identified
|
||||||
- Cost optimization and resource management strategies provided
|
- Cost optimization and resource management strategies provided
|
||||||
|
|
||||||
**This completes our technical research covering:**
|
**Technical research phases completed:**
|
||||||
|
|
||||||
- Technical overview and landscape analysis
|
- Step 1: Research scope confirmation
|
||||||
- Architectural patterns and design decisions
|
- Step 2: Technology stack analysis
|
||||||
- Implementation approaches and technology adoption
|
- Step 3: Integration patterns analysis
|
||||||
- Practical recommendations and implementation roadmap
|
- Step 4: Architectural patterns analysis
|
||||||
|
- Step 5: Implementation research (current step)
|
||||||
|
|
||||||
**Ready to complete the technical research report?**
|
**Ready to proceed to the final synthesis step?**
|
||||||
[C] Complete Research - Save final document and conclude
|
[C] Continue - Save this to document and proceed to synthesis
|
||||||
|
|
||||||
### 7. Handle Complete Selection
|
### 7. Handle Continue Selection
|
||||||
|
|
||||||
#### If 'C' (Complete Research):
|
#### If 'C' (Continue):
|
||||||
|
|
||||||
- Append the final content to the research document
|
- Append the final content to the research document
|
||||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||||
- Complete the technical research workflow
|
- Load: `./step-06-research-synthesis.md`
|
||||||
|
|
||||||
## APPEND TO DOCUMENT:
|
## APPEND TO DOCUMENT:
|
||||||
|
|
||||||
|
|
@ -191,9 +192,9 @@ When user selects 'C', append the content directly to the research document usin
|
||||||
✅ Testing and deployment practices clearly documented
|
✅ Testing and deployment practices clearly documented
|
||||||
✅ Team organization and skill requirements mapped
|
✅ Team organization and skill requirements mapped
|
||||||
✅ Cost optimization and risk mitigation strategies provided
|
✅ Cost optimization and risk mitigation strategies provided
|
||||||
✅ [C] complete option presented and handled correctly
|
✅ [C] continue option presented and handled correctly
|
||||||
✅ Content properly appended to document when C selected
|
✅ Content properly appended to document when C selected
|
||||||
✅ Technical research workflow completed successfully
|
✅ Proper routing to synthesis step (step-06)
|
||||||
|
|
||||||
## FAILURE MODES:
|
## FAILURE MODES:
|
||||||
|
|
||||||
|
|
@ -202,8 +203,9 @@ When user selects 'C', append the content directly to the research document usin
|
||||||
❌ Missing critical technology adoption strategies
|
❌ Missing critical technology adoption strategies
|
||||||
❌ Not providing practical implementation guidance
|
❌ Not providing practical implementation guidance
|
||||||
❌ Incomplete development workflows or operational practices analysis
|
❌ Incomplete development workflows or operational practices analysis
|
||||||
❌ Not presenting completion option for research workflow
|
❌ Not presenting continue option to synthesis step
|
||||||
❌ Appending content without user selecting 'C'
|
❌ Appending content without user selecting 'C'
|
||||||
|
❌ Not routing to step-06-research-synthesis.md
|
||||||
|
|
||||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||||
|
|
@ -221,19 +223,11 @@ When user selects 'C', append the content directly to the research document usin
|
||||||
|
|
||||||
When 'C' is selected:
|
When 'C' is selected:
|
||||||
|
|
||||||
- All technical research steps completed
|
- Implementation research step completed
|
||||||
- Comprehensive technical research document generated
|
- Content appended to research document with source citations
|
||||||
- All sections appended with source citations
|
- Frontmatter updated with stepsCompleted: [1, 2, 3, 4, 5]
|
||||||
- Technical research workflow status updated
|
- Ready to proceed to final synthesis step
|
||||||
- Final implementation recommendations provided to user
|
|
||||||
|
|
||||||
## NEXT STEPS:
|
## NEXT STEP:
|
||||||
|
|
||||||
Technical research workflow complete. User may:
|
After user selects 'C', load `./step-06-research-synthesis.md` to produce the comprehensive technical research document with narrative introduction, detailed TOC, and executive summary.
|
||||||
|
|
||||||
- Use technical research to inform architecture decisions
|
|
||||||
- Conduct additional research on specific technologies
|
|
||||||
- Combine technical research with other research types for comprehensive insights
|
|
||||||
- Move forward with implementation based on technical insights
|
|
||||||
|
|
||||||
Congratulations on completing comprehensive technical research! 🎉
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# Technical Research Step 5: Technical Synthesis and Completion
|
# Technical Research Step 6: Technical Synthesis and Completion
|
||||||
|
|
||||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||||
|
|
||||||
|
|
@ -18,7 +18,7 @@
|
||||||
- 🎯 Show web search analysis before presenting findings
|
- 🎯 Show web search analysis before presenting findings
|
||||||
- ⚠️ Present [C] complete option after synthesis content generation
|
- ⚠️ Present [C] complete option after synthesis content generation
|
||||||
- 💾 ONLY save when user chooses C (Complete)
|
- 💾 ONLY save when user chooses C (Complete)
|
||||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before completing workflow
|
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before completing workflow
|
||||||
- 🚫 FORBIDDEN to complete workflow until C is selected
|
- 🚫 FORBIDDEN to complete workflow until C is selected
|
||||||
- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
|
- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
|
||||||
|
|
||||||
|
|
@ -417,7 +417,7 @@ _This comprehensive technical research document serves as an authoritative techn
|
||||||
#### If 'C' (Complete Research):
|
#### If 'C' (Complete Research):
|
||||||
|
|
||||||
- Append the complete technical document to the research file
|
- Append the complete technical document to the research file
|
||||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||||
- Complete the technical research workflow
|
- Complete the technical research workflow
|
||||||
- Provide final technical document delivery confirmation
|
- Provide final technical document delivery confirmation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
---
|
||||||
|
name: domain-research
|
||||||
|
description: Conduct domain research covering industry analysis, regulations, technology trends, and ecosystem dynamics using current web data and verified sources.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Domain Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**Your Role:** You are a domain research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## CONFIGURATION
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as a system-generated value
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **domain/industry research**.
|
||||||
|
|
||||||
|
**What domain, industry, or sector do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'The healthcare technology industry'
|
||||||
|
- 'Sustainable packaging regulations in Europe'
|
||||||
|
- 'Construction and building materials sector'
|
||||||
|
- 'Or any other domain you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Domain**: "What specific aspect of [domain] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO DOMAIN RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "domain"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
4. Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
||||||
|
5. Load: `./domain-steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for domain research.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
---
|
||||||
|
name: market-research
|
||||||
|
description: Conduct market research covering market size, growth, competition, and customer insights using current web data and verified sources.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Market Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**Your Role:** You are a market research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## CONFIGURATION
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as a system-generated value
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **market research**.
|
||||||
|
|
||||||
|
**What topic, problem, or area do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'The electric vehicle market in Europe'
|
||||||
|
- 'Plant-based food alternatives market'
|
||||||
|
- 'Mobile payment solutions in Southeast Asia'
|
||||||
|
- 'Or anything else you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO MARKET RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "market"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
4. Create the starter output file: `{planning_artifacts}/research/market-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
||||||
|
5. Load: `./market-steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for market research.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
---
|
||||||
|
name: technical-research
|
||||||
|
description: Conduct technical research covering technology evaluation, architecture decisions, and implementation approaches using current web data and verified sources.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Technical Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**Your Role:** You are a technical research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## CONFIGURATION
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as a system-generated value
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **technical research**.
|
||||||
|
|
||||||
|
**What technology, tool, or technical area do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'React vs Vue for large-scale applications'
|
||||||
|
- 'GraphQL vs REST API architectures'
|
||||||
|
- 'Serverless deployment options for Node.js'
|
||||||
|
- 'Or any other technical topic you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Technology**: "What specific aspect of [technology] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO TECHNICAL RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "technical"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
4. Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
||||||
|
5. Load: `./technical-steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for technical research.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
@ -1,173 +0,0 @@
|
||||||
---
|
|
||||||
name: research
|
|
||||||
description: Conduct comprehensive research across multiple domains using current web data and verified sources - Market, Technical, Domain and other research types.
|
|
||||||
web_bundle: true
|
|
||||||
---
|
|
||||||
|
|
||||||
# Research Workflow
|
|
||||||
|
|
||||||
**Goal:** Conduct comprehensive, exhaustive research across multiple domains using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
||||||
|
|
||||||
**Document Standards:**
|
|
||||||
|
|
||||||
- **Comprehensive Coverage**: Exhaustive research with no critical gaps
|
|
||||||
- **Source Verification**: Every factual claim backed by web sources with URL citations
|
|
||||||
- **Document Length**: As long as needed to fully cover the research topic
|
|
||||||
- **Professional Structure**: Compelling narrative introduction, detailed TOC, and comprehensive summary
|
|
||||||
- **Authoritative Sources**: Multiple independent sources for all critical claims
|
|
||||||
|
|
||||||
**Your Role:** You are a research facilitator and web data analyst working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
|
||||||
|
|
||||||
**Final Deliverable**: A complete research document that serves as an authoritative reference on the research topic with:
|
|
||||||
|
|
||||||
- Compelling narrative introduction
|
|
||||||
- Comprehensive table of contents
|
|
||||||
- Detailed research sections with proper citations
|
|
||||||
- Executive summary and conclusions
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **micro-file architecture** with **routing-based discovery**:
|
|
||||||
|
|
||||||
- Each research type has its own step folder
|
|
||||||
- Step 01 discovers research type and routes to appropriate sub-workflow
|
|
||||||
- Sequential progression within each research type
|
|
||||||
- Document state tracked in output frontmatter
|
|
||||||
|
|
||||||
## INITIALIZATION
|
|
||||||
|
|
||||||
### Configuration Loading
|
|
||||||
|
|
||||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
||||||
|
|
||||||
- `project_name`, `output_folder`, , `planning_artifacts`, `user_name`
|
|
||||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
|
||||||
- `date` as a system-generated value
|
|
||||||
|
|
||||||
### Paths
|
|
||||||
|
|
||||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/1-analysis/research`
|
|
||||||
- `template_path` = `{installed_path}/research.template.md`
|
|
||||||
- `default_output_file` = `{planning_artifacts}/research/{{research_type}}-{{topic}}-research-{{date}}.md` (dynamic based on research type)
|
|
||||||
|
|
||||||
## PREREQUISITE
|
|
||||||
|
|
||||||
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
||||||
|
|
||||||
## RESEARCH BEHAVIOR
|
|
||||||
|
|
||||||
### Web Research Standards
|
|
||||||
|
|
||||||
- **Current Data Only**: Search the web to verify and supplement your knowledge with current facts
|
|
||||||
- **Source Verification**: Require citations for all factual claims
|
|
||||||
- **Anti-Hallucination Protocol**: Never present information without verified sources
|
|
||||||
- **Multiple Sources**: Require at least 2 independent sources for critical claims
|
|
||||||
- **Conflict Resolution**: Present conflicting views and note discrepancies
|
|
||||||
- **Confidence Levels**: Flag uncertain data with [High/Medium/Low Confidence]
|
|
||||||
|
|
||||||
### Source Quality Standards
|
|
||||||
|
|
||||||
- **Distinguish Clearly**: Facts (from sources) vs Analysis (interpretation) vs Speculation
|
|
||||||
- **URL Citation**: Always include source URLs when presenting web search data
|
|
||||||
- **Critical Claims**: Market size, growth rates, competitive data need verification
|
|
||||||
- **Fact Checking**: Apply fact-checking to critical data points
|
|
||||||
|
|
||||||
## Implementation Instructions
|
|
||||||
|
|
||||||
Execute research type discovery and routing:
|
|
||||||
|
|
||||||
### Research Type Discovery
|
|
||||||
|
|
||||||
**Your Role:** You are a research facilitator and web data analyst working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
|
||||||
|
|
||||||
**Research Standards:**
|
|
||||||
|
|
||||||
- **Anti-Hallucination Protocol**: Never present information without verified sources
|
|
||||||
- **Current Data Only**: Search the web to verify and supplement your knowledge with current facts
|
|
||||||
- **Source Citation**: Always include URLs for factual claims from web searches
|
|
||||||
- **Multiple Sources**: Require 2+ independent sources for critical claims
|
|
||||||
- **Conflict Resolution**: Present conflicting views and note discrepancies
|
|
||||||
- **Confidence Levels**: Flag uncertain data with [High/Medium/Low Confidence]
|
|
||||||
|
|
||||||
### Collaborative Research Discovery
|
|
||||||
|
|
||||||
"Welcome {{user_name}}! I'm excited to work with you as your research partner. I bring web research capabilities with rigorous source verification, while you bring the domain expertise and research direction.
|
|
||||||
|
|
||||||
**Let me help you clarify what you'd like to research.**
|
|
||||||
|
|
||||||
**First, tell me: What specific topic, problem, or area do you want to research?**
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
- 'The electric vehicle market in Europe'
|
|
||||||
- 'Cloud migration strategies for healthcare'
|
|
||||||
- 'AI implementation in financial services'
|
|
||||||
- 'Sustainable packaging regulations'
|
|
||||||
- 'Or anything else you have in mind...'
|
|
||||||
|
|
||||||
### Topic Exploration and Clarification
|
|
||||||
|
|
||||||
Based on the user's initial topic, explore and refine the research scope:
|
|
||||||
|
|
||||||
#### Topic Clarification Questions:
|
|
||||||
|
|
||||||
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
|
||||||
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
||||||
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
||||||
4. **Timeline**: "Are you looking at current state, historical context, or future trends?"
|
|
||||||
5. **Application**: "How will you use this research? (product development, strategy, academic, etc.)"
|
|
||||||
|
|
||||||
#### Context Building:
|
|
||||||
|
|
||||||
- **Initial Input**: User provides topic or research interest
|
|
||||||
- **Collaborative Refinement**: Work together to clarify scope and objectives
|
|
||||||
- **Goal Alignment**: Ensure research direction matches user needs
|
|
||||||
- **Research Boundaries**: Establish clear focus areas and deliverables
|
|
||||||
|
|
||||||
### Research Type Identification
|
|
||||||
|
|
||||||
After understanding the research topic and goals, identify the most appropriate research approach:
|
|
||||||
|
|
||||||
**Research Type Options:**
|
|
||||||
|
|
||||||
1. **Market Research** - Market size, growth, competition, customer insights
|
|
||||||
_Best for: Understanding market dynamics, customer behavior, competitive landscape_
|
|
||||||
|
|
||||||
2. **Domain Research** - Industry analysis, regulations, technology trends in specific domain
|
|
||||||
_Best for: Understanding industry context, regulatory environment, ecosystem_
|
|
||||||
|
|
||||||
3. **Technical Research** - Technology evaluation, architecture decisions, implementation approaches
|
|
||||||
_Best for: Technical feasibility, technology selection, implementation strategies_
|
|
||||||
|
|
||||||
**Recommendation**: Based on [topic] and [goals], I recommend [suggested research type] because [specific rationale].
|
|
||||||
|
|
||||||
**What type of research would work best for your needs?**
|
|
||||||
|
|
||||||
### Research Type Routing
|
|
||||||
|
|
||||||
<critical>Based on user selection, route to appropriate sub-workflow with the discovered topic using the following IF block sets of instructions. YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`</critical>
|
|
||||||
|
|
||||||
#### If Market Research:
|
|
||||||
|
|
||||||
- Set `research_type = "market"`
|
|
||||||
- Set `research_topic = [discovered topic from discussion]`
|
|
||||||
- Create the starter output file: `{planning_artifacts}/research/market-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
|
||||||
- Load: `./market-steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
#### If Domain Research:
|
|
||||||
|
|
||||||
- Set `research_type = "domain"`
|
|
||||||
- Set `research_topic = [discovered topic from discussion]`
|
|
||||||
- Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
|
||||||
- Load: `./domain-steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
#### If Technical Research:
|
|
||||||
|
|
||||||
- Set `research_type = "technical"`
|
|
||||||
- Set `research_topic = [discovered topic from discussion]`
|
|
||||||
- Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic}}-research-{{date}}.md` with exact copy of the ./research.template.md contents
|
|
||||||
- Load: `./technical-steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
**Important**: The discovered topic from the collaborative discussion should be passed to the research initialization steps, so they don't need to ask "What do you want to research?" again - they can focus on refining the scope for their specific research type.
|
|
||||||
|
|
||||||
**Note:** All research workflows require web search for current data and source verification.
|
|
||||||
|
|
@ -87,7 +87,7 @@ Offer validation workflows to ensure PRD is ready for implementation:
|
||||||
|
|
||||||
### 4. Suggest Next Workflows
|
### 4. Suggest Next Workflows
|
||||||
|
|
||||||
PRD complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create PRD`.
|
PRD complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create PRD`.
|
||||||
|
|
||||||
### 5. Final Completion Confirmation
|
### 5. Final Completion Confirmation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -197,7 +197,7 @@ Display:
|
||||||
- **IF X (Exit):**
|
- **IF X (Exit):**
|
||||||
- Display: "**Validation Report Saved:** {validationReportPath}"
|
- Display: "**Validation Report Saved:** {validationReportPath}"
|
||||||
- Display: "**Summary:** {overall status} - {recommendation}"
|
- Display: "**Summary:** {overall status} - {recommendation}"
|
||||||
- PRD Validation complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Validate PRD`.
|
- PRD Validation complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Validate PRD`.
|
||||||
|
|
||||||
- **IF Any other:** Help user, then redisplay menu
|
- **IF Any other:** Help user, then redisplay menu
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,433 +0,0 @@
|
||||||
---
|
|
||||||
validationTarget: 'PRD Workflow Structure'
|
|
||||||
validationDate: '2026-01-08'
|
|
||||||
inputDocuments: []
|
|
||||||
validationStepsCompleted: ['discovery', 'frontmatter-validation', 'content-validation', 'documentation-validation', 'integration-validation', 'corrections-applied']
|
|
||||||
validationStatus: COMPLETE - PRODUCTION READY
|
|
||||||
---
|
|
||||||
|
|
||||||
# PRD Workflow Validation Report
|
|
||||||
|
|
||||||
**Workflow Being Validated:** _bmad/bmm/workflows/2-plan-workflows/create-prd
|
|
||||||
**Validation Date:** 2026-01-08
|
|
||||||
**Validator:** BMAD Workflow Validation System
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Executive Summary
|
|
||||||
|
|
||||||
This validation report assesses the PRD workflow structure against BMAD workflow standards. The PRD workflow is a tri-modal workflow system with Create, Validate, and Edit phases.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. File Structure & Size Analysis
|
|
||||||
|
|
||||||
### Folder Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
prd/
|
|
||||||
├── workflow.md (main workflow file)
|
|
||||||
├── steps-c/ (Create steps - 12 files)
|
|
||||||
├── steps-v/ (Validation steps - 13 files)
|
|
||||||
├── steps-e/ (Edit steps - 5 files)
|
|
||||||
├── data/
|
|
||||||
│ └── prd-purpose.md
|
|
||||||
└── templates/
|
|
||||||
└── prd-template.md
|
|
||||||
```
|
|
||||||
|
|
||||||
**✅ Structure Status**: PASS - All required folders present
|
|
||||||
|
|
||||||
### File Size Analysis
|
|
||||||
|
|
||||||
#### Steps-C (Create Steps) - 12 files
|
|
||||||
| File | Lines | Status |
|
|
||||||
| ------------------------ | ----- | ------------------- |
|
|
||||||
| step-01-init.md | 191 | ⚠️ Approaching limit |
|
|
||||||
| step-01b-continue.md | 153 | ✅ Good |
|
|
||||||
| step-02-discovery.md | 197 | ⚠️ Approaching limit |
|
|
||||||
| step-03-success.md | 226 | ⚠️ Approaching limit |
|
|
||||||
| step-04-journeys.md | 213 | ⚠️ Approaching limit |
|
|
||||||
| step-05-domain.md | 193 | ⚠️ Approaching limit |
|
|
||||||
| step-06-innovation.md | 226 | ⚠️ Approaching limit |
|
|
||||||
| step-07-project-type.md | 225 | ⚠️ Approaching limit |
|
|
||||||
| step-08-scoping.md | 228 | ⚠️ Approaching limit |
|
|
||||||
| step-09-functional.md | 231 | ⚠️ Approaching limit |
|
|
||||||
| step-10-nonfunctional.md | 242 | ⚠️ Approaching limit |
|
|
||||||
| step-11-polish.md | 217 | ⚠️ Approaching limit |
|
|
||||||
| step-12-complete.md | 185 | ✅ Good |
|
|
||||||
|
|
||||||
#### Steps-V (Validation Steps) - 13 files
|
|
||||||
| File | Lines | Status |
|
|
||||||
| ---------------------------------------------- | ----- | ------------------- |
|
|
||||||
| step-v-01-discovery.md | 217 | ⚠️ Approaching limit |
|
|
||||||
| step-v-02-format-detection.md | 191 | ⚠️ Approaching limit |
|
|
||||||
| step-v-02b-parity-check.md | 209 | ⚠️ Approaching limit |
|
|
||||||
| step-v-03-density-validation.md | 174 | ✅ Good |
|
|
||||||
| step-v-04-brief-coverage-validation.md | 214 | ⚠️ Approaching limit |
|
|
||||||
| step-v-05-measurability-validation.md | 228 | ⚠️ Approaching limit |
|
|
||||||
| step-v-06-traceability-validation.md | 217 | ⚠️ Approaching limit |
|
|
||||||
| step-v-07-implementation-leakage-validation.md | 205 | ⚠️ Approaching limit |
|
|
||||||
| step-v-08-domain-compliance-validation.md | 243 | ⚠️ Approaching limit |
|
|
||||||
| step-v-09-project-type-validation.md | 263 | ❌ Exceeds limit |
|
|
||||||
| step-v-10-smart-validation.md | 209 | ⚠️ Approaching limit |
|
|
||||||
| step-v-11-holistic-quality-validation.md | 264 | ❌ Exceeds limit |
|
|
||||||
| step-v-12-completeness-validation.md | 242 | ⚠️ Approaching limit |
|
|
||||||
| step-v-13-report-complete.md | 231 | ⚠️ Approaching limit |
|
|
||||||
|
|
||||||
#### Steps-E (Edit Steps) - 5 files
|
|
||||||
| File | Lines | Status |
|
|
||||||
| ------------------------------- | ----- | ------------------- |
|
|
||||||
| step-e-01-discovery.md | 206 | ⚠️ Approaching limit |
|
|
||||||
| step-e-01b-legacy-conversion.md | 208 | ⚠️ Approaching limit |
|
|
||||||
| step-e-02-review.md | 249 | ⚠️ Approaching limit |
|
|
||||||
| step-e-03-edit.md | 253 | ❌ Exceeds limit |
|
|
||||||
| step-e-04-complete.md | 168 | ✅ Good |
|
|
||||||
|
|
||||||
#### Data & Templates
|
|
||||||
| File | Lines | Status |
|
|
||||||
| ------------------------- | ----- | ------------------- |
|
|
||||||
| data/prd-purpose.md | 197 | ⚠️ Approaching limit |
|
|
||||||
| templates/prd-template.md | 10 | ✅ Good |
|
|
||||||
| workflow.md | 114 | ✅ Good |
|
|
||||||
|
|
||||||
### File Size Statistics
|
|
||||||
|
|
||||||
- **Total Files**: 32 markdown files
|
|
||||||
- **✅ Good (<200 lines)**: 6 files (18.8%)
|
|
||||||
- **⚠️ Approaching limit (200-250)**: 23 files (71.9%)
|
|
||||||
- **❌ Exceeds limit (>250)**: 3 files (9.4%)
|
|
||||||
- **Average lines per file**: 213.3 lines
|
|
||||||
|
|
||||||
### ⚠️ Recommendations
|
|
||||||
|
|
||||||
1. **Files Exceeding 250-line limit**:
|
|
||||||
- `step-v-09-project-type-validation.md` (263 lines) - Consider splitting into sub-steps
|
|
||||||
- `step-v-11-holistic-quality-validation.md` (264 lines) - Consider splitting into sub-steps
|
|
||||||
- `step-e-03-edit.md` (253 lines) - Consider splitting into sub-steps
|
|
||||||
|
|
||||||
2. **Files Approaching Limit**:
|
|
||||||
- Many files are in the 200-250 line range
|
|
||||||
- Monitor these files as further additions may push them over the limit
|
|
||||||
- Consider proactive refactoring where appropriate
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Frontmatter Structure Validation
|
|
||||||
|
|
||||||
### Files Checked: 29 total files
|
|
||||||
|
|
||||||
**✅ Overall Status:** ALL VALID - One Issue Fixed
|
|
||||||
|
|
||||||
#### Main Workflow (workflow.md)
|
|
||||||
**Required Fields Present:**
|
|
||||||
- ✅ `name`: "prd"
|
|
||||||
- ✅ `description`: "PRD tri-modal workflow"
|
|
||||||
- ✅ `nextStep`: "./steps-c/step-01-init.md"
|
|
||||||
- ✅ `validateWorkflow`: "./steps-v/step-v-01-discovery.md"
|
|
||||||
- ✅ `editWorkflow`: "./steps-e/step-e-01-discovery.md" (FIXED - was assess-workflow.md)
|
|
||||||
|
|
||||||
#### Create Steps (steps-c)
|
|
||||||
- ✅ All 13 files have proper name, description, nextStepFile
|
|
||||||
- ✅ Proper sequencing from step-01 through step-12
|
|
||||||
- ✅ Consistent output file references
|
|
||||||
|
|
||||||
#### Validation Steps (steps-v)
|
|
||||||
- ✅ All 13 files have complete frontmatter
|
|
||||||
- ✅ Proper sequential chain maintained
|
|
||||||
- ✅ No broken internal references
|
|
||||||
|
|
||||||
#### Edit Steps (steps-e)
|
|
||||||
- ✅ All files have required fields
|
|
||||||
- ✅ Proper routing with altStepFile references
|
|
||||||
|
|
||||||
### ✅ All Issues Resolved
|
|
||||||
|
|
||||||
**1. Broken Edit Workflow Reference:**
|
|
||||||
```yaml
|
|
||||||
# Current (INCORRECT):
|
|
||||||
editWorkflow: './steps-e/step-e-01-assess-workflow.md'
|
|
||||||
|
|
||||||
# Should be:
|
|
||||||
editWorkflow: './steps-e/step-e-01-discovery.md'
|
|
||||||
```
|
|
||||||
|
|
||||||
**2. Step Numbering Gap:**
|
|
||||||
- Original `step-11-complete.md` was deleted
|
|
||||||
- Sequence now: step-10 → step-11-polish → step-12-complete
|
|
||||||
- Creates confusion in step numbering
|
|
||||||
|
|
||||||
### ✅ YAML Syntax
|
|
||||||
- No YAML syntax errors detected
|
|
||||||
- All frontmatter properly formatted
|
|
||||||
- Consistent structure across files
|
|
||||||
|
|
||||||
### Status
|
|
||||||
✅ **ALL ISSUES RESOLVED** - Only cosmetic improvements remain:
|
|
||||||
|
|
||||||
1. **✅ FIXED**: Edit workflow path corrected in workflow.md
|
|
||||||
2. **⚠️ OPTIONAL**: Address step numbering gap for clarity
|
|
||||||
3. **⚠️ OPTIONAL**: Rename step-01b-continue.md to step-01a-continue.md for consistency
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Step File Content Validation
|
|
||||||
|
|
||||||
### Content Quality Assessment: 4.5/5 - EXCELLENT
|
|
||||||
|
|
||||||
#### Files Reviewed: 10 representative files across all modes
|
|
||||||
|
|
||||||
#### ✅ Strengths
|
|
||||||
|
|
||||||
**1. Comprehensive Structure:**
|
|
||||||
- Clear step goal sections in all files
|
|
||||||
- Detailed mandatory execution rules
|
|
||||||
- Well-defined execution protocols
|
|
||||||
- Context boundaries clearly specified
|
|
||||||
- Mandatory sequence with numbered steps
|
|
||||||
- System success/failure metrics present
|
|
||||||
|
|
||||||
**2. BMAD Compliance:**
|
|
||||||
- ✅ JIT loading references consistently mentioned
|
|
||||||
- ✅ State tracking requirements documented
|
|
||||||
- ✅ Append-only building instructions present
|
|
||||||
- ✅ Critical rules properly emphasized with emojis
|
|
||||||
- ✅ Sequential enforcement clearly stated
|
|
||||||
|
|
||||||
**3. Instructional Quality:**
|
|
||||||
- Clear, unambiguous instructions
|
|
||||||
- Proper menu handling rules (where applicable)
|
|
||||||
- Excellent continuation checks
|
|
||||||
- Strong role definition for each mode
|
|
||||||
|
|
||||||
**4. Role Clarity:**
|
|
||||||
- Create Mode: "Product-focused PM facilitator"
|
|
||||||
- Validate Mode: "Validation Architect and Quality Assurance Specialist"
|
|
||||||
- Edit Mode: "PRD improvement specialist"
|
|
||||||
|
|
||||||
#### ⚠️ Minor Improvement Opportunities
|
|
||||||
|
|
||||||
**1. Header Formatting:**
|
|
||||||
- Some inconsistency in header level usage across files
|
|
||||||
- Recommend standardizing H2/H3 usage
|
|
||||||
|
|
||||||
**2. Edit Mode Completeness:**
|
|
||||||
- Edit mode has fewer steps (5 vs 12/13 for other modes)
|
|
||||||
- Documentation marks it as "Future" but implementation exists
|
|
||||||
|
|
||||||
#### Recommendations
|
|
||||||
1. **LOW PRIORITY**: Standardize header formatting across all step files
|
|
||||||
2. **LOW PRIORITY**: Complete remaining edit mode steps for parity
|
|
||||||
3. **MAINTAIN**: Current excellent quality standards
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. Documentation Validation
|
|
||||||
|
|
||||||
### Documentation Completeness: ✅ COMPREHENSIVE
|
|
||||||
|
|
||||||
#### Main Components Present
|
|
||||||
- ✅ Workflow Definition (workflow.md)
|
|
||||||
- ✅ Purpose Document (data/prd-purpose.md)
|
|
||||||
- ✅ Template (templates/prd-template.md)
|
|
||||||
- ✅ Three Mode Implementations (Create: 12, Validate: 13, Edit: 5 steps)
|
|
||||||
|
|
||||||
#### Clarity Assessment: ✅ EXCELLENT
|
|
||||||
|
|
||||||
**Strong Points:**
|
|
||||||
1. Clear mode determination (commands, flags, menu selection)
|
|
||||||
2. Detailed routing instructions for each mode
|
|
||||||
3. Comprehensive workflow architecture explanation
|
|
||||||
4. Well-defined critical rules with visual emphasis
|
|
||||||
5. Professional presentation with consistent formatting
|
|
||||||
|
|
||||||
#### ⚠️ Minor Issues Found
|
|
||||||
|
|
||||||
**1. Step Count Mismatch:**
|
|
||||||
- workflow.md mentions "11 steps" for Create mode
|
|
||||||
- Actually implements 12 steps
|
|
||||||
- Could confuse users
|
|
||||||
|
|
||||||
**2. Edit Mode Status:**
|
|
||||||
- workflow.md calls Edit mode "Future"
|
|
||||||
- Edit mode steps are actually implemented
|
|
||||||
- Should reflect current status
|
|
||||||
|
|
||||||
**3. Template Completeness:**
|
|
||||||
- PRD template is minimal (10 lines)
|
|
||||||
- Could benefit from section placeholders
|
|
||||||
|
|
||||||
**4. Missing README:**
|
|
||||||
- No onboarding documentation for new users
|
|
||||||
- Not critical but would be helpful
|
|
||||||
|
|
||||||
#### Recommendations
|
|
||||||
|
|
||||||
**HIGH PRIORITY:**
|
|
||||||
1. Fix step count reference to match implementation (12 steps)
|
|
||||||
2. Update edit mode documentation to "Implemented"
|
|
||||||
|
|
||||||
**MEDIUM PRIORITY:**
|
|
||||||
3. Enhance PRD template with section structure
|
|
||||||
4. Add quick-start README for new users
|
|
||||||
|
|
||||||
**LOW PRIORITY:**
|
|
||||||
5. Add troubleshooting section
|
|
||||||
6. Document external dependencies (domain-complexity.csv, project-types.csv)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 5. Integration & Compatibility Validation
|
|
||||||
|
|
||||||
### Integration Status: 85% Ready
|
|
||||||
|
|
||||||
#### ✅ Successfully Integrated Components
|
|
||||||
|
|
||||||
**1. Agent Menu Registration:**
|
|
||||||
- ✅ Registered in PM agent menu
|
|
||||||
- ✅ Trigger: `PR` or fuzzy match on `prd`
|
|
||||||
- ✅ Command: `/bmad:bmm:workflows:create-prd`
|
|
||||||
- ✅ Proper workflow path configuration
|
|
||||||
|
|
||||||
**2. External Workflow References:**
|
|
||||||
- ✅ Party-mode workflow: Exists at `{project-root}/_bmad/core/workflows/party-mode/workflow.md`
|
|
||||||
- ✅ Advanced-elicitation task: Exists at `{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml`
|
|
||||||
|
|
||||||
**3. Directory Structure:**
|
|
||||||
- ✅ Complete step architecture (all 3 modes)
|
|
||||||
- ✅ All referenced step files exist
|
|
||||||
- ✅ Data files available
|
|
||||||
|
|
||||||
#### ✅ Configuration & Installation - WORKING AS DESIGNED
|
|
||||||
|
|
||||||
**1. BMM Config Reference:**
|
|
||||||
- Path: `{project-root}/_bmad/bmm/config.yaml`
|
|
||||||
- **Status:** ✅ Correct installation-time placeholder
|
|
||||||
- Resolves to actual config during workflow installation
|
|
||||||
- **Note:** This is expected behavior, not an issue
|
|
||||||
|
|
||||||
**2. Planning Artifacts Folder:**
|
|
||||||
- Reference: `{planning_artifacts}/prd.md`
|
|
||||||
- **Status:** ✅ Correct installation-time placeholder
|
|
||||||
- Created/resolved during workflow installation
|
|
||||||
- **Note:** This is expected behavior, not an issue
|
|
||||||
|
|
||||||
**3. Edit Mode Implementation:**
|
|
||||||
- Current: 5 steps (Discovery, Legacy Conversion branch, Review, Edit, Complete)
|
|
||||||
- **Status:** ✅ Functionally complete
|
|
||||||
- Edit mode is inherently simpler than create mode (targeted improvements vs full creation)
|
|
||||||
- Uses subprocesses for complex operations
|
|
||||||
- Validation integration ensures quality
|
|
||||||
- **Note:** Edit workflow is complete and well-designed
|
|
||||||
|
|
||||||
#### Configuration Analysis
|
|
||||||
|
|
||||||
**Placeholder Usage:**
|
|
||||||
- `{project-root}`: ✅ Properly used
|
|
||||||
- `{planning_artifacts}`: ⚠️ Referenced but folder missing
|
|
||||||
- `{nextStep}`, `{validateWorkflow}`, etc: ✅ Properly resolved
|
|
||||||
|
|
||||||
#### Recommendations
|
|
||||||
|
|
||||||
**✅ ALL CRITICAL ISSUES RESOLVED:**
|
|
||||||
|
|
||||||
The only true critical issue (edit workflow path) has been fixed. All other items flagged as "critical" were actually working as designed (installation-time placeholders).
|
|
||||||
|
|
||||||
**LOW PRIORITY:**
|
|
||||||
3. Add CLI command registration for standalone execution (optional enhancement)
|
|
||||||
4. Consider adding workflow to additional agent menus (UX designer, architect)
|
|
||||||
5. Create standalone execution documentation (nice-to-have)
|
|
||||||
6. Address step numbering gap if desired (cosmetic)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Executive Summary & Overall Assessment
|
|
||||||
|
|
||||||
### Overall Validation Status: ✅ PRODUCTION-READY
|
|
||||||
|
|
||||||
#### Validation Scores by Category
|
|
||||||
|
|
||||||
| Category | Status | Score | Notes |
|
|
||||||
| -------------------------- | ----------- | ------ | --------------------------------------------- |
|
|
||||||
| **File Structure & Size** | ⚠️ WARNINGS | 7/10 | 3 files exceed 250-line limit, 23 approaching |
|
|
||||||
| **Frontmatter Validation** | ✅ PASS | 9/10 | One broken path reference |
|
|
||||||
| **Step Content Quality** | ✅ EXCELLENT | 9.5/10 | High-quality instructional design |
|
|
||||||
| **Documentation** | ✅ EXCELLENT | 9/10 | Comprehensive, minor inconsistencies |
|
|
||||||
| **Integration** | ✅ PASS | 9/10 | All paths correct (one issue fixed) |
|
|
||||||
| **BMAD Compliance** | ✅ EXCELLENT | 9.5/10 | Strong adherence to standards |
|
|
||||||
|
|
||||||
**Overall Score: 9.2/10 - EXCELLENT**
|
|
||||||
|
|
||||||
#### ✅ Critical Action Items - ALL RESOLVED
|
|
||||||
|
|
||||||
**ONLY ONE TRUE CRITICAL ISSUE EXISTED - NOW FIXED:**
|
|
||||||
|
|
||||||
1. **✅ FIXED: Edit Workflow Path**
|
|
||||||
- File: `workflow.md` ✓ RESOLVED
|
|
||||||
- Changed from: `./steps-e/step-e-01-assess-workflow.md`
|
|
||||||
- Changed to: `./steps-e/step-e-01-discovery.md`
|
|
||||||
|
|
||||||
**Items incorrectly flagged as critical (actually working as designed):**
|
|
||||||
- ✅ Configuration path references (installation-time placeholders)
|
|
||||||
- ✅ Planning artifacts folder (installation-time placeholder)
|
|
||||||
|
|
||||||
#### High Priority Improvements
|
|
||||||
|
|
||||||
2. **⚠️ Split Large Step Files** (>250 lines):
|
|
||||||
- `step-v-09-project-type-validation.md` (263 lines)
|
|
||||||
- `step-v-11-holistic-quality-validation.md` (264 lines)
|
|
||||||
- `step-e-03-edit.md` (253 lines)
|
|
||||||
|
|
||||||
3. **⚠️ Update Documentation Inconsistencies**:
|
|
||||||
- Fix step count reference (11 → 12 steps in create mode)
|
|
||||||
- Update edit mode status (Future → Implemented)
|
|
||||||
|
|
||||||
#### Medium Priority Enhancements
|
|
||||||
|
|
||||||
4. **Enhance PRD Template** (currently minimal at 10 lines)
|
|
||||||
5. **Add quick-start README** for new users
|
|
||||||
6. **Address step numbering gap** (cosmetic - missing step-11-complete.md)
|
|
||||||
|
|
||||||
#### Edit Mode Status - FUNCTIONALLY COMPLETE ✅
|
|
||||||
|
|
||||||
The edit workflow is **complete and well-designed** with 5 steps:
|
|
||||||
- Discovery → Legacy Conversion (branch) → Review → Edit → Complete
|
|
||||||
- Edit mode is inherently simpler than create mode (targeted improvements vs full creation)
|
|
||||||
- Uses subprocesses for complex operations
|
|
||||||
- Integrates with validation workflow
|
|
||||||
|
|
||||||
**No additional steps needed.**
|
|
||||||
|
|
||||||
### Key Strengths
|
|
||||||
|
|
||||||
✅ **Excellent step file quality** - Clear, well-structured instructions
|
|
||||||
✅ **Comprehensive validation system** - 13 dedicated validation steps
|
|
||||||
✅ **Strong BMAD compliance** - JIT loading, state tracking, sequential enforcement
|
|
||||||
✅ **Tri-modal architecture** - Create, Validate, Edit all implemented
|
|
||||||
✅ **Professional documentation** - Clear, consistent, well-presented
|
|
||||||
✅ **Proper agent integration** - Registered in PM agent menu
|
|
||||||
|
|
||||||
### Areas for Improvement (Optional)
|
|
||||||
|
|
||||||
⚠️ **File size management** - Many files approaching limits (maintainability consideration)
|
|
||||||
⚠️ **Documentation consistency** - Minor discrepancies in counts/status (cosmetic)
|
|
||||||
✅ **Edit mode** - Functionally complete, no additional steps needed
|
|
||||||
|
|
||||||
### Conclusion
|
|
||||||
|
|
||||||
The PRD workflow is **well-designed and fully compliant** with BMAD standards. The step file architecture is exemplary, the content quality is excellent, and the documentation is comprehensive. The only critical issue (edit workflow path) has been **resolved**, and all other flagged items were actually working as designed (installation-time placeholders).
|
|
||||||
|
|
||||||
**Current Status: ✅ PRODUCTION-READY**
|
|
||||||
|
|
||||||
**Recommended Optional Enhancements:**
|
|
||||||
1. Split the 3 files exceeding 250-line limit (maintainability)
|
|
||||||
2. Update documentation inconsistencies (step counts, edit mode status)
|
|
||||||
3. Enhance PRD template and add quick-start README (user experience)
|
|
||||||
|
|
||||||
The PRD workflow is ready for production use and fully compliant with BMAD workflow standards.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Validation Completed:** 2026-01-08
|
|
||||||
**Validation Method:** Systematic subprocess analysis with maximum context coverage
|
|
||||||
**Validator:** BMAD Workflow Validation System (Wendy - Workflow Building Master)
|
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
---
|
||||||
|
name: create-prd
|
||||||
|
description: Create a comprehensive PRD (Product Requirements Document) through structured workflow facilitation
|
||||||
|
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||||
|
nextStep: './steps-c/step-01-init.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# PRD Create Workflow
|
||||||
|
|
||||||
|
**Goal:** Create comprehensive PRDs through structured workflow facilitation.
|
||||||
|
|
||||||
|
**Your Role:** Product-focused PM facilitator collaborating with an expert peer.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## INITIALIZATION SEQUENCE
|
||||||
|
|
||||||
|
### 1. Configuration Loading
|
||||||
|
|
||||||
|
Load and read full config from {main_config} and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
|
||||||
|
### 2. Route to Create Workflow
|
||||||
|
|
||||||
|
"**Create Mode: Creating a new PRD from scratch.**"
|
||||||
|
|
||||||
|
Read fully and follow: `{nextStep}` (steps-c/step-01-init.md)
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
---
|
||||||
|
name: edit-prd
|
||||||
|
description: Edit and improve an existing PRD - enhance clarity, completeness, and quality
|
||||||
|
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||||
|
editWorkflow: './steps-e/step-e-01-discovery.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# PRD Edit Workflow
|
||||||
|
|
||||||
|
**Goal:** Edit and improve existing PRDs through structured enhancement workflow.
|
||||||
|
|
||||||
|
**Your Role:** PRD improvement specialist.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## INITIALIZATION SEQUENCE
|
||||||
|
|
||||||
|
### 1. Configuration Loading
|
||||||
|
|
||||||
|
Load and read full config from {main_config} and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
|
||||||
|
### 2. Route to Edit Workflow
|
||||||
|
|
||||||
|
"**Edit Mode: Improving an existing PRD.**"
|
||||||
|
|
||||||
|
Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
|
||||||
|
|
||||||
|
Then read fully and follow: `{editWorkflow}` (steps-e/step-e-01-discovery.md)
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
---
|
||||||
|
name: validate-prd
|
||||||
|
description: Validate an existing PRD against BMAD standards - comprehensive review for completeness, clarity, and quality
|
||||||
|
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||||
|
validateWorkflow: './steps-v/step-v-01-discovery.md'
|
||||||
|
---
|
||||||
|
|
||||||
|
# PRD Validate Workflow
|
||||||
|
|
||||||
|
**Goal:** Validate existing PRDs against BMAD standards through comprehensive review.
|
||||||
|
|
||||||
|
**Your Role:** Validation Architect and Quality Assurance Specialist.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## INITIALIZATION SEQUENCE
|
||||||
|
|
||||||
|
### 1. Configuration Loading
|
||||||
|
|
||||||
|
Load and read full config from {main_config} and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
|
||||||
|
### 2. Route to Validate Workflow
|
||||||
|
|
||||||
|
"**Validate Mode: Validating an existing PRD against BMAD standards.**"
|
||||||
|
|
||||||
|
Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file."
|
||||||
|
|
||||||
|
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
||||||
|
|
@ -1,150 +0,0 @@
|
||||||
---
|
|
||||||
name: create-prd
|
|
||||||
description: PRD tri-modal workflow - Create, Validate, or Edit comprehensive PRDs
|
|
||||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
|
||||||
nextStep: './steps-c/step-01-init.md'
|
|
||||||
validateWorkflow: './steps-v/step-v-01-discovery.md'
|
|
||||||
editWorkflow: './steps-e/step-e-01-discovery.md'
|
|
||||||
web_bundle: true
|
|
||||||
---
|
|
||||||
|
|
||||||
# PRD Workflow (Tri-Modal)
|
|
||||||
|
|
||||||
**Goal:** Create, Validate, or Edit comprehensive PRDs through structured workflows.
|
|
||||||
|
|
||||||
**Your Role:**
|
|
||||||
- **Create Mode:** Product-focused PM facilitator collaborating with an expert peer
|
|
||||||
- **Validate Mode:** Validation Architect and Quality Assurance Specialist
|
|
||||||
- **Edit Mode:** PRD improvement specialist
|
|
||||||
|
|
||||||
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## MODE DETERMINATION
|
|
||||||
|
|
||||||
### Detect Workflow Mode
|
|
||||||
|
|
||||||
Determine which mode to invoke based on:
|
|
||||||
|
|
||||||
1. **Command/Invocation:**
|
|
||||||
- "create prd" or "new prd" → Create mode
|
|
||||||
- "validate prd" or "check prd" → Validate mode
|
|
||||||
- "edit prd" or "improve prd" → Edit mode
|
|
||||||
|
|
||||||
2. **Context Detection:**
|
|
||||||
- If invoked with -c flag → Create mode
|
|
||||||
- If invoked with -v flag → Validate mode
|
|
||||||
- If invoked with -e flag → Edit mode
|
|
||||||
|
|
||||||
3. **Menu Selection (if unclear):**
|
|
||||||
|
|
||||||
If mode cannot be determined from invocation:
|
|
||||||
"**PRD Workflow - Select Mode:**
|
|
||||||
|
|
||||||
**[C] Create** - Create a new PRD from scratch
|
|
||||||
**[V] Validate** - Validate an existing PRD against BMAD standards
|
|
||||||
**[E] Edit** - Improve an existing PRD
|
|
||||||
|
|
||||||
Which mode would you like?"
|
|
||||||
|
|
||||||
Wait for user selection.
|
|
||||||
|
|
||||||
### Route to Appropriate Workflow
|
|
||||||
|
|
||||||
**IF Create Mode:**
|
|
||||||
"**Create Mode: Creating a new PRD from scratch.**"
|
|
||||||
Read fully and follow: `{nextStep}` (steps-c/step-01-init.md)
|
|
||||||
|
|
||||||
**IF Validate Mode:**
|
|
||||||
"**Validate Mode: Validating an existing PRD against BMAD standards.**"
|
|
||||||
Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file."
|
|
||||||
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
|
||||||
|
|
||||||
**IF Edit Mode:**
|
|
||||||
"**Edit Mode: Improving an existing PRD.**"
|
|
||||||
Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
|
|
||||||
Then read fully and follow: `{editWorkflow}` (steps-e/step-e-01-discovery.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **step-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
||||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## INITIALIZATION SEQUENCE
|
|
||||||
|
|
||||||
### 1. Mode Determination
|
|
||||||
|
|
||||||
**Check if mode was specified in the command invocation:**
|
|
||||||
|
|
||||||
- If user invoked with "create prd" or "new prd" or "build prd" or "-c" or "--create" → Set mode to **create**
|
|
||||||
- If user invoked with "validate prd" or "review prd" or "check prd" or "-v" or "--validate" → Set mode to **validate**
|
|
||||||
- If user invoked with "edit prd" or "modify prd" or "improve prd" or "-e" or "--edit" → Set mode to **edit**
|
|
||||||
|
|
||||||
**If mode is still unclear, ask user:**
|
|
||||||
|
|
||||||
"**PRD Workflow - Select Mode:**
|
|
||||||
|
|
||||||
**[C] Create** - Create a new PRD from scratch
|
|
||||||
**[V] Validate** - Validate an existing PRD against BMAD standards
|
|
||||||
**[E] Edit** - Improve an existing PRD
|
|
||||||
|
|
||||||
Which mode would you like?"
|
|
||||||
|
|
||||||
Wait for user selection.
|
|
||||||
|
|
||||||
### 2. Configuration Loading
|
|
||||||
|
|
||||||
Load and read full config from {main_config} and resolve:
|
|
||||||
|
|
||||||
- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
|
|
||||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
|
||||||
- `date` as system-generated current datetime
|
|
||||||
|
|
||||||
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
||||||
|
|
||||||
### 3. Route to Appropriate Workflow
|
|
||||||
|
|
||||||
**IF mode == create:**
|
|
||||||
"**Create Mode: Creating a new PRD from scratch.**"
|
|
||||||
Read fully and follow: `{nextStep}` (steps-c/step-01-init.md)
|
|
||||||
|
|
||||||
**IF mode == validate:**
|
|
||||||
"**Validate Mode: Validating an existing PRD against BMAD standards.**"
|
|
||||||
Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file."
|
|
||||||
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
|
||||||
|
|
||||||
**IF mode == edit:**
|
|
||||||
"**Edit Mode: Improving an existing PRD.**"
|
|
||||||
Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
|
|
||||||
Then read fully and follow: `{editWorkflow}` (steps-e/step-e-01-discovery.md)
|
|
||||||
|
|
@ -82,7 +82,7 @@ Update the main workflow status file:
|
||||||
|
|
||||||
### 3. Suggest Next Steps
|
### 3. Suggest Next Steps
|
||||||
|
|
||||||
UX Design complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create UX`.
|
UX Design complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create UX`.
|
||||||
|
|
||||||
### 5. Final Completion Confirmation
|
### 5. Final Completion Confirmation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: create-ux-design
|
name: create-ux-design
|
||||||
description: Work with a peer UX Design expert to plan your applications UX patterns, look and feel.
|
description: Work with a peer UX Design expert to plan your applications UX patterns, look and feel.
|
||||||
web_bundle: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Create UX Design Workflow
|
# Create UX Design Workflow
|
||||||
|
|
|
||||||
|
|
@ -2,15 +2,9 @@
|
||||||
name: 'step-01-document-discovery'
|
name: 'step-01-document-discovery'
|
||||||
description: 'Discover and inventory all project documents, handling duplicates and organizing file structure'
|
description: 'Discover and inventory all project documents, handling duplicates and organizing file structure'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-01-document-discovery.md'
|
|
||||||
nextStepFile: './step-02-prd-analysis.md'
|
nextStepFile: './step-02-prd-analysis.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
templateFile: '{workflow_path}/templates/readiness-report-template.md'
|
templateFile: '../templates/readiness-report-template.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
# Step 1: Document Discovery
|
# Step 1: Document Discovery
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,7 @@
|
||||||
name: 'step-02-prd-analysis'
|
name: 'step-02-prd-analysis'
|
||||||
description: 'Read and analyze PRD to extract all FRs and NFRs for coverage validation'
|
description: 'Read and analyze PRD to extract all FRs and NFRs for coverage validation'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-02-prd-analysis.md'
|
|
||||||
nextStepFile: './step-03-epic-coverage-validation.md'
|
nextStepFile: './step-03-epic-coverage-validation.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file
|
epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,7 @@
|
||||||
name: 'step-03-epic-coverage-validation'
|
name: 'step-03-epic-coverage-validation'
|
||||||
description: 'Validate that all PRD FRs are covered in epics and stories'
|
description: 'Validate that all PRD FRs are covered in epics and stories'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-03-epic-coverage-validation.md'
|
|
||||||
nextStepFile: './step-04-ux-alignment.md'
|
nextStepFile: './step-04-ux-alignment.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,7 @@
|
||||||
name: 'step-04-ux-alignment'
|
name: 'step-04-ux-alignment'
|
||||||
description: 'Check for UX document and validate alignment with PRD and Architecture'
|
description: 'Check for UX document and validate alignment with PRD and Architecture'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-04-ux-alignment.md'
|
|
||||||
nextStepFile: './step-05-epic-quality-review.md'
|
nextStepFile: './step-05-epic-quality-review.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,15 +2,8 @@
|
||||||
name: 'step-05-epic-quality-review'
|
name: 'step-05-epic-quality-review'
|
||||||
description: 'Validate epics and stories against create-epics-and-stories best practices'
|
description: 'Validate epics and stories against create-epics-and-stories best practices'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-05-epic-quality-review.md'
|
|
||||||
nextStepFile: './step-06-final-assessment.md'
|
nextStepFile: './step-06-final-assessment.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
epicsBestPractices: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories'
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Step 5: Epic Quality Review
|
# Step 5: Epic Quality Review
|
||||||
|
|
|
||||||
|
|
@ -2,12 +2,6 @@
|
||||||
name: 'step-06-final-assessment'
|
name: 'step-06-final-assessment'
|
||||||
description: 'Compile final assessment and polish the readiness report'
|
description: 'Compile final assessment and polish the readiness report'
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: './step-06-final-assessment.md'
|
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -115,7 +109,7 @@ The assessment found [number] issues requiring attention. Review the detailed re
|
||||||
|
|
||||||
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
|
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
|
||||||
|
|
||||||
Implementation Readiness complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `implementation readiness`.
|
Implementation Readiness complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `implementation readiness`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: check-implementation-readiness
|
name: check-implementation-readiness
|
||||||
description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.'
|
description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.'
|
||||||
web_bundle: false
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Implementation Readiness
|
# Implementation Readiness
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@ completedAt: '{{current_date}}'
|
||||||
|
|
||||||
### 3. Next Steps Guidance
|
### 3. Next Steps Guidance
|
||||||
|
|
||||||
Architecture complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create Architecture`.
|
Architecture complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create Architecture`.
|
||||||
|
|
||||||
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: create-architecture
|
name: create-architecture
|
||||||
description: Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.
|
description: Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.
|
||||||
web_bundle: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Architecture Workflow
|
# Architecture Workflow
|
||||||
|
|
|
||||||
|
|
@ -144,6 +144,6 @@ If all validations pass:
|
||||||
|
|
||||||
When C is selected, the workflow is complete and the epics.md is ready for development.
|
When C is selected, the workflow is complete and the epics.md is ready for development.
|
||||||
|
|
||||||
Epics and Stories complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create Epics and Stories`.
|
Epics and Stories complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create Epics and Stories`.
|
||||||
|
|
||||||
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: create-epics-and-stories
|
name: create-epics-and-stories
|
||||||
description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.'
|
description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.'
|
||||||
web_bundle: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Create Epics and Stories
|
# Create Epics and Stories
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,3 @@ input_file_patterns:
|
||||||
sharded_index: "{planning_artifacts}/*epic*/index.md"
|
sharded_index: "{planning_artifacts}/*epic*/index.md"
|
||||||
sharded_single: "{planning_artifacts}/*epic*/epic-{{epic_num}}.md"
|
sharded_single: "{planning_artifacts}/*epic*/epic-{{epic_num}}.md"
|
||||||
load_strategy: "SELECTIVE_LOAD"
|
load_strategy: "SELECTIVE_LOAD"
|
||||||
|
|
||||||
standalone: true
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,3 @@ instructions: "{installed_path}/instructions.md"
|
||||||
validation: "{installed_path}/checklist.md"
|
validation: "{installed_path}/checklist.md"
|
||||||
checklist: "{installed_path}/checklist.md"
|
checklist: "{installed_path}/checklist.md"
|
||||||
default_output_file: "{planning_artifacts}/sprint-change-proposal-{date}.md"
|
default_output_file: "{planning_artifacts}/sprint-change-proposal-{date}.md"
|
||||||
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -55,7 +55,3 @@ input_file_patterns:
|
||||||
whole: "{planning_artifacts}/*epic*.md"
|
whole: "{planning_artifacts}/*epic*.md"
|
||||||
sharded: "{planning_artifacts}/*epic*/*.md"
|
sharded: "{planning_artifacts}/*epic*/*.md"
|
||||||
load_strategy: "SELECTIVE_LOAD" # Only load needed epic
|
load_strategy: "SELECTIVE_LOAD" # Only load needed epic
|
||||||
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,3 @@ story_file: "" # Explicit story path; auto-discovered if empty
|
||||||
implementation_artifacts: "{config_source}:implementation_artifacts"
|
implementation_artifacts: "{config_source}:implementation_artifacts"
|
||||||
sprint_status: "{implementation_artifacts}/sprint-status.yaml"
|
sprint_status: "{implementation_artifacts}/sprint-status.yaml"
|
||||||
project_context: "**/project-context.md"
|
project_context: "**/project-context.md"
|
||||||
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -53,6 +53,3 @@ input_file_patterns:
|
||||||
sprint_status_file: "{implementation_artifacts}/sprint-status.yaml"
|
sprint_status_file: "{implementation_artifacts}/sprint-status.yaml"
|
||||||
story_directory: "{implementation_artifacts}"
|
story_directory: "{implementation_artifacts}"
|
||||||
retrospectives_folder: "{implementation_artifacts}"
|
retrospectives_folder: "{implementation_artifacts}"
|
||||||
|
|
||||||
standalone: true
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,3 @@ input_file_patterns:
|
||||||
|
|
||||||
# Output configuration
|
# Output configuration
|
||||||
default_output_file: "{status_file}"
|
default_output_file: "{status_file}"
|
||||||
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -28,9 +28,3 @@ input_file_patterns:
|
||||||
description: "Sprint status file generated by sprint-planning"
|
description: "Sprint status file generated by sprint-planning"
|
||||||
whole: "{implementation_artifacts}/sprint-status.yaml"
|
whole: "{implementation_artifacts}/sprint-status.yaml"
|
||||||
load_strategy: "FULL_LOAD"
|
load_strategy: "FULL_LOAD"
|
||||||
|
|
||||||
# Standalone so IDE commands get generated
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
# No web bundle needed
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,6 @@
|
||||||
name: 'step-01-mode-detection'
|
name: 'step-01-mode-detection'
|
||||||
description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables'
|
description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-01-mode-detection.md'
|
|
||||||
nextStepFile_modeA: './step-03-execute.md'
|
nextStepFile_modeA: './step-03-execute.md'
|
||||||
nextStepFile_modeB: './step-02-context-gathering.md'
|
nextStepFile_modeB: './step-02-context-gathering.md'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,6 @@
|
||||||
name: 'step-02-context-gathering'
|
name: 'step-02-context-gathering'
|
||||||
description: 'Quick context gathering for direct mode - identify files, patterns, dependencies'
|
description: 'Quick context gathering for direct mode - identify files, patterns, dependencies'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-02-context-gathering.md'
|
|
||||||
nextStepFile: './step-03-execute.md'
|
nextStepFile: './step-03-execute.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,6 @@
|
||||||
name: 'step-03-execute'
|
name: 'step-03-execute'
|
||||||
description: 'Execute implementation - iterate through tasks, write code, run tests'
|
description: 'Execute implementation - iterate through tasks, write code, run tests'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-03-execute.md'
|
|
||||||
nextStepFile: './step-04-self-check.md'
|
nextStepFile: './step-04-self-check.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,6 @@
|
||||||
name: 'step-04-self-check'
|
name: 'step-04-self-check'
|
||||||
description: 'Self-audit implementation against tasks, tests, AC, and patterns'
|
description: 'Self-audit implementation against tasks, tests, AC, and patterns'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-04-self-check.md'
|
|
||||||
nextStepFile: './step-05-adversarial-review.md'
|
nextStepFile: './step-05-adversarial-review.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,6 @@
|
||||||
name: 'step-05-adversarial-review'
|
name: 'step-05-adversarial-review'
|
||||||
description: 'Construct diff and invoke adversarial review task'
|
description: 'Construct diff and invoke adversarial review task'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-05-adversarial-review.md'
|
|
||||||
nextStepFile: './step-06-resolve-findings.md'
|
nextStepFile: './step-06-resolve-findings.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -59,7 +57,7 @@ Merge all changes into `{diff_output}`.
|
||||||
|
|
||||||
### 2. Invoke Adversarial Review
|
### 2. Invoke Adversarial Review
|
||||||
|
|
||||||
With `{diff_output}` constructed, invoke the review task. If possible, use information asymmetry: run this step, and only it, in a separate subagent or process with read access to the project, but no context except the `{diff_output}`.
|
With `{diff_output}` constructed, load and follow the review task. If possible, use information asymmetry: load this step, and only it, in a separate subagent or process with read access to the project, but no context except the `{diff_output}`.
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<invoke-task>Review {diff_output} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
|
<invoke-task>Review {diff_output} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,6 @@
|
||||||
---
|
---
|
||||||
name: 'step-06-resolve-findings'
|
name: 'step-06-resolve-findings'
|
||||||
description: 'Handle review findings interactively, apply fixes, update tech-spec with final status'
|
description: 'Handle review findings interactively, apply fixes, update tech-spec with final status'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
|
|
||||||
thisStepFile: './step-06-resolve-findings.md'
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Step 6: Resolve Findings
|
# Step 6: Resolve Findings
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,9 @@
|
||||||
name: 'step-01-understand'
|
name: 'step-01-understand'
|
||||||
description: 'Analyze the requirement delta between current state and what user wants to build'
|
description: 'Analyze the requirement delta between current state and what user wants to build'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
|
||||||
nextStepFile: './step-02-investigate.md'
|
nextStepFile: './step-02-investigate.md'
|
||||||
skipToStepFile: './step-03-generate.md'
|
skipToStepFile: './step-03-generate.md'
|
||||||
templateFile: '{workflow_path}/tech-spec-template.md'
|
templateFile: '../tech-spec-template.md'
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
name: 'step-02-investigate'
|
name: 'step-02-investigate'
|
||||||
description: 'Map technical constraints and anchor points within the codebase'
|
description: 'Map technical constraints and anchor points within the codebase'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
|
||||||
nextStepFile: './step-03-generate.md'
|
nextStepFile: './step-03-generate.md'
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
name: 'step-03-generate'
|
name: 'step-03-generate'
|
||||||
description: 'Build the implementation plan based on the technical mapping of constraints'
|
description: 'Build the implementation plan based on the technical mapping of constraints'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
|
||||||
nextStepFile: './step-04-review.md'
|
nextStepFile: './step-04-review.md'
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
name: 'step-04-review'
|
name: 'step-04-review'
|
||||||
description: 'Review and finalize the tech-spec'
|
description: 'Review and finalize the tech-spec'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -153,7 +152,7 @@ b) **HALT and wait for user selection.**
|
||||||
#### Adversarial Review [R] Process:
|
#### Adversarial Review [R] Process:
|
||||||
|
|
||||||
1. **Invoke Adversarial Review Task**:
|
1. **Invoke Adversarial Review Task**:
|
||||||
> With `{finalFile}` constructed, invoke the review task. If possible, use information asymmetry: run this task, and only it, in a separate subagent or process with read access to the project, but no context except the `{finalFile}`.
|
> With `{finalFile}` constructed, load and follow the review task. If possible, use information asymmetry: load this task, and only it, in a separate subagent or process with read access to the project, but no context except the `{finalFile}`.
|
||||||
<invoke-task>Review {finalFile} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
|
<invoke-task>Review {finalFile} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
|
||||||
> **Platform fallback:** If task invocation not available, load the task file and follow its instructions inline, passing `{finalFile}` as the content.
|
> **Platform fallback:** If task invocation not available, load the task file and follow its instructions inline, passing `{finalFile}` as the content.
|
||||||
> The task should: review `{finalFile}` and return a list of findings.
|
> The task should: review `{finalFile}` and return a list of findings.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
name: quick-spec
|
name: quick-spec
|
||||||
description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
|
description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
|
||||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||||
web_bundle: true
|
|
||||||
|
|
||||||
# Checkpoint handler paths
|
# Checkpoint handler paths
|
||||||
advanced_elicitation: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
advanced_elicitation: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||||
|
|
|
||||||
|
|
@ -20,11 +20,3 @@ validation: "{installed_path}/checklist.md"
|
||||||
|
|
||||||
# Required data files - CRITICAL for project type detection and documentation requirements
|
# Required data files - CRITICAL for project type detection and documentation requirements
|
||||||
documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"
|
documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"
|
||||||
|
|
||||||
# Output configuration - Multiple files generated in output folder
|
|
||||||
# Primary output: {output_folder}/project-documentation/
|
|
||||||
# Additional files generated by sub-workflows based on project structure
|
|
||||||
|
|
||||||
standalone: true
|
|
||||||
|
|
||||||
web_bundle: false
|
|
||||||
|
|
|
||||||
|
|
@ -1,90 +0,0 @@
|
||||||
{
|
|
||||||
"type": "excalidrawlib",
|
|
||||||
"version": 2,
|
|
||||||
"library": [
|
|
||||||
{
|
|
||||||
"id": "start-end-circle",
|
|
||||||
"status": "published",
|
|
||||||
"elements": [
|
|
||||||
{
|
|
||||||
"type": "ellipse",
|
|
||||||
"width": 120,
|
|
||||||
"height": 60,
|
|
||||||
"strokeColor": "#1976d2",
|
|
||||||
"backgroundColor": "#e3f2fd",
|
|
||||||
"fillStyle": "solid",
|
|
||||||
"strokeWidth": 2,
|
|
||||||
"roughness": 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "process-rectangle",
|
|
||||||
"status": "published",
|
|
||||||
"elements": [
|
|
||||||
{
|
|
||||||
"type": "rectangle",
|
|
||||||
"width": 160,
|
|
||||||
"height": 80,
|
|
||||||
"strokeColor": "#1976d2",
|
|
||||||
"backgroundColor": "#e3f2fd",
|
|
||||||
"fillStyle": "solid",
|
|
||||||
"strokeWidth": 2,
|
|
||||||
"roughness": 0,
|
|
||||||
"roundness": {
|
|
||||||
"type": 3,
|
|
||||||
"value": 8
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "decision-diamond",
|
|
||||||
"status": "published",
|
|
||||||
"elements": [
|
|
||||||
{
|
|
||||||
"type": "diamond",
|
|
||||||
"width": 140,
|
|
||||||
"height": 100,
|
|
||||||
"strokeColor": "#f57c00",
|
|
||||||
"backgroundColor": "#fff3e0",
|
|
||||||
"fillStyle": "solid",
|
|
||||||
"strokeWidth": 2,
|
|
||||||
"roughness": 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "data-store",
|
|
||||||
"status": "published",
|
|
||||||
"elements": [
|
|
||||||
{
|
|
||||||
"type": "rectangle",
|
|
||||||
"width": 140,
|
|
||||||
"height": 80,
|
|
||||||
"strokeColor": "#388e3c",
|
|
||||||
"backgroundColor": "#e8f5e9",
|
|
||||||
"fillStyle": "solid",
|
|
||||||
"strokeWidth": 2,
|
|
||||||
"roughness": 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "external-entity",
|
|
||||||
"status": "published",
|
|
||||||
"elements": [
|
|
||||||
{
|
|
||||||
"type": "rectangle",
|
|
||||||
"width": 120,
|
|
||||||
"height": 80,
|
|
||||||
"strokeColor": "#7b1fa2",
|
|
||||||
"backgroundColor": "#f3e5f5",
|
|
||||||
"fillStyle": "solid",
|
|
||||||
"strokeWidth": 3,
|
|
||||||
"roughness": 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
@ -1,127 +0,0 @@
|
||||||
flowchart:
|
|
||||||
viewport:
|
|
||||||
x: 0
|
|
||||||
y: 0
|
|
||||||
zoom: 1
|
|
||||||
grid:
|
|
||||||
size: 20
|
|
||||||
spacing:
|
|
||||||
vertical: 100
|
|
||||||
horizontal: 180
|
|
||||||
elements:
|
|
||||||
start:
|
|
||||||
type: ellipse
|
|
||||||
width: 120
|
|
||||||
height: 60
|
|
||||||
label: "Start"
|
|
||||||
process:
|
|
||||||
type: rectangle
|
|
||||||
width: 160
|
|
||||||
height: 80
|
|
||||||
roundness: 8
|
|
||||||
decision:
|
|
||||||
type: diamond
|
|
||||||
width: 140
|
|
||||||
height: 100
|
|
||||||
end:
|
|
||||||
type: ellipse
|
|
||||||
width: 120
|
|
||||||
height: 60
|
|
||||||
label: "End"
|
|
||||||
|
|
||||||
diagram:
|
|
||||||
viewport:
|
|
||||||
x: 0
|
|
||||||
y: 0
|
|
||||||
zoom: 1
|
|
||||||
grid:
|
|
||||||
size: 20
|
|
||||||
spacing:
|
|
||||||
vertical: 120
|
|
||||||
horizontal: 200
|
|
||||||
elements:
|
|
||||||
component:
|
|
||||||
type: rectangle
|
|
||||||
width: 180
|
|
||||||
height: 100
|
|
||||||
roundness: 8
|
|
||||||
database:
|
|
||||||
type: rectangle
|
|
||||||
width: 140
|
|
||||||
height: 80
|
|
||||||
service:
|
|
||||||
type: rectangle
|
|
||||||
width: 160
|
|
||||||
height: 90
|
|
||||||
roundness: 12
|
|
||||||
external:
|
|
||||||
type: rectangle
|
|
||||||
width: 140
|
|
||||||
height: 80
|
|
||||||
|
|
||||||
wireframe:
|
|
||||||
viewport:
|
|
||||||
x: 0
|
|
||||||
y: 0
|
|
||||||
zoom: 0.8
|
|
||||||
grid:
|
|
||||||
size: 20
|
|
||||||
spacing:
|
|
||||||
vertical: 40
|
|
||||||
horizontal: 40
|
|
||||||
elements:
|
|
||||||
container:
|
|
||||||
type: rectangle
|
|
||||||
width: 800
|
|
||||||
height: 600
|
|
||||||
strokeStyle: solid
|
|
||||||
strokeWidth: 2
|
|
||||||
header:
|
|
||||||
type: rectangle
|
|
||||||
width: 800
|
|
||||||
height: 80
|
|
||||||
button:
|
|
||||||
type: rectangle
|
|
||||||
width: 120
|
|
||||||
height: 40
|
|
||||||
roundness: 4
|
|
||||||
input:
|
|
||||||
type: rectangle
|
|
||||||
width: 300
|
|
||||||
height: 40
|
|
||||||
roundness: 4
|
|
||||||
text:
|
|
||||||
type: text
|
|
||||||
fontSize: 16
|
|
||||||
|
|
||||||
dataflow:
|
|
||||||
viewport:
|
|
||||||
x: 0
|
|
||||||
y: 0
|
|
||||||
zoom: 1
|
|
||||||
grid:
|
|
||||||
size: 20
|
|
||||||
spacing:
|
|
||||||
vertical: 120
|
|
||||||
horizontal: 200
|
|
||||||
elements:
|
|
||||||
process:
|
|
||||||
type: ellipse
|
|
||||||
width: 140
|
|
||||||
height: 80
|
|
||||||
label: "Process"
|
|
||||||
datastore:
|
|
||||||
type: rectangle
|
|
||||||
width: 140
|
|
||||||
height: 80
|
|
||||||
label: "Data Store"
|
|
||||||
external:
|
|
||||||
type: rectangle
|
|
||||||
width: 120
|
|
||||||
height: 80
|
|
||||||
strokeWidth: 3
|
|
||||||
label: "External Entity"
|
|
||||||
dataflow:
|
|
||||||
type: arrow
|
|
||||||
strokeWidth: 2
|
|
||||||
label: "Data Flow"
|
|
||||||
|
|
@ -1,39 +0,0 @@
|
||||||
# Create Data Flow Diagram - Validation Checklist
|
|
||||||
|
|
||||||
## DFD Notation
|
|
||||||
|
|
||||||
- [ ] Processes shown as circles/ellipses
|
|
||||||
- [ ] Data stores shown as parallel lines or rectangles
|
|
||||||
- [ ] External entities shown as rectangles
|
|
||||||
- [ ] Data flows shown as labeled arrows
|
|
||||||
- [ ] Follows standard DFD notation
|
|
||||||
|
|
||||||
## Structure
|
|
||||||
|
|
||||||
- [ ] All processes numbered correctly
|
|
||||||
- [ ] All data flows labeled with data names
|
|
||||||
- [ ] All data stores named appropriately
|
|
||||||
- [ ] External entities clearly identified
|
|
||||||
|
|
||||||
## Completeness
|
|
||||||
|
|
||||||
- [ ] All inputs and outputs accounted for
|
|
||||||
- [ ] No orphaned processes (unconnected)
|
|
||||||
- [ ] Data conservation maintained
|
|
||||||
- [ ] Level appropriate (context/level 0/level 1)
|
|
||||||
|
|
||||||
## Layout
|
|
||||||
|
|
||||||
- [ ] Logical flow direction (left to right, top to bottom)
|
|
||||||
- [ ] No crossing data flows where avoidable
|
|
||||||
- [ ] Balanced layout
|
|
||||||
- [ ] Grid alignment maintained
|
|
||||||
|
|
||||||
## Technical Quality
|
|
||||||
|
|
||||||
- [ ] All elements properly grouped
|
|
||||||
- [ ] Arrows have proper bindings
|
|
||||||
- [ ] Text readable and properly sized
|
|
||||||
- [ ] No elements with `isDeleted: true`
|
|
||||||
- [ ] JSON is valid
|
|
||||||
- [ ] File saved to correct location
|
|
||||||
|
|
@ -1,130 +0,0 @@
|
||||||
# Create Data Flow Diagram - Workflow Instructions
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
||||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
|
||||||
<critical>This workflow creates data flow diagrams (DFD) in Excalidraw format.</critical>
|
|
||||||
|
|
||||||
<workflow>
|
|
||||||
|
|
||||||
<step n="0" goal="Contextual Analysis">
|
|
||||||
<action>Review user's request and extract: DFD level, processes, data stores, external entities</action>
|
|
||||||
<check if="ALL requirements clear"><action>Skip to Step 4</action></check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="1" goal="Identify DFD Level" elicit="true">
|
|
||||||
<action>Ask: "What level of DFD do you need?"</action>
|
|
||||||
<action>Present options:
|
|
||||||
1. Context Diagram (Level 0) - Single process showing system boundaries
|
|
||||||
2. Level 1 DFD - Major processes and data flows
|
|
||||||
3. Level 2 DFD - Detailed sub-processes
|
|
||||||
4. Custom - Specify your requirements
|
|
||||||
</action>
|
|
||||||
<action>WAIT for selection</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="2" goal="Gather Requirements" elicit="true">
|
|
||||||
<action>Ask: "Describe the processes, data stores, and external entities in your system"</action>
|
|
||||||
<action>WAIT for user description</action>
|
|
||||||
<action>Summarize what will be included and confirm with user</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="3" goal="Theme Setup" elicit="true">
|
|
||||||
<action>Check for existing theme.json, ask to use if exists</action>
|
|
||||||
<check if="no existing theme">
|
|
||||||
<action>Ask: "Choose a DFD color scheme:"</action>
|
|
||||||
<action>Present numbered options:
|
|
||||||
1. Standard DFD
|
|
||||||
- Process: #e3f2fd (light blue)
|
|
||||||
- Data Store: #e8f5e9 (light green)
|
|
||||||
- External Entity: #f3e5f5 (light purple)
|
|
||||||
- Border: #1976d2 (blue)
|
|
||||||
|
|
||||||
2. Colorful DFD
|
|
||||||
- Process: #fff9c4 (light yellow)
|
|
||||||
- Data Store: #c5e1a5 (light lime)
|
|
||||||
- External Entity: #ffccbc (light coral)
|
|
||||||
- Border: #f57c00 (orange)
|
|
||||||
|
|
||||||
3. Minimal DFD
|
|
||||||
- Process: #f5f5f5 (light gray)
|
|
||||||
- Data Store: #eeeeee (gray)
|
|
||||||
- External Entity: #e0e0e0 (medium gray)
|
|
||||||
- Border: #616161 (dark gray)
|
|
||||||
|
|
||||||
4. Custom - Define your own colors
|
|
||||||
</action>
|
|
||||||
<action>WAIT for selection</action>
|
|
||||||
<action>Create theme.json based on selection</action>
|
|
||||||
</check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="4" goal="Plan DFD Structure">
|
|
||||||
<action>List all processes with numbers (1.0, 2.0, etc.)</action>
|
|
||||||
<action>List all data stores (D1, D2, etc.)</action>
|
|
||||||
<action>List all external entities</action>
|
|
||||||
<action>Map all data flows with labels</action>
|
|
||||||
<action>Show planned structure, confirm with user</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="5" goal="Load Resources">
|
|
||||||
<action>Load {{templates}} and extract `dataflow` section</action>
|
|
||||||
<action>Load {{library}}</action>
|
|
||||||
<action>Load theme.json</action>
|
|
||||||
<action>Load {{helpers}}</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="6" goal="Build DFD Elements">
|
|
||||||
<critical>Follow standard DFD notation from {{helpers}}</critical>
|
|
||||||
|
|
||||||
<substep>Build Order:
|
|
||||||
1. External entities (rectangles, bold border)
|
|
||||||
2. Processes (circles/ellipses with numbers)
|
|
||||||
3. Data stores (parallel lines or rectangles)
|
|
||||||
4. Data flows (labeled arrows)
|
|
||||||
</substep>
|
|
||||||
|
|
||||||
<substep>DFD Rules:
|
|
||||||
- Processes: Numbered (1.0, 2.0), verb phrases
|
|
||||||
- Data stores: Named (D1, D2), noun phrases
|
|
||||||
- External entities: Named, noun phrases
|
|
||||||
- Data flows: Labeled with data names, arrows show direction
|
|
||||||
- No direct flow between external entities
|
|
||||||
- No direct flow between data stores
|
|
||||||
</substep>
|
|
||||||
|
|
||||||
<substep>Layout:
|
|
||||||
- External entities at edges
|
|
||||||
- Processes in center
|
|
||||||
- Data stores between processes
|
|
||||||
- Minimize crossing flows
|
|
||||||
- Left-to-right or top-to-bottom flow
|
|
||||||
</substep>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="7" goal="Optimize and Save">
|
|
||||||
<action>Verify DFD rules compliance</action>
|
|
||||||
<action>Strip unused elements and elements with isDeleted: true</action>
|
|
||||||
<action>Save to {{default_output_file}}</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="8" goal="Validate JSON Syntax">
|
|
||||||
<critical>NEVER delete the file if validation fails - always fix syntax errors</critical>
|
|
||||||
<action>Run: node -e "JSON.parse(require('fs').readFileSync('{{default_output_file}}', 'utf8')); console.log('✓ Valid JSON')"</action>
|
|
||||||
<check if="validation fails (exit code 1)">
|
|
||||||
<action>Read the error message carefully - it shows the syntax error and position</action>
|
|
||||||
<action>Open the file and navigate to the error location</action>
|
|
||||||
<action>Fix the syntax error (add missing comma, bracket, or quote as indicated)</action>
|
|
||||||
<action>Save the file</action>
|
|
||||||
<action>Re-run validation with the same command</action>
|
|
||||||
<action>Repeat until validation passes</action>
|
|
||||||
</check>
|
|
||||||
<action>Once validation passes, confirm with user</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="9" goal="Validate Content">
|
|
||||||
<invoke-task>Validate against {{validation}}</invoke-task>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
</workflow>
|
|
||||||
```
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
name: create-excalidraw-dataflow
|
|
||||||
description: "Create data flow diagrams (DFD) in Excalidraw format"
|
|
||||||
author: "BMad"
|
|
||||||
|
|
||||||
# Config values
|
|
||||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
|
||||||
output_folder: "{config_source}:output_folder"
|
|
||||||
|
|
||||||
# Workflow components
|
|
||||||
installed_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow"
|
|
||||||
shared_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/_shared"
|
|
||||||
instructions: "{installed_path}/instructions.md"
|
|
||||||
validation: "{installed_path}/checklist.md"
|
|
||||||
|
|
||||||
# Core Excalidraw resources (universal knowledge)
|
|
||||||
helpers: "{project-root}/_bmad/core/resources/excalidraw/excalidraw-helpers.md"
|
|
||||||
json_validation: "{project-root}/_bmad/core/resources/excalidraw/validate-json-instructions.md"
|
|
||||||
|
|
||||||
# Domain-specific resources (technical diagrams)
|
|
||||||
templates: "{shared_path}/excalidraw-templates.yaml"
|
|
||||||
library: "{shared_path}/excalidraw-library.json"
|
|
||||||
|
|
||||||
# Output file (respects user's configured output_folder)
|
|
||||||
default_output_file: "{output_folder}/excalidraw-diagrams/dataflow-{timestamp}.excalidraw"
|
|
||||||
|
|
||||||
standalone: true
|
|
||||||
web_bundle: false
|
|
||||||
|
|
@ -1,43 +0,0 @@
|
||||||
# Create Diagram - Validation Checklist
|
|
||||||
|
|
||||||
## Element Structure
|
|
||||||
|
|
||||||
- [ ] All components with labels have matching `groupIds`
|
|
||||||
- [ ] All text elements have `containerId` pointing to parent component
|
|
||||||
- [ ] Text width calculated properly (no cutoff)
|
|
||||||
- [ ] Text alignment appropriate for diagram type
|
|
||||||
|
|
||||||
## Layout and Alignment
|
|
||||||
|
|
||||||
- [ ] All elements snapped to 20px grid
|
|
||||||
- [ ] Component spacing consistent (40px/60px)
|
|
||||||
- [ ] Hierarchical alignment maintained
|
|
||||||
- [ ] No overlapping elements
|
|
||||||
|
|
||||||
## Connections
|
|
||||||
|
|
||||||
- [ ] All arrows have `startBinding` and `endBinding`
|
|
||||||
- [ ] `boundElements` array updated on connected components
|
|
||||||
- [ ] Arrow routing avoids overlaps
|
|
||||||
- [ ] Relationship types clearly indicated
|
|
||||||
|
|
||||||
## Notation and Standards
|
|
||||||
|
|
||||||
- [ ] Follows specified notation standard (UML/ERD/etc)
|
|
||||||
- [ ] Symbols used correctly
|
|
||||||
- [ ] Cardinality/multiplicity shown where needed
|
|
||||||
- [ ] Labels and annotations clear
|
|
||||||
|
|
||||||
## Theme and Styling
|
|
||||||
|
|
||||||
- [ ] Theme colors applied consistently
|
|
||||||
- [ ] Component types visually distinguishable
|
|
||||||
- [ ] Text is readable
|
|
||||||
- [ ] Professional appearance
|
|
||||||
|
|
||||||
## Output Quality
|
|
||||||
|
|
||||||
- [ ] Element count under 80
|
|
||||||
- [ ] No elements with `isDeleted: true`
|
|
||||||
- [ ] JSON is valid
|
|
||||||
- [ ] File saved to correct location
|
|
||||||
|
|
@ -1,141 +0,0 @@
|
||||||
# Create Diagram - Workflow Instructions
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
||||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
|
||||||
<critical>This workflow creates system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format.</critical>
|
|
||||||
|
|
||||||
<workflow>
|
|
||||||
|
|
||||||
<step n="0" goal="Contextual Analysis">
|
|
||||||
<action>Review user's request and extract: diagram type, components/entities, relationships, notation preferences</action>
|
|
||||||
<check if="ALL requirements clear"><action>Skip to Step 5</action></check>
|
|
||||||
<check if="SOME requirements clear"><action>Only ask about missing info in Steps 1-2</action></check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="1" goal="Identify Diagram Type" elicit="true">
|
|
||||||
<action>Ask: "What type of technical diagram do you need?"</action>
|
|
||||||
<action>Present options:
|
|
||||||
1. System Architecture
|
|
||||||
2. Entity-Relationship Diagram (ERD)
|
|
||||||
3. UML Class Diagram
|
|
||||||
4. UML Sequence Diagram
|
|
||||||
5. UML Use Case Diagram
|
|
||||||
6. Network Diagram
|
|
||||||
7. Other
|
|
||||||
</action>
|
|
||||||
<action>WAIT for selection</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="2" goal="Gather Requirements" elicit="true">
|
|
||||||
<action>Ask: "Describe the components/entities and their relationships"</action>
|
|
||||||
<action>Ask: "What notation standard? (Standard/Simplified/Strict UML-ERD)"</action>
|
|
||||||
<action>WAIT for user input</action>
|
|
||||||
<action>Summarize what will be included and confirm with user</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="3" goal="Check for Existing Theme" elicit="true">
|
|
||||||
<action>Check if theme.json exists at output location</action>
|
|
||||||
<check if="exists"><action>Ask to use it, load if yes, else proceed to Step 4</action></check>
|
|
||||||
<check if="not exists"><action>Proceed to Step 4</action></check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="4" goal="Create Theme" elicit="true">
|
|
||||||
<action>Ask: "Choose a color scheme for your diagram:"</action>
|
|
||||||
<action>Present numbered options:
|
|
||||||
1. Professional
|
|
||||||
- Component: #e3f2fd (light blue)
|
|
||||||
- Database: #e8f5e9 (light green)
|
|
||||||
- Service: #fff3e0 (light orange)
|
|
||||||
- Border: #1976d2 (blue)
|
|
||||||
|
|
||||||
2. Colorful
|
|
||||||
- Component: #e1bee7 (light purple)
|
|
||||||
- Database: #c5e1a5 (light lime)
|
|
||||||
- Service: #ffccbc (light coral)
|
|
||||||
- Border: #7b1fa2 (purple)
|
|
||||||
|
|
||||||
3. Minimal
|
|
||||||
- Component: #f5f5f5 (light gray)
|
|
||||||
- Database: #eeeeee (gray)
|
|
||||||
- Service: #e0e0e0 (medium gray)
|
|
||||||
- Border: #616161 (dark gray)
|
|
||||||
|
|
||||||
4. Custom - Define your own colors
|
|
||||||
</action>
|
|
||||||
<action>WAIT for selection</action>
|
|
||||||
<action>Create theme.json based on selection</action>
|
|
||||||
<action>Show preview and confirm</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="5" goal="Plan Diagram Structure">
|
|
||||||
<action>List all components/entities</action>
|
|
||||||
<action>Map all relationships</action>
|
|
||||||
<action>Show planned layout</action>
|
|
||||||
<action>Ask: "Structure looks correct? (yes/no)"</action>
|
|
||||||
<check if="no"><action>Adjust and repeat</action></check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="6" goal="Load Resources">
|
|
||||||
<action>Load {{templates}} and extract `diagram` section</action>
|
|
||||||
<action>Load {{library}}</action>
|
|
||||||
<action>Load theme.json and merge with template</action>
|
|
||||||
<action>Load {{helpers}} for guidelines</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="7" goal="Build Diagram Elements">
|
|
||||||
<critical>Follow {{helpers}} for proper element creation</critical>
|
|
||||||
|
|
||||||
<substep>For Each Component:
|
|
||||||
- Generate unique IDs (component-id, text-id, group-id)
|
|
||||||
- Create shape with groupIds
|
|
||||||
- Calculate text width
|
|
||||||
- Create text with containerId and matching groupIds
|
|
||||||
- Add boundElements
|
|
||||||
</substep>
|
|
||||||
|
|
||||||
<substep>For Each Connection:
|
|
||||||
- Determine arrow type (straight/elbow)
|
|
||||||
- Create with startBinding and endBinding
|
|
||||||
- Update boundElements on both components
|
|
||||||
</substep>
|
|
||||||
|
|
||||||
<substep>Build Order by Type:
|
|
||||||
- Architecture: Services → Databases → Connections → Labels
|
|
||||||
- ERD: Entities → Attributes → Relationships → Cardinality
|
|
||||||
- UML Class: Classes → Attributes → Methods → Relationships
|
|
||||||
- UML Sequence: Actors → Lifelines → Messages → Returns
|
|
||||||
- UML Use Case: Actors → Use Cases → Relationships
|
|
||||||
</substep>
|
|
||||||
|
|
||||||
<substep>Alignment:
|
|
||||||
- Snap to 20px grid
|
|
||||||
- Space: 40px between components, 60px between sections
|
|
||||||
</substep>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="8" goal="Optimize and Save">
|
|
||||||
<action>Strip unused elements and elements with isDeleted: true</action>
|
|
||||||
<action>Save to {{default_output_file}}</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="9" goal="Validate JSON Syntax">
|
|
||||||
<critical>NEVER delete the file if validation fails - always fix syntax errors</critical>
|
|
||||||
<action>Run: node -e "JSON.parse(require('fs').readFileSync('{{default_output_file}}', 'utf8')); console.log('✓ Valid JSON')"</action>
|
|
||||||
<check if="validation fails (exit code 1)">
|
|
||||||
<action>Read the error message carefully - it shows the syntax error and position</action>
|
|
||||||
<action>Open the file and navigate to the error location</action>
|
|
||||||
<action>Fix the syntax error (add missing comma, bracket, or quote as indicated)</action>
|
|
||||||
<action>Save the file</action>
|
|
||||||
<action>Re-run validation with the same command</action>
|
|
||||||
<action>Repeat until validation passes</action>
|
|
||||||
</check>
|
|
||||||
<action>Once validation passes, confirm: "Diagram created at {{default_output_file}}. Open to view?"</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="10" goal="Validate Content">
|
|
||||||
<invoke-task>Validate against {{validation}} using {_bmad}/core/tasks/validate-workflow.xml</invoke-task>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
</workflow>
|
|
||||||
```
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue