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