bmalph 1.0.0 → 2.2.1

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 (455) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +398 -217
  3. package/bmad/bmm/agents/analyst.agent.yaml +43 -36
  4. package/bmad/bmm/agents/architect.agent.yaml +29 -28
  5. package/bmad/bmm/agents/dev.agent.yaml +38 -38
  6. package/bmad/bmm/agents/pm.agent.yaml +44 -46
  7. package/bmad/bmm/agents/qa.agent.yaml +58 -0
  8. package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -32
  9. package/bmad/bmm/agents/sm.agent.yaml +37 -36
  10. package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +223 -223
  11. package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +46 -45
  12. package/bmad/bmm/agents/ux-designer.agent.yaml +27 -26
  13. package/bmad/bmm/data/project-context-template.md +26 -26
  14. package/bmad/bmm/module-help.csv +31 -31
  15. package/bmad/bmm/module.yaml +50 -44
  16. package/bmad/bmm/teams/default-party.csv +20 -21
  17. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  18. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  19. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -177
  20. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -161
  21. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -199
  22. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -202
  23. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -205
  24. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -219
  25. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -162
  26. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -58
  27. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  28. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  29. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  30. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  31. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  32. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  33. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  34. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  35. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  36. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  37. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  38. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  39. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  40. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  41. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  42. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  43. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  44. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -239
  45. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  46. package/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
  47. package/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
  48. package/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
  49. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/domain-complexity.csv +14 -12
  50. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/prd-purpose.md +197 -197
  51. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/project-types.csv +10 -10
  52. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01-init.md +191 -191
  53. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01b-continue.md +153 -153
  54. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-02-discovery.md +224 -224
  55. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
  56. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
  57. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-03-success.md +226 -226
  58. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-04-journeys.md +213 -213
  59. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-05-domain.md +207 -207
  60. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-06-innovation.md +226 -226
  61. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-07-project-type.md +237 -237
  62. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-08-scoping.md +228 -228
  63. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-09-functional.md +231 -231
  64. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-10-nonfunctional.md +242 -242
  65. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-11-polish.md +217 -217
  66. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-12-complete.md +124 -124
  67. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01-discovery.md +247 -247
  68. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01b-legacy-conversion.md +208 -208
  69. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-02-review.md +249 -249
  70. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-03-edit.md +253 -253
  71. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-04-complete.md +168 -168
  72. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-01-discovery.md +226 -218
  73. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02-format-detection.md +191 -191
  74. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02b-parity-check.md +209 -209
  75. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-03-density-validation.md +174 -174
  76. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-04-brief-coverage-validation.md +214 -214
  77. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-05-measurability-validation.md +228 -228
  78. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-06-traceability-validation.md +217 -217
  79. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-07-implementation-leakage-validation.md +205 -205
  80. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-08-domain-compliance-validation.md +243 -243
  81. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-09-project-type-validation.md +263 -263
  82. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-10-smart-validation.md +209 -209
  83. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-11-holistic-quality-validation.md +264 -264
  84. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-12-completeness-validation.md +242 -242
  85. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-13-report-complete.md +231 -231
  86. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/templates/prd-template.md +10 -10
  87. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
  88. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
  89. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
  90. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  91. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  92. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  93. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  94. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  95. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  96. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  97. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  98. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  99. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  100. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  101. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  102. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  103. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  104. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -171
  105. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  106. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -43
  107. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -190
  108. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -178
  109. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -179
  110. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -139
  111. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -252
  112. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -135
  113. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  114. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -55
  115. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  116. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +12 -10
  117. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  118. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -153
  119. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  120. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  121. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -331
  122. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -318
  123. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -359
  124. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  125. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -359
  126. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -76
  127. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -50
  128. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  129. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  130. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  131. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -149
  132. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  133. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -59
  134. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  135. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +226 -226
  136. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +44 -51
  137. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -288
  138. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -206
  139. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +54 -60
  140. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  141. package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -345
  142. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  143. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +53 -61
  144. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -80
  145. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -410
  146. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +21 -27
  147. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -1443
  148. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +53 -58
  149. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  150. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -225
  151. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  152. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -54
  153. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -229
  154. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -36
  155. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -156
  156. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -120
  157. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -113
  158. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -113
  159. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -106
  160. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -140
  161. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
  162. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +191 -189
  163. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -144
  164. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +127 -128
  165. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -191
  166. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -74
  167. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
  168. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  169. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  170. package/bmad/bmm/workflows/document-project/instructions.md +130 -221
  171. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  172. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  173. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  174. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  175. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  176. package/bmad/bmm/workflows/document-project/workflow.yaml +22 -30
  177. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  178. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  179. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  180. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  181. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
  182. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
  183. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
  184. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
  185. package/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
  186. package/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
  187. package/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
  188. package/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
  189. package/bmad/core/agents/bmad-master.agent.yaml +30 -30
  190. package/bmad/core/module-help.csv +9 -11
  191. package/bmad/core/module.yaml +25 -25
  192. package/bmad/core/tasks/editorial-review-prose.xml +102 -91
  193. package/bmad/core/tasks/editorial-review-structure.xml +209 -198
  194. package/bmad/core/tasks/help.md +85 -0
  195. package/bmad/core/tasks/index-docs.xml +64 -64
  196. package/bmad/core/tasks/review-adversarial-general.xml +48 -48
  197. package/bmad/core/tasks/shard-doc.xml +107 -108
  198. package/bmad/core/tasks/workflow.xml +234 -234
  199. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  200. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  201. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  202. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  203. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  204. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  205. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  206. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  207. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  208. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -399
  209. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  210. package/bmad/core/workflows/brainstorming/template.md +15 -15
  211. package/bmad/core/workflows/brainstorming/workflow.md +58 -58
  212. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -138
  213. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -187
  214. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -157
  215. package/bmad/core/workflows/party-mode/workflow.md +194 -194
  216. package/bundled-versions.json +3 -0
  217. package/dist/cli.js +61 -6
  218. package/dist/commands/check-updates.d.ts +5 -0
  219. package/dist/commands/check-updates.js +63 -0
  220. package/dist/commands/doctor.d.ts +39 -1
  221. package/dist/commands/doctor.js +348 -79
  222. package/dist/commands/init.d.ts +2 -0
  223. package/dist/commands/init.js +41 -15
  224. package/dist/commands/status.d.ts +7 -1
  225. package/dist/commands/status.js +111 -42
  226. package/dist/commands/upgrade.d.ts +7 -1
  227. package/dist/commands/upgrade.js +43 -12
  228. package/dist/installer.d.ts +19 -2
  229. package/dist/installer.js +305 -66
  230. package/dist/transition/artifacts.d.ts +2 -0
  231. package/dist/transition/artifacts.js +46 -0
  232. package/dist/transition/context.d.ts +19 -0
  233. package/dist/transition/context.js +261 -0
  234. package/dist/transition/fix-plan.d.ts +15 -0
  235. package/dist/transition/fix-plan.js +94 -0
  236. package/dist/transition/index.d.ts +9 -0
  237. package/dist/transition/index.js +16 -0
  238. package/dist/transition/orchestration.d.ts +2 -0
  239. package/dist/transition/orchestration.js +243 -0
  240. package/dist/transition/specs-changelog.d.ts +3 -0
  241. package/dist/transition/specs-changelog.js +75 -0
  242. package/dist/transition/specs-index.d.ts +22 -0
  243. package/dist/transition/specs-index.js +157 -0
  244. package/dist/transition/story-parsing.d.ts +7 -0
  245. package/dist/transition/story-parsing.js +124 -0
  246. package/dist/transition/tech-stack.d.ts +3 -0
  247. package/dist/transition/tech-stack.js +79 -0
  248. package/dist/transition/types.d.ts +60 -0
  249. package/dist/transition/types.js +1 -0
  250. package/dist/utils/config.d.ts +4 -0
  251. package/dist/utils/config.js +14 -4
  252. package/dist/utils/constants.d.ts +70 -0
  253. package/dist/utils/constants.js +97 -0
  254. package/dist/utils/dryrun.d.ts +7 -0
  255. package/dist/utils/dryrun.js +48 -0
  256. package/dist/utils/errors.d.ts +63 -0
  257. package/dist/utils/errors.js +86 -0
  258. package/dist/utils/file-system.d.ts +24 -0
  259. package/dist/utils/file-system.js +99 -0
  260. package/dist/utils/github.d.ts +83 -0
  261. package/dist/utils/github.js +230 -0
  262. package/dist/utils/json.js +3 -3
  263. package/dist/utils/logger.d.ts +6 -0
  264. package/dist/utils/logger.js +27 -0
  265. package/dist/utils/state.d.ts +4 -7
  266. package/dist/utils/state.js +147 -26
  267. package/dist/utils/validate.d.ts +40 -0
  268. package/dist/utils/validate.js +175 -1
  269. package/package.json +75 -59
  270. package/ralph/RALPH-REFERENCE.md +412 -0
  271. package/ralph/lib/circuit_breaker.sh +463 -330
  272. package/ralph/lib/date_utils.sh +104 -53
  273. package/ralph/lib/enable_core.sh +815 -0
  274. package/ralph/lib/response_analyzer.sh +884 -768
  275. package/ralph/lib/task_sources.sh +577 -0
  276. package/ralph/lib/timeout_utils.sh +145 -145
  277. package/ralph/lib/wizard_utils.sh +547 -0
  278. package/ralph/ralph_import.sh +636 -0
  279. package/ralph/ralph_loop.sh +1793 -1391
  280. package/ralph/ralph_monitor.sh +125 -0
  281. package/ralph/templates/AGENT.md +158 -158
  282. package/ralph/templates/PROMPT.md +285 -292
  283. package/ralph/templates/fix_plan.md +27 -27
  284. package/ralph/templates/ralphrc.template +102 -0
  285. package/ralph/templates/specs/.gitkeep +1 -1
  286. package/slash-commands/advanced-elicitation.md +1 -1
  287. package/slash-commands/adversarial-review.md +1 -1
  288. package/slash-commands/analyst.md +1 -1
  289. package/slash-commands/architect.md +1 -1
  290. package/slash-commands/bmad-help.md +1 -1
  291. package/slash-commands/bmalph-implement.md +152 -152
  292. package/slash-commands/brainstorm-project.md +1 -1
  293. package/slash-commands/brainstorming.md +1 -1
  294. package/slash-commands/correct-course.md +1 -1
  295. package/slash-commands/create-architecture.md +1 -1
  296. package/slash-commands/create-brief.md +1 -1
  297. package/slash-commands/create-epics-stories.md +1 -1
  298. package/slash-commands/create-prd.md +1 -1
  299. package/slash-commands/create-story.md +1 -1
  300. package/slash-commands/create-ux.md +1 -1
  301. package/slash-commands/dev.md +1 -1
  302. package/slash-commands/document-project.md +1 -1
  303. package/slash-commands/domain-research.md +1 -1
  304. package/slash-commands/editorial-prose.md +1 -1
  305. package/slash-commands/editorial-structure.md +1 -1
  306. package/slash-commands/execute-workflow.md +1 -1
  307. package/slash-commands/generate-project-context.md +1 -0
  308. package/slash-commands/implementation-readiness.md +1 -1
  309. package/slash-commands/index-docs.md +1 -1
  310. package/slash-commands/market-research.md +1 -1
  311. package/slash-commands/party-mode.md +1 -1
  312. package/slash-commands/pm.md +1 -1
  313. package/slash-commands/qa-automate.md +1 -0
  314. package/slash-commands/qa.md +1 -0
  315. package/slash-commands/quick-dev.md +1 -1
  316. package/slash-commands/quick-flow-solo-dev.md +1 -1
  317. package/slash-commands/retrospective.md +1 -1
  318. package/slash-commands/shard-doc.md +1 -1
  319. package/slash-commands/sm.md +1 -1
  320. package/slash-commands/sprint-planning.md +1 -1
  321. package/slash-commands/sprint-status.md +1 -1
  322. package/slash-commands/tech-spec.md +1 -1
  323. package/slash-commands/tech-writer.md +1 -0
  324. package/slash-commands/technical-research.md +1 -1
  325. package/slash-commands/ux-designer.md +1 -1
  326. package/slash-commands/validate-architecture.md +1 -1
  327. package/slash-commands/validate-brief.md +1 -1
  328. package/slash-commands/validate-epics-stories.md +1 -1
  329. package/slash-commands/validate-prd.md +1 -1
  330. package/slash-commands/validate-story.md +1 -1
  331. package/slash-commands/validate-ux.md +1 -1
  332. package/bmad/bmm/agents/tea.agent.yaml +0 -63
  333. package/bmad/bmm/sub-modules/claude-code/config.yaml +0 -4
  334. package/bmad/bmm/sub-modules/claude-code/injections.yaml +0 -242
  335. package/bmad/bmm/sub-modules/claude-code/readme.md +0 -87
  336. package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +0 -350
  337. package/bmad/bmm/testarch/knowledge/api-request.md +0 -442
  338. package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +0 -843
  339. package/bmad/bmm/testarch/knowledge/auth-session.md +0 -552
  340. package/bmad/bmm/testarch/knowledge/burn-in.md +0 -273
  341. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  342. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  343. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  344. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  345. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  346. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  347. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  348. package/bmad/bmm/testarch/knowledge/file-utils.md +0 -463
  349. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  350. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +0 -382
  351. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +0 -430
  352. package/bmad/bmm/testarch/knowledge/log.md +0 -429
  353. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +0 -405
  354. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  355. package/bmad/bmm/testarch/knowledge/network-recorder.md +0 -527
  356. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  357. package/bmad/bmm/testarch/knowledge/overview.md +0 -286
  358. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  359. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  360. package/bmad/bmm/testarch/knowledge/recurse.md +0 -421
  361. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  362. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  363. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  364. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  365. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  366. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  367. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  368. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  369. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  370. package/bmad/bmm/testarch/tea-index.csv +0 -35
  371. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +0 -200
  372. package/bmad/bmm/workflows/1-analysis/research/workflow.md +0 -173
  373. package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +0 -433
  374. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +0 -150
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +0 -59
  376. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +0 -90
  377. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +0 -127
  378. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +0 -39
  379. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +0 -130
  380. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +0 -27
  381. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +0 -43
  382. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +0 -141
  383. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +0 -27
  384. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +0 -49
  385. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +0 -241
  386. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +0 -27
  387. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +0 -38
  388. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +0 -133
  389. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +0 -27
  390. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  391. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -374
  392. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -806
  393. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -47
  394. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -582
  395. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1324
  396. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -54
  397. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -247
  398. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -198
  399. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -149
  400. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -536
  401. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -47
  402. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -320
  403. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -481
  404. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -49
  405. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -407
  406. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -726
  407. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -461
  408. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -49
  409. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -407
  410. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -1158
  411. package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +0 -213
  412. package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +0 -286
  413. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -294
  414. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -71
  415. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -472
  416. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -628
  417. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -390
  418. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -48
  419. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -642
  420. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1030
  421. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -675
  422. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -57
  423. package/bmad/core/resources/excalidraw/README.md +0 -160
  424. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +0 -127
  425. package/bmad/core/resources/excalidraw/library-loader.md +0 -50
  426. package/bmad/core/resources/excalidraw/validate-json-instructions.md +0 -79
  427. package/bmad/core/tasks/bmad-help.md +0 -62
  428. package/dist/commands/guide.d.ts +0 -1
  429. package/dist/commands/guide.js +0 -19
  430. package/dist/commands/implement.d.ts +0 -1
  431. package/dist/commands/implement.js +0 -83
  432. package/dist/commands/plan.d.ts +0 -5
  433. package/dist/commands/plan.js +0 -44
  434. package/dist/commands/reset.d.ts +0 -5
  435. package/dist/commands/reset.js +0 -35
  436. package/dist/commands/resume.d.ts +0 -1
  437. package/dist/commands/resume.js +0 -44
  438. package/dist/commands/start.d.ts +0 -5
  439. package/dist/commands/start.js +0 -54
  440. package/dist/transition.d.ts +0 -52
  441. package/dist/transition.js +0 -656
  442. package/slash-commands/atdd.md +0 -1
  443. package/slash-commands/continuous-integration.md +0 -1
  444. package/slash-commands/create-dataflow.md +0 -1
  445. package/slash-commands/create-diagram.md +0 -1
  446. package/slash-commands/create-flowchart.md +0 -1
  447. package/slash-commands/create-wireframe.md +0 -1
  448. package/slash-commands/nfr-assess.md +0 -1
  449. package/slash-commands/tea.md +0 -1
  450. package/slash-commands/test-automate.md +0 -1
  451. package/slash-commands/test-design.md +0 -1
  452. package/slash-commands/test-framework.md +0 -1
  453. package/slash-commands/test-review.md +0 -1
  454. package/slash-commands/test-trace.md +0 -1
  455. package/slash-commands/validate-test-design.md +0 -1
@@ -1,198 +1,209 @@
1
- <?xml version="1.0"?>
2
- <!-- if possible, run this in a separate subagent or process with read access to the project,
3
- but no context except the content to review -->
4
- <task id="_bmad/core/tasks/editorial-review-structure.xml"
5
- name="Editorial Review - Structure"
6
- description="Structural editor that proposes cuts, reorganization,
7
- and simplification while preserving comprehension"
8
- standalone="false">
9
- <objective>Review document structure and propose substantive changes
10
- to improve clarity and flow-run this BEFORE copy editing</objective>
11
- <inputs>
12
- <input name="content" required="true"
13
- desc="Document to review (markdown, plain text, or structured content)"/>
14
- <input name="purpose" required="false"
15
- desc="Document's intended purpose (e.g., 'quickstart tutorial',
16
- 'API reference', 'conceptual overview')"/>
17
- <input name="target_audience" required="false"
18
- desc="Who reads this? (e.g., 'new users', 'experienced developers',
19
- 'decision makers')"/>
20
- <input name="reader_type" required="false" default="humans"
21
- desc="'humans' (default) preserves comprehension aids;
22
- 'llm' optimizes for precision and density"/>
23
- <input name="length_target" required="false"
24
- desc="Target reduction (e.g., '30% shorter', 'half the length',
25
- 'no limit')"/>
26
- </inputs>
27
- <llm critical="true">
28
- <i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
29
- <i>DO NOT skip steps or change the sequence</i>
30
- <i>HALT immediately when halt-conditions are met</i>
31
- <i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
32
- <i>You are a structural editor focused on HIGH-VALUE DENSITY</i>
33
- <i>Brevity IS clarity: Concise writing respects limited attention spans and enables effective scanning</i>
34
- <i>Every section must justify its existence-cut anything that delays understanding</i>
35
- <i>True redundancy is failure</i>
36
- <principles>
37
- <i>Comprehension through calibration: Optimize for the minimum words needed to maintain understanding</i>
38
- <i>Front-load value: Critical information comes first; nice-to-know comes last (or goes)</i>
39
- <i>One source of truth: If information appears identically twice, consolidate</i>
40
- <i>Scope discipline: Content that belongs in a different document should be cut or linked</i>
41
- <i>Propose, don't execute: Output recommendations-user decides what to accept</i>
42
- <i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only optimize how they're organized.</i>
43
- </principles>
44
- <human-reader-principles>
45
- <i>These elements serve human comprehension and engagement-preserve unless clearly wasteful:</i>
46
- <i>Visual aids: Diagrams, images, and flowcharts anchor understanding</i>
47
- <i>Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place</i>
48
- <i>Reader's Journey: Organize content biologically (linear progression), not logically (database)</i>
49
- <i>Mental models: Overview before details prevents cognitive overload</i>
50
- <i>Warmth: Encouraging tone reduces anxiety for new users</i>
51
- <i>Whitespace: Admonitions and callouts provide visual breathing room</i>
52
- <i>Summaries: Recaps help retention; they're reinforcement, not redundancy</i>
53
- <i>Examples: Concrete illustrations make abstract concepts accessible</i>
54
- <i>Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff"-they maintain attention</i>
55
- </human-reader-principles>
56
- <llm-reader-principles>
57
- <i>When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:</i>
58
- <i>Dependency-first: Define concepts before usage to minimize hallucination risk</i>
59
- <i>Cut emotional language, encouragement, and orientation sections</i>
60
- <i>
61
- IF concept is well-known from training (e.g., "conventional
62
- commits", "REST APIs"): Reference the standard-don't re-teach it
63
- ELSE: Be explicit-don't assume the LLM will infer correctly
64
- </i>
65
- <i>Use consistent terminology-same word for same concept throughout</i>
66
- <i>Eliminate hedging ("might", "could", "generally")-use direct statements</i>
67
- <i>Prefer structured formats (tables, lists, YAML) over prose</i>
68
- <i>Reference known standards ("conventional commits", "Google style guide") to leverage training</i>
69
- <i>STILL PROVIDE EXAMPLES even for known standards-grounds the LLM in your specific expectation</i>
70
- <i>Unambiguous references-no unclear antecedents ("it", "this", "the above")</i>
71
- <i>Note: LLM documents may be LONGER than human docs in some areas
72
- (more explicit) while shorter in others (no warmth)</i>
73
- </llm-reader-principles>
74
- <structure-models>
75
- <model name="Tutorial/Guide (Linear)" applicability="Tutorials, detailed guides, how-to articles, walkthroughs">
76
- <i>Prerequisites: Setup/Context MUST precede action</i>
77
- <i>Sequence: Steps must follow strict chronological or logical dependency order</i>
78
- <i>Goal-oriented: clear 'Definition of Done' at the end</i>
79
- </model>
80
- <model name="Reference/Database" applicability="API docs, glossaries, configuration references, cheat sheets">
81
- <i>Random Access: No narrative flow required; user jumps to specific item</i>
82
- <i>MECE: Topics are Mutually Exclusive and Collectively Exhaustive</i>
83
- <i>Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)</i>
84
- </model>
85
- <model name="Explanation (Conceptual)"
86
- applicability="Deep dives, architecture overviews, conceptual guides,
87
- whitepapers, project context">
88
- <i>Abstract to Concrete: Definition to Context to Implementation/Example</i>
89
- <i>Scaffolding: Complex ideas built on established foundations</i>
90
- </model>
91
- <model name="Prompt/Task Definition (Functional)"
92
- applicability="BMAD tasks, prompts, system instructions, XML definitions">
93
- <i>Meta-first: Inputs, usage constraints, and context defined before instructions</i>
94
- <i>Separation of Concerns: Instructions (logic) separate from Data (content)</i>
95
- <i>Step-by-step: Execution flow must be explicit and ordered</i>
96
- </model>
97
- <model name="Strategic/Context (Pyramid)" applicability="PRDs, research reports, proposals, decision records">
98
- <i>Top-down: Conclusion/Status/Recommendation starts the document</i>
99
- <i>Grouping: Supporting context grouped logically below the headline</i>
100
- <i>Ordering: Most critical information first</i>
101
- <i>MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive</i>
102
- <i>Evidence: Data supports arguments, never leads</i>
103
- </model>
104
- </structure-models>
105
- </llm>
106
- <flow>
107
- <step n="1" title="Validate Input">
108
- <action>Check if content is empty or contains fewer than 3 words</action>
109
- <action if="empty or fewer than 3 words">HALT with error: "Content
110
- too short for substantive review (minimum 3 words required)"</action>
111
- <action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
112
- <action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
113
- <action>Identify document type and structure (headings, sections, lists, etc.)</action>
114
- <action>Note the current word count and section count</action>
115
- </step>
116
- <step n="2" title="Understand Purpose">
117
- <action>If purpose was provided, use it; otherwise infer from content</action>
118
- <action>If target_audience was provided, use it; otherwise infer from content</action>
119
- <action>Identify the core question the document answers</action>
120
- <action>State in one sentence: "This document exists to help [audience] accomplish [goal]"</action>
121
- <action>Select the most appropriate structural model from structure-models based on purpose/audience</action>
122
- <action>Note reader_type and which principles apply (human-reader-principles or llm-reader-principles)</action>
123
- </step>
124
- <step n="3" title="Structural Analysis" critical="true">
125
- <action>Map the document structure: list each major section with its word count</action>
126
- <action>Evaluate structure against the selected model's primary rules
127
- (e.g., 'Does recommendation come first?' for Pyramid)</action>
128
- <action>For each section, answer: Does this directly serve the stated purpose?</action>
129
- <action if="reader_type='humans'">For each comprehension aid (visual,
130
- summary, example, callout), answer: Does this help readers
131
- understand or stay engaged?</action>
132
- <action>Identify sections that could be: cut entirely, merged with
133
- another, moved to a different location, or split</action>
134
- <action>Identify true redundancies: identical information repeated
135
- without purpose (not summaries or reinforcement)</action>
136
- <action>Identify scope violations: content that belongs in a different document</action>
137
- <action>Identify burying: critical information hidden deep in the document</action>
138
- </step>
139
- <step n="4" title="Flow Analysis">
140
- <action>Assess the reader's journey: Does the sequence match how readers will use this?</action>
141
- <action>Identify premature detail: explanation given before the reader needs it</action>
142
- <action>Identify missing scaffolding: complex ideas without adequate setup</action>
143
- <action>Identify anti-patterns: FAQs that should be inline, appendices
144
- that should be cut, overviews that repeat the body verbatim</action>
145
- <action if="reader_type='humans'">Assess pacing: Is there enough
146
- whitespace and visual variety to maintain attention?</action>
147
- </step>
148
- <step n="5" title="Generate Recommendations">
149
- <action>Compile all findings into prioritized recommendations</action>
150
- <action>Categorize each recommendation: CUT (remove entirely),
151
- MERGE (combine sections), MOVE (reorder), CONDENSE (shorten
152
- significantly), QUESTION (needs author decision), PRESERVE
153
- (explicitly keep-for elements that might seem cuttable but
154
- serve comprehension)</action>
155
- <action>For each recommendation, state the rationale in one sentence</action>
156
- <action>Estimate impact: how many words would this save (or cost, for PRESERVE)?</action>
157
- <action>If length_target was provided, assess whether recommendations meet it</action>
158
- <action if="reader_type='humans' and recommendations would cut
159
- comprehension aids">Flag with warning: "This cut may impact
160
- reader comprehension/engagement"</action>
161
- </step>
162
- <step n="6" title="Output Results">
163
- <action>Output document summary (purpose, audience, reader_type, current length)</action>
164
- <action>Output the recommendation list in priority order</action>
165
- <action>Output estimated total reduction if all recommendations accepted</action>
166
- <action if="no recommendations">Output: "No substantive changes recommended-document structure is sound"</action>
167
- <output-format>
168
- ## Document Summary
169
- - **Purpose:** [inferred or provided purpose]
170
- - **Audience:** [inferred or provided audience]
171
- - **Reader type:** [selected reader type]
172
- - **Structure model:** [selected structure model]
173
- - **Current length:** [X] words across [Y] sections
174
-
175
- ## Recommendations
176
-
177
- ### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
178
- **Rationale:** [One sentence explanation]
179
- **Impact:** ~[X] words
180
- **Comprehension note:** [If applicable, note impact on reader understanding]
181
-
182
- ### 2. ...
183
-
184
- ## Summary
185
- - **Total recommendations:** [N]
186
- - **Estimated reduction:** [X] words ([Y]% of original)
187
- - **Meets length target:** [Yes/No/No target specified]
188
- - **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
189
- </output-format>
190
- </step>
191
- </flow>
192
- <halt-conditions>
193
- <condition>HALT with error if content is empty or fewer than 3 words</condition>
194
- <condition>HALT with error if reader_type is not "humans" or "llm"</condition>
195
- <condition>If no structural issues found, output "No substantive changes
196
- recommended" (this is valid completion, not an error)</condition>
197
- </halt-conditions>
198
- </task>
1
+ <?xml version="1.0"?>
2
+ <!-- if possible, run this in a separate subagent or process with read access to the project,
3
+ but no context except the content to review -->
4
+ <task id="_bmad/core/tasks/editorial-review-structure.xml"
5
+ name="Editorial Review - Structure"
6
+ description="Structural editor that proposes cuts, reorganization,
7
+ and simplification while preserving comprehension">
8
+ <objective>Review document structure and propose substantive changes
9
+ to improve clarity and flow-run this BEFORE copy editing</objective>
10
+ <inputs>
11
+ <input name="content" required="true"
12
+ desc="Document to review (markdown, plain text, or structured content)" />
13
+ <input name="style_guide" required="false"
14
+ desc="Project-specific style guide. When provided, overrides all generic
15
+ principles in this task (except CONTENT IS SACROSANCT). The style guide
16
+ is the final authority on tone, structure, and language choices." />
17
+ <input name="purpose" required="false"
18
+ desc="Document's intended purpose (e.g., 'quickstart tutorial',
19
+ 'API reference', 'conceptual overview')" />
20
+ <input name="target_audience" required="false"
21
+ desc="Who reads this? (e.g., 'new users', 'experienced developers',
22
+ 'decision makers')" />
23
+ <input name="reader_type" required="false" default="humans"
24
+ desc="'humans' (default) preserves comprehension aids;
25
+ 'llm' optimizes for precision and density" />
26
+ <input name="length_target" required="false"
27
+ desc="Target reduction (e.g., '30% shorter', 'half the length',
28
+ 'no limit')" />
29
+ </inputs>
30
+ <llm critical="true">
31
+ <i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
32
+ <i>DO NOT skip steps or change the sequence</i>
33
+ <i>HALT immediately when halt-conditions are met</i>
34
+ <i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
35
+ <i>You are a structural editor focused on HIGH-VALUE DENSITY</i>
36
+ <i>Brevity IS clarity: Concise writing respects limited attention spans and enables effective scanning</i>
37
+ <i>Every section must justify its existence-cut anything that delays understanding</i>
38
+ <i>True redundancy is failure</i>
39
+ <principles>
40
+ <i>Comprehension through calibration: Optimize for the minimum words needed to maintain understanding</i>
41
+ <i>Front-load value: Critical information comes first; nice-to-know comes last (or goes)</i>
42
+ <i>One source of truth: If information appears identically twice, consolidate</i>
43
+ <i>Scope discipline: Content that belongs in a different document should be cut or linked</i>
44
+ <i>Propose, don't execute: Output recommendations-user decides what to accept</i>
45
+ <i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only optimize how they're organized.</i>
46
+ </principles>
47
+ <i critical="true">STYLE GUIDE OVERRIDE: If a style_guide input is provided,
48
+ it overrides ALL generic principles in this task (including human-reader-principles,
49
+ llm-reader-principles, reader_type-specific priorities, structure-models selection,
50
+ and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS
51
+ SACROSANCT—never change what ideas say, only how they're expressed. When style
52
+ guide conflicts with this task, style guide wins.</i>
53
+ <human-reader-principles>
54
+ <i>These elements serve human comprehension and engagement-preserve unless clearly wasteful:</i>
55
+ <i>Visual aids: Diagrams, images, and flowcharts anchor understanding</i>
56
+ <i>Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place</i>
57
+ <i>Reader's Journey: Organize content biologically (linear progression), not logically (database)</i>
58
+ <i>Mental models: Overview before details prevents cognitive overload</i>
59
+ <i>Warmth: Encouraging tone reduces anxiety for new users</i>
60
+ <i>Whitespace: Admonitions and callouts provide visual breathing room</i>
61
+ <i>Summaries: Recaps help retention; they're reinforcement, not redundancy</i>
62
+ <i>Examples: Concrete illustrations make abstract concepts accessible</i>
63
+ <i>Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff"-they maintain attention</i>
64
+ </human-reader-principles>
65
+ <llm-reader-principles>
66
+ <i>When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:</i>
67
+ <i>Dependency-first: Define concepts before usage to minimize hallucination risk</i>
68
+ <i>Cut emotional language, encouragement, and orientation sections</i>
69
+ <i>
70
+ IF concept is well-known from training (e.g., "conventional
71
+ commits", "REST APIs"): Reference the standard-don't re-teach it
72
+ ELSE: Be explicit-don't assume the LLM will infer correctly
73
+ </i>
74
+ <i>Use consistent terminology-same word for same concept throughout</i>
75
+ <i>Eliminate hedging ("might", "could", "generally")-use direct statements</i>
76
+ <i>Prefer structured formats (tables, lists, YAML) over prose</i>
77
+ <i>Reference known standards ("conventional commits", "Google style guide") to leverage training</i>
78
+ <i>STILL PROVIDE EXAMPLES even for known standards-grounds the LLM in your specific expectation</i>
79
+ <i>Unambiguous references-no unclear antecedents ("it", "this", "the above")</i>
80
+ <i>Note: LLM documents may be LONGER than human docs in some areas
81
+ (more explicit) while shorter in others (no warmth)</i>
82
+ </llm-reader-principles>
83
+ <structure-models>
84
+ <model name="Tutorial/Guide (Linear)" applicability="Tutorials, detailed guides, how-to articles, walkthroughs">
85
+ <i>Prerequisites: Setup/Context MUST precede action</i>
86
+ <i>Sequence: Steps must follow strict chronological or logical dependency order</i>
87
+ <i>Goal-oriented: clear 'Definition of Done' at the end</i>
88
+ </model>
89
+ <model name="Reference/Database" applicability="API docs, glossaries, configuration references, cheat sheets">
90
+ <i>Random Access: No narrative flow required; user jumps to specific item</i>
91
+ <i>MECE: Topics are Mutually Exclusive and Collectively Exhaustive</i>
92
+ <i>Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)</i>
93
+ </model>
94
+ <model name="Explanation (Conceptual)"
95
+ applicability="Deep dives, architecture overviews, conceptual guides,
96
+ whitepapers, project context">
97
+ <i>Abstract to Concrete: Definition to Context to Implementation/Example</i>
98
+ <i>Scaffolding: Complex ideas built on established foundations</i>
99
+ </model>
100
+ <model name="Prompt/Task Definition (Functional)"
101
+ applicability="BMAD tasks, prompts, system instructions, XML definitions">
102
+ <i>Meta-first: Inputs, usage constraints, and context defined before instructions</i>
103
+ <i>Separation of Concerns: Instructions (logic) separate from Data (content)</i>
104
+ <i>Step-by-step: Execution flow must be explicit and ordered</i>
105
+ </model>
106
+ <model name="Strategic/Context (Pyramid)" applicability="PRDs, research reports, proposals, decision records">
107
+ <i>Top-down: Conclusion/Status/Recommendation starts the document</i>
108
+ <i>Grouping: Supporting context grouped logically below the headline</i>
109
+ <i>Ordering: Most critical information first</i>
110
+ <i>MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive</i>
111
+ <i>Evidence: Data supports arguments, never leads</i>
112
+ </model>
113
+ </structure-models>
114
+ </llm>
115
+ <flow>
116
+ <step n="1" title="Validate Input">
117
+ <action>Check if content is empty or contains fewer than 3 words</action>
118
+ <action if="empty or fewer than 3 words">HALT with error: "Content
119
+ too short for substantive review (minimum 3 words required)"</action>
120
+ <action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
121
+ <action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
122
+ <action>Identify document type and structure (headings, sections, lists, etc.)</action>
123
+ <action>Note the current word count and section count</action>
124
+ </step>
125
+ <step n="2" title="Understand Purpose">
126
+ <action>If purpose was provided, use it; otherwise infer from content</action>
127
+ <action>If target_audience was provided, use it; otherwise infer from content</action>
128
+ <action>Identify the core question the document answers</action>
129
+ <action>State in one sentence: "This document exists to help [audience] accomplish [goal]"</action>
130
+ <action>Select the most appropriate structural model from structure-models based on purpose/audience</action>
131
+ <action>Note reader_type and which principles apply (human-reader-principles or llm-reader-principles)</action>
132
+ </step>
133
+ <step n="3" title="Structural Analysis" critical="true">
134
+ <action if="style_guide provided">Consult style_guide now and note its key requirements—these override default principles for this
135
+ analysis</action>
136
+ <action>Map the document structure: list each major section with its word count</action>
137
+ <action>Evaluate structure against the selected model's primary rules
138
+ (e.g., 'Does recommendation come first?' for Pyramid)</action>
139
+ <action>For each section, answer: Does this directly serve the stated purpose?</action>
140
+ <action if="reader_type='humans'">For each comprehension aid (visual,
141
+ summary, example, callout), answer: Does this help readers
142
+ understand or stay engaged?</action>
143
+ <action>Identify sections that could be: cut entirely, merged with
144
+ another, moved to a different location, or split</action>
145
+ <action>Identify true redundancies: identical information repeated
146
+ without purpose (not summaries or reinforcement)</action>
147
+ <action>Identify scope violations: content that belongs in a different document</action>
148
+ <action>Identify burying: critical information hidden deep in the document</action>
149
+ </step>
150
+ <step n="4" title="Flow Analysis">
151
+ <action>Assess the reader's journey: Does the sequence match how readers will use this?</action>
152
+ <action>Identify premature detail: explanation given before the reader needs it</action>
153
+ <action>Identify missing scaffolding: complex ideas without adequate setup</action>
154
+ <action>Identify anti-patterns: FAQs that should be inline, appendices
155
+ that should be cut, overviews that repeat the body verbatim</action>
156
+ <action if="reader_type='humans'">Assess pacing: Is there enough
157
+ whitespace and visual variety to maintain attention?</action>
158
+ </step>
159
+ <step n="5" title="Generate Recommendations">
160
+ <action>Compile all findings into prioritized recommendations</action>
161
+ <action>Categorize each recommendation: CUT (remove entirely),
162
+ MERGE (combine sections), MOVE (reorder), CONDENSE (shorten
163
+ significantly), QUESTION (needs author decision), PRESERVE
164
+ (explicitly keep-for elements that might seem cuttable but
165
+ serve comprehension)</action>
166
+ <action>For each recommendation, state the rationale in one sentence</action>
167
+ <action>Estimate impact: how many words would this save (or cost, for PRESERVE)?</action>
168
+ <action>If length_target was provided, assess whether recommendations meet it</action>
169
+ <action if="reader_type='humans' and recommendations would cut
170
+ comprehension aids">Flag with warning: "This cut may impact
171
+ reader comprehension/engagement"</action>
172
+ </step>
173
+ <step n="6" title="Output Results">
174
+ <action>Output document summary (purpose, audience, reader_type, current length)</action>
175
+ <action>Output the recommendation list in priority order</action>
176
+ <action>Output estimated total reduction if all recommendations accepted</action>
177
+ <action if="no recommendations">Output: "No substantive changes recommended-document structure is sound"</action>
178
+ <output-format>
179
+ ## Document Summary
180
+ - **Purpose:** [inferred or provided purpose]
181
+ - **Audience:** [inferred or provided audience]
182
+ - **Reader type:** [selected reader type]
183
+ - **Structure model:** [selected structure model]
184
+ - **Current length:** [X] words across [Y] sections
185
+
186
+ ## Recommendations
187
+
188
+ ### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
189
+ **Rationale:** [One sentence explanation]
190
+ **Impact:** ~[X] words
191
+ **Comprehension note:** [If applicable, note impact on reader understanding]
192
+
193
+ ### 2. ...
194
+
195
+ ## Summary
196
+ - **Total recommendations:** [N]
197
+ - **Estimated reduction:** [X] words ([Y]% of original)
198
+ - **Meets length target:** [Yes/No/No target specified]
199
+ - **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
200
+ </output-format>
201
+ </step>
202
+ </flow>
203
+ <halt-conditions>
204
+ <condition>HALT with error if content is empty or fewer than 3 words</condition>
205
+ <condition>HALT with error if reader_type is not "humans" or "llm"</condition>
206
+ <condition>If no structural issues found, output "No substantive changes
207
+ recommended" (this is valid completion, not an error)</condition>
208
+ </halt-conditions>
209
+ </task>
@@ -0,0 +1,85 @@
1
+ ---
2
+ name: help
3
+ description: Get unstuck by showing what workflow steps come next or answering questions about what to do
4
+ ---
5
+
6
+ # Task: BMAD Help
7
+
8
+ ## ROUTING RULES
9
+
10
+ - **Empty `phase` = anytime** — Universal tools work regardless of workflow state
11
+ - **Numbered phases indicate sequence** — Phases like `1-discover` → `2-define` → `3-build` → `4-ship` flow in order (naming varies by module)
12
+ - **Stay in module** — Guide through the active module's workflow based on phase+sequence ordering
13
+ - **Descriptions contain routing** — Read for alternate paths (e.g., "back to previous if fixes needed")
14
+ - **`required=true` blocks progress** — Required workflows must complete before proceeding to later phases
15
+ - **Artifacts reveal completion** — Search resolved output paths for `outputs` patterns, fuzzy-match found files to workflow rows
16
+
17
+ ## DISPLAY RULES
18
+
19
+ ### Command-Based Workflows
20
+ When `command` field has a value:
21
+ - Show the command prefixed with `/` (e.g., `/bmad-bmm-create-prd`)
22
+
23
+ ### Agent-Based Workflows
24
+ When `command` field is empty:
25
+ - User loads agent first via `/agent-command`
26
+ - Then invokes by referencing the `code` field or describing the `name` field
27
+ - Do NOT show a slash command — show the code value and agent load instruction instead
28
+
29
+ Example presentation for empty command:
30
+ ```
31
+ Explain Concept (EC)
32
+ Load: /tech-writer, then ask to "EC about [topic]"
33
+ Agent: Tech Writer
34
+ Description: Create clear technical explanations with examples...
35
+ ```
36
+
37
+ ## MODULE DETECTION
38
+
39
+ - **Empty `module` column** → universal tools (work across all modules)
40
+ - **Named `module`** → module-specific workflows
41
+
42
+ Detect the active module from conversation context, recent workflows, or user query keywords. If ambiguous, ask the user.
43
+
44
+ ## INPUT ANALYSIS
45
+
46
+ Determine what was just completed:
47
+ - Explicit completion stated by user
48
+ - Workflow completed in current conversation
49
+ - Artifacts found matching `outputs` patterns
50
+ - If `index.md` exists, read it for additional context
51
+ - If still unclear, ask: "What workflow did you most recently complete?"
52
+
53
+ ## EXECUTION
54
+
55
+ 1. **Load catalog** — Load `{project-root}/_bmad/_config/bmad-help.csv`
56
+
57
+ 2. **Resolve output locations and config** — Scan each folder under `_bmad/` (except `_config`) for `config.yaml`. For each workflow row, resolve its `output-location` variables against that module's config so artifact paths can be searched. Also extract `communication_language` and `project_knowledge` from each scanned module's config.
58
+
59
+ 3. **Ground in project knowledge** — If `project_knowledge` resolves to an existing path, read available documentation files (architecture docs, project overview, tech stack references) for grounding context. Use discovered project facts when composing any project-specific output. Never fabricate project-specific details — if documentation is unavailable, state so.
60
+
61
+ 4. **Detect active module** — Use MODULE DETECTION above
62
+
63
+ 5. **Analyze input** — Task may provide a workflow name/code, conversational phrase, or nothing. Infer what was just completed using INPUT ANALYSIS above.
64
+
65
+ 6. **Present recommendations** — Show next steps based on:
66
+ - Completed workflows detected
67
+ - Phase/sequence ordering (ROUTING RULES)
68
+ - Artifact presence
69
+
70
+ **Optional items first** — List optional workflows until a required step is reached
71
+ **Required items next** — List the next required workflow
72
+
73
+ For each item, apply DISPLAY RULES above and include:
74
+ - Workflow **name**
75
+ - **Command** OR **Code + Agent load instruction** (per DISPLAY RULES)
76
+ - **Agent** title and display name from the CSV (e.g., "🎨 Alex (Designer)")
77
+ - Brief **description**
78
+
79
+ 7. **Additional guidance to convey**:
80
+ - Present all output in `{communication_language}`
81
+ - Run each workflow in a **fresh context window**
82
+ - For **validation workflows**: recommend using a different high-quality LLM if available
83
+ - For conversational requests: match the user's tone while presenting clearly
84
+
85
+ 8. Return to the calling process after presenting recommendations.