bmad-method 6.0.0-alpha.1 → 6.0.0-alpha.11

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 (714) hide show
  1. package/.github/ISSUE_TEMPLATE/idea_submission.md +1 -1
  2. package/.github/workflows/bundle-latest.yaml +277 -0
  3. package/.github/workflows/manual-release.yaml +64 -17
  4. package/.github/workflows/{lint.yaml → quality.yaml} +19 -2
  5. package/.husky/pre-commit +4 -0
  6. package/.prettierignore +4 -0
  7. package/.vscode/settings.json +3 -1
  8. package/CHANGELOG.md +321 -12
  9. package/CONTRIBUTING.md +1 -13
  10. package/README.md +138 -187
  11. package/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
  12. package/docs/agent-customization-guide.md +208 -0
  13. package/docs/custom-agent-installation.md +169 -0
  14. package/docs/document-sharding-guide.md +449 -0
  15. package/docs/ide-info/crush.md +1 -1
  16. package/docs/ide-info/cursor.md +7 -7
  17. package/docs/ide-info/iflow.md +3 -3
  18. package/docs/ide-info/opencode.md +1 -1
  19. package/docs/index.md +227 -0
  20. package/docs/installers-bundlers/ide-injections.md +2 -2
  21. package/docs/installers-bundlers/installers-modules-platforms-reference.md +80 -19
  22. package/docs/v4-to-v6-upgrade.md +21 -19
  23. package/docs/v6-open-items.md +17 -0
  24. package/docs/web-bundles-gemini-gpt-guide.md +473 -0
  25. package/eslint.config.mjs +2 -0
  26. package/package.json +6 -3
  27. package/src/core/_module-installer/install-config.yaml +17 -10
  28. package/src/core/_module-installer/installer.js +0 -8
  29. package/src/core/agents/bmad-master.agent.yaml +5 -5
  30. package/src/core/agents/bmad-web-orchestrator.agent.xml +8 -17
  31. package/src/core/resources/excalidraw/README.md +160 -0
  32. package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
  33. package/src/core/resources/excalidraw/library-loader.md +50 -0
  34. package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
  35. package/src/core/tasks/advanced-elicitation-methods.csv +21 -0
  36. package/{bmad/core/tasks/adv-elicit.xml → src/core/tasks/advanced-elicitation.xml} +6 -4
  37. package/src/core/tasks/index-docs.xml +1 -1
  38. package/src/core/tasks/validate-workflow.xml +1 -1
  39. package/src/core/tasks/workflow.xml +126 -22
  40. package/src/core/tools/shard-doc.xml +54 -45
  41. package/src/core/workflows/brainstorming/README.md +6 -16
  42. package/src/core/workflows/brainstorming/instructions.md +6 -5
  43. package/src/core/workflows/brainstorming/template.md +4 -0
  44. package/src/core/workflows/brainstorming/workflow.yaml +8 -13
  45. package/src/core/workflows/party-mode/instructions.md +2 -7
  46. package/src/core/workflows/party-mode/workflow.yaml +11 -6
  47. package/src/modules/bmb/README.md +135 -73
  48. package/src/modules/bmb/_module-installer/install-config.yaml +9 -4
  49. package/src/modules/bmb/agents/bmad-builder.agent.yaml +11 -12
  50. package/src/modules/bmb/docs/agent-compilation.md +340 -0
  51. package/src/modules/bmb/docs/agent-menu-patterns.md +524 -0
  52. package/src/modules/bmb/docs/expert-agent-architecture.md +364 -0
  53. package/src/modules/bmb/docs/index.md +55 -0
  54. package/src/modules/bmb/docs/module-agent-architecture.md +367 -0
  55. package/src/modules/bmb/docs/simple-agent-architecture.md +288 -0
  56. package/src/modules/bmb/docs/understanding-agent-types.md +184 -0
  57. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md +242 -0
  58. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md +24 -0
  59. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md +108 -0
  60. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md +46 -0
  61. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md +39 -0
  62. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +152 -0
  63. package/src/modules/bmb/reference/agents/module-examples/README.md +50 -0
  64. package/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +53 -0
  65. package/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +57 -0
  66. package/src/modules/bmb/reference/agents/simple-examples/README.md +223 -0
  67. package/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml +126 -0
  68. package/src/modules/bmb/reference/readme.md +3 -0
  69. package/src/modules/bmb/workflows/audit-workflow/checklist.md +5 -6
  70. package/src/modules/bmb/workflows/audit-workflow/instructions.md +6 -6
  71. package/src/modules/bmb/workflows/audit-workflow/workflow.yaml +2 -2
  72. package/src/modules/bmb/workflows/convert-legacy/README.md +5 -5
  73. package/src/modules/bmb/workflows/convert-legacy/checklist.md +2 -2
  74. package/src/modules/bmb/workflows/convert-legacy/instructions.md +17 -17
  75. package/src/modules/bmb/workflows/convert-legacy/workflow.yaml +6 -10
  76. package/src/modules/bmb/workflows/create-agent/agent-validation-checklist.md +174 -0
  77. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +99 -120
  78. package/src/modules/bmb/workflows/create-agent/communication-presets.csv +61 -0
  79. package/src/modules/bmb/workflows/create-agent/instructions.md +171 -82
  80. package/src/modules/bmb/workflows/create-agent/workflow.yaml +26 -20
  81. package/src/modules/bmb/workflows/create-module/README.md +163 -154
  82. package/src/modules/bmb/workflows/create-module/checklist.md +1 -10
  83. package/src/modules/bmb/workflows/create-module/installer-templates/install-config.yaml +1 -1
  84. package/src/modules/bmb/workflows/create-module/instructions.md +13 -17
  85. package/src/modules/bmb/workflows/create-module/module-structure.md +39 -5
  86. package/src/modules/bmb/workflows/create-module/workflow.yaml +21 -13
  87. package/src/modules/bmb/workflows/create-workflow/README.md +4 -4
  88. package/src/modules/bmb/workflows/create-workflow/checklist.md +1 -1
  89. package/src/modules/bmb/workflows/create-workflow/instructions.md +46 -37
  90. package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +219 -42
  91. package/src/modules/bmb/workflows/create-workflow/workflow-template/instructions.md +4 -2
  92. package/src/modules/bmb/workflows/create-workflow/workflow-template/workflow.yaml +12 -16
  93. package/src/modules/bmb/workflows/create-workflow/workflow.yaml +7 -8
  94. package/src/modules/bmb/workflows/edit-agent/README.md +174 -47
  95. package/src/modules/bmb/workflows/edit-agent/instructions.md +399 -35
  96. package/src/modules/bmb/workflows/edit-agent/workflow.yaml +27 -13
  97. package/src/modules/bmb/workflows/edit-module/README.md +2 -2
  98. package/src/modules/bmb/workflows/edit-module/checklist.md +2 -2
  99. package/src/modules/bmb/workflows/edit-module/instructions.md +7 -5
  100. package/src/modules/bmb/workflows/edit-module/workflow.yaml +11 -13
  101. package/src/modules/bmb/workflows/edit-workflow/instructions.md +4 -4
  102. package/src/modules/bmb/workflows/edit-workflow/workflow.yaml +6 -8
  103. package/src/modules/bmb/workflows/module-brief/README.md +2 -2
  104. package/src/modules/bmb/workflows/module-brief/checklist.md +2 -2
  105. package/src/modules/bmb/workflows/module-brief/instructions.md +3 -2
  106. package/src/modules/bmb/workflows/module-brief/workflow.yaml +12 -7
  107. package/src/modules/bmgd/README.md +208 -0
  108. package/src/modules/bmgd/_module-installer/install-config.yaml +54 -0
  109. package/src/modules/bmgd/agents/game-architect.agent.yaml +33 -0
  110. package/src/modules/bmgd/agents/game-designer.agent.yaml +40 -0
  111. package/src/modules/bmgd/agents/game-dev.agent.yaml +40 -0
  112. package/src/modules/bmgd/agents/game-scrum-master.agent.yaml +75 -0
  113. package/src/modules/bmgd/teams/default-party.csv +10 -0
  114. package/src/modules/{bmm → bmgd}/teams/team-gamedev.yaml +5 -1
  115. package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +130 -0
  116. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/workflow.yaml +10 -10
  117. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/instructions.md +44 -28
  118. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/workflow.yaml +9 -17
  119. package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/instructions-gdd.md +58 -31
  120. package/src/modules/bmgd/workflows/2-design/gdd/workflow.yaml +81 -0
  121. package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/instructions-narrative.md +75 -28
  122. package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/workflow.yaml +6 -12
  123. package/src/modules/bmgd/workflows/3-technical/game-architecture/architecture-patterns.yaml +321 -0
  124. package/src/modules/bmgd/workflows/3-technical/game-architecture/architecture-template.md +103 -0
  125. package/src/modules/bmgd/workflows/3-technical/game-architecture/checklist.md +240 -0
  126. package/src/modules/bmgd/workflows/3-technical/game-architecture/decision-catalog.yaml +222 -0
  127. package/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +701 -0
  128. package/src/modules/bmgd/workflows/3-technical/game-architecture/pattern-categories.csv +13 -0
  129. package/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.yaml +69 -0
  130. package/src/modules/bmgd/workflows/4-production/code-review/backlog_template.md +12 -0
  131. package/src/modules/bmgd/workflows/4-production/code-review/checklist.md +22 -0
  132. package/src/modules/bmgd/workflows/4-production/code-review/instructions.md +398 -0
  133. package/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +61 -0
  134. package/src/modules/bmgd/workflows/4-production/correct-course/checklist.md +279 -0
  135. package/src/modules/bmgd/workflows/4-production/correct-course/instructions.md +206 -0
  136. package/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +58 -0
  137. package/src/modules/bmgd/workflows/4-production/create-story/checklist.md +240 -0
  138. package/src/modules/bmgd/workflows/4-production/create-story/instructions.md +256 -0
  139. package/src/modules/bmgd/workflows/4-production/create-story/template.md +51 -0
  140. package/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +74 -0
  141. package/src/modules/bmgd/workflows/4-production/dev-story/checklist.md +38 -0
  142. package/src/modules/bmgd/workflows/4-production/dev-story/instructions.md +267 -0
  143. package/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +58 -0
  144. package/src/modules/bmgd/workflows/4-production/epic-tech-context/checklist.md +17 -0
  145. package/src/modules/bmgd/workflows/4-production/epic-tech-context/instructions.md +164 -0
  146. package/src/modules/bmgd/workflows/4-production/epic-tech-context/template.md +76 -0
  147. package/src/modules/bmgd/workflows/4-production/epic-tech-context/workflow.yaml +58 -0
  148. package/src/modules/bmgd/workflows/4-production/retrospective/instructions.md +1443 -0
  149. package/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +57 -0
  150. package/src/modules/bmgd/workflows/4-production/sprint-planning/checklist.md +33 -0
  151. package/src/modules/bmgd/workflows/4-production/sprint-planning/instructions.md +234 -0
  152. package/src/modules/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml +55 -0
  153. package/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml +51 -0
  154. package/src/modules/bmgd/workflows/4-production/story-context/checklist.md +16 -0
  155. package/src/modules/bmgd/workflows/4-production/story-context/context-template.xml +34 -0
  156. package/src/modules/bmgd/workflows/4-production/story-context/instructions.md +209 -0
  157. package/src/modules/bmgd/workflows/4-production/story-context/workflow.yaml +63 -0
  158. package/src/modules/bmgd/workflows/4-production/story-done/instructions.md +111 -0
  159. package/src/modules/bmgd/workflows/4-production/story-done/workflow.yaml +28 -0
  160. package/src/modules/bmgd/workflows/4-production/story-ready/instructions.md +117 -0
  161. package/src/modules/bmgd/workflows/4-production/story-ready/workflow.yaml +25 -0
  162. package/src/modules/bmm/README.md +79 -92
  163. package/src/modules/bmm/_module-installer/install-config.yaml +9 -23
  164. package/src/modules/bmm/_module-installer/installer.js +2 -2
  165. package/src/modules/bmm/agents/analyst.agent.yaml +25 -19
  166. package/src/modules/bmm/agents/architect.agent.yaml +28 -19
  167. package/src/modules/bmm/agents/dev.agent.yaml +12 -15
  168. package/src/modules/bmm/agents/pm.agent.yaml +40 -22
  169. package/src/modules/bmm/agents/sm.agent.yaml +30 -24
  170. package/src/modules/bmm/agents/tea.agent.yaml +25 -17
  171. package/src/modules/bmm/agents/tech-writer.agent.yaml +80 -0
  172. package/src/modules/bmm/agents/ux-designer.agent.yaml +22 -12
  173. package/src/modules/bmm/docs/README.md +240 -0
  174. package/src/modules/bmm/docs/agents-guide.md +1058 -0
  175. package/src/modules/bmm/docs/brownfield-guide.md +762 -0
  176. package/src/modules/bmm/docs/enterprise-agentic-development.md +686 -0
  177. package/src/modules/bmm/docs/faq.md +588 -0
  178. package/src/modules/bmm/docs/glossary.md +320 -0
  179. package/src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw +5919 -0
  180. package/src/modules/bmm/docs/images/workflow-method-greenfield.svg +2 -0
  181. package/src/modules/bmm/docs/party-mode.md +224 -0
  182. package/src/modules/bmm/docs/quick-spec-flow.md +652 -0
  183. package/src/modules/bmm/docs/quick-start.md +382 -0
  184. package/src/modules/bmm/docs/scale-adaptive-system.md +618 -0
  185. package/src/modules/bmm/docs/test-architecture.md +396 -0
  186. package/src/modules/bmm/{workflows/3-solutioning/architecture/readme.md → docs/workflow-architecture-reference.md} +132 -84
  187. package/src/modules/bmm/{workflows/document-project/README.md → docs/workflow-document-project-reference.md} +49 -4
  188. package/src/modules/bmm/docs/workflows-analysis.md +370 -0
  189. package/src/modules/bmm/docs/workflows-implementation.md +296 -0
  190. package/src/modules/bmm/docs/workflows-planning.md +612 -0
  191. package/src/modules/bmm/docs/workflows-solutioning.md +554 -0
  192. package/src/modules/bmm/teams/default-party.csv +20 -0
  193. package/src/modules/bmm/teams/team-fullstack.yaml +2 -0
  194. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +45 -24
  195. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +8 -8
  196. package/src/modules/bmm/workflows/1-analysis/domain-research/instructions.md +425 -0
  197. package/src/modules/bmm/workflows/1-analysis/domain-research/template.md +180 -0
  198. package/src/modules/bmm/workflows/1-analysis/domain-research/workflow.yaml +56 -0
  199. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +435 -232
  200. package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +93 -77
  201. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +32 -14
  202. package/src/modules/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +144 -0
  203. package/src/modules/bmm/workflows/1-analysis/research/checklist-technical.md +249 -0
  204. package/src/modules/bmm/workflows/1-analysis/research/checklist.md +156 -59
  205. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +70 -65
  206. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +205 -143
  207. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +55 -46
  208. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +116 -83
  209. package/src/modules/bmm/workflows/1-analysis/research/template-market.md +37 -1
  210. package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +36 -1
  211. package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +25 -12
  212. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +51 -26
  213. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +67 -16
  214. package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +292 -63
  215. package/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +13 -0
  216. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +544 -290
  217. package/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md +165 -23
  218. package/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv +11 -0
  219. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +50 -18
  220. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +146 -36
  221. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +67 -4
  222. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-generate-stories.md +436 -0
  223. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +874 -163
  224. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +132 -6
  225. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +54 -20
  226. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +36 -28
  227. package/src/modules/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml +0 -26
  228. package/src/modules/bmm/workflows/3-solutioning/architecture/architecture-template.md +1 -1
  229. package/src/modules/bmm/workflows/3-solutioning/architecture/checklist.md +5 -9
  230. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +215 -150
  231. package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml +72 -26
  232. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md +80 -0
  233. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md +616 -0
  234. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml +63 -0
  235. package/src/modules/bmm/workflows/3-solutioning/{solutioning-gate-check → implementation-readiness}/checklist.md +7 -13
  236. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/instructions.md +332 -0
  237. package/src/modules/bmm/workflows/3-solutioning/{solutioning-gate-check → implementation-readiness}/template.md +1 -1
  238. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml +64 -0
  239. package/src/modules/bmm/workflows/4-implementation/code-review/instructions.md +25 -18
  240. package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +31 -26
  241. package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
  242. package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +7 -2
  243. package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +38 -25
  244. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +22 -18
  245. package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +38 -14
  246. package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.md +8 -3
  247. package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +35 -5
  248. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/checklist.md +1 -1
  249. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/instructions.md +10 -6
  250. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +40 -16
  251. package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +1207 -243
  252. package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +38 -26
  253. package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +28 -15
  254. package/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +1 -1
  255. package/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +16 -6
  256. package/src/modules/bmm/workflows/4-implementation/story-context/checklist.md +1 -1
  257. package/src/modules/bmm/workflows/4-implementation/story-context/context-template.xml +1 -1
  258. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +23 -15
  259. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +39 -8
  260. package/src/modules/bmm/workflows/4-implementation/story-done/instructions.md +1 -1
  261. package/src/modules/bmm/workflows/4-implementation/story-done/workflow.yaml +5 -4
  262. package/src/modules/bmm/workflows/4-implementation/story-ready/instructions.md +6 -6
  263. package/src/modules/bmm/workflows/4-implementation/story-ready/workflow.yaml +5 -7
  264. package/src/modules/bmm/workflows/diagrams/_shared/excalidraw-library.json +90 -0
  265. package/src/modules/bmm/workflows/diagrams/_shared/excalidraw-templates.yaml +127 -0
  266. package/src/modules/bmm/workflows/diagrams/create-dataflow/checklist.md +39 -0
  267. package/src/modules/bmm/workflows/diagrams/create-dataflow/instructions.md +130 -0
  268. package/src/modules/bmm/workflows/diagrams/create-dataflow/workflow.yaml +27 -0
  269. package/src/modules/bmm/workflows/diagrams/create-diagram/checklist.md +43 -0
  270. package/src/modules/bmm/workflows/diagrams/create-diagram/instructions.md +141 -0
  271. package/src/modules/bmm/workflows/diagrams/create-diagram/workflow.yaml +27 -0
  272. package/src/modules/bmm/workflows/diagrams/create-flowchart/checklist.md +49 -0
  273. package/src/modules/bmm/workflows/diagrams/create-flowchart/instructions.md +241 -0
  274. package/src/modules/bmm/workflows/diagrams/create-flowchart/workflow.yaml +27 -0
  275. package/src/modules/bmm/workflows/diagrams/create-wireframe/checklist.md +38 -0
  276. package/src/modules/bmm/workflows/diagrams/create-wireframe/instructions.md +133 -0
  277. package/src/modules/bmm/workflows/diagrams/create-wireframe/workflow.yaml +27 -0
  278. package/src/modules/bmm/workflows/document-project/checklist.md +1 -1
  279. package/src/modules/bmm/workflows/document-project/instructions.md +5 -5
  280. package/src/modules/bmm/workflows/document-project/workflow.yaml +2 -7
  281. package/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md +4 -4
  282. package/src/modules/bmm/workflows/document-project/workflows/deep-dive.yaml +5 -5
  283. package/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md +13 -13
  284. package/src/modules/bmm/workflows/document-project/workflows/full-scan.yaml +5 -5
  285. package/src/modules/bmm/workflows/techdoc/documentation-standards.md +262 -0
  286. package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +2 -2
  287. package/src/modules/bmm/workflows/testarch/atdd/instructions.md +2 -2
  288. package/src/modules/bmm/workflows/testarch/atdd/workflow.yaml +2 -9
  289. package/src/modules/bmm/workflows/testarch/automate/instructions.md +2 -2
  290. package/src/modules/bmm/workflows/testarch/automate/workflow.yaml +2 -11
  291. package/src/modules/bmm/workflows/testarch/ci/checklist.md +4 -4
  292. package/src/modules/bmm/workflows/testarch/ci/instructions.md +2 -2
  293. package/src/modules/bmm/workflows/testarch/ci/workflow.yaml +2 -10
  294. package/src/modules/bmm/workflows/testarch/framework/checklist.md +4 -4
  295. package/src/modules/bmm/workflows/testarch/framework/instructions.md +2 -2
  296. package/src/modules/bmm/workflows/testarch/framework/workflow.yaml +2 -8
  297. package/src/modules/bmm/workflows/testarch/nfr-assess/instructions.md +1 -1
  298. package/src/modules/bmm/workflows/testarch/nfr-assess/workflow.yaml +2 -11
  299. package/src/modules/bmm/workflows/testarch/test-design/checklist.md +4 -4
  300. package/src/modules/bmm/workflows/testarch/test-design/instructions.md +175 -14
  301. package/src/modules/bmm/workflows/testarch/test-design/test-design-template.md +4 -4
  302. package/src/modules/bmm/workflows/testarch/test-design/workflow.yaml +7 -11
  303. package/src/modules/bmm/workflows/testarch/test-review/instructions.md +1 -1
  304. package/src/modules/bmm/workflows/testarch/test-review/workflow.yaml +2 -9
  305. package/src/modules/bmm/workflows/testarch/trace/instructions.md +9 -9
  306. package/src/modules/bmm/workflows/testarch/trace/workflow.yaml +2 -13
  307. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +249 -212
  308. package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +6 -5
  309. package/src/modules/bmm/workflows/workflow-status/instructions.md +177 -113
  310. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +126 -0
  311. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +114 -0
  312. package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-3.yaml → method-brownfield.yaml} +48 -33
  313. package/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +101 -0
  314. package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-1.yaml → quick-flow-brownfield.yaml} +18 -18
  315. package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  316. package/src/modules/bmm/workflows/workflow-status/project-levels.yaml +1 -1
  317. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
  318. package/src/modules/bmm/workflows/workflow-status/workflow.yaml +5 -5
  319. package/src/modules/cis/README.md +153 -0
  320. package/src/modules/cis/_module-installer/install-config.yaml +6 -4
  321. package/src/modules/cis/agents/README.md +1 -1
  322. package/src/modules/cis/agents/brainstorming-coach.agent.yaml +13 -8
  323. package/src/modules/cis/agents/creative-problem-solver.agent.yaml +13 -8
  324. package/src/modules/cis/agents/design-thinking-coach.agent.yaml +13 -8
  325. package/src/modules/cis/agents/innovation-strategist.agent.yaml +13 -8
  326. package/src/modules/cis/agents/presentation-master.agent.yaml +60 -0
  327. package/src/modules/cis/agents/storyteller.agent.yaml +13 -8
  328. package/src/modules/cis/teams/creative-squad.yaml +1 -0
  329. package/src/modules/cis/teams/default-party.csv +11 -0
  330. package/src/modules/cis/workflows/README.md +102 -30
  331. package/src/modules/cis/workflows/design-thinking/instructions.md +4 -2
  332. package/src/modules/cis/workflows/design-thinking/workflow.yaml +7 -12
  333. package/src/modules/cis/workflows/innovation-strategy/instructions.md +7 -5
  334. package/src/modules/cis/workflows/innovation-strategy/template.md +3 -3
  335. package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +7 -12
  336. package/src/modules/cis/workflows/problem-solving/instructions.md +4 -2
  337. package/src/modules/cis/workflows/problem-solving/workflow.yaml +7 -12
  338. package/src/modules/cis/workflows/storytelling/instructions.md +14 -4
  339. package/src/modules/cis/workflows/storytelling/workflow.yaml +7 -12
  340. package/src/utility/models/action-command-header.md +0 -0
  341. package/src/utility/models/agent-activation-ide.xml +3 -3
  342. package/src/utility/models/agent-activation-web.xml +4 -4
  343. package/src/utility/models/agent-command-header.md +1 -0
  344. package/src/utility/models/fragments/activation-steps.xml +3 -2
  345. package/src/utility/models/fragments/handler-validate-workflow.xml +1 -1
  346. package/src/utility/models/fragments/handler-workflow.xml +1 -1
  347. package/src/utility/models/fragments/web-bundle-activation-steps.xml +3 -3
  348. package/test/test-installation-components.js +214 -0
  349. package/tools/bmad-npx-wrapper.js +10 -98
  350. package/tools/cli/README.md +50 -32
  351. package/tools/cli/bundlers/web-bundler.js +322 -26
  352. package/tools/cli/commands/agent-install.js +409 -0
  353. package/tools/cli/commands/install.js +2 -5
  354. package/tools/cli/installers/lib/core/config-collector.js +279 -39
  355. package/tools/cli/installers/lib/core/detector.js +62 -7
  356. package/tools/cli/installers/lib/core/ide-config-manager.js +3 -1
  357. package/tools/cli/installers/lib/core/installer.js +338 -46
  358. package/tools/cli/installers/lib/core/manifest-generator.js +33 -117
  359. package/tools/cli/installers/lib/core/manifest.js +6 -2
  360. package/tools/cli/installers/lib/ide/_base-ide.js +82 -3
  361. package/tools/cli/installers/lib/ide/antigravity.js +463 -0
  362. package/tools/cli/installers/lib/ide/auggie.js +81 -238
  363. package/tools/cli/installers/lib/ide/claude-code.js +90 -25
  364. package/tools/cli/installers/lib/ide/cline.js +15 -18
  365. package/tools/cli/installers/lib/ide/codex.js +225 -71
  366. package/tools/cli/installers/lib/ide/crush.js +14 -50
  367. package/tools/cli/installers/lib/ide/cursor.js +116 -8
  368. package/tools/cli/installers/lib/ide/gemini.js +87 -37
  369. package/tools/cli/installers/lib/ide/github-copilot.js +121 -35
  370. package/tools/cli/installers/lib/ide/iflow.js +13 -30
  371. package/tools/cli/installers/lib/ide/kilo.js +20 -16
  372. package/tools/cli/installers/lib/ide/manager.js +50 -0
  373. package/tools/cli/installers/lib/ide/opencode.js +61 -17
  374. package/tools/cli/installers/lib/ide/qwen.js +39 -11
  375. package/tools/cli/installers/lib/ide/roo.js +27 -62
  376. package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +90 -0
  377. package/tools/cli/installers/lib/ide/{task-tool-command-generator.js → shared/task-tool-command-generator.js} +1 -1
  378. package/tools/cli/installers/lib/ide/{workflow-command-generator.js → shared/workflow-command-generator.js} +11 -9
  379. package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -0
  380. package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
  381. package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
  382. package/tools/cli/installers/lib/ide/{workflow-command-template.md → templates/workflow-command-template.md} +3 -5
  383. package/tools/cli/installers/lib/ide/trae.js +20 -32
  384. package/tools/cli/installers/lib/ide/windsurf.js +65 -8
  385. package/tools/cli/installers/lib/modules/manager.js +213 -7
  386. package/tools/cli/lib/agent/compiler.js +390 -0
  387. package/tools/cli/lib/agent/installer.js +725 -0
  388. package/tools/cli/lib/agent/template-engine.js +152 -0
  389. package/tools/cli/lib/cli-utils.js +52 -50
  390. package/tools/cli/lib/config.js +3 -1
  391. package/tools/cli/lib/ui.js +34 -17
  392. package/tools/cli/lib/xml-handler.js +1 -0
  393. package/tools/cli/lib/yaml-format.js +2 -1
  394. package/tools/cli/lib/yaml-xml-builder.js +76 -8
  395. package/tools/schema/agent.js +12 -3
  396. package/.claude/commands/bmad/bmb/agents/bmad-builder.md +0 -70
  397. package/.claude/commands/bmad/bmb/workflows/README.md +0 -67
  398. package/.claude/commands/bmad/bmb/workflows/audit-workflow.md +0 -15
  399. package/.claude/commands/bmad/bmb/workflows/convert-legacy.md +0 -15
  400. package/.claude/commands/bmad/bmb/workflows/create-agent.md +0 -15
  401. package/.claude/commands/bmad/bmb/workflows/create-module.md +0 -15
  402. package/.claude/commands/bmad/bmb/workflows/create-workflow.md +0 -15
  403. package/.claude/commands/bmad/bmb/workflows/edit-agent.md +0 -15
  404. package/.claude/commands/bmad/bmb/workflows/edit-module.md +0 -15
  405. package/.claude/commands/bmad/bmb/workflows/edit-workflow.md +0 -15
  406. package/.claude/commands/bmad/bmb/workflows/module-brief.md +0 -15
  407. package/.claude/commands/bmad/bmb/workflows/redoc.md +0 -15
  408. package/.claude/commands/bmad/bmd/agents/cli-chief.md +0 -108
  409. package/.claude/commands/bmad/bmd/agents/doc-keeper.md +0 -115
  410. package/.claude/commands/bmad/bmd/agents/release-chief.md +0 -109
  411. package/.claude/commands/bmad/core/agents/bmad-master.md +0 -71
  412. package/.claude/commands/bmad/core/tasks/index-docs.md +0 -9
  413. package/.claude/commands/bmad/core/tools/shard-doc.md +0 -9
  414. package/.claude/commands/bmad/core/workflows/README.md +0 -27
  415. package/.claude/commands/bmad/core/workflows/brainstorming.md +0 -15
  416. package/.claude/commands/bmad/core/workflows/party-mode.md +0 -15
  417. package/.claude/hooks/bmad-tts-injector.sh +0 -415
  418. package/.claude/hooks/bmad-voice-manager.sh +0 -511
  419. package/.claude/hooks/check-output-style.sh +0 -112
  420. package/.claude/hooks/download-extra-voices.sh +0 -244
  421. package/.claude/hooks/github-star-reminder.sh +0 -154
  422. package/.claude/hooks/language-manager.sh +0 -392
  423. package/.claude/hooks/learn-manager.sh +0 -475
  424. package/.claude/hooks/personality-manager.sh +0 -438
  425. package/.claude/hooks/piper-download-voices.sh +0 -165
  426. package/.claude/hooks/piper-installer.sh +0 -178
  427. package/.claude/hooks/piper-multispeaker-registry.sh +0 -165
  428. package/.claude/hooks/piper-voice-manager.sh +0 -293
  429. package/.claude/hooks/play-tts-elevenlabs.sh +0 -404
  430. package/.claude/hooks/play-tts-piper.sh +0 -338
  431. package/.claude/hooks/play-tts.sh +0 -100
  432. package/.claude/hooks/provider-commands.sh +0 -540
  433. package/.claude/hooks/provider-manager.sh +0 -298
  434. package/.claude/hooks/replay-target-audio.sh +0 -95
  435. package/.claude/hooks/sentiment-manager.sh +0 -201
  436. package/.claude/hooks/speed-manager.sh +0 -291
  437. package/.claude/hooks/voice-manager.sh +0 -594
  438. package/.claude/hooks/voices-config.sh +0 -70
  439. package/.claude/settings.local.json +0 -41
  440. package/bmad/_cfg/agent-manifest.csv +0 -7
  441. package/bmad/_cfg/agents/bmb-bmad-builder.customize.yaml +0 -42
  442. package/bmad/_cfg/agents/bmd-cli-chief.customize.yaml +0 -32
  443. package/bmad/_cfg/agents/bmd-doc-keeper.customize.yaml +0 -42
  444. package/bmad/_cfg/agents/bmd-release-chief.customize.yaml +0 -42
  445. package/bmad/_cfg/agents/core-bmad-master.customize.yaml +0 -42
  446. package/bmad/_cfg/files-manifest.csv +0 -83
  447. package/bmad/_cfg/manifest.yaml +0 -12
  448. package/bmad/_cfg/task-manifest.csv +0 -5
  449. package/bmad/_cfg/tool-manifest.csv +0 -2
  450. package/bmad/_cfg/workflow-manifest.csv +0 -15
  451. package/bmad/bmb/README.md +0 -132
  452. package/bmad/bmb/agents/bmad-builder.md +0 -70
  453. package/bmad/bmb/config.yaml +0 -14
  454. package/bmad/bmb/workflows/audit-workflow/checklist.md +0 -143
  455. package/bmad/bmb/workflows/audit-workflow/instructions.md +0 -341
  456. package/bmad/bmb/workflows/audit-workflow/template.md +0 -118
  457. package/bmad/bmb/workflows/audit-workflow/workflow.yaml +0 -23
  458. package/bmad/bmb/workflows/audit-workflow/workflow.yaml.bak +0 -21
  459. package/bmad/bmb/workflows/convert-legacy/README.md +0 -262
  460. package/bmad/bmb/workflows/convert-legacy/checklist.md +0 -205
  461. package/bmad/bmb/workflows/convert-legacy/instructions.md +0 -377
  462. package/bmad/bmb/workflows/convert-legacy/workflow.yaml +0 -32
  463. package/bmad/bmb/workflows/create-agent/README.md +0 -320
  464. package/bmad/bmb/workflows/create-agent/agent-architecture.md +0 -419
  465. package/bmad/bmb/workflows/create-agent/agent-architecture.md.bak +0 -412
  466. package/bmad/bmb/workflows/create-agent/agent-command-patterns.md +0 -759
  467. package/bmad/bmb/workflows/create-agent/agent-command-patterns.md.bak +0 -759
  468. package/bmad/bmb/workflows/create-agent/agent-types.md +0 -292
  469. package/bmad/bmb/workflows/create-agent/brainstorm-context.md +0 -174
  470. package/bmad/bmb/workflows/create-agent/checklist.md +0 -62
  471. package/bmad/bmb/workflows/create-agent/communication-styles.md +0 -202
  472. package/bmad/bmb/workflows/create-agent/instructions.md +0 -430
  473. package/bmad/bmb/workflows/create-agent/workflow.yaml +0 -37
  474. package/bmad/bmb/workflows/create-module/README.md +0 -220
  475. package/bmad/bmb/workflows/create-module/README.md.bak +0 -218
  476. package/bmad/bmb/workflows/create-module/brainstorm-context.md +0 -137
  477. package/bmad/bmb/workflows/create-module/checklist.md +0 -244
  478. package/bmad/bmb/workflows/create-module/checklist.md.bak +0 -245
  479. package/bmad/bmb/workflows/create-module/installer-templates/install-config.yaml +0 -92
  480. package/bmad/bmb/workflows/create-module/installer-templates/installer.js +0 -231
  481. package/bmad/bmb/workflows/create-module/installer-templates/installer.js.bak +0 -231
  482. package/bmad/bmb/workflows/create-module/instructions.md +0 -581
  483. package/bmad/bmb/workflows/create-module/instructions.md.bak +0 -521
  484. package/bmad/bmb/workflows/create-module/module-structure.md +0 -366
  485. package/bmad/bmb/workflows/create-module/module-structure.md.bak +0 -310
  486. package/bmad/bmb/workflows/create-module/workflow.yaml +0 -42
  487. package/bmad/bmb/workflows/create-module/workflow.yaml.bak +0 -40
  488. package/bmad/bmb/workflows/create-workflow/README.md +0 -277
  489. package/bmad/bmb/workflows/create-workflow/brainstorm-context.md +0 -197
  490. package/bmad/bmb/workflows/create-workflow/checklist.md +0 -94
  491. package/bmad/bmb/workflows/create-workflow/instructions.md +0 -716
  492. package/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md +0 -1150
  493. package/bmad/bmb/workflows/create-workflow/workflow-template/checklist.md +0 -24
  494. package/bmad/bmb/workflows/create-workflow/workflow-template/instructions.md +0 -13
  495. package/bmad/bmb/workflows/create-workflow/workflow-template/template.md +0 -9
  496. package/bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml +0 -39
  497. package/bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml.bak +0 -39
  498. package/bmad/bmb/workflows/create-workflow/workflow.yaml +0 -40
  499. package/bmad/bmb/workflows/create-workflow/workflow.yaml.bak +0 -38
  500. package/bmad/bmb/workflows/edit-agent/README.md +0 -112
  501. package/bmad/bmb/workflows/edit-agent/checklist.md +0 -112
  502. package/bmad/bmb/workflows/edit-agent/instructions.md +0 -290
  503. package/bmad/bmb/workflows/edit-agent/workflow.yaml +0 -33
  504. package/bmad/bmb/workflows/edit-module/README.md +0 -187
  505. package/bmad/bmb/workflows/edit-module/checklist.md +0 -165
  506. package/bmad/bmb/workflows/edit-module/instructions.md +0 -339
  507. package/bmad/bmb/workflows/edit-module/workflow.yaml +0 -34
  508. package/bmad/bmb/workflows/edit-workflow/README.md +0 -119
  509. package/bmad/bmb/workflows/edit-workflow/checklist.md +0 -70
  510. package/bmad/bmb/workflows/edit-workflow/instructions.md +0 -342
  511. package/bmad/bmb/workflows/edit-workflow/workflow.yaml +0 -27
  512. package/bmad/bmb/workflows/edit-workflow/workflow.yaml.bak +0 -25
  513. package/bmad/bmb/workflows/module-brief/README.md +0 -264
  514. package/bmad/bmb/workflows/module-brief/checklist.md +0 -116
  515. package/bmad/bmb/workflows/module-brief/instructions.md +0 -267
  516. package/bmad/bmb/workflows/module-brief/template.md +0 -275
  517. package/bmad/bmb/workflows/module-brief/workflow.yaml +0 -29
  518. package/bmad/bmb/workflows/module-brief/workflow.yaml.bak +0 -27
  519. package/bmad/bmb/workflows/redoc/README.md +0 -87
  520. package/bmad/bmb/workflows/redoc/checklist.md +0 -99
  521. package/bmad/bmb/workflows/redoc/instructions.md +0 -265
  522. package/bmad/bmb/workflows/redoc/workflow.yaml +0 -32
  523. package/bmad/bmb/workflows/redoc/workflow.yaml.bak +0 -31
  524. package/bmad/bmd/README.md +0 -193
  525. package/bmad/bmd/README.md.bak +0 -193
  526. package/bmad/bmd/agents/cli-chief-sidecar/instructions.md +0 -102
  527. package/bmad/bmd/agents/cli-chief-sidecar/instructions.md.bak +0 -102
  528. package/bmad/bmd/agents/cli-chief-sidecar/knowledge/README.md +0 -68
  529. package/bmad/bmd/agents/cli-chief-sidecar/knowledge/README.md.bak +0 -68
  530. package/bmad/bmd/agents/cli-chief-sidecar/knowledge/cli-reference.md +0 -123
  531. package/bmad/bmd/agents/cli-chief-sidecar/knowledge/cli-reference.md.bak +0 -123
  532. package/bmad/bmd/agents/cli-chief-sidecar/memories.md +0 -53
  533. package/bmad/bmd/agents/cli-chief-sidecar/memories.md.bak +0 -53
  534. package/bmad/bmd/agents/cli-chief.md +0 -108
  535. package/bmad/bmd/agents/cli-chief.md.bak +0 -108
  536. package/bmad/bmd/agents/doc-keeper-sidecar/instructions.md +0 -177
  537. package/bmad/bmd/agents/doc-keeper-sidecar/instructions.md.bak +0 -177
  538. package/bmad/bmd/agents/doc-keeper-sidecar/knowledge/README.md +0 -81
  539. package/bmad/bmd/agents/doc-keeper-sidecar/knowledge/README.md.bak +0 -81
  540. package/bmad/bmd/agents/doc-keeper-sidecar/memories.md +0 -88
  541. package/bmad/bmd/agents/doc-keeper-sidecar/memories.md.bak +0 -88
  542. package/bmad/bmd/agents/doc-keeper.md +0 -115
  543. package/bmad/bmd/agents/doc-keeper.md.bak +0 -115
  544. package/bmad/bmd/agents/release-chief-sidecar/instructions.md +0 -164
  545. package/bmad/bmd/agents/release-chief-sidecar/instructions.md.bak +0 -164
  546. package/bmad/bmd/agents/release-chief-sidecar/knowledge/README.md +0 -82
  547. package/bmad/bmd/agents/release-chief-sidecar/knowledge/README.md.bak +0 -82
  548. package/bmad/bmd/agents/release-chief-sidecar/memories.md +0 -73
  549. package/bmad/bmd/agents/release-chief-sidecar/memories.md.bak +0 -73
  550. package/bmad/bmd/agents/release-chief.md +0 -109
  551. package/bmad/bmd/agents/release-chief.md.bak +0 -109
  552. package/bmad/bmd/config.yaml +0 -10
  553. package/bmad/core/agents/bmad-master.md +0 -71
  554. package/bmad/core/agents/bmad-web-orchestrator.agent.xml +0 -122
  555. package/bmad/core/config.yaml +0 -9
  556. package/bmad/core/tasks/adv-elicit-methods.csv +0 -39
  557. package/bmad/core/tasks/index-docs.xml +0 -65
  558. package/bmad/core/tasks/validate-workflow.xml +0 -89
  559. package/bmad/core/tasks/workflow.xml +0 -174
  560. package/bmad/core/tools/shard-doc.xml +0 -100
  561. package/bmad/core/workflows/brainstorming/README.md +0 -271
  562. package/bmad/core/workflows/brainstorming/brain-methods.csv +0 -36
  563. package/bmad/core/workflows/brainstorming/instructions.md +0 -314
  564. package/bmad/core/workflows/brainstorming/template.md +0 -102
  565. package/bmad/core/workflows/brainstorming/workflow.yaml +0 -43
  566. package/bmad/core/workflows/party-mode/instructions.md +0 -188
  567. package/bmad/core/workflows/party-mode/workflow.yaml +0 -23
  568. package/bmad/docs/claude-code-instructions.md +0 -25
  569. package/bmad/docs/codex-instructions.md +0 -21
  570. package/bmd/README.md +0 -193
  571. package/bmd/agents/cli-chief-sidecar/instructions.md +0 -102
  572. package/bmd/agents/cli-chief-sidecar/knowledge/README.md +0 -68
  573. package/bmd/agents/cli-chief-sidecar/knowledge/cli-reference.md +0 -123
  574. package/bmd/agents/cli-chief-sidecar/memories.md +0 -53
  575. package/bmd/agents/cli-chief.agent.yaml +0 -126
  576. package/bmd/agents/doc-keeper-sidecar/instructions.md +0 -177
  577. package/bmd/agents/doc-keeper-sidecar/knowledge/README.md +0 -81
  578. package/bmd/agents/doc-keeper-sidecar/memories.md +0 -88
  579. package/bmd/agents/doc-keeper.agent.yaml +0 -137
  580. package/bmd/agents/release-chief-sidecar/instructions.md +0 -164
  581. package/bmd/agents/release-chief-sidecar/knowledge/README.md +0 -82
  582. package/bmd/agents/release-chief-sidecar/memories.md +0 -73
  583. package/bmd/agents/release-chief.agent.yaml +0 -127
  584. package/bmd/bmad-custom-module-installer-plan.md +0 -1176
  585. package/bmd/config.yaml +0 -12
  586. package/docs/bmad-brownfield-guide.md +0 -1260
  587. package/docs/conversion-report-shard-doc-2025-10-26.md +0 -188
  588. package/docs/installers-bundlers/web-bundler-usage.md +0 -54
  589. package/src/core/tasks/adv-elicit.xml +0 -104
  590. package/src/modules/bmb/workflows/create-agent/README.md +0 -320
  591. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +0 -419
  592. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +0 -759
  593. package/src/modules/bmb/workflows/create-agent/agent-types.md +0 -292
  594. package/src/modules/bmb/workflows/create-agent/checklist.md +0 -62
  595. package/src/modules/bmb/workflows/create-agent/communication-styles.md +0 -202
  596. package/src/modules/bmb/workflows/edit-agent/checklist.md +0 -112
  597. package/src/modules/bmb/workflows/redoc/README.md +0 -87
  598. package/src/modules/bmb/workflows/redoc/checklist.md +0 -99
  599. package/src/modules/bmb/workflows/redoc/instructions.md +0 -265
  600. package/src/modules/bmb/workflows/redoc/workflow.yaml +0 -34
  601. package/src/modules/bmm/agents/game-architect.agent.yaml +0 -35
  602. package/src/modules/bmm/agents/game-designer.agent.yaml +0 -47
  603. package/src/modules/bmm/agents/game-dev.agent.yaml +0 -39
  604. package/src/modules/bmm/sub-modules/claude-code/config.yaml +0 -5
  605. package/src/modules/bmm/sub-modules/claude-code/injections.yaml +0 -242
  606. package/src/modules/bmm/sub-modules/claude-code/readme.md +0 -87
  607. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-analysis/api-documenter.md +0 -102
  608. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-analysis/codebase-analyzer.md +0 -82
  609. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-analysis/data-analyst.md +0 -101
  610. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-analysis/pattern-detector.md +0 -84
  611. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/dependency-mapper.md +0 -83
  612. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/epic-optimizer.md +0 -81
  613. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/requirements-analyst.md +0 -61
  614. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/technical-decisions-curator.md +0 -168
  615. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/trend-spotter.md +0 -115
  616. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/user-journey-mapper.md +0 -123
  617. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-planning/user-researcher.md +0 -72
  618. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-research/market-researcher.md +0 -51
  619. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-research/tech-debt-auditor.md +0 -106
  620. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-review/document-reviewer.md +0 -102
  621. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-review/technical-evaluator.md +0 -68
  622. package/src/modules/bmm/sub-modules/claude-code/sub-agents/bmad-review/test-coverage-analyzer.md +0 -108
  623. package/src/modules/bmm/tasks/daily-standup.xml +0 -85
  624. package/src/modules/bmm/tasks/retrospective.xml +0 -104
  625. package/src/modules/bmm/testarch/README.md +0 -311
  626. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/README.md +0 -38
  627. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +0 -109
  628. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -29
  629. package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +0 -221
  630. package/src/modules/bmm/workflows/1-analysis/product-brief/README.md +0 -180
  631. package/src/modules/bmm/workflows/1-analysis/research/README.md +0 -454
  632. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +0 -259
  633. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +0 -190
  634. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +0 -337
  635. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +0 -107
  636. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +0 -329
  637. package/src/modules/bmm/workflows/2-plan-workflows/README.md +0 -258
  638. package/src/modules/bmm/workflows/2-plan-workflows/gdd/README.md +0 -222
  639. package/src/modules/bmm/workflows/2-plan-workflows/gdd/workflow.yaml +0 -67
  640. package/src/modules/bmm/workflows/2-plan-workflows/prd/epics-template.md +0 -63
  641. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md +0 -167
  642. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-level1-stories.md +0 -278
  643. package/src/modules/bmm/workflows/3-solutioning/README.md +0 -1
  644. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
  645. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +0 -273
  646. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/validation-criteria.yaml +0 -189
  647. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +0 -40
  648. package/src/modules/bmm/workflows/4-implementation/README.md +0 -221
  649. package/src/modules/bmm/workflows/4-implementation/code-review/README.md +0 -69
  650. package/src/modules/bmm/workflows/4-implementation/correct-course/README.md +0 -73
  651. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +0 -129
  652. package/src/modules/bmm/workflows/4-implementation/dev-story/AUDIT-REPORT.md +0 -367
  653. package/src/modules/bmm/workflows/4-implementation/dev-story/README.md +0 -206
  654. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
  655. package/src/modules/bmm/workflows/4-implementation/retrospective/README.md +0 -77
  656. package/src/modules/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
  657. package/src/modules/bmm/workflows/4-implementation/story-context/README.md +0 -234
  658. package/src/modules/bmm/workflows/README.md +0 -577
  659. package/src/modules/bmm/workflows/document-project/templates/README.md +0 -38
  660. package/src/modules/bmm/workflows/testarch/README.md +0 -26
  661. package/src/modules/bmm/workflows/testarch/atdd/README.md +0 -672
  662. package/src/modules/bmm/workflows/testarch/automate/README.md +0 -869
  663. package/src/modules/bmm/workflows/testarch/ci/README.md +0 -493
  664. package/src/modules/bmm/workflows/testarch/framework/README.md +0 -340
  665. package/src/modules/bmm/workflows/testarch/nfr-assess/README.md +0 -469
  666. package/src/modules/bmm/workflows/testarch/test-design/README.md +0 -493
  667. package/src/modules/bmm/workflows/testarch/test-review/README.md +0 -775
  668. package/src/modules/bmm/workflows/testarch/trace/README.md +0 -802
  669. package/src/modules/bmm/workflows/workflow-status/README.md +0 -241
  670. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  671. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  672. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  673. package/src/modules/bmm/workflows/workflow-status/paths/game-design.yaml +0 -75
  674. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  675. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml +0 -78
  676. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  677. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  678. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.md +0 -30
  679. package/src/modules/cis/readme.md +0 -86
  680. package/test/fixtures/agent-schema/invalid/persona/principles-as-string.agent.yaml +0 -23
  681. package/v6-open-items.md +0 -23
  682. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-brain-methods.csv +0 -0
  683. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-context.md +0 -0
  684. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/checklist.md +0 -0
  685. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/template.md +0 -0
  686. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/checklist.md +0 -0
  687. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/action-platformer.md +0 -0
  688. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/adventure.md +0 -0
  689. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/card-game.md +0 -0
  690. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/fighting.md +0 -0
  691. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/horror.md +0 -0
  692. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/idle-incremental.md +0 -0
  693. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/metroidvania.md +0 -0
  694. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/moba.md +0 -0
  695. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/party-game.md +0 -0
  696. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/puzzle.md +0 -0
  697. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/racing.md +0 -0
  698. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rhythm.md +0 -0
  699. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/roguelike.md +0 -0
  700. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rpg.md +0 -0
  701. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sandbox.md +0 -0
  702. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/shooter.md +0 -0
  703. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/simulation.md +0 -0
  704. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sports.md +0 -0
  705. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/strategy.md +0 -0
  706. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/survival.md +0 -0
  707. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/text-based.md +0 -0
  708. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/tower-defense.md +0 -0
  709. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/turn-based-tactics.md +0 -0
  710. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/visual-novel.md +0 -0
  711. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types.csv +0 -0
  712. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/gdd-template.md +0 -0
  713. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/checklist.md +0 -0
  714. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/narrative-template.md +0 -0
@@ -0,0 +1,762 @@
1
+ # BMad Method Brownfield Development Guide
2
+
3
+ **Complete guide for working with existing codebases**
4
+
5
+ **Reading Time:** ~35 minutes
6
+
7
+ ---
8
+
9
+ ## Quick Navigation
10
+
11
+ **Jump to:**
12
+
13
+ - [Quick Reference](#quick-reference) - Commands and files
14
+ - [Common Scenarios](#common-scenarios) - Real-world examples
15
+ - [Best Practices](#best-practices) - Success tips
16
+
17
+ ---
18
+
19
+ ## What is Brownfield Development?
20
+
21
+ Brownfield projects involve working within existing codebases rather than starting fresh:
22
+
23
+ - **Bug fixes** - Single file changes
24
+ - **Small features** - Adding to existing modules
25
+ - **Feature sets** - Multiple related features
26
+ - **Major integrations** - Complex architectural additions
27
+ - **System expansions** - Enterprise-scale enhancements
28
+
29
+ **Key Difference from Greenfield:** You must understand and respect existing patterns, architecture, and constraints.
30
+
31
+ **Core Principle:** AI agents need comprehensive documentation to understand existing code before they can effectively plan or implement changes.
32
+
33
+ ---
34
+
35
+ ## Getting Started
36
+
37
+ ### Understanding Planning Tracks
38
+
39
+ For complete track details, see [Scale Adaptive System](./scale-adaptive-system.md).
40
+
41
+ **Brownfield tracks at a glance:**
42
+
43
+ | Track | Scope | Typical Stories | Key Difference |
44
+ | --------------------- | -------------------------- | --------------- | ----------------------------------------------- |
45
+ | **Quick Flow** | Bug fixes, small features | 1-15 | Must understand affected code and patterns |
46
+ | **BMad Method** | Feature sets, integrations | 10-50+ | Integrate with existing architecture |
47
+ | **Enterprise Method** | Enterprise expansions | 30+ | Full system documentation + compliance required |
48
+
49
+ **Note:** Story counts are guidance, not definitions. Tracks are chosen based on planning needs.
50
+
51
+ ### Track Selection for Brownfield
52
+
53
+ When you run `workflow-init`, it handles brownfield intelligently:
54
+
55
+ **Step 1: Shows what it found**
56
+
57
+ - Old planning docs (PRD, epics, stories)
58
+ - Existing codebase
59
+
60
+ **Step 2: Asks about YOUR work**
61
+
62
+ > "Are these works in progress, previous effort, or proposed work?"
63
+
64
+ - **(a) Works in progress** → Uses artifacts to determine level
65
+ - **(b) Previous effort** → Asks you to describe NEW work
66
+ - **(c) Proposed work** → Uses artifacts as guidance
67
+ - **(d) None of these** → You explain your work
68
+
69
+ **Step 3: Analyzes your description**
70
+
71
+ - Keywords: "fix", "bug" → Quick Flow, "dashboard", "platform" → BMad Method, "enterprise", "multi-tenant" → Enterprise Method
72
+ - Complexity assessment
73
+ - Confirms suggested track with you
74
+
75
+ **Key Principle:** System asks about YOUR current work first, uses old artifacts as context only.
76
+
77
+ **Example: Old Complex PRD, New Simple Work**
78
+
79
+ ```
80
+ System: "Found PRD.md (BMad Method track, 30 stories, 6 months old)"
81
+ System: "Is this work in progress or previous effort?"
82
+ You: "Previous effort - I'm just fixing a bug now"
83
+ System: "Tell me about your current work"
84
+ You: "Update payment method enums"
85
+ System: "Quick Flow track (tech-spec approach). Correct?"
86
+ You: "Yes"
87
+ ✅ Creates Quick Flow workflow
88
+ ```
89
+
90
+ ---
91
+
92
+ ## Phase 0: Documentation (Critical First Step)
93
+
94
+ 🚨 **For brownfield projects: Always ensure adequate AI-usable documentation before planning**
95
+
96
+ ### Default Recommendation: Run document-project
97
+
98
+ **Best practice:** Run `document-project` workflow unless you have **confirmed, trusted, AI-optimized documentation**.
99
+
100
+ ### Why Document-Project is Almost Always the Right Choice
101
+
102
+ Existing documentation often has quality issues that break AI workflows:
103
+
104
+ **Common Problems:**
105
+
106
+ - **Too Much Information (TMI):** Massive markdown files with 10s or 100s of level 2 sections
107
+ - **Out of Date:** Documentation hasn't been updated with recent code changes
108
+ - **Wrong Format:** Written for humans, not AI agents (lacks structure, index, clear patterns)
109
+ - **Incomplete Coverage:** Missing critical architecture, patterns, or setup info
110
+ - **Inconsistent Quality:** Some areas documented well, others not at all
111
+
112
+ **Impact on AI Agents:**
113
+
114
+ - AI agents hit token limits reading massive files
115
+ - Outdated docs cause hallucinations (agent thinks old patterns still apply)
116
+ - Missing structure means agents can't find relevant information
117
+ - Incomplete coverage leads to incorrect assumptions
118
+
119
+ ### Documentation Decision Tree
120
+
121
+ **Step 1: Assess Existing Documentation Quality**
122
+
123
+ Ask yourself:
124
+
125
+ - ✅ Is it **current** (updated in last 30 days)?
126
+ - ✅ Is it **AI-optimized** (structured with index.md, clear sections, <500 lines per file)?
127
+ - ✅ Is it **comprehensive** (architecture, patterns, setup all documented)?
128
+ - ✅ Do you **trust** it completely for AI agent consumption?
129
+
130
+ **If ANY answer is NO → Run `document-project`**
131
+
132
+ **Step 2: Check for Massive Documents**
133
+
134
+ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
135
+
136
+ 1. **First:** Run `shard-doc` tool to split large files:
137
+
138
+ ```bash
139
+ # Load BMad Master or any agent
140
+ {bmad_folder}/core/tools/shard-doc.xml --input docs/massive-doc.md
141
+ ```
142
+
143
+ - Splits on level 2 sections by default
144
+ - Creates organized, manageable files
145
+ - Preserves content integrity
146
+
147
+ 2. **Then:** Run `index-docs` task to create navigation:
148
+
149
+ ```bash
150
+ {bmad_folder}/core/tasks/index-docs.xml --directory ./docs
151
+ ```
152
+
153
+ 3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
154
+
155
+ ### Four Real-World Scenarios
156
+
157
+ | Scenario | You Have | Action | Why |
158
+ | -------- | ------------------------------------------ | -------------------------- | --------------------------------------- |
159
+ | **A** | No documentation | `document-project` | Only option - generate from scratch |
160
+ | **B** | Docs exist but massive/outdated/incomplete | `document-project` | Safer to regenerate than trust bad docs |
161
+ | **C** | Good docs but no structure | `shard-doc` → `index-docs` | Structure existing content for AI |
162
+ | **D** | Confirmed AI-optimized docs with index.md | Skip Phase 0 | Rare - only if you're 100% confident |
163
+
164
+ ### Scenario A: No Documentation (Most Common)
165
+
166
+ **Action: Run document-project workflow**
167
+
168
+ 1. Load Analyst or Technical Writer (Paige) agent
169
+ 2. Run `*document-project`
170
+ 3. Choose scan level:
171
+ - **Quick** (2-5min): Pattern analysis, no source reading
172
+ - **Deep** (10-30min): Reads critical paths - **Recommended**
173
+ - **Exhaustive** (30-120min): Reads all files
174
+
175
+ **Outputs:**
176
+
177
+ - `docs/index.md` - Master AI entry point
178
+ - `docs/project-overview.md` - Executive summary
179
+ - `docs/architecture.md` - Architecture analysis
180
+ - `docs/source-tree-analysis.md` - Directory structure
181
+ - Additional files based on project type (API, web app, etc.)
182
+
183
+ ### Scenario B: Docs Exist But Quality Unknown/Poor (Very Common)
184
+
185
+ **Action: Run document-project workflow (regenerate)**
186
+
187
+ Even if `docs/` folder exists, if you're unsure about quality → **regenerate**.
188
+
189
+ **Why regenerate instead of index?**
190
+
191
+ - Outdated docs → AI makes wrong assumptions
192
+ - Incomplete docs → AI invents missing information
193
+ - TMI docs → AI hits token limits, misses key info
194
+ - Human-focused docs → Missing AI-critical structure
195
+
196
+ **document-project** will:
197
+
198
+ - Scan actual codebase (source of truth)
199
+ - Generate fresh, accurate documentation
200
+ - Structure properly for AI consumption
201
+ - Include only relevant, current information
202
+
203
+ ### Scenario C: Good Docs But Needs Structure
204
+
205
+ **Action: Shard massive files, then index**
206
+
207
+ If you have **good, current documentation** but it's in massive files:
208
+
209
+ **Step 1: Shard large documents**
210
+
211
+ ```bash
212
+ # For each massive doc (>500 lines or 10+ level 2 sections)
213
+ {bmad_folder}/core/tools/shard-doc.xml \
214
+ --input docs/api-documentation.md \
215
+ --output docs/api/ \
216
+ --level 2 # Split on ## headers (default)
217
+ ```
218
+
219
+ **Step 2: Generate index**
220
+
221
+ ```bash
222
+ {bmad_folder}/core/tasks/index-docs.xml --directory ./docs
223
+ ```
224
+
225
+ **Step 3: Validate**
226
+
227
+ - Review generated `docs/index.md`
228
+ - Check that sharded files are <500 lines each
229
+ - Verify content is current and accurate
230
+ - **If anything seems off → Run document-project instead**
231
+
232
+ ### Scenario D: Confirmed AI-Optimized Documentation (Rare)
233
+
234
+ **Action: Skip Phase 0**
235
+
236
+ Only skip if ALL conditions met:
237
+
238
+ - ✅ `docs/index.md` exists and is comprehensive
239
+ - ✅ Documentation updated within last 30 days
240
+ - ✅ All doc files <500 lines with clear structure
241
+ - ✅ Covers architecture, patterns, setup, API surface
242
+ - ✅ You personally verified quality for AI consumption
243
+ - ✅ Previous AI agents used it successfully
244
+
245
+ **If unsure → Run document-project** (costs 10-30 minutes, saves hours of confusion)
246
+
247
+ ### Why document-project is Critical
248
+
249
+ Without AI-optimized documentation, workflows fail:
250
+
251
+ - **tech-spec** (Quick Flow) can't auto-detect stack/patterns → Makes wrong assumptions
252
+ - **PRD** (BMad Method) can't reference existing code → Designs incompatible features
253
+ - **architecture** can't build on existing structure → Suggests conflicting patterns
254
+ - **story-context** can't inject existing patterns → Dev agent rewrites working code
255
+ - **dev-story** invents implementations → Breaks existing integrations
256
+
257
+ ### Key Principle
258
+
259
+ **When in doubt, run document-project.**
260
+
261
+ It's better to spend 10-30 minutes generating fresh, accurate docs than to waste hours debugging AI agents working from bad documentation.
262
+
263
+ ---
264
+
265
+ ## Workflow Phases by Track
266
+
267
+ ### Phase 1: Analysis (Optional)
268
+
269
+ **Workflows:**
270
+
271
+ - `brainstorm-project` - Solution exploration
272
+ - `research` - Technical/market research
273
+ - `product-brief` - Strategic planning (BMad Method/Enterprise tracks only)
274
+
275
+ **When to use:** Complex features, technical decisions, strategic additions
276
+
277
+ **When to skip:** Bug fixes, well-understood features, time-sensitive changes
278
+
279
+ See the [Workflows section in BMM README](../README.md) for details.
280
+
281
+ ### Phase 2: Planning (Required)
282
+
283
+ **Planning approach adapts by track:**
284
+
285
+ **Quick Flow:** Use `tech-spec` workflow
286
+
287
+ - Creates tech-spec.md
288
+ - Auto-detects existing stack (brownfield)
289
+ - Confirms conventions with you
290
+ - Generates implementation-ready stories
291
+
292
+ **BMad Method/Enterprise:** Use `prd` workflow
293
+
294
+ - Creates PRD.md with FRs/NFRs only
295
+ - References existing architecture
296
+ - Plans integration points
297
+ - Epics+Stories created AFTER architecture phase
298
+
299
+ **Brownfield-specific:** See [Scale Adaptive System](./scale-adaptive-system.md) for complete workflow paths by track.
300
+
301
+ ### Phase 3: Solutioning (BMad Method/Enterprise Only)
302
+
303
+ **Critical for brownfield:**
304
+
305
+ - Review existing architecture FIRST
306
+ - Document integration points explicitly
307
+ - Plan backward compatibility
308
+ - Consider migration strategy
309
+
310
+ **Workflows:**
311
+
312
+ - `create-architecture` - Extend architecture docs (BMad Method/Enterprise)
313
+ - `create-epics-and-stories` - Create epics and stories AFTER architecture
314
+ - `implementation-readiness` - Validate before implementation (BMad Method/Enterprise)
315
+
316
+ ### Phase 4: Implementation (All Tracks)
317
+
318
+ **Sprint-based development through story iteration:**
319
+
320
+ ```mermaid
321
+ flowchart TD
322
+ SPRINT[sprint-planning<br/>Initialize tracking]
323
+ EPIC[epic-tech-context<br/>Per epic]
324
+ CREATE[create-story]
325
+ CONTEXT[story-context]
326
+ DEV[dev-story]
327
+ REVIEW[code-review]
328
+ CHECK{More stories?}
329
+ RETRO[retrospective<br/>Per epic]
330
+
331
+ SPRINT --> EPIC
332
+ EPIC --> CREATE
333
+ CREATE --> CONTEXT
334
+ CONTEXT --> DEV
335
+ DEV --> REVIEW
336
+ REVIEW --> CHECK
337
+ CHECK -->|Yes| CREATE
338
+ CHECK -->|No| RETRO
339
+
340
+ style SPRINT fill:#bfb,stroke:#333,stroke-width:2px,color:#000
341
+ style RETRO fill:#fbf,stroke:#333,stroke-width:2px,color:#000
342
+ ```
343
+
344
+ **Status Progression:**
345
+
346
+ - Epic: `backlog → contexted`
347
+ - Story: `backlog → drafted → ready-for-dev → in-progress → review → done`
348
+
349
+ **Brownfield-Specific Implementation Tips:**
350
+
351
+ 1. **Respect existing patterns** - Follow established conventions
352
+ 2. **Test integration thoroughly** - Validate interactions with existing code
353
+ 3. **Use feature flags** - Enable gradual rollout
354
+ 4. **Context injection matters** - epic-tech-context and story-context reference existing patterns
355
+
356
+ ---
357
+
358
+ ## Best Practices
359
+
360
+ ### 1. Always Document First
361
+
362
+ Even if you know the code, AI agents need `document-project` output for context. Run it before planning.
363
+
364
+ ### 2. Be Specific About Current Work
365
+
366
+ When workflow-init asks about your work:
367
+
368
+ - ✅ "Update payment method enums to include Apple Pay"
369
+ - ❌ "Fix stuff"
370
+
371
+ ### 3. Choose Right Documentation Approach
372
+
373
+ - **Has good docs, no index?** → Run `index-docs` task (fast)
374
+ - **No docs or need codebase analysis?** → Run `document-project` (Deep scan)
375
+
376
+ ### 4. Respect Existing Patterns
377
+
378
+ Tech-spec and story-context will detect conventions. Follow them unless explicitly modernizing.
379
+
380
+ ### 5. Plan Integration Points Explicitly
381
+
382
+ Document in tech-spec/architecture:
383
+
384
+ - Which existing modules you'll modify
385
+ - What APIs/services you'll integrate with
386
+ - How data flows between new and existing code
387
+
388
+ ### 6. Design for Gradual Rollout
389
+
390
+ - Use feature flags for new functionality
391
+ - Plan rollback strategies
392
+ - Maintain backward compatibility
393
+ - Create migration scripts if needed
394
+
395
+ ### 7. Test Integration Thoroughly
396
+
397
+ - Regression testing of existing features
398
+ - Integration point validation
399
+ - Performance impact assessment
400
+ - API contract verification
401
+
402
+ ### 8. Use Sprint Planning Effectively
403
+
404
+ - Run `sprint-planning` at Phase 4 start
405
+ - Context epics before drafting stories
406
+ - Update `sprint-status.yaml` as work progresses
407
+
408
+ ### 9. Leverage Context Injection
409
+
410
+ - Run `epic-tech-context` before story drafting
411
+ - Always create `story-context` before implementation
412
+ - These reference existing patterns for consistency
413
+
414
+ ### 10. Learn Continuously
415
+
416
+ - Run `retrospective` after each epic
417
+ - Incorporate learnings into next stories
418
+ - Update discovered patterns
419
+ - Share insights across team
420
+
421
+ ---
422
+
423
+ ## Common Scenarios
424
+
425
+ ### Scenario 1: Bug Fix (Quick Flow)
426
+
427
+ **Situation:** Authentication token expiration causing logout issues
428
+
429
+ **Track:** Quick Flow
430
+
431
+ **Workflow:**
432
+
433
+ 1. **Document:** Skip if auth system documented, else run `document-project` (Quick scan)
434
+ 2. **Plan:** Load PM → run `tech-spec`
435
+ - Analyzes bug
436
+ - Detects stack (Express, Jest)
437
+ - Confirms conventions
438
+ - Creates tech-spec.md + story
439
+ 3. **Implement:** Load DEV → run `dev-story`
440
+ 4. **Review:** Load DEV → run `code-review`
441
+
442
+ **Time:** 2-4 hours
443
+
444
+ ---
445
+
446
+ ### Scenario 2: Small Feature (Quick Flow)
447
+
448
+ **Situation:** Add "forgot password" to existing auth system
449
+
450
+ **Track:** Quick Flow
451
+
452
+ **Workflow:**
453
+
454
+ 1. **Document:** Run `document-project` (Deep scan of auth module if not documented)
455
+ 2. **Plan:** Load PM → run `tech-spec`
456
+ - Detects Next.js 13.4, NextAuth.js
457
+ - Analyzes existing auth patterns
458
+ - Confirms conventions
459
+ - Creates tech-spec.md + epic + 3-5 stories
460
+ 3. **Implement:** Load SM → `sprint-planning` → `create-story` → `story-context`
461
+ Load DEV → `dev-story` for each story
462
+ 4. **Review:** Load DEV → `code-review`
463
+
464
+ **Time:** 1-3 days
465
+
466
+ ---
467
+
468
+ ### Scenario 3: Feature Set (BMad Method)
469
+
470
+ **Situation:** Add user dashboard with analytics, preferences, activity
471
+
472
+ **Track:** BMad Method
473
+
474
+ **Workflow:**
475
+
476
+ 1. **Document:** Run `document-project` (Deep scan) - Critical for understanding existing UI patterns
477
+ 2. **Analyze:** Load Analyst → `research` (if evaluating analytics libraries)
478
+ 3. **Plan:** Load PM → `prd` (creates FRs/NFRs)
479
+ 4. **Solution:** Load Architect → `create-architecture` → `create-epics-and-stories` → `implementation-readiness`
480
+ 5. **Implement:** Sprint-based (10-15 stories)
481
+ - Load SM → `sprint-planning`
482
+ - Per epic: `epic-tech-context` → stories
483
+ - Load DEV → `dev-story` per story
484
+ 6. **Review:** Per story completion
485
+
486
+ **Time:** 1-2 weeks
487
+
488
+ ---
489
+
490
+ ### Scenario 4: Complex Integration (BMad Method)
491
+
492
+ **Situation:** Add real-time collaboration to document editor
493
+
494
+ **Track:** BMad Method
495
+
496
+ **Workflow:**
497
+
498
+ 1. **Document:** Run `document-project` (Exhaustive if not documented) - **Mandatory**
499
+ 2. **Analyze:** Load Analyst → `research` (WebSocket vs WebRTC vs CRDT)
500
+ 3. **Plan:** Load PM → `prd` (creates FRs/NFRs)
501
+ 4. **Solution:**
502
+ - Load Architect → `create-architecture` (extend for real-time layer)
503
+ - Load Architect → `create-epics-and-stories`
504
+ - Load Architect → `implementation-readiness`
505
+ 5. **Implement:** Sprint-based (20-30 stories)
506
+
507
+ **Time:** 3-6 weeks
508
+
509
+ ---
510
+
511
+ ### Scenario 5: Enterprise Expansion (Enterprise Method)
512
+
513
+ **Situation:** Add multi-tenancy to single-tenant SaaS platform
514
+
515
+ **Track:** Enterprise Method
516
+
517
+ **Workflow:**
518
+
519
+ 1. **Document:** Run `document-project` (Exhaustive) - **Mandatory**
520
+ 2. **Analyze:** **Required**
521
+ - `brainstorm-project` - Explore multi-tenancy approaches
522
+ - `research` - Database sharding, tenant isolation, pricing
523
+ - `product-brief` - Strategic document
524
+ 3. **Plan:** Load PM → `prd` (comprehensive FRs/NFRs)
525
+ 4. **Solution:**
526
+ - `create-architecture` - Full system architecture
527
+ - `integration-planning` - Phased migration strategy
528
+ - `create-architecture` - Multi-tenancy architecture
529
+ - `validate-architecture` - External review
530
+ - `create-epics-and-stories` - Create epics and stories
531
+ - `implementation-readiness` - Executive approval
532
+ 5. **Implement:** Phased sprint-based (50+ stories)
533
+
534
+ **Time:** 3-6 months
535
+
536
+ ---
537
+
538
+ ## Troubleshooting
539
+
540
+ ### AI Agents Lack Codebase Understanding
541
+
542
+ **Symptoms:**
543
+
544
+ - Suggestions don't align with existing patterns
545
+ - Ignores available components
546
+ - Doesn't reference existing code
547
+
548
+ **Solution:**
549
+
550
+ 1. Run `document-project` with Deep scan
551
+ 2. Verify `docs/index.md` exists
552
+ 3. Check documentation completeness
553
+ 4. Run deep-dive on specific areas if needed
554
+
555
+ ### Have Documentation But Agents Can't Find It
556
+
557
+ **Symptoms:**
558
+
559
+ - README.md, ARCHITECTURE.md exist
560
+ - AI agents ask questions already answered
561
+ - No `docs/index.md` file
562
+
563
+ **Solution:**
564
+
565
+ - **Quick fix:** Run `index-docs` task (2-5min)
566
+ - **Comprehensive:** Run `document-project` workflow (10-30min)
567
+
568
+ ### Integration Points Unclear
569
+
570
+ **Symptoms:**
571
+
572
+ - Not sure how to connect new code to existing
573
+ - Unsure which files to modify
574
+
575
+ **Solution:**
576
+
577
+ 1. Ensure `document-project` captured existing architecture
578
+ 2. Check `story-context` - should document integration points
579
+ 3. In tech-spec/architecture - explicitly document:
580
+ - Which existing modules to modify
581
+ - What APIs/services to integrate with
582
+ - Data flow between new and existing code
583
+ 4. Review architecture document for integration guidance
584
+
585
+ ### Existing Tests Breaking
586
+
587
+ **Symptoms:**
588
+
589
+ - Regression test failures
590
+ - Previously working functionality broken
591
+
592
+ **Solution:**
593
+
594
+ 1. Review changes against existing patterns
595
+ 2. Verify API contracts unchanged (unless intentionally versioned)
596
+ 3. Run `test-review` workflow (TEA agent)
597
+ 4. Add regression testing to DoD
598
+ 5. Consider feature flags for gradual rollout
599
+
600
+ ### Inconsistent Patterns Being Introduced
601
+
602
+ **Symptoms:**
603
+
604
+ - New code style doesn't match existing
605
+ - Different architectural approach
606
+
607
+ **Solution:**
608
+
609
+ 1. Check convention detection (Quick Spec Flow should detect patterns)
610
+ 2. Review documentation - ensure `document-project` captured patterns
611
+ 3. Use `story-context` - injects pattern guidance
612
+ 4. Add to code-review checklist: pattern adherence, convention consistency
613
+ 5. Run retrospective to identify deviations early
614
+
615
+ ---
616
+
617
+ ## Quick Reference
618
+
619
+ ### Commands by Phase
620
+
621
+ ```bash
622
+ # Phase 0: Documentation (If Needed)
623
+ # Analyst agent:
624
+ document-project # Create comprehensive docs (10-30min)
625
+ # OR load index-docs task for existing docs (2-5min)
626
+
627
+ # Phase 1: Analysis (Optional)
628
+ # Analyst agent:
629
+ brainstorm-project # Explore solutions
630
+ research # Gather data
631
+ product-brief # Strategic planning (BMad Method/Enterprise only)
632
+
633
+ # Phase 2: Planning (Required)
634
+ # PM agent:
635
+ tech-spec # Quick Flow track
636
+ prd # BMad Method/Enterprise tracks
637
+
638
+ # Phase 3: Solutioning (BMad Method/Enterprise)
639
+ # Architect agent:
640
+ create-architecture # Extend architecture
641
+ create-epics-and-stories # Create epics and stories (after architecture)
642
+ implementation-readiness # Final validation
643
+
644
+ # Phase 4: Implementation (All Tracks)
645
+ # SM agent:
646
+ sprint-planning # Initialize tracking
647
+ epic-tech-context # Epic context
648
+ create-story # Draft story
649
+ story-context # Story context
650
+
651
+ # DEV agent:
652
+ dev-story # Implement
653
+ code-review # Review
654
+
655
+ # SM agent:
656
+ retrospective # After epic
657
+ correct-course # If issues
658
+ ```
659
+
660
+ ### Key Files
661
+
662
+ **Phase 0 Output:**
663
+
664
+ - `docs/index.md` - **Master AI entry point (REQUIRED)**
665
+ - `docs/project-overview.md`
666
+ - `docs/architecture.md`
667
+ - `docs/source-tree-analysis.md`
668
+
669
+ **Phase 1-3 Tracking:**
670
+
671
+ - `docs/bmm-workflow-status.yaml` - Progress tracker
672
+
673
+ **Phase 2 Planning:**
674
+
675
+ - `docs/tech-spec.md` (Quick Flow track)
676
+ - `docs/PRD.md` (BMad Method/Enterprise tracks - FRs/NFRs only)
677
+
678
+ **Phase 3 Solutioning:**
679
+
680
+ - Epic breakdown (created after architecture)
681
+
682
+ **Phase 3 Architecture:**
683
+
684
+ - `docs/architecture.md` (BMad Method/Enterprise tracks)
685
+
686
+ **Phase 4 Implementation:**
687
+
688
+ - `docs/sprint-status.yaml` - **Single source of truth**
689
+ - `docs/epic-{n}-context.md`
690
+ - `docs/stories/{epic}-{story}-{title}.md`
691
+ - `docs/stories/{epic}-{story}-{title}-context.md`
692
+
693
+ ### Decision Flowchart
694
+
695
+ ```mermaid
696
+ flowchart TD
697
+ START([Brownfield Project])
698
+ CHECK{Has docs/<br/>index.md?}
699
+
700
+ START --> CHECK
701
+ CHECK -->|No| DOC[document-project<br/>Deep scan]
702
+ CHECK -->|Yes| TRACK{What Track?}
703
+
704
+ DOC --> TRACK
705
+
706
+ TRACK -->|Quick Flow| TS[tech-spec]
707
+ TRACK -->|BMad Method| PRD[prd → architecture]
708
+ TRACK -->|Enterprise| PRD2[prd → arch + security/devops]
709
+
710
+ TS --> IMPL[Phase 4<br/>Implementation]
711
+ PRD --> IMPL
712
+ PRD2 --> IMPL
713
+
714
+ style START fill:#f9f,stroke:#333,stroke-width:2px,color:#000
715
+ style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000
716
+ style IMPL fill:#bfb,stroke:#333,stroke-width:2px,color:#000
717
+ ```
718
+
719
+ ---
720
+
721
+ ## Prevention Tips
722
+
723
+ **Avoid issues before they happen:**
724
+
725
+ 1. ✅ **Always run document-project for brownfield** - Saves context issues later
726
+ 2. ✅ **Use fresh chats for complex workflows** - Prevents hallucinations
727
+ 3. ✅ **Verify files exist before workflows** - Check PRD, epics, stories present
728
+ 4. ✅ **Read agent menu first** - Confirm agent has the workflow
729
+ 5. ✅ **Start with simpler track if unsure** - Easy to upgrade (Quick Flow → BMad Method)
730
+ 6. ✅ **Keep status files updated** - Manual updates when needed
731
+ 7. ✅ **Run retrospectives after epics** - Catch issues early
732
+ 8. ✅ **Follow phase sequence** - Don't skip required phases
733
+
734
+ ---
735
+
736
+ ## Related Documentation
737
+
738
+ - **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding tracks and complexity
739
+ - **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Quick Flow
740
+ - **[Quick Start Guide](./quick-start.md)** - Getting started with BMM
741
+ - **[Glossary](./glossary.md)** - Key terminology
742
+ - **[FAQ](./faq.md)** - Common questions
743
+ - **[Workflow Documentation](./README.md#-workflow-guides)** - Complete workflow reference
744
+
745
+ ---
746
+
747
+ ## Support and Resources
748
+
749
+ **Community:**
750
+
751
+ - [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
752
+ - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
753
+ - [YouTube Channel](https://www.youtube.com/@BMadCode)
754
+
755
+ **Documentation:**
756
+
757
+ - [Test Architect Guide](./test-architecture.md) - Comprehensive testing strategy
758
+ - [BMM Module README](../README.md) - Complete module and workflow reference
759
+
760
+ ---
761
+
762
+ _Brownfield development is about understanding and respecting what exists while thoughtfully extending it._