bmad-method 4.27.6 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (274) hide show
  1. package/.bmad-core/agent-teams/team-all.yml +16 -0
  2. package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
  3. package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
  4. package/{bmad-core → .bmad-core}/agents/analyst.md +23 -29
  5. package/.bmad-core/agents/architect.md +66 -0
  6. package/.bmad-core/agents/bmad-master.md +104 -0
  7. package/.bmad-core/agents/bmad-orchestrator.md +81 -0
  8. package/.bmad-core/agents/dev.md +70 -0
  9. package/{bmad-core → .bmad-core}/agents/pm.md +24 -24
  10. package/{bmad-core → .bmad-core}/agents/po.md +24 -27
  11. package/.bmad-core/agents/qa.md +52 -0
  12. package/.bmad-core/agents/sm.md +55 -0
  13. package/.bmad-core/agents/ux-expert.md +66 -0
  14. package/{bmad-core → .bmad-core}/checklists/change-checklist.md +2 -2
  15. package/{bmad-core → .bmad-core}/checklists/story-draft-checklist.md +1 -1
  16. package/.bmad-core/data/bmad-kb.md +47 -0
  17. package/.bmad-core/schemas/agent-team-schema.yml +153 -0
  18. package/.bmad-core/tasks/advanced-elicitation.md +92 -0
  19. package/.bmad-core/tasks/brainstorming-techniques.md +238 -0
  20. package/.bmad-core/tasks/core-dump.md +74 -0
  21. package/{expansion-packs/bmad-creator-tools → .bmad-core}/tasks/create-agent.md +11 -9
  22. package/.bmad-core/tasks/create-doc.md +74 -0
  23. package/.bmad-core/tasks/create-expansion-pack.md +425 -0
  24. package/.bmad-core/tasks/create-next-story.md +206 -0
  25. package/.bmad-core/tasks/create-team.md +229 -0
  26. package/{bmad-core → .bmad-core}/tasks/doc-migration-task.md +9 -9
  27. package/{common → .bmad-core}/tasks/execute-checklist.md +6 -2
  28. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
  29. package/{bmad-core → .bmad-core}/tasks/index-docs.md +7 -3
  30. package/{bmad-core → .bmad-core}/tasks/shard-doc.md +7 -25
  31. package/.bmad-core/templates/agent-tmpl.md +58 -0
  32. package/.bmad-core/templates/architecture-tmpl.md +771 -0
  33. package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
  34. package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
  35. package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
  36. package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
  37. package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
  38. package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
  39. package/.bmad-core/templates/fullstack-architecture-tmpl.md +1016 -0
  40. package/.bmad-core/templates/market-research-tmpl.md +261 -0
  41. package/.bmad-core/templates/prd-tmpl.md +200 -0
  42. package/.bmad-core/templates/project-brief-tmpl.md +228 -0
  43. package/.bmad-core/templates/simple-project-prd-tmpl.md +461 -0
  44. package/.bmad-core/templates/story-tmpl.md +61 -0
  45. package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
  46. package/.bmad-core/utils/agent-switcher.ide.md +112 -0
  47. package/.bmad-core/utils/template-format.md +26 -0
  48. package/.bmad-core/utils/workflow-management.md +224 -0
  49. package/.bmad-core/web-bundles/agents/analyst.txt +1684 -0
  50. package/.bmad-core/web-bundles/agents/architect.txt +3584 -0
  51. package/.bmad-core/web-bundles/agents/bmad-master.txt +9491 -0
  52. package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1466 -0
  53. package/{dist → .bmad-core/web-bundles}/agents/dev.txt +71 -179
  54. package/{dist → .bmad-core/web-bundles}/agents/pm.txt +1058 -624
  55. package/{dist → .bmad-core/web-bundles}/agents/po.txt +138 -337
  56. package/.bmad-core/web-bundles/agents/qa.txt +129 -0
  57. package/.bmad-core/web-bundles/agents/sm.txt +658 -0
  58. package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
  59. package/.bmad-core/web-bundles/teams/team-all.txt +10757 -0
  60. package/.bmad-core/web-bundles/teams/team-fullstack.txt +10109 -0
  61. package/.bmad-core/web-bundles/teams/team-no-ui.txt +8950 -0
  62. package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
  63. package/.bmad-core/workflows/brownfield-service.yml +117 -0
  64. package/.bmad-core/workflows/brownfield-ui.yml +127 -0
  65. package/.bmad-core/workflows/greenfield-fullstack.yml +177 -0
  66. package/.bmad-core/workflows/greenfield-service.yml +143 -0
  67. package/.bmad-core/workflows/greenfield-ui.yml +172 -0
  68. package/.claude/commands/analyst.md +63 -0
  69. package/.claude/commands/architect.md +70 -0
  70. package/.claude/commands/bmad-master.md +108 -0
  71. package/.claude/commands/bmad-orchestrator.md +85 -0
  72. package/.claude/commands/dev.md +74 -0
  73. package/.claude/commands/pm.md +63 -0
  74. package/.claude/commands/po.md +64 -0
  75. package/.claude/commands/qa.md +56 -0
  76. package/.claude/commands/sm.md +59 -0
  77. package/.claude/commands/ux-expert.md +70 -0
  78. package/.cursor/rules/analyst.mdc +77 -0
  79. package/.cursor/rules/architect.mdc +84 -0
  80. package/.cursor/rules/bmad-master.mdc +122 -0
  81. package/.cursor/rules/bmad-orchestrator.mdc +99 -0
  82. package/.cursor/rules/dev.mdc +88 -0
  83. package/.cursor/rules/pm.mdc +77 -0
  84. package/.cursor/rules/po.mdc +78 -0
  85. package/.cursor/rules/qa.mdc +70 -0
  86. package/.cursor/rules/sm.mdc +73 -0
  87. package/.cursor/rules/ux-expert.mdc +84 -0
  88. package/.roo/.roomodes +95 -0
  89. package/.roo/README.md +38 -0
  90. package/.vscode/extensions.json +6 -0
  91. package/.vscode/settings.json +75 -49
  92. package/.windsurf/rules/analyst.md +71 -0
  93. package/.windsurf/rules/architect.md +78 -0
  94. package/.windsurf/rules/bmad-master.md +116 -0
  95. package/.windsurf/rules/bmad-orchestrator.md +93 -0
  96. package/.windsurf/rules/dev.md +82 -0
  97. package/.windsurf/rules/pm.md +71 -0
  98. package/.windsurf/rules/po.md +72 -0
  99. package/.windsurf/rules/qa.md +64 -0
  100. package/.windsurf/rules/sm.md +67 -0
  101. package/.windsurf/rules/ux-expert.md +78 -0
  102. package/CHANGELOG.md +16 -459
  103. package/CONTRIBUTING.md +5 -168
  104. package/LICENSE +1 -1
  105. package/README.md +230 -77
  106. package/docs/bmad-workflow-guide.md +15 -19
  107. package/docs/claude-code-guide.md +119 -0
  108. package/docs/cursor-guide.md +127 -0
  109. package/docs/roo-code-guide.md +140 -0
  110. package/docs/sample-output/simple-fullstack-greenfield/prd.md +42 -0
  111. package/docs/versioning-and-releases.md +16 -8
  112. package/docs/versions.md +5 -4
  113. package/docs/windsurf-guide.md +127 -0
  114. package/expansion-packs/README.md +112 -2
  115. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/README.md +9 -9
  116. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/agents/infra-devops-platform.md +15 -14
  117. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/checklists/infrastructure-checklist.md +1 -1
  118. package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
  119. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/review-infrastructure.md +4 -4
  120. package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/validate-infrastructure.md +4 -4
  121. package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
  122. package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
  123. package/package.json +11 -19
  124. package/tools/bmad-npx-wrapper.js +1 -1
  125. package/tools/builders/web-builder.js +28 -563
  126. package/tools/cli.js +22 -55
  127. package/tools/installer/README.md +53 -3
  128. package/tools/installer/bin/bmad.js +56 -294
  129. package/tools/installer/config/install.config.yml +139 -0
  130. package/tools/installer/lib/config-loader.js +34 -198
  131. package/tools/installer/lib/file-manager.js +7 -200
  132. package/tools/installer/lib/ide-setup.js +189 -545
  133. package/tools/installer/lib/installer.js +61 -1171
  134. package/tools/installer/package-lock.json +3 -3
  135. package/tools/installer/package.json +4 -4
  136. package/tools/installer/templates/claude-commands.md +7 -0
  137. package/tools/installer/templates/cursor-rules.md +22 -0
  138. package/tools/installer/templates/windsurf-rules.md +22 -0
  139. package/tools/lib/dependency-resolver.js +22 -22
  140. package/tools/upgraders/v3-to-v4-upgrader.js +43 -35
  141. package/tools/version-bump.js +1 -1
  142. package/tools/yaml-format.js +2 -2
  143. package/.github/FUNDING.yaml +0 -15
  144. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -32
  145. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
  146. package/.prettierignore +0 -21
  147. package/.prettierrc +0 -23
  148. package/bmad-core/agent-teams/team-all.yaml +0 -14
  149. package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
  150. package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
  151. package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
  152. package/bmad-core/agents/architect.md +0 -62
  153. package/bmad-core/agents/bmad-master.md +0 -88
  154. package/bmad-core/agents/bmad-orchestrator.md +0 -135
  155. package/bmad-core/agents/dev.md +0 -56
  156. package/bmad-core/agents/qa.md +0 -54
  157. package/bmad-core/agents/sm.md +0 -45
  158. package/bmad-core/agents/ux-expert.md +0 -53
  159. package/bmad-core/core-config.yaml +0 -25
  160. package/bmad-core/data/bmad-kb.md +0 -803
  161. package/bmad-core/data/brainstorming-techniques.md +0 -36
  162. package/bmad-core/data/elicitation-methods.md +0 -134
  163. package/bmad-core/tasks/advanced-elicitation.md +0 -117
  164. package/bmad-core/tasks/create-brownfield-story.md +0 -355
  165. package/bmad-core/tasks/create-next-story.md +0 -113
  166. package/bmad-core/tasks/create-workflow-plan.md +0 -289
  167. package/bmad-core/tasks/document-project.md +0 -317
  168. package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
  169. package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  170. package/bmad-core/tasks/kb-mode-interaction.md +0 -70
  171. package/bmad-core/tasks/review-story.md +0 -145
  172. package/bmad-core/tasks/update-workflow-plan.md +0 -248
  173. package/bmad-core/tasks/validate-next-story.md +0 -134
  174. package/bmad-core/templates/architecture-tmpl.yaml +0 -650
  175. package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  176. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
  177. package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
  178. package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -293
  179. package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -206
  180. package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
  181. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -805
  182. package/bmad-core/templates/market-research-tmpl.yaml +0 -252
  183. package/bmad-core/templates/prd-tmpl.yaml +0 -202
  184. package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
  185. package/bmad-core/templates/story-tmpl.yaml +0 -137
  186. package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
  187. package/bmad-core/workflows/brownfield-service.yaml +0 -187
  188. package/bmad-core/workflows/brownfield-ui.yaml +0 -197
  189. package/bmad-core/workflows/greenfield-fullstack.yaml +0 -240
  190. package/bmad-core/workflows/greenfield-service.yaml +0 -206
  191. package/bmad-core/workflows/greenfield-ui.yaml +0 -235
  192. package/common/tasks/create-doc.md +0 -79
  193. package/common/utils/bmad-doc-template.md +0 -325
  194. package/common/utils/workflow-management.md +0 -69
  195. package/dist/agents/analyst.txt +0 -2849
  196. package/dist/agents/architect.txt +0 -3505
  197. package/dist/agents/bmad-master.txt +0 -9271
  198. package/dist/agents/bmad-orchestrator.txt +0 -2006
  199. package/dist/agents/qa.txt +0 -388
  200. package/dist/agents/sm.txt +0 -672
  201. package/dist/agents/ux-expert.txt +0 -987
  202. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2401
  203. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1635
  204. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -825
  205. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -11504
  206. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +0 -2023
  207. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2052
  208. package/dist/teams/team-all.txt +0 -11572
  209. package/dist/teams/team-fullstack.txt +0 -10903
  210. package/dist/teams/team-ide-minimal.txt +0 -4346
  211. package/dist/teams/team-no-ui.txt +0 -9458
  212. package/docs/GUIDING-PRINCIPLES.md +0 -91
  213. package/docs/agentic-tools/claude-code-guide.md +0 -19
  214. package/docs/agentic-tools/cline-guide.md +0 -16
  215. package/docs/agentic-tools/cursor-guide.md +0 -14
  216. package/docs/agentic-tools/gemini-cli-guide.md +0 -32
  217. package/docs/agentic-tools/github-copilot-guide.md +0 -42
  218. package/docs/agentic-tools/roo-code-guide.md +0 -15
  219. package/docs/agentic-tools/trae-guide.md +0 -14
  220. package/docs/agentic-tools/windsurf-guide.md +0 -14
  221. package/docs/core-architecture.md +0 -219
  222. package/docs/expansion-packs.md +0 -280
  223. package/docs/how-to-contribute-with-pull-requests.md +0 -158
  224. package/docs/template-markup-references.md +0 -86
  225. package/docs/user-guide.md +0 -1142
  226. package/docs/working-in-the-brownfield.md +0 -361
  227. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
  228. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -59
  229. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -67
  230. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -52
  231. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
  232. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
  233. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -7
  234. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -254
  235. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -651
  236. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -111
  237. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
  238. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -308
  239. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
  240. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
  241. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
  242. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
  243. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  244. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  245. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
  246. package/expansion-packs/bmad-creator-tools/README.md +0 -8
  247. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +0 -54
  248. package/expansion-packs/bmad-creator-tools/config.yaml +0 -5
  249. package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +0 -1020
  250. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +0 -178
  251. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +0 -154
  252. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +0 -120
  253. package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -8
  254. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -308
  255. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
  256. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
  257. package/tools/bump-all-versions.js +0 -107
  258. package/tools/bump-core-version.js +0 -57
  259. package/tools/bump-expansion-version.js +0 -78
  260. package/tools/installer/config/ide-agent-config.yaml +0 -58
  261. package/tools/installer/config/install.config.yaml +0 -91
  262. package/tools/lib/yaml-utils.js +0 -29
  263. package/tools/md-assets/web-agent-startup-instructions.md +0 -39
  264. package/tools/update-expansion-version.js +0 -54
  265. /package/{bmad-core → .bmad-core}/checklists/architect-checklist.md +0 -0
  266. /package/{bmad-core → .bmad-core}/checklists/pm-checklist.md +0 -0
  267. /package/{bmad-core → .bmad-core}/checklists/po-master-checklist.md +0 -0
  268. /package/{bmad-core → .bmad-core}/checklists/story-dod-checklist.md +0 -0
  269. /package/{bmad-core → .bmad-core}/data/technical-preferences.md +0 -0
  270. /package/{bmad-core → .bmad-core}/tasks/brownfield-create-epic.md +0 -0
  271. /package/{bmad-core → .bmad-core}/tasks/brownfield-create-story.md +0 -0
  272. /package/{bmad-core → .bmad-core}/tasks/correct-course.md +0 -0
  273. /package/{bmad-core → .bmad-core}/tasks/create-deep-research-prompt.md +0 -0
  274. /package/.github/workflows/{release.yaml → release.yml} +0 -0
@@ -0,0 +1,206 @@
1
+ # Create Next Story Task
2
+
3
+ ## Purpose
4
+
5
+ To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
6
+
7
+ ## Inputs for this Task
8
+
9
+ - Access to the project's documentation repository, specifically:
10
+ - `docs/index.md` (hereafter "Index Doc")
11
+ - All Epic files - located in one of these locations:
12
+ - Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
13
+ - Secondary: `docs/epics/epic-{n}-{description}.md`
14
+ - User-specified location if not found in above paths
15
+ - Existing story files in `docs/stories/`
16
+ - Main PRD (hereafter "PRD Doc")
17
+ - Main Architecture Document (hereafter "Main Arch Doc")
18
+ - Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
19
+ - Project Structure Guide (`docs/project-structure.md`)
20
+ - Operational Guidelines Document (`docs/operational-guidelines.md`)
21
+ - Technology Stack Document (`docs/tech-stack.md`)
22
+ - Data Models Document (as referenced in Index Doc)
23
+ - API Reference Document (as referenced in Index Doc)
24
+ - UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
25
+ - The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
26
+ - The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
27
+ - User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
28
+
29
+ ## Task Execution Instructions
30
+
31
+ ### 1. Identify Next Story for Preparation
32
+
33
+ #### 1.1 Locate Epic Files
34
+
35
+ - First, determine where epic files are located:
36
+ - Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
37
+ - If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
38
+ - If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
39
+ - Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
40
+
41
+ #### 1.2 Review Existing Stories
42
+
43
+ - Review `docs/stories/` to find the highest-numbered story file.
44
+ - **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
45
+
46
+ - Verify its `Status` is 'Done' (or equivalent).
47
+ - If not 'Done', present an alert to the user:
48
+
49
+ ```plaintext
50
+ ALERT: Found incomplete story:
51
+ File: {lastEpicNum}.{lastStoryNum}.story.md
52
+ Status: [current status]
53
+
54
+ Would you like to:
55
+ 1. View the incomplete story details (instructs user to do so, agent does not display)
56
+ 2. Cancel new story creation at this time
57
+ 3. Accept risk & Override to create the next story in draft
58
+
59
+ Please choose an option (1/2/3):
60
+ ```
61
+
62
+ - Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
63
+ - If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
64
+ - Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
65
+
66
+ - **If no story files exist in `docs/stories/`:**
67
+ - The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
68
+ - If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
69
+ - Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
70
+
71
+ ### 2. Gather Core Story Requirements (from Epic File)
72
+
73
+ - For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
74
+ - Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
75
+ - Keep a record of this original epic-defined scope for later deviation analysis.
76
+
77
+ ### 3. Review Previous Story and Extract Dev Notes
78
+
79
+ [[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
80
+
81
+ - If this is not the first story (i.e., previous story exists):
82
+ - Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
83
+ - Pay special attention to:
84
+ - Dev Agent Record sections (especially Completion Notes and Debug Log References)
85
+ - Any deviations from planned implementation
86
+ - Technical decisions made during implementation
87
+ - Challenges encountered and solutions applied
88
+ - Any "lessons learned" or notes for future stories
89
+ - Extract relevant insights that might inform the current story's preparation
90
+
91
+ ### 4. Gather & Synthesize Architecture Context from Sharded Docs
92
+
93
+ [[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
94
+
95
+ #### 4.1 Start with Architecture Index
96
+
97
+ - Read `docs/architecture/index.md` to understand the full scope of available documentation
98
+ - Identify which sharded documents are most relevant to the current story
99
+
100
+ #### 4.2 Recommended Reading Order Based on Story Type
101
+
102
+ [[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
103
+
104
+ **For ALL Stories:**
105
+
106
+ 1. `docs/architecture/tech-stack.md` - Understand technology constraints and versions
107
+ 2. `docs/architecture/unified-project-structure.md` - Know where code should be placed
108
+ 3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
109
+ 4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
110
+
111
+ **For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
112
+
113
+ **For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
114
+
115
+ **For Full-Stack Stories:**
116
+
117
+ - Read both Backend and Frontend sections above
118
+
119
+ #### 4.3 Extract Story-Specific Technical Details
120
+
121
+ [[LLM: As you read each document, extract ONLY the information directly relevant to implementing the current story. Do NOT include general information unless it directly impacts the story implementation.]]
122
+
123
+ For each relevant document, extract:
124
+
125
+ - Specific data models, schemas, or structures the story will use
126
+ - API endpoints the story must implement or consume
127
+ - Component specifications for UI elements in the story
128
+ - File paths and naming conventions for new code
129
+ - Testing requirements specific to the story's features
130
+ - Security or performance considerations affecting the story
131
+
132
+ #### 4.4 Document Source References
133
+
134
+ [[LLM: ALWAYS cite the source document and section for each technical detail you include. This helps the dev agent verify information if needed.]]
135
+
136
+ Format references as: `[Source: architecture/{filename}.md#{section}]`
137
+
138
+ ### 5. Verify Project Structure Alignment
139
+
140
+ - Cross-reference the story's requirements and anticipated file manipulations with the Project Structure Guide from `docs/architecture/unified-project-structure.md`.
141
+ - Ensure any file paths, component locations, or module names implied by the story align with defined structures.
142
+ - Document any structural conflicts, necessary clarifications, or undefined components/paths in a "Project Structure Notes" section within the story draft.
143
+
144
+ ### 6. Populate Story Template with Full Context
145
+
146
+ - Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
147
+ - Use the Story Template to structure the file.
148
+ - Fill in:
149
+ - Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
150
+ - `Status: Draft`
151
+ - `Story` (User Story statement from Epic)
152
+ - `Acceptance Criteria (ACs)` (from Epic, to be refined if needed based on context)
153
+ - **`Dev Technical Guidance` section (CRITICAL):**
154
+
155
+ [[LLM: This section MUST contain ONLY information extracted from the architecture shards. NEVER invent or assume technical details.]]
156
+
157
+ - Include ALL relevant technical details gathered from Steps 3 and 4, organized by category:
158
+ - **Previous Story Insights**: Key learnings or considerations from the previous story
159
+ - **Data Models**: Specific schemas, validation rules, relationships [with source references]
160
+ - **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
161
+ - **Component Specifications**: UI component details, props, state management [with source references]
162
+ - **File Locations**: Exact paths where new code should be created based on project structure
163
+ - **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
164
+ - **Technical Constraints**: Version requirements, performance considerations, security rules
165
+ - Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
166
+ - If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
167
+
168
+ - **`Tasks / Subtasks` section:**
169
+ - Generate a detailed, sequential list of technical tasks based ONLY on:
170
+ - Requirements from the Epic
171
+ - Technical constraints from architecture shards
172
+ - Project structure from unified-project-structure.md
173
+ - Testing requirements from testing-strategy.md
174
+ - Each task must reference relevant architecture documentation
175
+ - Include unit testing as explicit subtasks based on testing-strategy.md
176
+ - Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
177
+ - Add notes on project structure alignment or discrepancies found in Step 5.
178
+ - Prepare content for the "Deviation Analysis" based on any conflicts between epic requirements and architecture constraints.
179
+
180
+ ### 7. Run Story Draft Checklist
181
+
182
+ - Execute the Story Draft Checklist against the prepared story
183
+ - Document any issues or gaps identified
184
+ - Make necessary adjustments to meet quality standards
185
+ - Ensure all technical guidance is properly sourced from architecture docs
186
+
187
+ ### 8. Finalize Story File
188
+
189
+ - Review all sections for completeness and accuracy
190
+ - Verify all source references are included for technical details
191
+ - Ensure tasks align with both epic requirements and architecture constraints
192
+ - Update status to "Draft"
193
+ - Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
194
+
195
+ ### 9. Report Completion
196
+
197
+ Provide a summary to the user including:
198
+
199
+ - Story created: `{epicNum}.{storyNum} - {Story Title}`
200
+ - Status: Draft
201
+ - Key technical components included from architecture docs
202
+ - Any deviations or conflicts noted between epic and architecture
203
+ - Recommendations for story review before approval
204
+ - Next steps: Story should be reviewed by PO for approval before dev work begins
205
+
206
+ [[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]
@@ -0,0 +1,229 @@
1
+ # Create Team Task
2
+
3
+ This task guides you through creating a new BMAD agent team that conforms to the agent-team schema and effectively combines agents for specific project types.
4
+
5
+ **Note for User-Created Teams**: If creating a custom team for your own use (not part of the core BMAD system), prefix the team name with a period (e.g., `.team-frontend`) to ensure it's gitignored and won't conflict with repository updates.
6
+
7
+ ## Prerequisites
8
+
9
+ 1. Load and understand the team schema: `/bmad-core/schemas/agent-team-schema.yml`
10
+ 2. Review existing teams in `/bmad-core/agent-teams/` for patterns and naming conventions
11
+ 3. List available agents from `/agents/` to understand team composition options
12
+ 4. Review workflows in `/bmad-core/workflows/` to align team capabilities
13
+
14
+ ## Process
15
+
16
+ ### 1. Define Team Purpose and Scope
17
+
18
+ Before selecting agents, clarify the team's mission:
19
+
20
+ - **Team Purpose**: What specific problems will this team solve?
21
+ - **Project Types**: Greenfield, brownfield, or both?
22
+ - **Technical Scope**: UI-focused, backend-only, or full-stack?
23
+ - **Team Size Consideration**: Smaller teams (3-5 agents) for focused work, larger teams (6-8) for comprehensive coverage
24
+
25
+ ### 2. Create Team Metadata
26
+
27
+ Based on the schema requirements:
28
+
29
+ - **Team Name**: Must follow pattern `^Team .+$` (e.g., "Team Frontend", "Team Analytics")
30
+ - For user teams: prefix with period (e.g., "Team .MyCustom")
31
+ - **Description**: 20-500 characters explaining team's purpose, capabilities, and use cases
32
+ - **File Name**: `/bmad-core/agent-teams/team-{identifier}.yml`
33
+ - For user teams: `/bmad-core/agent-teams/.team-{identifier}.yml`
34
+
35
+ ### 3. Select Agents Based on Purpose
36
+
37
+ #### Discover Available Agents
38
+
39
+ 1. List all agents from `/agents/` directory
40
+ 2. Review each agent's role and capabilities
41
+ 3. Consider agent synergies and coverage
42
+
43
+ #### Agent Selection Guidelines
44
+
45
+ Based on team purpose, recommend agents:
46
+
47
+ **For Planning & Strategy Teams:**
48
+
49
+ - `bmad` (required orchestrator)
50
+ - `analyst` - Requirements gathering and research
51
+ - `pm` - Product strategy and documentation
52
+ - `po` - Validation and approval
53
+ - `architect` - Technical planning (if technical planning needed)
54
+
55
+ **For Design & UX Teams:**
56
+
57
+ - `bmad` (required orchestrator)
58
+ - `ux-expert` - User experience design
59
+ - `architect` - Frontend architecture
60
+ - `pm` - Product requirements alignment
61
+ - `po` - Design validation
62
+
63
+ **For Development Teams:**
64
+
65
+ - `bmad-orchestrator` (required)
66
+ - `sm` - Sprint coordination
67
+ - `dev` - Implementation
68
+ - `qa` - Quality assurance
69
+ - `architect` - Technical guidance
70
+
71
+ **For Full-Stack Teams:**
72
+
73
+ - `bmad-orchestrator` (required)
74
+ - `analyst` - Initial planning
75
+ - `pm` - Product management
76
+ - `ux-expert` - UI/UX design (if UI work included)
77
+ - `architect` - System architecture
78
+ - `po` - Validation
79
+ - Additional agents as needed
80
+
81
+ #### Special Cases
82
+
83
+ - **Using Wildcard**: If team needs all agents, use `["bmad", "*"]`
84
+ - **Validation**: Schema requires `bmad` in all teams
85
+
86
+ ### 4. Select Workflows
87
+
88
+ Based on the schema's workflow enum values and team composition:
89
+
90
+ 1. **Analyze team capabilities** against available workflows:
91
+
92
+ - `brownfield-fullstack` - Requires full team with UX
93
+ - `brownfield-service` - Backend-focused team
94
+ - `brownfield-ui` - UI/UX-focused team
95
+ - `greenfield-fullstack` - Full team for new projects
96
+ - `greenfield-service` - Backend team for new services
97
+ - `greenfield-ui` - Frontend team for new UIs
98
+
99
+ 2. **Match workflows to agents**:
100
+
101
+ - UI workflows require `ux-expert`
102
+ - Service workflows benefit from `architect` and `dev`
103
+ - All workflows benefit from planning agents (`analyst`, `pm`)
104
+
105
+ 3. **Apply schema validation rules**:
106
+ - Teams without `ux-expert` shouldn't have UI workflows
107
+ - Teams named "Team No UI" can't have UI workflows
108
+
109
+ ### 5. Create Team Configuration
110
+
111
+ Generate the configuration following the schema:
112
+
113
+ ```yaml
114
+ bundle:
115
+ name: "{Team Name}" # Must match pattern "^Team .+$"
116
+ description: >-
117
+ {20-500 character description explaining purpose,
118
+ capabilities, and ideal use cases}
119
+
120
+ agents:
121
+ - bmad # Required orchestrator
122
+ - { agent-id-1 }
123
+ - { agent-id-2 }
124
+ # ... additional agents
125
+
126
+ workflows:
127
+ - { workflow-1 } # From enum list
128
+ - { workflow-2 }
129
+ # ... additional workflows
130
+ ```
131
+
132
+ ### 6. Validate Team Composition
133
+
134
+ Before finalizing, verify:
135
+
136
+ 1. **Role Coverage**: Does the team have all necessary skills for its workflows?
137
+ 2. **Size Optimization**:
138
+ - Minimum: 2 agents (bmad + 1)
139
+ - Recommended: 3-7 agents
140
+ - Maximum with wildcard: bmad + "\*"
141
+ 3. **Workflow Alignment**: Can the selected agents execute all workflows?
142
+ 4. **Schema Compliance**: Configuration matches all schema requirements
143
+
144
+ ### 7. Integration Recommendations
145
+
146
+ Document how this team integrates with existing system:
147
+
148
+ 1. **Complementary Teams**: Which existing teams complement this one?
149
+ 2. **Handoff Points**: Where does this team hand off to others?
150
+ 3. **Use Case Scenarios**: Specific project types ideal for this team
151
+
152
+ ### 8. Validation and Testing
153
+
154
+ 1. **Schema Validation**: Ensure configuration matches agent-team-schema.yml
155
+ 2. **Build Validation**: Run `npm run validate`
156
+ 3. **Build Team**: Run `npm run build:team -t {team-name}`
157
+ 4. **Size Check**: Verify output is appropriate for target platform
158
+ 5. **Test Scenarios**: Run sample workflows with the team
159
+
160
+ ## Example Team Creation
161
+
162
+ ### Example 1: API Development Team
163
+
164
+ ```yaml
165
+ bundle:
166
+ name: "Team API"
167
+ description: >-
168
+ Specialized team for API and backend service development. Focuses on
169
+ robust service architecture, implementation, and testing without UI
170
+ components. Ideal for microservices, REST APIs, and backend systems.
171
+
172
+ agents:
173
+ - bmad
174
+ - analyst
175
+ - architect
176
+ - dev
177
+ - qa
178
+ - po
179
+
180
+ workflows:
181
+ - greenfield-service
182
+ - brownfield-service
183
+ ```
184
+
185
+ ### Example 2: Rapid Prototyping Team
186
+
187
+ ```yaml
188
+ bundle:
189
+ name: "Team Prototype"
190
+ description: >-
191
+ Agile team for rapid prototyping and proof of concept development.
192
+ Combines planning, design, and implementation for quick iterations
193
+ on new ideas and experimental features.
194
+
195
+ agents:
196
+ - bmad
197
+ - pm
198
+ - ux-expert
199
+ - architect
200
+ - dev
201
+
202
+ workflows:
203
+ - greenfield-ui
204
+ - greenfield-fullstack
205
+ ```
206
+
207
+ ## Team Creation Checklist
208
+
209
+ - [ ] Team purpose clearly defined
210
+ - [ ] Name follows schema pattern "Team {Name}"
211
+ - [ ] Description is 20-500 characters
212
+ - [ ] Includes bmad orchestrator
213
+ - [ ] Agents align with team purpose
214
+ - [ ] Workflows match team capabilities
215
+ - [ ] No conflicting validations (e.g., no-UI team with UI workflows)
216
+ - [ ] Configuration validates against schema
217
+ - [ ] Build completes successfully
218
+ - [ ] Output size appropriate for platform
219
+
220
+ ## Best Practices
221
+
222
+ 1. **Start Focused**: Create teams with specific purposes rather than general-purpose teams
223
+ 2. **Consider Workflow**: Order agents by typical workflow sequence
224
+ 3. **Avoid Redundancy**: Don't duplicate roles unless needed
225
+ 4. **Document Rationale**: Explain why each agent is included
226
+ 5. **Test Integration**: Verify team works well with selected workflows
227
+ 6. **Iterate**: Refine team composition based on usage
228
+
229
+ This schema-driven approach ensures teams are well-structured, purposeful, and integrate seamlessly with the BMAD ecosystem.
@@ -68,7 +68,7 @@ The epic numbering starts at 1 and increments for each epic found.
68
68
 
69
69
  ### Before (PRD):
70
70
 
71
- ```markdown
71
+ `````markdown
72
72
  # Product Requirements Document
73
73
 
74
74
  ## 1. Executive Summary
@@ -91,10 +91,9 @@ Epic content...
91
91
 
92
92
  Content here...
93
93
 
94
- ```
94
+ ````text
95
95
 
96
96
  ### After (PRD):
97
-
98
97
  ```markdown
99
98
  # Product Requirements Document
100
99
 
@@ -114,11 +113,9 @@ Epic content...
114
113
 
115
114
  ## Success Metrics
116
115
  Content here...
117
-
118
- ```
116
+ ```text
119
117
 
120
118
  ### Before (Non-PRD):
121
-
122
119
  ```markdown
123
120
  # Architecture Document
124
121
 
@@ -127,10 +124,9 @@ Content...
127
124
 
128
125
  ## 2.1 Technical Stack & Tools
129
126
  Content...
130
- ```
127
+ ```text
131
128
 
132
129
  ### After (Non-PRD):
133
-
134
130
  ```markdown
135
131
  # Architecture Document
136
132
 
@@ -139,5 +135,9 @@ Content...
139
135
 
140
136
  ## Technical Stack Tools
141
137
  Content...
138
+ ````
139
+ `````
142
140
 
143
- ```
141
+ ```text
142
+
143
+ ```
@@ -2,9 +2,13 @@
2
2
 
3
3
  This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
4
4
 
5
+ ## Context
6
+
7
+ The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
8
+
5
9
  ## Available Checklists
6
10
 
7
- 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 {root}/checklists folder to select the appropriate one to run.
11
+ 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.
8
12
 
9
13
  ## Instructions
10
14
 
@@ -13,7 +17,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
13
17
  - If user or the task being run provides a checklist name:
14
18
  - Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
15
19
  - If multiple matches found, ask user to clarify
16
- - Load the appropriate checklist from {root}/checklists/
20
+ - Load the appropriate checklist from bmad-core/checklists/
17
21
  - If no checklist specified:
18
22
  - Ask the user which checklist they want to use
19
23
  - Present the available options from the files in the checklists folder
@@ -0,0 +1,58 @@
1
+ # Create AI Frontend Prompt Task
2
+
3
+ ## Purpose
4
+
5
+ To generate a masterful, comprehensive, and optimized prompt that can be used with AI-driven frontend development tools (e.g., Lovable, Vercel v0, or similar) to scaffold or generate significant portions of the frontend application.
6
+
7
+ ## Inputs
8
+
9
+ - Completed UI/UX Specification (`front-end-spec-tmpl`)
10
+ - Completed Frontend Architecture Document (`front-end-architecture`)
11
+ - Main System Architecture Document (`architecture` - for API contracts and tech stack)
12
+ - Primary Design Files (Figma, Sketch, etc. - for visual context if the tool can accept it or if descriptions are needed)
13
+
14
+ ## Key Activities & Instructions
15
+
16
+ 1. **Confirm Target AI Generation Platform:**
17
+
18
+ - Ask the user to specify which AI frontend generation tool/platform they intend to use (e.g., "Lovable.ai", "Vercel v0", "GPT-4 with direct code generation instructions", etc.).
19
+ - Explain that prompt optimization might differ slightly based on the platform's capabilities and preferred input format.
20
+
21
+ 2. **Synthesize Inputs into a Structured Prompt:**
22
+
23
+ - **Overall Project Context:**
24
+ - Briefly state the project's purpose (from brief/PRD).
25
+ - Specify the chosen frontend framework, core libraries, and UI component library (from `front-end-architecture` and main `architecture`).
26
+ - Mention the styling approach (e.g., Tailwind CSS, CSS Modules).
27
+ - **Design System & Visuals:**
28
+ - Reference the primary design files (e.g., Figma link).
29
+ - If the tool doesn't directly ingest design files, describe the overall visual style, color palette, typography, and key branding elements (from `front-end-spec-tmpl`).
30
+ - List any global UI components or design tokens that should be defined or adhered to.
31
+ - **Application Structure & Routing:**
32
+ - Describe the main pages/views and their routes (from `front-end-architecture` - Routing Strategy).
33
+ - Outline the navigation structure (from `front-end-spec-tmpl`).
34
+ - **Key User Flows & Page-Level Interactions:**
35
+ - For a few critical user flows (from `front-end-spec-tmpl`):
36
+ - Describe the sequence of user actions and expected UI changes on each relevant page.
37
+ - Specify API calls to be made (referencing API endpoints from the main `architecture`) and how data should be displayed or used.
38
+ - **Component Generation Instructions (Iterative or Key Components):**
39
+ - Based on the chosen AI tool's capabilities, decide on a strategy:
40
+ - **Option 1 (Scaffolding):** Prompt for the generation of main page structures, layouts, and placeholders for components.
41
+ - **Option 2 (Key Component Generation):** Select a few critical or complex components from the `front-end-architecture` (Component Breakdown) and provide detailed specifications for them (props, state, basic behavior, key UI elements).
42
+ - **Option 3 (Holistic, if tool supports):** Attempt to describe the entire application structure and key components more broadly.
43
+ - <important_note>Advise the user that generating an entire complex application perfectly in one go is rare. Iterative prompting or focusing on sections/key components is often more effective.</important_note>
44
+ - **State Management (High-Level Pointers):**
45
+ - Mention the chosen state management solution (e.g., "Use Redux Toolkit").
46
+ - For key pieces of data, indicate if they should be managed in global state.
47
+ - **API Integration Points:**
48
+ - For pages/components that fetch or submit data, clearly state the relevant API endpoints (from `architecture`) and the expected data shapes (can reference schemas in `data-models` or `api-reference` sections of the architecture doc).
49
+ - **Critical "Don'ts" or Constraints:**
50
+ - e.g., "Do not use deprecated libraries." "Ensure all forms have basic client-side validation."
51
+ - **Platform-Specific Optimizations:**
52
+ - If the chosen AI tool has known best practices for prompting (e.g., specific keywords, structure, level of detail), incorporate them. (This might require the agent to have some general knowledge or to ask the user if they know any such specific prompt modifiers for their chosen tool).
53
+
54
+ 3. **Present and Refine the Master Prompt:**
55
+ - Output the generated prompt in a clear, copy-pasteable format (e.g., a large code block).
56
+ - Explain the structure of the prompt and why certain information was included.
57
+ - Work with the user to refine the prompt based on their knowledge of the target AI tool and any specific nuances they want to emphasize.
58
+ - <important_note>Remind the user that the generated code from the AI tool will likely require review, testing, and further refinement by developers.</important_note>
@@ -56,7 +56,7 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
56
56
 
57
57
  The index should be organized as follows:
58
58
 
59
- ```markdown
59
+ `````markdown
60
60
  # Documentation Index
61
61
 
62
62
  ## Root Documents
@@ -89,7 +89,7 @@ Documents within the `another-folder/` directory:
89
89
 
90
90
  Description of nested document.
91
91
 
92
- ```
92
+ ````text
93
93
 
94
94
  ### Index Entry Format
95
95
 
@@ -99,7 +99,10 @@ Each entry should follow this format:
99
99
  ### [Document Title](relative/path/to/file.md)
100
100
 
101
101
  Brief description of the document's purpose and contents.
102
- ```
102
+ ````
103
+ `````
104
+
105
+ ````
103
106
 
104
107
  ### Rules of Operation
105
108
 
@@ -177,3 +180,4 @@ Please provide:
177
180
  5. Whether to include hidden files/folders (starting with `.`)
178
181
 
179
182
  Would you like to proceed with documentation indexing? Please provide the required input above.
183
+ ````
@@ -6,27 +6,9 @@
6
6
  - Create a folder structure to organize the sharded documents
7
7
  - Maintain all content integrity including code blocks, diagrams, and markdown formatting
8
8
 
9
- ## Primary Method: Automatic with markdown-tree
9
+ ## Recommended Method: @kayvan/markdown-tree-parser
10
10
 
11
- [[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}`.
12
-
13
- If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
14
-
15
- 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:
16
-
17
- 1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
18
- 2. Or set markdownExploder to false in bmad-core/core-config.yaml
19
-
20
- **IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
21
-
22
- If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
23
-
24
- 1. Set markdownExploder to true in bmad-core/core-config.yaml
25
- 2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
26
-
27
- I will now proceed with the manual sharding process."
28
-
29
- Then proceed with the manual method below ONLY if markdownExploder is false.]]
11
+ [[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
30
12
 
31
13
  ### Installation and Usage
32
14
 
@@ -59,19 +41,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
59
41
 
60
42
  ---
61
43
 
62
- ## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
44
+ ## Manual Method (if @kayvan/markdown-tree-parser is not available)
63
45
 
64
46
  [[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
65
47
 
66
48
  ### Task Instructions
67
49
 
68
- 1. Identify Document and Target Location
50
+ ### 1. Identify Document and Target Location
69
51
 
70
52
  - Determine which document to shard (user-provided path)
71
53
  - Create a new folder under `docs/` with the same name as the document (without extension)
72
54
  - Example: `docs/prd.md` → create folder `docs/prd/`
73
55
 
74
- 2. Parse and Extract Sections
56
+ ### 2. Parse and Extract Sections
75
57
 
76
58
  [[LLM: When sharding the document:
77
59
 
@@ -81,7 +63,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
81
63
  - Extract the section heading and ALL content until the next level 2 section
82
64
  - Include all subsections, code blocks, diagrams, lists, tables, etc.
83
65
  - Be extremely careful with:
84
- - 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
66
+ - Fenced code blocks (```) - ensure you capture the full block including closing backticks
85
67
  - Mermaid diagrams - preserve the complete diagram syntax
86
68
  - Nested markdown elements
87
69
  - Multi-line content that might contain ## inside code blocks
@@ -100,7 +82,7 @@ For each extracted section:
100
82
 
101
83
  2. **Adjust heading levels**:
102
84
 
103
- - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
85
+ - The level 2 heading becomes level 1 (# instead of ##)
104
86
  - All subsection levels decrease by 1:
105
87
 
106
88
  ```txt