bmad-method 5.1.2 → 6.0.0-alpha.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 (579) hide show
  1. package/.github/FUNDING.yaml +2 -2
  2. package/.github/ISSUE_TEMPLATE/config.yaml +1 -0
  3. package/.github/ISSUE_TEMPLATE/idea_submission.md +109 -0
  4. package/.github/workflows/discord.yaml +1 -10
  5. package/.github/workflows/format-check.yaml +3 -2
  6. package/.github/workflows/manual-release.yaml +2 -2
  7. package/.nvmrc +1 -0
  8. package/.vscode/settings.json +34 -9
  9. package/CHANGELOG.md +211 -577
  10. package/CONTRIBUTING.md +130 -60
  11. package/LICENSE +6 -1
  12. package/docs/codebase-flattener.md +19 -0
  13. package/docs/ide-info/auggie.md +31 -0
  14. package/docs/ide-info/claude-code.md +25 -0
  15. package/docs/ide-info/cline.md +31 -0
  16. package/docs/ide-info/codex.md +32 -0
  17. package/docs/ide-info/crush.md +30 -0
  18. package/docs/ide-info/cursor.md +25 -0
  19. package/docs/ide-info/gemini.md +25 -0
  20. package/docs/ide-info/github-copilot.md +26 -0
  21. package/docs/ide-info/iflow.md +33 -0
  22. package/docs/ide-info/kilo.md +24 -0
  23. package/docs/ide-info/qwen.md +25 -0
  24. package/docs/ide-info/roo.md +27 -0
  25. package/docs/ide-info/trae.md +25 -0
  26. package/docs/ide-info/windsurf.md +22 -0
  27. package/docs/installers-bundlers/ide-injections.md +196 -0
  28. package/docs/installers-bundlers/installers-modules-platforms-reference.md +355 -0
  29. package/docs/installers-bundlers/web-bundler-usage.md +54 -0
  30. package/eslint.config.mjs +17 -7
  31. package/package.json +26 -35
  32. package/prettier.config.mjs +1 -1
  33. package/readme.md +216 -0
  34. package/src/core/_module-installer/install-menu-config.yaml +24 -0
  35. package/src/core/_module-installer/installer.js +68 -0
  36. package/src/core/agents/bmad-master.md +27 -0
  37. package/src/core/agents/bmad-web-orchestrator.md +71 -0
  38. package/src/core/tasks/adv-elicit-methods.csv +39 -0
  39. package/src/core/tasks/adv-elicit.md +109 -0
  40. package/src/core/tasks/index-docs.md +69 -0
  41. package/src/core/tasks/shard-doc.md +57 -0
  42. package/src/core/tasks/validate-workflow.md +92 -0
  43. package/src/core/tasks/workflow.md +141 -0
  44. package/src/core/workflows/bmad-init/instructions.md +79 -0
  45. package/src/core/workflows/bmad-init/workflow.yaml +24 -0
  46. package/src/core/workflows/party-mode/instructions.md +181 -0
  47. package/src/core/workflows/party-mode/workflow.yaml +24 -0
  48. package/src/modules/bmb/_module-installer/install-menu-config.yaml +16 -0
  49. package/src/modules/bmb/agents/bmad-builder.md +30 -0
  50. package/src/modules/bmb/workflows/convert-legacy/README.md +262 -0
  51. package/src/modules/bmb/workflows/convert-legacy/checklist.md +204 -0
  52. package/src/modules/bmb/workflows/convert-legacy/instructions.md +328 -0
  53. package/src/modules/bmb/workflows/convert-legacy/workflow.yaml +35 -0
  54. package/src/modules/bmb/workflows/create-agent/README.md +268 -0
  55. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +412 -0
  56. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +757 -0
  57. package/src/modules/bmb/workflows/create-agent/agent-types.md +177 -0
  58. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +174 -0
  59. package/src/modules/bmb/workflows/create-agent/checklist.md +134 -0
  60. package/src/modules/bmb/workflows/create-agent/communication-styles.md +240 -0
  61. package/src/modules/bmb/workflows/create-agent/instructions.md +340 -0
  62. package/src/modules/bmb/workflows/create-agent/workflow.yaml +39 -0
  63. package/src/modules/bmb/workflows/create-module/README.md +218 -0
  64. package/src/modules/bmb/workflows/create-module/brainstorm-context.md +137 -0
  65. package/src/modules/bmb/workflows/create-module/checklist.md +245 -0
  66. package/src/modules/bmb/workflows/create-module/installer-templates/install-module-config.yaml +132 -0
  67. package/src/modules/bmb/workflows/create-module/installer-templates/installer.js +231 -0
  68. package/src/modules/bmb/workflows/create-module/instructions.md +509 -0
  69. package/src/modules/bmb/workflows/create-module/module-structure.md +310 -0
  70. package/src/modules/bmb/workflows/create-module/workflow.yaml +47 -0
  71. package/src/modules/bmb/workflows/create-workflow/README.md +216 -0
  72. package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md +197 -0
  73. package/src/modules/bmb/workflows/create-workflow/checklist.md +72 -0
  74. package/src/modules/bmb/workflows/create-workflow/instructions.md +267 -0
  75. package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +456 -0
  76. package/src/modules/bmb/workflows/create-workflow/workflow-template/checklist.md +24 -0
  77. package/src/modules/bmb/workflows/create-workflow/workflow-template/instructions.md +12 -0
  78. package/src/modules/bmb/workflows/create-workflow/workflow-template/template.md +9 -0
  79. package/src/modules/bmb/workflows/create-workflow/workflow-template/workflow.yaml +35 -0
  80. package/src/modules/bmb/workflows/create-workflow/workflow.yaml +42 -0
  81. package/src/modules/bmb/workflows/edit-workflow/README.md +63 -0
  82. package/src/modules/bmb/workflows/edit-workflow/checklist.md +70 -0
  83. package/src/modules/bmb/workflows/edit-workflow/instructions.md +170 -0
  84. package/src/modules/bmb/workflows/edit-workflow/workflow.yaml +34 -0
  85. package/src/modules/bmb/workflows/module-brief/README.md +264 -0
  86. package/src/modules/bmb/workflows/module-brief/checklist.md +116 -0
  87. package/src/modules/bmb/workflows/module-brief/instructions.md +265 -0
  88. package/src/modules/bmb/workflows/module-brief/template.md +275 -0
  89. package/src/modules/bmb/workflows/module-brief/workflow.yaml +30 -0
  90. package/src/modules/bmb/workflows/redoc/README.md +87 -0
  91. package/src/modules/bmb/workflows/redoc/checklist.md +99 -0
  92. package/src/modules/bmb/workflows/redoc/instructions.md +255 -0
  93. package/src/modules/bmb/workflows/redoc/workflow.yaml +33 -0
  94. package/src/modules/bmm/_module-installer/assets/bmm-kb.md +1 -0
  95. package/src/modules/bmm/_module-installer/assets/technical-decisions-template.md +30 -0
  96. package/src/modules/bmm/_module-installer/install-menu-config.yaml +49 -0
  97. package/src/modules/bmm/_module-installer/installer.js +131 -0
  98. package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
  99. package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
  100. package/src/modules/bmm/agents/analyst.md +26 -0
  101. package/src/modules/bmm/agents/architect.md +29 -0
  102. package/src/modules/bmm/agents/dev.md +61 -0
  103. package/src/modules/bmm/agents/game-architect.md +26 -0
  104. package/src/modules/bmm/agents/game-designer.md +27 -0
  105. package/src/modules/bmm/agents/game-dev.md +28 -0
  106. package/src/modules/bmm/agents/pm.md +26 -0
  107. package/src/modules/bmm/agents/po.md +25 -0
  108. package/src/modules/bmm/agents/sm.md +29 -0
  109. package/src/modules/bmm/agents/tea.md +32 -0
  110. package/src/modules/bmm/agents/ux-expert.md +24 -0
  111. package/src/modules/bmm/sub-modules/claude-code/config.yaml +5 -0
  112. package/src/modules/bmm/sub-modules/claude-code/injections.yaml +242 -0
  113. package/src/modules/bmm/sub-modules/claude-code/readme.md +87 -0
  114. package/src/modules/bmm/sub-modules/claude-code/sub-agents/api-documenter.md +85 -0
  115. package/src/modules/bmm/sub-modules/claude-code/sub-agents/codebase-analyzer.md +64 -0
  116. package/src/modules/bmm/sub-modules/claude-code/sub-agents/data-analyst.md +84 -0
  117. package/src/modules/bmm/sub-modules/claude-code/sub-agents/dependency-mapper.md +67 -0
  118. package/src/modules/bmm/sub-modules/claude-code/sub-agents/document-reviewer.md +85 -0
  119. package/src/modules/bmm/sub-modules/claude-code/sub-agents/epic-optimizer.md +66 -0
  120. package/src/modules/bmm/sub-modules/claude-code/sub-agents/market-researcher.md +34 -0
  121. package/src/modules/bmm/sub-modules/claude-code/sub-agents/pattern-detector.md +67 -0
  122. package/src/modules/bmm/sub-modules/claude-code/sub-agents/requirements-analyst.md +61 -0
  123. package/src/modules/bmm/sub-modules/claude-code/sub-agents/tech-debt-auditor.md +89 -0
  124. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-decisions-curator.md +146 -0
  125. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-evaluator.md +51 -0
  126. package/src/modules/bmm/sub-modules/claude-code/sub-agents/test-coverage-analyzer.md +91 -0
  127. package/src/modules/bmm/sub-modules/claude-code/sub-agents/trend-spotter.md +99 -0
  128. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-journey-mapper.md +101 -0
  129. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-researcher.md +56 -0
  130. package/src/modules/bmm/tasks/daily-standup.md +91 -0
  131. package/src/modules/bmm/tasks/retrospective.md +110 -0
  132. package/src/modules/bmm/teams/team-all.yaml +7 -0
  133. package/src/modules/bmm/teams/team-dev.yaml +14 -0
  134. package/src/modules/bmm/teams/team-gamedev.yaml +9 -0
  135. package/src/modules/bmm/testarch/atdd.md +40 -0
  136. package/src/modules/bmm/testarch/automate.md +38 -0
  137. package/src/modules/bmm/testarch/ci.md +39 -0
  138. package/src/modules/bmm/testarch/framework.md +41 -0
  139. package/src/modules/bmm/testarch/nfr-assess.md +38 -0
  140. package/src/modules/bmm/testarch/risk-profile.md +38 -0
  141. package/src/modules/bmm/testarch/tea-commands.csv +11 -0
  142. package/src/modules/bmm/testarch/tea-gate.md +38 -0
  143. package/src/modules/bmm/testarch/tea-knowledge.md +275 -0
  144. package/src/modules/bmm/testarch/test-design.md +39 -0
  145. package/{bmad-core/data → src/modules/bmm/testarch}/test-levels-framework.md +2 -0
  146. package/{bmad-core/data → src/modules/bmm/testarch}/test-priorities-matrix.md +2 -0
  147. package/src/modules/bmm/testarch/trace-requirements.md +38 -0
  148. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-brain-methods.csv +26 -0
  149. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-context.md +115 -0
  150. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +47 -0
  151. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/workflow.yaml +22 -0
  152. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +38 -0
  153. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/project-context.md +25 -0
  154. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +21 -0
  155. package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +221 -0
  156. package/src/modules/bmm/workflows/1-analysis/game-brief/checklist.md +128 -0
  157. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +517 -0
  158. package/src/modules/bmm/workflows/1-analysis/game-brief/template.md +205 -0
  159. package/src/modules/bmm/workflows/1-analysis/game-brief/workflow.yaml +34 -0
  160. package/src/modules/bmm/workflows/1-analysis/product-brief/README.md +180 -0
  161. package/src/modules/bmm/workflows/1-analysis/product-brief/checklist.md +115 -0
  162. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +353 -0
  163. package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +165 -0
  164. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +33 -0
  165. package/src/modules/bmm/workflows/1-analysis/research/README.md +454 -0
  166. package/src/modules/bmm/workflows/1-analysis/research/checklist.md +202 -0
  167. package/src/modules/bmm/workflows/1-analysis/research/claude-code/injections.yaml +114 -0
  168. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +259 -0
  169. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +190 -0
  170. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +337 -0
  171. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +107 -0
  172. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +329 -0
  173. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +370 -0
  174. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +553 -0
  175. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +91 -0
  176. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +442 -0
  177. package/src/modules/bmm/workflows/1-analysis/research/template-deep-prompt.md +94 -0
  178. package/src/modules/bmm/workflows/1-analysis/research/template-market.md +311 -0
  179. package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +210 -0
  180. package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +149 -0
  181. package/src/modules/bmm/workflows/2-plan/README.md +203 -0
  182. package/src/modules/bmm/workflows/2-plan/checklist.md +369 -0
  183. package/src/modules/bmm/workflows/2-plan/gdd/README.md +222 -0
  184. package/src/modules/bmm/workflows/2-plan/gdd/game-types/action-platformer.md +45 -0
  185. package/src/modules/bmm/workflows/2-plan/gdd/game-types/adventure.md +84 -0
  186. package/src/modules/bmm/workflows/2-plan/gdd/game-types/card-game.md +76 -0
  187. package/src/modules/bmm/workflows/2-plan/gdd/game-types/fighting.md +89 -0
  188. package/src/modules/bmm/workflows/2-plan/gdd/game-types/horror.md +86 -0
  189. package/src/modules/bmm/workflows/2-plan/gdd/game-types/idle-incremental.md +78 -0
  190. package/src/modules/bmm/workflows/2-plan/gdd/game-types/metroidvania.md +87 -0
  191. package/src/modules/bmm/workflows/2-plan/gdd/game-types/moba.md +74 -0
  192. package/src/modules/bmm/workflows/2-plan/gdd/game-types/party-game.md +79 -0
  193. package/src/modules/bmm/workflows/2-plan/gdd/game-types/puzzle.md +58 -0
  194. package/src/modules/bmm/workflows/2-plan/gdd/game-types/racing.md +88 -0
  195. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rhythm.md +79 -0
  196. package/src/modules/bmm/workflows/2-plan/gdd/game-types/roguelike.md +69 -0
  197. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rpg.md +70 -0
  198. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sandbox.md +79 -0
  199. package/src/modules/bmm/workflows/2-plan/gdd/game-types/shooter.md +62 -0
  200. package/src/modules/bmm/workflows/2-plan/gdd/game-types/simulation.md +73 -0
  201. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sports.md +75 -0
  202. package/src/modules/bmm/workflows/2-plan/gdd/game-types/strategy.md +71 -0
  203. package/src/modules/bmm/workflows/2-plan/gdd/game-types/survival.md +79 -0
  204. package/src/modules/bmm/workflows/2-plan/gdd/game-types/text-based.md +91 -0
  205. package/src/modules/bmm/workflows/2-plan/gdd/game-types/tower-defense.md +79 -0
  206. package/src/modules/bmm/workflows/2-plan/gdd/game-types/turn-based-tactics.md +88 -0
  207. package/src/modules/bmm/workflows/2-plan/gdd/game-types/visual-novel.md +89 -0
  208. package/src/modules/bmm/workflows/2-plan/gdd/game-types.csv +25 -0
  209. package/src/modules/bmm/workflows/2-plan/gdd/gdd-template.md +159 -0
  210. package/src/modules/bmm/workflows/2-plan/gdd/instructions-gdd.md +480 -0
  211. package/src/modules/bmm/workflows/2-plan/instructions-router.md +222 -0
  212. package/src/modules/bmm/workflows/2-plan/narrative/instructions-narrative.md +517 -0
  213. package/src/modules/bmm/workflows/2-plan/narrative/narrative-template.md +195 -0
  214. package/src/modules/bmm/workflows/2-plan/prd/analysis-template.md +53 -0
  215. package/src/modules/bmm/workflows/2-plan/prd/epics-template.md +18 -0
  216. package/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md +267 -0
  217. package/src/modules/bmm/workflows/2-plan/prd/instructions-med.md +251 -0
  218. package/src/modules/bmm/workflows/2-plan/prd/prd-template.md +73 -0
  219. package/src/modules/bmm/workflows/2-plan/tech-spec/instructions-sm.md +137 -0
  220. package/src/modules/bmm/workflows/2-plan/tech-spec/tech-spec-template.md +59 -0
  221. package/src/modules/bmm/workflows/2-plan/ux/instructions-ux.md +360 -0
  222. package/src/modules/bmm/workflows/2-plan/ux/ux-spec-template.md +162 -0
  223. package/src/modules/bmm/workflows/2-plan/workflow.yaml +60 -0
  224. package/src/modules/bmm/workflows/3-solutioning/ADR-template.md +74 -0
  225. package/src/modules/bmm/workflows/3-solutioning/README.md +565 -0
  226. package/src/modules/bmm/workflows/3-solutioning/checklist.md +170 -0
  227. package/src/modules/bmm/workflows/3-solutioning/instructions.md +661 -0
  228. package/src/modules/bmm/workflows/3-solutioning/project-types/backend-questions.md +490 -0
  229. package/src/modules/bmm/workflows/3-solutioning/project-types/cli-questions.md +337 -0
  230. package/src/modules/bmm/workflows/3-solutioning/project-types/data-questions.md +472 -0
  231. package/src/modules/bmm/workflows/3-solutioning/project-types/desktop-questions.md +299 -0
  232. package/src/modules/bmm/workflows/3-solutioning/project-types/embedded-questions.md +118 -0
  233. package/src/modules/bmm/workflows/3-solutioning/project-types/extension-questions.md +374 -0
  234. package/src/modules/bmm/workflows/3-solutioning/project-types/game-questions.md +133 -0
  235. package/src/modules/bmm/workflows/3-solutioning/project-types/infra-questions.md +484 -0
  236. package/src/modules/bmm/workflows/3-solutioning/project-types/library-questions.md +146 -0
  237. package/src/modules/bmm/workflows/3-solutioning/project-types/mobile-questions.md +110 -0
  238. package/src/modules/bmm/workflows/3-solutioning/project-types/project-types.csv +12 -0
  239. package/src/modules/bmm/workflows/3-solutioning/project-types/web-questions.md +136 -0
  240. package/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md +195 -0
  241. package/src/modules/bmm/workflows/3-solutioning/tech-spec/checklist.md +17 -0
  242. package/src/modules/bmm/workflows/3-solutioning/tech-spec/instructions.md +73 -0
  243. package/src/modules/bmm/workflows/3-solutioning/tech-spec/template.md +76 -0
  244. package/src/modules/bmm/workflows/3-solutioning/tech-spec/workflow.yaml +51 -0
  245. package/src/modules/bmm/workflows/3-solutioning/templates/backend-service-architecture.md +66 -0
  246. package/src/modules/bmm/workflows/3-solutioning/templates/cli-tool-architecture.md +66 -0
  247. package/src/modules/bmm/workflows/3-solutioning/templates/data-pipeline-architecture.md +66 -0
  248. package/src/modules/bmm/workflows/3-solutioning/templates/desktop-app-architecture.md +66 -0
  249. package/src/modules/bmm/workflows/3-solutioning/templates/embedded-firmware-architecture.md +66 -0
  250. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-architecture.md +244 -0
  251. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-godot-guide.md +428 -0
  252. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-unity-guide.md +333 -0
  253. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-web-guide.md +528 -0
  254. package/src/modules/bmm/workflows/3-solutioning/templates/infrastructure-architecture.md +66 -0
  255. package/src/modules/bmm/workflows/3-solutioning/templates/library-package-architecture.md +66 -0
  256. package/src/modules/bmm/workflows/3-solutioning/templates/mobile-app-architecture.md +66 -0
  257. package/src/modules/bmm/workflows/3-solutioning/templates/registry.csv +172 -0
  258. package/src/modules/bmm/workflows/3-solutioning/templates/web-api-architecture.md +66 -0
  259. package/src/modules/bmm/workflows/3-solutioning/templates/web-fullstack-architecture.md +277 -0
  260. package/src/modules/bmm/workflows/3-solutioning/workflow.yaml +65 -0
  261. package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
  262. package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +190 -0
  263. package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +35 -0
  264. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +42 -0
  265. package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +39 -0
  266. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +81 -0
  267. package/src/modules/bmm/workflows/4-implementation/create-story/template.md +57 -0
  268. package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +72 -0
  269. package/src/modules/bmm/workflows/4-implementation/dev-story/README.md +84 -0
  270. package/src/modules/bmm/workflows/4-implementation/dev-story/checklist.md +38 -0
  271. package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.md +87 -0
  272. package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +53 -0
  273. package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +391 -0
  274. package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +41 -0
  275. package/src/modules/bmm/workflows/4-implementation/review-story/README.md +72 -0
  276. package/src/modules/bmm/workflows/4-implementation/review-story/backlog_template.md +12 -0
  277. package/src/modules/bmm/workflows/4-implementation/review-story/checklist.md +22 -0
  278. package/src/modules/bmm/workflows/4-implementation/review-story/instructions.md +176 -0
  279. package/src/modules/bmm/workflows/4-implementation/review-story/workflow.yaml +99 -0
  280. package/src/modules/bmm/workflows/4-implementation/story-context/README.md +234 -0
  281. package/src/modules/bmm/workflows/4-implementation/story-context/checklist.md +16 -0
  282. package/src/modules/bmm/workflows/4-implementation/story-context/context-template.xml +34 -0
  283. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +76 -0
  284. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +56 -0
  285. package/src/modules/cis/_module-installer/install-menu-config.yaml +14 -0
  286. package/src/modules/cis/_module-installer/installer.js +92 -0
  287. package/src/modules/cis/agents/README.md +104 -0
  288. package/src/modules/cis/agents/brainstorming-coach.md +24 -0
  289. package/src/modules/cis/agents/creative-problem-solver.md +24 -0
  290. package/src/modules/cis/agents/design-thinking-coach.md +24 -0
  291. package/src/modules/cis/agents/innovation-strategist.md +24 -0
  292. package/src/modules/cis/agents/storyteller.md +24 -0
  293. package/src/modules/cis/readme.md +86 -0
  294. package/src/modules/cis/teams/creative-squad.yaml +6 -0
  295. package/src/modules/cis/workflows/README.md +67 -0
  296. package/src/modules/cis/workflows/brainstorming/README.md +271 -0
  297. package/src/modules/cis/workflows/brainstorming/brain-methods.csv +36 -0
  298. package/src/modules/cis/workflows/brainstorming/instructions.md +310 -0
  299. package/src/modules/cis/workflows/brainstorming/template.md +102 -0
  300. package/src/modules/cis/workflows/brainstorming/workflow.yaml +30 -0
  301. package/src/modules/cis/workflows/design-thinking/README.md +56 -0
  302. package/src/modules/cis/workflows/design-thinking/design-methods.csv +31 -0
  303. package/src/modules/cis/workflows/design-thinking/instructions.md +200 -0
  304. package/src/modules/cis/workflows/design-thinking/template.md +111 -0
  305. package/src/modules/cis/workflows/design-thinking/workflow.yaml +29 -0
  306. package/src/modules/cis/workflows/innovation-strategy/README.md +56 -0
  307. package/src/modules/cis/workflows/innovation-strategy/innovation-frameworks.csv +31 -0
  308. package/src/modules/cis/workflows/innovation-strategy/instructions.md +274 -0
  309. package/src/modules/cis/workflows/innovation-strategy/template.md +189 -0
  310. package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +29 -0
  311. package/src/modules/cis/workflows/problem-solving/README.md +56 -0
  312. package/src/modules/cis/workflows/problem-solving/instructions.md +250 -0
  313. package/src/modules/cis/workflows/problem-solving/solving-methods.csv +31 -0
  314. package/src/modules/cis/workflows/problem-solving/template.md +165 -0
  315. package/src/modules/cis/workflows/problem-solving/workflow.yaml +29 -0
  316. package/src/modules/cis/workflows/storytelling/README.md +58 -0
  317. package/src/modules/cis/workflows/storytelling/instructions.md +275 -0
  318. package/src/modules/cis/workflows/storytelling/story-types.csv +26 -0
  319. package/src/modules/cis/workflows/storytelling/template.md +113 -0
  320. package/src/modules/cis/workflows/storytelling/workflow.yaml +29 -0
  321. package/src/utility/models/agent-activation-ide.xml +51 -0
  322. package/src/utility/models/agent-config-template.md +23 -0
  323. package/tools/cli/bmad-cli.js +42 -0
  324. package/tools/cli/bundlers/bundle-web.js +157 -0
  325. package/tools/cli/bundlers/test-analyst.js +28 -0
  326. package/tools/cli/bundlers/test-bundler.js +118 -0
  327. package/tools/cli/bundlers/web-bundler.js +880 -0
  328. package/tools/cli/commands/install.js +41 -0
  329. package/tools/cli/commands/list.js +28 -0
  330. package/tools/cli/commands/status.js +47 -0
  331. package/tools/cli/commands/uninstall.js +44 -0
  332. package/tools/cli/commands/update.js +28 -0
  333. package/tools/cli/installers/lib/core/config-collector.js +383 -0
  334. package/tools/cli/installers/lib/core/dependency-resolver.js +721 -0
  335. package/tools/cli/installers/lib/core/detector.js +208 -0
  336. package/tools/cli/installers/lib/core/installer.js +1070 -0
  337. package/tools/cli/installers/lib/core/manifest-generator.js +385 -0
  338. package/tools/cli/installers/lib/core/manifest.js +484 -0
  339. package/tools/cli/installers/lib/ide/_base-ide.js +281 -0
  340. package/tools/cli/installers/lib/ide/auggie.js +271 -0
  341. package/tools/cli/installers/lib/ide/claude-code.js +625 -0
  342. package/tools/cli/installers/lib/ide/cline.js +301 -0
  343. package/tools/cli/installers/lib/ide/codex.js +267 -0
  344. package/tools/cli/installers/lib/ide/crush.js +204 -0
  345. package/tools/cli/installers/lib/ide/cursor.js +224 -0
  346. package/tools/cli/installers/lib/ide/gemini.js +160 -0
  347. package/tools/cli/installers/lib/ide/github-copilot.js +289 -0
  348. package/tools/cli/installers/lib/ide/iflow.js +142 -0
  349. package/tools/cli/installers/lib/ide/kilo.js +171 -0
  350. package/tools/cli/installers/lib/ide/manager.js +203 -0
  351. package/tools/cli/installers/lib/ide/qwen.js +188 -0
  352. package/tools/cli/installers/lib/ide/roo.js +288 -0
  353. package/tools/cli/installers/lib/ide/trae.js +182 -0
  354. package/tools/cli/installers/lib/ide/windsurf.js +149 -0
  355. package/tools/cli/installers/lib/ide/workflow-command-generator.js +162 -0
  356. package/tools/cli/installers/lib/ide/workflow-command-template.md +11 -0
  357. package/tools/cli/installers/lib/modules/manager.js +452 -0
  358. package/tools/cli/lib/agent-party-generator.js +206 -0
  359. package/tools/cli/lib/cli-utils.js +208 -0
  360. package/tools/cli/lib/config.js +210 -0
  361. package/tools/cli/lib/file-ops.js +204 -0
  362. package/tools/cli/lib/platform-codes.js +116 -0
  363. package/tools/cli/lib/project-root.js +71 -0
  364. package/tools/cli/lib/replace-project-root.js +239 -0
  365. package/tools/cli/lib/ui.js +516 -0
  366. package/tools/cli/lib/xml-handler.js +183 -0
  367. package/tools/cli/lib/xml-to-markdown.js +82 -0
  368. package/tools/{yaml-format.js → cli/lib/yaml-format.js} +3 -10
  369. package/tools/cli/regenerate-manifests.js +28 -0
  370. package/tools/flattener/ignoreRules.js +2 -6
  371. package/tools/flattener/main.js +31 -121
  372. package/tools/flattener/projectRoot.js +3 -8
  373. package/tools/flattener/stats.helpers.js +8 -35
  374. package/tools/flattener/stats.js +1 -6
  375. package/tools/flattener/test-matrix.js +1 -5
  376. package/tools/platform-codes.yaml +127 -0
  377. package/tools/test-agents/captain-kirk-commander.md +110 -0
  378. package/tools/test-agents/data-operations-android.md +123 -0
  379. package/tools/test-agents/geordi-chief-engineer.md +135 -0
  380. package/tools/test-agents/isabella-martinez-ethicist.md +109 -0
  381. package/tools/test-agents/marcus-thompson-security.md +109 -0
  382. package/tools/test-agents/maya-patel-pragmatist.md +82 -0
  383. package/tools/test-agents/picard-diplomat-captain.md +134 -0
  384. package/tools/test-agents/spock-science-officer.md +124 -0
  385. package/tools/test-agents/william-smithers-technocrat.md +71 -0
  386. package/tools/test-agents/zara-chen-designer.md +94 -0
  387. package/tools/validate-bundles.js +87 -0
  388. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
  389. package/README.md +0 -221
  390. package/bmad-core/agent-teams/team-all.yaml +0 -14
  391. package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
  392. package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
  393. package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
  394. package/bmad-core/agents/analyst.md +0 -81
  395. package/bmad-core/agents/architect.md +0 -83
  396. package/bmad-core/agents/bmad-master.md +0 -107
  397. package/bmad-core/agents/bmad-orchestrator.md +0 -149
  398. package/bmad-core/agents/dev.md +0 -75
  399. package/bmad-core/agents/pm.md +0 -81
  400. package/bmad-core/agents/po.md +0 -76
  401. package/bmad-core/agents/qa.md +0 -88
  402. package/bmad-core/agents/sm.md +0 -62
  403. package/bmad-core/agents/ux-expert.md +0 -66
  404. package/bmad-core/checklists/architect-checklist.md +0 -438
  405. package/bmad-core/checklists/change-checklist.md +0 -182
  406. package/bmad-core/checklists/pm-checklist.md +0 -370
  407. package/bmad-core/checklists/po-master-checklist.md +0 -432
  408. package/bmad-core/checklists/story-dod-checklist.md +0 -94
  409. package/bmad-core/checklists/story-draft-checklist.md +0 -153
  410. package/bmad-core/core-config.yaml +0 -20
  411. package/bmad-core/data/bmad-kb.md +0 -806
  412. package/bmad-core/data/brainstorming-techniques.md +0 -36
  413. package/bmad-core/data/elicitation-methods.md +0 -154
  414. package/bmad-core/data/technical-preferences.md +0 -3
  415. package/bmad-core/tasks/advanced-elicitation.md +0 -117
  416. package/bmad-core/tasks/brownfield-create-epic.md +0 -160
  417. package/bmad-core/tasks/brownfield-create-story.md +0 -147
  418. package/bmad-core/tasks/correct-course.md +0 -70
  419. package/bmad-core/tasks/create-brownfield-story.md +0 -312
  420. package/bmad-core/tasks/create-deep-research-prompt.md +0 -278
  421. package/bmad-core/tasks/create-next-story.md +0 -112
  422. package/bmad-core/tasks/document-project.md +0 -343
  423. package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
  424. package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  425. package/bmad-core/tasks/index-docs.md +0 -173
  426. package/bmad-core/tasks/kb-mode-interaction.md +0 -75
  427. package/bmad-core/tasks/nfr-assess.md +0 -343
  428. package/bmad-core/tasks/qa-gate.md +0 -159
  429. package/bmad-core/tasks/review-story.md +0 -314
  430. package/bmad-core/tasks/risk-profile.md +0 -353
  431. package/bmad-core/tasks/shard-doc.md +0 -185
  432. package/bmad-core/tasks/test-design.md +0 -174
  433. package/bmad-core/tasks/trace-requirements.md +0 -264
  434. package/bmad-core/tasks/validate-next-story.md +0 -134
  435. package/bmad-core/templates/architecture-tmpl.yaml +0 -650
  436. package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  437. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
  438. package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
  439. package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -306
  440. package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -218
  441. package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
  442. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -823
  443. package/bmad-core/templates/market-research-tmpl.yaml +0 -252
  444. package/bmad-core/templates/prd-tmpl.yaml +0 -202
  445. package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
  446. package/bmad-core/templates/qa-gate-tmpl.yaml +0 -102
  447. package/bmad-core/templates/story-tmpl.yaml +0 -137
  448. package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
  449. package/bmad-core/workflows/brownfield-service.yaml +0 -187
  450. package/bmad-core/workflows/brownfield-ui.yaml +0 -197
  451. package/bmad-core/workflows/greenfield-fullstack.yaml +0 -240
  452. package/bmad-core/workflows/greenfield-service.yaml +0 -206
  453. package/bmad-core/workflows/greenfield-ui.yaml +0 -235
  454. package/common/tasks/create-doc.md +0 -101
  455. package/common/tasks/execute-checklist.md +0 -86
  456. package/common/utils/bmad-doc-template.md +0 -325
  457. package/common/utils/workflow-management.md +0 -69
  458. package/dist/agents/analyst.txt +0 -2889
  459. package/dist/agents/architect.txt +0 -3552
  460. package/dist/agents/bmad-master.txt +0 -8769
  461. package/dist/agents/bmad-orchestrator.txt +0 -1513
  462. package/dist/agents/dev.txt +0 -414
  463. package/dist/agents/pm.txt +0 -2204
  464. package/dist/agents/po.txt +0 -1346
  465. package/dist/agents/qa.txt +0 -1987
  466. package/dist/agents/sm.txt +0 -658
  467. package/dist/agents/ux-expert.txt +0 -694
  468. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2371
  469. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1620
  470. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -815
  471. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -10952
  472. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +0 -4012
  473. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +0 -3698
  474. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -450
  475. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +0 -973
  476. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +0 -15376
  477. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2075
  478. package/dist/teams/team-all.txt +0 -12682
  479. package/dist/teams/team-fullstack.txt +0 -10421
  480. package/dist/teams/team-ide-minimal.txt +0 -5103
  481. package/dist/teams/team-no-ui.txt +0 -8980
  482. package/docs/GUIDING-PRINCIPLES.md +0 -91
  483. package/docs/core-architecture.md +0 -219
  484. package/docs/enhanced-ide-development-workflow.md +0 -248
  485. package/docs/expansion-packs.md +0 -280
  486. package/docs/how-to-contribute-with-pull-requests.md +0 -158
  487. package/docs/user-guide.md +0 -504
  488. package/docs/versioning-and-releases.md +0 -147
  489. package/docs/versions.md +0 -48
  490. package/docs/working-in-the-brownfield.md +0 -597
  491. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
  492. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash copy.txt +0 -13
  493. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash.txt +0 -13
  494. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.2 Agent Development Kit Installation/1.2.2 - Basic Project Structure - txt.txt +0 -25
  495. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.1 - settings.py +0 -34
  496. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.2 - main.py - Base Application.py +0 -70
  497. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +0 -26
  498. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
  499. package/expansion-packs/README.md +0 -3
  500. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
  501. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -71
  502. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -78
  503. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -64
  504. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
  505. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
  506. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -8
  507. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -250
  508. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -647
  509. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -110
  510. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
  511. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -290
  512. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
  513. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
  514. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
  515. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
  516. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  517. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  518. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
  519. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +0 -14
  520. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +0 -80
  521. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +0 -77
  522. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +0 -78
  523. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +0 -65
  524. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -391
  525. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +0 -203
  526. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +0 -201
  527. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -124
  528. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +0 -6
  529. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -769
  530. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -586
  531. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -110
  532. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -141
  533. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +0 -184
  534. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -290
  535. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +0 -200
  536. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +0 -1030
  537. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +0 -356
  538. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +0 -705
  539. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +0 -256
  540. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  541. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  542. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +0 -175
  543. package/expansion-packs/bmad-infrastructure-devops/README.md +0 -147
  544. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +0 -71
  545. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +0 -484
  546. package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -9
  547. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -305
  548. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -159
  549. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -153
  550. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
  551. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
  552. package/release_notes.md +0 -32
  553. package/tools/bmad-npx-wrapper.js +0 -39
  554. package/tools/builders/web-builder.js +0 -675
  555. package/tools/bump-all-versions.js +0 -115
  556. package/tools/bump-expansion-version.js +0 -90
  557. package/tools/cli.js +0 -152
  558. package/tools/installer/README.md +0 -8
  559. package/tools/installer/bin/bmad.js +0 -585
  560. package/tools/installer/config/ide-agent-config.yaml +0 -58
  561. package/tools/installer/config/install.config.yaml +0 -123
  562. package/tools/installer/lib/config-loader.js +0 -257
  563. package/tools/installer/lib/file-manager.js +0 -389
  564. package/tools/installer/lib/ide-base-setup.js +0 -228
  565. package/tools/installer/lib/ide-setup.js +0 -1441
  566. package/tools/installer/lib/installer.js +0 -1995
  567. package/tools/installer/lib/memory-profiler.js +0 -225
  568. package/tools/installer/lib/module-manager.js +0 -114
  569. package/tools/installer/lib/resource-locator.js +0 -308
  570. package/tools/installer/package.json +0 -44
  571. package/tools/lib/dependency-resolver.js +0 -175
  572. package/tools/lib/yaml-utils.js +0 -29
  573. package/tools/md-assets/web-agent-startup-instructions.md +0 -39
  574. package/tools/preview-release-notes.js +0 -66
  575. package/tools/shared/bannerArt.js +0 -105
  576. package/tools/sync-installer-version.js +0 -32
  577. package/tools/update-expansion-version.js +0 -53
  578. package/tools/upgraders/v3-to-v4-upgrader.js +0 -672
  579. package/tools/version-bump.js +0 -94
@@ -1,2204 +0,0 @@
1
- # Web Agent Bundle Instructions
2
-
3
- You are now operating as a specialized AI agent from the BMad-Method framework. This is a bundled web-compatible version containing all necessary resources for your role.
4
-
5
- ## Important Instructions
6
-
7
- 1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
8
-
9
- 2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
10
-
11
- - `==================== START: .bmad-core/folder/filename.md ====================`
12
- - `==================== END: .bmad-core/folder/filename.md ====================`
13
-
14
- When you need to reference a resource mentioned in your instructions:
15
-
16
- - Look for the corresponding START/END tags
17
- - The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
18
- - If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
19
-
20
- **Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
21
-
22
- ```yaml
23
- dependencies:
24
- utils:
25
- - template-format
26
- tasks:
27
- - create-story
28
- ```
29
-
30
- These references map directly to bundle sections:
31
-
32
- - `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
33
- - `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
34
-
35
- 3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
36
-
37
- 4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
38
-
39
- ---
40
-
41
-
42
- ==================== START: .bmad-core/agents/pm.md ====================
43
- # pm
44
-
45
- CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
46
-
47
- ```yaml
48
- activation-instructions:
49
- - ONLY load dependency files when user selects them for execution via command or request of a task
50
- - The agent.customization field ALWAYS takes precedence over any conflicting instructions
51
- - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
52
- - STAY IN CHARACTER!
53
- agent:
54
- name: John
55
- id: pm
56
- title: Product Manager
57
- icon: 📋
58
- whenToUse: Use for creating PRDs, product strategy, feature prioritization, roadmap planning, and stakeholder communication
59
- persona:
60
- role: Investigative Product Strategist & Market-Savvy PM
61
- style: Analytical, inquisitive, data-driven, user-focused, pragmatic
62
- identity: Product Manager specialized in document creation and product research
63
- focus: Creating PRDs and other product documentation using templates
64
- core_principles:
65
- - Deeply understand "Why" - uncover root causes and motivations
66
- - Champion the user - maintain relentless focus on target user value
67
- - Data-informed decisions with strategic judgment
68
- - Ruthless prioritization & MVP focus
69
- - Clarity & precision in communication
70
- - Collaborative & iterative approach
71
- - Proactive risk identification
72
- - Strategic thinking & outcome-oriented
73
- commands:
74
- - help: Show numbered list of the following commands to allow selection
75
- - create-prd: run task create-doc.md with template prd-tmpl.yaml
76
- - create-brownfield-prd: run task create-doc.md with template brownfield-prd-tmpl.yaml
77
- - create-brownfield-epic: run task brownfield-create-epic.md
78
- - create-brownfield-story: run task brownfield-create-story.md
79
- - create-epic: Create epic for brownfield projects (task brownfield-create-epic)
80
- - create-story: Create user story from requirements (task brownfield-create-story)
81
- - doc-out: Output full document to current destination file
82
- - shard-prd: run the task shard-doc.md for the provided prd.md (ask if not found)
83
- - correct-course: execute the correct-course task
84
- - yolo: Toggle Yolo Mode
85
- - exit: Exit (confirm)
86
- dependencies:
87
- tasks:
88
- - create-doc.md
89
- - correct-course.md
90
- - create-deep-research-prompt.md
91
- - brownfield-create-epic.md
92
- - brownfield-create-story.md
93
- - execute-checklist.md
94
- - shard-doc.md
95
- templates:
96
- - prd-tmpl.yaml
97
- - brownfield-prd-tmpl.yaml
98
- checklists:
99
- - pm-checklist.md
100
- - change-checklist.md
101
- data:
102
- - technical-preferences.md
103
- ```
104
- ==================== END: .bmad-core/agents/pm.md ====================
105
-
106
- ==================== START: .bmad-core/tasks/create-doc.md ====================
107
- # Create Document from Template (YAML Driven)
108
-
109
- ## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
110
-
111
- **THIS IS AN EXECUTABLE WORKFLOW - NOT REFERENCE MATERIAL**
112
-
113
- When this task is invoked:
114
-
115
- 1. **DISABLE ALL EFFICIENCY OPTIMIZATIONS** - This workflow requires full user interaction
116
- 2. **MANDATORY STEP-BY-STEP EXECUTION** - Each section must be processed sequentially with user feedback
117
- 3. **ELICITATION IS REQUIRED** - When `elicit: true`, you MUST use the 1-9 format and wait for user response
118
- 4. **NO SHORTCUTS ALLOWED** - Complete documents cannot be created without following this workflow
119
-
120
- **VIOLATION INDICATOR:** If you create a complete document without user interaction, you have violated this workflow.
121
-
122
- ## Critical: Template Discovery
123
-
124
- If a YAML Template has not been provided, list all templates from .bmad-core/templates or ask the user to provide another.
125
-
126
- ## CRITICAL: Mandatory Elicitation Format
127
-
128
- **When `elicit: true`, this is a HARD STOP requiring user interaction:**
129
-
130
- **YOU MUST:**
131
-
132
- 1. Present section content
133
- 2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
134
- 3. **STOP and present numbered options 1-9:**
135
- - **Option 1:** Always "Proceed to next section"
136
- - **Options 2-9:** Select 8 methods from data/elicitation-methods
137
- - End with: "Select 1-9 or just type your question/feedback:"
138
- 4. **WAIT FOR USER RESPONSE** - Do not proceed until user selects option or provides feedback
139
-
140
- **WORKFLOW VIOLATION:** Creating content for elicit=true sections without user interaction violates this task.
141
-
142
- **NEVER ask yes/no questions or use any other format.**
143
-
144
- ## Processing Flow
145
-
146
- 1. **Parse YAML template** - Load template metadata and sections
147
- 2. **Set preferences** - Show current mode (Interactive), confirm output file
148
- 3. **Process each section:**
149
- - Skip if condition unmet
150
- - Check agent permissions (owner/editors) - note if section is restricted to specific agents
151
- - Draft content using section instruction
152
- - Present content + detailed rationale
153
- - **IF elicit: true** → MANDATORY 1-9 options format
154
- - Save to file if possible
155
- 4. **Continue until complete**
156
-
157
- ## Detailed Rationale Requirements
158
-
159
- When presenting section content, ALWAYS include rationale that explains:
160
-
161
- - Trade-offs and choices made (what was chosen over alternatives and why)
162
- - Key assumptions made during drafting
163
- - Interesting or questionable decisions that need user attention
164
- - Areas that might need validation
165
-
166
- ## Elicitation Results Flow
167
-
168
- After user selects elicitation method (2-9):
169
-
170
- 1. Execute method from data/elicitation-methods
171
- 2. Present results with insights
172
- 3. Offer options:
173
- - **1. Apply changes and update section**
174
- - **2. Return to elicitation menu**
175
- - **3. Ask any questions or engage further with this elicitation**
176
-
177
- ## Agent Permissions
178
-
179
- When processing sections with agent permission fields:
180
-
181
- - **owner**: Note which agent role initially creates/populates the section
182
- - **editors**: List agent roles allowed to modify the section
183
- - **readonly**: Mark sections that cannot be modified after creation
184
-
185
- **For sections with restricted access:**
186
-
187
- - Include a note in the generated document indicating the responsible agent
188
- - Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
189
-
190
- ## YOLO Mode
191
-
192
- User can type `#yolo` to toggle to YOLO mode (process all sections at once).
193
-
194
- ## CRITICAL REMINDERS
195
-
196
- **❌ NEVER:**
197
-
198
- - Ask yes/no questions for elicitation
199
- - Use any format other than 1-9 numbered options
200
- - Create new elicitation methods
201
-
202
- **✅ ALWAYS:**
203
-
204
- - Use exact 1-9 format when elicit: true
205
- - Select options 2-9 from data/elicitation-methods only
206
- - Provide detailed rationale explaining decisions
207
- - End with "Select 1-9 or just type your question/feedback:"
208
- ==================== END: .bmad-core/tasks/create-doc.md ====================
209
-
210
- ==================== START: .bmad-core/tasks/correct-course.md ====================
211
- # Correct Course Task
212
-
213
- ## Purpose
214
-
215
- - Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
216
- - Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
217
- - Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
218
- - Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
219
- - Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
220
- - Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
221
-
222
- ## Instructions
223
-
224
- ### 1. Initial Setup & Mode Selection
225
-
226
- - **Acknowledge Task & Inputs:**
227
- - Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
228
- - Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
229
- - Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
230
- - **Establish Interaction Mode:**
231
- - Ask the user their preferred interaction mode for this task:
232
- - **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
233
- - **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
234
- - Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
235
-
236
- ### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
237
-
238
- - Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
239
- - For each checklist item or logical group of items (depending on interaction mode):
240
- - Present the relevant prompt(s) or considerations from the checklist to the user.
241
- - Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
242
- - Discuss your findings for each item with the user.
243
- - Record the status of each checklist item (e.g., `[x] Addressed`, `[N/A]`, `[!] Further Action Needed`) and any pertinent notes or decisions.
244
- - Collaboratively agree on the "Recommended Path Forward" as prompted by Section 4 of the checklist.
245
-
246
- ### 3. Draft Proposed Changes (Iteratively or Batched)
247
-
248
- - Based on the completed checklist analysis (Sections 1-4) and the agreed "Recommended Path Forward" (excluding scenarios requiring fundamental replans that would necessitate immediate handoff to PM/Architect):
249
- - Identify the specific project artifacts that require updates (e.g., specific epics, user stories, PRD sections, architecture document components, diagrams).
250
- - **Draft the proposed changes directly and explicitly for each identified artifact.** Examples include:
251
- - Revising user story text, acceptance criteria, or priority.
252
- - Adding, removing, reordering, or splitting user stories within epics.
253
- - Proposing modified architecture diagram snippets (e.g., providing an updated Mermaid diagram block or a clear textual description of the change to an existing diagram).
254
- - Updating technology lists, configuration details, or specific sections within the PRD or architecture documents.
255
- - Drafting new, small supporting artifacts if necessary (e.g., a brief addendum for a specific decision).
256
- - If in "Incremental Mode," discuss and refine these proposed edits for each artifact or small group of related artifacts with the user as they are drafted.
257
- - If in "YOLO Mode," compile all drafted edits for presentation in the next step.
258
-
259
- ### 4. Generate "Sprint Change Proposal" with Edits
260
-
261
- - Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
262
- - The proposal must clearly present:
263
- - **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
264
- - **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
265
- - Present the complete draft of the "Sprint Change Proposal" to the user for final review and feedback. Incorporate any final adjustments requested by the user.
266
-
267
- ### 5. Finalize & Determine Next Steps
268
-
269
- - Obtain explicit user approval for the "Sprint Change Proposal," including all the specific edits documented within it.
270
- - Provide the finalized "Sprint Change Proposal" document to the user.
271
- - **Based on the nature of the approved changes:**
272
- - **If the approved edits sufficiently address the change and can be implemented directly or organized by a PO/SM:** State that the "Correct Course Task" is complete regarding analysis and change proposal, and the user can now proceed with implementing or logging these changes (e.g., updating actual project documents, backlog items). Suggest handoff to a PO/SM agent for backlog organization if appropriate.
273
- - **If the analysis and proposed path (as per checklist Section 4 and potentially Section 6) indicate that the change requires a more fundamental replan (e.g., significant scope change, major architectural rework):** Clearly state this conclusion. Advise the user that the next step involves engaging the primary PM or Architect agents, using the "Sprint Change Proposal" as critical input and context for that deeper replanning effort.
274
-
275
- ## Output Deliverables
276
-
277
- - **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
278
- - A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
279
- - Specific, clearly drafted proposed edits for all affected project artifacts.
280
- - **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
281
- ==================== END: .bmad-core/tasks/correct-course.md ====================
282
-
283
- ==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
284
- # Create Deep Research Prompt Task
285
-
286
- This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
287
-
288
- ## Purpose
289
-
290
- Generate well-structured research prompts that:
291
-
292
- - Define clear research objectives and scope
293
- - Specify appropriate research methodologies
294
- - Outline expected deliverables and formats
295
- - Guide systematic investigation of complex topics
296
- - Ensure actionable insights are captured
297
-
298
- ## Research Type Selection
299
-
300
- CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
301
-
302
- ### 1. Research Focus Options
303
-
304
- Present these numbered options to the user:
305
-
306
- 1. **Product Validation Research**
307
- - Validate product hypotheses and market fit
308
- - Test assumptions about user needs and solutions
309
- - Assess technical and business feasibility
310
- - Identify risks and mitigation strategies
311
-
312
- 2. **Market Opportunity Research**
313
- - Analyze market size and growth potential
314
- - Identify market segments and dynamics
315
- - Assess market entry strategies
316
- - Evaluate timing and market readiness
317
-
318
- 3. **User & Customer Research**
319
- - Deep dive into user personas and behaviors
320
- - Understand jobs-to-be-done and pain points
321
- - Map customer journeys and touchpoints
322
- - Analyze willingness to pay and value perception
323
-
324
- 4. **Competitive Intelligence Research**
325
- - Detailed competitor analysis and positioning
326
- - Feature and capability comparisons
327
- - Business model and strategy analysis
328
- - Identify competitive advantages and gaps
329
-
330
- 5. **Technology & Innovation Research**
331
- - Assess technology trends and possibilities
332
- - Evaluate technical approaches and architectures
333
- - Identify emerging technologies and disruptions
334
- - Analyze build vs. buy vs. partner options
335
-
336
- 6. **Industry & Ecosystem Research**
337
- - Map industry value chains and dynamics
338
- - Identify key players and relationships
339
- - Analyze regulatory and compliance factors
340
- - Understand partnership opportunities
341
-
342
- 7. **Strategic Options Research**
343
- - Evaluate different strategic directions
344
- - Assess business model alternatives
345
- - Analyze go-to-market strategies
346
- - Consider expansion and scaling paths
347
-
348
- 8. **Risk & Feasibility Research**
349
- - Identify and assess various risk factors
350
- - Evaluate implementation challenges
351
- - Analyze resource requirements
352
- - Consider regulatory and legal implications
353
-
354
- 9. **Custom Research Focus**
355
- - User-defined research objectives
356
- - Specialized domain investigation
357
- - Cross-functional research needs
358
-
359
- ### 2. Input Processing
360
-
361
- **If Project Brief provided:**
362
-
363
- - Extract key product concepts and goals
364
- - Identify target users and use cases
365
- - Note technical constraints and preferences
366
- - Highlight uncertainties and assumptions
367
-
368
- **If Brainstorming Results provided:**
369
-
370
- - Synthesize main ideas and themes
371
- - Identify areas needing validation
372
- - Extract hypotheses to test
373
- - Note creative directions to explore
374
-
375
- **If Market Research provided:**
376
-
377
- - Build on identified opportunities
378
- - Deepen specific market insights
379
- - Validate initial findings
380
- - Explore adjacent possibilities
381
-
382
- **If Starting Fresh:**
383
-
384
- - Gather essential context through questions
385
- - Define the problem space
386
- - Clarify research objectives
387
- - Establish success criteria
388
-
389
- ## Process
390
-
391
- ### 3. Research Prompt Structure
392
-
393
- CRITICAL: collaboratively develop a comprehensive research prompt with these components.
394
-
395
- #### A. Research Objectives
396
-
397
- CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
398
-
399
- - Primary research goal and purpose
400
- - Key decisions the research will inform
401
- - Success criteria for the research
402
- - Constraints and boundaries
403
-
404
- #### B. Research Questions
405
-
406
- CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
407
-
408
- **Core Questions:**
409
-
410
- - Central questions that must be answered
411
- - Priority ranking of questions
412
- - Dependencies between questions
413
-
414
- **Supporting Questions:**
415
-
416
- - Additional context-building questions
417
- - Nice-to-have insights
418
- - Future-looking considerations
419
-
420
- #### C. Research Methodology
421
-
422
- **Data Collection Methods:**
423
-
424
- - Secondary research sources
425
- - Primary research approaches (if applicable)
426
- - Data quality requirements
427
- - Source credibility criteria
428
-
429
- **Analysis Frameworks:**
430
-
431
- - Specific frameworks to apply
432
- - Comparison criteria
433
- - Evaluation methodologies
434
- - Synthesis approaches
435
-
436
- #### D. Output Requirements
437
-
438
- **Format Specifications:**
439
-
440
- - Executive summary requirements
441
- - Detailed findings structure
442
- - Visual/tabular presentations
443
- - Supporting documentation
444
-
445
- **Key Deliverables:**
446
-
447
- - Must-have sections and insights
448
- - Decision-support elements
449
- - Action-oriented recommendations
450
- - Risk and uncertainty documentation
451
-
452
- ### 4. Prompt Generation
453
-
454
- **Research Prompt Template:**
455
-
456
- ```markdown
457
- ## Research Objective
458
-
459
- [Clear statement of what this research aims to achieve]
460
-
461
- ## Background Context
462
-
463
- [Relevant information from project brief, brainstorming, or other inputs]
464
-
465
- ## Research Questions
466
-
467
- ### Primary Questions (Must Answer)
468
-
469
- 1. [Specific, actionable question]
470
- 2. [Specific, actionable question]
471
- ...
472
-
473
- ### Secondary Questions (Nice to Have)
474
-
475
- 1. [Supporting question]
476
- 2. [Supporting question]
477
- ...
478
-
479
- ## Research Methodology
480
-
481
- ### Information Sources
482
-
483
- - [Specific source types and priorities]
484
-
485
- ### Analysis Frameworks
486
-
487
- - [Specific frameworks to apply]
488
-
489
- ### Data Requirements
490
-
491
- - [Quality, recency, credibility needs]
492
-
493
- ## Expected Deliverables
494
-
495
- ### Executive Summary
496
-
497
- - Key findings and insights
498
- - Critical implications
499
- - Recommended actions
500
-
501
- ### Detailed Analysis
502
-
503
- [Specific sections needed based on research type]
504
-
505
- ### Supporting Materials
506
-
507
- - Data tables
508
- - Comparison matrices
509
- - Source documentation
510
-
511
- ## Success Criteria
512
-
513
- [How to evaluate if research achieved its objectives]
514
-
515
- ## Timeline and Priority
516
-
517
- [If applicable, any time constraints or phasing]
518
- ```
519
-
520
- ### 5. Review and Refinement
521
-
522
- 1. **Present Complete Prompt**
523
- - Show the full research prompt
524
- - Explain key elements and rationale
525
- - Highlight any assumptions made
526
-
527
- 2. **Gather Feedback**
528
- - Are the objectives clear and correct?
529
- - Do the questions address all concerns?
530
- - Is the scope appropriate?
531
- - Are output requirements sufficient?
532
-
533
- 3. **Refine as Needed**
534
- - Incorporate user feedback
535
- - Adjust scope or focus
536
- - Add missing elements
537
- - Clarify ambiguities
538
-
539
- ### 6. Next Steps Guidance
540
-
541
- **Execution Options:**
542
-
543
- 1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
544
- 2. **Guide Human Research**: Use as a framework for manual research efforts
545
- 3. **Hybrid Approach**: Combine AI and human research using this structure
546
-
547
- **Integration Points:**
548
-
549
- - How findings will feed into next phases
550
- - Which team members should review results
551
- - How to validate findings
552
- - When to revisit or expand research
553
-
554
- ## Important Notes
555
-
556
- - The quality of the research prompt directly impacts the quality of insights gathered
557
- - Be specific rather than general in research questions
558
- - Consider both current state and future implications
559
- - Balance comprehensiveness with focus
560
- - Document assumptions and limitations clearly
561
- - Plan for iterative refinement based on initial findings
562
- ==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
563
-
564
- ==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
565
- # Create Brownfield Epic Task
566
-
567
- ## Purpose
568
-
569
- Create a single epic for smaller brownfield enhancements that don't require the full PRD and Architecture documentation process. This task is for isolated features or modifications that can be completed within a focused scope.
570
-
571
- ## When to Use This Task
572
-
573
- **Use this task when:**
574
-
575
- - The enhancement can be completed in 1-3 stories
576
- - No significant architectural changes are required
577
- - The enhancement follows existing project patterns
578
- - Integration complexity is minimal
579
- - Risk to existing system is low
580
-
581
- **Use the full brownfield PRD/Architecture process when:**
582
-
583
- - The enhancement requires multiple coordinated stories
584
- - Architectural planning is needed
585
- - Significant integration work is required
586
- - Risk assessment and mitigation planning is necessary
587
-
588
- ## Instructions
589
-
590
- ### 1. Project Analysis (Required)
591
-
592
- Before creating the epic, gather essential information about the existing project:
593
-
594
- **Existing Project Context:**
595
-
596
- - [ ] Project purpose and current functionality understood
597
- - [ ] Existing technology stack identified
598
- - [ ] Current architecture patterns noted
599
- - [ ] Integration points with existing system identified
600
-
601
- **Enhancement Scope:**
602
-
603
- - [ ] Enhancement clearly defined and scoped
604
- - [ ] Impact on existing functionality assessed
605
- - [ ] Required integration points identified
606
- - [ ] Success criteria established
607
-
608
- ### 2. Epic Creation
609
-
610
- Create a focused epic following this structure:
611
-
612
- #### Epic Title
613
-
614
- {{Enhancement Name}} - Brownfield Enhancement
615
-
616
- #### Epic Goal
617
-
618
- {{1-2 sentences describing what the epic will accomplish and why it adds value}}
619
-
620
- #### Epic Description
621
-
622
- **Existing System Context:**
623
-
624
- - Current relevant functionality: {{brief description}}
625
- - Technology stack: {{relevant existing technologies}}
626
- - Integration points: {{where new work connects to existing system}}
627
-
628
- **Enhancement Details:**
629
-
630
- - What's being added/changed: {{clear description}}
631
- - How it integrates: {{integration approach}}
632
- - Success criteria: {{measurable outcomes}}
633
-
634
- #### Stories
635
-
636
- List 1-3 focused stories that complete the epic:
637
-
638
- 1. **Story 1:** {{Story title and brief description}}
639
- 2. **Story 2:** {{Story title and brief description}}
640
- 3. **Story 3:** {{Story title and brief description}}
641
-
642
- #### Compatibility Requirements
643
-
644
- - [ ] Existing APIs remain unchanged
645
- - [ ] Database schema changes are backward compatible
646
- - [ ] UI changes follow existing patterns
647
- - [ ] Performance impact is minimal
648
-
649
- #### Risk Mitigation
650
-
651
- - **Primary Risk:** {{main risk to existing system}}
652
- - **Mitigation:** {{how risk will be addressed}}
653
- - **Rollback Plan:** {{how to undo changes if needed}}
654
-
655
- #### Definition of Done
656
-
657
- - [ ] All stories completed with acceptance criteria met
658
- - [ ] Existing functionality verified through testing
659
- - [ ] Integration points working correctly
660
- - [ ] Documentation updated appropriately
661
- - [ ] No regression in existing features
662
-
663
- ### 3. Validation Checklist
664
-
665
- Before finalizing the epic, ensure:
666
-
667
- **Scope Validation:**
668
-
669
- - [ ] Epic can be completed in 1-3 stories maximum
670
- - [ ] No architectural documentation is required
671
- - [ ] Enhancement follows existing patterns
672
- - [ ] Integration complexity is manageable
673
-
674
- **Risk Assessment:**
675
-
676
- - [ ] Risk to existing system is low
677
- - [ ] Rollback plan is feasible
678
- - [ ] Testing approach covers existing functionality
679
- - [ ] Team has sufficient knowledge of integration points
680
-
681
- **Completeness Check:**
682
-
683
- - [ ] Epic goal is clear and achievable
684
- - [ ] Stories are properly scoped
685
- - [ ] Success criteria are measurable
686
- - [ ] Dependencies are identified
687
-
688
- ### 4. Handoff to Story Manager
689
-
690
- Once the epic is validated, provide this handoff to the Story Manager:
691
-
692
- ---
693
-
694
- **Story Manager Handoff:**
695
-
696
- "Please develop detailed user stories for this brownfield epic. Key considerations:
697
-
698
- - This is an enhancement to an existing system running {{technology stack}}
699
- - Integration points: {{list key integration points}}
700
- - Existing patterns to follow: {{relevant existing patterns}}
701
- - Critical compatibility requirements: {{key requirements}}
702
- - Each story must include verification that existing functionality remains intact
703
-
704
- The epic should maintain system integrity while delivering {{epic goal}}."
705
-
706
- ---
707
-
708
- ## Success Criteria
709
-
710
- The epic creation is successful when:
711
-
712
- 1. Enhancement scope is clearly defined and appropriately sized
713
- 2. Integration approach respects existing system architecture
714
- 3. Risk to existing functionality is minimized
715
- 4. Stories are logically sequenced for safe implementation
716
- 5. Compatibility requirements are clearly specified
717
- 6. Rollback plan is feasible and documented
718
-
719
- ## Important Notes
720
-
721
- - This task is specifically for SMALL brownfield enhancements
722
- - If the scope grows beyond 3 stories, consider the full brownfield PRD process
723
- - Always prioritize existing system integrity over new functionality
724
- - When in doubt about scope or complexity, escalate to full brownfield planning
725
- ==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
726
-
727
- ==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
728
- # Create Brownfield Story Task
729
-
730
- ## Purpose
731
-
732
- Create a single user story for very small brownfield enhancements that can be completed in one focused development session. This task is for minimal additions or bug fixes that require existing system integration awareness.
733
-
734
- ## When to Use This Task
735
-
736
- **Use this task when:**
737
-
738
- - The enhancement can be completed in a single story
739
- - No new architecture or significant design is required
740
- - The change follows existing patterns exactly
741
- - Integration is straightforward with minimal risk
742
- - Change is isolated with clear boundaries
743
-
744
- **Use brownfield-create-epic when:**
745
-
746
- - The enhancement requires 2-3 coordinated stories
747
- - Some design work is needed
748
- - Multiple integration points are involved
749
-
750
- **Use the full brownfield PRD/Architecture process when:**
751
-
752
- - The enhancement requires multiple coordinated stories
753
- - Architectural planning is needed
754
- - Significant integration work is required
755
-
756
- ## Instructions
757
-
758
- ### 1. Quick Project Assessment
759
-
760
- Gather minimal but essential context about the existing project:
761
-
762
- **Current System Context:**
763
-
764
- - [ ] Relevant existing functionality identified
765
- - [ ] Technology stack for this area noted
766
- - [ ] Integration point(s) clearly understood
767
- - [ ] Existing patterns for similar work identified
768
-
769
- **Change Scope:**
770
-
771
- - [ ] Specific change clearly defined
772
- - [ ] Impact boundaries identified
773
- - [ ] Success criteria established
774
-
775
- ### 2. Story Creation
776
-
777
- Create a single focused story following this structure:
778
-
779
- #### Story Title
780
-
781
- {{Specific Enhancement}} - Brownfield Addition
782
-
783
- #### User Story
784
-
785
- As a {{user type}},
786
- I want {{specific action/capability}},
787
- So that {{clear benefit/value}}.
788
-
789
- #### Story Context
790
-
791
- **Existing System Integration:**
792
-
793
- - Integrates with: {{existing component/system}}
794
- - Technology: {{relevant tech stack}}
795
- - Follows pattern: {{existing pattern to follow}}
796
- - Touch points: {{specific integration points}}
797
-
798
- #### Acceptance Criteria
799
-
800
- **Functional Requirements:**
801
-
802
- 1. {{Primary functional requirement}}
803
- 2. {{Secondary functional requirement (if any)}}
804
- 3. {{Integration requirement}}
805
-
806
- **Integration Requirements:** 4. Existing {{relevant functionality}} continues to work unchanged 5. New functionality follows existing {{pattern}} pattern 6. Integration with {{system/component}} maintains current behavior
807
-
808
- **Quality Requirements:** 7. Change is covered by appropriate tests 8. Documentation is updated if needed 9. No regression in existing functionality verified
809
-
810
- #### Technical Notes
811
-
812
- - **Integration Approach:** {{how it connects to existing system}}
813
- - **Existing Pattern Reference:** {{link or description of pattern to follow}}
814
- - **Key Constraints:** {{any important limitations or requirements}}
815
-
816
- #### Definition of Done
817
-
818
- - [ ] Functional requirements met
819
- - [ ] Integration requirements verified
820
- - [ ] Existing functionality regression tested
821
- - [ ] Code follows existing patterns and standards
822
- - [ ] Tests pass (existing and new)
823
- - [ ] Documentation updated if applicable
824
-
825
- ### 3. Risk and Compatibility Check
826
-
827
- **Minimal Risk Assessment:**
828
-
829
- - **Primary Risk:** {{main risk to existing system}}
830
- - **Mitigation:** {{simple mitigation approach}}
831
- - **Rollback:** {{how to undo if needed}}
832
-
833
- **Compatibility Verification:**
834
-
835
- - [ ] No breaking changes to existing APIs
836
- - [ ] Database changes (if any) are additive only
837
- - [ ] UI changes follow existing design patterns
838
- - [ ] Performance impact is negligible
839
-
840
- ### 4. Validation Checklist
841
-
842
- Before finalizing the story, confirm:
843
-
844
- **Scope Validation:**
845
-
846
- - [ ] Story can be completed in one development session
847
- - [ ] Integration approach is straightforward
848
- - [ ] Follows existing patterns exactly
849
- - [ ] No design or architecture work required
850
-
851
- **Clarity Check:**
852
-
853
- - [ ] Story requirements are unambiguous
854
- - [ ] Integration points are clearly specified
855
- - [ ] Success criteria are testable
856
- - [ ] Rollback approach is simple
857
-
858
- ## Success Criteria
859
-
860
- The story creation is successful when:
861
-
862
- 1. Enhancement is clearly defined and appropriately scoped for single session
863
- 2. Integration approach is straightforward and low-risk
864
- 3. Existing system patterns are identified and will be followed
865
- 4. Rollback plan is simple and feasible
866
- 5. Acceptance criteria include existing functionality verification
867
-
868
- ## Important Notes
869
-
870
- - This task is for VERY SMALL brownfield changes only
871
- - If complexity grows during analysis, escalate to brownfield-create-epic
872
- - Always prioritize existing system integrity
873
- - When in doubt about integration complexity, use brownfield-create-epic instead
874
- - Stories should take no more than 4 hours of focused development work
875
- ==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
876
-
877
- ==================== START: .bmad-core/tasks/execute-checklist.md ====================
878
- # Checklist Validation Task
879
-
880
- This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
881
-
882
- ## Available Checklists
883
-
884
- If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-core/checklists folder to select the appropriate one to run.
885
-
886
- ## Instructions
887
-
888
- 1. **Initial Assessment**
889
- - If user or the task being run provides a checklist name:
890
- - Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
891
- - If multiple matches found, ask user to clarify
892
- - Load the appropriate checklist from .bmad-core/checklists/
893
- - If no checklist specified:
894
- - Ask the user which checklist they want to use
895
- - Present the available options from the files in the checklists folder
896
- - Confirm if they want to work through the checklist:
897
- - Section by section (interactive mode - very time consuming)
898
- - All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
899
-
900
- 2. **Document and Artifact Gathering**
901
- - Each checklist will specify its required documents/artifacts at the beginning
902
- - Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
903
-
904
- 3. **Checklist Processing**
905
-
906
- If in interactive mode:
907
- - Work through each section of the checklist one at a time
908
- - For each section:
909
- - Review all items in the section following instructions for that section embedded in the checklist
910
- - Check each item against the relevant documentation or artifacts as appropriate
911
- - Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
912
- - Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
913
-
914
- If in YOLO mode:
915
- - Process all sections at once
916
- - Create a comprehensive report of all findings
917
- - Present the complete analysis to the user
918
-
919
- 4. **Validation Approach**
920
-
921
- For each checklist item:
922
- - Read and understand the requirement
923
- - Look for evidence in the documentation that satisfies the requirement
924
- - Consider both explicit mentions and implicit coverage
925
- - Aside from this, follow all checklist llm instructions
926
- - Mark items as:
927
- - ✅ PASS: Requirement clearly met
928
- - ❌ FAIL: Requirement not met or insufficient coverage
929
- - ⚠️ PARTIAL: Some aspects covered but needs improvement
930
- - N/A: Not applicable to this case
931
-
932
- 5. **Section Analysis**
933
-
934
- For each section:
935
- - think step by step to calculate pass rate
936
- - Identify common themes in failed items
937
- - Provide specific recommendations for improvement
938
- - In interactive mode, discuss findings with user
939
- - Document any user decisions or explanations
940
-
941
- 6. **Final Report**
942
-
943
- Prepare a summary that includes:
944
- - Overall checklist completion status
945
- - Pass rates by section
946
- - List of failed items with context
947
- - Specific recommendations for improvement
948
- - Any sections or items marked as N/A with justification
949
-
950
- ## Checklist Execution Methodology
951
-
952
- Each checklist now contains embedded LLM prompts and instructions that will:
953
-
954
- 1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
955
- 2. **Request specific artifacts** - Clear instructions on what documents/access is needed
956
- 3. **Provide contextual guidance** - Section-specific prompts for better validation
957
- 4. **Generate comprehensive reports** - Final summary with detailed findings
958
-
959
- The LLM will:
960
-
961
- - Execute the complete checklist validation
962
- - Present a final report with pass/fail rates and key findings
963
- - Offer to provide detailed analysis of any section, especially those with warnings or failures
964
- ==================== END: .bmad-core/tasks/execute-checklist.md ====================
965
-
966
- ==================== START: .bmad-core/tasks/shard-doc.md ====================
967
- # Document Sharding Task
968
-
969
- ## Purpose
970
-
971
- - Split a large document into multiple smaller documents based on level 2 sections
972
- - Create a folder structure to organize the sharded documents
973
- - Maintain all content integrity including code blocks, diagrams, and markdown formatting
974
-
975
- ## Primary Method: Automatic with markdown-tree
976
-
977
- [[LLM: First, check if markdownExploder is set to true in .bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
978
-
979
- If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
980
-
981
- If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
982
-
983
- 1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
984
- 2. Or set markdownExploder to false in .bmad-core/core-config.yaml
985
-
986
- **IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
987
-
988
- If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
989
-
990
- 1. Set markdownExploder to true in .bmad-core/core-config.yaml
991
- 2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
992
-
993
- I will now proceed with the manual sharding process."
994
-
995
- Then proceed with the manual method below ONLY if markdownExploder is false.]]
996
-
997
- ### Installation and Usage
998
-
999
- 1. **Install globally**:
1000
-
1001
- ```bash
1002
- npm install -g @kayvan/markdown-tree-parser
1003
- ```
1004
-
1005
- 2. **Use the explode command**:
1006
-
1007
- ```bash
1008
- # For PRD
1009
- md-tree explode docs/prd.md docs/prd
1010
-
1011
- # For Architecture
1012
- md-tree explode docs/architecture.md docs/architecture
1013
-
1014
- # For any document
1015
- md-tree explode [source-document] [destination-folder]
1016
- ```
1017
-
1018
- 3. **What it does**:
1019
- - Automatically splits the document by level 2 sections
1020
- - Creates properly named files
1021
- - Adjusts heading levels appropriately
1022
- - Handles all edge cases with code blocks and special markdown
1023
-
1024
- If the user has @kayvan/markdown-tree-parser installed, use it and skip the manual process below.
1025
-
1026
- ---
1027
-
1028
- ## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
1029
-
1030
- ### Task Instructions
1031
-
1032
- 1. Identify Document and Target Location
1033
-
1034
- - Determine which document to shard (user-provided path)
1035
- - Create a new folder under `docs/` with the same name as the document (without extension)
1036
- - Example: `docs/prd.md` → create folder `docs/prd/`
1037
-
1038
- 2. Parse and Extract Sections
1039
-
1040
- CRITICAL AEGNT SHARDING RULES:
1041
-
1042
- 1. Read the entire document content
1043
- 2. Identify all level 2 sections (## headings)
1044
- 3. For each level 2 section:
1045
- - Extract the section heading and ALL content until the next level 2 section
1046
- - Include all subsections, code blocks, diagrams, lists, tables, etc.
1047
- - Be extremely careful with:
1048
- - Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
1049
- - Mermaid diagrams - preserve the complete diagram syntax
1050
- - Nested markdown elements
1051
- - Multi-line content that might contain ## inside code blocks
1052
-
1053
- CRITICAL: Use proper parsing that understands markdown context. A ## inside a code block is NOT a section header.]]
1054
-
1055
- ### 3. Create Individual Files
1056
-
1057
- For each extracted section:
1058
-
1059
- 1. **Generate filename**: Convert the section heading to lowercase-dash-case
1060
- - Remove special characters
1061
- - Replace spaces with dashes
1062
- - Example: "## Tech Stack" → `tech-stack.md`
1063
-
1064
- 2. **Adjust heading levels**:
1065
- - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
1066
- - All subsection levels decrease by 1:
1067
-
1068
- ```txt
1069
- - ### → ##
1070
- - #### → ###
1071
- - ##### → ####
1072
- - etc.
1073
- ```
1074
-
1075
- 3. **Write content**: Save the adjusted content to the new file
1076
-
1077
- ### 4. Create Index File
1078
-
1079
- Create an `index.md` file in the sharded folder that:
1080
-
1081
- 1. Contains the original level 1 heading and any content before the first level 2 section
1082
- 2. Lists all the sharded files with links:
1083
-
1084
- ```markdown
1085
- # Original Document Title
1086
-
1087
- [Original introduction content if any]
1088
-
1089
- ## Sections
1090
-
1091
- - [Section Name 1](./section-name-1.md)
1092
- - [Section Name 2](./section-name-2.md)
1093
- - [Section Name 3](./section-name-3.md)
1094
- ...
1095
- ```
1096
-
1097
- ### 5. Preserve Special Content
1098
-
1099
- 1. **Code blocks**: Must capture complete blocks including:
1100
-
1101
- ```language
1102
- content
1103
- ```
1104
-
1105
- 2. **Mermaid diagrams**: Preserve complete syntax:
1106
-
1107
- ```mermaid
1108
- graph TD
1109
- ...
1110
- ```
1111
-
1112
- 3. **Tables**: Maintain proper markdown table formatting
1113
-
1114
- 4. **Lists**: Preserve indentation and nesting
1115
-
1116
- 5. **Inline code**: Preserve backticks
1117
-
1118
- 6. **Links and references**: Keep all markdown links intact
1119
-
1120
- 7. **Template markup**: If documents contain {{placeholders}} ,preserve exactly
1121
-
1122
- ### 6. Validation
1123
-
1124
- After sharding:
1125
-
1126
- 1. Verify all sections were extracted
1127
- 2. Check that no content was lost
1128
- 3. Ensure heading levels were properly adjusted
1129
- 4. Confirm all files were created successfully
1130
-
1131
- ### 7. Report Results
1132
-
1133
- Provide a summary:
1134
-
1135
- ```text
1136
- Document sharded successfully:
1137
- - Source: [original document path]
1138
- - Destination: docs/[folder-name]/
1139
- - Files created: [count]
1140
- - Sections:
1141
- - section-name-1.md: "Section Title 1"
1142
- - section-name-2.md: "Section Title 2"
1143
- ...
1144
- ```
1145
-
1146
- ## Important Notes
1147
-
1148
- - Never modify the actual content, only adjust heading levels
1149
- - Preserve ALL formatting, including whitespace where significant
1150
- - Handle edge cases like sections with code blocks containing ## symbols
1151
- - Ensure the sharding is reversible (could reconstruct the original from shards)
1152
- ==================== END: .bmad-core/tasks/shard-doc.md ====================
1153
-
1154
- ==================== START: .bmad-core/templates/prd-tmpl.yaml ====================
1155
- template:
1156
- id: prd-template-v2
1157
- name: Product Requirements Document
1158
- version: 2.0
1159
- output:
1160
- format: markdown
1161
- filename: docs/prd.md
1162
- title: "{{project_name}} Product Requirements Document (PRD)"
1163
-
1164
- workflow:
1165
- mode: interactive
1166
- elicitation: advanced-elicitation
1167
-
1168
- sections:
1169
- - id: goals-context
1170
- title: Goals and Background Context
1171
- instruction: |
1172
- Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on PRD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired outcomes) and Background Context (1-2 paragraphs on what this solves and why) so we can determine what is and is not in scope for PRD mvp. Either way this is critical to determine the requirements. Include Change Log table.
1173
- sections:
1174
- - id: goals
1175
- title: Goals
1176
- type: bullet-list
1177
- instruction: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires
1178
- - id: background
1179
- title: Background Context
1180
- type: paragraphs
1181
- instruction: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is
1182
- - id: changelog
1183
- title: Change Log
1184
- type: table
1185
- columns: [Date, Version, Description, Author]
1186
- instruction: Track document versions and changes
1187
-
1188
- - id: requirements
1189
- title: Requirements
1190
- instruction: Draft the list of functional and non functional requirements under the two child sections
1191
- elicit: true
1192
- sections:
1193
- - id: functional
1194
- title: Functional
1195
- type: numbered-list
1196
- prefix: FR
1197
- instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with FR
1198
- examples:
1199
- - "FR6: The Todo List uses AI to detect and warn against potentially duplicate todo items that are worded differently."
1200
- - id: non-functional
1201
- title: Non Functional
1202
- type: numbered-list
1203
- prefix: NFR
1204
- instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR
1205
- examples:
1206
- - "NFR1: AWS service usage must aim to stay within free-tier limits where feasible."
1207
-
1208
- - id: ui-goals
1209
- title: User Interface Design Goals
1210
- condition: PRD has UX/UI requirements
1211
- instruction: |
1212
- Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
1213
-
1214
- 1. Pre-fill all subsections with educated guesses based on project context
1215
- 2. Present the complete rendered section to user
1216
- 3. Clearly let the user know where assumptions were made
1217
- 4. Ask targeted questions for unclear/missing elements or areas needing more specification
1218
- 5. This is NOT detailed UI spec - focus on product vision and user goals
1219
- elicit: true
1220
- choices:
1221
- accessibility: [None, WCAG AA, WCAG AAA]
1222
- platforms: [Web Responsive, Mobile Only, Desktop Only, Cross-Platform]
1223
- sections:
1224
- - id: ux-vision
1225
- title: Overall UX Vision
1226
- - id: interaction-paradigms
1227
- title: Key Interaction Paradigms
1228
- - id: core-screens
1229
- title: Core Screens and Views
1230
- instruction: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories
1231
- examples:
1232
- - "Login Screen"
1233
- - "Main Dashboard"
1234
- - "Item Detail Page"
1235
- - "Settings Page"
1236
- - id: accessibility
1237
- title: "Accessibility: {None|WCAG AA|WCAG AAA|Custom Requirements}"
1238
- - id: branding
1239
- title: Branding
1240
- instruction: Any known branding elements or style guides that must be incorporated?
1241
- examples:
1242
- - "Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions."
1243
- - "Attached is the full color pallet and tokens for our corporate branding."
1244
- - id: target-platforms
1245
- title: "Target Device and Platforms: {Web Responsive|Mobile Only|Desktop Only|Cross-Platform}"
1246
- examples:
1247
- - "Web Responsive, and all mobile platforms"
1248
- - "iPhone Only"
1249
- - "ASCII Windows Desktop"
1250
-
1251
- - id: technical-assumptions
1252
- title: Technical Assumptions
1253
- instruction: |
1254
- Gather technical decisions that will guide the Architect. Steps:
1255
-
1256
- 1. Check if .bmad-core/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
1257
- 2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
1258
- 3. For unknowns, offer guidance based on project goals and MVP scope
1259
- 4. Document ALL technical choices with rationale (why this choice fits the project)
1260
- 5. These become constraints for the Architect - be specific and complete
1261
- elicit: true
1262
- choices:
1263
- repository: [Monorepo, Polyrepo]
1264
- architecture: [Monolith, Microservices, Serverless]
1265
- testing: [Unit Only, Unit + Integration, Full Testing Pyramid]
1266
- sections:
1267
- - id: repository-structure
1268
- title: "Repository Structure: {Monorepo|Polyrepo|Multi-repo}"
1269
- - id: service-architecture
1270
- title: Service Architecture
1271
- instruction: "CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo)."
1272
- - id: testing-requirements
1273
- title: Testing Requirements
1274
- instruction: "CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods)."
1275
- - id: additional-assumptions
1276
- title: Additional Technical Assumptions and Requests
1277
- instruction: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items
1278
-
1279
- - id: epic-list
1280
- title: Epic List
1281
- instruction: |
1282
- Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
1283
-
1284
- CRITICAL: Epics MUST be logically sequential following agile best practices:
1285
-
1286
- - Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
1287
- - Epic 1 must establish foundational project infrastructure (app setup, Git, CI/CD, core services) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, even as simple as a health-check route or display of a simple canary page - remember this when we produce the stories for the first epic!
1288
- - Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
1289
- - Not every project needs multiple epics, an epic needs to deliver value. For example, an API completed can deliver value even if a UI is not complete and planned for a separate epic.
1290
- - Err on the side of less epics, but let the user know your rationale and offer options for splitting them if it seems some are too large or focused on disparate things.
1291
- - Cross Cutting Concerns should flow through epics and stories and not be final stories. For example, adding a logging framework as a last story of an epic, or at the end of a project as a final epic or story would be terrible as we would not have logging from the beginning.
1292
- elicit: true
1293
- examples:
1294
- - "Epic 1: Foundation & Core Infrastructure: Establish project setup, authentication, and basic user management"
1295
- - "Epic 2: Core Business Entities: Create and manage primary domain objects with CRUD operations"
1296
- - "Epic 3: User Workflows & Interactions: Enable key user journeys and business processes"
1297
- - "Epic 4: Reporting & Analytics: Provide insights and data visualization for users"
1298
-
1299
- - id: epic-details
1300
- title: Epic {{epic_number}} {{epic_title}}
1301
- repeatable: true
1302
- instruction: |
1303
- After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
1304
-
1305
- For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
1306
-
1307
- CRITICAL STORY SEQUENCING REQUIREMENTS:
1308
-
1309
- - Stories within each epic MUST be logically sequential
1310
- - Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
1311
- - No story should depend on work from a later story or epic
1312
- - Identify and note any direct prerequisite stories
1313
- - Focus on "what" and "why" not "how" (leave technical implementation to Architect) yet be precise enough to support a logical sequential order of operations from story to story.
1314
- - Ensure each story delivers clear user or business value, try to avoid enablers and build them into stories that deliver value.
1315
- - Size stories for AI agent execution: Each story must be completable by a single AI agent in one focused session without context overflow
1316
- - Think "junior developer working for 2-4 hours" - stories must be small, focused, and self-contained
1317
- - If a story seems complex, break it down further as long as it can deliver a vertical slice
1318
- elicit: true
1319
- template: "{{epic_goal}}"
1320
- sections:
1321
- - id: story
1322
- title: Story {{epic_number}}.{{story_number}} {{story_title}}
1323
- repeatable: true
1324
- template: |
1325
- As a {{user_type}},
1326
- I want {{action}},
1327
- so that {{benefit}}.
1328
- sections:
1329
- - id: acceptance-criteria
1330
- title: Acceptance Criteria
1331
- type: numbered-list
1332
- item_template: "{{criterion_number}}: {{criteria}}"
1333
- repeatable: true
1334
- instruction: |
1335
- Define clear, comprehensive, and testable acceptance criteria that:
1336
-
1337
- - Precisely define what "done" means from a functional perspective
1338
- - Are unambiguous and serve as basis for verification
1339
- - Include any critical non-functional requirements from the PRD
1340
- - Consider local testability for backend/data components
1341
- - Specify UI/UX requirements and framework adherence where applicable
1342
- - Avoid cross-cutting concerns that should be in other stories or PRD sections
1343
-
1344
- - id: checklist-results
1345
- title: Checklist Results Report
1346
- instruction: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the pm-checklist and populate the results in this section.
1347
-
1348
- - id: next-steps
1349
- title: Next Steps
1350
- sections:
1351
- - id: ux-expert-prompt
1352
- title: UX Expert Prompt
1353
- instruction: This section will contain the prompt for the UX Expert, keep it short and to the point to initiate create architecture mode using this document as input.
1354
- - id: architect-prompt
1355
- title: Architect Prompt
1356
- instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.
1357
- ==================== END: .bmad-core/templates/prd-tmpl.yaml ====================
1358
-
1359
- ==================== START: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
1360
- template:
1361
- id: brownfield-prd-template-v2
1362
- name: Brownfield Enhancement PRD
1363
- version: 2.0
1364
- output:
1365
- format: markdown
1366
- filename: docs/prd.md
1367
- title: "{{project_name}} Brownfield Enhancement PRD"
1368
-
1369
- workflow:
1370
- mode: interactive
1371
- elicitation: advanced-elicitation
1372
-
1373
- sections:
1374
- - id: intro-analysis
1375
- title: Intro Project Analysis and Context
1376
- instruction: |
1377
- IMPORTANT - SCOPE ASSESSMENT REQUIRED:
1378
-
1379
- This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
1380
-
1381
- 1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
1382
-
1383
- 2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
1384
-
1385
- 3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.
1386
-
1387
- Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
1388
-
1389
- CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
1390
-
1391
- Do not proceed with any recommendations until the user has validated your understanding of the existing system.
1392
- sections:
1393
- - id: existing-project-overview
1394
- title: Existing Project Overview
1395
- instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.
1396
- sections:
1397
- - id: analysis-source
1398
- title: Analysis Source
1399
- instruction: |
1400
- Indicate one of the following:
1401
- - Document-project output available at: {{path}}
1402
- - IDE-based fresh analysis
1403
- - User-provided information
1404
- - id: current-state
1405
- title: Current Project State
1406
- instruction: |
1407
- - If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
1408
- - Otherwise: Brief description of what the project currently does and its primary purpose
1409
- - id: documentation-analysis
1410
- title: Available Documentation Analysis
1411
- instruction: |
1412
- If document-project was run:
1413
- - Note: "Document-project analysis available - using existing technical documentation"
1414
- - List key documents created by document-project
1415
- - Skip the missing documentation check below
1416
-
1417
- Otherwise, check for existing documentation:
1418
- sections:
1419
- - id: available-docs
1420
- title: Available Documentation
1421
- type: checklist
1422
- items:
1423
- - Tech Stack Documentation [[LLM: If from document-project, check ✓]]
1424
- - Source Tree/Architecture [[LLM: If from document-project, check ✓]]
1425
- - Coding Standards [[LLM: If from document-project, may be partial]]
1426
- - API Documentation [[LLM: If from document-project, check ✓]]
1427
- - External API Documentation [[LLM: If from document-project, check ✓]]
1428
- - UX/UI Guidelines [[LLM: May not be in document-project]]
1429
- - Technical Debt Documentation [[LLM: If from document-project, check ✓]]
1430
- - "Other: {{other_docs}}"
1431
- instruction: |
1432
- - If document-project was already run: "Using existing project analysis from document-project output."
1433
- - If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
1434
- - id: enhancement-scope
1435
- title: Enhancement Scope Definition
1436
- instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.
1437
- sections:
1438
- - id: enhancement-type
1439
- title: Enhancement Type
1440
- type: checklist
1441
- instruction: Determine with user which applies
1442
- items:
1443
- - New Feature Addition
1444
- - Major Feature Modification
1445
- - Integration with New Systems
1446
- - Performance/Scalability Improvements
1447
- - UI/UX Overhaul
1448
- - Technology Stack Upgrade
1449
- - Bug Fix and Stability Improvements
1450
- - "Other: {{other_type}}"
1451
- - id: enhancement-description
1452
- title: Enhancement Description
1453
- instruction: 2-3 sentences describing what the user wants to add or change
1454
- - id: impact-assessment
1455
- title: Impact Assessment
1456
- type: checklist
1457
- instruction: Assess the scope of impact on existing codebase
1458
- items:
1459
- - Minimal Impact (isolated additions)
1460
- - Moderate Impact (some existing code changes)
1461
- - Significant Impact (substantial existing code changes)
1462
- - Major Impact (architectural changes required)
1463
- - id: goals-context
1464
- title: Goals and Background Context
1465
- sections:
1466
- - id: goals
1467
- title: Goals
1468
- type: bullet-list
1469
- instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful
1470
- - id: background
1471
- title: Background Context
1472
- type: paragraphs
1473
- instruction: 1-2 short paragraphs explaining why this enhancement is needed, what problem it solves, and how it fits with the existing project
1474
- - id: changelog
1475
- title: Change Log
1476
- type: table
1477
- columns: [Change, Date, Version, Description, Author]
1478
-
1479
- - id: requirements
1480
- title: Requirements
1481
- instruction: |
1482
- Draft functional and non-functional requirements based on your validated understanding of the existing project. Before presenting requirements, confirm: "These requirements are based on my understanding of your existing system. Please review carefully and confirm they align with your project's reality."
1483
- elicit: true
1484
- sections:
1485
- - id: functional
1486
- title: Functional
1487
- type: numbered-list
1488
- prefix: FR
1489
- instruction: Each Requirement will be a bullet markdown with identifier starting with FR
1490
- examples:
1491
- - "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality."
1492
- - id: non-functional
1493
- title: Non Functional
1494
- type: numbered-list
1495
- prefix: NFR
1496
- instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system
1497
- examples:
1498
- - "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%."
1499
- - id: compatibility
1500
- title: Compatibility Requirements
1501
- instruction: Critical for brownfield - what must remain compatible
1502
- type: numbered-list
1503
- prefix: CR
1504
- template: "{{requirement}}: {{description}}"
1505
- items:
1506
- - id: cr1
1507
- template: "CR1: {{existing_api_compatibility}}"
1508
- - id: cr2
1509
- template: "CR2: {{database_schema_compatibility}}"
1510
- - id: cr3
1511
- template: "CR3: {{ui_ux_consistency}}"
1512
- - id: cr4
1513
- template: "CR4: {{integration_compatibility}}"
1514
-
1515
- - id: ui-enhancement-goals
1516
- title: User Interface Enhancement Goals
1517
- condition: Enhancement includes UI changes
1518
- instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems
1519
- sections:
1520
- - id: existing-ui-integration
1521
- title: Integration with Existing UI
1522
- instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries
1523
- - id: modified-screens
1524
- title: Modified/New Screens and Views
1525
- instruction: List only the screens/views that will be modified or added
1526
- - id: ui-consistency
1527
- title: UI Consistency Requirements
1528
- instruction: Specific requirements for maintaining visual and interaction consistency with existing application
1529
-
1530
- - id: technical-constraints
1531
- title: Technical Constraints and Integration Requirements
1532
- instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.
1533
- sections:
1534
- - id: existing-tech-stack
1535
- title: Existing Technology Stack
1536
- instruction: |
1537
- If document-project output available:
1538
- - Extract from "Actual Tech Stack" table in High Level Architecture section
1539
- - Include version numbers and any noted constraints
1540
-
1541
- Otherwise, document the current technology stack:
1542
- template: |
1543
- **Languages**: {{languages}}
1544
- **Frameworks**: {{frameworks}}
1545
- **Database**: {{database}}
1546
- **Infrastructure**: {{infrastructure}}
1547
- **External Dependencies**: {{external_dependencies}}
1548
- - id: integration-approach
1549
- title: Integration Approach
1550
- instruction: Define how the enhancement will integrate with existing architecture
1551
- template: |
1552
- **Database Integration Strategy**: {{database_integration}}
1553
- **API Integration Strategy**: {{api_integration}}
1554
- **Frontend Integration Strategy**: {{frontend_integration}}
1555
- **Testing Integration Strategy**: {{testing_integration}}
1556
- - id: code-organization
1557
- title: Code Organization and Standards
1558
- instruction: Based on existing project analysis, define how new code will fit existing patterns
1559
- template: |
1560
- **File Structure Approach**: {{file_structure}}
1561
- **Naming Conventions**: {{naming_conventions}}
1562
- **Coding Standards**: {{coding_standards}}
1563
- **Documentation Standards**: {{documentation_standards}}
1564
- - id: deployment-operations
1565
- title: Deployment and Operations
1566
- instruction: How the enhancement fits existing deployment pipeline
1567
- template: |
1568
- **Build Process Integration**: {{build_integration}}
1569
- **Deployment Strategy**: {{deployment_strategy}}
1570
- **Monitoring and Logging**: {{monitoring_logging}}
1571
- **Configuration Management**: {{config_management}}
1572
- - id: risk-assessment
1573
- title: Risk Assessment and Mitigation
1574
- instruction: |
1575
- If document-project output available:
1576
- - Reference "Technical Debt and Known Issues" section
1577
- - Include "Workarounds and Gotchas" that might impact enhancement
1578
- - Note any identified constraints from "Critical Technical Debt"
1579
-
1580
- Build risk assessment incorporating existing known issues:
1581
- template: |
1582
- **Technical Risks**: {{technical_risks}}
1583
- **Integration Risks**: {{integration_risks}}
1584
- **Deployment Risks**: {{deployment_risks}}
1585
- **Mitigation Strategies**: {{mitigation_strategies}}
1586
-
1587
- - id: epic-structure
1588
- title: Epic and Story Structure
1589
- instruction: |
1590
- For brownfield projects, favor a single comprehensive epic unless the user is clearly requesting multiple unrelated enhancements. Before presenting the epic structure, confirm: "Based on my analysis of your existing project, I believe this enhancement should be structured as [single epic/multiple epics] because [rationale based on actual project analysis]. Does this align with your understanding of the work required?"
1591
- elicit: true
1592
- sections:
1593
- - id: epic-approach
1594
- title: Epic Approach
1595
- instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features
1596
- template: "**Epic Structure Decision**: {{epic_decision}} with rationale"
1597
-
1598
- - id: epic-details
1599
- title: "Epic 1: {{enhancement_title}}"
1600
- instruction: |
1601
- Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
1602
-
1603
- CRITICAL STORY SEQUENCING FOR BROWNFIELD:
1604
- - Stories must ensure existing functionality remains intact
1605
- - Each story should include verification that existing features still work
1606
- - Stories should be sequenced to minimize risk to existing system
1607
- - Include rollback considerations for each story
1608
- - Focus on incremental integration rather than big-bang changes
1609
- - Size stories for AI agent execution in existing codebase context
1610
- - MANDATORY: Present the complete story sequence and ask: "This story sequence is designed to minimize risk to your existing system. Does this order make sense given your project's architecture and constraints?"
1611
- - Stories must be logically sequential with clear dependencies identified
1612
- - Each story must deliver value while maintaining system integrity
1613
- template: |
1614
- **Epic Goal**: {{epic_goal}}
1615
-
1616
- **Integration Requirements**: {{integration_requirements}}
1617
- sections:
1618
- - id: story
1619
- title: "Story 1.{{story_number}} {{story_title}}"
1620
- repeatable: true
1621
- template: |
1622
- As a {{user_type}},
1623
- I want {{action}},
1624
- so that {{benefit}}.
1625
- sections:
1626
- - id: acceptance-criteria
1627
- title: Acceptance Criteria
1628
- type: numbered-list
1629
- instruction: Define criteria that include both new functionality and existing system integrity
1630
- item_template: "{{criterion_number}}: {{criteria}}"
1631
- - id: integration-verification
1632
- title: Integration Verification
1633
- instruction: Specific verification steps to ensure existing functionality remains intact
1634
- type: numbered-list
1635
- prefix: IV
1636
- items:
1637
- - template: "IV1: {{existing_functionality_verification}}"
1638
- - template: "IV2: {{integration_point_verification}}"
1639
- - template: "IV3: {{performance_impact_verification}}"
1640
- ==================== END: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
1641
-
1642
- ==================== START: .bmad-core/checklists/pm-checklist.md ====================
1643
- # Product Manager (PM) Requirements Checklist
1644
-
1645
- This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
1646
-
1647
- [[LLM: INITIALIZATION INSTRUCTIONS - PM CHECKLIST
1648
-
1649
- Before proceeding with this checklist, ensure you have access to:
1650
-
1651
- 1. prd.md - The Product Requirements Document (check docs/prd.md)
1652
- 2. Any user research, market analysis, or competitive analysis documents
1653
- 3. Business goals and strategy documents
1654
- 4. Any existing epic definitions or user stories
1655
-
1656
- IMPORTANT: If the PRD is missing, immediately ask the user for its location or content before proceeding.
1657
-
1658
- VALIDATION APPROACH:
1659
-
1660
- 1. User-Centric - Every requirement should tie back to user value
1661
- 2. MVP Focus - Ensure scope is truly minimal while viable
1662
- 3. Clarity - Requirements should be unambiguous and testable
1663
- 4. Completeness - All aspects of the product vision are covered
1664
- 5. Feasibility - Requirements are technically achievable
1665
-
1666
- EXECUTION MODE:
1667
- Ask the user if they want to work through the checklist:
1668
-
1669
- - Section by section (interactive mode) - Review each section, present findings, get confirmation before proceeding
1670
- - All at once (comprehensive mode) - Complete full analysis and present comprehensive report at end]]
1671
-
1672
- ## 1. PROBLEM DEFINITION & CONTEXT
1673
-
1674
- [[LLM: The foundation of any product is a clear problem statement. As you review this section:
1675
-
1676
- 1. Verify the problem is real and worth solving
1677
- 2. Check that the target audience is specific, not "everyone"
1678
- 3. Ensure success metrics are measurable, not vague aspirations
1679
- 4. Look for evidence of user research, not just assumptions
1680
- 5. Confirm the problem-solution fit is logical]]
1681
-
1682
- ### 1.1 Problem Statement
1683
-
1684
- - [ ] Clear articulation of the problem being solved
1685
- - [ ] Identification of who experiences the problem
1686
- - [ ] Explanation of why solving this problem matters
1687
- - [ ] Quantification of problem impact (if possible)
1688
- - [ ] Differentiation from existing solutions
1689
-
1690
- ### 1.2 Business Goals & Success Metrics
1691
-
1692
- - [ ] Specific, measurable business objectives defined
1693
- - [ ] Clear success metrics and KPIs established
1694
- - [ ] Metrics are tied to user and business value
1695
- - [ ] Baseline measurements identified (if applicable)
1696
- - [ ] Timeframe for achieving goals specified
1697
-
1698
- ### 1.3 User Research & Insights
1699
-
1700
- - [ ] Target user personas clearly defined
1701
- - [ ] User needs and pain points documented
1702
- - [ ] User research findings summarized (if available)
1703
- - [ ] Competitive analysis included
1704
- - [ ] Market context provided
1705
-
1706
- ## 2. MVP SCOPE DEFINITION
1707
-
1708
- [[LLM: MVP scope is critical - too much and you waste resources, too little and you can't validate. Check:
1709
-
1710
- 1. Is this truly minimal? Challenge every feature
1711
- 2. Does each feature directly address the core problem?
1712
- 3. Are "nice-to-haves" clearly separated from "must-haves"?
1713
- 4. Is the rationale for inclusion/exclusion documented?
1714
- 5. Can you ship this in the target timeframe?]]
1715
-
1716
- ### 2.1 Core Functionality
1717
-
1718
- - [ ] Essential features clearly distinguished from nice-to-haves
1719
- - [ ] Features directly address defined problem statement
1720
- - [ ] Each Epic ties back to specific user needs
1721
- - [ ] Features and Stories are described from user perspective
1722
- - [ ] Minimum requirements for success defined
1723
-
1724
- ### 2.2 Scope Boundaries
1725
-
1726
- - [ ] Clear articulation of what is OUT of scope
1727
- - [ ] Future enhancements section included
1728
- - [ ] Rationale for scope decisions documented
1729
- - [ ] MVP minimizes functionality while maximizing learning
1730
- - [ ] Scope has been reviewed and refined multiple times
1731
-
1732
- ### 2.3 MVP Validation Approach
1733
-
1734
- - [ ] Method for testing MVP success defined
1735
- - [ ] Initial user feedback mechanisms planned
1736
- - [ ] Criteria for moving beyond MVP specified
1737
- - [ ] Learning goals for MVP articulated
1738
- - [ ] Timeline expectations set
1739
-
1740
- ## 3. USER EXPERIENCE REQUIREMENTS
1741
-
1742
- [[LLM: UX requirements bridge user needs and technical implementation. Validate:
1743
-
1744
- 1. User flows cover the primary use cases completely
1745
- 2. Edge cases are identified (even if deferred)
1746
- 3. Accessibility isn't an afterthought
1747
- 4. Performance expectations are realistic
1748
- 5. Error states and recovery are planned]]
1749
-
1750
- ### 3.1 User Journeys & Flows
1751
-
1752
- - [ ] Primary user flows documented
1753
- - [ ] Entry and exit points for each flow identified
1754
- - [ ] Decision points and branches mapped
1755
- - [ ] Critical path highlighted
1756
- - [ ] Edge cases considered
1757
-
1758
- ### 3.2 Usability Requirements
1759
-
1760
- - [ ] Accessibility considerations documented
1761
- - [ ] Platform/device compatibility specified
1762
- - [ ] Performance expectations from user perspective defined
1763
- - [ ] Error handling and recovery approaches outlined
1764
- - [ ] User feedback mechanisms identified
1765
-
1766
- ### 3.3 UI Requirements
1767
-
1768
- - [ ] Information architecture outlined
1769
- - [ ] Critical UI components identified
1770
- - [ ] Visual design guidelines referenced (if applicable)
1771
- - [ ] Content requirements specified
1772
- - [ ] High-level navigation structure defined
1773
-
1774
- ## 4. FUNCTIONAL REQUIREMENTS
1775
-
1776
- [[LLM: Functional requirements must be clear enough for implementation. Check:
1777
-
1778
- 1. Requirements focus on WHAT not HOW (no implementation details)
1779
- 2. Each requirement is testable (how would QA verify it?)
1780
- 3. Dependencies are explicit (what needs to be built first?)
1781
- 4. Requirements use consistent terminology
1782
- 5. Complex features are broken into manageable pieces]]
1783
-
1784
- ### 4.1 Feature Completeness
1785
-
1786
- - [ ] All required features for MVP documented
1787
- - [ ] Features have clear, user-focused descriptions
1788
- - [ ] Feature priority/criticality indicated
1789
- - [ ] Requirements are testable and verifiable
1790
- - [ ] Dependencies between features identified
1791
-
1792
- ### 4.2 Requirements Quality
1793
-
1794
- - [ ] Requirements are specific and unambiguous
1795
- - [ ] Requirements focus on WHAT not HOW
1796
- - [ ] Requirements use consistent terminology
1797
- - [ ] Complex requirements broken into simpler parts
1798
- - [ ] Technical jargon minimized or explained
1799
-
1800
- ### 4.3 User Stories & Acceptance Criteria
1801
-
1802
- - [ ] Stories follow consistent format
1803
- - [ ] Acceptance criteria are testable
1804
- - [ ] Stories are sized appropriately (not too large)
1805
- - [ ] Stories are independent where possible
1806
- - [ ] Stories include necessary context
1807
- - [ ] Local testability requirements (e.g., via CLI) defined in ACs for relevant backend/data stories
1808
-
1809
- ## 5. NON-FUNCTIONAL REQUIREMENTS
1810
-
1811
- ### 5.1 Performance Requirements
1812
-
1813
- - [ ] Response time expectations defined
1814
- - [ ] Throughput/capacity requirements specified
1815
- - [ ] Scalability needs documented
1816
- - [ ] Resource utilization constraints identified
1817
- - [ ] Load handling expectations set
1818
-
1819
- ### 5.2 Security & Compliance
1820
-
1821
- - [ ] Data protection requirements specified
1822
- - [ ] Authentication/authorization needs defined
1823
- - [ ] Compliance requirements documented
1824
- - [ ] Security testing requirements outlined
1825
- - [ ] Privacy considerations addressed
1826
-
1827
- ### 5.3 Reliability & Resilience
1828
-
1829
- - [ ] Availability requirements defined
1830
- - [ ] Backup and recovery needs documented
1831
- - [ ] Fault tolerance expectations set
1832
- - [ ] Error handling requirements specified
1833
- - [ ] Maintenance and support considerations included
1834
-
1835
- ### 5.4 Technical Constraints
1836
-
1837
- - [ ] Platform/technology constraints documented
1838
- - [ ] Integration requirements outlined
1839
- - [ ] Third-party service dependencies identified
1840
- - [ ] Infrastructure requirements specified
1841
- - [ ] Development environment needs identified
1842
-
1843
- ## 6. EPIC & STORY STRUCTURE
1844
-
1845
- ### 6.1 Epic Definition
1846
-
1847
- - [ ] Epics represent cohesive units of functionality
1848
- - [ ] Epics focus on user/business value delivery
1849
- - [ ] Epic goals clearly articulated
1850
- - [ ] Epics are sized appropriately for incremental delivery
1851
- - [ ] Epic sequence and dependencies identified
1852
-
1853
- ### 6.2 Story Breakdown
1854
-
1855
- - [ ] Stories are broken down to appropriate size
1856
- - [ ] Stories have clear, independent value
1857
- - [ ] Stories include appropriate acceptance criteria
1858
- - [ ] Story dependencies and sequence documented
1859
- - [ ] Stories aligned with epic goals
1860
-
1861
- ### 6.3 First Epic Completeness
1862
-
1863
- - [ ] First epic includes all necessary setup steps
1864
- - [ ] Project scaffolding and initialization addressed
1865
- - [ ] Core infrastructure setup included
1866
- - [ ] Development environment setup addressed
1867
- - [ ] Local testability established early
1868
-
1869
- ## 7. TECHNICAL GUIDANCE
1870
-
1871
- ### 7.1 Architecture Guidance
1872
-
1873
- - [ ] Initial architecture direction provided
1874
- - [ ] Technical constraints clearly communicated
1875
- - [ ] Integration points identified
1876
- - [ ] Performance considerations highlighted
1877
- - [ ] Security requirements articulated
1878
- - [ ] Known areas of high complexity or technical risk flagged for architectural deep-dive
1879
-
1880
- ### 7.2 Technical Decision Framework
1881
-
1882
- - [ ] Decision criteria for technical choices provided
1883
- - [ ] Trade-offs articulated for key decisions
1884
- - [ ] Rationale for selecting primary approach over considered alternatives documented (for key design/feature choices)
1885
- - [ ] Non-negotiable technical requirements highlighted
1886
- - [ ] Areas requiring technical investigation identified
1887
- - [ ] Guidance on technical debt approach provided
1888
-
1889
- ### 7.3 Implementation Considerations
1890
-
1891
- - [ ] Development approach guidance provided
1892
- - [ ] Testing requirements articulated
1893
- - [ ] Deployment expectations set
1894
- - [ ] Monitoring needs identified
1895
- - [ ] Documentation requirements specified
1896
-
1897
- ## 8. CROSS-FUNCTIONAL REQUIREMENTS
1898
-
1899
- ### 8.1 Data Requirements
1900
-
1901
- - [ ] Data entities and relationships identified
1902
- - [ ] Data storage requirements specified
1903
- - [ ] Data quality requirements defined
1904
- - [ ] Data retention policies identified
1905
- - [ ] Data migration needs addressed (if applicable)
1906
- - [ ] Schema changes planned iteratively, tied to stories requiring them
1907
-
1908
- ### 8.2 Integration Requirements
1909
-
1910
- - [ ] External system integrations identified
1911
- - [ ] API requirements documented
1912
- - [ ] Authentication for integrations specified
1913
- - [ ] Data exchange formats defined
1914
- - [ ] Integration testing requirements outlined
1915
-
1916
- ### 8.3 Operational Requirements
1917
-
1918
- - [ ] Deployment frequency expectations set
1919
- - [ ] Environment requirements defined
1920
- - [ ] Monitoring and alerting needs identified
1921
- - [ ] Support requirements documented
1922
- - [ ] Performance monitoring approach specified
1923
-
1924
- ## 9. CLARITY & COMMUNICATION
1925
-
1926
- ### 9.1 Documentation Quality
1927
-
1928
- - [ ] Documents use clear, consistent language
1929
- - [ ] Documents are well-structured and organized
1930
- - [ ] Technical terms are defined where necessary
1931
- - [ ] Diagrams/visuals included where helpful
1932
- - [ ] Documentation is versioned appropriately
1933
-
1934
- ### 9.2 Stakeholder Alignment
1935
-
1936
- - [ ] Key stakeholders identified
1937
- - [ ] Stakeholder input incorporated
1938
- - [ ] Potential areas of disagreement addressed
1939
- - [ ] Communication plan for updates established
1940
- - [ ] Approval process defined
1941
-
1942
- ## PRD & EPIC VALIDATION SUMMARY
1943
-
1944
- [[LLM: FINAL PM CHECKLIST REPORT GENERATION
1945
-
1946
- Create a comprehensive validation report that includes:
1947
-
1948
- 1. Executive Summary
1949
- - Overall PRD completeness (percentage)
1950
- - MVP scope appropriateness (Too Large/Just Right/Too Small)
1951
- - Readiness for architecture phase (Ready/Nearly Ready/Not Ready)
1952
- - Most critical gaps or concerns
1953
-
1954
- 2. Category Analysis Table
1955
- Fill in the actual table with:
1956
- - Status: PASS (90%+ complete), PARTIAL (60-89%), FAIL (<60%)
1957
- - Critical Issues: Specific problems that block progress
1958
-
1959
- 3. Top Issues by Priority
1960
- - BLOCKERS: Must fix before architect can proceed
1961
- - HIGH: Should fix for quality
1962
- - MEDIUM: Would improve clarity
1963
- - LOW: Nice to have
1964
-
1965
- 4. MVP Scope Assessment
1966
- - Features that might be cut for true MVP
1967
- - Missing features that are essential
1968
- - Complexity concerns
1969
- - Timeline realism
1970
-
1971
- 5. Technical Readiness
1972
- - Clarity of technical constraints
1973
- - Identified technical risks
1974
- - Areas needing architect investigation
1975
-
1976
- 6. Recommendations
1977
- - Specific actions to address each blocker
1978
- - Suggested improvements
1979
- - Next steps
1980
-
1981
- After presenting the report, ask if the user wants:
1982
-
1983
- - Detailed analysis of any failed sections
1984
- - Suggestions for improving specific areas
1985
- - Help with refining MVP scope]]
1986
-
1987
- ### Category Statuses
1988
-
1989
- | Category | Status | Critical Issues |
1990
- | -------------------------------- | ------ | --------------- |
1991
- | 1. Problem Definition & Context | _TBD_ | |
1992
- | 2. MVP Scope Definition | _TBD_ | |
1993
- | 3. User Experience Requirements | _TBD_ | |
1994
- | 4. Functional Requirements | _TBD_ | |
1995
- | 5. Non-Functional Requirements | _TBD_ | |
1996
- | 6. Epic & Story Structure | _TBD_ | |
1997
- | 7. Technical Guidance | _TBD_ | |
1998
- | 8. Cross-Functional Requirements | _TBD_ | |
1999
- | 9. Clarity & Communication | _TBD_ | |
2000
-
2001
- ### Critical Deficiencies
2002
-
2003
- (To be populated during validation)
2004
-
2005
- ### Recommendations
2006
-
2007
- (To be populated during validation)
2008
-
2009
- ### Final Decision
2010
-
2011
- - **READY FOR ARCHITECT**: The PRD and epics are comprehensive, properly structured, and ready for architectural design.
2012
- - **NEEDS REFINEMENT**: The requirements documentation requires additional work to address the identified deficiencies.
2013
- ==================== END: .bmad-core/checklists/pm-checklist.md ====================
2014
-
2015
- ==================== START: .bmad-core/checklists/change-checklist.md ====================
2016
- # Change Navigation Checklist
2017
-
2018
- **Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
2019
-
2020
- **Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
2021
-
2022
- [[LLM: INITIALIZATION INSTRUCTIONS - CHANGE NAVIGATION
2023
-
2024
- Changes during development are inevitable, but how we handle them determines project success or failure.
2025
-
2026
- Before proceeding, understand:
2027
-
2028
- 1. This checklist is for SIGNIFICANT changes that affect the project direction
2029
- 2. Minor adjustments within a story don't require this process
2030
- 3. The goal is to minimize wasted work while adapting to new realities
2031
- 4. User buy-in is critical - they must understand and approve changes
2032
-
2033
- Required context:
2034
-
2035
- - The triggering story or issue
2036
- - Current project state (completed stories, current epic)
2037
- - Access to PRD, architecture, and other key documents
2038
- - Understanding of remaining work planned
2039
-
2040
- APPROACH:
2041
- This is an interactive process with the user. Work through each section together, discussing implications and options. The user makes final decisions, but provide expert guidance on technical feasibility and impact.
2042
-
2043
- REMEMBER: Changes are opportunities to improve, not failures. Handle them professionally and constructively.]]
2044
-
2045
- ---
2046
-
2047
- ## 1. Understand the Trigger & Context
2048
-
2049
- [[LLM: Start by fully understanding what went wrong and why. Don't jump to solutions yet. Ask probing questions:
2050
-
2051
- - What exactly happened that triggered this review?
2052
- - Is this a one-time issue or symptomatic of a larger problem?
2053
- - Could this have been anticipated earlier?
2054
- - What assumptions were incorrect?
2055
-
2056
- Be specific and factual, not blame-oriented.]]
2057
-
2058
- - [ ] **Identify Triggering Story:** Clearly identify the story (or stories) that revealed the issue.
2059
- - [ ] **Define the Issue:** Articulate the core problem precisely.
2060
- - [ ] Is it a technical limitation/dead-end?
2061
- - [ ] Is it a newly discovered requirement?
2062
- - [ ] Is it a fundamental misunderstanding of existing requirements?
2063
- - [ ] Is it a necessary pivot based on feedback or new information?
2064
- - [ ] Is it a failed/abandoned story needing a new approach?
2065
- - [ ] **Assess Initial Impact:** Describe the immediate observed consequences (e.g., blocked progress, incorrect functionality, non-viable tech).
2066
- - [ ] **Gather Evidence:** Note any specific logs, error messages, user feedback, or analysis that supports the issue definition.
2067
-
2068
- ## 2. Epic Impact Assessment
2069
-
2070
- [[LLM: Changes ripple through the project structure. Systematically evaluate:
2071
-
2072
- 1. Can we salvage the current epic with modifications?
2073
- 2. Do future epics still make sense given this change?
2074
- 3. Are we creating or eliminating dependencies?
2075
- 4. Does the epic sequence need reordering?
2076
-
2077
- Think about both immediate and downstream effects.]]
2078
-
2079
- - [ ] **Analyze Current Epic:**
2080
- - [ ] Can the current epic containing the trigger story still be completed?
2081
- - [ ] Does the current epic need modification (story changes, additions, removals)?
2082
- - [ ] Should the current epic be abandoned or fundamentally redefined?
2083
- - [ ] **Analyze Future Epics:**
2084
- - [ ] Review all remaining planned epics.
2085
- - [ ] Does the issue require changes to planned stories in future epics?
2086
- - [ ] Does the issue invalidate any future epics?
2087
- - [ ] Does the issue necessitate the creation of entirely new epics?
2088
- - [ ] Should the order/priority of future epics be changed?
2089
- - [ ] **Summarize Epic Impact:** Briefly document the overall effect on the project's epic structure and flow.
2090
-
2091
- ## 3. Artifact Conflict & Impact Analysis
2092
-
2093
- [[LLM: Documentation drives development in BMad. Check each artifact:
2094
-
2095
- 1. Does this change invalidate documented decisions?
2096
- 2. Are architectural assumptions still valid?
2097
- 3. Do user flows need rethinking?
2098
- 4. Are technical constraints different than documented?
2099
-
2100
- Be thorough - missed conflicts cause future problems.]]
2101
-
2102
- - [ ] **Review PRD:**
2103
- - [ ] Does the issue conflict with the core goals or requirements stated in the PRD?
2104
- - [ ] Does the PRD need clarification or updates based on the new understanding?
2105
- - [ ] **Review Architecture Document:**
2106
- - [ ] Does the issue conflict with the documented architecture (components, patterns, tech choices)?
2107
- - [ ] Are specific components/diagrams/sections impacted?
2108
- - [ ] Does the technology list need updating?
2109
- - [ ] Do data models or schemas need revision?
2110
- - [ ] Are external API integrations affected?
2111
- - [ ] **Review Frontend Spec (if applicable):**
2112
- - [ ] Does the issue conflict with the FE architecture, component library choice, or UI/UX design?
2113
- - [ ] Are specific FE components or user flows impacted?
2114
- - [ ] **Review Other Artifacts (if applicable):**
2115
- - [ ] Consider impact on deployment scripts, IaC, monitoring setup, etc.
2116
- - [ ] **Summarize Artifact Impact:** List all artifacts requiring updates and the nature of the changes needed.
2117
-
2118
- ## 4. Path Forward Evaluation
2119
-
2120
- [[LLM: Present options clearly with pros/cons. For each path:
2121
-
2122
- 1. What's the effort required?
2123
- 2. What work gets thrown away?
2124
- 3. What risks are we taking?
2125
- 4. How does this affect timeline?
2126
- 5. Is this sustainable long-term?
2127
-
2128
- Be honest about trade-offs. There's rarely a perfect solution.]]
2129
-
2130
- - [ ] **Option 1: Direct Adjustment / Integration:**
2131
- - [ ] Can the issue be addressed by modifying/adding future stories within the existing plan?
2132
- - [ ] Define the scope and nature of these adjustments.
2133
- - [ ] Assess feasibility, effort, and risks of this path.
2134
- - [ ] **Option 2: Potential Rollback:**
2135
- - [ ] Would reverting completed stories significantly simplify addressing the issue?
2136
- - [ ] Identify specific stories/commits to consider for rollback.
2137
- - [ ] Assess the effort required for rollback.
2138
- - [ ] Assess the impact of rollback (lost work, data implications).
2139
- - [ ] Compare the net benefit/cost vs. Direct Adjustment.
2140
- - [ ] **Option 3: PRD MVP Review & Potential Re-scoping:**
2141
- - [ ] Is the original PRD MVP still achievable given the issue and constraints?
2142
- - [ ] Does the MVP scope need reduction (removing features/epics)?
2143
- - [ ] Do the core MVP goals need modification?
2144
- - [ ] Are alternative approaches needed to meet the original MVP intent?
2145
- - [ ] **Extreme Case:** Does the issue necessitate a fundamental replan or potentially a new PRD V2 (to be handled by PM)?
2146
- - [ ] **Select Recommended Path:** Based on the evaluation, agree on the most viable path forward.
2147
-
2148
- ## 5. Sprint Change Proposal Components
2149
-
2150
- [[LLM: The proposal must be actionable and clear. Ensure:
2151
-
2152
- 1. The issue is explained in plain language
2153
- 2. Impacts are quantified where possible
2154
- 3. The recommended path has clear rationale
2155
- 4. Next steps are specific and assigned
2156
- 5. Success criteria for the change are defined
2157
-
2158
- This proposal guides all subsequent work.]]
2159
-
2160
- (Ensure all agreed-upon points from previous sections are captured in the proposal)
2161
-
2162
- - [ ] **Identified Issue Summary:** Clear, concise problem statement.
2163
- - [ ] **Epic Impact Summary:** How epics are affected.
2164
- - [ ] **Artifact Adjustment Needs:** List of documents to change.
2165
- - [ ] **Recommended Path Forward:** Chosen solution with rationale.
2166
- - [ ] **PRD MVP Impact:** Changes to scope/goals (if any).
2167
- - [ ] **High-Level Action Plan:** Next steps for stories/updates.
2168
- - [ ] **Agent Handoff Plan:** Identify roles needed (PM, Arch, Design Arch, PO).
2169
-
2170
- ## 6. Final Review & Handoff
2171
-
2172
- [[LLM: Changes require coordination. Before concluding:
2173
-
2174
- 1. Is the user fully aligned with the plan?
2175
- 2. Do all stakeholders understand the impacts?
2176
- 3. Are handoffs to other agents clear?
2177
- 4. Is there a rollback plan if the change fails?
2178
- 5. How will we validate the change worked?
2179
-
2180
- Get explicit approval - implicit agreement causes problems.
2181
-
2182
- FINAL REPORT:
2183
- After completing the checklist, provide a concise summary:
2184
-
2185
- - What changed and why
2186
- - What we're doing about it
2187
- - Who needs to do what
2188
- - When we'll know if it worked
2189
-
2190
- Keep it action-oriented and forward-looking.]]
2191
-
2192
- - [ ] **Review Checklist:** Confirm all relevant items were discussed.
2193
- - [ ] **Review Sprint Change Proposal:** Ensure it accurately reflects the discussion and decisions.
2194
- - [ ] **User Approval:** Obtain explicit user approval for the proposal.
2195
- - [ ] **Confirm Next Steps:** Reiterate the handoff plan and the next actions to be taken by specific agents.
2196
-
2197
- ---
2198
- ==================== END: .bmad-core/checklists/change-checklist.md ====================
2199
-
2200
- ==================== START: .bmad-core/data/technical-preferences.md ====================
2201
- # User-Defined Preferred Patterns and Preferences
2202
-
2203
- None Listed
2204
- ==================== END: .bmad-core/data/technical-preferences.md ====================