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.
Files changed (274) hide show
  1. package/.bmad-core/agent-teams/team-all.yml +16 -0
  2. package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
  3. package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
  4. package/{bmad-core → .bmad-core}/agents/analyst.md +23 -30
  5. package/.bmad-core/agents/architect.md +66 -0
  6. package/.bmad-core/agents/bmad-master.md +104 -0
  7. package/.bmad-core/agents/bmad-orchestrator.md +81 -0
  8. package/.bmad-core/agents/dev.md +70 -0
  9. package/{bmad-core → .bmad-core}/agents/pm.md +24 -25
  10. package/{bmad-core → .bmad-core}/agents/po.md +24 -28
  11. package/.bmad-core/agents/qa.md +52 -0
  12. package/.bmad-core/agents/sm.md +55 -0
  13. package/.bmad-core/agents/ux-expert.md +66 -0
  14. package/{bmad-core → .bmad-core}/checklists/change-checklist.md +2 -2
  15. package/{bmad-core → .bmad-core}/checklists/story-draft-checklist.md +1 -1
  16. package/.bmad-core/data/bmad-kb.md +47 -0
  17. package/.bmad-core/schemas/agent-team-schema.yml +153 -0
  18. package/.bmad-core/tasks/advanced-elicitation.md +92 -0
  19. package/.bmad-core/tasks/brainstorming-techniques.md +238 -0
  20. package/.bmad-core/tasks/core-dump.md +74 -0
  21. package/{expansion-packs/bmad-creator-tools → .bmad-core}/tasks/create-agent.md +11 -9
  22. package/.bmad-core/tasks/create-doc.md +74 -0
  23. package/.bmad-core/tasks/create-expansion-pack.md +425 -0
  24. package/.bmad-core/tasks/create-next-story.md +206 -0
  25. package/.bmad-core/tasks/create-team.md +229 -0
  26. package/{bmad-core → .bmad-core}/tasks/doc-migration-task.md +9 -9
  27. package/{common → .bmad-core}/tasks/execute-checklist.md +6 -2
  28. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
  29. package/{bmad-core → .bmad-core}/tasks/index-docs.md +7 -3
  30. package/{bmad-core → .bmad-core}/tasks/shard-doc.md +7 -25
  31. package/.bmad-core/templates/agent-tmpl.md +58 -0
  32. package/.bmad-core/templates/architecture-tmpl.md +771 -0
  33. package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
  34. package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
  35. package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
  36. package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
  37. package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
  38. package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
  39. package/.bmad-core/templates/fullstack-architecture-tmpl.md +1016 -0
  40. package/.bmad-core/templates/market-research-tmpl.md +261 -0
  41. package/.bmad-core/templates/prd-tmpl.md +200 -0
  42. package/.bmad-core/templates/project-brief-tmpl.md +228 -0
  43. package/.bmad-core/templates/simple-project-prd-tmpl.md +461 -0
  44. package/.bmad-core/templates/story-tmpl.md +61 -0
  45. package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
  46. package/.bmad-core/utils/agent-switcher.ide.md +112 -0
  47. package/.bmad-core/utils/template-format.md +26 -0
  48. package/.bmad-core/utils/workflow-management.md +224 -0
  49. package/.bmad-core/web-bundles/agents/analyst.txt +1684 -0
  50. package/.bmad-core/web-bundles/agents/architect.txt +3584 -0
  51. package/.bmad-core/web-bundles/agents/bmad-master.txt +9491 -0
  52. package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1466 -0
  53. package/{dist → .bmad-core/web-bundles}/agents/dev.txt +71 -179
  54. package/{dist → .bmad-core/web-bundles}/agents/pm.txt +1058 -624
  55. package/{dist → .bmad-core/web-bundles}/agents/po.txt +138 -337
  56. package/.bmad-core/web-bundles/agents/qa.txt +129 -0
  57. package/.bmad-core/web-bundles/agents/sm.txt +658 -0
  58. package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
  59. package/.bmad-core/web-bundles/teams/team-all.txt +10757 -0
  60. package/.bmad-core/web-bundles/teams/team-fullstack.txt +10109 -0
  61. package/.bmad-core/web-bundles/teams/team-no-ui.txt +8950 -0
  62. package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
  63. package/.bmad-core/workflows/brownfield-service.yml +117 -0
  64. package/.bmad-core/workflows/brownfield-ui.yml +127 -0
  65. package/{bmad-core/workflows/greenfield-fullstack.yaml → .bmad-core/workflows/greenfield-fullstack.yml} +77 -140
  66. package/.bmad-core/workflows/greenfield-service.yml +143 -0
  67. package/.bmad-core/workflows/greenfield-ui.yml +172 -0
  68. package/.claude/commands/analyst.md +63 -0
  69. package/.claude/commands/architect.md +70 -0
  70. package/.claude/commands/bmad-master.md +108 -0
  71. package/.claude/commands/bmad-orchestrator.md +85 -0
  72. package/.claude/commands/dev.md +74 -0
  73. package/.claude/commands/pm.md +63 -0
  74. package/.claude/commands/po.md +64 -0
  75. package/.claude/commands/qa.md +56 -0
  76. package/.claude/commands/sm.md +59 -0
  77. package/.claude/commands/ux-expert.md +70 -0
  78. package/.cursor/rules/analyst.mdc +77 -0
  79. package/.cursor/rules/architect.mdc +84 -0
  80. package/.cursor/rules/bmad-master.mdc +122 -0
  81. package/.cursor/rules/bmad-orchestrator.mdc +99 -0
  82. package/.cursor/rules/dev.mdc +88 -0
  83. package/.cursor/rules/pm.mdc +77 -0
  84. package/.cursor/rules/po.mdc +78 -0
  85. package/.cursor/rules/qa.mdc +70 -0
  86. package/.cursor/rules/sm.mdc +73 -0
  87. package/.cursor/rules/ux-expert.mdc +84 -0
  88. package/.roo/.roomodes +95 -0
  89. package/.roo/README.md +38 -0
  90. package/.vscode/extensions.json +6 -0
  91. package/.vscode/settings.json +75 -49
  92. package/.windsurf/rules/analyst.md +71 -0
  93. package/.windsurf/rules/architect.md +78 -0
  94. package/.windsurf/rules/bmad-master.md +116 -0
  95. package/.windsurf/rules/bmad-orchestrator.md +93 -0
  96. package/.windsurf/rules/dev.md +82 -0
  97. package/.windsurf/rules/pm.md +71 -0
  98. package/.windsurf/rules/po.md +72 -0
  99. package/.windsurf/rules/qa.md +64 -0
  100. package/.windsurf/rules/sm.md +67 -0
  101. package/.windsurf/rules/ux-expert.md +78 -0
  102. package/CHANGELOG.md +16 -452
  103. package/CONTRIBUTING.md +5 -168
  104. package/LICENSE +1 -1
  105. package/README.md +230 -77
  106. package/docs/bmad-workflow-guide.md +15 -19
  107. package/docs/claude-code-guide.md +119 -0
  108. package/docs/cursor-guide.md +127 -0
  109. package/docs/roo-code-guide.md +140 -0
  110. package/docs/sample-output/simple-fullstack-greenfield/prd.md +42 -0
  111. package/docs/versioning-and-releases.md +16 -8
  112. package/docs/versions.md +5 -4
  113. package/docs/windsurf-guide.md +127 -0
  114. package/expansion-packs/README.md +112 -2
  115. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/README.md +9 -9
  116. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/agents/infra-devops-platform.md +15 -15
  117. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/checklists/infrastructure-checklist.md +1 -1
  118. package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
  119. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/review-infrastructure.md +4 -4
  120. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/validate-infrastructure.md +4 -4
  121. package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
  122. package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
  123. package/package.json +11 -19
  124. package/tools/bmad-npx-wrapper.js +1 -1
  125. package/tools/builders/web-builder.js +28 -563
  126. package/tools/cli.js +22 -55
  127. package/tools/installer/README.md +53 -3
  128. package/tools/installer/bin/bmad.js +56 -294
  129. package/tools/installer/config/install.config.yml +139 -0
  130. package/tools/installer/lib/config-loader.js +34 -198
  131. package/tools/installer/lib/file-manager.js +5 -123
  132. package/tools/installer/lib/ide-setup.js +189 -545
  133. package/tools/installer/lib/installer.js +55 -1136
  134. package/tools/installer/package-lock.json +3 -3
  135. package/tools/installer/package.json +4 -4
  136. package/tools/installer/templates/claude-commands.md +7 -0
  137. package/tools/installer/templates/cursor-rules.md +22 -0
  138. package/tools/installer/templates/windsurf-rules.md +22 -0
  139. package/tools/lib/dependency-resolver.js +22 -22
  140. package/tools/upgraders/v3-to-v4-upgrader.js +43 -35
  141. package/tools/version-bump.js +1 -1
  142. package/tools/yaml-format.js +2 -2
  143. package/.github/FUNDING.yaml +0 -15
  144. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -32
  145. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
  146. package/.prettierignore +0 -21
  147. package/.prettierrc +0 -23
  148. package/bmad-core/agent-teams/team-all.yaml +0 -14
  149. package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
  150. package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
  151. package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
  152. package/bmad-core/agents/architect.md +0 -63
  153. package/bmad-core/agents/bmad-master.md +0 -110
  154. package/bmad-core/agents/bmad-orchestrator.md +0 -140
  155. package/bmad-core/agents/dev.md +0 -57
  156. package/bmad-core/agents/qa.md +0 -55
  157. package/bmad-core/agents/sm.md +0 -46
  158. package/bmad-core/agents/ux-expert.md +0 -54
  159. package/bmad-core/core-config.yaml +0 -25
  160. package/bmad-core/data/bmad-kb.md +0 -803
  161. package/bmad-core/data/brainstorming-techniques.md +0 -36
  162. package/bmad-core/data/elicitation-methods.md +0 -134
  163. package/bmad-core/tasks/advanced-elicitation.md +0 -117
  164. package/bmad-core/tasks/create-brownfield-story.md +0 -355
  165. package/bmad-core/tasks/create-next-story.md +0 -114
  166. package/bmad-core/tasks/create-workflow-plan.md +0 -289
  167. package/bmad-core/tasks/document-project.md +0 -317
  168. package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
  169. package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  170. package/bmad-core/tasks/kb-mode-interaction.md +0 -70
  171. package/bmad-core/tasks/review-story.md +0 -145
  172. package/bmad-core/tasks/update-workflow-plan.md +0 -248
  173. package/bmad-core/tasks/validate-next-story.md +0 -134
  174. package/bmad-core/templates/architecture-tmpl.yaml +0 -650
  175. package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  176. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
  177. package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
  178. package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -293
  179. package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -206
  180. package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
  181. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -805
  182. package/bmad-core/templates/market-research-tmpl.yaml +0 -252
  183. package/bmad-core/templates/prd-tmpl.yaml +0 -202
  184. package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
  185. package/bmad-core/templates/story-tmpl.yaml +0 -137
  186. package/bmad-core/utils/plan-management.md +0 -219
  187. package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
  188. package/bmad-core/workflows/brownfield-service.yaml +0 -187
  189. package/bmad-core/workflows/brownfield-ui.yaml +0 -197
  190. package/bmad-core/workflows/greenfield-service.yaml +0 -206
  191. package/bmad-core/workflows/greenfield-ui.yaml +0 -235
  192. package/common/tasks/create-doc.md +0 -79
  193. package/common/utils/bmad-doc-template.md +0 -325
  194. package/common/utils/workflow-management.md +0 -69
  195. package/dist/agents/analyst.txt +0 -2849
  196. package/dist/agents/architect.txt +0 -3505
  197. package/dist/agents/bmad-master.txt +0 -9588
  198. package/dist/agents/bmad-orchestrator.txt +0 -2232
  199. package/dist/agents/qa.txt +0 -388
  200. package/dist/agents/sm.txt +0 -673
  201. package/dist/agents/ux-expert.txt +0 -987
  202. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2401
  203. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1635
  204. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -825
  205. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -11730
  206. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +0 -2023
  207. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2052
  208. package/dist/teams/team-all.txt +0 -11799
  209. package/dist/teams/team-fullstack.txt +0 -11129
  210. package/dist/teams/team-ide-minimal.txt +0 -4573
  211. package/dist/teams/team-no-ui.txt +0 -9684
  212. package/docs/GUIDING-PRINCIPLES.md +0 -91
  213. package/docs/agentic-tools/claude-code-guide.md +0 -19
  214. package/docs/agentic-tools/cline-guide.md +0 -16
  215. package/docs/agentic-tools/cursor-guide.md +0 -14
  216. package/docs/agentic-tools/gemini-cli-guide.md +0 -32
  217. package/docs/agentic-tools/github-copilot-guide.md +0 -42
  218. package/docs/agentic-tools/roo-code-guide.md +0 -15
  219. package/docs/agentic-tools/trae-guide.md +0 -14
  220. package/docs/agentic-tools/windsurf-guide.md +0 -14
  221. package/docs/core-architecture.md +0 -219
  222. package/docs/expansion-packs.md +0 -280
  223. package/docs/how-to-contribute-with-pull-requests.md +0 -158
  224. package/docs/template-markup-references.md +0 -86
  225. package/docs/user-guide.md +0 -1142
  226. package/docs/working-in-the-brownfield.md +0 -361
  227. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
  228. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -60
  229. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -68
  230. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -53
  231. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
  232. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
  233. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -7
  234. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -254
  235. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -651
  236. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -111
  237. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
  238. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -308
  239. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
  240. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
  241. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
  242. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
  243. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  244. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  245. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
  246. package/expansion-packs/bmad-creator-tools/README.md +0 -8
  247. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +0 -55
  248. package/expansion-packs/bmad-creator-tools/config.yaml +0 -5
  249. package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +0 -1020
  250. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +0 -178
  251. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +0 -154
  252. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +0 -120
  253. package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -8
  254. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -308
  255. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
  256. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
  257. package/tools/bump-all-versions.js +0 -107
  258. package/tools/bump-core-version.js +0 -57
  259. package/tools/bump-expansion-version.js +0 -78
  260. package/tools/installer/config/ide-agent-config.yaml +0 -58
  261. package/tools/installer/config/install.config.yaml +0 -91
  262. package/tools/lib/yaml-utils.js +0 -29
  263. package/tools/md-assets/web-agent-startup-instructions.md +0 -39
  264. package/tools/update-expansion-version.js +0 -54
  265. /package/{bmad-core → .bmad-core}/checklists/architect-checklist.md +0 -0
  266. /package/{bmad-core → .bmad-core}/checklists/pm-checklist.md +0 -0
  267. /package/{bmad-core → .bmad-core}/checklists/po-master-checklist.md +0 -0
  268. /package/{bmad-core → .bmad-core}/checklists/story-dod-checklist.md +0 -0
  269. /package/{bmad-core → .bmad-core}/data/technical-preferences.md +0 -0
  270. /package/{bmad-core → .bmad-core}/tasks/brownfield-create-epic.md +0 -0
  271. /package/{bmad-core → .bmad-core}/tasks/brownfield-create-story.md +0 -0
  272. /package/{bmad-core → .bmad-core}/tasks/correct-course.md +0 -0
  273. /package/{bmad-core → .bmad-core}/tasks/create-deep-research-prompt.md +0 -0
  274. /package/.github/workflows/{release.yaml → release.yml} +0 -0
@@ -1,137 +0,0 @@
1
- template:
2
- id: story-template-v2
3
- name: Story Document
4
- version: 2.0
5
- output:
6
- format: markdown
7
- filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
8
- title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
9
-
10
- workflow:
11
- mode: interactive
12
- elicitation: advanced-elicitation
13
-
14
- agent_config:
15
- editable_sections:
16
- - Status
17
- - Story
18
- - Acceptance Criteria
19
- - Tasks / Subtasks
20
- - Dev Notes
21
- - Testing
22
- - Change Log
23
-
24
- sections:
25
- - id: status
26
- title: Status
27
- type: choice
28
- choices: [Draft, Approved, InProgress, Review, Done]
29
- instruction: Select the current status of the story
30
- owner: scrum-master
31
- editors: [scrum-master, dev-agent]
32
-
33
- - id: story
34
- title: Story
35
- type: template-text
36
- template: |
37
- **As a** {{role}},
38
- **I want** {{action}},
39
- **so that** {{benefit}}
40
- instruction: Define the user story using the standard format with role, action, and benefit
41
- elicit: true
42
- owner: scrum-master
43
- editors: [scrum-master]
44
-
45
- - id: acceptance-criteria
46
- title: Acceptance Criteria
47
- type: numbered-list
48
- instruction: Copy the acceptance criteria numbered list from the epic file
49
- elicit: true
50
- owner: scrum-master
51
- editors: [scrum-master]
52
-
53
- - id: tasks-subtasks
54
- title: Tasks / Subtasks
55
- type: bullet-list
56
- instruction: |
57
- Break down the story into specific tasks and subtasks needed for implementation.
58
- Reference applicable acceptance criteria numbers where relevant.
59
- template: |
60
- - [ ] Task 1 (AC: # if applicable)
61
- - [ ] Subtask1.1...
62
- - [ ] Task 2 (AC: # if applicable)
63
- - [ ] Subtask 2.1...
64
- - [ ] Task 3 (AC: # if applicable)
65
- - [ ] Subtask 3.1...
66
- elicit: true
67
- owner: scrum-master
68
- editors: [scrum-master, dev-agent]
69
-
70
- - id: dev-notes
71
- title: Dev Notes
72
- instruction: |
73
- Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
74
- - Do not invent information
75
- - If known add Relevant Source Tree info that relates to this story
76
- - If there were important notes from previous story that are relevant to this one, include them here
77
- - Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
78
- elicit: true
79
- owner: scrum-master
80
- editors: [scrum-master]
81
- sections:
82
- - id: testing-standards
83
- title: Testing
84
- instruction: |
85
- List Relevant Testing Standards from Architecture the Developer needs to conform to:
86
- - Test file location
87
- - Test standards
88
- - Testing frameworks and patterns to use
89
- - Any specific testing requirements for this story
90
- elicit: true
91
- owner: scrum-master
92
- editors: [scrum-master]
93
-
94
- - id: change-log
95
- title: Change Log
96
- type: table
97
- columns: [Date, Version, Description, Author]
98
- instruction: Track changes made to this story document
99
- owner: scrum-master
100
- editors: [scrum-master, dev-agent, qa-agent]
101
-
102
- - id: dev-agent-record
103
- title: Dev Agent Record
104
- instruction: This section is populated by the development agent during implementation
105
- owner: dev-agent
106
- editors: [dev-agent]
107
- sections:
108
- - id: agent-model
109
- title: Agent Model Used
110
- template: "{{agent_model_name_version}}"
111
- instruction: Record the specific AI agent model and version used for development
112
- owner: dev-agent
113
- editors: [dev-agent]
114
-
115
- - id: debug-log-references
116
- title: Debug Log References
117
- instruction: Reference any debug logs or traces generated during development
118
- owner: dev-agent
119
- editors: [dev-agent]
120
-
121
- - id: completion-notes
122
- title: Completion Notes List
123
- instruction: Notes about the completion of tasks and any issues encountered
124
- owner: dev-agent
125
- editors: [dev-agent]
126
-
127
- - id: file-list
128
- title: File List
129
- instruction: List all files created, modified, or affected during story implementation
130
- owner: dev-agent
131
- editors: [dev-agent]
132
-
133
- - id: qa-results
134
- title: QA Results
135
- instruction: Results from QA Agent QA review of the completed story implementation
136
- owner: qa-agent
137
- editors: [qa-agent]
@@ -1,219 +0,0 @@
1
- # Plan Management Utility
2
-
3
- ## Purpose
4
-
5
- Provides utilities for agents and tasks to interact with workflow plans, check progress, update status, and ensure workflow steps are executed in the appropriate sequence.
6
-
7
- ## Core Functions
8
-
9
- ### 1. Check Plan Existence
10
-
11
- Check for workflow plan:
12
-
13
- 1. Look for docs/workflow-plan.md (default location)
14
- 2. Return plan status to user (exists/not exists) - if not exists then HALT.
15
-
16
- ### 2. Parse Plan Status
17
-
18
- [[LLM: Extract current progress from the plan document]]
19
-
20
- **Plan Parsing Logic:**
21
-
22
- 1. **Identify Step Structure**:
23
- - Look for checkbox lines: `- [ ]` or `- [x]`
24
- - Extract step IDs from comments: `<!-- step-id: X.Y -->`
25
- - Identify agent assignments: `<!-- agent: pm -->`
26
-
27
- 2. **Determine Current State**:
28
- - Last completed step (highest numbered `[x]`)
29
- - Next expected step (first `[ ]` after completed steps)
30
- - Overall progress percentage
31
-
32
- 3. **Extract Metadata**:
33
- - Workflow type from plan header
34
- - Decision points and their status
35
- - Any deviation notes
36
-
37
- ### 3. Sequence Validation
38
-
39
- [[LLM: Check if requested action aligns with plan sequence]]
40
-
41
- **Validation Rules:**
42
-
43
- 1. **Strict Mode** (enforceSequence: true):
44
- - Must complete steps in exact order
45
- - Warn and block if out of sequence
46
- - Require explicit override justification
47
-
48
- 2. **Flexible Mode** (enforceSequence: false):
49
- - Warn about sequence deviation
50
- - Allow with confirmation
51
- - Log deviation reason
52
-
53
- **Warning Templates:**
54
-
55
- ```text
56
- SEQUENCE WARNING:
57
- The workflow plan shows you should complete "{expected_step}" next.
58
- You're attempting to: "{requested_action}"
59
-
60
- In strict mode: Block and require plan update
61
- In flexible mode: Allow with confirmation
62
- ```
63
-
64
- ### 4. Plan Update Operations
65
-
66
- [[LLM: Provide consistent way to update plan progress]]
67
-
68
- **Update Actions:**
69
-
70
- 1. **Mark Step Complete**:
71
- - Change `- [ ]` to `- [x]`
72
- - Add completion timestamp comment
73
- - Update any status metadata
74
-
75
- 2. **Add Deviation Note**:
76
- - Insert note explaining why sequence changed
77
- - Reference the deviation in plan
78
-
79
- 3. **Update Current Step Pointer**:
80
- - Add/move `<!-- current-step -->` marker
81
- - Update last-modified timestamp
82
-
83
- ### 5. Integration Instructions
84
-
85
- [[LLM: How agents and tasks should use this utility]]
86
-
87
- **For Agents (startup sequence)**:
88
-
89
- ```text
90
- 1. Check if plan exists using this utility
91
- 2. If exists:
92
- - Parse current status
93
- - Show user: "Active workflow plan detected. Current step: {X}"
94
- - Suggest: "Next recommended action: {next_step}"
95
- 3. Continue with normal startup
96
- ```
97
-
98
- **For Tasks (pre-execution)**:
99
-
100
- ```text
101
- 1. Check if plan exists
102
- 2. If exists:
103
- - Verify this task aligns with plan
104
- - If not aligned:
105
- - In strict mode: Show warning and stop
106
- - In flexible mode: Show warning and ask for confirmation
107
- 3. After task completion:
108
- - Update plan if task was a planned step
109
- - Add note if task was unplanned
110
- ```
111
-
112
- ### 6. Plan Status Report Format
113
-
114
- [[LLM: Standard format for showing plan status]]
115
-
116
- ```text
117
- 📋 Workflow Plan Status
118
- ━━━━━━━━━━━━━━━━━━━━
119
- Workflow: {workflow_name}
120
- Progress: {X}% complete ({completed}/{total} steps)
121
-
122
- ✅ Completed:
123
- - {completed_step_1}
124
- - {completed_step_2}
125
-
126
- 🔄 Current Step:
127
- - {current_step_description}
128
-
129
- 📌 Upcoming:
130
- - {next_step_1}
131
- - {next_step_2}
132
-
133
- ⚠️ Notes:
134
- - {any_deviations_or_notes}
135
- ```
136
-
137
- ### 7. Decision Point Handling
138
-
139
- [[LLM: Special handling for workflow decision points]]
140
-
141
- When encountering a decision point in the plan:
142
-
143
- 1. **Identify Decision Marker**: `<!-- decision: {decision_id} -->`
144
- 2. **Check Decision Status**: Made/Pending
145
- 3. **If Pending**:
146
- - Block progress until decision made
147
- - Show options to user
148
- - Record decision when made
149
- 4. **If Made**:
150
- - Verify current path aligns with decision
151
- - Warn if attempting alternate path
152
-
153
- ### 8. Plan Abandonment
154
-
155
- [[LLM: Graceful handling when user wants to stop following plan]]
156
-
157
- If user wants to abandon plan:
158
-
159
- 1. Confirm abandonment intent
160
- 2. Add abandonment note to plan
161
- 3. Mark plan as "Abandoned" in header
162
- 4. Stop plan checking for remainder of session
163
- 5. Suggest creating new plan if needed
164
-
165
- ## Usage Examples
166
-
167
- ### Example 1: Agent Startup Check
168
-
169
- ```text
170
- BMad Master starting...
171
-
172
- [Check for plan]
173
- Found active workflow plan: brownfield-fullstack
174
- Progress: 40% complete (4/10 steps)
175
- Current step: Create PRD (pm agent)
176
-
177
- Suggestion: Based on your plan, you should work with the PM agent next.
178
- Use *agent pm to switch, or *plan-status to see full progress.
179
- ```
180
-
181
- ### Example 2: Task Sequence Warning
182
-
183
- ```text
184
- User: *task create-next-story
185
-
186
- [Plan check triggered]
187
- ⚠️ SEQUENCE WARNING:
188
- Your workflow plan indicates the PRD hasn't been created yet.
189
- Creating stories before the PRD may lead to incomplete requirements.
190
-
191
- Would you like to:
192
- 1. Continue anyway (will note deviation in plan)
193
- 2. Switch to creating PRD first (*agent pm)
194
- 3. View plan status (*plan-status)
195
- ```
196
-
197
- ### Example 3: Automatic Plan Update
198
-
199
- ```text
200
- [After completing create-doc task for PRD]
201
-
202
- ✅ Plan Updated: Marked "Create PRD" as complete
203
- 📍 Next step: Create Architecture Document (architect agent)
204
- ```
205
-
206
- ## Implementation Notes
207
-
208
- - This utility should be lightweight and fast
209
- - Plan parsing should be resilient to format variations
210
- - Always preserve user agency - warnings not blocks (unless strict mode)
211
- - Plan updates should be atomic to prevent corruption
212
- - Consider plan versioning for rollback capability
213
-
214
- ## Error Handling
215
-
216
- - Missing plan: Return null, don't error
217
- - Malformed plan: Warn but continue, treat as no plan
218
- - Update failures: Log but don't block task completion
219
- - Parse errors: Fallback to basic text search
@@ -1,297 +0,0 @@
1
- workflow:
2
- id: brownfield-fullstack
3
- name: Brownfield Full-Stack Enhancement
4
- description: >-
5
- Agent workflow for enhancing existing full-stack applications with new features,
6
- modernization, or significant changes. Handles existing system analysis and safe integration.
7
- type: brownfield
8
- project_types:
9
- - feature-addition
10
- - refactoring
11
- - modernization
12
- - integration-enhancement
13
-
14
- sequence:
15
- - step: enhancement_classification
16
- agent: analyst
17
- action: classify enhancement scope
18
- notes: |
19
- Determine enhancement complexity to route to appropriate path:
20
- - Single story (< 4 hours) → Use brownfield-create-story task
21
- - Small feature (1-3 stories) → Use brownfield-create-epic task
22
- - Major enhancement (multiple epics) → Continue with full workflow
23
-
24
- Ask user: "Can you describe the enhancement scope? Is this a small fix, a feature addition, or a major enhancement requiring architectural changes?"
25
-
26
- - step: routing_decision
27
- condition: based_on_classification
28
- routes:
29
- single_story:
30
- agent: pm
31
- uses: brownfield-create-story
32
- notes: "Create single story for immediate implementation. Exit workflow after story creation."
33
- small_feature:
34
- agent: pm
35
- uses: brownfield-create-epic
36
- notes: "Create focused epic with 1-3 stories. Exit workflow after epic creation."
37
- major_enhancement:
38
- continue: to_next_step
39
- notes: "Continue with comprehensive planning workflow below."
40
-
41
- - step: documentation_check
42
- agent: analyst
43
- action: check existing documentation
44
- condition: major_enhancement_path
45
- notes: |
46
- Check if adequate project documentation exists:
47
- - Look for existing architecture docs, API specs, coding standards
48
- - Assess if documentation is current and comprehensive
49
- - If adequate: Skip document-project, proceed to PRD
50
- - If inadequate: Run document-project first
51
-
52
- - step: project_analysis
53
- agent: architect
54
- action: analyze existing project and use task document-project
55
- creates: brownfield-architecture.md (or multiple documents)
56
- condition: documentation_inadequate
57
- notes: "Run document-project to capture current system state, technical debt, and constraints. Pass findings to PRD creation."
58
-
59
- - agent: pm
60
- creates: prd.md
61
- uses: brownfield-prd-tmpl
62
- requires: existing_documentation_or_analysis
63
- notes: |
64
- Creates PRD for major enhancement. If document-project was run, reference its output to avoid re-analysis.
65
- If skipped, use existing project documentation.
66
- SAVE OUTPUT: Copy final prd.md to your project's docs/ folder.
67
-
68
- - step: architecture_decision
69
- agent: pm/architect
70
- action: determine if architecture document needed
71
- condition: after_prd_creation
72
- notes: |
73
- Review PRD to determine if architectural planning is needed:
74
- - New architectural patterns → Create architecture doc
75
- - New libraries/frameworks → Create architecture doc
76
- - Platform/infrastructure changes → Create architecture doc
77
- - Following existing patterns → Skip to story creation
78
-
79
- - agent: architect
80
- creates: architecture.md
81
- uses: brownfield-architecture-tmpl
82
- requires: prd.md
83
- condition: architecture_changes_needed
84
- notes: "Creates architecture ONLY for significant architectural changes. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
85
-
86
- - agent: po
87
- validates: all_artifacts
88
- uses: po-master-checklist
89
- notes: "Validates all documents for integration safety and completeness. May require updates to any document."
90
-
91
- - agent: various
92
- updates: any_flagged_documents
93
- condition: po_checklist_issues
94
- notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
95
-
96
- - agent: po
97
- action: shard_documents
98
- creates: sharded_docs
99
- requires: all_artifacts_in_project
100
- notes: |
101
- Shard documents for IDE development:
102
- - Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
103
- - Option B: Manual: Drag shard-doc task + docs/prd.md into chat
104
- - Creates docs/prd/ and docs/architecture/ folders with sharded content
105
-
106
- - agent: sm
107
- action: create_story
108
- creates: story.md
109
- requires: sharded_docs_or_brownfield_docs
110
- repeats: for_each_epic_or_enhancement
111
- notes: |
112
- Story creation cycle:
113
- - For sharded PRD: @sm → *create (uses create-next-story)
114
- - For brownfield docs: @sm → use create-brownfield-story task
115
- - Creates story from available documentation
116
- - Story starts in "Draft" status
117
- - May require additional context gathering for brownfield
118
-
119
- - agent: analyst/pm
120
- action: review_draft_story
121
- updates: story.md
122
- requires: story.md
123
- optional: true
124
- condition: user_wants_story_review
125
- notes: |
126
- OPTIONAL: Review and approve draft story
127
- - NOTE: story-review task coming soon
128
- - Review story completeness and alignment
129
- - Update story status: Draft → Approved
130
-
131
- - agent: dev
132
- action: implement_story
133
- creates: implementation_files
134
- requires: story.md
135
- notes: |
136
- Dev Agent (New Chat): @dev
137
- - Implements approved story
138
- - Updates File List with all changes
139
- - Marks story as "Review" when complete
140
-
141
- - agent: qa
142
- action: review_implementation
143
- updates: implementation_files
144
- requires: implementation_files
145
- optional: true
146
- notes: |
147
- OPTIONAL: QA Agent (New Chat): @qa → review-story
148
- - Senior dev review with refactoring ability
149
- - Fixes small issues directly
150
- - Leaves checklist for remaining items
151
- - Updates story status (Review → Done or stays Review)
152
-
153
- - agent: dev
154
- action: address_qa_feedback
155
- updates: implementation_files
156
- condition: qa_left_unchecked_items
157
- notes: |
158
- If QA left unchecked items:
159
- - Dev Agent (New Chat): Address remaining items
160
- - Return to QA for final approval
161
-
162
- - repeat_development_cycle:
163
- action: continue_for_all_stories
164
- notes: |
165
- Repeat story cycle (SM → Dev → QA) for all epic stories
166
- Continue until all stories in PRD are complete
167
-
168
- - agent: po
169
- action: epic_retrospective
170
- creates: epic-retrospective.md
171
- condition: epic_complete
172
- optional: true
173
- notes: |
174
- OPTIONAL: After epic completion
175
- - NOTE: epic-retrospective task coming soon
176
- - Validate epic was completed correctly
177
- - Document learnings and improvements
178
-
179
- - workflow_end:
180
- action: project_complete
181
- notes: |
182
- All stories implemented and reviewed!
183
- Project development phase complete.
184
-
185
- Reference: data#bmad-kb:IDE Development Workflow
186
-
187
- flow_diagram: |
188
- ```mermaid
189
- graph TD
190
- A[Start: Brownfield Enhancement] --> B[analyst: classify enhancement scope]
191
- B --> C{Enhancement Size?}
192
-
193
- C -->|Single Story| D[pm: brownfield-create-story]
194
- C -->|1-3 Stories| E[pm: brownfield-create-epic]
195
- C -->|Major Enhancement| F[analyst: check documentation]
196
-
197
- D --> END1[To Dev Implementation]
198
- E --> END2[To Story Creation]
199
-
200
- F --> G{Docs Adequate?}
201
- G -->|No| H[architect: document-project]
202
- G -->|Yes| I[pm: brownfield PRD]
203
- H --> I
204
-
205
- I --> J{Architecture Needed?}
206
- J -->|Yes| K[architect: architecture.md]
207
- J -->|No| L[po: validate artifacts]
208
- K --> L
209
-
210
- L --> M{PO finds issues?}
211
- M -->|Yes| N[Fix issues]
212
- M -->|No| O[po: shard documents]
213
- N --> L
214
-
215
- O --> P[sm: create story]
216
- P --> Q{Story Type?}
217
- Q -->|Sharded PRD| R[create-next-story]
218
- Q -->|Brownfield Docs| S[create-brownfield-story]
219
-
220
- R --> T{Review draft?}
221
- S --> T
222
- T -->|Yes| U[review & approve]
223
- T -->|No| V[dev: implement]
224
- U --> V
225
-
226
- V --> W{QA review?}
227
- W -->|Yes| X[qa: review]
228
- W -->|No| Y{More stories?}
229
- X --> Z{Issues?}
230
- Z -->|Yes| AA[dev: fix]
231
- Z -->|No| Y
232
- AA --> X
233
- Y -->|Yes| P
234
- Y -->|No| AB{Retrospective?}
235
- AB -->|Yes| AC[po: retrospective]
236
- AB -->|No| AD[Complete]
237
- AC --> AD
238
-
239
- style AD fill:#90EE90
240
- style END1 fill:#90EE90
241
- style END2 fill:#90EE90
242
- style D fill:#87CEEB
243
- style E fill:#87CEEB
244
- style I fill:#FFE4B5
245
- style K fill:#FFE4B5
246
- style O fill:#ADD8E6
247
- style P fill:#ADD8E6
248
- style V fill:#ADD8E6
249
- style U fill:#F0E68C
250
- style X fill:#F0E68C
251
- style AC fill:#F0E68C
252
- ```
253
-
254
- decision_guidance:
255
- when_to_use:
256
- - Enhancement requires coordinated stories
257
- - Architectural changes are needed
258
- - Significant integration work required
259
- - Risk assessment and mitigation planning necessary
260
- - Multiple team members will work on related changes
261
-
262
- handoff_prompts:
263
- classification_complete: |
264
- Enhancement classified as: {{enhancement_type}}
265
- {{if single_story}}: Proceeding with brownfield-create-story task for immediate implementation.
266
- {{if small_feature}}: Creating focused epic with brownfield-create-epic task.
267
- {{if major_enhancement}}: Continuing with comprehensive planning workflow.
268
-
269
- documentation_assessment: |
270
- Documentation assessment complete:
271
- {{if adequate}}: Existing documentation is sufficient. Proceeding directly to PRD creation.
272
- {{if inadequate}}: Running document-project to capture current system state before PRD.
273
-
274
- document_project_to_pm: |
275
- Project analysis complete. Key findings documented in:
276
- - {{document_list}}
277
- Use these findings to inform PRD creation and avoid re-analyzing the same aspects.
278
-
279
- pm_to_architect_decision: |
280
- PRD complete and saved as docs/prd.md.
281
- Architectural changes identified: {{yes/no}}
282
- {{if yes}}: Proceeding to create architecture document for: {{specific_changes}}
283
- {{if no}}: No architectural changes needed. Proceeding to validation.
284
-
285
- architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
286
-
287
- po_to_sm: |
288
- All artifacts validated.
289
- Documentation type available: {{sharded_prd / brownfield_docs}}
290
- {{if sharded}}: Use standard create-next-story task.
291
- {{if brownfield}}: Use create-brownfield-story task to handle varied documentation formats.
292
-
293
- sm_story_creation: |
294
- Creating story from {{documentation_type}}.
295
- {{if missing_context}}: May need to gather additional context from user during story creation.
296
-
297
- complete: "All planning artifacts validated and development can begin. Stories will be created based on available documentation format."