siesa-agents 2.1.40 → 2.1.42

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 (552) hide show
  1. package/README.md +147 -147
  2. package/bin/install.js +534 -534
  3. package/bin/prepare-publish.js +26 -26
  4. package/bin/restore-folders.js +26 -26
  5. package/bmad/_config/agent-manifest.csv +20 -20
  6. package/bmad/_config/agents/bmb-agent-builder.customize.yaml +41 -41
  7. package/bmad/_config/agents/bmb-module-builder.customize.yaml +41 -41
  8. package/bmad/_config/agents/bmb-workflow-builder.customize.yaml +41 -41
  9. package/bmad/_config/files-manifest.csv +469 -469
  10. package/bmad/_config/ides/claude-code.yaml +6 -6
  11. package/bmad/_config/manifest.yaml +14 -14
  12. package/bmad/_config/task-manifest.csv +6 -6
  13. package/bmad/_config/tool-manifest.csv +1 -1
  14. package/bmad/_config/workflow-manifest.csv +45 -45
  15. package/bmad/_memory/config.yaml +11 -11
  16. package/bmad/bmb/README.md +25 -25
  17. package/bmad/bmb/agents/agent-builder.md +57 -57
  18. package/bmad/bmb/agents/module-builder.md +60 -60
  19. package/bmad/bmb/agents/workflow-builder.md +56 -56
  20. package/bmad/bmb/config.yaml +12 -12
  21. package/bmad/bmb/docs/workflows/architecture.md +220 -220
  22. package/bmad/bmb/docs/workflows/common-workflow-tools.csv +18 -18
  23. package/bmad/bmb/docs/workflows/csv-data-file-standards.md +206 -206
  24. package/bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +220 -220
  25. package/bmad/bmb/docs/workflows/step-file-rules.md +469 -469
  26. package/bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md +241 -241
  27. package/bmad/bmb/docs/workflows/templates/step-1b-template.md +223 -223
  28. package/bmad/bmb/docs/workflows/templates/step-file.md +139 -139
  29. package/bmad/bmb/docs/workflows/templates/step-template.md +290 -290
  30. package/bmad/bmb/docs/workflows/templates/workflow-template.md +104 -104
  31. package/bmad/bmb/docs/workflows/templates/workflow.md +58 -58
  32. package/bmad/bmb/docs/workflows/terms.md +97 -97
  33. package/bmad/bmb/reference/agents/simple-examples/README.md +223 -223
  34. package/bmad/bmb/reference/readme.md +3 -3
  35. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  36. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  37. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +27 -27
  38. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +177 -177
  39. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +121 -121
  40. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +165 -165
  41. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +154 -154
  42. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +183 -183
  43. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +168 -168
  44. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +195 -195
  45. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +25 -25
  46. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  47. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  48. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +47 -47
  49. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +37 -37
  50. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +18 -18
  51. package/bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md +59 -59
  52. package/bmad/bmb/workflows/agent/data/agent-compilation.md +273 -273
  53. package/bmad/bmb/workflows/agent/data/agent-menu-patterns.md +233 -233
  54. package/bmad/bmb/workflows/agent/data/agent-metadata.md +208 -208
  55. package/bmad/bmb/workflows/agent/data/brainstorm-context.md +146 -146
  56. package/bmad/bmb/workflows/agent/data/communication-presets.csv +61 -61
  57. package/bmad/bmb/workflows/agent/data/critical-actions.md +120 -120
  58. package/bmad/bmb/workflows/agent/data/expert-agent-architecture.md +236 -236
  59. package/bmad/bmb/workflows/agent/data/expert-agent-validation.md +173 -173
  60. package/bmad/bmb/workflows/agent/data/module-agent-validation.md +124 -124
  61. package/bmad/bmb/workflows/agent/data/persona-properties.md +266 -266
  62. package/bmad/bmb/workflows/agent/data/principles-crafting.md +292 -292
  63. package/bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +16 -16
  64. package/bmad/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -68
  65. package/bmad/bmb/workflows/agent/data/simple-agent-architecture.md +204 -204
  66. package/bmad/bmb/workflows/agent/data/simple-agent-validation.md +132 -132
  67. package/bmad/bmb/workflows/agent/data/understanding-agent-types.md +222 -222
  68. package/bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md +126 -126
  69. package/bmad/bmb/workflows/agent/steps-c/step-02-discovery.md +168 -168
  70. package/bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md +294 -294
  71. package/bmad/bmb/workflows/agent/steps-c/step-04-persona.md +210 -210
  72. package/bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md +176 -176
  73. package/bmad/bmb/workflows/agent/steps-c/step-06-activation.md +275 -275
  74. package/bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md +185 -185
  75. package/bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md +201 -201
  76. package/bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md +258 -258
  77. package/bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +203 -203
  78. package/bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +135 -135
  79. package/bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md +161 -161
  80. package/bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +158 -158
  81. package/bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +306 -306
  82. package/bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +462 -462
  83. package/bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md +244 -244
  84. package/bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md +214 -214
  85. package/bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md +191 -191
  86. package/bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md +78 -78
  87. package/bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md +76 -76
  88. package/bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md +75 -75
  89. package/bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md +75 -75
  90. package/bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md +78 -78
  91. package/bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md +119 -119
  92. package/bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md +122 -122
  93. package/bmad/bmb/workflows/agent/steps-e/e-05-persona.md +132 -132
  94. package/bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md +120 -120
  95. package/bmad/bmb/workflows/agent/steps-e/e-07-activation.md +122 -122
  96. package/bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +134 -134
  97. package/bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +117 -117
  98. package/bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md +120 -120
  99. package/bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +70 -70
  100. package/bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +70 -70
  101. package/bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +69 -69
  102. package/bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +69 -69
  103. package/bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +70 -70
  104. package/bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +111 -111
  105. package/bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md +150 -150
  106. package/bmad/bmb/workflows/agent/steps-v/v-01-load-review.md +128 -128
  107. package/bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +73 -73
  108. package/bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +72 -72
  109. package/bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +71 -71
  110. package/bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +71 -71
  111. package/bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +76 -76
  112. package/bmad/bmb/workflows/agent/steps-v/v-03-summary.md +100 -100
  113. package/bmad/bmb/workflows/agent/templates/agent-plan.template.md +5 -5
  114. package/bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +76 -76
  115. package/bmad/bmb/workflows/agent/templates/simple-agent.template.md +71 -71
  116. package/bmad/bmb/workflows/agent/workflow.md +123 -123
  117. package/bmad/bmb/workflows/create-module/steps/step-01-init.md +156 -156
  118. package/bmad/bmb/workflows/create-module/steps/step-01b-continue.md +170 -170
  119. package/bmad/bmb/workflows/create-module/steps/step-02-concept.md +218 -218
  120. package/bmad/bmb/workflows/create-module/steps/step-03-components.md +268 -268
  121. package/bmad/bmb/workflows/create-module/steps/step-04-structure.md +229 -229
  122. package/bmad/bmb/workflows/create-module/steps/step-05-config.md +234 -234
  123. package/bmad/bmb/workflows/create-module/steps/step-06-agents.md +297 -297
  124. package/bmad/bmb/workflows/create-module/steps/step-07-workflows.md +229 -229
  125. package/bmad/bmb/workflows/create-module/steps/step-08-installer.md +187 -187
  126. package/bmad/bmb/workflows/create-module/steps/step-09-documentation.md +310 -310
  127. package/bmad/bmb/workflows/create-module/steps/step-10-roadmap.md +338 -338
  128. package/bmad/bmb/workflows/create-module/steps/step-11-validate.md +336 -336
  129. package/bmad/bmb/workflows/create-module/templates/agent.template.md +313 -313
  130. package/bmad/bmb/workflows/create-module/templates/installer.template.js +47 -47
  131. package/bmad/bmb/workflows/create-module/templates/module-plan.template.md +5 -5
  132. package/bmad/bmb/workflows/create-module/templates/module.template.yaml +53 -53
  133. package/bmad/bmb/workflows/create-module/templates/workflow-plan-template.md +23 -23
  134. package/bmad/bmb/workflows/create-module/validation.md +126 -126
  135. package/bmad/bmb/workflows/create-module/workflow.md +56 -56
  136. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  137. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  138. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv +27 -27
  139. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +177 -177
  140. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +150 -150
  141. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +164 -164
  142. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +152 -152
  143. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +182 -182
  144. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +167 -167
  145. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +194 -194
  146. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md +25 -25
  147. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  148. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  149. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md +47 -47
  150. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md +37 -37
  151. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md +18 -18
  152. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +58 -58
  153. package/bmad/bmb/workflows/create-workflow/steps/step-01-init.md +158 -158
  154. package/bmad/bmb/workflows/create-workflow/steps/step-02-gather.md +212 -212
  155. package/bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +251 -251
  156. package/bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md +217 -217
  157. package/bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +290 -290
  158. package/bmad/bmb/workflows/create-workflow/steps/step-06-design.md +272 -272
  159. package/bmad/bmb/workflows/create-workflow/steps/step-07-build.md +323 -323
  160. package/bmad/bmb/workflows/create-workflow/steps/step-08-review.md +285 -285
  161. package/bmad/bmb/workflows/create-workflow/steps/step-09-complete.md +188 -188
  162. package/bmad/bmb/workflows/create-workflow/workflow.md +59 -59
  163. package/bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md +217 -217
  164. package/bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md +254 -254
  165. package/bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md +218 -218
  166. package/bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md +194 -194
  167. package/bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +246 -246
  168. package/bmad/bmb/workflows/edit-workflow/templates/completion-summary.md +75 -75
  169. package/bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md +68 -68
  170. package/bmad/bmb/workflows/edit-workflow/templates/improvement-log.md +40 -40
  171. package/bmad/bmb/workflows/edit-workflow/templates/validation-results.md +51 -51
  172. package/bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md +56 -56
  173. package/bmad/bmb/workflows/edit-workflow/workflow.md +59 -59
  174. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +153 -153
  175. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +244 -244
  176. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +275 -275
  177. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +296 -296
  178. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +265 -265
  179. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +361 -361
  180. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +259 -259
  181. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +302 -302
  182. package/bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +140 -140
  183. package/bmad/bmb/workflows/workflow-compliance-check/workflow.md +59 -59
  184. package/bmad/bmb/workflows-legacy/edit-module/README.md +171 -171
  185. package/bmad/bmb/workflows-legacy/edit-module/checklist.md +163 -163
  186. package/bmad/bmb/workflows-legacy/edit-module/instructions.md +340 -340
  187. package/bmad/bmb/workflows-legacy/edit-module/workflow.yaml +32 -32
  188. package/bmad/bmb/workflows-legacy/module-brief/README.md +264 -264
  189. package/bmad/bmb/workflows-legacy/module-brief/checklist.md +116 -116
  190. package/bmad/bmb/workflows-legacy/module-brief/instructions.md +268 -268
  191. package/bmad/bmb/workflows-legacy/module-brief/template.md +275 -275
  192. package/bmad/bmb/workflows-legacy/module-brief/workflow.yaml +34 -34
  193. package/bmad/bmm/agents/analyst.md +76 -76
  194. package/bmad/bmm/agents/architect.md +68 -68
  195. package/bmad/bmm/agents/dev.md +70 -70
  196. package/bmad/bmm/agents/pm.md +70 -70
  197. package/bmad/bmm/agents/quick-flow-solo-dev.md +68 -68
  198. package/bmad/bmm/agents/sm.md +71 -71
  199. package/bmad/bmm/agents/tea.md +71 -71
  200. package/bmad/bmm/agents/tech-writer.md +72 -72
  201. package/bmad/bmm/agents/ux-designer.md +68 -68
  202. package/bmad/bmm/config.yaml +18 -18
  203. package/bmad/bmm/data/README.md +29 -29
  204. package/bmad/bmm/data/documentation-standards.md +262 -262
  205. package/bmad/bmm/data/project-context-template.md +40 -40
  206. package/bmad/bmm/teams/default-party.csv +21 -21
  207. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  208. package/bmad/bmm/testarch/knowledge/api-request.md +303 -303
  209. package/bmad/bmm/testarch/knowledge/auth-session.md +356 -356
  210. package/bmad/bmm/testarch/knowledge/burn-in.md +273 -273
  211. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -675
  212. package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -486
  213. package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -957
  214. package/bmad/bmm/testarch/knowledge/data-factories.md +500 -500
  215. package/bmad/bmm/testarch/knowledge/email-auth.md +721 -721
  216. package/bmad/bmm/testarch/knowledge/error-handling.md +725 -725
  217. package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -750
  218. package/bmad/bmm/testarch/knowledge/file-utils.md +260 -260
  219. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -401
  220. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -382
  221. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +280 -280
  222. package/bmad/bmm/testarch/knowledge/log.md +294 -294
  223. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +272 -272
  224. package/bmad/bmm/testarch/knowledge/network-first.md +486 -486
  225. package/bmad/bmm/testarch/knowledge/network-recorder.md +265 -265
  226. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -670
  227. package/bmad/bmm/testarch/knowledge/overview.md +283 -283
  228. package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -730
  229. package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -601
  230. package/bmad/bmm/testarch/knowledge/recurse.md +296 -296
  231. package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -615
  232. package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -732
  233. package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -527
  234. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -644
  235. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -473
  236. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -373
  237. package/bmad/bmm/testarch/knowledge/test-quality.md +664 -664
  238. package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -372
  239. package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -524
  240. package/bmad/bmm/testarch/tea-index.csv +33 -33
  241. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  242. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +182 -182
  243. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +166 -166
  244. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +204 -204
  245. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +207 -207
  246. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +210 -210
  247. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +224 -224
  248. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +199 -199
  249. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -58
  250. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  251. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  252. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  253. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  254. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  255. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  256. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  257. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  258. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -200
  259. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  260. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  261. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  262. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  263. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  264. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  265. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  266. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  267. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  268. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -239
  269. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  270. package/bmad/bmm/workflows/1-analysis/research/workflow.md +173 -173
  271. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  272. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  273. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  274. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  275. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  276. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  277. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  278. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  279. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  280. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  281. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  282. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +332 -248
  283. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  284. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  285. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -228
  286. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  287. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +59 -43
  288. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +12 -12
  289. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +11 -11
  290. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +10 -10
  291. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +197 -197
  292. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +166 -166
  293. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +421 -421
  294. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +290 -290
  295. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +291 -291
  296. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +271 -271
  297. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +262 -262
  298. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +258 -258
  299. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +299 -299
  300. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +270 -270
  301. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +294 -294
  302. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +186 -186
  303. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +63 -63
  304. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -190
  305. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -178
  306. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -179
  307. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -139
  308. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -252
  309. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -133
  310. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  311. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -55
  312. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  313. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/architecture-patterns.md +415 -415
  314. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/backend-standards.md +811 -811
  315. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/frontend-standards.md +375 -375
  316. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technical-preferences-ux.md +422 -422
  317. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technology-stack.md +235 -235
  318. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +10 -10
  319. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  320. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +166 -166
  321. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  322. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  323. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +342 -342
  324. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +328 -328
  325. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +368 -368
  326. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  327. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +366 -366
  328. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -352
  329. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +51 -51
  330. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  331. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  332. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  333. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -145
  334. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  335. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -59
  336. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  337. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +224 -224
  338. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +49 -49
  339. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -279
  340. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -206
  341. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +58 -58
  342. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  343. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-01-determine-story.md +85 -85
  344. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-02-analyze.md +67 -67
  345. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-03-architecture.md +71 -71
  346. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-04-web-research.md +58 -58
  347. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-05-create-file.md +76 -76
  348. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-06-finalize.md +66 -66
  349. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  350. package/bmad/bmm/workflows/4-implementation/create-story/workflow.md +58 -58
  351. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml.bak +63 -63
  352. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +85 -85
  353. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +470 -470
  354. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +25 -25
  355. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -1443
  356. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +56 -56
  357. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  358. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -225
  359. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  360. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -52
  361. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -229
  362. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +34 -34
  363. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md +189 -189
  364. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-02-investigate.md +144 -144
  365. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-03-generate.md +128 -128
  366. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md +173 -173
  367. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/tech-spec-template.md +74 -74
  368. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md +79 -79
  369. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -156
  370. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -120
  371. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -113
  372. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -113
  373. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -106
  374. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -140
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -52
  376. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  377. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  378. package/bmad/bmm/workflows/document-project/instructions.md +221 -221
  379. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  380. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  381. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  382. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  383. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  384. package/bmad/bmm/workflows/document-project/workflow.yaml +28 -28
  385. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  386. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  387. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  388. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  389. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -90
  390. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -127
  391. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -39
  392. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -130
  393. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +25 -25
  394. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -43
  395. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -141
  396. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +25 -25
  397. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -49
  398. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -241
  399. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +25 -25
  400. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -38
  401. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -133
  402. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +25 -25
  403. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -21
  404. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +218 -218
  405. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -318
  406. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -278
  407. package/bmad/bmm/workflows/generate-project-context/workflow.md +50 -50
  408. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -364
  409. package/bmad/bmm/workflows/testarch/atdd/checklist.md +374 -374
  410. package/bmad/bmm/workflows/testarch/atdd/instructions.md +806 -806
  411. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +45 -45
  412. package/bmad/bmm/workflows/testarch/automate/checklist.md +582 -582
  413. package/bmad/bmm/workflows/testarch/automate/instructions.md +1324 -1324
  414. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +52 -52
  415. package/bmad/bmm/workflows/testarch/ci/checklist.md +248 -248
  416. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -198
  417. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -149
  418. package/bmad/bmm/workflows/testarch/ci/instructions.md +536 -536
  419. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +45 -45
  420. package/bmad/bmm/workflows/testarch/framework/checklist.md +321 -321
  421. package/bmad/bmm/workflows/testarch/framework/instructions.md +481 -481
  422. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +47 -47
  423. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -407
  424. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -722
  425. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -445
  426. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +47 -47
  427. package/bmad/bmm/workflows/testarch/test-design/checklist.md +235 -235
  428. package/bmad/bmm/workflows/testarch/test-design/instructions.md +788 -788
  429. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -294
  430. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +54 -54
  431. package/bmad/bmm/workflows/testarch/test-review/checklist.md +472 -472
  432. package/bmad/bmm/workflows/testarch/test-review/instructions.md +628 -628
  433. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -390
  434. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +46 -46
  435. package/bmad/bmm/workflows/testarch/trace/checklist.md +655 -655
  436. package/bmad/bmm/workflows/testarch/trace/instructions.md +1047 -1047
  437. package/bmad/bmm/workflows/testarch/trace/trace-template.md +675 -675
  438. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +55 -55
  439. package/bmad/bmm/workflows/workflow-status/init/instructions.md +346 -346
  440. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +28 -28
  441. package/bmad/bmm/workflows/workflow-status/instructions.md +395 -395
  442. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -103
  443. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -100
  444. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -103
  445. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -100
  446. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -59
  447. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -24
  448. package/bmad/bmm/workflows/workflow-status/workflow.yaml +30 -30
  449. package/bmad/cis/agents/brainstorming-coach.md +60 -60
  450. package/bmad/cis/agents/creative-problem-solver.md +60 -60
  451. package/bmad/cis/agents/design-thinking-coach.md +60 -60
  452. package/bmad/cis/agents/innovation-strategist.md +60 -60
  453. package/bmad/cis/agents/presentation-master.md +66 -66
  454. package/bmad/cis/agents/storyteller/storyteller.md +57 -57
  455. package/bmad/cis/config.yaml +11 -11
  456. package/bmad/cis/teams/creative-squad.yaml +7 -7
  457. package/bmad/cis/teams/default-party.csv +12 -12
  458. package/bmad/cis/workflows/README.md +139 -139
  459. package/bmad/cis/workflows/design-thinking/README.md +56 -56
  460. package/bmad/cis/workflows/design-thinking/design-methods.csv +30 -30
  461. package/bmad/cis/workflows/design-thinking/instructions.md +202 -202
  462. package/bmad/cis/workflows/design-thinking/template.md +111 -111
  463. package/bmad/cis/workflows/design-thinking/workflow.yaml +27 -27
  464. package/bmad/cis/workflows/innovation-strategy/README.md +56 -56
  465. package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +30 -30
  466. package/bmad/cis/workflows/innovation-strategy/instructions.md +276 -276
  467. package/bmad/cis/workflows/innovation-strategy/template.md +189 -189
  468. package/bmad/cis/workflows/innovation-strategy/workflow.yaml +27 -27
  469. package/bmad/cis/workflows/problem-solving/README.md +56 -56
  470. package/bmad/cis/workflows/problem-solving/instructions.md +252 -252
  471. package/bmad/cis/workflows/problem-solving/solving-methods.csv +30 -30
  472. package/bmad/cis/workflows/problem-solving/template.md +165 -165
  473. package/bmad/cis/workflows/problem-solving/workflow.yaml +27 -27
  474. package/bmad/cis/workflows/storytelling/README.md +58 -58
  475. package/bmad/cis/workflows/storytelling/instructions.md +293 -293
  476. package/bmad/cis/workflows/storytelling/story-types.csv +25 -25
  477. package/bmad/cis/workflows/storytelling/template.md +113 -113
  478. package/bmad/cis/workflows/storytelling/workflow.yaml +27 -27
  479. package/bmad/core/agents/bmad-master.md +57 -57
  480. package/bmad/core/config.yaml +9 -9
  481. package/bmad/core/resources/excalidraw/README.md +160 -160
  482. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -127
  483. package/bmad/core/resources/excalidraw/library-loader.md +50 -50
  484. package/bmad/core/resources/excalidraw/validate-json-instructions.md +79 -79
  485. package/bmad/core/tasks/index-docs.xml +64 -64
  486. package/bmad/core/tasks/review-adversarial-general.xml +41 -41
  487. package/bmad/core/tasks/shard-doc.xml +108 -108
  488. package/bmad/core/tasks/validate-workflow.xml +88 -88
  489. package/bmad/core/tasks/workflow.xml +234 -234
  490. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  491. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  492. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  493. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  494. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  495. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  496. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  497. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  498. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  499. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +340 -340
  500. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  501. package/bmad/core/workflows/brainstorming/template.md +15 -15
  502. package/bmad/core/workflows/brainstorming/workflow.md +51 -51
  503. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +139 -139
  504. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +204 -204
  505. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +159 -159
  506. package/bmad/core/workflows/party-mode/workflow.md +206 -206
  507. package/claude/hooks/file-restriction-hook.py +51 -51
  508. package/claude/hooks/track-agent.py +67 -67
  509. package/claude/settings.local.json +76 -76
  510. package/gemini/commands/BMad/agents/analyst.toml +6 -0
  511. package/gemini/commands/BMad/agents/architect.toml +6 -0
  512. package/gemini/commands/BMad/agents/bmad-master.toml +6 -0
  513. package/gemini/commands/BMad/agents/bmad-orchestrator.toml +6 -0
  514. package/gemini/commands/BMad/agents/dev.toml +6 -0
  515. package/gemini/commands/BMad/agents/pm.toml +6 -0
  516. package/gemini/commands/BMad/agents/po.toml +6 -0
  517. package/gemini/commands/BMad/agents/qa.toml +6 -0
  518. package/gemini/commands/BMad/agents/sm.toml +6 -0
  519. package/gemini/commands/BMad/agents/ux-expert.toml +6 -0
  520. package/gemini/commands/BMad/tasks/advanced-elicitation.toml +6 -0
  521. package/gemini/commands/BMad/tasks/apply-qa-fixes.toml +6 -0
  522. package/gemini/commands/BMad/tasks/brownfield-create-epic.toml +6 -0
  523. package/gemini/commands/BMad/tasks/brownfield-create-story.toml +6 -0
  524. package/gemini/commands/BMad/tasks/correct-course.toml +6 -0
  525. package/gemini/commands/BMad/tasks/create-brownfield-story.toml +6 -0
  526. package/gemini/commands/BMad/tasks/create-deep-research-prompt.toml +6 -0
  527. package/gemini/commands/BMad/tasks/create-doc.toml +6 -0
  528. package/gemini/commands/BMad/tasks/create-next-story.toml +6 -0
  529. package/gemini/commands/BMad/tasks/document-project.toml +6 -0
  530. package/gemini/commands/BMad/tasks/execute-checklist.toml +6 -0
  531. package/gemini/commands/BMad/tasks/facilitate-brainstorming-session.toml +6 -0
  532. package/gemini/commands/BMad/tasks/generate-ai-frontend-prompt.toml +6 -0
  533. package/gemini/commands/BMad/tasks/index-docs.toml +6 -0
  534. package/gemini/commands/BMad/tasks/kb-mode-interaction.toml +6 -0
  535. package/gemini/commands/BMad/tasks/nfr-assess.toml +6 -0
  536. package/gemini/commands/BMad/tasks/qa-gate.toml +6 -0
  537. package/gemini/commands/BMad/tasks/review-story.toml +6 -0
  538. package/gemini/commands/BMad/tasks/risk-profile.toml +6 -0
  539. package/gemini/commands/BMad/tasks/shard-doc.toml +6 -0
  540. package/gemini/commands/BMad/tasks/test-design.toml +6 -0
  541. package/gemini/commands/BMad/tasks/trace-requirements.toml +6 -0
  542. package/gemini/commands/BMad/tasks/validate-next-story.toml +6 -0
  543. package/github/workflows/publish.yml +150 -150
  544. package/index.js +9 -9
  545. package/mcp.json +14 -14
  546. package/package.json +41 -40
  547. package/resources/images/Siesa_Logosimbolo_Azul.svg +24 -24
  548. package/resources/images/Siesa_Logosimbolo_Blanco.svg +24 -24
  549. package/resources/images/Siesa_Simbolo_Azul.svg +14 -14
  550. package/resources/images/Siesa_Simbolo_Blanco.svg +14 -14
  551. package/vscode/mcp.json +15 -15
  552. package/vscode/settings.json +12 -12
@@ -1,1106 +1,1106 @@
1
- # Full Project Scan Instructions
2
-
3
- <workflow>
4
-
5
- <critical>This workflow performs complete project documentation (Steps 1-12)</critical>
6
- <critical>Called by: document-project/instructions.md router</critical>
7
- <critical>Handles: initial_scan and full_rescan modes</critical>
8
-
9
- <step n="0.5" goal="Load documentation requirements data for fresh starts (not needed for resume)" if="resume_mode == false">
10
- <critical>DATA LOADING STRATEGY - Understanding the Documentation Requirements System:</critical>
11
-
12
- <action>Display explanation to user:
13
-
14
- **How Project Type Detection Works:**
15
-
16
- This workflow uses a single comprehensive CSV file to intelligently document your project:
17
-
18
- **documentation-requirements.csv** ({documentation_requirements_csv})
19
-
20
- - Contains 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)
21
- - 24-column schema combining project type detection AND documentation requirements
22
- - **Detection columns**: project_type_id, key_file_patterns (used to identify project type from codebase)
23
- - **Requirement columns**: requires_api_scan, requires_data_models, requires_ui_components, etc.
24
- - **Pattern columns**: critical_directories, test_file_patterns, config_patterns, etc.
25
- - Acts as a "scan guide" - tells the workflow WHERE to look and WHAT to document
26
- - Example: For project_type_id="web", key_file_patterns includes "package.json;tsconfig.json;\*.config.js" and requires_api_scan=true
27
-
28
- **When Documentation Requirements are Loaded:**
29
-
30
- - **Fresh Start (initial_scan)**: Load all 12 rows → detect type using key_file_patterns → use that row's requirements
31
- - **Resume**: Load ONLY the doc requirements row(s) for cached project_type_id(s)
32
- - **Full Rescan**: Same as fresh start (may re-detect project type)
33
- - **Deep Dive**: Load ONLY doc requirements for the part being deep-dived
34
- </action>
35
-
36
- <action>Now loading documentation requirements data for fresh start...</action>
37
-
38
- <action>Load documentation-requirements.csv from: {documentation_requirements_csv}</action>
39
- <action>Store all 12 rows indexed by project_type_id for project detection and requirements lookup</action>
40
- <action>Display: "Loaded documentation requirements for 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)"</action>
41
-
42
- <action>Display: "✓ Documentation requirements loaded successfully. Ready to begin project analysis."</action>
43
- </step>
44
-
45
- <step n="0.6" goal="Check for existing documentation and determine workflow mode">
46
- <action>Check if {output_folder}/index.md exists</action>
47
-
48
- <check if="index.md exists">
49
- <action>Read existing index.md to extract metadata (date, project structure, parts count)</action>
50
- <action>Store as {{existing_doc_date}}, {{existing_structure}}</action>
51
-
52
- <ask>I found existing documentation generated on {{existing_doc_date}}.
53
-
54
- What would you like to do?
55
-
56
- 1. **Re-scan entire project** - Update all documentation with latest changes
57
- 2. **Deep-dive into specific area** - Generate detailed documentation for a particular feature/module/folder
58
- 3. **Cancel** - Keep existing documentation as-is
59
-
60
- Your choice [1/2/3]:
61
- </ask>
62
-
63
- <check if="user selects 1">
64
- <action>Set workflow_mode = "full_rescan"</action>
65
- <action>Continue to scan level selection below</action>
66
- </check>
67
-
68
- <check if="user selects 2">
69
- <action>Set workflow_mode = "deep_dive"</action>
70
- <action>Set scan_level = "exhaustive"</action>
71
- <action>Initialize state file with mode=deep_dive, scan_level=exhaustive</action>
72
- <action>Jump to Step 13</action>
73
- </check>
74
-
75
- <check if="user selects 3">
76
- <action>Display message: "Keeping existing documentation. Exiting workflow."</action>
77
- <action>Exit workflow</action>
78
- </check>
79
- </check>
80
-
81
- <check if="index.md does not exist">
82
- <action>Set workflow_mode = "initial_scan"</action>
83
- <action>Continue to scan level selection below</action>
84
- </check>
85
-
86
- <action if="workflow_mode != deep_dive">Select Scan Level</action>
87
-
88
- <check if="workflow_mode == initial_scan OR workflow_mode == full_rescan">
89
- <ask>Choose your scan depth level:
90
-
91
- **1. Quick Scan** (2-5 minutes) [DEFAULT]
92
-
93
- - Pattern-based analysis without reading source files
94
- - Scans: Config files, package manifests, directory structure
95
- - Best for: Quick project overview, initial understanding
96
- - File reading: Minimal (configs, README, package.json, etc.)
97
-
98
- **2. Deep Scan** (10-30 minutes)
99
-
100
- - Reads files in critical directories based on project type
101
- - Scans: All critical paths from documentation requirements
102
- - Best for: Comprehensive documentation for brownfield PRD
103
- - File reading: Selective (key files in critical directories)
104
-
105
- **3. Exhaustive Scan** (30-120 minutes)
106
-
107
- - Reads ALL source files in project
108
- - Scans: Every source file (excludes node_modules, dist, build)
109
- - Best for: Complete analysis, migration planning, detailed audit
110
- - File reading: Complete (all source files)
111
-
112
- Your choice [1/2/3] (default: 1):
113
- </ask>
114
-
115
- <action if="user selects 1 OR user presses enter">
116
- <action>Set scan_level = "quick"</action>
117
- <action>Display: "Using Quick Scan (pattern-based, no source file reading)"</action>
118
- </action>
119
-
120
- <action if="user selects 2">
121
- <action>Set scan_level = "deep"</action>
122
- <action>Display: "Using Deep Scan (reading critical files per project type)"</action>
123
- </action>
124
-
125
- <action if="user selects 3">
126
- <action>Set scan_level = "exhaustive"</action>
127
- <action>Display: "Using Exhaustive Scan (reading all source files)"</action>
128
- </action>
129
-
130
- <action>Initialize state file: {output_folder}/project-scan-report.json</action>
131
- <critical>Every time you touch the state file, record: step id, human-readable summary (what you actually did), precise timestamp, and any outputs written. Vague phrases are unacceptable.</critical>
132
- <action>Write initial state:
133
- {
134
- "workflow_version": "1.2.0",
135
- "timestamps": {"started": "{{current_timestamp}}", "last_updated": "{{current_timestamp}}"},
136
- "mode": "{{workflow_mode}}",
137
- "scan_level": "{{scan_level}}",
138
- "project_root": "{{project_root_path}}",
139
- "output_folder": "{{output_folder}}",
140
- "completed_steps": [],
141
- "current_step": "step_1",
142
- "findings": {},
143
- "outputs_generated": ["project-scan-report.json"],
144
- "resume_instructions": "Starting from step 1"
145
- }
146
- </action>
147
- <action>Continue with standard workflow from Step 1</action>
148
- </check>
149
- </step>
150
-
151
- <step n="1" goal="Detect project structure and classify project type" if="workflow_mode != deep_dive">
152
- <action>Ask user: "What is the root directory of the project to document?" (default: current working directory)</action>
153
- <action>Store as {{project_root_path}}</action>
154
-
155
- <action>Scan {{project_root_path}} for key indicators:
156
-
157
- - Directory structure (presence of client/, server/, api/, src/, app/, etc.)
158
- - Key files (package.json, go.mod, requirements.txt, etc.)
159
- - Technology markers matching detection_keywords from project-types.csv
160
- </action>
161
-
162
- <action>Detect if project is:
163
-
164
- - **Monolith**: Single cohesive codebase
165
- - **Monorepo**: Multiple parts in one repository
166
- - **Multi-part**: Separate client/server or similar architecture
167
- </action>
168
-
169
- <check if="multiple distinct parts detected (e.g., client/ and server/ folders)">
170
- <action>List detected parts with their paths</action>
171
- <ask>I detected multiple parts in this project:
172
- {{detected_parts_list}}
173
-
174
- Is this correct? Should I document each part separately? [y/n]
175
- </ask>
176
-
177
- <action if="user confirms">Set repository_type = "monorepo" or "multi-part"</action>
178
- <action if="user confirms">For each detected part: - Identify root path - Run project type detection using key_file_patterns from documentation-requirements.csv - Store as part in project_parts array
179
- </action>
180
-
181
- <action if="user denies or corrects">Ask user to specify correct parts and their paths</action>
182
- </check>
183
-
184
- <check if="single cohesive project detected">
185
- <action>Set repository_type = "monolith"</action>
186
- <action>Create single part in project_parts array with root_path = {{project_root_path}}</action>
187
- <action>Run project type detection using key_file_patterns from documentation-requirements.csv</action>
188
- </check>
189
-
190
- <action>For each part, match detected technologies and file patterns against key_file_patterns column in documentation-requirements.csv</action>
191
- <action>Assign project_type_id to each part</action>
192
- <action>Load corresponding documentation_requirements row for each part</action>
193
-
194
- <ask>I've classified this project:
195
- {{project_classification_summary}}
196
-
197
- Does this look correct? [y/n/edit]
198
- </ask>
199
-
200
- <template-output>project_structure</template-output>
201
- <template-output>project_parts_metadata</template-output>
202
-
203
- <action>IMMEDIATELY update state file with step completion:
204
-
205
- - Add to completed_steps: {"step": "step_1", "status": "completed", "timestamp": "{{now}}", "summary": "Classified as {{repository_type}} with {{parts_count}} parts"}
206
- - Update current_step = "step_2"
207
- - Update findings.project_classification with high-level summary only
208
- - **CACHE project_type_id(s)**: Add project_types array: [{"part_id": "{{part_id}}", "project_type_id": "{{project_type_id}}", "display_name": "{{display_name}}"}]
209
- - This cached data prevents reloading all CSV files on resume - we can load just the needed documentation_requirements row(s)
210
- - Update last_updated timestamp
211
- - Write state file
212
- </action>
213
-
214
- <action>PURGE detailed scan results from memory, keep only summary: "{{repository_type}}, {{parts_count}} parts, {{primary_tech}}"</action>
215
- </step>
216
-
217
- <step n="2" goal="Discover existing documentation and gather user context" if="workflow_mode != deep_dive">
218
- <action>For each part, scan for existing documentation using patterns:
219
- - README.md, README.rst, README.txt
220
- - CONTRIBUTING.md, CONTRIBUTING.rst
221
- - ARCHITECTURE.md, ARCHITECTURE.txt, docs/architecture/
222
- - DEPLOYMENT.md, DEPLOY.md, docs/deployment/
223
- - API.md, docs/api/
224
- - Any files in docs/, documentation/, .github/ folders
225
- </action>
226
-
227
- <action>Create inventory of existing_docs with:
228
-
229
- - File path
230
- - File type (readme, architecture, api, etc.)
231
- - Which part it belongs to (if multi-part)
232
- </action>
233
-
234
- <ask>I found these existing documentation files:
235
- {{existing_docs_list}}
236
-
237
- Are there any other important documents or key areas I should focus on while analyzing this project? [Provide paths or guidance, or type 'none']
238
- </ask>
239
-
240
- <action>Store user guidance as {{user_context}}</action>
241
-
242
- <template-output>existing_documentation_inventory</template-output>
243
- <template-output>user_provided_context</template-output>
244
-
245
- <action>Update state file:
246
-
247
- - Add to completed_steps: {"step": "step_2", "status": "completed", "timestamp": "{{now}}", "summary": "Found {{existing_docs_count}} existing docs"}
248
- - Update current_step = "step_3"
249
- - Update last_updated timestamp
250
- </action>
251
-
252
- <action>PURGE detailed doc contents from memory, keep only: "{{existing_docs_count}} docs found"</action>
253
- </step>
254
-
255
- <step n="3" goal="Analyze technology stack for each part" if="workflow_mode != deep_dive">
256
- <action>For each part in project_parts:
257
- - Load key_file_patterns from documentation_requirements
258
- - Scan part root for these patterns
259
- - Parse technology manifest files (package.json, go.mod, requirements.txt, etc.)
260
- - Extract: framework, language, version, database, dependencies
261
- - Build technology_table with columns: Category, Technology, Version, Justification
262
- </action>
263
-
264
- <action>Determine architecture pattern based on detected tech stack:
265
-
266
- - Use project_type_id as primary indicator (e.g., "web" → layered/component-based, "backend" → service/API-centric)
267
- - Consider framework patterns (e.g., React → component hierarchy, Express → middleware pipeline)
268
- - Note architectural style in technology table
269
- - Store as {{architecture_pattern}} for each part
270
- </action>
271
-
272
- <template-output>technology_stack</template-output>
273
- <template-output>architecture_patterns</template-output>
274
-
275
- <action>Update state file:
276
-
277
- - Add to completed_steps: {"step": "step_3", "status": "completed", "timestamp": "{{now}}", "summary": "Tech stack: {{primary_framework}}"}
278
- - Update current_step = "step_4"
279
- - Update findings.technology_stack with summary per part
280
- - Update last_updated timestamp
281
- </action>
282
-
283
- <action>PURGE detailed tech analysis from memory, keep only: "{{framework}} on {{language}}"</action>
284
- </step>
285
-
286
- <step n="4" goal="Perform conditional analysis based on project type requirements" if="workflow_mode != deep_dive">
287
-
288
- <critical>BATCHING STRATEGY FOR DEEP/EXHAUSTIVE SCANS</critical>
289
-
290
- <check if="scan_level == deep OR scan_level == exhaustive">
291
- <action>This step requires file reading. Apply batching strategy:</action>
292
-
293
- <action>Identify subfolders to process based on: - scan_level == "deep": Use critical_directories from documentation_requirements - scan_level == "exhaustive": Get ALL subfolders recursively (excluding node_modules, .git, dist, build, coverage)
294
- </action>
295
-
296
- <action>For each subfolder to scan: 1. Read all files in subfolder (consider file size - use judgment for files >5000 LOC) 2. Extract required information based on conditional flags below 3. IMMEDIATELY write findings to appropriate output file 4. Validate written document (section-level validation) 5. Update state file with batch completion 6. PURGE detailed findings from context, keep only 1-2 sentence summary 7. Move to next subfolder
297
- </action>
298
-
299
- <action>Track batches in state file:
300
- findings.batches_completed: [
301
- {"path": "{{subfolder_path}}", "files_scanned": {{count}}, "summary": "{{brief_summary}}"}
302
- ]
303
- </action>
304
- </check>
305
-
306
- <check if="scan_level == quick">
307
- <action>Use pattern matching only - do NOT read source files</action>
308
- <action>Use glob/grep to identify file locations and patterns</action>
309
- <action>Extract information from filenames, directory structure, and config files only</action>
310
- </check>
311
-
312
- <action>For each part, check documentation_requirements boolean flags and execute corresponding scans:</action>
313
-
314
- <check if="requires_api_scan == true">
315
- <action>Scan for API routes and endpoints using integration_scan_patterns</action>
316
- <action>Look for: controllers/, routes/, api/, handlers/, endpoints/</action>
317
-
318
- <check if="scan_level == quick">
319
- <action>Use glob to find route files, extract patterns from filenames and folder structure</action>
320
- </check>
321
-
322
- <check if="scan_level == deep OR scan_level == exhaustive">
323
- <action>Read files in batches (one subfolder at a time)</action>
324
- <action>Extract: HTTP methods, paths, request/response types from actual code</action>
325
- </check>
326
-
327
- <action>Build API contracts catalog</action>
328
- <action>IMMEDIATELY write to: {output_folder}/api-contracts-{part_id}.md</action>
329
- <action>Validate document has all required sections</action>
330
- <action>Update state file with output generated</action>
331
- <action>PURGE detailed API data, keep only: "{{api_count}} endpoints documented"</action>
332
- <template-output>api_contracts\*{part_id}</template-output>
333
- </check>
334
-
335
- <check if="requires_data_models == true">
336
- <action>Scan for data models using schema_migration_patterns</action>
337
- <action>Look for: models/, schemas/, entities/, migrations/, prisma/, ORM configs</action>
338
-
339
- <check if="scan_level == quick">
340
- <action>Identify schema files via glob, parse migration file names for table discovery</action>
341
- </check>
342
-
343
- <check if="scan_level == deep OR scan_level == exhaustive">
344
- <action>Read model files in batches (one subfolder at a time)</action>
345
- <action>Extract: table names, fields, relationships, constraints from actual code</action>
346
- </check>
347
-
348
- <action>Build database schema documentation</action>
349
- <action>IMMEDIATELY write to: {output_folder}/data-models-{part_id}.md</action>
350
- <action>Validate document completeness</action>
351
- <action>Update state file with output generated</action>
352
- <action>PURGE detailed schema data, keep only: "{{table_count}} tables documented"</action>
353
- <template-output>data_models\*{part_id}</template-output>
354
- </check>
355
-
356
- <check if="requires_state_management == true">
357
- <action>Analyze state management patterns</action>
358
- <action>Look for: Redux, Context API, MobX, Vuex, Pinia, Provider patterns</action>
359
- <action>Identify: stores, reducers, actions, state structure</action>
360
- <template-output>state_management_patterns_{part_id}</template-output>
361
- </check>
362
-
363
- <check if="requires_ui_components == true">
364
- <action>Inventory UI component library</action>
365
- <action>Scan: components/, ui/, widgets/, views/ folders</action>
366
- <action>Categorize: Layout, Form, Display, Navigation, etc.</action>
367
- <action>Identify: Design system, component patterns, reusable elements</action>
368
- <template-output>ui_component_inventory_{part_id}</template-output>
369
- </check>
370
-
371
- <check if="requires_hardware_docs == true">
372
- <action>Look for hardware schematics using hardware_interface_patterns</action>
373
- <ask>This appears to be an embedded/hardware project. Do you have:
374
- - Pinout diagrams
375
- - Hardware schematics
376
- - PCB layouts
377
- - Hardware documentation
378
-
379
- If yes, please provide paths or links. [Provide paths or type 'none']
380
- </ask>
381
- <action>Store hardware docs references</action>
382
- <template-output>hardware*documentation*{part_id}</template-output>
383
- </check>
384
-
385
- <check if="requires_asset_inventory == true">
386
- <action>Scan and catalog assets using asset_patterns</action>
387
- <action>Categorize by: Images, Audio, 3D Models, Sprites, Textures, etc.</action>
388
- <action>Calculate: Total size, file counts, formats used</action>
389
- <template-output>asset_inventory_{part_id}</template-output>
390
- </check>
391
-
392
- <action>Scan for additional patterns based on doc requirements:
393
-
394
- - config_patterns → Configuration management
395
- - auth_security_patterns → Authentication/authorization approach
396
- - entry_point_patterns → Application entry points and bootstrap
397
- - shared_code_patterns → Shared libraries and utilities
398
- - async_event_patterns → Event-driven architecture
399
- - ci_cd_patterns → CI/CD pipeline details
400
- - localization_patterns → i18n/l10n support
401
- </action>
402
-
403
- <action>Apply scan_level strategy to each pattern scan (quick=glob only, deep/exhaustive=read files)</action>
404
-
405
- <template-output>comprehensive*analysis*{part_id}</template-output>
406
-
407
- <action>Update state file:
408
-
409
- - Add to completed_steps: {"step": "step_4", "status": "completed", "timestamp": "{{now}}", "summary": "Conditional analysis complete, {{files_generated}} files written"}
410
- - Update current_step = "step_5"
411
- - Update last_updated timestamp
412
- - List all outputs_generated
413
- </action>
414
-
415
- <action>PURGE all detailed scan results from context. Keep only summaries:
416
-
417
- - "APIs: {{api_count}} endpoints"
418
- - "Data: {{table_count}} tables"
419
- - "Components: {{component_count}} components"
420
- </action>
421
- </step>
422
-
423
- <step n="5" goal="Generate source tree analysis with annotations" if="workflow_mode != deep_dive">
424
- <action>For each part, generate complete directory tree using critical_directories from doc requirements</action>
425
-
426
- <action>Annotate the tree with:
427
-
428
- - Purpose of each critical directory
429
- - Entry points marked
430
- - Key file locations highlighted
431
- - Integration points noted (for multi-part projects)
432
- </action>
433
-
434
- <action if="multi-part project">Show how parts are organized and where they interface</action>
435
-
436
- <action>Create formatted source tree with descriptions:
437
-
438
- ```
439
- project-root/
440
- ├── client/ # React frontend (Part: client)
441
- │ ├── src/
442
- │ │ ├── components/ # Reusable UI components
443
- │ │ ├── pages/ # Route-based pages
444
- │ │ └── api/ # API client layer → Calls server/
445
- ├── server/ # Express API backend (Part: api)
446
- │ ├── src/
447
- │ │ ├── routes/ # REST API endpoints
448
- │ │ ├── models/ # Database models
449
- │ │ └── services/ # Business logic
450
- ```
451
-
452
- </action>
453
-
454
- <template-output>source_tree_analysis</template-output>
455
- <template-output>critical_folders_summary</template-output>
456
-
457
- <action>IMMEDIATELY write source-tree-analysis.md to disk</action>
458
- <action>Validate document structure</action>
459
- <action>Update state file:
460
-
461
- - Add to completed_steps: {"step": "step_5", "status": "completed", "timestamp": "{{now}}", "summary": "Source tree documented"}
462
- - Update current_step = "step_6"
463
- - Add output: "source-tree-analysis.md"
464
- </action>
465
- <action>PURGE detailed tree from context, keep only: "Source tree with {{folder_count}} critical folders"</action>
466
- </step>
467
-
468
- <step n="6" goal="Extract development and operational information" if="workflow_mode != deep_dive">
469
- <action>Scan for development setup using key_file_patterns and existing docs:
470
- - Prerequisites (Node version, Python version, etc.)
471
- - Installation steps (npm install, etc.)
472
- - Environment setup (.env files, config)
473
- - Build commands (npm run build, make, etc.)
474
- - Run commands (npm start, go run, etc.)
475
- - Test commands using test_file_patterns
476
- </action>
477
-
478
- <action>Look for deployment configuration using ci_cd_patterns:
479
-
480
- - Dockerfile, docker-compose.yml
481
- - Kubernetes configs (k8s/, helm/)
482
- - CI/CD pipelines (.github/workflows/, .gitlab-ci.yml)
483
- - Deployment scripts
484
- - Infrastructure as Code (terraform/, pulumi/)
485
- </action>
486
-
487
- <action if="CONTRIBUTING.md or similar found">
488
- <action>Extract contribution guidelines:
489
- - Code style rules
490
- - PR process
491
- - Commit conventions
492
- - Testing requirements
493
- </action>
494
- </action>
495
-
496
- <template-output>development_instructions</template-output>
497
- <template-output>deployment_configuration</template-output>
498
- <template-output>contribution_guidelines</template-output>
499
-
500
- <action>Update state file:
501
-
502
- - Add to completed_steps: {"step": "step_6", "status": "completed", "timestamp": "{{now}}", "summary": "Dev/deployment guides written"}
503
- - Update current_step = "step_7"
504
- - Add generated outputs to list
505
- </action>
506
- <action>PURGE detailed instructions, keep only: "Dev setup and deployment documented"</action>
507
- </step>
508
-
509
- <step n="7" goal="Detect multi-part integration architecture" if="workflow_mode != deep_dive and project has multiple parts">
510
- <action>Analyze how parts communicate:
511
- - Scan integration_scan_patterns across parts
512
- - Identify: REST calls, GraphQL queries, gRPC, message queues, shared databases
513
- - Document: API contracts between parts, data flow, authentication flow
514
- </action>
515
-
516
- <action>Create integration_points array with:
517
-
518
- - from: source part
519
- - to: target part
520
- - type: REST API, GraphQL, gRPC, Event Bus, etc.
521
- - details: Endpoints, protocols, data formats
522
- </action>
523
-
524
- <action>IMMEDIATELY write integration-architecture.md to disk</action>
525
- <action>Validate document completeness</action>
526
-
527
- <template-output>integration_architecture</template-output>
528
-
529
- <action>Update state file:
530
-
531
- - Add to completed_steps: {"step": "step_7", "status": "completed", "timestamp": "{{now}}", "summary": "Integration architecture documented"}
532
- - Update current_step = "step_8"
533
- </action>
534
- <action>PURGE integration details, keep only: "{{integration_count}} integration points"</action>
535
- </step>
536
-
537
- <step n="8" goal="Generate architecture documentation for each part" if="workflow_mode != deep_dive">
538
- <action>For each part in project_parts:
539
- - Use matched architecture template from Step 3 as base structure
540
- - Fill in all sections with discovered information:
541
- * Executive Summary
542
- * Technology Stack (from Step 3)
543
- * Architecture Pattern (from registry match)
544
- * Data Architecture (from Step 4 data models scan)
545
- * API Design (from Step 4 API scan if applicable)
546
- * Component Overview (from Step 4 component scan if applicable)
547
- * Source Tree (from Step 5)
548
- * Development Workflow (from Step 6)
549
- * Deployment Architecture (from Step 6)
550
- * Testing Strategy (from test patterns)
551
- </action>
552
-
553
- <action if="single part project">
554
- - Generate: architecture.md (no part suffix)
555
- </action>
556
-
557
- <action if="multi-part project">
558
- - Generate: architecture-{part_id}.md for each part
559
- </action>
560
-
561
- <action>For each architecture file generated:
562
-
563
- - IMMEDIATELY write architecture file to disk
564
- - Validate against architecture template schema
565
- - Update state file with output
566
- - PURGE detailed architecture from context, keep only: "Architecture for {{part_id}} written"
567
- </action>
568
-
569
- <template-output>architecture_document</template-output>
570
-
571
- <action>Update state file:
572
-
573
- - Add to completed_steps: {"step": "step_8", "status": "completed", "timestamp": "{{now}}", "summary": "Architecture docs written for {{parts_count}} parts"}
574
- - Update current_step = "step_9"
575
- </action>
576
- </step>
577
-
578
- <step n="9" goal="Generate supporting documentation files" if="workflow_mode != deep_dive">
579
- <action>Generate project-overview.md with:
580
- - Project name and purpose (from README or user input)
581
- - Executive summary
582
- - Tech stack summary table
583
- - Architecture type classification
584
- - Repository structure (monolith/monorepo/multi-part)
585
- - Links to detailed docs
586
- </action>
587
-
588
- <action>Generate source-tree-analysis.md with:
589
-
590
- - Full annotated directory tree from Step 5
591
- - Critical folders explained
592
- - Entry points documented
593
- - Multi-part structure (if applicable)
594
- </action>
595
-
596
- <action>IMMEDIATELY write project-overview.md to disk</action>
597
- <action>Validate document sections</action>
598
-
599
- <action>Generate source-tree-analysis.md (if not already written in Step 5)</action>
600
- <action>IMMEDIATELY write to disk and validate</action>
601
-
602
- <action>Generate component-inventory.md (or per-part versions) with:
603
-
604
- - All discovered components from Step 4
605
- - Categorized by type
606
- - Reusable vs specific components
607
- - Design system elements (if found)
608
- </action>
609
- <action>IMMEDIATELY write each component inventory to disk and validate</action>
610
-
611
- <action>Generate development-guide.md (or per-part versions) with:
612
-
613
- - Prerequisites and dependencies
614
- - Environment setup instructions
615
- - Local development commands
616
- - Build process
617
- - Testing approach and commands
618
- - Common development tasks
619
- </action>
620
- <action>IMMEDIATELY write each development guide to disk and validate</action>
621
-
622
- <action if="deployment configuration found">
623
- <action>Generate deployment-guide.md with:
624
- - Infrastructure requirements
625
- - Deployment process
626
- - Environment configuration
627
- - CI/CD pipeline details
628
- </action>
629
- <action>IMMEDIATELY write to disk and validate</action>
630
- </action>
631
-
632
- <action if="contribution guidelines found">
633
- <action>Generate contribution-guide.md with:
634
- - Code style and conventions
635
- - PR process
636
- - Testing requirements
637
- - Documentation standards
638
- </action>
639
- <action>IMMEDIATELY write to disk and validate</action>
640
- </action>
641
-
642
- <action if="API contracts documented">
643
- <action>Generate api-contracts.md (or per-part) with:
644
- - All API endpoints
645
- - Request/response schemas
646
- - Authentication requirements
647
- - Example requests
648
- </action>
649
- <action>IMMEDIATELY write to disk and validate</action>
650
- </action>
651
-
652
- <action if="Data models documented">
653
- <action>Generate data-models.md (or per-part) with:
654
- - Database schema
655
- - Table relationships
656
- - Data models and entities
657
- - Migration strategy
658
- </action>
659
- <action>IMMEDIATELY write to disk and validate</action>
660
- </action>
661
-
662
- <action if="multi-part project">
663
- <action>Generate integration-architecture.md with:
664
- - How parts communicate
665
- - Integration points diagram/description
666
- - Data flow between parts
667
- - Shared dependencies
668
- </action>
669
- <action>IMMEDIATELY write to disk and validate</action>
670
-
671
- <action>Generate project-parts.json metadata file:
672
- `json
673
- {
674
- "repository_type": "monorepo",
675
- "parts": [ ... ],
676
- "integration_points": [ ... ]
677
- }
678
- `
679
- </action>
680
- <action>IMMEDIATELY write to disk</action>
681
- </action>
682
-
683
- <template-output>supporting_documentation</template-output>
684
-
685
- <action>Update state file:
686
-
687
- - Add to completed_steps: {"step": "step_9", "status": "completed", "timestamp": "{{now}}", "summary": "All supporting docs written"}
688
- - Update current_step = "step_10"
689
- - List all newly generated outputs
690
- </action>
691
-
692
- <action>PURGE all document contents from context, keep only list of files generated</action>
693
- </step>
694
-
695
- <step n="10" goal="Generate master index as primary AI retrieval source" if="workflow_mode != deep_dive">
696
-
697
- <critical>INCOMPLETE DOCUMENTATION MARKER CONVENTION:
698
- When a document SHOULD be generated but wasn't (due to quick scan, missing data, conditional requirements not met):
699
-
700
- - Use EXACTLY this marker: _(To be generated)_
701
- - Place it at the end of the markdown link line
702
- - Example: - [API Contracts - Server](./api-contracts-server.md) _(To be generated)_
703
- - This allows Step 11 to detect and offer to complete these items
704
- - ALWAYS use this exact format for consistency and automated detection
705
- </critical>
706
-
707
- <action>Create index.md with intelligent navigation based on project structure</action>
708
-
709
- <action if="single part project">
710
- <action>Generate simple index with:
711
- - Project name and type
712
- - Quick reference (tech stack, architecture type)
713
- - Links to all generated docs
714
- - Links to discovered existing docs
715
- - Getting started section
716
- </action>
717
- </action>
718
-
719
- <action if="multi-part project">
720
- <action>Generate comprehensive index with:
721
- - Project overview and structure summary
722
- - Part-based navigation section
723
- - Quick reference by part
724
- - Cross-part integration links
725
- - Links to all generated and existing docs
726
- - Getting started per part
727
- </action>
728
- </action>
729
-
730
- <action>Include in index.md:
731
-
732
- ## Project Documentation Index
733
-
734
- ### Project Overview
735
-
736
- - **Type:** {{repository_type}} {{#if multi-part}}with {{parts.length}} parts{{/if}}
737
- - **Primary Language:** {{primary_language}}
738
- - **Architecture:** {{architecture_type}}
739
-
740
- ### Quick Reference
741
-
742
- {{#if single_part}}
743
-
744
- - **Tech Stack:** {{tech_stack_summary}}
745
- - **Entry Point:** {{entry_point}}
746
- - **Architecture Pattern:** {{architecture_pattern}}
747
- {{else}}
748
- {{#each parts}}
749
-
750
- #### {{part_name}} ({{part_id}})
751
-
752
- - **Type:** {{project_type}}
753
- - **Tech Stack:** {{tech_stack}}
754
- - **Root:** {{root_path}}
755
- {{/each}}
756
- {{/if}}
757
-
758
- ### Generated Documentation
759
-
760
- - [Project Overview](./project-overview.md)
761
- - [Architecture](./architecture{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless architecture_file_exists}} (To be generated) {{/unless}}
762
- - [Source Tree Analysis](./source-tree-analysis.md)
763
- - [Component Inventory](./component-inventory{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless component_inventory_exists}} (To be generated) {{/unless}}
764
- - [Development Guide](./development-guide{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless dev_guide_exists}} (To be generated) {{/unless}}
765
- {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} (To be generated) {{/unless}}{{/if}}
766
- {{#if contribution_found}}- [Contribution Guide](./contribution-guide.md){{/if}}
767
- {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} (To be generated) {{/unless}}{{/if}}
768
- {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} (To be generated) {{/unless}}{{/if}}
769
- {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} (To be generated) {{/unless}}{{/if}}
770
-
771
- ### Existing Documentation
772
-
773
- {{#each existing_docs}}
774
-
775
- - [{{title}}]({{relative_path}}) - {{description}}
776
- {{/each}}
777
-
778
- ### Getting Started
779
-
780
- {{getting_started_instructions}}
781
- </action>
782
-
783
- <action>Before writing index.md, check which expected files actually exist:
784
-
785
- - For each document that should have been generated, check if file exists on disk
786
- - Set existence flags: architecture_file_exists, component_inventory_exists, dev_guide_exists, etc.
787
- - These flags determine whether to add the _(To be generated)_ marker
788
- - Track which files are missing in {{missing_docs_list}} for reporting
789
- </action>
790
-
791
- <action>IMMEDIATELY write index.md to disk with appropriate _(To be generated)_ markers for missing files</action>
792
- <action>Validate index has all required sections and links are valid</action>
793
-
794
- <template-output>index</template-output>
795
-
796
- <action>Update state file:
797
-
798
- - Add to completed_steps: {"step": "step_10", "status": "completed", "timestamp": "{{now}}", "summary": "Master index generated"}
799
- - Update current_step = "step_11"
800
- - Add output: "index.md"
801
- </action>
802
-
803
- <action>PURGE index content from context</action>
804
- </step>
805
-
806
- <step n="11" goal="Validate and review generated documentation" if="workflow_mode != deep_dive">
807
- <action>Show summary of all generated files:
808
- Generated in {{output_folder}}/:
809
- {{file_list_with_sizes}}
810
- </action>
811
-
812
- <action>Run validation checklist from {validation}</action>
813
-
814
- <critical>INCOMPLETE DOCUMENTATION DETECTION:
815
-
816
- 1. PRIMARY SCAN: Look for exact marker: _(To be generated)_
817
- 2. FALLBACK SCAN: Look for fuzzy patterns (in case agent was lazy):
818
- - _(TBD)_
819
- - _(TODO)_
820
- - _(Coming soon)_
821
- - _(Not yet generated)_
822
- - _(Pending)_
823
- 3. Extract document metadata from each match for user selection
824
- </critical>
825
-
826
- <action>Read {output_folder}/index.md</action>
827
-
828
- <action>Scan for incomplete documentation markers:
829
- Step 1: Search for exact pattern "_(To be generated)_" (case-sensitive)
830
- Step 2: For each match found, extract the entire line
831
- Step 3: Parse line to extract:
832
-
833
- - Document title (text within [brackets] or **bold**)
834
- - File path (from markdown link or inferable from title)
835
- - Document type (infer from filename: architecture, api-contracts, data-models, component-inventory, development-guide, deployment-guide, integration-architecture)
836
- - Part ID if applicable (extract from filename like "architecture-server.md" → part_id: "server")
837
- Step 4: Add to {{incomplete_docs_strict}} array
838
- </action>
839
-
840
- <action>Fallback fuzzy scan for alternate markers:
841
- Search for patterns: _(TBD)_, _(TODO)_, _(Coming soon)_, _(Not yet generated)_, _(Pending)_
842
- For each fuzzy match:
843
-
844
- - Extract same metadata as strict scan
845
- - Add to {{incomplete_docs_fuzzy}} array with fuzzy_match flag
846
- </action>
847
-
848
- <action>Combine results:
849
- Set {{incomplete_docs_list}} = {{incomplete_docs_strict}} + {{incomplete_docs_fuzzy}}
850
- For each item store structure:
851
- {
852
- "title": "Architecture – Server",
853
- "file\*path": "./architecture-server.md",
854
- "doc_type": "architecture",
855
- "part_id": "server",
856
- "line_text": "- [Architecture – Server](./architecture-server.md) (To be generated)",
857
- "fuzzy_match": false
858
- }
859
- </action>
860
-
861
- <ask>Documentation generation complete!
862
-
863
- Summary:
864
-
865
- - Project Type: {{project_type_summary}}
866
- - Parts Documented: {{parts_count}}
867
- - Files Generated: {{files_count}}
868
- - Total Lines: {{total_lines}}
869
-
870
- {{#if incomplete_docs_list.length > 0}}
871
- ⚠️ **Incomplete Documentation Detected:**
872
-
873
- I found {{incomplete_docs_list.length}} item(s) marked as incomplete:
874
-
875
- {{#each incomplete_docs_list}}
876
- {{@index + 1}}. **{{title}}** ({{doc_type}}{{#if part_id}} for {{part_id}}{{/if}}){{#if fuzzy_match}} ⚠️ [non-standard marker]{{/if}}
877
- {{/each}}
878
-
879
- {{/if}}
880
-
881
- Would you like to:
882
-
883
- {{#if incomplete_docs_list.length > 0}}
884
-
885
- 1. **Generate incomplete documentation** - Complete any of the {{incomplete_docs_list.length}} items above
886
- 2. Review any specific section [type section name]
887
- 3. Add more detail to any area [type area name]
888
- 4. Generate additional custom documentation [describe what]
889
- 5. Finalize and complete [type 'done']
890
- {{else}}
891
- 6. Review any specific section [type section name]
892
- 7. Add more detail to any area [type area name]
893
- 8. Generate additional documentation [describe what]
894
- 9. Finalize and complete [type 'done']
895
- {{/if}}
896
-
897
- Your choice:
898
- </ask>
899
-
900
- <check if="user selects option 1 (generate incomplete)">
901
- <ask>Which incomplete items would you like to generate?
902
-
903
- {{#each incomplete_docs_list}}
904
- {{@index + 1}}. {{title}} ({{doc_type}}{{#if part_id}} - {{part_id}}{{/if}})
905
- {{/each}}
906
- {{incomplete_docs_list.length + 1}}. All of them
907
-
908
- Enter number(s) separated by commas (e.g., "1,3,5"), or type 'all':
909
- </ask>
910
-
911
- <action>Parse user selection:
912
-
913
- - If "all", set {{selected_items}} = all items in {{incomplete_docs_list}}
914
- - If comma-separated numbers, extract selected items by index
915
- - Store result in {{selected_items}} array
916
- </action>
917
-
918
- <action>Display: "Generating {{selected_items.length}} document(s)..."</action>
919
-
920
- <action>For each item in {{selected_items}}:
921
-
922
- 1. **Identify the part and requirements:**
923
- - Extract part_id from item (if exists)
924
- - Look up part data in project_parts array from state file
925
- - Load documentation_requirements for that part's project_type_id
926
-
927
- 2. **Route to appropriate generation substep based on doc_type:**
928
-
929
- **If doc_type == "architecture":**
930
- - Display: "Generating architecture documentation for {{part_id}}..."
931
- - Load architecture_match for this part from state file (Step 3 cache)
932
- - Re-run Step 8 architecture generation logic ONLY for this specific part
933
- - Use matched template and fill with cached data from state file
934
- - Write architecture-{{part_id}}.md to disk
935
- - Validate completeness
936
-
937
- **If doc_type == "api-contracts":**
938
- - Display: "Generating API contracts for {{part_id}}..."
939
- - Load part data and documentation_requirements
940
- - Re-run Step 4 API scan substep targeting ONLY this part
941
- - Use scan_level from state file (quick/deep/exhaustive)
942
- - Generate api-contracts-{{part_id}}.md
943
- - Validate document structure
944
-
945
- **If doc_type == "data-models":**
946
- - Display: "Generating data models documentation for {{part_id}}..."
947
- - Re-run Step 4 data models scan substep targeting ONLY this part
948
- - Use schema_migration_patterns from documentation_requirements
949
- - Generate data-models-{{part_id}}.md
950
- - Validate completeness
951
-
952
- **If doc_type == "component-inventory":**
953
- - Display: "Generating component inventory for {{part_id}}..."
954
- - Re-run Step 9 component inventory generation for this specific part
955
- - Scan components/, ui/, widgets/ folders
956
- - Generate component-inventory-{{part_id}}.md
957
- - Validate structure
958
-
959
- **If doc_type == "development-guide":**
960
- - Display: "Generating development guide for {{part_id}}..."
961
- - Re-run Step 9 development guide generation for this specific part
962
- - Use key_file_patterns and test_file_patterns from documentation_requirements
963
- - Generate development-guide-{{part_id}}.md
964
- - Validate completeness
965
-
966
- **If doc_type == "deployment-guide":**
967
- - Display: "Generating deployment guide..."
968
- - Re-run Step 6 deployment configuration scan
969
- - Re-run Step 9 deployment guide generation
970
- - Generate deployment-guide.md
971
- - Validate structure
972
-
973
- **If doc_type == "integration-architecture":**
974
- - Display: "Generating integration architecture..."
975
- - Re-run Step 7 integration analysis for all parts
976
- - Generate integration-architecture.md
977
- - Validate completeness
978
-
979
- 3. **Post-generation actions:**
980
- - Confirm file was written successfully
981
- - Update state file with newly generated output
982
- - Add to {{newly_generated_docs}} tracking list
983
- - Display: "✓ Generated: {{file_path}}"
984
-
985
- 4. **Handle errors:**
986
- - If generation fails, log error and continue with next item
987
- - Track failed items in {{failed_generations}} list
988
- </action>
989
-
990
- <action>After all selected items are processed:
991
-
992
- **Update index.md to remove markers:**
993
-
994
- 1. Read current index.md content
995
- 2. For each item in {{newly_generated_docs}}:
996
- - Find the line containing the file link and marker
997
- - Remove the _(To be generated)_ or fuzzy marker text
998
- - Leave the markdown link intact
999
- 3. Write updated index.md back to disk
1000
- 4. Update state file to record index.md modification
1001
- </action>
1002
-
1003
- <action>Display generation summary:
1004
-
1005
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1006
-
1007
- ✓ **Documentation Generation Complete!**
1008
-
1009
- **Successfully Generated:**
1010
- {{#each newly_generated_docs}}
1011
-
1012
- - {{title}} → {{file_path}}
1013
- {{/each}}
1014
-
1015
- {{#if failed_generations.length > 0}}
1016
- **Failed to Generate:**
1017
- {{#each failed_generations}}
1018
-
1019
- - {{title}} ({{error_message}})
1020
- {{/each}}
1021
- {{/if}}
1022
-
1023
- **Updated:** index.md (removed incomplete markers)
1024
-
1025
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1026
- </action>
1027
-
1028
- <action>Update state file with all generation activities</action>
1029
-
1030
- <action>Return to Step 11 menu (loop back to check for any remaining incomplete items)</action>
1031
- </check>
1032
-
1033
- <action if="user requests other changes (options 2-3)">Make requested modifications and regenerate affected files</action>
1034
- <action if="user selects finalize (option 4 or 5)">Proceed to Step 12 completion</action>
1035
-
1036
- <check if="not finalizing">
1037
- <action>Update state file:
1038
- - Add to completed_steps: {"step": "step_11_iteration", "status": "completed", "timestamp": "{{now}}", "summary": "Review iteration complete"}
1039
- - Keep current_step = "step_11" (for loop back)
1040
- - Update last_updated timestamp
1041
- </action>
1042
- <action>Loop back to beginning of Step 11 (re-scan for remaining incomplete docs)</action>
1043
- </check>
1044
-
1045
- <check if="finalizing">
1046
- <action>Update state file:
1047
- - Add to completed_steps: {"step": "step_11", "status": "completed", "timestamp": "{{now}}", "summary": "Validation and review complete"}
1048
- - Update current_step = "step_12"
1049
- </action>
1050
- <action>Proceed to Step 12</action>
1051
- </check>
1052
- </step>
1053
-
1054
- <step n="12" goal="Finalize and provide next steps" if="workflow_mode != deep_dive">
1055
- <action>Create final summary report</action>
1056
- <action>Compile verification recap variables:
1057
- - Set {{verification_summary}} to the concrete tests, validations, or scripts you executed (or "none run").
1058
- - Set {{open_risks}} to any remaining risks or TODO follow-ups (or "none").
1059
- - Set {{next_checks}} to recommended actions before merging/deploying (or "none").
1060
- </action>
1061
-
1062
- <action>Display completion message:
1063
-
1064
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1065
-
1066
- ## Project Documentation Complete! ✓
1067
-
1068
- **Location:** {{output_folder}}/
1069
-
1070
- **Master Index:** {{output_folder}}/index.md
1071
- 👆 This is your primary entry point for AI-assisted development
1072
-
1073
- **Generated Documentation:**
1074
- {{generated_files_list}}
1075
-
1076
- **Next Steps:**
1077
-
1078
- 1. Review the index.md to familiarize yourself with the documentation structure
1079
- 2. When creating a brownfield PRD, point the PRD workflow to: {{output_folder}}/index.md
1080
- 3. For UI-only features: Reference {{output_folder}}/architecture-{{ui_part_id}}.md
1081
- 4. For API-only features: Reference {{output_folder}}/architecture-{{api_part_id}}.md
1082
- 5. For full-stack features: Reference both part architectures + integration-architecture.md
1083
-
1084
- **Verification Recap:**
1085
-
1086
- - Tests/extractions executed: {{verification_summary}}
1087
- - Outstanding risks or follow-ups: {{open_risks}}
1088
- - Recommended next checks before PR: {{next_checks}}
1089
-
1090
- **Brownfield PRD Command:**
1091
- When ready to plan new features, run the PRD workflow and provide this index as input.
1092
-
1093
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1094
- </action>
1095
-
1096
- <action>FINALIZE state file:
1097
-
1098
- - Add to completed_steps: {"step": "step_12", "status": "completed", "timestamp": "{{now}}", "summary": "Workflow complete"}
1099
- - Update timestamps.completed = "{{now}}"
1100
- - Update current_step = "completed"
1101
- - Write final state file
1102
- </action>
1103
-
1104
- <action>Display: "State file saved: {{output_folder}}/project-scan-report.json"</action>
1105
-
1106
- </workflow>
1
+ # Full Project Scan Instructions
2
+
3
+ <workflow>
4
+
5
+ <critical>This workflow performs complete project documentation (Steps 1-12)</critical>
6
+ <critical>Called by: document-project/instructions.md router</critical>
7
+ <critical>Handles: initial_scan and full_rescan modes</critical>
8
+
9
+ <step n="0.5" goal="Load documentation requirements data for fresh starts (not needed for resume)" if="resume_mode == false">
10
+ <critical>DATA LOADING STRATEGY - Understanding the Documentation Requirements System:</critical>
11
+
12
+ <action>Display explanation to user:
13
+
14
+ **How Project Type Detection Works:**
15
+
16
+ This workflow uses a single comprehensive CSV file to intelligently document your project:
17
+
18
+ **documentation-requirements.csv** ({documentation_requirements_csv})
19
+
20
+ - Contains 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)
21
+ - 24-column schema combining project type detection AND documentation requirements
22
+ - **Detection columns**: project_type_id, key_file_patterns (used to identify project type from codebase)
23
+ - **Requirement columns**: requires_api_scan, requires_data_models, requires_ui_components, etc.
24
+ - **Pattern columns**: critical_directories, test_file_patterns, config_patterns, etc.
25
+ - Acts as a "scan guide" - tells the workflow WHERE to look and WHAT to document
26
+ - Example: For project_type_id="web", key_file_patterns includes "package.json;tsconfig.json;\*.config.js" and requires_api_scan=true
27
+
28
+ **When Documentation Requirements are Loaded:**
29
+
30
+ - **Fresh Start (initial_scan)**: Load all 12 rows → detect type using key_file_patterns → use that row's requirements
31
+ - **Resume**: Load ONLY the doc requirements row(s) for cached project_type_id(s)
32
+ - **Full Rescan**: Same as fresh start (may re-detect project type)
33
+ - **Deep Dive**: Load ONLY doc requirements for the part being deep-dived
34
+ </action>
35
+
36
+ <action>Now loading documentation requirements data for fresh start...</action>
37
+
38
+ <action>Load documentation-requirements.csv from: {documentation_requirements_csv}</action>
39
+ <action>Store all 12 rows indexed by project_type_id for project detection and requirements lookup</action>
40
+ <action>Display: "Loaded documentation requirements for 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)"</action>
41
+
42
+ <action>Display: "✓ Documentation requirements loaded successfully. Ready to begin project analysis."</action>
43
+ </step>
44
+
45
+ <step n="0.6" goal="Check for existing documentation and determine workflow mode">
46
+ <action>Check if {output_folder}/index.md exists</action>
47
+
48
+ <check if="index.md exists">
49
+ <action>Read existing index.md to extract metadata (date, project structure, parts count)</action>
50
+ <action>Store as {{existing_doc_date}}, {{existing_structure}}</action>
51
+
52
+ <ask>I found existing documentation generated on {{existing_doc_date}}.
53
+
54
+ What would you like to do?
55
+
56
+ 1. **Re-scan entire project** - Update all documentation with latest changes
57
+ 2. **Deep-dive into specific area** - Generate detailed documentation for a particular feature/module/folder
58
+ 3. **Cancel** - Keep existing documentation as-is
59
+
60
+ Your choice [1/2/3]:
61
+ </ask>
62
+
63
+ <check if="user selects 1">
64
+ <action>Set workflow_mode = "full_rescan"</action>
65
+ <action>Continue to scan level selection below</action>
66
+ </check>
67
+
68
+ <check if="user selects 2">
69
+ <action>Set workflow_mode = "deep_dive"</action>
70
+ <action>Set scan_level = "exhaustive"</action>
71
+ <action>Initialize state file with mode=deep_dive, scan_level=exhaustive</action>
72
+ <action>Jump to Step 13</action>
73
+ </check>
74
+
75
+ <check if="user selects 3">
76
+ <action>Display message: "Keeping existing documentation. Exiting workflow."</action>
77
+ <action>Exit workflow</action>
78
+ </check>
79
+ </check>
80
+
81
+ <check if="index.md does not exist">
82
+ <action>Set workflow_mode = "initial_scan"</action>
83
+ <action>Continue to scan level selection below</action>
84
+ </check>
85
+
86
+ <action if="workflow_mode != deep_dive">Select Scan Level</action>
87
+
88
+ <check if="workflow_mode == initial_scan OR workflow_mode == full_rescan">
89
+ <ask>Choose your scan depth level:
90
+
91
+ **1. Quick Scan** (2-5 minutes) [DEFAULT]
92
+
93
+ - Pattern-based analysis without reading source files
94
+ - Scans: Config files, package manifests, directory structure
95
+ - Best for: Quick project overview, initial understanding
96
+ - File reading: Minimal (configs, README, package.json, etc.)
97
+
98
+ **2. Deep Scan** (10-30 minutes)
99
+
100
+ - Reads files in critical directories based on project type
101
+ - Scans: All critical paths from documentation requirements
102
+ - Best for: Comprehensive documentation for brownfield PRD
103
+ - File reading: Selective (key files in critical directories)
104
+
105
+ **3. Exhaustive Scan** (30-120 minutes)
106
+
107
+ - Reads ALL source files in project
108
+ - Scans: Every source file (excludes node_modules, dist, build)
109
+ - Best for: Complete analysis, migration planning, detailed audit
110
+ - File reading: Complete (all source files)
111
+
112
+ Your choice [1/2/3] (default: 1):
113
+ </ask>
114
+
115
+ <action if="user selects 1 OR user presses enter">
116
+ <action>Set scan_level = "quick"</action>
117
+ <action>Display: "Using Quick Scan (pattern-based, no source file reading)"</action>
118
+ </action>
119
+
120
+ <action if="user selects 2">
121
+ <action>Set scan_level = "deep"</action>
122
+ <action>Display: "Using Deep Scan (reading critical files per project type)"</action>
123
+ </action>
124
+
125
+ <action if="user selects 3">
126
+ <action>Set scan_level = "exhaustive"</action>
127
+ <action>Display: "Using Exhaustive Scan (reading all source files)"</action>
128
+ </action>
129
+
130
+ <action>Initialize state file: {output_folder}/project-scan-report.json</action>
131
+ <critical>Every time you touch the state file, record: step id, human-readable summary (what you actually did), precise timestamp, and any outputs written. Vague phrases are unacceptable.</critical>
132
+ <action>Write initial state:
133
+ {
134
+ "workflow_version": "1.2.0",
135
+ "timestamps": {"started": "{{current_timestamp}}", "last_updated": "{{current_timestamp}}"},
136
+ "mode": "{{workflow_mode}}",
137
+ "scan_level": "{{scan_level}}",
138
+ "project_root": "{{project_root_path}}",
139
+ "output_folder": "{{output_folder}}",
140
+ "completed_steps": [],
141
+ "current_step": "step_1",
142
+ "findings": {},
143
+ "outputs_generated": ["project-scan-report.json"],
144
+ "resume_instructions": "Starting from step 1"
145
+ }
146
+ </action>
147
+ <action>Continue with standard workflow from Step 1</action>
148
+ </check>
149
+ </step>
150
+
151
+ <step n="1" goal="Detect project structure and classify project type" if="workflow_mode != deep_dive">
152
+ <action>Ask user: "What is the root directory of the project to document?" (default: current working directory)</action>
153
+ <action>Store as {{project_root_path}}</action>
154
+
155
+ <action>Scan {{project_root_path}} for key indicators:
156
+
157
+ - Directory structure (presence of client/, server/, api/, src/, app/, etc.)
158
+ - Key files (package.json, go.mod, requirements.txt, etc.)
159
+ - Technology markers matching detection_keywords from project-types.csv
160
+ </action>
161
+
162
+ <action>Detect if project is:
163
+
164
+ - **Monolith**: Single cohesive codebase
165
+ - **Monorepo**: Multiple parts in one repository
166
+ - **Multi-part**: Separate client/server or similar architecture
167
+ </action>
168
+
169
+ <check if="multiple distinct parts detected (e.g., client/ and server/ folders)">
170
+ <action>List detected parts with their paths</action>
171
+ <ask>I detected multiple parts in this project:
172
+ {{detected_parts_list}}
173
+
174
+ Is this correct? Should I document each part separately? [y/n]
175
+ </ask>
176
+
177
+ <action if="user confirms">Set repository_type = "monorepo" or "multi-part"</action>
178
+ <action if="user confirms">For each detected part: - Identify root path - Run project type detection using key_file_patterns from documentation-requirements.csv - Store as part in project_parts array
179
+ </action>
180
+
181
+ <action if="user denies or corrects">Ask user to specify correct parts and their paths</action>
182
+ </check>
183
+
184
+ <check if="single cohesive project detected">
185
+ <action>Set repository_type = "monolith"</action>
186
+ <action>Create single part in project_parts array with root_path = {{project_root_path}}</action>
187
+ <action>Run project type detection using key_file_patterns from documentation-requirements.csv</action>
188
+ </check>
189
+
190
+ <action>For each part, match detected technologies and file patterns against key_file_patterns column in documentation-requirements.csv</action>
191
+ <action>Assign project_type_id to each part</action>
192
+ <action>Load corresponding documentation_requirements row for each part</action>
193
+
194
+ <ask>I've classified this project:
195
+ {{project_classification_summary}}
196
+
197
+ Does this look correct? [y/n/edit]
198
+ </ask>
199
+
200
+ <template-output>project_structure</template-output>
201
+ <template-output>project_parts_metadata</template-output>
202
+
203
+ <action>IMMEDIATELY update state file with step completion:
204
+
205
+ - Add to completed_steps: {"step": "step_1", "status": "completed", "timestamp": "{{now}}", "summary": "Classified as {{repository_type}} with {{parts_count}} parts"}
206
+ - Update current_step = "step_2"
207
+ - Update findings.project_classification with high-level summary only
208
+ - **CACHE project_type_id(s)**: Add project_types array: [{"part_id": "{{part_id}}", "project_type_id": "{{project_type_id}}", "display_name": "{{display_name}}"}]
209
+ - This cached data prevents reloading all CSV files on resume - we can load just the needed documentation_requirements row(s)
210
+ - Update last_updated timestamp
211
+ - Write state file
212
+ </action>
213
+
214
+ <action>PURGE detailed scan results from memory, keep only summary: "{{repository_type}}, {{parts_count}} parts, {{primary_tech}}"</action>
215
+ </step>
216
+
217
+ <step n="2" goal="Discover existing documentation and gather user context" if="workflow_mode != deep_dive">
218
+ <action>For each part, scan for existing documentation using patterns:
219
+ - README.md, README.rst, README.txt
220
+ - CONTRIBUTING.md, CONTRIBUTING.rst
221
+ - ARCHITECTURE.md, ARCHITECTURE.txt, docs/architecture/
222
+ - DEPLOYMENT.md, DEPLOY.md, docs/deployment/
223
+ - API.md, docs/api/
224
+ - Any files in docs/, documentation/, .github/ folders
225
+ </action>
226
+
227
+ <action>Create inventory of existing_docs with:
228
+
229
+ - File path
230
+ - File type (readme, architecture, api, etc.)
231
+ - Which part it belongs to (if multi-part)
232
+ </action>
233
+
234
+ <ask>I found these existing documentation files:
235
+ {{existing_docs_list}}
236
+
237
+ Are there any other important documents or key areas I should focus on while analyzing this project? [Provide paths or guidance, or type 'none']
238
+ </ask>
239
+
240
+ <action>Store user guidance as {{user_context}}</action>
241
+
242
+ <template-output>existing_documentation_inventory</template-output>
243
+ <template-output>user_provided_context</template-output>
244
+
245
+ <action>Update state file:
246
+
247
+ - Add to completed_steps: {"step": "step_2", "status": "completed", "timestamp": "{{now}}", "summary": "Found {{existing_docs_count}} existing docs"}
248
+ - Update current_step = "step_3"
249
+ - Update last_updated timestamp
250
+ </action>
251
+
252
+ <action>PURGE detailed doc contents from memory, keep only: "{{existing_docs_count}} docs found"</action>
253
+ </step>
254
+
255
+ <step n="3" goal="Analyze technology stack for each part" if="workflow_mode != deep_dive">
256
+ <action>For each part in project_parts:
257
+ - Load key_file_patterns from documentation_requirements
258
+ - Scan part root for these patterns
259
+ - Parse technology manifest files (package.json, go.mod, requirements.txt, etc.)
260
+ - Extract: framework, language, version, database, dependencies
261
+ - Build technology_table with columns: Category, Technology, Version, Justification
262
+ </action>
263
+
264
+ <action>Determine architecture pattern based on detected tech stack:
265
+
266
+ - Use project_type_id as primary indicator (e.g., "web" → layered/component-based, "backend" → service/API-centric)
267
+ - Consider framework patterns (e.g., React → component hierarchy, Express → middleware pipeline)
268
+ - Note architectural style in technology table
269
+ - Store as {{architecture_pattern}} for each part
270
+ </action>
271
+
272
+ <template-output>technology_stack</template-output>
273
+ <template-output>architecture_patterns</template-output>
274
+
275
+ <action>Update state file:
276
+
277
+ - Add to completed_steps: {"step": "step_3", "status": "completed", "timestamp": "{{now}}", "summary": "Tech stack: {{primary_framework}}"}
278
+ - Update current_step = "step_4"
279
+ - Update findings.technology_stack with summary per part
280
+ - Update last_updated timestamp
281
+ </action>
282
+
283
+ <action>PURGE detailed tech analysis from memory, keep only: "{{framework}} on {{language}}"</action>
284
+ </step>
285
+
286
+ <step n="4" goal="Perform conditional analysis based on project type requirements" if="workflow_mode != deep_dive">
287
+
288
+ <critical>BATCHING STRATEGY FOR DEEP/EXHAUSTIVE SCANS</critical>
289
+
290
+ <check if="scan_level == deep OR scan_level == exhaustive">
291
+ <action>This step requires file reading. Apply batching strategy:</action>
292
+
293
+ <action>Identify subfolders to process based on: - scan_level == "deep": Use critical_directories from documentation_requirements - scan_level == "exhaustive": Get ALL subfolders recursively (excluding node_modules, .git, dist, build, coverage)
294
+ </action>
295
+
296
+ <action>For each subfolder to scan: 1. Read all files in subfolder (consider file size - use judgment for files >5000 LOC) 2. Extract required information based on conditional flags below 3. IMMEDIATELY write findings to appropriate output file 4. Validate written document (section-level validation) 5. Update state file with batch completion 6. PURGE detailed findings from context, keep only 1-2 sentence summary 7. Move to next subfolder
297
+ </action>
298
+
299
+ <action>Track batches in state file:
300
+ findings.batches_completed: [
301
+ {"path": "{{subfolder_path}}", "files_scanned": {{count}}, "summary": "{{brief_summary}}"}
302
+ ]
303
+ </action>
304
+ </check>
305
+
306
+ <check if="scan_level == quick">
307
+ <action>Use pattern matching only - do NOT read source files</action>
308
+ <action>Use glob/grep to identify file locations and patterns</action>
309
+ <action>Extract information from filenames, directory structure, and config files only</action>
310
+ </check>
311
+
312
+ <action>For each part, check documentation_requirements boolean flags and execute corresponding scans:</action>
313
+
314
+ <check if="requires_api_scan == true">
315
+ <action>Scan for API routes and endpoints using integration_scan_patterns</action>
316
+ <action>Look for: controllers/, routes/, api/, handlers/, endpoints/</action>
317
+
318
+ <check if="scan_level == quick">
319
+ <action>Use glob to find route files, extract patterns from filenames and folder structure</action>
320
+ </check>
321
+
322
+ <check if="scan_level == deep OR scan_level == exhaustive">
323
+ <action>Read files in batches (one subfolder at a time)</action>
324
+ <action>Extract: HTTP methods, paths, request/response types from actual code</action>
325
+ </check>
326
+
327
+ <action>Build API contracts catalog</action>
328
+ <action>IMMEDIATELY write to: {output_folder}/api-contracts-{part_id}.md</action>
329
+ <action>Validate document has all required sections</action>
330
+ <action>Update state file with output generated</action>
331
+ <action>PURGE detailed API data, keep only: "{{api_count}} endpoints documented"</action>
332
+ <template-output>api_contracts\*{part_id}</template-output>
333
+ </check>
334
+
335
+ <check if="requires_data_models == true">
336
+ <action>Scan for data models using schema_migration_patterns</action>
337
+ <action>Look for: models/, schemas/, entities/, migrations/, prisma/, ORM configs</action>
338
+
339
+ <check if="scan_level == quick">
340
+ <action>Identify schema files via glob, parse migration file names for table discovery</action>
341
+ </check>
342
+
343
+ <check if="scan_level == deep OR scan_level == exhaustive">
344
+ <action>Read model files in batches (one subfolder at a time)</action>
345
+ <action>Extract: table names, fields, relationships, constraints from actual code</action>
346
+ </check>
347
+
348
+ <action>Build database schema documentation</action>
349
+ <action>IMMEDIATELY write to: {output_folder}/data-models-{part_id}.md</action>
350
+ <action>Validate document completeness</action>
351
+ <action>Update state file with output generated</action>
352
+ <action>PURGE detailed schema data, keep only: "{{table_count}} tables documented"</action>
353
+ <template-output>data_models\*{part_id}</template-output>
354
+ </check>
355
+
356
+ <check if="requires_state_management == true">
357
+ <action>Analyze state management patterns</action>
358
+ <action>Look for: Redux, Context API, MobX, Vuex, Pinia, Provider patterns</action>
359
+ <action>Identify: stores, reducers, actions, state structure</action>
360
+ <template-output>state_management_patterns_{part_id}</template-output>
361
+ </check>
362
+
363
+ <check if="requires_ui_components == true">
364
+ <action>Inventory UI component library</action>
365
+ <action>Scan: components/, ui/, widgets/, views/ folders</action>
366
+ <action>Categorize: Layout, Form, Display, Navigation, etc.</action>
367
+ <action>Identify: Design system, component patterns, reusable elements</action>
368
+ <template-output>ui_component_inventory_{part_id}</template-output>
369
+ </check>
370
+
371
+ <check if="requires_hardware_docs == true">
372
+ <action>Look for hardware schematics using hardware_interface_patterns</action>
373
+ <ask>This appears to be an embedded/hardware project. Do you have:
374
+ - Pinout diagrams
375
+ - Hardware schematics
376
+ - PCB layouts
377
+ - Hardware documentation
378
+
379
+ If yes, please provide paths or links. [Provide paths or type 'none']
380
+ </ask>
381
+ <action>Store hardware docs references</action>
382
+ <template-output>hardware*documentation*{part_id}</template-output>
383
+ </check>
384
+
385
+ <check if="requires_asset_inventory == true">
386
+ <action>Scan and catalog assets using asset_patterns</action>
387
+ <action>Categorize by: Images, Audio, 3D Models, Sprites, Textures, etc.</action>
388
+ <action>Calculate: Total size, file counts, formats used</action>
389
+ <template-output>asset_inventory_{part_id}</template-output>
390
+ </check>
391
+
392
+ <action>Scan for additional patterns based on doc requirements:
393
+
394
+ - config_patterns → Configuration management
395
+ - auth_security_patterns → Authentication/authorization approach
396
+ - entry_point_patterns → Application entry points and bootstrap
397
+ - shared_code_patterns → Shared libraries and utilities
398
+ - async_event_patterns → Event-driven architecture
399
+ - ci_cd_patterns → CI/CD pipeline details
400
+ - localization_patterns → i18n/l10n support
401
+ </action>
402
+
403
+ <action>Apply scan_level strategy to each pattern scan (quick=glob only, deep/exhaustive=read files)</action>
404
+
405
+ <template-output>comprehensive*analysis*{part_id}</template-output>
406
+
407
+ <action>Update state file:
408
+
409
+ - Add to completed_steps: {"step": "step_4", "status": "completed", "timestamp": "{{now}}", "summary": "Conditional analysis complete, {{files_generated}} files written"}
410
+ - Update current_step = "step_5"
411
+ - Update last_updated timestamp
412
+ - List all outputs_generated
413
+ </action>
414
+
415
+ <action>PURGE all detailed scan results from context. Keep only summaries:
416
+
417
+ - "APIs: {{api_count}} endpoints"
418
+ - "Data: {{table_count}} tables"
419
+ - "Components: {{component_count}} components"
420
+ </action>
421
+ </step>
422
+
423
+ <step n="5" goal="Generate source tree analysis with annotations" if="workflow_mode != deep_dive">
424
+ <action>For each part, generate complete directory tree using critical_directories from doc requirements</action>
425
+
426
+ <action>Annotate the tree with:
427
+
428
+ - Purpose of each critical directory
429
+ - Entry points marked
430
+ - Key file locations highlighted
431
+ - Integration points noted (for multi-part projects)
432
+ </action>
433
+
434
+ <action if="multi-part project">Show how parts are organized and where they interface</action>
435
+
436
+ <action>Create formatted source tree with descriptions:
437
+
438
+ ```
439
+ project-root/
440
+ ├── client/ # React frontend (Part: client)
441
+ │ ├── src/
442
+ │ │ ├── components/ # Reusable UI components
443
+ │ │ ├── pages/ # Route-based pages
444
+ │ │ └── api/ # API client layer → Calls server/
445
+ ├── server/ # Express API backend (Part: api)
446
+ │ ├── src/
447
+ │ │ ├── routes/ # REST API endpoints
448
+ │ │ ├── models/ # Database models
449
+ │ │ └── services/ # Business logic
450
+ ```
451
+
452
+ </action>
453
+
454
+ <template-output>source_tree_analysis</template-output>
455
+ <template-output>critical_folders_summary</template-output>
456
+
457
+ <action>IMMEDIATELY write source-tree-analysis.md to disk</action>
458
+ <action>Validate document structure</action>
459
+ <action>Update state file:
460
+
461
+ - Add to completed_steps: {"step": "step_5", "status": "completed", "timestamp": "{{now}}", "summary": "Source tree documented"}
462
+ - Update current_step = "step_6"
463
+ - Add output: "source-tree-analysis.md"
464
+ </action>
465
+ <action>PURGE detailed tree from context, keep only: "Source tree with {{folder_count}} critical folders"</action>
466
+ </step>
467
+
468
+ <step n="6" goal="Extract development and operational information" if="workflow_mode != deep_dive">
469
+ <action>Scan for development setup using key_file_patterns and existing docs:
470
+ - Prerequisites (Node version, Python version, etc.)
471
+ - Installation steps (npm install, etc.)
472
+ - Environment setup (.env files, config)
473
+ - Build commands (npm run build, make, etc.)
474
+ - Run commands (npm start, go run, etc.)
475
+ - Test commands using test_file_patterns
476
+ </action>
477
+
478
+ <action>Look for deployment configuration using ci_cd_patterns:
479
+
480
+ - Dockerfile, docker-compose.yml
481
+ - Kubernetes configs (k8s/, helm/)
482
+ - CI/CD pipelines (.github/workflows/, .gitlab-ci.yml)
483
+ - Deployment scripts
484
+ - Infrastructure as Code (terraform/, pulumi/)
485
+ </action>
486
+
487
+ <action if="CONTRIBUTING.md or similar found">
488
+ <action>Extract contribution guidelines:
489
+ - Code style rules
490
+ - PR process
491
+ - Commit conventions
492
+ - Testing requirements
493
+ </action>
494
+ </action>
495
+
496
+ <template-output>development_instructions</template-output>
497
+ <template-output>deployment_configuration</template-output>
498
+ <template-output>contribution_guidelines</template-output>
499
+
500
+ <action>Update state file:
501
+
502
+ - Add to completed_steps: {"step": "step_6", "status": "completed", "timestamp": "{{now}}", "summary": "Dev/deployment guides written"}
503
+ - Update current_step = "step_7"
504
+ - Add generated outputs to list
505
+ </action>
506
+ <action>PURGE detailed instructions, keep only: "Dev setup and deployment documented"</action>
507
+ </step>
508
+
509
+ <step n="7" goal="Detect multi-part integration architecture" if="workflow_mode != deep_dive and project has multiple parts">
510
+ <action>Analyze how parts communicate:
511
+ - Scan integration_scan_patterns across parts
512
+ - Identify: REST calls, GraphQL queries, gRPC, message queues, shared databases
513
+ - Document: API contracts between parts, data flow, authentication flow
514
+ </action>
515
+
516
+ <action>Create integration_points array with:
517
+
518
+ - from: source part
519
+ - to: target part
520
+ - type: REST API, GraphQL, gRPC, Event Bus, etc.
521
+ - details: Endpoints, protocols, data formats
522
+ </action>
523
+
524
+ <action>IMMEDIATELY write integration-architecture.md to disk</action>
525
+ <action>Validate document completeness</action>
526
+
527
+ <template-output>integration_architecture</template-output>
528
+
529
+ <action>Update state file:
530
+
531
+ - Add to completed_steps: {"step": "step_7", "status": "completed", "timestamp": "{{now}}", "summary": "Integration architecture documented"}
532
+ - Update current_step = "step_8"
533
+ </action>
534
+ <action>PURGE integration details, keep only: "{{integration_count}} integration points"</action>
535
+ </step>
536
+
537
+ <step n="8" goal="Generate architecture documentation for each part" if="workflow_mode != deep_dive">
538
+ <action>For each part in project_parts:
539
+ - Use matched architecture template from Step 3 as base structure
540
+ - Fill in all sections with discovered information:
541
+ * Executive Summary
542
+ * Technology Stack (from Step 3)
543
+ * Architecture Pattern (from registry match)
544
+ * Data Architecture (from Step 4 data models scan)
545
+ * API Design (from Step 4 API scan if applicable)
546
+ * Component Overview (from Step 4 component scan if applicable)
547
+ * Source Tree (from Step 5)
548
+ * Development Workflow (from Step 6)
549
+ * Deployment Architecture (from Step 6)
550
+ * Testing Strategy (from test patterns)
551
+ </action>
552
+
553
+ <action if="single part project">
554
+ - Generate: architecture.md (no part suffix)
555
+ </action>
556
+
557
+ <action if="multi-part project">
558
+ - Generate: architecture-{part_id}.md for each part
559
+ </action>
560
+
561
+ <action>For each architecture file generated:
562
+
563
+ - IMMEDIATELY write architecture file to disk
564
+ - Validate against architecture template schema
565
+ - Update state file with output
566
+ - PURGE detailed architecture from context, keep only: "Architecture for {{part_id}} written"
567
+ </action>
568
+
569
+ <template-output>architecture_document</template-output>
570
+
571
+ <action>Update state file:
572
+
573
+ - Add to completed_steps: {"step": "step_8", "status": "completed", "timestamp": "{{now}}", "summary": "Architecture docs written for {{parts_count}} parts"}
574
+ - Update current_step = "step_9"
575
+ </action>
576
+ </step>
577
+
578
+ <step n="9" goal="Generate supporting documentation files" if="workflow_mode != deep_dive">
579
+ <action>Generate project-overview.md with:
580
+ - Project name and purpose (from README or user input)
581
+ - Executive summary
582
+ - Tech stack summary table
583
+ - Architecture type classification
584
+ - Repository structure (monolith/monorepo/multi-part)
585
+ - Links to detailed docs
586
+ </action>
587
+
588
+ <action>Generate source-tree-analysis.md with:
589
+
590
+ - Full annotated directory tree from Step 5
591
+ - Critical folders explained
592
+ - Entry points documented
593
+ - Multi-part structure (if applicable)
594
+ </action>
595
+
596
+ <action>IMMEDIATELY write project-overview.md to disk</action>
597
+ <action>Validate document sections</action>
598
+
599
+ <action>Generate source-tree-analysis.md (if not already written in Step 5)</action>
600
+ <action>IMMEDIATELY write to disk and validate</action>
601
+
602
+ <action>Generate component-inventory.md (or per-part versions) with:
603
+
604
+ - All discovered components from Step 4
605
+ - Categorized by type
606
+ - Reusable vs specific components
607
+ - Design system elements (if found)
608
+ </action>
609
+ <action>IMMEDIATELY write each component inventory to disk and validate</action>
610
+
611
+ <action>Generate development-guide.md (or per-part versions) with:
612
+
613
+ - Prerequisites and dependencies
614
+ - Environment setup instructions
615
+ - Local development commands
616
+ - Build process
617
+ - Testing approach and commands
618
+ - Common development tasks
619
+ </action>
620
+ <action>IMMEDIATELY write each development guide to disk and validate</action>
621
+
622
+ <action if="deployment configuration found">
623
+ <action>Generate deployment-guide.md with:
624
+ - Infrastructure requirements
625
+ - Deployment process
626
+ - Environment configuration
627
+ - CI/CD pipeline details
628
+ </action>
629
+ <action>IMMEDIATELY write to disk and validate</action>
630
+ </action>
631
+
632
+ <action if="contribution guidelines found">
633
+ <action>Generate contribution-guide.md with:
634
+ - Code style and conventions
635
+ - PR process
636
+ - Testing requirements
637
+ - Documentation standards
638
+ </action>
639
+ <action>IMMEDIATELY write to disk and validate</action>
640
+ </action>
641
+
642
+ <action if="API contracts documented">
643
+ <action>Generate api-contracts.md (or per-part) with:
644
+ - All API endpoints
645
+ - Request/response schemas
646
+ - Authentication requirements
647
+ - Example requests
648
+ </action>
649
+ <action>IMMEDIATELY write to disk and validate</action>
650
+ </action>
651
+
652
+ <action if="Data models documented">
653
+ <action>Generate data-models.md (or per-part) with:
654
+ - Database schema
655
+ - Table relationships
656
+ - Data models and entities
657
+ - Migration strategy
658
+ </action>
659
+ <action>IMMEDIATELY write to disk and validate</action>
660
+ </action>
661
+
662
+ <action if="multi-part project">
663
+ <action>Generate integration-architecture.md with:
664
+ - How parts communicate
665
+ - Integration points diagram/description
666
+ - Data flow between parts
667
+ - Shared dependencies
668
+ </action>
669
+ <action>IMMEDIATELY write to disk and validate</action>
670
+
671
+ <action>Generate project-parts.json metadata file:
672
+ `json
673
+ {
674
+ "repository_type": "monorepo",
675
+ "parts": [ ... ],
676
+ "integration_points": [ ... ]
677
+ }
678
+ `
679
+ </action>
680
+ <action>IMMEDIATELY write to disk</action>
681
+ </action>
682
+
683
+ <template-output>supporting_documentation</template-output>
684
+
685
+ <action>Update state file:
686
+
687
+ - Add to completed_steps: {"step": "step_9", "status": "completed", "timestamp": "{{now}}", "summary": "All supporting docs written"}
688
+ - Update current_step = "step_10"
689
+ - List all newly generated outputs
690
+ </action>
691
+
692
+ <action>PURGE all document contents from context, keep only list of files generated</action>
693
+ </step>
694
+
695
+ <step n="10" goal="Generate master index as primary AI retrieval source" if="workflow_mode != deep_dive">
696
+
697
+ <critical>INCOMPLETE DOCUMENTATION MARKER CONVENTION:
698
+ When a document SHOULD be generated but wasn't (due to quick scan, missing data, conditional requirements not met):
699
+
700
+ - Use EXACTLY this marker: _(To be generated)_
701
+ - Place it at the end of the markdown link line
702
+ - Example: - [API Contracts - Server](./api-contracts-server.md) _(To be generated)_
703
+ - This allows Step 11 to detect and offer to complete these items
704
+ - ALWAYS use this exact format for consistency and automated detection
705
+ </critical>
706
+
707
+ <action>Create index.md with intelligent navigation based on project structure</action>
708
+
709
+ <action if="single part project">
710
+ <action>Generate simple index with:
711
+ - Project name and type
712
+ - Quick reference (tech stack, architecture type)
713
+ - Links to all generated docs
714
+ - Links to discovered existing docs
715
+ - Getting started section
716
+ </action>
717
+ </action>
718
+
719
+ <action if="multi-part project">
720
+ <action>Generate comprehensive index with:
721
+ - Project overview and structure summary
722
+ - Part-based navigation section
723
+ - Quick reference by part
724
+ - Cross-part integration links
725
+ - Links to all generated and existing docs
726
+ - Getting started per part
727
+ </action>
728
+ </action>
729
+
730
+ <action>Include in index.md:
731
+
732
+ ## Project Documentation Index
733
+
734
+ ### Project Overview
735
+
736
+ - **Type:** {{repository_type}} {{#if multi-part}}with {{parts.length}} parts{{/if}}
737
+ - **Primary Language:** {{primary_language}}
738
+ - **Architecture:** {{architecture_type}}
739
+
740
+ ### Quick Reference
741
+
742
+ {{#if single_part}}
743
+
744
+ - **Tech Stack:** {{tech_stack_summary}}
745
+ - **Entry Point:** {{entry_point}}
746
+ - **Architecture Pattern:** {{architecture_pattern}}
747
+ {{else}}
748
+ {{#each parts}}
749
+
750
+ #### {{part_name}} ({{part_id}})
751
+
752
+ - **Type:** {{project_type}}
753
+ - **Tech Stack:** {{tech_stack}}
754
+ - **Root:** {{root_path}}
755
+ {{/each}}
756
+ {{/if}}
757
+
758
+ ### Generated Documentation
759
+
760
+ - [Project Overview](./project-overview.md)
761
+ - [Architecture](./architecture{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless architecture_file_exists}} (To be generated) {{/unless}}
762
+ - [Source Tree Analysis](./source-tree-analysis.md)
763
+ - [Component Inventory](./component-inventory{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless component_inventory_exists}} (To be generated) {{/unless}}
764
+ - [Development Guide](./development-guide{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless dev_guide_exists}} (To be generated) {{/unless}}
765
+ {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} (To be generated) {{/unless}}{{/if}}
766
+ {{#if contribution_found}}- [Contribution Guide](./contribution-guide.md){{/if}}
767
+ {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} (To be generated) {{/unless}}{{/if}}
768
+ {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} (To be generated) {{/unless}}{{/if}}
769
+ {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} (To be generated) {{/unless}}{{/if}}
770
+
771
+ ### Existing Documentation
772
+
773
+ {{#each existing_docs}}
774
+
775
+ - [{{title}}]({{relative_path}}) - {{description}}
776
+ {{/each}}
777
+
778
+ ### Getting Started
779
+
780
+ {{getting_started_instructions}}
781
+ </action>
782
+
783
+ <action>Before writing index.md, check which expected files actually exist:
784
+
785
+ - For each document that should have been generated, check if file exists on disk
786
+ - Set existence flags: architecture_file_exists, component_inventory_exists, dev_guide_exists, etc.
787
+ - These flags determine whether to add the _(To be generated)_ marker
788
+ - Track which files are missing in {{missing_docs_list}} for reporting
789
+ </action>
790
+
791
+ <action>IMMEDIATELY write index.md to disk with appropriate _(To be generated)_ markers for missing files</action>
792
+ <action>Validate index has all required sections and links are valid</action>
793
+
794
+ <template-output>index</template-output>
795
+
796
+ <action>Update state file:
797
+
798
+ - Add to completed_steps: {"step": "step_10", "status": "completed", "timestamp": "{{now}}", "summary": "Master index generated"}
799
+ - Update current_step = "step_11"
800
+ - Add output: "index.md"
801
+ </action>
802
+
803
+ <action>PURGE index content from context</action>
804
+ </step>
805
+
806
+ <step n="11" goal="Validate and review generated documentation" if="workflow_mode != deep_dive">
807
+ <action>Show summary of all generated files:
808
+ Generated in {{output_folder}}/:
809
+ {{file_list_with_sizes}}
810
+ </action>
811
+
812
+ <action>Run validation checklist from {validation}</action>
813
+
814
+ <critical>INCOMPLETE DOCUMENTATION DETECTION:
815
+
816
+ 1. PRIMARY SCAN: Look for exact marker: _(To be generated)_
817
+ 2. FALLBACK SCAN: Look for fuzzy patterns (in case agent was lazy):
818
+ - _(TBD)_
819
+ - _(TODO)_
820
+ - _(Coming soon)_
821
+ - _(Not yet generated)_
822
+ - _(Pending)_
823
+ 3. Extract document metadata from each match for user selection
824
+ </critical>
825
+
826
+ <action>Read {output_folder}/index.md</action>
827
+
828
+ <action>Scan for incomplete documentation markers:
829
+ Step 1: Search for exact pattern "_(To be generated)_" (case-sensitive)
830
+ Step 2: For each match found, extract the entire line
831
+ Step 3: Parse line to extract:
832
+
833
+ - Document title (text within [brackets] or **bold**)
834
+ - File path (from markdown link or inferable from title)
835
+ - Document type (infer from filename: architecture, api-contracts, data-models, component-inventory, development-guide, deployment-guide, integration-architecture)
836
+ - Part ID if applicable (extract from filename like "architecture-server.md" → part_id: "server")
837
+ Step 4: Add to {{incomplete_docs_strict}} array
838
+ </action>
839
+
840
+ <action>Fallback fuzzy scan for alternate markers:
841
+ Search for patterns: _(TBD)_, _(TODO)_, _(Coming soon)_, _(Not yet generated)_, _(Pending)_
842
+ For each fuzzy match:
843
+
844
+ - Extract same metadata as strict scan
845
+ - Add to {{incomplete_docs_fuzzy}} array with fuzzy_match flag
846
+ </action>
847
+
848
+ <action>Combine results:
849
+ Set {{incomplete_docs_list}} = {{incomplete_docs_strict}} + {{incomplete_docs_fuzzy}}
850
+ For each item store structure:
851
+ {
852
+ "title": "Architecture – Server",
853
+ "file\*path": "./architecture-server.md",
854
+ "doc_type": "architecture",
855
+ "part_id": "server",
856
+ "line_text": "- [Architecture – Server](./architecture-server.md) (To be generated)",
857
+ "fuzzy_match": false
858
+ }
859
+ </action>
860
+
861
+ <ask>Documentation generation complete!
862
+
863
+ Summary:
864
+
865
+ - Project Type: {{project_type_summary}}
866
+ - Parts Documented: {{parts_count}}
867
+ - Files Generated: {{files_count}}
868
+ - Total Lines: {{total_lines}}
869
+
870
+ {{#if incomplete_docs_list.length > 0}}
871
+ ⚠️ **Incomplete Documentation Detected:**
872
+
873
+ I found {{incomplete_docs_list.length}} item(s) marked as incomplete:
874
+
875
+ {{#each incomplete_docs_list}}
876
+ {{@index + 1}}. **{{title}}** ({{doc_type}}{{#if part_id}} for {{part_id}}{{/if}}){{#if fuzzy_match}} ⚠️ [non-standard marker]{{/if}}
877
+ {{/each}}
878
+
879
+ {{/if}}
880
+
881
+ Would you like to:
882
+
883
+ {{#if incomplete_docs_list.length > 0}}
884
+
885
+ 1. **Generate incomplete documentation** - Complete any of the {{incomplete_docs_list.length}} items above
886
+ 2. Review any specific section [type section name]
887
+ 3. Add more detail to any area [type area name]
888
+ 4. Generate additional custom documentation [describe what]
889
+ 5. Finalize and complete [type 'done']
890
+ {{else}}
891
+ 6. Review any specific section [type section name]
892
+ 7. Add more detail to any area [type area name]
893
+ 8. Generate additional documentation [describe what]
894
+ 9. Finalize and complete [type 'done']
895
+ {{/if}}
896
+
897
+ Your choice:
898
+ </ask>
899
+
900
+ <check if="user selects option 1 (generate incomplete)">
901
+ <ask>Which incomplete items would you like to generate?
902
+
903
+ {{#each incomplete_docs_list}}
904
+ {{@index + 1}}. {{title}} ({{doc_type}}{{#if part_id}} - {{part_id}}{{/if}})
905
+ {{/each}}
906
+ {{incomplete_docs_list.length + 1}}. All of them
907
+
908
+ Enter number(s) separated by commas (e.g., "1,3,5"), or type 'all':
909
+ </ask>
910
+
911
+ <action>Parse user selection:
912
+
913
+ - If "all", set {{selected_items}} = all items in {{incomplete_docs_list}}
914
+ - If comma-separated numbers, extract selected items by index
915
+ - Store result in {{selected_items}} array
916
+ </action>
917
+
918
+ <action>Display: "Generating {{selected_items.length}} document(s)..."</action>
919
+
920
+ <action>For each item in {{selected_items}}:
921
+
922
+ 1. **Identify the part and requirements:**
923
+ - Extract part_id from item (if exists)
924
+ - Look up part data in project_parts array from state file
925
+ - Load documentation_requirements for that part's project_type_id
926
+
927
+ 2. **Route to appropriate generation substep based on doc_type:**
928
+
929
+ **If doc_type == "architecture":**
930
+ - Display: "Generating architecture documentation for {{part_id}}..."
931
+ - Load architecture_match for this part from state file (Step 3 cache)
932
+ - Re-run Step 8 architecture generation logic ONLY for this specific part
933
+ - Use matched template and fill with cached data from state file
934
+ - Write architecture-{{part_id}}.md to disk
935
+ - Validate completeness
936
+
937
+ **If doc_type == "api-contracts":**
938
+ - Display: "Generating API contracts for {{part_id}}..."
939
+ - Load part data and documentation_requirements
940
+ - Re-run Step 4 API scan substep targeting ONLY this part
941
+ - Use scan_level from state file (quick/deep/exhaustive)
942
+ - Generate api-contracts-{{part_id}}.md
943
+ - Validate document structure
944
+
945
+ **If doc_type == "data-models":**
946
+ - Display: "Generating data models documentation for {{part_id}}..."
947
+ - Re-run Step 4 data models scan substep targeting ONLY this part
948
+ - Use schema_migration_patterns from documentation_requirements
949
+ - Generate data-models-{{part_id}}.md
950
+ - Validate completeness
951
+
952
+ **If doc_type == "component-inventory":**
953
+ - Display: "Generating component inventory for {{part_id}}..."
954
+ - Re-run Step 9 component inventory generation for this specific part
955
+ - Scan components/, ui/, widgets/ folders
956
+ - Generate component-inventory-{{part_id}}.md
957
+ - Validate structure
958
+
959
+ **If doc_type == "development-guide":**
960
+ - Display: "Generating development guide for {{part_id}}..."
961
+ - Re-run Step 9 development guide generation for this specific part
962
+ - Use key_file_patterns and test_file_patterns from documentation_requirements
963
+ - Generate development-guide-{{part_id}}.md
964
+ - Validate completeness
965
+
966
+ **If doc_type == "deployment-guide":**
967
+ - Display: "Generating deployment guide..."
968
+ - Re-run Step 6 deployment configuration scan
969
+ - Re-run Step 9 deployment guide generation
970
+ - Generate deployment-guide.md
971
+ - Validate structure
972
+
973
+ **If doc_type == "integration-architecture":**
974
+ - Display: "Generating integration architecture..."
975
+ - Re-run Step 7 integration analysis for all parts
976
+ - Generate integration-architecture.md
977
+ - Validate completeness
978
+
979
+ 3. **Post-generation actions:**
980
+ - Confirm file was written successfully
981
+ - Update state file with newly generated output
982
+ - Add to {{newly_generated_docs}} tracking list
983
+ - Display: "✓ Generated: {{file_path}}"
984
+
985
+ 4. **Handle errors:**
986
+ - If generation fails, log error and continue with next item
987
+ - Track failed items in {{failed_generations}} list
988
+ </action>
989
+
990
+ <action>After all selected items are processed:
991
+
992
+ **Update index.md to remove markers:**
993
+
994
+ 1. Read current index.md content
995
+ 2. For each item in {{newly_generated_docs}}:
996
+ - Find the line containing the file link and marker
997
+ - Remove the _(To be generated)_ or fuzzy marker text
998
+ - Leave the markdown link intact
999
+ 3. Write updated index.md back to disk
1000
+ 4. Update state file to record index.md modification
1001
+ </action>
1002
+
1003
+ <action>Display generation summary:
1004
+
1005
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1006
+
1007
+ ✓ **Documentation Generation Complete!**
1008
+
1009
+ **Successfully Generated:**
1010
+ {{#each newly_generated_docs}}
1011
+
1012
+ - {{title}} → {{file_path}}
1013
+ {{/each}}
1014
+
1015
+ {{#if failed_generations.length > 0}}
1016
+ **Failed to Generate:**
1017
+ {{#each failed_generations}}
1018
+
1019
+ - {{title}} ({{error_message}})
1020
+ {{/each}}
1021
+ {{/if}}
1022
+
1023
+ **Updated:** index.md (removed incomplete markers)
1024
+
1025
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1026
+ </action>
1027
+
1028
+ <action>Update state file with all generation activities</action>
1029
+
1030
+ <action>Return to Step 11 menu (loop back to check for any remaining incomplete items)</action>
1031
+ </check>
1032
+
1033
+ <action if="user requests other changes (options 2-3)">Make requested modifications and regenerate affected files</action>
1034
+ <action if="user selects finalize (option 4 or 5)">Proceed to Step 12 completion</action>
1035
+
1036
+ <check if="not finalizing">
1037
+ <action>Update state file:
1038
+ - Add to completed_steps: {"step": "step_11_iteration", "status": "completed", "timestamp": "{{now}}", "summary": "Review iteration complete"}
1039
+ - Keep current_step = "step_11" (for loop back)
1040
+ - Update last_updated timestamp
1041
+ </action>
1042
+ <action>Loop back to beginning of Step 11 (re-scan for remaining incomplete docs)</action>
1043
+ </check>
1044
+
1045
+ <check if="finalizing">
1046
+ <action>Update state file:
1047
+ - Add to completed_steps: {"step": "step_11", "status": "completed", "timestamp": "{{now}}", "summary": "Validation and review complete"}
1048
+ - Update current_step = "step_12"
1049
+ </action>
1050
+ <action>Proceed to Step 12</action>
1051
+ </check>
1052
+ </step>
1053
+
1054
+ <step n="12" goal="Finalize and provide next steps" if="workflow_mode != deep_dive">
1055
+ <action>Create final summary report</action>
1056
+ <action>Compile verification recap variables:
1057
+ - Set {{verification_summary}} to the concrete tests, validations, or scripts you executed (or "none run").
1058
+ - Set {{open_risks}} to any remaining risks or TODO follow-ups (or "none").
1059
+ - Set {{next_checks}} to recommended actions before merging/deploying (or "none").
1060
+ </action>
1061
+
1062
+ <action>Display completion message:
1063
+
1064
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1065
+
1066
+ ## Project Documentation Complete! ✓
1067
+
1068
+ **Location:** {{output_folder}}/
1069
+
1070
+ **Master Index:** {{output_folder}}/index.md
1071
+ 👆 This is your primary entry point for AI-assisted development
1072
+
1073
+ **Generated Documentation:**
1074
+ {{generated_files_list}}
1075
+
1076
+ **Next Steps:**
1077
+
1078
+ 1. Review the index.md to familiarize yourself with the documentation structure
1079
+ 2. When creating a brownfield PRD, point the PRD workflow to: {{output_folder}}/index.md
1080
+ 3. For UI-only features: Reference {{output_folder}}/architecture-{{ui_part_id}}.md
1081
+ 4. For API-only features: Reference {{output_folder}}/architecture-{{api_part_id}}.md
1082
+ 5. For full-stack features: Reference both part architectures + integration-architecture.md
1083
+
1084
+ **Verification Recap:**
1085
+
1086
+ - Tests/extractions executed: {{verification_summary}}
1087
+ - Outstanding risks or follow-ups: {{open_risks}}
1088
+ - Recommended next checks before PR: {{next_checks}}
1089
+
1090
+ **Brownfield PRD Command:**
1091
+ When ready to plan new features, run the PRD workflow and provide this index as input.
1092
+
1093
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1094
+ </action>
1095
+
1096
+ <action>FINALIZE state file:
1097
+
1098
+ - Add to completed_steps: {"step": "step_12", "status": "completed", "timestamp": "{{now}}", "summary": "Workflow complete"}
1099
+ - Update timestamps.completed = "{{now}}"
1100
+ - Update current_step = "completed"
1101
+ - Write final state file
1102
+ </action>
1103
+
1104
+ <action>Display: "State file saved: {{output_folder}}/project-scan-report.json"</action>
1105
+
1106
+ </workflow>