bmad-method 4.27.5 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.bmad-core/agent-teams/team-all.yml +16 -0
- package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
- package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
- package/{bmad-core → .bmad-core}/agents/analyst.md +23 -30
- package/.bmad-core/agents/architect.md +66 -0
- package/.bmad-core/agents/bmad-master.md +104 -0
- package/.bmad-core/agents/bmad-orchestrator.md +81 -0
- package/.bmad-core/agents/dev.md +70 -0
- package/{bmad-core → .bmad-core}/agents/pm.md +24 -25
- package/{bmad-core → .bmad-core}/agents/po.md +24 -28
- package/.bmad-core/agents/qa.md +52 -0
- package/.bmad-core/agents/sm.md +55 -0
- package/.bmad-core/agents/ux-expert.md +66 -0
- package/{bmad-core → .bmad-core}/checklists/change-checklist.md +2 -2
- package/{bmad-core → .bmad-core}/checklists/story-draft-checklist.md +1 -1
- package/.bmad-core/data/bmad-kb.md +47 -0
- package/.bmad-core/schemas/agent-team-schema.yml +153 -0
- package/.bmad-core/tasks/advanced-elicitation.md +92 -0
- package/.bmad-core/tasks/brainstorming-techniques.md +238 -0
- package/.bmad-core/tasks/core-dump.md +74 -0
- package/{expansion-packs/bmad-creator-tools → .bmad-core}/tasks/create-agent.md +11 -9
- package/.bmad-core/tasks/create-doc.md +74 -0
- package/.bmad-core/tasks/create-expansion-pack.md +425 -0
- package/.bmad-core/tasks/create-next-story.md +206 -0
- package/.bmad-core/tasks/create-team.md +229 -0
- package/{bmad-core → .bmad-core}/tasks/doc-migration-task.md +9 -9
- package/{common → .bmad-core}/tasks/execute-checklist.md +6 -2
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
- package/{bmad-core → .bmad-core}/tasks/index-docs.md +7 -3
- package/{bmad-core → .bmad-core}/tasks/shard-doc.md +7 -25
- package/.bmad-core/templates/agent-tmpl.md +58 -0
- package/.bmad-core/templates/architecture-tmpl.md +771 -0
- package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
- package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
- package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
- package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
- package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
- package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
- package/.bmad-core/templates/fullstack-architecture-tmpl.md +1016 -0
- package/.bmad-core/templates/market-research-tmpl.md +261 -0
- package/.bmad-core/templates/prd-tmpl.md +200 -0
- package/.bmad-core/templates/project-brief-tmpl.md +228 -0
- package/.bmad-core/templates/simple-project-prd-tmpl.md +461 -0
- package/.bmad-core/templates/story-tmpl.md +61 -0
- package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
- package/.bmad-core/utils/agent-switcher.ide.md +112 -0
- package/.bmad-core/utils/template-format.md +26 -0
- package/.bmad-core/utils/workflow-management.md +224 -0
- package/.bmad-core/web-bundles/agents/analyst.txt +1684 -0
- package/.bmad-core/web-bundles/agents/architect.txt +3584 -0
- package/.bmad-core/web-bundles/agents/bmad-master.txt +9491 -0
- package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1466 -0
- package/{dist → .bmad-core/web-bundles}/agents/dev.txt +71 -179
- package/{dist → .bmad-core/web-bundles}/agents/pm.txt +1058 -624
- package/{dist → .bmad-core/web-bundles}/agents/po.txt +138 -337
- package/.bmad-core/web-bundles/agents/qa.txt +129 -0
- package/.bmad-core/web-bundles/agents/sm.txt +658 -0
- package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
- package/.bmad-core/web-bundles/teams/team-all.txt +10757 -0
- package/.bmad-core/web-bundles/teams/team-fullstack.txt +10109 -0
- package/.bmad-core/web-bundles/teams/team-no-ui.txt +8950 -0
- package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
- package/.bmad-core/workflows/brownfield-service.yml +117 -0
- package/.bmad-core/workflows/brownfield-ui.yml +127 -0
- package/{bmad-core/workflows/greenfield-fullstack.yaml → .bmad-core/workflows/greenfield-fullstack.yml} +77 -140
- package/.bmad-core/workflows/greenfield-service.yml +143 -0
- package/.bmad-core/workflows/greenfield-ui.yml +172 -0
- package/.claude/commands/analyst.md +63 -0
- package/.claude/commands/architect.md +70 -0
- package/.claude/commands/bmad-master.md +108 -0
- package/.claude/commands/bmad-orchestrator.md +85 -0
- package/.claude/commands/dev.md +74 -0
- package/.claude/commands/pm.md +63 -0
- package/.claude/commands/po.md +64 -0
- package/.claude/commands/qa.md +56 -0
- package/.claude/commands/sm.md +59 -0
- package/.claude/commands/ux-expert.md +70 -0
- package/.cursor/rules/analyst.mdc +77 -0
- package/.cursor/rules/architect.mdc +84 -0
- package/.cursor/rules/bmad-master.mdc +122 -0
- package/.cursor/rules/bmad-orchestrator.mdc +99 -0
- package/.cursor/rules/dev.mdc +88 -0
- package/.cursor/rules/pm.mdc +77 -0
- package/.cursor/rules/po.mdc +78 -0
- package/.cursor/rules/qa.mdc +70 -0
- package/.cursor/rules/sm.mdc +73 -0
- package/.cursor/rules/ux-expert.mdc +84 -0
- package/.roo/.roomodes +95 -0
- package/.roo/README.md +38 -0
- package/.vscode/extensions.json +6 -0
- package/.vscode/settings.json +75 -49
- package/.windsurf/rules/analyst.md +71 -0
- package/.windsurf/rules/architect.md +78 -0
- package/.windsurf/rules/bmad-master.md +116 -0
- package/.windsurf/rules/bmad-orchestrator.md +93 -0
- package/.windsurf/rules/dev.md +82 -0
- package/.windsurf/rules/pm.md +71 -0
- package/.windsurf/rules/po.md +72 -0
- package/.windsurf/rules/qa.md +64 -0
- package/.windsurf/rules/sm.md +67 -0
- package/.windsurf/rules/ux-expert.md +78 -0
- package/CHANGELOG.md +16 -452
- package/CONTRIBUTING.md +5 -168
- package/LICENSE +1 -1
- package/README.md +230 -77
- package/docs/bmad-workflow-guide.md +15 -19
- package/docs/claude-code-guide.md +119 -0
- package/docs/cursor-guide.md +127 -0
- package/docs/roo-code-guide.md +140 -0
- package/docs/sample-output/simple-fullstack-greenfield/prd.md +42 -0
- package/docs/versioning-and-releases.md +16 -8
- package/docs/versions.md +5 -4
- package/docs/windsurf-guide.md +127 -0
- package/expansion-packs/README.md +112 -2
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/README.md +9 -9
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/agents/infra-devops-platform.md +15 -15
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/checklists/infrastructure-checklist.md +1 -1
- package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/review-infrastructure.md +4 -4
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/validate-infrastructure.md +4 -4
- package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
- package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/package.json +11 -19
- package/tools/bmad-npx-wrapper.js +1 -1
- package/tools/builders/web-builder.js +28 -563
- package/tools/cli.js +22 -55
- package/tools/installer/README.md +53 -3
- package/tools/installer/bin/bmad.js +56 -294
- package/tools/installer/config/install.config.yml +139 -0
- package/tools/installer/lib/config-loader.js +34 -198
- package/tools/installer/lib/file-manager.js +5 -123
- package/tools/installer/lib/ide-setup.js +189 -545
- package/tools/installer/lib/installer.js +55 -1136
- package/tools/installer/package-lock.json +3 -3
- package/tools/installer/package.json +4 -4
- package/tools/installer/templates/claude-commands.md +7 -0
- package/tools/installer/templates/cursor-rules.md +22 -0
- package/tools/installer/templates/windsurf-rules.md +22 -0
- package/tools/lib/dependency-resolver.js +22 -22
- package/tools/upgraders/v3-to-v4-upgrader.js +43 -35
- package/tools/version-bump.js +1 -1
- package/tools/yaml-format.js +2 -2
- package/.github/FUNDING.yaml +0 -15
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -32
- package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
- package/.prettierignore +0 -21
- package/.prettierrc +0 -23
- package/bmad-core/agent-teams/team-all.yaml +0 -14
- package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
- package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
- package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
- package/bmad-core/agents/architect.md +0 -63
- package/bmad-core/agents/bmad-master.md +0 -110
- package/bmad-core/agents/bmad-orchestrator.md +0 -140
- package/bmad-core/agents/dev.md +0 -57
- package/bmad-core/agents/qa.md +0 -55
- package/bmad-core/agents/sm.md +0 -46
- package/bmad-core/agents/ux-expert.md +0 -54
- package/bmad-core/core-config.yaml +0 -25
- package/bmad-core/data/bmad-kb.md +0 -803
- package/bmad-core/data/brainstorming-techniques.md +0 -36
- package/bmad-core/data/elicitation-methods.md +0 -134
- package/bmad-core/tasks/advanced-elicitation.md +0 -117
- package/bmad-core/tasks/create-brownfield-story.md +0 -355
- package/bmad-core/tasks/create-next-story.md +0 -114
- package/bmad-core/tasks/create-workflow-plan.md +0 -289
- package/bmad-core/tasks/document-project.md +0 -317
- package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
- package/bmad-core/tasks/kb-mode-interaction.md +0 -70
- package/bmad-core/tasks/review-story.md +0 -145
- package/bmad-core/tasks/update-workflow-plan.md +0 -248
- package/bmad-core/tasks/validate-next-story.md +0 -134
- package/bmad-core/templates/architecture-tmpl.yaml +0 -650
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -293
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -206
- package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -805
- package/bmad-core/templates/market-research-tmpl.yaml +0 -252
- package/bmad-core/templates/prd-tmpl.yaml +0 -202
- package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
- package/bmad-core/templates/story-tmpl.yaml +0 -137
- package/bmad-core/utils/plan-management.md +0 -219
- package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
- package/bmad-core/workflows/brownfield-service.yaml +0 -187
- package/bmad-core/workflows/brownfield-ui.yaml +0 -197
- package/bmad-core/workflows/greenfield-service.yaml +0 -206
- package/bmad-core/workflows/greenfield-ui.yaml +0 -235
- package/common/tasks/create-doc.md +0 -79
- package/common/utils/bmad-doc-template.md +0 -325
- package/common/utils/workflow-management.md +0 -69
- package/dist/agents/analyst.txt +0 -2849
- package/dist/agents/architect.txt +0 -3505
- package/dist/agents/bmad-master.txt +0 -9588
- package/dist/agents/bmad-orchestrator.txt +0 -2232
- package/dist/agents/qa.txt +0 -388
- package/dist/agents/sm.txt +0 -673
- package/dist/agents/ux-expert.txt +0 -987
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2401
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1635
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -825
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -11730
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +0 -2023
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2052
- package/dist/teams/team-all.txt +0 -11799
- package/dist/teams/team-fullstack.txt +0 -11129
- package/dist/teams/team-ide-minimal.txt +0 -4573
- package/dist/teams/team-no-ui.txt +0 -9684
- package/docs/GUIDING-PRINCIPLES.md +0 -91
- package/docs/agentic-tools/claude-code-guide.md +0 -19
- package/docs/agentic-tools/cline-guide.md +0 -16
- package/docs/agentic-tools/cursor-guide.md +0 -14
- package/docs/agentic-tools/gemini-cli-guide.md +0 -32
- package/docs/agentic-tools/github-copilot-guide.md +0 -42
- package/docs/agentic-tools/roo-code-guide.md +0 -15
- package/docs/agentic-tools/trae-guide.md +0 -14
- package/docs/agentic-tools/windsurf-guide.md +0 -14
- package/docs/core-architecture.md +0 -219
- package/docs/expansion-packs.md +0 -280
- package/docs/how-to-contribute-with-pull-requests.md +0 -158
- package/docs/template-markup-references.md +0 -86
- package/docs/user-guide.md +0 -1142
- package/docs/working-in-the-brownfield.md +0 -361
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -60
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -68
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -53
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -7
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -254
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -651
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -111
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -308
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
- package/expansion-packs/bmad-creator-tools/README.md +0 -8
- package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +0 -55
- package/expansion-packs/bmad-creator-tools/config.yaml +0 -5
- package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +0 -1020
- package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +0 -178
- package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +0 -154
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +0 -120
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -8
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -308
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
- package/tools/bump-all-versions.js +0 -107
- package/tools/bump-core-version.js +0 -57
- package/tools/bump-expansion-version.js +0 -78
- package/tools/installer/config/ide-agent-config.yaml +0 -58
- package/tools/installer/config/install.config.yaml +0 -91
- package/tools/lib/yaml-utils.js +0 -29
- package/tools/md-assets/web-agent-startup-instructions.md +0 -39
- package/tools/update-expansion-version.js +0 -54
- /package/{bmad-core → .bmad-core}/checklists/architect-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/pm-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/po-master-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/story-dod-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/data/technical-preferences.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/brownfield-create-epic.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/brownfield-create-story.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/correct-course.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/create-deep-research-prompt.md +0 -0
- /package/.github/workflows/{release.yaml → release.yml} +0 -0
|
@@ -1,235 +0,0 @@
|
|
|
1
|
-
workflow:
|
|
2
|
-
id: greenfield-ui
|
|
3
|
-
name: Greenfield UI/Frontend Development
|
|
4
|
-
description: >-
|
|
5
|
-
Agent workflow for building frontend applications from concept to development.
|
|
6
|
-
Supports both comprehensive planning for complex UIs and rapid prototyping for simple interfaces.
|
|
7
|
-
type: greenfield
|
|
8
|
-
project_types:
|
|
9
|
-
- spa
|
|
10
|
-
- mobile-app
|
|
11
|
-
- micro-frontend
|
|
12
|
-
- static-site
|
|
13
|
-
- ui-prototype
|
|
14
|
-
- simple-interface
|
|
15
|
-
|
|
16
|
-
sequence:
|
|
17
|
-
- agent: analyst
|
|
18
|
-
creates: project-brief.md
|
|
19
|
-
optional_steps:
|
|
20
|
-
- brainstorming_session
|
|
21
|
-
- market_research_prompt
|
|
22
|
-
notes: "Can do brainstorming first, then optional deep research before creating project brief. SAVE OUTPUT: Copy final project-brief.md to your project's docs/ folder."
|
|
23
|
-
|
|
24
|
-
- agent: pm
|
|
25
|
-
creates: prd.md
|
|
26
|
-
requires: project-brief.md
|
|
27
|
-
notes: "Creates PRD from project brief using prd-tmpl, focused on UI/frontend requirements. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
|
28
|
-
|
|
29
|
-
- agent: ux-expert
|
|
30
|
-
creates: front-end-spec.md
|
|
31
|
-
requires: prd.md
|
|
32
|
-
optional_steps:
|
|
33
|
-
- user_research_prompt
|
|
34
|
-
notes: "Creates UI/UX specification using front-end-spec-tmpl. SAVE OUTPUT: Copy final front-end-spec.md to your project's docs/ folder."
|
|
35
|
-
|
|
36
|
-
- agent: ux-expert
|
|
37
|
-
creates: v0_prompt (optional)
|
|
38
|
-
requires: front-end-spec.md
|
|
39
|
-
condition: user_wants_ai_generation
|
|
40
|
-
notes: "OPTIONAL BUT RECOMMENDED: Generate AI UI prompt for tools like v0, Lovable, etc. Use the generate-ai-frontend-prompt task. User can then generate UI in external tool and download project structure."
|
|
41
|
-
|
|
42
|
-
- agent: architect
|
|
43
|
-
creates: front-end-architecture.md
|
|
44
|
-
requires: front-end-spec.md
|
|
45
|
-
optional_steps:
|
|
46
|
-
- technical_research_prompt
|
|
47
|
-
- review_generated_ui_structure
|
|
48
|
-
notes: "Creates frontend architecture using front-end-architecture-tmpl. If user generated UI with v0/Lovable, can incorporate the project structure into architecture. May suggest changes to PRD stories or new stories. SAVE OUTPUT: Copy final front-end-architecture.md to your project's docs/ folder."
|
|
49
|
-
|
|
50
|
-
- agent: pm
|
|
51
|
-
updates: prd.md (if needed)
|
|
52
|
-
requires: front-end-architecture.md
|
|
53
|
-
condition: architecture_suggests_prd_changes
|
|
54
|
-
notes: "If architect suggests story changes, update PRD and re-export the complete unredacted prd.md to docs/ folder."
|
|
55
|
-
|
|
56
|
-
- agent: po
|
|
57
|
-
validates: all_artifacts
|
|
58
|
-
uses: po-master-checklist
|
|
59
|
-
notes: "Validates all documents for consistency and completeness. May require updates to any document."
|
|
60
|
-
|
|
61
|
-
- agent: various
|
|
62
|
-
updates: any_flagged_documents
|
|
63
|
-
condition: po_checklist_issues
|
|
64
|
-
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
|
65
|
-
|
|
66
|
-
- project_setup_guidance:
|
|
67
|
-
action: guide_project_structure
|
|
68
|
-
condition: user_has_generated_ui
|
|
69
|
-
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo. For monorepo, place in apps/web or frontend/ directory. Review architecture document for specific guidance."
|
|
70
|
-
|
|
71
|
-
- agent: po
|
|
72
|
-
action: shard_documents
|
|
73
|
-
creates: sharded_docs
|
|
74
|
-
requires: all_artifacts_in_project
|
|
75
|
-
notes: |
|
|
76
|
-
Shard documents for IDE development:
|
|
77
|
-
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
78
|
-
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
79
|
-
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
80
|
-
|
|
81
|
-
- agent: sm
|
|
82
|
-
action: create_story
|
|
83
|
-
creates: story.md
|
|
84
|
-
requires: sharded_docs
|
|
85
|
-
repeats: for_each_epic
|
|
86
|
-
notes: |
|
|
87
|
-
Story creation cycle:
|
|
88
|
-
- SM Agent (New Chat): @sm → *create
|
|
89
|
-
- Creates next story from sharded docs
|
|
90
|
-
- Story starts in "Draft" status
|
|
91
|
-
|
|
92
|
-
- agent: analyst/pm
|
|
93
|
-
action: review_draft_story
|
|
94
|
-
updates: story.md
|
|
95
|
-
requires: story.md
|
|
96
|
-
optional: true
|
|
97
|
-
condition: user_wants_story_review
|
|
98
|
-
notes: |
|
|
99
|
-
OPTIONAL: Review and approve draft story
|
|
100
|
-
- NOTE: story-review task coming soon
|
|
101
|
-
- Review story completeness and alignment
|
|
102
|
-
- Update story status: Draft → Approved
|
|
103
|
-
|
|
104
|
-
- agent: dev
|
|
105
|
-
action: implement_story
|
|
106
|
-
creates: implementation_files
|
|
107
|
-
requires: story.md
|
|
108
|
-
notes: |
|
|
109
|
-
Dev Agent (New Chat): @dev
|
|
110
|
-
- Implements approved story
|
|
111
|
-
- Updates File List with all changes
|
|
112
|
-
- Marks story as "Review" when complete
|
|
113
|
-
|
|
114
|
-
- agent: qa
|
|
115
|
-
action: review_implementation
|
|
116
|
-
updates: implementation_files
|
|
117
|
-
requires: implementation_files
|
|
118
|
-
optional: true
|
|
119
|
-
notes: |
|
|
120
|
-
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
|
121
|
-
- Senior dev review with refactoring ability
|
|
122
|
-
- Fixes small issues directly
|
|
123
|
-
- Leaves checklist for remaining items
|
|
124
|
-
- Updates story status (Review → Done or stays Review)
|
|
125
|
-
|
|
126
|
-
- agent: dev
|
|
127
|
-
action: address_qa_feedback
|
|
128
|
-
updates: implementation_files
|
|
129
|
-
condition: qa_left_unchecked_items
|
|
130
|
-
notes: |
|
|
131
|
-
If QA left unchecked items:
|
|
132
|
-
- Dev Agent (New Chat): Address remaining items
|
|
133
|
-
- Return to QA for final approval
|
|
134
|
-
|
|
135
|
-
- repeat_development_cycle:
|
|
136
|
-
action: continue_for_all_stories
|
|
137
|
-
notes: |
|
|
138
|
-
Repeat story cycle (SM → Dev → QA) for all epic stories
|
|
139
|
-
Continue until all stories in PRD are complete
|
|
140
|
-
|
|
141
|
-
- agent: po
|
|
142
|
-
action: epic_retrospective
|
|
143
|
-
creates: epic-retrospective.md
|
|
144
|
-
condition: epic_complete
|
|
145
|
-
optional: true
|
|
146
|
-
notes: |
|
|
147
|
-
OPTIONAL: After epic completion
|
|
148
|
-
- NOTE: epic-retrospective task coming soon
|
|
149
|
-
- Validate epic was completed correctly
|
|
150
|
-
- Document learnings and improvements
|
|
151
|
-
|
|
152
|
-
- workflow_end:
|
|
153
|
-
action: project_complete
|
|
154
|
-
notes: |
|
|
155
|
-
All stories implemented and reviewed!
|
|
156
|
-
Project development phase complete.
|
|
157
|
-
|
|
158
|
-
Reference: data#bmad-kb:IDE Development Workflow
|
|
159
|
-
|
|
160
|
-
flow_diagram: |
|
|
161
|
-
```mermaid
|
|
162
|
-
graph TD
|
|
163
|
-
A[Start: UI Development] --> B[analyst: project-brief.md]
|
|
164
|
-
B --> C[pm: prd.md]
|
|
165
|
-
C --> D[ux-expert: front-end-spec.md]
|
|
166
|
-
D --> D2{Generate v0 prompt?}
|
|
167
|
-
D2 -->|Yes| D3[ux-expert: create v0 prompt]
|
|
168
|
-
D2 -->|No| E[architect: front-end-architecture.md]
|
|
169
|
-
D3 --> D4[User: generate UI in v0/Lovable]
|
|
170
|
-
D4 --> E
|
|
171
|
-
E --> F{Architecture suggests PRD changes?}
|
|
172
|
-
F -->|Yes| G[pm: update prd.md]
|
|
173
|
-
F -->|No| H[po: validate all artifacts]
|
|
174
|
-
G --> H
|
|
175
|
-
H --> I{PO finds issues?}
|
|
176
|
-
I -->|Yes| J[Return to relevant agent for fixes]
|
|
177
|
-
I -->|No| K[po: shard documents]
|
|
178
|
-
J --> H
|
|
179
|
-
|
|
180
|
-
K --> L[sm: create story]
|
|
181
|
-
L --> M{Review draft story?}
|
|
182
|
-
M -->|Yes| N[analyst/pm: review & approve story]
|
|
183
|
-
M -->|No| O[dev: implement story]
|
|
184
|
-
N --> O
|
|
185
|
-
O --> P{QA review?}
|
|
186
|
-
P -->|Yes| Q[qa: review implementation]
|
|
187
|
-
P -->|No| R{More stories?}
|
|
188
|
-
Q --> S{QA found issues?}
|
|
189
|
-
S -->|Yes| T[dev: address QA feedback]
|
|
190
|
-
S -->|No| R
|
|
191
|
-
T --> Q
|
|
192
|
-
R -->|Yes| L
|
|
193
|
-
R -->|No| U{Epic retrospective?}
|
|
194
|
-
U -->|Yes| V[po: epic retrospective]
|
|
195
|
-
U -->|No| W[Project Complete]
|
|
196
|
-
V --> W
|
|
197
|
-
|
|
198
|
-
B -.-> B1[Optional: brainstorming]
|
|
199
|
-
B -.-> B2[Optional: market research]
|
|
200
|
-
D -.-> D1[Optional: user research]
|
|
201
|
-
E -.-> E1[Optional: technical research]
|
|
202
|
-
|
|
203
|
-
style W fill:#90EE90
|
|
204
|
-
style K fill:#ADD8E6
|
|
205
|
-
style L fill:#ADD8E6
|
|
206
|
-
style O fill:#ADD8E6
|
|
207
|
-
style D3 fill:#E6E6FA
|
|
208
|
-
style D4 fill:#E6E6FA
|
|
209
|
-
style B fill:#FFE4B5
|
|
210
|
-
style C fill:#FFE4B5
|
|
211
|
-
style D fill:#FFE4B5
|
|
212
|
-
style E fill:#FFE4B5
|
|
213
|
-
style N fill:#F0E68C
|
|
214
|
-
style Q fill:#F0E68C
|
|
215
|
-
style V fill:#F0E68C
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
decision_guidance:
|
|
219
|
-
when_to_use:
|
|
220
|
-
- Building production frontend applications
|
|
221
|
-
- Multiple views/pages with complex interactions
|
|
222
|
-
- Need comprehensive UI/UX design and testing
|
|
223
|
-
- Multiple team members will be involved
|
|
224
|
-
- Long-term maintenance expected
|
|
225
|
-
- Customer-facing applications
|
|
226
|
-
|
|
227
|
-
handoff_prompts:
|
|
228
|
-
analyst_to_pm: "Project brief is complete. Save it as docs/project-brief.md in your project, then create the PRD."
|
|
229
|
-
pm_to_ux: "PRD is ready. Save it as docs/prd.md in your project, then create the UI/UX specification."
|
|
230
|
-
ux_to_architect: "UI/UX spec complete. Save it as docs/front-end-spec.md in your project, then create the frontend architecture."
|
|
231
|
-
architect_review: "Frontend architecture complete. Save it as docs/front-end-architecture.md. Do you suggest any changes to the PRD stories or need new stories added?"
|
|
232
|
-
architect_to_pm: "Please update the PRD with the suggested story changes, then re-export the complete prd.md to docs/."
|
|
233
|
-
updated_to_po: "All documents ready in docs/ folder. Please validate all artifacts for consistency."
|
|
234
|
-
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
|
235
|
-
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# Create Document from Template (YAML Driven)
|
|
2
|
-
|
|
3
|
-
## CRITICAL: Mandatory Elicitation Format
|
|
4
|
-
|
|
5
|
-
**When `elicit: true`, ALWAYS use this exact format:**
|
|
6
|
-
|
|
7
|
-
1. Present section content
|
|
8
|
-
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
|
|
9
|
-
3. Present numbered options 1-9:
|
|
10
|
-
- **Option 1:** Always "Proceed to next section"
|
|
11
|
-
- **Options 2-9:** Select 8 methods from data/elicitation-methods
|
|
12
|
-
- End with: "Select 1-9 or just type your question/feedback:"
|
|
13
|
-
|
|
14
|
-
**NEVER ask yes/no questions or use any other format.**
|
|
15
|
-
|
|
16
|
-
## Processing Flow
|
|
17
|
-
|
|
18
|
-
1. **Parse YAML template** - Load template metadata and sections
|
|
19
|
-
2. **Set preferences** - Show current mode (Interactive), confirm output file
|
|
20
|
-
3. **Process each section:**
|
|
21
|
-
- Skip if condition unmet
|
|
22
|
-
- Check agent permissions (owner/editors) - note if section is restricted to specific agents
|
|
23
|
-
- Draft content using section instruction
|
|
24
|
-
- Present content + detailed rationale
|
|
25
|
-
- **IF elicit: true** → MANDATORY 1-9 options format
|
|
26
|
-
- Save to file if possible
|
|
27
|
-
4. **Continue until complete**
|
|
28
|
-
|
|
29
|
-
## Detailed Rationale Requirements
|
|
30
|
-
|
|
31
|
-
When presenting section content, ALWAYS include rationale that explains:
|
|
32
|
-
|
|
33
|
-
- Trade-offs and choices made (what was chosen over alternatives and why)
|
|
34
|
-
- Key assumptions made during drafting
|
|
35
|
-
- Interesting or questionable decisions that need user attention
|
|
36
|
-
- Areas that might need validation
|
|
37
|
-
|
|
38
|
-
## Elicitation Results Flow
|
|
39
|
-
|
|
40
|
-
After user selects elicitation method (2-9):
|
|
41
|
-
|
|
42
|
-
1. Execute method from data/elicitation-methods
|
|
43
|
-
2. Present results with insights
|
|
44
|
-
3. Offer options:
|
|
45
|
-
- **1. Apply changes and update section**
|
|
46
|
-
- **2. Return to elicitation menu**
|
|
47
|
-
- **3. Ask any questions or engage further with this elicitation**
|
|
48
|
-
|
|
49
|
-
## Agent Permissions
|
|
50
|
-
|
|
51
|
-
When processing sections with agent permission fields:
|
|
52
|
-
|
|
53
|
-
- **owner**: Note which agent role initially creates/populates the section
|
|
54
|
-
- **editors**: List agent roles allowed to modify the section
|
|
55
|
-
- **readonly**: Mark sections that cannot be modified after creation
|
|
56
|
-
|
|
57
|
-
**For sections with restricted access:**
|
|
58
|
-
|
|
59
|
-
- Include a note in the generated document indicating the responsible agent
|
|
60
|
-
- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
|
|
61
|
-
|
|
62
|
-
## YOLO Mode
|
|
63
|
-
|
|
64
|
-
User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
65
|
-
|
|
66
|
-
## CRITICAL REMINDERS
|
|
67
|
-
|
|
68
|
-
**❌ NEVER:**
|
|
69
|
-
|
|
70
|
-
- Ask yes/no questions for elicitation
|
|
71
|
-
- Use any format other than 1-9 numbered options
|
|
72
|
-
- Create new elicitation methods
|
|
73
|
-
|
|
74
|
-
**✅ ALWAYS:**
|
|
75
|
-
|
|
76
|
-
- Use exact 1-9 format when elicit: true
|
|
77
|
-
- Select options 2-9 from data/elicitation-methods only
|
|
78
|
-
- Provide detailed rationale explaining decisions
|
|
79
|
-
- End with "Select 1-9 or just type your question/feedback:"
|
|
@@ -1,325 +0,0 @@
|
|
|
1
|
-
# BMad Document Template Specification
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
BMad document templates are defined in YAML format to drive interactive document generation and agent interaction. Templates separate structure definition from content generation, making them both human and LLM-agent-friendly.
|
|
6
|
-
|
|
7
|
-
## Template Structure
|
|
8
|
-
|
|
9
|
-
```yaml
|
|
10
|
-
template:
|
|
11
|
-
id: template-identifier
|
|
12
|
-
name: Human Readable Template Name
|
|
13
|
-
version: 1.0
|
|
14
|
-
output:
|
|
15
|
-
format: markdown
|
|
16
|
-
filename: default-path/to/{{filename}}.md
|
|
17
|
-
title: "{{variable}} Document Title"
|
|
18
|
-
|
|
19
|
-
workflow:
|
|
20
|
-
mode: interactive
|
|
21
|
-
elicitation: advanced-elicitation
|
|
22
|
-
|
|
23
|
-
sections:
|
|
24
|
-
- id: section-id
|
|
25
|
-
title: Section Title
|
|
26
|
-
instruction: |
|
|
27
|
-
Detailed instructions for the LLM on how to handle this section
|
|
28
|
-
# ... additional section properties
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## Core Fields
|
|
32
|
-
|
|
33
|
-
### Template Metadata
|
|
34
|
-
|
|
35
|
-
- **id**: Unique identifier for the template
|
|
36
|
-
- **name**: Human-readable name displayed in UI
|
|
37
|
-
- **version**: Template version for tracking changes
|
|
38
|
-
- **output.format**: Default "markdown" for document templates
|
|
39
|
-
- **output.filename**: Default output file path (can include variables)
|
|
40
|
-
- **output.title**: Document title (becomes H1 in markdown)
|
|
41
|
-
|
|
42
|
-
### Workflow Configuration
|
|
43
|
-
|
|
44
|
-
- **workflow.mode**: Default interaction mode ("interactive" or "yolo")
|
|
45
|
-
- **workflow.elicitation**: Elicitation task to use ("advanced-elicitation")
|
|
46
|
-
|
|
47
|
-
## Section Properties
|
|
48
|
-
|
|
49
|
-
### Required Fields
|
|
50
|
-
|
|
51
|
-
- **id**: Unique section identifier
|
|
52
|
-
- **title**: Section heading text
|
|
53
|
-
- **instruction**: Detailed guidance for LLM on handling this section
|
|
54
|
-
|
|
55
|
-
### Optional Fields
|
|
56
|
-
|
|
57
|
-
#### Content Control
|
|
58
|
-
|
|
59
|
-
- **type**: Content type hint for structured sections
|
|
60
|
-
- **template**: Fixed template text for section content
|
|
61
|
-
- **item_template**: Template for repeatable items within section
|
|
62
|
-
- **prefix**: Prefix for numbered items (e.g., "FR", "NFR")
|
|
63
|
-
|
|
64
|
-
#### Behavior Flags
|
|
65
|
-
|
|
66
|
-
- **elicit**: Boolean - Apply elicitation after section rendered
|
|
67
|
-
- **repeatable**: Boolean - Section can be repeated multiple times
|
|
68
|
-
- **condition**: String - Condition for including section (e.g., "has ui requirements")
|
|
69
|
-
|
|
70
|
-
#### Agent Permissions
|
|
71
|
-
|
|
72
|
-
- **owner**: String - Agent role that initially creates/populates this section
|
|
73
|
-
- **editors**: Array - List of agent roles allowed to modify this section
|
|
74
|
-
- **readonly**: Boolean - Section cannot be modified after initial creation
|
|
75
|
-
|
|
76
|
-
#### Content Guidance
|
|
77
|
-
|
|
78
|
-
- **examples**: Array of example content (not included in output)
|
|
79
|
-
- **choices**: Object with choice options for common decisions
|
|
80
|
-
- **placeholder**: Default placeholder text
|
|
81
|
-
|
|
82
|
-
#### Structure
|
|
83
|
-
|
|
84
|
-
- **sections**: Array of nested child sections
|
|
85
|
-
|
|
86
|
-
## Supported Types
|
|
87
|
-
|
|
88
|
-
### Content Types
|
|
89
|
-
|
|
90
|
-
- **bullet-list**: Unordered list items
|
|
91
|
-
- **numbered-list**: Ordered list with optional prefix
|
|
92
|
-
- **paragraphs**: Free-form paragraph text
|
|
93
|
-
- **table**: Structured table data
|
|
94
|
-
- **code-block**: Code or configuration blocks
|
|
95
|
-
- **template-text**: Fixed template with variable substitution
|
|
96
|
-
- **mermaid**: Mermaid diagram with specified type and details
|
|
97
|
-
|
|
98
|
-
### Special Types
|
|
99
|
-
|
|
100
|
-
- **repeatable-container**: Container for multiple instances
|
|
101
|
-
- **conditional-block**: Content shown based on conditions
|
|
102
|
-
- **choice-selector**: Present choices to user
|
|
103
|
-
|
|
104
|
-
## Advanced Features
|
|
105
|
-
|
|
106
|
-
### Variable Substitution
|
|
107
|
-
|
|
108
|
-
Use `{{variable_name}}` in titles, templates, and content:
|
|
109
|
-
|
|
110
|
-
```yaml
|
|
111
|
-
title: "Epic {{epic_number}} {{epic_title}}"
|
|
112
|
-
template: "As a {{user_type}}, I want {{action}}, so that {{benefit}}."
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
### Conditional Sections
|
|
116
|
-
|
|
117
|
-
```yaml
|
|
118
|
-
- id: ui-section
|
|
119
|
-
title: User Interface Design
|
|
120
|
-
condition: Project has UX/UI Requirements
|
|
121
|
-
instruction: Only include if project has UI components
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Choice Integration
|
|
125
|
-
|
|
126
|
-
```yaml
|
|
127
|
-
choices:
|
|
128
|
-
architecture: [Monolith, Microservices, Serverless]
|
|
129
|
-
testing: [Unit Only, Unit + Integration, Full Pyramid]
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### Mermaid Diagrams
|
|
133
|
-
|
|
134
|
-
```yaml
|
|
135
|
-
- id: system-architecture
|
|
136
|
-
title: System Architecture Diagram
|
|
137
|
-
type: mermaid
|
|
138
|
-
instruction: Create a system architecture diagram showing key components and data flow
|
|
139
|
-
mermaid_type: flowchart
|
|
140
|
-
details: |
|
|
141
|
-
Show the following components:
|
|
142
|
-
- User interface layer
|
|
143
|
-
- API gateway
|
|
144
|
-
- Core services
|
|
145
|
-
- Database layer
|
|
146
|
-
- External integrations
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
**Supported mermaid_type values:**
|
|
150
|
-
|
|
151
|
-
**Core Diagram Types:**
|
|
152
|
-
|
|
153
|
-
- `flowchart` - Flow charts and process diagrams
|
|
154
|
-
- `sequenceDiagram` - Sequence diagrams for interactions
|
|
155
|
-
- `classDiagram` - Class relationship diagrams (UML)
|
|
156
|
-
- `stateDiagram` - State transition diagrams
|
|
157
|
-
- `erDiagram` - Entity relationship diagrams
|
|
158
|
-
- `gantt` - Gantt charts for timelines
|
|
159
|
-
- `pie` - Pie charts for data visualization
|
|
160
|
-
|
|
161
|
-
**Advanced Diagram Types:**
|
|
162
|
-
|
|
163
|
-
- `journey` - User journey maps
|
|
164
|
-
- `mindmap` - Mindmaps for brainstorming
|
|
165
|
-
- `timeline` - Timeline diagrams for chronological events
|
|
166
|
-
- `quadrantChart` - Quadrant charts for data categorization
|
|
167
|
-
- `xyChart` - XY charts (bar charts, line charts)
|
|
168
|
-
- `sankey` - Sankey diagrams for flow visualization
|
|
169
|
-
|
|
170
|
-
**Specialized Types:**
|
|
171
|
-
|
|
172
|
-
- `c4Context` - C4 context diagrams (experimental)
|
|
173
|
-
- `requirement` - Requirement diagrams
|
|
174
|
-
- `packet` - Network packet diagrams
|
|
175
|
-
- `block` - Block diagrams
|
|
176
|
-
- `kanban` - Kanban boards
|
|
177
|
-
|
|
178
|
-
### Agent Permissions Example
|
|
179
|
-
|
|
180
|
-
```yaml
|
|
181
|
-
- id: story-details
|
|
182
|
-
title: Story
|
|
183
|
-
owner: scrum-master
|
|
184
|
-
editors: [scrum-master]
|
|
185
|
-
readonly: false
|
|
186
|
-
sections:
|
|
187
|
-
- id: dev-notes
|
|
188
|
-
title: Dev Notes
|
|
189
|
-
owner: dev-agent
|
|
190
|
-
editors: [dev-agent]
|
|
191
|
-
readonly: false
|
|
192
|
-
instruction: Implementation notes and technical details
|
|
193
|
-
- id: qa-results
|
|
194
|
-
title: QA Results
|
|
195
|
-
owner: qa-agent
|
|
196
|
-
editors: [qa-agent]
|
|
197
|
-
readonly: true
|
|
198
|
-
instruction: Quality assurance test results
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
### Repeatable Sections
|
|
202
|
-
|
|
203
|
-
```yaml
|
|
204
|
-
- id: epic-details
|
|
205
|
-
title: Epic {{epic_number}} {{epic_title}}
|
|
206
|
-
repeatable: true
|
|
207
|
-
sections:
|
|
208
|
-
- id: story
|
|
209
|
-
title: Story {{epic_number}}.{{story_number}} {{story_title}}
|
|
210
|
-
repeatable: true
|
|
211
|
-
sections:
|
|
212
|
-
- id: criteria
|
|
213
|
-
title: Acceptance Criteria
|
|
214
|
-
type: numbered-list
|
|
215
|
-
item_template: "{{criterion_number}}: {{criteria}}"
|
|
216
|
-
repeatable: true
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
### Examples with Code Blocks
|
|
220
|
-
|
|
221
|
-
````yaml
|
|
222
|
-
examples:
|
|
223
|
-
- "FR6: The system must authenticate users within 2 seconds"
|
|
224
|
-
- |
|
|
225
|
-
```mermaid
|
|
226
|
-
sequenceDiagram
|
|
227
|
-
participant User
|
|
228
|
-
participant API
|
|
229
|
-
participant DB
|
|
230
|
-
User->>API: POST /login
|
|
231
|
-
API->>DB: Validate credentials
|
|
232
|
-
DB-->>API: User data
|
|
233
|
-
API-->>User: JWT token
|
|
234
|
-
```
|
|
235
|
-
- |
|
|
236
|
-
**Architecture Decision Record**
|
|
237
|
-
|
|
238
|
-
**Decision**: Use PostgreSQL for primary database
|
|
239
|
-
**Rationale**: ACID compliance and JSON support needed
|
|
240
|
-
**Consequences**: Requires database management expertise
|
|
241
|
-
````
|
|
242
|
-
|
|
243
|
-
## Section Hierarchy
|
|
244
|
-
|
|
245
|
-
Templates define the complete document structure starting with the first H2 - each level in is the next H#:
|
|
246
|
-
|
|
247
|
-
```yaml
|
|
248
|
-
sections:
|
|
249
|
-
- id: overview
|
|
250
|
-
title: Project Overview
|
|
251
|
-
sections:
|
|
252
|
-
- id: goals
|
|
253
|
-
title: Goals
|
|
254
|
-
- id: scope
|
|
255
|
-
title: Scope
|
|
256
|
-
sections:
|
|
257
|
-
- id: in-scope
|
|
258
|
-
title: In Scope
|
|
259
|
-
- id: out-scope
|
|
260
|
-
title: Out of Scope
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
## Processing Flow
|
|
264
|
-
|
|
265
|
-
1. **Parse Template**: Load and validate YAML structure
|
|
266
|
-
2. **Initialize Workflow**: Set interaction mode and elicitation
|
|
267
|
-
3. **Process Sections**: Handle each section in order:
|
|
268
|
-
- Check conditions
|
|
269
|
-
- Apply instructions
|
|
270
|
-
- Generate content
|
|
271
|
-
- Handle choices and variables
|
|
272
|
-
- Apply elicitation if specified
|
|
273
|
-
- Process nested sections
|
|
274
|
-
4. **Generate Output**: Create clean markdown document
|
|
275
|
-
|
|
276
|
-
## Best Practices
|
|
277
|
-
|
|
278
|
-
### Template Design
|
|
279
|
-
|
|
280
|
-
- Keep instructions clear and specific
|
|
281
|
-
- Use examples for complex content
|
|
282
|
-
- Structure sections logically
|
|
283
|
-
- Include all necessary guidance for LLM
|
|
284
|
-
|
|
285
|
-
### Content Instructions
|
|
286
|
-
|
|
287
|
-
- Be explicit about expected format
|
|
288
|
-
- Include reasoning for decisions
|
|
289
|
-
- Specify interaction patterns
|
|
290
|
-
- Reference other documents when needed
|
|
291
|
-
|
|
292
|
-
### Variable Naming
|
|
293
|
-
|
|
294
|
-
- Use descriptive variable names
|
|
295
|
-
- Follow consistent naming conventions
|
|
296
|
-
- Document expected variable values
|
|
297
|
-
|
|
298
|
-
### Examples Usage
|
|
299
|
-
|
|
300
|
-
- Provide concrete examples for complex sections
|
|
301
|
-
- Include both simple and complex cases
|
|
302
|
-
- Use realistic project scenarios
|
|
303
|
-
- Include code blocks and diagrams when helpful
|
|
304
|
-
|
|
305
|
-
## Validation
|
|
306
|
-
|
|
307
|
-
Templates should be validated for:
|
|
308
|
-
|
|
309
|
-
- Valid YAML syntax
|
|
310
|
-
- Required fields present
|
|
311
|
-
- Consistent section IDs
|
|
312
|
-
- Proper nesting structure
|
|
313
|
-
- Valid variable references
|
|
314
|
-
|
|
315
|
-
## Migration from Legacy
|
|
316
|
-
|
|
317
|
-
When converting from markdown+frontmatter templates:
|
|
318
|
-
|
|
319
|
-
1. Extract embedded `[[LLM:]]` instructions to `instruction` fields
|
|
320
|
-
2. Convert `<<REPEAT>>` blocks to `repeatable: true` sections
|
|
321
|
-
3. Extract `^^CONDITIONS^^` to `condition` fields
|
|
322
|
-
4. Move `@{examples}` to `examples` arrays
|
|
323
|
-
5. Convert `{{placeholders}}` to proper variable syntax
|
|
324
|
-
|
|
325
|
-
This specification ensures templates are both human-readable and machine-processable while maintaining the flexibility needed for complex document generation.
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
# Workflow Management
|
|
2
|
-
|
|
3
|
-
Enables BMad orchestrator to manage and execute team workflows.
|
|
4
|
-
|
|
5
|
-
## Dynamic Workflow Loading
|
|
6
|
-
|
|
7
|
-
Read available workflows from current team configuration's `workflows` field. Each team bundle defines its own supported workflows.
|
|
8
|
-
|
|
9
|
-
**Key Commands**:
|
|
10
|
-
|
|
11
|
-
- `/workflows` - List workflows in current bundle or workflows folder
|
|
12
|
-
- `/agent-list` - Show agents in current bundle
|
|
13
|
-
|
|
14
|
-
## Workflow Commands
|
|
15
|
-
|
|
16
|
-
### /workflows
|
|
17
|
-
|
|
18
|
-
Lists available workflows with titles and descriptions.
|
|
19
|
-
|
|
20
|
-
### /workflow-start {workflow-id}
|
|
21
|
-
|
|
22
|
-
Starts workflow and transitions to first agent.
|
|
23
|
-
|
|
24
|
-
### /workflow-status
|
|
25
|
-
|
|
26
|
-
Shows current progress, completed artifacts, and next steps.
|
|
27
|
-
|
|
28
|
-
### /workflow-resume
|
|
29
|
-
|
|
30
|
-
Resumes workflow from last position. User can provide completed artifacts.
|
|
31
|
-
|
|
32
|
-
### /workflow-next
|
|
33
|
-
|
|
34
|
-
Shows next recommended agent and action.
|
|
35
|
-
|
|
36
|
-
## Execution Flow
|
|
37
|
-
|
|
38
|
-
1. **Starting**: Load definition → Identify first stage → Transition to agent → Guide artifact creation
|
|
39
|
-
|
|
40
|
-
2. **Stage Transitions**: Mark complete → Check conditions → Load next agent → Pass artifacts
|
|
41
|
-
|
|
42
|
-
3. **Artifact Tracking**: Track status, creator, timestamps in workflow_state
|
|
43
|
-
|
|
44
|
-
4. **Interruption Handling**: Analyze provided artifacts → Determine position → Suggest next step
|
|
45
|
-
|
|
46
|
-
## Context Passing
|
|
47
|
-
|
|
48
|
-
When transitioning, pass:
|
|
49
|
-
|
|
50
|
-
- Previous artifacts
|
|
51
|
-
- Current workflow stage
|
|
52
|
-
- Expected outputs
|
|
53
|
-
- Decisions/constraints
|
|
54
|
-
|
|
55
|
-
## Multi-Path Workflows
|
|
56
|
-
|
|
57
|
-
Handle conditional paths by asking clarifying questions when needed.
|
|
58
|
-
|
|
59
|
-
## Best Practices
|
|
60
|
-
|
|
61
|
-
1. Show progress
|
|
62
|
-
2. Explain transitions
|
|
63
|
-
3. Preserve context
|
|
64
|
-
4. Allow flexibility
|
|
65
|
-
5. Track state
|
|
66
|
-
|
|
67
|
-
## Agent Integration
|
|
68
|
-
|
|
69
|
-
Agents should be workflow-aware: know active workflow, their role, access artifacts, understand expected outputs.
|