bmad-method 6.0.4 → 6.0.5-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (252) hide show
  1. package/.augment/code_review_guidelines.yaml +2 -42
  2. package/.claude/skills/bmad-os-findings-triage/SKILL.md +6 -0
  3. package/.claude/skills/bmad-os-findings-triage/prompts/agent-prompt.md +104 -0
  4. package/.claude/skills/bmad-os-findings-triage/prompts/instructions.md +286 -0
  5. package/.claude/skills/bmad-os-review-pr/SKILL.md +1 -1
  6. package/.claude/skills/bmad-os-review-pr/prompts/instructions.md +63 -6
  7. package/.claude/skills/bmad-os-review-prompt/SKILL.md +177 -0
  8. package/.github/workflows/publish.yaml +243 -0
  9. package/CONTRIBUTING.md +1 -1
  10. package/README_CN.md +121 -0
  11. package/docs/_STYLE_GUIDE.md +10 -10
  12. package/docs/explanation/brainstorming.md +1 -1
  13. package/docs/explanation/party-mode.md +1 -1
  14. package/docs/explanation/preventing-agent-conflicts.md +1 -1
  15. package/docs/explanation/project-context.md +15 -15
  16. package/docs/explanation/quick-flow.md +9 -9
  17. package/docs/how-to/established-projects.md +7 -7
  18. package/docs/how-to/get-answers-about-bmad.md +2 -2
  19. package/docs/how-to/install-bmad.md +16 -6
  20. package/docs/how-to/project-context.md +2 -2
  21. package/docs/how-to/quick-fixes.md +5 -5
  22. package/docs/how-to/shard-large-documents.md +1 -1
  23. package/docs/how-to/upgrade-to-v6.md +8 -5
  24. package/docs/index.md +1 -1
  25. package/docs/reference/agents.md +14 -14
  26. package/docs/reference/commands.md +64 -70
  27. package/docs/reference/testing.md +1 -1
  28. package/docs/reference/workflow-map.md +19 -19
  29. package/docs/tutorials/getting-started.md +34 -34
  30. package/docs/zh-cn/404.md +9 -0
  31. package/docs/zh-cn/_STYLE_GUIDE.md +370 -0
  32. package/docs/zh-cn/explanation/advanced-elicitation.md +62 -0
  33. package/docs/zh-cn/explanation/adversarial-review.md +71 -0
  34. package/docs/zh-cn/explanation/brainstorming.md +43 -0
  35. package/docs/zh-cn/explanation/established-projects-faq.md +60 -0
  36. package/docs/zh-cn/explanation/party-mode.md +79 -0
  37. package/docs/zh-cn/explanation/preventing-agent-conflicts.md +137 -0
  38. package/docs/zh-cn/explanation/project-context.md +176 -0
  39. package/docs/zh-cn/explanation/quick-flow.md +93 -0
  40. package/docs/zh-cn/explanation/why-solutioning-matters.md +90 -0
  41. package/docs/zh-cn/how-to/customize-bmad.md +182 -0
  42. package/docs/zh-cn/how-to/established-projects.md +134 -0
  43. package/docs/zh-cn/how-to/get-answers-about-bmad.md +144 -0
  44. package/docs/zh-cn/how-to/install-bmad.md +105 -0
  45. package/docs/zh-cn/how-to/non-interactive-installation.md +181 -0
  46. package/docs/zh-cn/how-to/project-context.md +152 -0
  47. package/docs/zh-cn/how-to/quick-fixes.md +140 -0
  48. package/docs/zh-cn/how-to/shard-large-documents.md +86 -0
  49. package/docs/zh-cn/how-to/upgrade-to-v6.md +120 -0
  50. package/docs/zh-cn/index.md +69 -0
  51. package/docs/zh-cn/reference/agents.md +41 -0
  52. package/docs/zh-cn/reference/commands.md +166 -0
  53. package/docs/zh-cn/reference/modules.md +94 -0
  54. package/docs/zh-cn/reference/testing.md +122 -0
  55. package/docs/zh-cn/reference/workflow-map.md +104 -0
  56. package/docs/zh-cn/roadmap.mdx +152 -0
  57. package/docs/zh-cn/tutorials/getting-started.md +300 -0
  58. package/package.json +1 -1
  59. package/src/bmm/agents/analyst.agent.yaml +1 -1
  60. package/src/bmm/agents/bmad-skill-manifest.yaml +39 -0
  61. package/src/bmm/agents/dev.agent.yaml +2 -2
  62. package/src/bmm/agents/pm.agent.yaml +1 -1
  63. package/src/bmm/agents/qa.agent.yaml +1 -1
  64. package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +6 -2
  65. package/src/bmm/agents/sm.agent.yaml +4 -4
  66. package/src/bmm/agents/tech-writer/bmad-skill-manifest.yaml +3 -0
  67. package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +1 -1
  68. package/src/bmm/module-help.csv +11 -10
  69. package/src/bmm/workflows/1-analysis/create-product-brief/bmad-skill-manifest.yaml +3 -0
  70. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +1 -1
  71. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +1 -1
  72. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +1 -1
  73. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +1 -1
  74. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
  75. package/src/bmm/workflows/1-analysis/research/bmad-skill-manifest.yaml +14 -0
  76. package/src/bmm/workflows/2-plan-workflows/create-prd/bmad-skill-manifest.yaml +14 -0
  77. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +1 -1
  78. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +1 -1
  79. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +1 -1
  80. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +1 -1
  81. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +1 -1
  82. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +1 -1
  83. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +1 -1
  84. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +1 -1
  85. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +1 -1
  86. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +1 -1
  87. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +1 -1
  88. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +1 -1
  89. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +1 -1
  90. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +1 -1
  91. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +1 -1
  92. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +1 -1
  93. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +1 -1
  94. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +1 -1
  95. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +1 -1
  96. package/src/bmm/workflows/2-plan-workflows/create-ux-design/bmad-skill-manifest.yaml +3 -0
  97. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +1 -1
  98. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +2 -2
  99. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +2 -2
  100. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +2 -2
  101. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +2 -2
  102. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +2 -2
  103. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +2 -2
  104. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +2 -2
  105. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +2 -2
  106. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +2 -2
  107. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +2 -2
  108. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +2 -2
  109. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -1
  110. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/bmad-skill-manifest.yaml +3 -0
  111. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
  112. package/src/bmm/workflows/3-solutioning/create-architecture/bmad-skill-manifest.yaml +3 -0
  113. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +2 -2
  114. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +2 -2
  115. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +2 -2
  116. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +2 -2
  117. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +2 -2
  118. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +2 -2
  119. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
  120. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/bmad-skill-manifest.yaml +3 -0
  121. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +1 -1
  122. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +1 -1
  123. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +1 -1
  124. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +2 -2
  125. package/src/bmm/workflows/4-implementation/code-review/bmad-skill-manifest.yaml +3 -0
  126. package/src/bmm/workflows/4-implementation/code-review/discover-inputs.md +88 -0
  127. package/src/bmm/workflows/4-implementation/code-review/workflow.md +271 -0
  128. package/src/bmm/workflows/4-implementation/correct-course/bmad-skill-manifest.yaml +3 -0
  129. package/src/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
  130. package/src/bmm/workflows/4-implementation/correct-course/{instructions.md → workflow.md} +79 -12
  131. package/src/bmm/workflows/4-implementation/create-story/bmad-skill-manifest.yaml +3 -0
  132. package/src/bmm/workflows/4-implementation/create-story/checklist.md +9 -10
  133. package/src/bmm/workflows/4-implementation/create-story/discover-inputs.md +88 -0
  134. package/src/bmm/workflows/4-implementation/create-story/workflow.md +388 -0
  135. package/src/bmm/workflows/4-implementation/dev-story/bmad-skill-manifest.yaml +3 -0
  136. package/src/bmm/workflows/4-implementation/dev-story/{instructions.xml → workflow.md} +49 -2
  137. package/src/bmm/workflows/4-implementation/retrospective/bmad-skill-manifest.yaml +3 -0
  138. package/src/bmm/workflows/4-implementation/retrospective/{instructions.md → workflow.md} +64 -23
  139. package/src/bmm/workflows/4-implementation/sprint-planning/bmad-skill-manifest.yaml +3 -0
  140. package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +1 -0
  141. package/src/bmm/workflows/4-implementation/sprint-planning/{instructions.md → workflow.md} +55 -10
  142. package/src/bmm/workflows/4-implementation/sprint-status/bmad-skill-manifest.yaml +3 -0
  143. package/src/bmm/workflows/4-implementation/sprint-status/{instructions.md → workflow.md} +45 -8
  144. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md +6 -0
  145. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/bmad-skill-manifest.yaml +1 -0
  146. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-01-clarify-and-route.md +54 -0
  147. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-02-plan.md +39 -0
  148. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-03-implement.md +35 -0
  149. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md +55 -0
  150. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md +19 -0
  151. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/tech-spec-template.md +90 -0
  152. package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/workflow.md +84 -0
  153. package/src/bmm/workflows/bmad-quick-flow/quick-dev/bmad-skill-manifest.yaml +3 -0
  154. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +8 -14
  155. package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +1 -1
  156. package/src/bmm/workflows/bmad-quick-flow/quick-spec/bmad-skill-manifest.yaml +3 -0
  157. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +4 -6
  158. package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +1 -1
  159. package/src/bmm/workflows/document-project/bmad-skill-manifest.yaml +3 -0
  160. package/src/bmm/workflows/document-project/instructions.md +5 -7
  161. package/src/bmm/workflows/document-project/workflow.md +39 -0
  162. package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -1
  163. package/src/bmm/workflows/document-project/workflows/deep-dive-workflow.md +42 -0
  164. package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1
  165. package/src/bmm/workflows/document-project/workflows/full-scan-workflow.md +42 -0
  166. package/src/bmm/workflows/generate-project-context/bmad-skill-manifest.yaml +3 -0
  167. package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
  168. package/src/bmm/workflows/qa-generate-e2e-tests/bmad-skill-manifest.yaml +3 -0
  169. package/src/bmm/workflows/qa-generate-e2e-tests/checklist.md +1 -1
  170. package/src/bmm/workflows/qa-generate-e2e-tests/{instructions.md → workflow.md} +40 -7
  171. package/src/core/agents/bmad-master.agent.yaml +1 -1
  172. package/src/core/agents/bmad-skill-manifest.yaml +3 -0
  173. package/src/core/module-help.csv +3 -3
  174. package/src/core/module.yaml +1 -1
  175. package/src/core/tasks/bmad-help/SKILL.md +6 -0
  176. package/src/core/tasks/bmad-help/bmad-skill-manifest.yaml +1 -0
  177. package/src/core/tasks/{help.md → bmad-help/workflow.md} +6 -4
  178. package/src/core/tasks/bmad-review-adversarial-general/SKILL.md +6 -0
  179. package/src/core/tasks/bmad-review-adversarial-general/bmad-skill-manifest.yaml +1 -0
  180. package/src/core/tasks/bmad-review-adversarial-general/workflow.md +32 -0
  181. package/src/core/tasks/bmad-review-edge-case-hunter/SKILL.md +6 -0
  182. package/src/core/tasks/bmad-review-edge-case-hunter/bmad-skill-manifest.yaml +1 -0
  183. package/src/core/tasks/bmad-review-edge-case-hunter/workflow.md +62 -0
  184. package/src/core/tasks/bmad-skill-manifest.yaml +19 -0
  185. package/src/core/workflows/advanced-elicitation/bmad-skill-manifest.yaml +3 -0
  186. package/src/core/workflows/advanced-elicitation/workflow.md +138 -0
  187. package/src/core/workflows/brainstorming/bmad-skill-manifest.yaml +3 -0
  188. package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +1 -1
  189. package/src/core/workflows/brainstorming/workflow.md +1 -1
  190. package/src/core/workflows/party-mode/bmad-skill-manifest.yaml +3 -0
  191. package/src/utility/agent-components/activation-steps.txt +2 -2
  192. package/src/utility/agent-components/handler-multi.txt +1 -2
  193. package/test/adversarial-review-tests/README.md +3 -3
  194. package/test/adversarial-review-tests/test-cases.yaml +2 -2
  195. package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +1 -1
  196. package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +1 -1
  197. package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +1 -2
  198. package/test/fixtures/file-refs-csv/valid/bmm-style.csv +1 -1
  199. package/test/test-file-refs-csv.js +1 -1
  200. package/test/test-install-to-bmad.js +154 -0
  201. package/test/test-installation-components.js +1586 -2
  202. package/test/test-workflow-path-regex.js +88 -0
  203. package/tools/cli/installers/lib/core/installer.js +34 -1
  204. package/tools/cli/installers/lib/core/manifest-generator.js +328 -35
  205. package/tools/cli/installers/lib/ide/_base-ide.js +24 -15
  206. package/tools/cli/installers/lib/ide/_config-driven.js +472 -53
  207. package/tools/cli/installers/lib/ide/manager.js +23 -61
  208. package/tools/cli/installers/lib/ide/platform-codes.yaml +108 -30
  209. package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +1 -0
  210. package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +7 -0
  211. package/tools/cli/installers/lib/ide/shared/path-utils.js +68 -3
  212. package/tools/cli/installers/lib/ide/shared/skill-manifest.js +90 -0
  213. package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +2 -0
  214. package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +6 -145
  215. package/tools/cli/installers/lib/modules/manager.js +9 -132
  216. package/tools/cli/lib/agent/compiler.js +1 -10
  217. package/tools/cli/lib/agent-analyzer.js +2 -14
  218. package/tools/cli/lib/yaml-xml-builder.js +1 -18
  219. package/tools/docs/native-skills-migration-checklist.md +281 -0
  220. package/tools/platform-codes.yaml +1 -1
  221. package/tools/schema/agent.js +1 -3
  222. package/tools/validate-file-refs.js +2 -0
  223. package/website/astro.config.mjs +24 -3
  224. package/website/src/content/config.ts +2 -1
  225. package/website/src/content/i18n/zh-CN.json +28 -0
  226. package/src/bmm/workflows/4-implementation/code-review/instructions.xml +0 -227
  227. package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +0 -43
  228. package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +0 -53
  229. package/src/bmm/workflows/4-implementation/create-story/instructions.xml +0 -346
  230. package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +0 -52
  231. package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +0 -20
  232. package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +0 -52
  233. package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +0 -47
  234. package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +0 -25
  235. package/src/bmm/workflows/document-project/workflow.yaml +0 -22
  236. package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
  237. package/src/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
  238. package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +0 -42
  239. package/src/core/tasks/review-adversarial-general.xml +0 -49
  240. package/src/core/tasks/review-edge-case-hunter.xml +0 -63
  241. package/src/core/tasks/workflow.xml +0 -235
  242. package/src/core/workflows/advanced-elicitation/workflow.xml +0 -118
  243. package/src/utility/agent-components/handler-validate-workflow.txt +0 -7
  244. package/src/utility/agent-components/handler-workflow.txt +0 -10
  245. package/tools/cli/installers/lib/ide/codex.js +0 -440
  246. package/tools/cli/installers/lib/ide/github-copilot.js +0 -699
  247. package/tools/cli/installers/lib/ide/kilo.js +0 -269
  248. package/tools/cli/installers/lib/ide/rovodev.js +0 -257
  249. package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +0 -14
  250. package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +0 -15
  251. package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +0 -13
  252. package/tools/cli/installers/lib/ide/templates/workflow-commander.md +0 -5
@@ -9,9 +9,9 @@ The BMad Method (BMM) is a module in the BMad Ecosystem, targeted at following t
9
9
 
10
10
  The rationale and concepts come from agile methodologies that have been used across the industry with great success as a mental framework.
11
11
 
12
- If at any time you are unsure what to do, the `/bmad-help` command will help you stay on track or know what to do next. You can always refer to this for reference also - but /bmad-help is fully interactive and much quicker if you have already installed the BMad Method. Additionally, if you are using different modules that have extended the BMad Method or added other complementary non-extension modules - the /bmad-help evolves to know all that is available to give you the best in-the-moment advice.
12
+ If at any time you are unsure what to do, the `bmad-help` skill will help you stay on track or know what to do next. You can always refer to this for reference also - but `bmad-help` is fully interactive and much quicker if you have already installed the BMad Method. Additionally, if you are using different modules that have extended the BMad Method or added other complementary non-extension modules - `bmad-help` evolves to know all that is available to give you the best in-the-moment advice.
13
13
 
14
- Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu.
14
+ Final important note: Every workflow below can be run directly with your tool of choice via skill or by loading an agent first and using the entry from the agents menu.
15
15
 
16
16
  <iframe src="/workflow-map-diagram.html" title="BMad Method Workflow Map Diagram" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
17
17
 
@@ -26,8 +26,8 @@ Explore the problem space and validate ideas before committing to planning.
26
26
  | Workflow | Purpose | Produces |
27
27
  | ------------------------------- | -------------------------------------------------------------------------- | ------------------------- |
28
28
  | `bmad-brainstorming` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` |
29
- | `bmad-bmm-research` | Validate market, technical, or domain assumptions | Research findings |
30
- | `bmad-bmm-create-product-brief` | Capture strategic vision | `product-brief.md` |
29
+ | `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validate market, technical, or domain assumptions | Research findings |
30
+ | `bmad-create-product-brief` | Capture strategic vision | `product-brief.md` |
31
31
 
32
32
  ## Phase 2: Planning
33
33
 
@@ -35,8 +35,8 @@ Define what to build and for whom.
35
35
 
36
36
  | Workflow | Purpose | Produces |
37
37
  | --------------------------- | ---------------------------------------- | ------------ |
38
- | `bmad-bmm-create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
39
- | `bmad-bmm-create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
38
+ | `bmad-create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
39
+ | `bmad-create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
40
40
 
41
41
  ## Phase 3: Solutioning
42
42
 
@@ -44,9 +44,9 @@ Decide how to build it and break work into stories.
44
44
 
45
45
  | Workflow | Purpose | Produces |
46
46
  | ----------------------------------------- | ------------------------------------------ | --------------------------- |
47
- | `bmad-bmm-create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
48
- | `bmad-bmm-create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
49
- | `bmad-bmm-check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
47
+ | `bmad-create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
48
+ | `bmad-create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
49
+ | `bmad-check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
50
50
 
51
51
  ## Phase 4: Implementation
52
52
 
@@ -54,13 +54,13 @@ Build it, one story at a time. Coming soon, full phase 4 automation!
54
54
 
55
55
  | Workflow | Purpose | Produces |
56
56
  | -------------------------- | ------------------------------------------------------------------------ | -------------------------------- |
57
- | `bmad-bmm-sprint-planning` | Initialize tracking (once per project to sequence the dev cycle) | `sprint-status.yaml` |
58
- | `bmad-bmm-create-story` | Prepare next story for implementation | `story-[slug].md` |
59
- | `bmad-bmm-dev-story` | Implement the story | Working code + tests |
60
- | `bmad-bmm-code-review` | Validate implementation quality | Approved or changes requested |
61
- | `bmad-bmm-correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
62
- | `bmad-bmm-automate` | Generate tests for existing features - Use after a full epic is complete | End to End UI Focused Test suite |
63
- | `bmad-bmm-retrospective` | Review after epic completion | Lessons learned |
57
+ | `bmad-sprint-planning` | Initialize tracking (once per project to sequence the dev cycle) | `sprint-status.yaml` |
58
+ | `bmad-create-story` | Prepare next story for implementation | `story-[slug].md` |
59
+ | `bmad-dev-story` | Implement the story | Working code + tests |
60
+ | `bmad-code-review` | Validate implementation quality | Approved or changes requested |
61
+ | `bmad-correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
62
+ | `bmad-sprint-status` | Track sprint progress and story status | Sprint status update |
63
+ | `bmad-retrospective` | Review after epic completion | Lessons learned |
64
64
 
65
65
  ## Quick Flow (Parallel Track)
66
66
 
@@ -68,8 +68,8 @@ Skip phases 1-3 for small, well-understood work.
68
68
 
69
69
  | Workflow | Purpose | Produces |
70
70
  | --------------------- | ------------------------------------------ | --------------------------------------------- |
71
- | `bmad-bmm-quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) |
72
- | `bmad-bmm-quick-dev` | Implement from spec or direct instructions | Working code + tests |
71
+ | `bmad-quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) |
72
+ | `bmad-quick-dev` | Implement from spec or direct instructions | Working code + tests |
73
73
 
74
74
  ## Context Management
75
75
 
@@ -84,6 +84,6 @@ Create `project-context.md` to ensure AI agents follow your project's rules and
84
84
  **How to create it:**
85
85
 
86
86
  - **Manually** — Create `_bmad-output/project-context.md` with your technology stack and implementation rules
87
- - **Generate it** — Run `/bmad-bmm-generate-project-context` to auto-generate from your architecture or codebase
87
+ - **Generate it** — Run `bmad-generate-project-context` to auto-generate from your architecture or codebase
88
88
 
89
89
  [**Learn more about project-context.md**](../explanation/project-context.md)
@@ -37,16 +37,16 @@ Build software faster using AI-powered workflows with specialized agents that gu
37
37
 
38
38
  ### How to Use BMad-Help
39
39
 
40
- Run it in your AI IDE with just the slash command:
40
+ Run it in your AI IDE by invoking the skill:
41
41
 
42
42
  ```
43
- /bmad-help
43
+ bmad-help
44
44
  ```
45
45
 
46
46
  Or combine it with a question for context-aware guidance:
47
47
 
48
48
  ```
49
- /bmad-help I have an idea for a SaaS product, I already know all the features I want. where do I get started?
49
+ bmad-help I have an idea for a SaaS product, I already know all the features I want. where do I get started?
50
50
  ```
51
51
 
52
52
  BMad-Help will respond with:
@@ -112,7 +112,7 @@ BMad-Help will detect what you've completed and recommend exactly what to do nex
112
112
  :::
113
113
 
114
114
  :::note[How to Load Agents and Run Workflows]
115
- Each workflow has a **slash command** you run in your IDE (e.g., `/bmad-bmm-create-prd`). Running a workflow command automatically loads the appropriate agent — you don't need to load agents separately. You can also load an agent directly for general conversation (e.g., `/bmad-agent-bmm-pm` for the PM agent).
115
+ Each workflow has a **skill** you invoke in your IDE (e.g., `/bmad-create-prd`). Running a workflow skill automatically loads the appropriate agent — you don't need to load agents separately. You can also invoke an agent directly for general conversation (e.g., `/bmad-pm` for the PM agent).
116
116
  :::
117
117
 
118
118
  :::caution[Fresh Chats]
@@ -126,35 +126,35 @@ Work through phases 1-3. **Use fresh chats for each workflow.**
126
126
  :::tip[Project Context (Optional)]
127
127
  Before starting, consider creating `project-context.md` to document your technical preferences and implementation rules. This ensures all AI agents follow your conventions throughout the project.
128
128
 
129
- Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `/bmad-bmm-generate-project-context`. [Learn more](../explanation/project-context.md).
129
+ Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `/bmad-generate-project-context`. [Learn more](../explanation/project-context.md).
130
130
  :::
131
131
 
132
132
  ### Phase 1: Analysis (Optional)
133
133
 
134
134
  All workflows in this phase are optional:
135
135
  - **brainstorming** (`/bmad-brainstorming`) — Guided ideation
136
- - **research** (`/bmad-bmm-research`) — Market and technical research
137
- - **create-product-brief** (`/bmad-bmm-create-product-brief`) — Recommended foundation document
136
+ - **research** (`/bmad-research`) — Market and technical research
137
+ - **create-product-brief** (`/bmad-create-product-brief`) — Recommended foundation document
138
138
 
139
139
  ### Phase 2: Planning (Required)
140
140
 
141
141
  **For BMad Method and Enterprise tracks:**
142
- 1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
143
- 2. Run the `prd` workflow (`/bmad-bmm-create-prd`)
142
+ 1. Invoke the **PM agent** (`/bmad-pm`) in a new chat
143
+ 2. Run the `bmad-create-prd` workflow (`/bmad-create-prd`)
144
144
  3. Output: `PRD.md`
145
145
 
146
146
  **For Quick Flow track:**
147
- - Use the `quick-spec` workflow (`/bmad-bmm-quick-spec`) instead of PRD, then skip to implementation
147
+ - Use the `bmad-quick-spec` workflow (`/bmad-quick-spec`) instead of PRD, then skip to implementation
148
148
 
149
149
  :::note[UX Design (Optional)]
150
- If your project has a user interface, load the **UX-Designer agent** (`/bmad-agent-bmm-ux-designer`) and run the UX design workflow (`/bmad-bmm-create-ux-design`) after creating your PRD.
150
+ If your project has a user interface, invoke the **UX-Designer agent** (`/bmad-ux-designer`) and run the UX design workflow (`/bmad-create-ux-design`) after creating your PRD.
151
151
  :::
152
152
 
153
153
  ### Phase 3: Solutioning (BMad Method/Enterprise)
154
154
 
155
155
  **Create Architecture**
156
- 1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
157
- 2. Run `create-architecture` (`/bmad-bmm-create-architecture`)
156
+ 1. Invoke the **Architect agent** (`/bmad-architect`) in a new chat
157
+ 2. Run `bmad-create-architecture` (`/bmad-create-architecture`)
158
158
  3. Output: Architecture document with technical decisions
159
159
 
160
160
  **Create Epics and Stories**
@@ -163,13 +163,13 @@ If your project has a user interface, load the **UX-Designer agent** (`/bmad-age
163
163
  Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down.
164
164
  :::
165
165
 
166
- 1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
167
- 2. Run `create-epics-and-stories` (`/bmad-bmm-create-epics-and-stories`)
166
+ 1. Invoke the **PM agent** (`/bmad-pm`) in a new chat
167
+ 2. Run `bmad-create-epics-and-stories` (`/bmad-create-epics-and-stories`)
168
168
  3. The workflow uses both PRD and Architecture to create technically-informed stories
169
169
 
170
170
  **Implementation Readiness Check** *(Highly Recommended)*
171
- 1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
172
- 2. Run `check-implementation-readiness` (`/bmad-bmm-check-implementation-readiness`)
171
+ 1. Invoke the **Architect agent** (`/bmad-architect`) in a new chat
172
+ 2. Run `bmad-check-implementation-readiness` (`/bmad-check-implementation-readiness`)
173
173
  3. Validates cohesion across all planning documents
174
174
 
175
175
  ## Step 2: Build Your Project
@@ -178,7 +178,7 @@ Once planning is complete, move to implementation. **Each workflow should run in
178
178
 
179
179
  ### Initialize Sprint Planning
180
180
 
181
- Load the **SM agent** (`/bmad-agent-bmm-sm`) and run `sprint-planning` (`/bmad-bmm-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
181
+ Invoke the **SM agent** (`/bmad-sm`) and run `bmad-sprint-planning` (`/bmad-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
182
182
 
183
183
  ### The Build Cycle
184
184
 
@@ -186,11 +186,11 @@ For each story, repeat this cycle with fresh chats:
186
186
 
187
187
  | Step | Agent | Workflow | Command | Purpose |
188
188
  | ---- | ----- | -------------- | -------------------------- | ---------------------------------- |
189
- | 1 | SM | `create-story` | `/bmad-bmm-create-story` | Create story file from epic |
190
- | 2 | DEV | `dev-story` | `/bmad-bmm-dev-story` | Implement the story |
191
- | 3 | DEV | `code-review` | `/bmad-bmm-code-review` | Quality validation *(recommended)* |
189
+ | 1 | SM | `bmad-create-story` | `/bmad-create-story` | Create story file from epic |
190
+ | 2 | DEV | `bmad-dev-story` | `/bmad-dev-story` | Implement the story |
191
+ | 3 | DEV | `bmad-code-review` | `/bmad-code-review` | Quality validation *(recommended)* |
192
192
 
193
- After completing all stories in an epic, load the **SM agent** (`/bmad-agent-bmm-sm`) and run `retrospective` (`/bmad-bmm-retrospective`).
193
+ After completing all stories in an epic, invoke the **SM agent** (`/bmad-sm`) and run `bmad-retrospective` (`/bmad-retrospective`).
194
194
 
195
195
  ## What You've Accomplished
196
196
 
@@ -221,16 +221,16 @@ your-project/
221
221
 
222
222
  | Workflow | Command | Agent | Purpose |
223
223
  | ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- |
224
- | **`help`** ⭐ | `/bmad-help` | Any | **Your intelligent guide — ask anything!** |
225
- | `prd` | `/bmad-bmm-create-prd` | PM | Create Product Requirements Document |
226
- | `create-architecture` | `/bmad-bmm-create-architecture` | Architect | Create architecture document |
227
- | `generate-project-context` | `/bmad-bmm-generate-project-context` | Analyst | Create project context file |
228
- | `create-epics-and-stories` | `/bmad-bmm-create-epics-and-stories` | PM | Break down PRD into epics |
229
- | `check-implementation-readiness` | `/bmad-bmm-check-implementation-readiness` | Architect | Validate planning cohesion |
230
- | `sprint-planning` | `/bmad-bmm-sprint-planning` | SM | Initialize sprint tracking |
231
- | `create-story` | `/bmad-bmm-create-story` | SM | Create a story file |
232
- | `dev-story` | `/bmad-bmm-dev-story` | DEV | Implement a story |
233
- | `code-review` | `/bmad-bmm-code-review` | DEV | Review implemented code |
224
+ | **`bmad-help`** ⭐ | `/bmad-help` | Any | **Your intelligent guide — ask anything!** |
225
+ | `bmad-create-prd` | `/bmad-create-prd` | PM | Create Product Requirements Document |
226
+ | `bmad-create-architecture` | `/bmad-create-architecture` | Architect | Create architecture document |
227
+ | `bmad-generate-project-context` | `/bmad-generate-project-context` | Analyst | Create project context file |
228
+ | `bmad-create-epics-and-stories` | `/bmad-create-epics-and-stories` | PM | Break down PRD into epics |
229
+ | `bmad-check-implementation-readiness` | `/bmad-check-implementation-readiness` | Architect | Validate planning cohesion |
230
+ | `bmad-sprint-planning` | `/bmad-sprint-planning` | SM | Initialize sprint tracking |
231
+ | `bmad-create-story` | `/bmad-create-story` | SM | Create a story file |
232
+ | `bmad-dev-story` | `/bmad-dev-story` | DEV | Implement a story |
233
+ | `bmad-code-review` | `/bmad-code-review` | DEV | Review implemented code |
234
234
 
235
235
  ## Common Questions
236
236
 
@@ -238,10 +238,10 @@ your-project/
238
238
  Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.
239
239
 
240
240
  **Can I change my plan later?**
241
- Yes. The SM agent has a `correct-course` workflow (`/bmad-bmm-correct-course`) for handling scope changes.
241
+ Yes. The SM agent has a `bmad-correct-course` workflow (`/bmad-correct-course`) for handling scope changes.
242
242
 
243
243
  **What if I want to brainstorm first?**
244
- Load the Analyst agent (`/bmad-agent-bmm-analyst`) and run `brainstorming` (`/bmad-brainstorming`) before starting your PRD.
244
+ Invoke the Analyst agent (`/bmad-analyst`) and run `bmad-brainstorming` (`/bmad-brainstorming`) before starting your PRD.
245
245
 
246
246
  **Do I need to follow a strict order?**
247
247
  Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.
@@ -0,0 +1,9 @@
1
+ ---
2
+ title: 页面未找到
3
+ template: splash
4
+ ---
5
+
6
+
7
+ 您查找的页面不存在或已被移动。
8
+
9
+ [返回首页](./index.md)
@@ -0,0 +1,370 @@
1
+ ---
2
+ title: "Documentation Style Guide"
3
+ description: Project-specific documentation conventions based on Google style and Diataxis structure
4
+ ---
5
+
6
+ This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
7
+
8
+ ## Project-Specific Rules
9
+
10
+ | Rule | Specification |
11
+ | -------------------------------- | ---------------------------------------- |
12
+ | No horizontal rules (`---`) | Fragments reading flow |
13
+ | No `####` headers | Use bold text or admonitions instead |
14
+ | No "Related" or "Next:" sections | Sidebar handles navigation |
15
+ | No deeply nested lists | Break into sections instead |
16
+ | No code blocks for non-code | Use admonitions for dialogue examples |
17
+ | No bold paragraphs for callouts | Use admonitions instead |
18
+ | 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
19
+ | Table cells / list items | 1-2 sentences max |
20
+ | Header budget | 8-12 `##` per doc; 2-3 `###` per section |
21
+
22
+ ## Admonitions (Starlight Syntax)
23
+
24
+ ```md
25
+ :::tip[Title]
26
+ Shortcuts, best practices
27
+ :::
28
+
29
+ :::note[Title]
30
+ Context, definitions, examples, prerequisites
31
+ :::
32
+
33
+ :::caution[Title]
34
+ Caveats, potential issues
35
+ :::
36
+
37
+ :::danger[Title]
38
+ Critical warnings only — data loss, security issues
39
+ :::
40
+ ```
41
+
42
+ ### Standard Uses
43
+
44
+ | Admonition | Use For |
45
+ | ------------------------ | ----------------------------- |
46
+ | `:::note[Prerequisites]` | Dependencies before starting |
47
+ | `:::tip[Quick Path]` | TL;DR summary at document top |
48
+ | `:::caution[Important]` | Critical caveats |
49
+ | `:::note[Example]` | Command/response examples |
50
+
51
+ ## Standard Table Formats
52
+
53
+ **Phases:**
54
+
55
+ ```md
56
+ | Phase | Name | What Happens |
57
+ | ----- | -------- | -------------------------------------------- |
58
+ | 1 | Analysis | Brainstorm, research *(optional)* |
59
+ | 2 | Planning | Requirements — PRD or tech-spec *(required)* |
60
+ ```
61
+
62
+ **Commands:**
63
+
64
+ ```md
65
+ | Command | Agent | Purpose |
66
+ | ------------ | ------- | ------------------------------------ |
67
+ | `brainstorm` | Analyst | Brainstorm a new project |
68
+ | `prd` | PM | Create Product Requirements Document |
69
+ ```
70
+
71
+ ## Folder Structure Blocks
72
+
73
+ Show in "What You've Accomplished" sections:
74
+
75
+ ````md
76
+ ```
77
+ your-project/
78
+ ├── _bmad/ # BMad configuration
79
+ ├── _bmad-output/
80
+ │ ├── planning-artifacts/
81
+ │ │ └── PRD.md # Your requirements document
82
+ │ ├── implementation-artifacts/
83
+ │ └── project-context.md # Implementation rules (optional)
84
+ └── ...
85
+ ```
86
+ ````
87
+
88
+ ## Tutorial Structure
89
+
90
+ ```text
91
+ 1. Title + Hook (1-2 sentences describing outcome)
92
+ 2. Version/Module Notice (info or warning admonition) (optional)
93
+ 3. What You'll Learn (bullet list of outcomes)
94
+ 4. Prerequisites (info admonition)
95
+ 5. Quick Path (tip admonition - TL;DR summary)
96
+ 6. Understanding [Topic] (context before steps - tables for phases/agents)
97
+ 7. Installation (optional)
98
+ 8. Step 1: [First Major Task]
99
+ 9. Step 2: [Second Major Task]
100
+ 10. Step 3: [Third Major Task]
101
+ 11. What You've Accomplished (summary + folder structure)
102
+ 12. Quick Reference (commands table)
103
+ 13. Common Questions (FAQ format)
104
+ 14. Getting Help (community links)
105
+ 15. Key Takeaways (tip admonition)
106
+ ```
107
+
108
+ ### Tutorial Checklist
109
+
110
+ - [ ] Hook describes outcome in 1-2 sentences
111
+ - [ ] "What You'll Learn" section present
112
+ - [ ] Prerequisites in admonition
113
+ - [ ] Quick Path TL;DR admonition at top
114
+ - [ ] Tables for phases, commands, agents
115
+ - [ ] "What You've Accomplished" section present
116
+ - [ ] Quick Reference table present
117
+ - [ ] Common Questions section present
118
+ - [ ] Getting Help section present
119
+ - [ ] Key Takeaways admonition at end
120
+
121
+ ## How-To Structure
122
+
123
+ ```text
124
+ 1. Title + Hook (one sentence: "Use the `X` workflow to...")
125
+ 2. When to Use This (bullet list of scenarios)
126
+ 3. When to Skip This (optional)
127
+ 4. Prerequisites (note admonition)
128
+ 5. Steps (numbered ### subsections)
129
+ 6. What You Get (output/artifacts produced)
130
+ 7. Example (optional)
131
+ 8. Tips (optional)
132
+ 9. Next Steps (optional)
133
+ ```
134
+
135
+ ### How-To Checklist
136
+
137
+ - [ ] Hook starts with "Use the `X` workflow to..."
138
+ - [ ] "When to Use This" has 3-5 bullet points
139
+ - [ ] Prerequisites listed
140
+ - [ ] Steps are numbered `###` subsections with action verbs
141
+ - [ ] "What You Get" describes output artifacts
142
+
143
+ ## Explanation Structure
144
+
145
+ ### Types
146
+
147
+ | Type | Example |
148
+ | ----------------- | ----------------------------- |
149
+ | **Index/Landing** | `core-concepts/index.md` |
150
+ | **Concept** | `what-are-agents.md` |
151
+ | **Feature** | `quick-flow.md` |
152
+ | **Philosophy** | `why-solutioning-matters.md` |
153
+ | **FAQ** | `established-projects-faq.md` |
154
+
155
+ ### General Template
156
+
157
+ ```text
158
+ 1. Title + Hook (1-2 sentences)
159
+ 2. Overview/Definition (what it is, why it matters)
160
+ 3. Key Concepts (### subsections)
161
+ 4. Comparison Table (optional)
162
+ 5. When to Use / When Not to Use (optional)
163
+ 6. Diagram (optional - mermaid, 1 per doc max)
164
+ 7. Next Steps (optional)
165
+ ```
166
+
167
+ ### Index/Landing Pages
168
+
169
+ ```text
170
+ 1. Title + Hook (one sentence)
171
+ 2. Content Table (links with descriptions)
172
+ 3. Getting Started (numbered list)
173
+ 4. Choose Your Path (optional - decision tree)
174
+ ```
175
+
176
+ ### Concept Explainers
177
+
178
+ ```text
179
+ 1. Title + Hook (what it is)
180
+ 2. Types/Categories (### subsections) (optional)
181
+ 3. Key Differences Table
182
+ 4. Components/Parts
183
+ 5. Which Should You Use?
184
+ 6. Creating/Customizing (pointer to how-to guides)
185
+ ```
186
+
187
+ ### Feature Explainers
188
+
189
+ ```text
190
+ 1. Title + Hook (what it does)
191
+ 2. Quick Facts (optional - "Perfect for:", "Time to:")
192
+ 3. When to Use / When Not to Use
193
+ 4. How It Works (mermaid diagram optional)
194
+ 5. Key Benefits
195
+ 6. Comparison Table (optional)
196
+ 7. When to Graduate/Upgrade (optional)
197
+ ```
198
+
199
+ ### Philosophy/Rationale Documents
200
+
201
+ ```text
202
+ 1. Title + Hook (the principle)
203
+ 2. The Problem
204
+ 3. The Solution
205
+ 4. Key Principles (### subsections)
206
+ 5. Benefits
207
+ 6. When This Applies
208
+ ```
209
+
210
+ ### Explanation Checklist
211
+
212
+ - [ ] Hook states what document explains
213
+ - [ ] Content in scannable `##` sections
214
+ - [ ] Comparison tables for 3+ options
215
+ - [ ] Diagrams have clear labels
216
+ - [ ] Links to how-to guides for procedural questions
217
+ - [ ] 2-3 admonitions max per document
218
+
219
+ ## Reference Structure
220
+
221
+ ### Types
222
+
223
+ | Type | Example |
224
+ | ----------------- | --------------------- |
225
+ | **Index/Landing** | `workflows/index.md` |
226
+ | **Catalog** | `agents/index.md` |
227
+ | **Deep-Dive** | `document-project.md` |
228
+ | **Configuration** | `core-tasks.md` |
229
+ | **Glossary** | `glossary/index.md` |
230
+ | **Comprehensive** | `bmgd-workflows.md` |
231
+
232
+ ### Reference Index Pages
233
+
234
+ ```text
235
+ 1. Title + Hook (one sentence)
236
+ 2. Content Sections (## for each category)
237
+ - Bullet list with links and descriptions
238
+ ```
239
+
240
+ ### Catalog Reference
241
+
242
+ ```text
243
+ 1. Title + Hook
244
+ 2. Items (## for each item)
245
+ - Brief description (one sentence)
246
+ - **Commands:** or **Key Info:** as flat list
247
+ 3. Universal/Shared (## section) (optional)
248
+ ```
249
+
250
+ ### Item Deep-Dive Reference
251
+
252
+ ```text
253
+ 1. Title + Hook (one sentence purpose)
254
+ 2. Quick Facts (optional note admonition)
255
+ - Module, Command, Input, Output as list
256
+ 3. Purpose/Overview (## section)
257
+ 4. How to Invoke (code block)
258
+ 5. Key Sections (## for each aspect)
259
+ - Use ### for sub-options
260
+ 6. Notes/Caveats (tip or caution admonition)
261
+ ```
262
+
263
+ ### Configuration Reference
264
+
265
+ ```text
266
+ 1. Title + Hook
267
+ 2. Table of Contents (jump links if 4+ items)
268
+ 3. Items (## for each config/task)
269
+ - **Bold summary** — one sentence
270
+ - **Use it when:** bullet list
271
+ - **How it works:** numbered steps (3-5 max)
272
+ - **Output:** expected result (optional)
273
+ ```
274
+
275
+ ### Comprehensive Reference Guide
276
+
277
+ ```text
278
+ 1. Title + Hook
279
+ 2. Overview (## section)
280
+ - Diagram or table showing organization
281
+ 3. Major Sections (## for each phase/category)
282
+ - Items (### for each item)
283
+ - Standardized fields: Command, Agent, Input, Output, Description
284
+ 4. Next Steps (optional)
285
+ ```
286
+
287
+ ### Reference Checklist
288
+
289
+ - [ ] Hook states what document references
290
+ - [ ] Structure matches reference type
291
+ - [ ] Items use consistent structure throughout
292
+ - [ ] Tables for structured/comparative data
293
+ - [ ] Links to explanation docs for conceptual depth
294
+ - [ ] 1-2 admonitions max
295
+
296
+ ## Glossary Structure
297
+
298
+ Starlight generates right-side "On this page" navigation from headers:
299
+
300
+ - Categories as `##` headers — appear in right nav
301
+ - Terms in tables — compact rows, not individual headers
302
+ - No inline TOC — right sidebar handles navigation
303
+
304
+ ### Table Format
305
+
306
+ ```md
307
+ ## Category Name
308
+
309
+ | Term | Definition |
310
+ | ------------ | ---------------------------------------------------------------------------------------- |
311
+ | **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
312
+ | **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
313
+ ```
314
+
315
+ ### Definition Rules
316
+
317
+ | Do | Don't |
318
+ | ----------------------------- | ------------------------------------------- |
319
+ | Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
320
+ | Keep to 1-2 sentences | Write multi-paragraph explanations |
321
+ | Bold term name in cell | Use plain text for terms |
322
+
323
+ ### Context Markers
324
+
325
+ Add italic context at definition start for limited-scope terms:
326
+
327
+ - `*Quick Flow only.*`
328
+ - `*BMad Method/Enterprise.*`
329
+ - `*Phase N.*`
330
+ - `*BMGD.*`
331
+ - `*Established projects.*`
332
+
333
+ ### Glossary Checklist
334
+
335
+ - [ ] Terms in tables, not individual headers
336
+ - [ ] Terms alphabetized within categories
337
+ - [ ] Definitions 1-2 sentences
338
+ - [ ] Context markers italicized
339
+ - [ ] Term names bolded in cells
340
+ - [ ] No "A [term] is..." definitions
341
+
342
+ ## FAQ Sections
343
+
344
+ ```md
345
+ ## Questions
346
+
347
+ - [Do I always need architecture?](#do-i-always-need-architecture)
348
+ - [Can I change my plan later?](#can-i-change-my-plan-later)
349
+
350
+ ### Do I always need architecture?
351
+
352
+ Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
353
+
354
+ ### Can I change my plan later?
355
+
356
+ Yes. The SM agent has a `correct-course` workflow for handling scope changes.
357
+
358
+ **Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
359
+ ```
360
+
361
+ ## Validation Commands
362
+
363
+ Before submitting documentation changes:
364
+
365
+ ```bash
366
+ npm run docs:fix-links # Preview link format fixes
367
+ npm run docs:fix-links -- --write # Apply fixes
368
+ npm run docs:validate-links # Check links exist
369
+ npm run docs:build # Verify no build errors
370
+ ```