bmad-method 6.0.0-alpha.21 → 6.0.0-alpha.23
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.
- package/.coderabbit.yaml +2 -2
- package/.github/workflows/docs.yaml +3 -12
- package/.vscode/settings.json +1 -0
- package/CHANGELOG.md +309 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +9 -7
- package/README.md +41 -207
- package/docs/404.md +9 -0
- package/{src/modules/bmm/docs/images/README.md → docs/_README_WORKFLOW_DIAGRAMS.md} +4 -1
- package/docs/_STYLE_GUIDE.md +347 -0
- package/docs/_archive/getting-started-bmadv4.md +247 -0
- package/{website/src/pages → docs}/downloads.md +17 -26
- package/{src/modules/bmm/docs/quick-flow-solo-dev.md → docs/explanation/agents/barry-quick-flow.md} +18 -15
- package/docs/explanation/agents/index.md +28 -0
- package/docs/explanation/architecture/four-phases.md +126 -0
- package/docs/explanation/architecture/preventing-agent-conflicts.md +138 -0
- package/docs/explanation/architecture/why-solutioning-matters.md +91 -0
- package/docs/{custom-content.md → explanation/bmad-builder/custom-content-types.md} +19 -21
- package/docs/explanation/bmad-builder/index.md +66 -0
- package/docs/explanation/bmm/index.md +135 -0
- package/docs/explanation/core/index.md +18 -0
- package/docs/explanation/core-concepts/agent-roles.md +204 -0
- package/docs/explanation/core-concepts/index.md +40 -0
- package/docs/explanation/core-concepts/what-are-agents.md +96 -0
- package/docs/explanation/core-concepts/what-are-modules.md +79 -0
- package/docs/explanation/core-concepts/what-are-workflows.md +217 -0
- package/{src/modules/cis/docs → docs/explanation/creative-intelligence}/index.md +26 -54
- package/docs/explanation/faq/brownfield-faq.md +73 -0
- package/docs/explanation/faq/getting-started-faq.md +62 -0
- package/docs/explanation/faq/implementation-faq.md +52 -0
- package/docs/explanation/faq/index.md +16 -0
- package/docs/explanation/faq/levels-and-tracks-faq.md +52 -0
- package/docs/explanation/faq/planning-faq.md +41 -0
- package/docs/explanation/faq/tools-faq.md +253 -0
- package/docs/explanation/faq/workflows-faq.md +61 -0
- package/docs/explanation/features/advanced-elicitation.md +108 -0
- package/docs/explanation/features/brainstorming-techniques.md +103 -0
- package/{src/modules/bmm/docs → docs/explanation/features}/party-mode.md +11 -123
- package/docs/explanation/features/quick-flow.md +169 -0
- package/{src/modules/bmm/docs/test-architecture.md → docs/explanation/features/tea-overview.md} +160 -118
- package/docs/explanation/features/web-bundles.md +35 -0
- package/{src/modules/bmgd/docs/agents-guide.md → docs/explanation/game-dev/agents.md} +8 -5
- package/docs/explanation/game-dev/bmgd-vs-bmm.md +150 -0
- package/{src/modules/bmgd/docs/game-types-guide.md → docs/explanation/game-dev/game-types.md} +7 -4
- package/docs/explanation/game-dev/index.md +85 -0
- package/docs/explanation/philosophy/facilitation-over-generation.md +121 -0
- package/docs/explanation/philosophy/testing-as-engineering.md +119 -0
- package/docs/how-to/brownfield/add-feature-to-existing.md +91 -0
- package/docs/how-to/brownfield/document-existing-project.md +84 -0
- package/docs/how-to/brownfield/index.md +102 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +94 -0
- package/docs/{agent-customization-guide.md → how-to/customization/customize-agents.md} +10 -10
- package/docs/how-to/customization/customize-workflows.md +33 -0
- package/docs/how-to/customization/index.md +27 -0
- package/docs/how-to/customization/shard-large-documents.md +125 -0
- package/docs/how-to/customization/vendor-workflows.md +45 -0
- package/docs/how-to/get-answers-about-bmad.md +98 -0
- package/docs/how-to/installation/index.md +15 -0
- package/docs/how-to/installation/install-bmad.md +138 -0
- package/docs/{custom-content-installation.md → how-to/installation/install-custom-modules.md} +17 -14
- package/docs/how-to/installation/upgrade-to-v6.md +147 -0
- package/{src/modules/bmgd/docs/troubleshooting.md → docs/how-to/troubleshooting/bmgd-troubleshooting.md} +7 -5
- package/{src/modules/bmgd/docs/quick-flow-guide.md → docs/how-to/workflows/bmgd-quick-flow.md} +8 -5
- package/docs/how-to/workflows/conduct-research.md +130 -0
- package/docs/how-to/workflows/create-architecture.md +147 -0
- package/docs/how-to/workflows/create-epics-and-stories.md +136 -0
- package/docs/how-to/workflows/create-prd.md +130 -0
- package/docs/how-to/workflows/create-product-brief.md +117 -0
- package/docs/how-to/workflows/create-story.md +119 -0
- package/docs/how-to/workflows/create-ux-design.md +117 -0
- package/docs/how-to/workflows/implement-story.md +127 -0
- package/docs/how-to/workflows/quick-spec.md +159 -0
- package/docs/how-to/workflows/run-brainstorming-session.md +94 -0
- package/docs/how-to/workflows/run-code-review.md +141 -0
- package/docs/how-to/workflows/run-implementation-readiness.md +162 -0
- package/docs/how-to/workflows/run-sprint-planning.md +111 -0
- package/docs/how-to/workflows/run-test-design.md +128 -0
- package/docs/how-to/workflows/setup-party-mode.md +117 -0
- package/docs/how-to/workflows/setup-test-framework.md +113 -0
- package/docs/index.md +33 -113
- package/{src/modules/bmm/docs/agents-guide.md → docs/reference/agents/index.md} +36 -39
- package/docs/reference/configuration/core-tasks.md +67 -0
- package/docs/reference/configuration/global-config.md +14 -0
- package/{src/modules/bmm/docs/glossary.md → docs/reference/glossary/index.md} +90 -24
- package/{src/modules/bmgd/docs/workflows-guide.md → docs/reference/workflows/bmgd-workflows.md} +11 -8
- package/docs/reference/workflows/core-workflows.md +33 -0
- package/docs/reference/workflows/document-project.md +74 -0
- package/docs/reference/workflows/index.md +16 -0
- package/docs/tutorials/advanced/create-custom-agent.md +171 -0
- package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
- package/docs/tutorials/getting-started/quick-start-bmgd.md +260 -0
- package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
- package/eslint.config.mjs +2 -2
- package/package.json +10 -10
- package/samples/sample-custom-modules/README.md +1 -1
- package/samples/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml +1 -0
- package/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +0 -5
- package/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +1 -1
- package/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +1 -1
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md +3 -3
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md +2 -2
- package/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md +1 -1
- package/samples/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml +1 -0
- package/src/core/agents/bmad-master.agent.yaml +1 -0
- package/src/core/{tools → tasks}/shard-doc.xml +2 -2
- package/src/core/tasks/workflow.xml +1 -1
- package/src/core/{tasks/advanced-elicitation.xml → workflows/advanced-elicitation/workflow.xml} +3 -2
- package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-01b-continue.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +1 -0
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +69 -9
- package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +1 -0
- package/src/core/workflows/brainstorming/workflow.md +8 -1
- package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +1 -0
- package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +1 -0
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +1 -0
- package/src/core/workflows/party-mode/workflow.md +1 -1
- package/src/modules/bmb/agents/agent-builder.agent.yaml +7 -2
- package/src/modules/bmb/agents/module-builder.agent.yaml +5 -8
- package/src/modules/bmb/agents/workflow-builder.agent.yaml +16 -7
- package/src/modules/bmb/workflows/agent/data/agent-compilation.md +273 -0
- package/src/modules/bmb/workflows/agent/data/agent-menu-patterns.md +233 -0
- package/src/modules/bmb/workflows/agent/data/agent-metadata.md +208 -0
- package/src/modules/bmb/workflows/{create-agent → agent}/data/brainstorm-context.md +3 -10
- package/src/modules/bmb/workflows/{create-agent → agent}/data/communication-presets.csv +1 -1
- package/src/modules/bmb/workflows/agent/data/critical-actions.md +120 -0
- package/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md +236 -0
- package/src/modules/bmb/workflows/agent/data/expert-agent-validation.md +174 -0
- package/src/modules/bmb/workflows/agent/data/module-agent-validation.md +126 -0
- package/src/modules/bmb/workflows/agent/data/persona-properties.md +266 -0
- package/src/modules/bmb/workflows/agent/data/principles-crafting.md +292 -0
- package/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +17 -0
- package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/expert-examples/journal-keeper/journal-keeper.agent.yaml +26 -25
- package/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.agent.yaml +32 -0
- package/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -0
- package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/module-examples/security-engineer.agent.yaml +1 -0
- package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/module-examples/trend-analyst.agent.yaml +1 -0
- package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/simple-examples/commit-poet.agent.yaml +15 -14
- package/src/modules/bmb/workflows/agent/data/simple-agent-architecture.md +204 -0
- package/src/modules/bmb/workflows/agent/data/simple-agent-validation.md +133 -0
- package/src/modules/bmb/workflows/agent/data/understanding-agent-types.md +222 -0
- package/src/modules/bmb/workflows/{create-agent/steps → agent/steps-c}/step-01-brainstorm.md +9 -26
- package/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md +170 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md +296 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md +212 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md +178 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md +279 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md +187 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md +201 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md +258 -0
- package/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md +249 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md +221 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md +193 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md +1 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md +124 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md +134 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md +122 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md +125 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +137 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +119 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md +123 -0
- package/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md +155 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md +136 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +116 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +124 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +145 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +136 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +136 -0
- package/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md +104 -0
- package/src/modules/bmb/workflows/agent/templates/agent-plan.template.md +5 -0
- package/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/instructions.md.template +20 -0
- package/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/memories.md.template +18 -0
- package/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +77 -0
- package/src/modules/bmb/workflows/agent/templates/simple-agent.template.md +72 -0
- package/src/modules/bmb/workflows/agent/workflow.md +123 -0
- package/src/modules/bmb/workflows/module/data/agent-architecture.md +179 -0
- package/src/modules/bmb/workflows/module/data/agent-spec-template.md +79 -0
- package/src/modules/bmb/workflows/module/data/module-installer-standards.md +348 -0
- package/src/modules/bmb/workflows/module/data/module-standards.md +280 -0
- package/src/modules/bmb/workflows/module/data/module-yaml-conventions.md +392 -0
- package/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md +147 -0
- package/src/modules/bmb/workflows/module/steps-b/step-02-spark.md +140 -0
- package/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md +148 -0
- package/src/modules/bmb/workflows/module/steps-b/step-04-vision.md +82 -0
- package/src/modules/bmb/workflows/module/steps-b/step-05-identity.md +96 -0
- package/src/modules/bmb/workflows/module/steps-b/step-06-users.md +85 -0
- package/src/modules/bmb/workflows/module/steps-b/step-07-value.md +75 -0
- package/src/modules/bmb/workflows/module/steps-b/step-08-agents.md +96 -0
- package/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md +82 -0
- package/src/modules/bmb/workflows/module/steps-b/step-10-tools.md +90 -0
- package/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md +83 -0
- package/src/modules/bmb/workflows/module/steps-b/step-12-creative.md +94 -0
- package/src/modules/bmb/workflows/module/steps-b/step-13-review.md +104 -0
- package/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md +117 -0
- package/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md +178 -0
- package/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md +83 -0
- package/src/modules/bmb/workflows/module/steps-c/step-02-structure.md +109 -0
- package/src/modules/bmb/workflows/module/steps-c/step-03-config.md +118 -0
- package/src/modules/bmb/workflows/module/steps-c/step-04-installer.md +160 -0
- package/src/modules/bmb/workflows/module/steps-c/step-05-agents.md +167 -0
- package/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md +183 -0
- package/src/modules/bmb/workflows/module/steps-c/step-07-docs.md +402 -0
- package/src/modules/bmb/workflows/module/steps-c/step-08-complete.md +123 -0
- package/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md +81 -0
- package/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md +77 -0
- package/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md +77 -0
- package/src/modules/bmb/workflows/module/steps-e/step-04-review.md +80 -0
- package/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md +75 -0
- package/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md +96 -0
- package/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md +94 -0
- package/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md +99 -0
- package/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md +152 -0
- package/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md +152 -0
- package/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md +143 -0
- package/src/modules/bmb/workflows/module/steps-v/step-07-installation.md +113 -0
- package/src/modules/bmb/workflows/module/steps-v/step-08-report.md +197 -0
- package/src/modules/bmb/workflows/module/templates/brief-template.md +154 -0
- package/src/modules/bmb/workflows/module/templates/workflow-spec-template.md +96 -0
- package/src/modules/bmb/workflows/module/workflow.md +100 -0
- package/src/modules/bmb/workflows/workflow/data/architecture.md +152 -0
- package/src/modules/bmb/{docs/workflows → workflows/workflow/data}/common-workflow-tools.csv +1 -1
- package/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md +81 -0
- package/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md +225 -0
- package/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md +269 -0
- package/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md +50 -0
- package/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md +167 -0
- package/src/modules/bmb/workflows/workflow/data/output-format-standards.md +188 -0
- package/src/modules/bmb/workflows/workflow/data/step-file-rules.md +235 -0
- package/src/modules/bmb/workflows/workflow/data/step-type-patterns.md +311 -0
- package/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md +386 -0
- package/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md +209 -0
- package/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md +271 -0
- package/src/modules/bmb/workflows/workflow/data/workflow-examples.md +276 -0
- package/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md +172 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md +262 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md +194 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md +3 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md +269 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md +282 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md +281 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md +242 -0
- package/src/modules/bmb/workflows/{create-workflow/steps → workflow/steps-c}/step-06-design.md +96 -38
- package/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md +238 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md +377 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md +350 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md +320 -0
- package/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md +191 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md +237 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md +248 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md +252 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md +275 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md +154 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md +190 -0
- package/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md +206 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md +109 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md +221 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md +152 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md +199 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md +265 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md +164 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md +211 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md +200 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md +195 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md +209 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md +199 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md +179 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md +186 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md +154 -0
- package/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md +237 -0
- package/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md +11 -0
- package/src/modules/bmb/{docs/workflows → workflows/workflow}/templates/step-01-init-continuable-template.md +3 -3
- package/src/modules/bmb/{docs/workflows → workflows/workflow}/templates/step-1b-template.md +1 -1
- package/src/modules/bmb/{docs/workflows → workflows/workflow}/templates/step-template.md +15 -15
- package/src/modules/bmb/{docs/workflows → workflows/workflow}/templates/workflow-template.md +2 -4
- package/src/modules/bmb/workflows/workflow/workflow.md +109 -0
- package/src/modules/bmgd/agents/game-architect.agent.yaml +1 -0
- package/src/modules/bmgd/agents/game-designer.agent.yaml +1 -0
- package/src/modules/bmgd/agents/game-dev.agent.yaml +2 -1
- package/src/modules/bmgd/agents/game-qa.agent.yaml +2 -1
- package/src/modules/bmgd/agents/game-scrum-master.agent.yaml +2 -1
- package/src/modules/bmgd/agents/game-solo-dev.agent.yaml +3 -2
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md +5 -3
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md +52 -46
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md +2 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md +5 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md +2 -1
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md +4 -3
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md +2 -1
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.md +1 -0
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md +2 -1
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md +4 -3
- package/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md +2 -1
- package/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +1 -1
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md +12 -11
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md +4 -3
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md +2 -1
- package/src/modules/bmgd/workflows/2-design/narrative/workflow.md +2 -1
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md +10 -9
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md +6 -5
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md +4 -3
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md +6 -5
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md +2 -1
- package/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md +2 -1
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md +1 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md +2 -1
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md +1 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md +1 -0
- package/src/modules/bmgd/workflows/4-production/code-review/instructions.xml +1 -0
- package/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/4-production/create-story/checklist.md +2 -2
- package/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/{create-tech-spec → quick-spec}/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml +2 -2
- package/src/modules/bmm/agents/analyst.agent.yaml +3 -2
- package/src/modules/bmm/agents/architect.agent.yaml +3 -1
- package/src/modules/bmm/agents/dev.agent.yaml +4 -3
- package/src/modules/bmm/agents/pm.agent.yaml +16 -5
- package/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +3 -2
- package/src/modules/bmm/agents/sm.agent.yaml +1 -0
- package/src/modules/bmm/agents/tea.agent.yaml +6 -3
- package/src/modules/bmm/agents/tech-writer.agent.yaml +1 -0
- package/src/modules/bmm/agents/ux-designer.agent.yaml +1 -0
- package/src/modules/bmm/module.yaml +1 -1
- package/src/modules/bmm/testarch/knowledge/api-request.md +155 -16
- package/src/modules/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/src/modules/bmm/testarch/knowledge/auth-session.md +197 -1
- package/src/modules/bmm/testarch/knowledge/file-utils.md +257 -54
- package/src/modules/bmm/testarch/knowledge/intercept-network-call.md +159 -9
- package/src/modules/bmm/testarch/knowledge/log.md +170 -35
- package/src/modules/bmm/testarch/knowledge/network-error-monitor.md +228 -95
- package/src/modules/bmm/testarch/knowledge/network-recorder.md +314 -52
- package/src/modules/bmm/testarch/knowledge/overview.md +15 -12
- package/src/modules/bmm/testarch/knowledge/recurse.md +173 -48
- package/src/modules/bmm/testarch/tea-index.csv +19 -18
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +4 -8
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +1 -5
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +3 -7
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +3 -7
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +3 -7
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +3 -7
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -5
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +1 -0
- package/src/modules/bmm/workflows/1-analysis/research/workflow.md +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +1 -0
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +1 -0
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +2 -1
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +3 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -0
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +2 -1
- package/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-01-init.md +8 -13
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-01b-continue.md +37 -49
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-03-success.md +52 -115
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-06-innovation.md +45 -80
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-07-project-type.md +39 -59
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-08-scoping.md +45 -115
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-09-functional.md +23 -61
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-10-nonfunctional.md +34 -85
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/{prd-template.md → templates/prd-template.md} +0 -1
- package/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md +97 -8
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +2 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +2 -1
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +1 -0
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -0
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md +1 -0
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +5 -4
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +4 -3
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +4 -3
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +3 -2
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +1 -0
- package/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml +2 -0
- package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +9 -12
- package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +2 -1
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +13 -12
- package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +2 -1
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +3 -3
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +11 -10
- package/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +7 -7
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +2 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +2 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +2 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +3 -3
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +1 -1
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +4 -3
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +173 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/src/modules/bmm/workflows/document-project/checklist.md +2 -2
- package/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +1 -1
- package/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +1 -1
- package/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +1 -1
- package/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +1 -1
- package/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md +1 -0
- package/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -1
- package/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md +1 -0
- package/src/modules/bmm/workflows/generate-project-context/workflow.md +1 -0
- package/src/modules/bmm/workflows/testarch/test-design/instructions.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +6 -6
- package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +2 -1
- package/src/modules/bmm/workflows/workflow-status/instructions.md +8 -8
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +44 -63
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +44 -54
- package/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml +38 -41
- package/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +26 -22
- package/src/modules/cis/agents/brainstorming-coach.agent.yaml +2 -1
- package/src/modules/cis/agents/creative-problem-solver.agent.yaml +1 -0
- package/src/modules/cis/agents/design-thinking-coach.agent.yaml +1 -0
- package/src/modules/cis/agents/innovation-strategist.agent.yaml +1 -0
- package/src/modules/cis/agents/presentation-master.agent.yaml +1 -0
- package/src/modules/cis/module.yaml +1 -0
- package/src/modules/cis/workflows/design-thinking/instructions.md +2 -2
- package/src/modules/cis/workflows/innovation-strategy/instructions.md +2 -2
- package/src/modules/cis/workflows/problem-solving/instructions.md +2 -2
- package/src/modules/cis/workflows/storytelling/instructions.md +2 -2
- package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +1 -0
- package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +1 -0
- package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +1 -0
- package/tools/build-docs.js +200 -271
- package/tools/cli/bmad-cli.js +18 -0
- package/tools/cli/commands/install.js +15 -13
- package/tools/cli/installers/install-messages.yaml +33 -27
- package/tools/cli/installers/lib/core/config-collector.js +11 -1
- package/tools/cli/installers/lib/core/detector.js +5 -115
- package/tools/cli/installers/lib/core/installer.js +48 -80
- package/tools/cli/installers/lib/core/manifest-generator.js +46 -2
- package/tools/cli/installers/lib/ide/antigravity.js +3 -3
- package/tools/cli/installers/lib/ide/claude-code.js +3 -3
- package/tools/cli/installers/lib/ide/codex.js +1 -1
- package/tools/cli/installers/lib/ide/cursor.js +57 -304
- package/tools/cli/installers/lib/ide/github-copilot.js +1 -1
- package/tools/cli/lib/agent/compiler.js +0 -4
- package/tools/cli/lib/ui.js +22 -1
- package/tools/docs/index.md +2 -0
- package/tools/fix-doc-links.js +288 -0
- package/tools/schema/agent.js +1 -0
- package/tools/validate-doc-links.js +363 -0
- package/website/README.md +76 -0
- package/website/astro.config.mjs +218 -0
- package/website/src/components/Banner.astro +59 -0
- package/website/src/components/Header.astro +121 -0
- package/website/src/components/MobileMenuFooter.astro +53 -0
- package/website/src/content/config.ts +6 -0
- package/website/src/lib/site-url.js +25 -0
- package/website/src/rehype-markdown-links.js +102 -0
- package/website/src/styles/custom.css +483 -0
- package/docs/document-sharding-guide.md +0 -449
- package/docs/getting-started/installation.md +0 -76
- package/docs/ide-info/auggie.md +0 -31
- package/docs/ide-info/claude-code.md +0 -25
- package/docs/ide-info/cline.md +0 -31
- package/docs/ide-info/codex.md +0 -21
- package/docs/ide-info/crush.md +0 -30
- package/docs/ide-info/cursor.md +0 -25
- package/docs/ide-info/gemini.md +0 -25
- package/docs/ide-info/github-copilot.md +0 -26
- package/docs/ide-info/iflow.md +0 -33
- package/docs/ide-info/index.md +0 -24
- package/docs/ide-info/kilo.md +0 -24
- package/docs/ide-info/opencode.md +0 -24
- package/docs/ide-info/qwen.md +0 -25
- package/docs/ide-info/roo.md +0 -27
- package/docs/ide-info/rovo-dev.md +0 -22
- package/docs/ide-info/trae.md +0 -25
- package/docs/ide-info/windsurf.md +0 -22
- package/docs/v4-to-v6-upgrade.md +0 -227
- package/docs/web-bundles-gemini-gpt-guide.md +0 -21
- package/src/core/tasks/validate-workflow.xml +0 -89
- package/src/modules/bmb/docs/agents/agent-compilation.md +0 -340
- package/src/modules/bmb/docs/agents/agent-menu-patterns.md +0 -523
- package/src/modules/bmb/docs/agents/expert-agent-architecture.md +0 -363
- package/src/modules/bmb/docs/agents/index.md +0 -55
- package/src/modules/bmb/docs/agents/kb.csv +0 -0
- package/src/modules/bmb/docs/agents/simple-agent-architecture.md +0 -257
- package/src/modules/bmb/docs/agents/understanding-agent-types.md +0 -184
- package/src/modules/bmb/docs/index.md +0 -247
- package/src/modules/bmb/docs/workflows/architecture.md +0 -220
- package/src/modules/bmb/docs/workflows/csv-data-file-standards.md +0 -206
- package/src/modules/bmb/docs/workflows/index.md +0 -45
- package/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +0 -220
- package/src/modules/bmb/docs/workflows/kb.csv +0 -0
- package/src/modules/bmb/docs/workflows/templates/step-file.md +0 -139
- package/src/modules/bmb/docs/workflows/templates/workflow.md +0 -58
- package/src/modules/bmb/docs/workflows/terms.md +0 -97
- package/src/modules/bmb/reference/README.md +0 -3
- package/src/modules/bmb/reference/agents/simple-examples/README.md +0 -223
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +0 -18
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +0 -16
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +0 -28
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +0 -176
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +0 -120
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +0 -164
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +0 -153
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +0 -182
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +0 -167
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +0 -194
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +0 -25
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +0 -68
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +0 -29
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +0 -47
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +0 -37
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +0 -18
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +0 -58
- package/src/modules/bmb/workflows/create-agent/data/agent-validation-checklist.md +0 -174
- package/src/modules/bmb/workflows/create-agent/data/info-and-installation-guide.md +0 -29
- package/src/modules/bmb/workflows/create-agent/data/reference/README.md +0 -3
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/README.md +0 -242
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/README.md +0 -48
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/README.md +0 -223
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +0 -18
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +0 -16
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +0 -28
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +0 -177
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +0 -150
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +0 -164
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +0 -152
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +0 -182
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +0 -167
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +0 -194
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +0 -25
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +0 -68
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +0 -29
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/profile-section.md +0 -47
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +0 -37
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +0 -18
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md +0 -58
- package/src/modules/bmb/workflows/create-agent/data/validation-complete.md +0 -305
- package/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md +0 -206
- package/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md +0 -260
- package/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md +0 -237
- package/src/modules/bmb/workflows/create-agent/steps/step-05-name.md +0 -232
- package/src/modules/bmb/workflows/create-agent/steps/step-06-build.md +0 -186
- package/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md +0 -234
- package/src/modules/bmb/workflows/create-agent/steps/step-08-celebrate.md +0 -218
- package/src/modules/bmb/workflows/create-agent/templates/agent-plan.template.md +0 -3
- package/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md +0 -364
- package/src/modules/bmb/workflows/create-agent/templates/simple-agent.template.md +0 -257
- package/src/modules/bmb/workflows/create-agent/workflow.md +0 -58
- package/src/modules/bmb/workflows/create-module/steps/step-01-init.md +0 -155
- package/src/modules/bmb/workflows/create-module/steps/step-01b-continue.md +0 -169
- package/src/modules/bmb/workflows/create-module/steps/step-02-concept.md +0 -217
- package/src/modules/bmb/workflows/create-module/steps/step-03-components.md +0 -267
- package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +0 -228
- package/src/modules/bmb/workflows/create-module/steps/step-05-config.md +0 -233
- package/src/modules/bmb/workflows/create-module/steps/step-06-agents.md +0 -296
- package/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md +0 -228
- package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +0 -186
- package/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md +0 -309
- package/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md +0 -337
- package/src/modules/bmb/workflows/create-module/steps/step-11-validate.md +0 -335
- package/src/modules/bmb/workflows/create-module/templates/agent.template.md +0 -313
- package/src/modules/bmb/workflows/create-module/templates/installer.template.js +0 -47
- package/src/modules/bmb/workflows/create-module/templates/module-plan.template.md +0 -5
- package/src/modules/bmb/workflows/create-module/templates/module.template.yaml +0 -53
- package/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md +0 -23
- package/src/modules/bmb/workflows/create-module/validation.md +0 -126
- package/src/modules/bmb/workflows/create-module/workflow.md +0 -55
- package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +0 -157
- package/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md +0 -211
- package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +0 -250
- package/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md +0 -216
- package/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +0 -289
- package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +0 -308
- package/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md +0 -284
- package/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md +0 -187
- package/src/modules/bmb/workflows/create-workflow/workflow.md +0 -58
- package/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md +0 -134
- package/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md +0 -202
- package/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md +0 -157
- package/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md +0 -150
- package/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md +0 -150
- package/src/modules/bmb/workflows/edit-agent/workflow.md +0 -58
- package/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md +0 -217
- package/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md +0 -253
- package/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md +0 -217
- package/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md +0 -193
- package/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +0 -245
- package/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md +0 -75
- package/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md +0 -68
- package/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md +0 -40
- package/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md +0 -51
- package/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md +0 -56
- package/src/modules/bmb/workflows/edit-workflow/workflow.md +0 -58
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +0 -152
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +0 -243
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +0 -274
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +0 -295
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +0 -264
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +0 -360
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +0 -258
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +0 -301
- package/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +0 -140
- package/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +0 -58
- package/src/modules/bmb/workflows-legacy/edit-module/README.md +0 -171
- package/src/modules/bmb/workflows-legacy/edit-module/checklist.md +0 -163
- package/src/modules/bmb/workflows-legacy/edit-module/instructions.md +0 -340
- package/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml +0 -34
- package/src/modules/bmb/workflows-legacy/module-brief/README.md +0 -264
- package/src/modules/bmb/workflows-legacy/module-brief/checklist.md +0 -116
- package/src/modules/bmb/workflows-legacy/module-brief/instructions.md +0 -268
- package/src/modules/bmb/workflows-legacy/module-brief/template.md +0 -275
- package/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml +0 -36
- package/src/modules/bmgd/docs/glossary.md +0 -294
- package/src/modules/bmgd/docs/index.md +0 -180
- package/src/modules/bmgd/docs/quick-start.md +0 -250
- package/src/modules/bmm/README.md +0 -127
- package/src/modules/bmm/docs/bmad-quick-flow.md +0 -506
- package/src/modules/bmm/docs/brownfield-guide.md +0 -748
- package/src/modules/bmm/docs/enterprise-agentic-development.md +0 -686
- package/src/modules/bmm/docs/faq.md +0 -542
- package/src/modules/bmm/docs/index.md +0 -168
- package/src/modules/bmm/docs/quick-spec-flow.md +0 -638
- package/src/modules/bmm/docs/quick-start.md +0 -366
- package/src/modules/bmm/docs/scale-adaptive-system.md +0 -618
- package/src/modules/bmm/docs/troubleshooting.md +0 -661
- package/src/modules/bmm/docs/workflow-architecture-reference.md +0 -366
- package/src/modules/bmm/docs/workflow-document-project-reference.md +0 -489
- package/src/modules/bmm/docs/workflows-analysis.md +0 -266
- package/src/modules/bmm/docs/workflows-implementation.md +0 -210
- package/src/modules/bmm/docs/workflows-planning.md +0 -451
- package/src/modules/bmm/docs/workflows-solutioning.md +0 -509
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +0 -420
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +0 -290
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +0 -270
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +0 -185
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md +0 -115
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +0 -28
- package/website/css/custom.css +0 -52
- package/website/docusaurus.config.js +0 -179
- package/website/sidebars.js +0 -157
- package/website/src/pages/index.js +0 -50
- /package/{src/modules/bmm/docs → docs/tutorials/getting-started}/images/workflow-method-greenfield.excalidraw +0 -0
- /package/{src/modules/bmm/docs → docs/tutorials/getting-started}/images/workflow-method-greenfield.svg +0 -0
- /package/{src/modules/bmgd/docs → docs/tutorials/getting-started/images}/workflow-overview.jpg +0 -0
- /package/src/core/{tasks/advanced-elicitation-methods.csv → workflows/advanced-elicitation/methods.csv} +0 -0
- /package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md +0 -0
- /package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md +0 -0
- /package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md +0 -0
- /package/src/modules/bmb/workflows/{create-agent/data/reference/agents → agent/data/reference}/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md +0 -0
- /package/src/modules/bmgd/workflows/bmgd-quick-flow/{create-tech-spec → quick-spec}/instructions.md +0 -0
- /package/src/modules/bmm/workflows/2-plan-workflows/prd/{domain-complexity.csv → data/domain-complexity.csv} +0 -0
- /package/src/modules/bmm/workflows/2-plan-workflows/prd/{project-types.csv → data/project-types.csv} +0 -0
- /package/{docs → tools/docs}/BUNDLE_DISTRIBUTION_SETUP.md +0 -0
- /package/website/{static → public}/favicon.ico +0 -0
- /package/website/{static → public}/img/logo.svg +0 -0
- /package/website/{static → public}/robots.txt +0 -0
package/README.md
CHANGED
|
@@ -1,245 +1,79 @@
|
|
|
1
|
-
# BMad Method
|
|
1
|
+
# BMad Method
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/bmad-method)
|
|
3
|
+
[](https://www.npmjs.com/package/bmad-method)
|
|
5
4
|
[](LICENSE)
|
|
6
5
|
[](https://nodejs.org)
|
|
7
6
|
[](https://discord.gg/gk8jAdXWmj)
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
<div align="center">
|
|
12
|
-
|
|
13
|
-
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
|
|
14
|
-
|
|
15
|
-
The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
|
|
16
|
-
|
|
17
|
-
**✨ What's New:**
|
|
18
|
-
|
|
19
|
-
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
|
20
|
-
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
|
|
21
|
-
- 🔄 **Unitary Module Support** - Install individual components without full modules
|
|
22
|
-
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
|
|
23
|
-
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
|
|
24
|
-
|
|
25
|
-
**📚 Learn More:**
|
|
26
|
-
|
|
27
|
-
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
|
|
28
|
-
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
|
|
29
|
-
- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
|
|
30
|
-
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
|
31
|
-
|
|
32
|
-
</div>
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
|
37
|
-
|
|
38
|
-
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
|
39
|
-
|
|
40
|
-
Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
|
|
41
|
-
|
|
42
|
-
> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
|
|
8
|
+
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
|
43
9
|
|
|
44
|
-
|
|
10
|
+
## Why BMad?
|
|
45
11
|
|
|
46
|
-
|
|
12
|
+
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
|
47
13
|
|
|
48
|
-
|
|
14
|
+
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
|
15
|
+
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
|
16
|
+
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
|
17
|
+
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
|
49
18
|
|
|
50
|
-
|
|
19
|
+
## Quick Start
|
|
51
20
|
|
|
52
|
-
|
|
53
|
-
- **Complete Development Lifecycle** - Analysis → Planning → Architecture → Implementation
|
|
54
|
-
- **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.)
|
|
55
|
-
- **Proven Methodologies** - Built on agile best practices with AI amplification
|
|
56
|
-
- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code
|
|
57
|
-
|
|
58
|
-
## 🏗️ The Power of BMad Core
|
|
59
|
-
|
|
60
|
-
**BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means:
|
|
61
|
-
|
|
62
|
-
- **BMad Core** provides the universal framework for human-AI collaboration
|
|
63
|
-
- **BMad Method** leverages Core to deliver agile development workflows
|
|
64
|
-
- **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself
|
|
65
|
-
|
|
66
|
-
With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team!
|
|
67
|
-
|
|
68
|
-
## 📊 See It In Action
|
|
69
|
-
|
|
70
|
-
<p align="center">
|
|
71
|
-
<img src="./src/modules/bmm/docs/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
|
72
|
-
</p>
|
|
73
|
-
|
|
74
|
-
<p align="center">
|
|
75
|
-
<em>Complete BMad Method workflow showing all phases, agents, and decision points</em>
|
|
76
|
-
</p>
|
|
77
|
-
|
|
78
|
-
## 🚀 Get Started in 3 Steps
|
|
79
|
-
|
|
80
|
-
### 1. Install BMad Method
|
|
21
|
+
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
81
22
|
|
|
82
23
|
```bash
|
|
83
|
-
# Install v6 Alpha (recommended)
|
|
84
24
|
npx bmad-method@alpha install
|
|
85
|
-
|
|
86
|
-
# Or stable v4 for production
|
|
87
|
-
npx bmad-method install
|
|
88
25
|
```
|
|
89
26
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
Load any agent in your IDE and run:
|
|
27
|
+
Follow the installer prompts to configure your project. Then run:
|
|
93
28
|
|
|
94
|
-
```
|
|
29
|
+
```bash
|
|
95
30
|
*workflow-init
|
|
96
31
|
```
|
|
97
32
|
|
|
98
|
-
This analyzes your project and recommends
|
|
99
|
-
|
|
100
|
-
### 3. Choose Your Track
|
|
33
|
+
This analyzes your project and recommends a track:
|
|
101
34
|
|
|
102
|
-
|
|
35
|
+
| Track | Best For | Time to First Story |
|
|
36
|
+
| --------------- | ------------------------- | ------------------- |
|
|
37
|
+
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
|
38
|
+
| **BMad Method** | Products and platforms | ~15 minutes |
|
|
39
|
+
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
|
103
40
|
|
|
104
|
-
|
|
105
|
-
| ------------------ | ------------------------- | ----------------------- | ------------- |
|
|
106
|
-
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
|
|
107
|
-
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
|
|
108
|
-
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
|
|
41
|
+
## Modules
|
|
109
42
|
|
|
110
|
-
|
|
43
|
+
| Module | Purpose |
|
|
44
|
+
| ------------------------------------- | -------------------------------------------------------- |
|
|
45
|
+
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
|
46
|
+
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
|
47
|
+
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
|
111
48
|
|
|
112
|
-
##
|
|
49
|
+
## Documentation
|
|
113
50
|
|
|
114
|
-
|
|
51
|
+
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
|
115
52
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
3. **🏗️ Solutioning** - Design architecture, UX, and technical approach
|
|
119
|
-
4. **⚡ Implementation** - Story-driven development with continuous validation
|
|
120
|
-
|
|
121
|
-
Each phase has specialized workflows and agents working together to deliver exceptional results.
|
|
122
|
-
|
|
123
|
-
## 🤖 Meet Your Team
|
|
124
|
-
|
|
125
|
-
**12 Specialized Agents** working in concert:
|
|
126
|
-
|
|
127
|
-
| Development | Architecture | Product | Leadership |
|
|
128
|
-
| ----------- | -------------- | ------------- | -------------- |
|
|
129
|
-
| Developer | Architect | PM | Scrum Master |
|
|
130
|
-
| UX Designer | Test Architect | Analyst | BMad Master |
|
|
131
|
-
| Tech Writer | Game Architect | Game Designer | Game Developer |
|
|
132
|
-
|
|
133
|
-
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready fixture-based utilities.
|
|
134
|
-
|
|
135
|
-
Each agent brings deep expertise and can be customized to match your team's style.
|
|
136
|
-
|
|
137
|
-
## 📦 What's Included
|
|
138
|
-
|
|
139
|
-
### Core Modules
|
|
140
|
-
|
|
141
|
-
- **BMad Method (BMM)** - Complete agile development framework
|
|
142
|
-
- 12 specialized agents
|
|
143
|
-
- 34 workflows across 4 phases
|
|
144
|
-
- Scale-adaptive planning
|
|
145
|
-
- [→ Documentation Hub](./src/modules/bmm/docs/index.md)
|
|
146
|
-
|
|
147
|
-
- **BMad Builder (BMB)** - Create custom agents and workflows
|
|
148
|
-
- Build anything from simple agents to complex modules
|
|
149
|
-
- Create domain-specific solutions (legal, medical, finance, education)
|
|
150
|
-
- [→ Builder Guide](./src/modules/bmb/docs/index.md)
|
|
151
|
-
|
|
152
|
-
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
|
153
|
-
- Brainstorming, design thinking, storytelling
|
|
154
|
-
- 5 creative facilitation workflows
|
|
155
|
-
- [→ Creative Workflows](./src/modules/cis/docs/index.md)
|
|
156
|
-
|
|
157
|
-
### Key Features
|
|
158
|
-
|
|
159
|
-
- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles
|
|
160
|
-
- **🌐 Multi-Language Support** - Separate settings for communication and code output
|
|
161
|
-
- **📄 Document Sharding** - 90% token savings for large projects
|
|
162
|
-
- **🔄 Update-Safe** - Your customizations persist through updates
|
|
163
|
-
- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems
|
|
164
|
-
|
|
165
|
-
## 📚 Documentation
|
|
166
|
-
|
|
167
|
-
### Quick Links
|
|
168
|
-
|
|
169
|
-
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
|
|
170
|
-
- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
|
|
171
|
-
- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
|
|
172
|
-
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
|
53
|
+
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
|
|
54
|
+
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
|
|
173
55
|
|
|
174
56
|
### For v4 Users
|
|
175
57
|
|
|
176
|
-
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
|
|
177
|
-
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
|
|
178
|
-
|
|
179
|
-
## 💬 Community & Support
|
|
180
|
-
|
|
181
|
-
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
|
182
|
-
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
|
183
|
-
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
|
184
|
-
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
|
|
185
|
-
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
|
186
|
-
|
|
187
|
-
## 🛠️ Development
|
|
188
|
-
|
|
189
|
-
For contributors working on the BMad codebase:
|
|
190
|
-
|
|
191
|
-
```bash
|
|
192
|
-
# Run all quality checks
|
|
193
|
-
npm test
|
|
194
|
-
|
|
195
|
-
# Development commands
|
|
196
|
-
npm run lint:fix # Fix code style
|
|
197
|
-
npm run format:fix # Auto-format code
|
|
198
|
-
npm run bundle # Build web bundles
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
|
202
|
-
|
|
203
|
-
## What's New in v6
|
|
204
|
-
|
|
205
|
-
**v6 represents a complete architectural revolution from v4:**
|
|
206
|
-
|
|
207
|
-
### 🚀 Major Upgrades
|
|
208
|
-
|
|
209
|
-
- **BMad Core Framework** - Modular architecture enabling custom domain solutions
|
|
210
|
-
- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise
|
|
211
|
-
- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology
|
|
212
|
-
- **BMad Builder Module** - Create and share your own AI agent teams
|
|
213
|
-
- **50+ Workflows** - Up from 20 in v4, covering every development scenario
|
|
214
|
-
- **19 Specialized Agents** - Enhanced with customizable personalities and expertise
|
|
215
|
-
- **Update-Safe Customization** - Your configs persist through all updates
|
|
216
|
-
- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini
|
|
217
|
-
- **Multi-Language Support** - Separate settings for communication and code
|
|
218
|
-
- **Document Sharding** - 90% token savings for large projects
|
|
58
|
+
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
|
219
59
|
|
|
220
|
-
|
|
60
|
+
## Community
|
|
221
61
|
|
|
222
|
-
-
|
|
223
|
-
-
|
|
224
|
-
-
|
|
225
|
-
-
|
|
62
|
+
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
|
63
|
+
- [YouTube](https://www.youtube.com/@BMadCode) — Video tutorials and updates
|
|
64
|
+
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
|
65
|
+
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
|
226
66
|
|
|
227
|
-
##
|
|
67
|
+
## Contributing
|
|
228
68
|
|
|
229
|
-
|
|
69
|
+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
230
70
|
|
|
231
|
-
|
|
71
|
+
## License
|
|
232
72
|
|
|
233
|
-
|
|
73
|
+
MIT License — see [LICENSE](LICENSE) for details.
|
|
234
74
|
|
|
235
75
|
---
|
|
236
76
|
|
|
237
|
-
|
|
238
|
-
<a href="https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors">
|
|
239
|
-
<img src="https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD" alt="Contributors">
|
|
240
|
-
</a>
|
|
241
|
-
</p>
|
|
77
|
+
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC.
|
|
242
78
|
|
|
243
|
-
|
|
244
|
-
<sub>Built with ❤️ for the human-AI collaboration community</sub>
|
|
245
|
-
</p>
|
|
79
|
+
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
package/docs/404.md
ADDED
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
# Documentation Style Guide
|
|
2
|
+
|
|
3
|
+
Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
|
|
4
|
+
|
|
5
|
+
## Quick Principles
|
|
6
|
+
|
|
7
|
+
1. **Clarity over brevity** — Be concise, but never at the cost of understanding
|
|
8
|
+
2. **Consistent structure** — Follow established patterns so readers know what to expect
|
|
9
|
+
3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully
|
|
10
|
+
4. **Scannable content** — Headers, lists, and callouts help readers find what they need
|
|
11
|
+
|
|
12
|
+
## Validation Steps
|
|
13
|
+
|
|
14
|
+
Before submitting documentation changes, run these checks from the repo root:
|
|
15
|
+
|
|
16
|
+
1. **Fix link format** — Convert relative links (`./`, `../`) to site-relative paths (`/path/`)
|
|
17
|
+
```bash
|
|
18
|
+
npm run docs:fix-links # Preview changes
|
|
19
|
+
npm run docs:fix-links -- --write # Apply changes
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
2. **Validate links** — Check all links point to existing files
|
|
23
|
+
```bash
|
|
24
|
+
npm run docs:validate-links # Preview issues
|
|
25
|
+
npm run docs:validate-links -- --write # Auto-fix where possible
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
3. **Build the site** — Verify no build errors
|
|
29
|
+
```bash
|
|
30
|
+
npm run docs:build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Tutorial Structure
|
|
34
|
+
|
|
35
|
+
Every tutorial should follow this structure:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
1. Title + Hook (1-2 sentences describing the outcome)
|
|
39
|
+
2. Version/Module Notice (info or warning admonition as appropriate)
|
|
40
|
+
3. What You'll Learn (bullet list of outcomes)
|
|
41
|
+
4. Prerequisites (info admonition)
|
|
42
|
+
5. Quick Path (tip admonition - TL;DR summary)
|
|
43
|
+
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
|
44
|
+
7. Installation (if applicable)
|
|
45
|
+
8. Step 1: [First Major Task]
|
|
46
|
+
9. Step 2: [Second Major Task]
|
|
47
|
+
10. Step 3: [Third Major Task]
|
|
48
|
+
11. What You've Accomplished (summary + folder structure if applicable)
|
|
49
|
+
12. Quick Reference (commands table)
|
|
50
|
+
13. Common Questions (FAQ format)
|
|
51
|
+
14. Getting Help (community links)
|
|
52
|
+
15. Key Takeaways (tip admonition - memorable points)
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Not all sections are required for every tutorial, but this is the standard flow.
|
|
56
|
+
|
|
57
|
+
## Visual Hierarchy
|
|
58
|
+
|
|
59
|
+
### Avoid
|
|
60
|
+
|
|
61
|
+
| Pattern | Problem |
|
|
62
|
+
|---------|---------|
|
|
63
|
+
| `---` horizontal rules | Fragment the reading flow |
|
|
64
|
+
| `####` deep headers | Create visual noise |
|
|
65
|
+
| **Important:** bold paragraphs | Blend into body text |
|
|
66
|
+
| Deeply nested lists | Hard to scan |
|
|
67
|
+
| Code blocks for non-code | Confusing semantics |
|
|
68
|
+
|
|
69
|
+
### Use Instead
|
|
70
|
+
|
|
71
|
+
| Pattern | When to Use |
|
|
72
|
+
|---------|-------------|
|
|
73
|
+
| White space + section headers | Natural content separation |
|
|
74
|
+
| Bold text within paragraphs | Inline emphasis |
|
|
75
|
+
| Admonitions | Callouts that need attention |
|
|
76
|
+
| Tables | Structured comparisons |
|
|
77
|
+
| Flat lists | Scannable options |
|
|
78
|
+
|
|
79
|
+
## Admonitions
|
|
80
|
+
|
|
81
|
+
Use Starlight admonitions strategically:
|
|
82
|
+
|
|
83
|
+
```md
|
|
84
|
+
:::tip[Title]
|
|
85
|
+
Shortcuts, best practices, "pro tips"
|
|
86
|
+
:::
|
|
87
|
+
|
|
88
|
+
:::note[Title]
|
|
89
|
+
Context, definitions, examples, prerequisites
|
|
90
|
+
:::
|
|
91
|
+
|
|
92
|
+
:::caution[Title]
|
|
93
|
+
Caveats, potential issues, things to watch out for
|
|
94
|
+
:::
|
|
95
|
+
|
|
96
|
+
:::danger[Title]
|
|
97
|
+
Critical warnings only — data loss, security issues
|
|
98
|
+
:::
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Standard Admonition Uses
|
|
102
|
+
|
|
103
|
+
| Admonition | Standard Use in Tutorials |
|
|
104
|
+
|------------|---------------------------|
|
|
105
|
+
| `:::note[Prerequisites]` | What users need before starting |
|
|
106
|
+
| `:::tip[Quick Path]` | TL;DR summary at top of tutorial |
|
|
107
|
+
| `:::caution[Fresh Chats]` | Context limitation reminders |
|
|
108
|
+
| `:::note[Example]` | Command/response examples |
|
|
109
|
+
| `:::tip[Check Your Status]` | How to verify progress |
|
|
110
|
+
| `:::tip[Remember These]` | Key takeaways at end |
|
|
111
|
+
|
|
112
|
+
### Admonition Guidelines
|
|
113
|
+
|
|
114
|
+
- **Always include a title** for tip, info, and warning
|
|
115
|
+
- **Keep content brief** — 1-3 sentences ideal
|
|
116
|
+
- **Don't overuse** — More than 3-4 per major section feels noisy
|
|
117
|
+
- **Don't nest** — Admonitions inside admonitions are hard to read
|
|
118
|
+
|
|
119
|
+
## Headers
|
|
120
|
+
|
|
121
|
+
### Budget
|
|
122
|
+
|
|
123
|
+
- **8-12 `##` sections** for full tutorials following standard structure
|
|
124
|
+
- **2-3 `###` subsections** per `##` section maximum
|
|
125
|
+
- **Avoid `####` entirely** — use bold text or admonitions instead
|
|
126
|
+
|
|
127
|
+
### Naming
|
|
128
|
+
|
|
129
|
+
- Use action verbs for steps: "Install BMad", "Create Your Plan"
|
|
130
|
+
- Use nouns for reference sections: "Common Questions", "Quick Reference"
|
|
131
|
+
- Keep headers short and scannable
|
|
132
|
+
|
|
133
|
+
## Code Blocks
|
|
134
|
+
|
|
135
|
+
### Do
|
|
136
|
+
|
|
137
|
+
```md
|
|
138
|
+
```bash
|
|
139
|
+
npx bmad-method install
|
|
140
|
+
```
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Don't
|
|
144
|
+
|
|
145
|
+
````md
|
|
146
|
+
```
|
|
147
|
+
You: Do something
|
|
148
|
+
Agent: [Response here]
|
|
149
|
+
```
|
|
150
|
+
````
|
|
151
|
+
|
|
152
|
+
For command/response examples, use an admonition instead:
|
|
153
|
+
|
|
154
|
+
```md
|
|
155
|
+
:::note[Example]
|
|
156
|
+
Run `workflow-status` and the agent will tell you the next recommended workflow.
|
|
157
|
+
:::
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Tables
|
|
161
|
+
|
|
162
|
+
Use tables for:
|
|
163
|
+
- Phases and what happens in each
|
|
164
|
+
- Agent roles and when to use them
|
|
165
|
+
- Command references
|
|
166
|
+
- Comparing options
|
|
167
|
+
- Step sequences with multiple attributes
|
|
168
|
+
|
|
169
|
+
Keep tables simple:
|
|
170
|
+
- 2-4 columns maximum
|
|
171
|
+
- Short cell content
|
|
172
|
+
- Left-align text, right-align numbers
|
|
173
|
+
|
|
174
|
+
### Standard Tables
|
|
175
|
+
|
|
176
|
+
**Phases Table:**
|
|
177
|
+
```md
|
|
178
|
+
| Phase | Name | What Happens |
|
|
179
|
+
|-------|------|--------------|
|
|
180
|
+
| 1 | Analysis | Brainstorm, research *(optional)* |
|
|
181
|
+
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
**Quick Reference Table:**
|
|
185
|
+
```md
|
|
186
|
+
| Command | Agent | Purpose |
|
|
187
|
+
|---------|-------|---------|
|
|
188
|
+
| `*workflow-init` | Analyst | Initialize a new project |
|
|
189
|
+
| `*prd` | PM | Create Product Requirements Document |
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
**Build Cycle Table:**
|
|
193
|
+
```md
|
|
194
|
+
| Step | Agent | Workflow | Purpose |
|
|
195
|
+
|------|-------|----------|---------|
|
|
196
|
+
| 1 | SM | `create-story` | Create story file from epic |
|
|
197
|
+
| 2 | DEV | `dev-story` | Implement the story |
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## Lists
|
|
201
|
+
|
|
202
|
+
### Flat Lists (Preferred)
|
|
203
|
+
|
|
204
|
+
```md
|
|
205
|
+
- **Option A** — Description of option A
|
|
206
|
+
- **Option B** — Description of option B
|
|
207
|
+
- **Option C** — Description of option C
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Numbered Steps
|
|
211
|
+
|
|
212
|
+
```md
|
|
213
|
+
1. Load the **PM agent** in a new chat
|
|
214
|
+
2. Run the PRD workflow: `*prd`
|
|
215
|
+
3. Output: `PRD.md`
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
### Avoid Deep Nesting
|
|
219
|
+
|
|
220
|
+
```md
|
|
221
|
+
<!-- Don't do this -->
|
|
222
|
+
1. First step
|
|
223
|
+
- Sub-step A
|
|
224
|
+
- Detail 1
|
|
225
|
+
- Detail 2
|
|
226
|
+
- Sub-step B
|
|
227
|
+
2. Second step
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Instead, break into separate sections or use an admonition for context.
|
|
231
|
+
|
|
232
|
+
## Links
|
|
233
|
+
|
|
234
|
+
- Use descriptive link text: `[Tutorial Style Guide](./tutorial-style.md)`
|
|
235
|
+
- Avoid "click here" or bare URLs
|
|
236
|
+
- Prefer relative paths within docs
|
|
237
|
+
|
|
238
|
+
## Images
|
|
239
|
+
|
|
240
|
+
- Always include alt text
|
|
241
|
+
- Add a caption in italics below: `*Description of the image.*`
|
|
242
|
+
- Use SVG for diagrams when possible
|
|
243
|
+
- Store in `./images/` relative to the document
|
|
244
|
+
|
|
245
|
+
## FAQ Sections
|
|
246
|
+
|
|
247
|
+
Use a TOC with jump links, `###` headers for questions, and direct answers:
|
|
248
|
+
|
|
249
|
+
```md
|
|
250
|
+
## Questions
|
|
251
|
+
|
|
252
|
+
- [Do I always need architecture?](#do-i-always-need-architecture)
|
|
253
|
+
- [Can I change my plan later?](#can-i-change-my-plan-later)
|
|
254
|
+
|
|
255
|
+
### Do I always need architecture?
|
|
256
|
+
|
|
257
|
+
Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
|
258
|
+
|
|
259
|
+
### Can I change my plan later?
|
|
260
|
+
|
|
261
|
+
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
|
262
|
+
|
|
263
|
+
**Have a question not answered here?** Please [open an issue](...) or ask in [Discord](...) so we can add it!
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### FAQ Guidelines
|
|
267
|
+
|
|
268
|
+
- **TOC at top** — Jump links under `## Questions` for quick navigation
|
|
269
|
+
- **`###` headers** — Questions are scannable and linkable (no `Q:` prefix)
|
|
270
|
+
- **Direct answers** — No `**A:**` prefix, just the answer
|
|
271
|
+
- **No "Related Documentation"** — Sidebar handles navigation; avoid repetitive links
|
|
272
|
+
- **End with CTA** — "Have a question not answered here?" with issue/Discord links
|
|
273
|
+
|
|
274
|
+
## Folder Structure Blocks
|
|
275
|
+
|
|
276
|
+
Show project structure in "What You've Accomplished":
|
|
277
|
+
|
|
278
|
+
````md
|
|
279
|
+
Your project now has:
|
|
280
|
+
|
|
281
|
+
```
|
|
282
|
+
your-project/
|
|
283
|
+
├── _bmad/ # BMad configuration
|
|
284
|
+
├── _bmad-output/
|
|
285
|
+
│ ├── PRD.md # Your requirements document
|
|
286
|
+
│ └── bmm-workflow-status.yaml # Progress tracking
|
|
287
|
+
└── ...
|
|
288
|
+
```
|
|
289
|
+
````
|
|
290
|
+
|
|
291
|
+
## Example: Before and After
|
|
292
|
+
|
|
293
|
+
### Before (Noisy)
|
|
294
|
+
|
|
295
|
+
```md
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## Getting Started
|
|
299
|
+
|
|
300
|
+
### Step 1: Initialize
|
|
301
|
+
|
|
302
|
+
#### What happens during init?
|
|
303
|
+
|
|
304
|
+
**Important:** You need to describe your project.
|
|
305
|
+
|
|
306
|
+
1. Your project goals
|
|
307
|
+
- What you want to build
|
|
308
|
+
- Why you're building it
|
|
309
|
+
2. The complexity
|
|
310
|
+
- Small, medium, or large
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### After (Clean)
|
|
316
|
+
|
|
317
|
+
```md
|
|
318
|
+
## Step 1: Initialize Your Project
|
|
319
|
+
|
|
320
|
+
Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`.
|
|
321
|
+
|
|
322
|
+
:::note[What Happens]
|
|
323
|
+
You'll describe your project goals and complexity. The workflow then recommends a planning track.
|
|
324
|
+
:::
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
## Checklist
|
|
328
|
+
|
|
329
|
+
Before submitting a tutorial:
|
|
330
|
+
|
|
331
|
+
- [ ] Follows the standard structure
|
|
332
|
+
- [ ] Has version/module notice if applicable
|
|
333
|
+
- [ ] Has "What You'll Learn" section
|
|
334
|
+
- [ ] Has Prerequisites admonition
|
|
335
|
+
- [ ] Has Quick Path TL;DR admonition
|
|
336
|
+
- [ ] No horizontal rules (`---`)
|
|
337
|
+
- [ ] No `####` headers
|
|
338
|
+
- [ ] Admonitions used for callouts (not bold paragraphs)
|
|
339
|
+
- [ ] Tables used for structured data (phases, commands, agents)
|
|
340
|
+
- [ ] Lists are flat (no deep nesting)
|
|
341
|
+
- [ ] Has "What You've Accomplished" section
|
|
342
|
+
- [ ] Has Quick Reference table
|
|
343
|
+
- [ ] Has Common Questions section
|
|
344
|
+
- [ ] Has Getting Help section
|
|
345
|
+
- [ ] Has Key Takeaways admonition
|
|
346
|
+
- [ ] All links use descriptive text
|
|
347
|
+
- [ ] Images have alt text and captions
|