bmad-fh 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 +40 -0
- package/.githooks/post-checkout +129 -0
- package/.githooks/pre-commit +63 -0
- package/.githooks/pre-push +135 -0
- package/.github/CODE_OF_CONDUCT.md +128 -0
- package/.github/FUNDING.yaml +15 -0
- package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.github/ISSUE_TEMPLATE/issue.md +32 -0
- package/.github/scripts/discord-helpers.sh +34 -0
- package/.github/workflows/bundle-latest.yaml +330 -0
- package/.github/workflows/discord.yaml +90 -0
- package/.github/workflows/docs.yaml +63 -0
- package/.github/workflows/manual-release.yaml +190 -0
- package/.github/workflows/publish-multi-artifact.yaml +50 -0
- package/.github/workflows/quality.yaml +115 -0
- package/.husky/pre-commit +20 -0
- package/.markdownlint-cli2.yaml +41 -0
- package/.nvmrc +1 -0
- package/.prettierignore +9 -0
- package/.vscode/settings.json +97 -0
- package/CHANGELOG.md +1394 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +306 -0
- package/CONTRIBUTORS.md +32 -0
- package/LICENSE +30 -0
- package/README.md +126 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/docs/404.md +9 -0
- package/docs/_README_WORKFLOW_DIAGRAMS.md +40 -0
- package/docs/_STYLE_GUIDE.md +367 -0
- package/docs/_archive/customize-workflows.md +30 -0
- package/docs/_archive/getting-started-bmadv4.md +247 -0
- package/docs/_archive/vendor-workflows.md +52 -0
- package/docs/downloads.md +72 -0
- package/docs/explanation/agents/barry-quick-flow.md +328 -0
- package/docs/explanation/agents/index.md +19 -0
- package/docs/explanation/architecture/four-phases.md +107 -0
- package/docs/explanation/architecture/preventing-agent-conflicts.md +111 -0
- package/docs/explanation/architecture/why-solutioning-matters.md +75 -0
- package/docs/explanation/bmm/index.md +131 -0
- package/docs/explanation/core/index.md +18 -0
- package/docs/explanation/core-concepts/agent-roles.md +179 -0
- package/docs/explanation/core-concepts/index.md +35 -0
- package/docs/explanation/core-concepts/what-are-agents.md +97 -0
- package/docs/explanation/core-concepts/what-are-modules.md +85 -0
- package/docs/explanation/core-concepts/what-are-workflows.md +204 -0
- package/docs/explanation/faq/brownfield-faq.md +73 -0
- package/docs/explanation/faq/getting-started-faq.md +67 -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 +277 -0
- package/docs/explanation/faq/workflows-faq.md +61 -0
- package/docs/explanation/features/advanced-elicitation.md +95 -0
- package/docs/explanation/features/brainstorming-techniques.md +92 -0
- package/docs/explanation/features/party-mode.md +95 -0
- package/docs/explanation/features/quick-flow.md +149 -0
- package/docs/explanation/features/tea-overview.md +410 -0
- package/docs/explanation/features/web-bundles.md +34 -0
- package/docs/explanation/philosophy/facilitation-over-generation.md +333 -0
- package/docs/explanation/philosophy/testing-as-engineering.md +112 -0
- package/docs/explanation/tea/engagement-models.md +710 -0
- package/docs/explanation/tea/fixture-architecture.md +457 -0
- package/docs/explanation/tea/knowledge-base-system.md +554 -0
- package/docs/explanation/tea/network-first-patterns.md +853 -0
- package/docs/explanation/tea/risk-based-testing.md +586 -0
- package/docs/explanation/tea/test-quality-standards.md +907 -0
- package/docs/how-to/brownfield/add-feature-to-existing.md +74 -0
- package/docs/how-to/brownfield/document-existing-project.md +66 -0
- package/docs/how-to/brownfield/index.md +84 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +77 -0
- package/docs/how-to/brownfield/use-tea-for-enterprise.md +526 -0
- package/docs/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
- package/docs/how-to/customization/customize-agents.md +212 -0
- package/docs/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
- package/docs/how-to/customization/index.md +23 -0
- package/docs/how-to/customization/integrate-playwright-utils.md +813 -0
- package/docs/how-to/customization/shard-large-documents.md +101 -0
- package/docs/how-to/get-answers-about-bmad.md +102 -0
- package/docs/how-to/installation/index.md +12 -0
- package/docs/how-to/installation/install-bmad.md +111 -0
- package/docs/how-to/installation/install-custom-modules.md +118 -0
- package/docs/how-to/installation/upgrade-to-v6.md +131 -0
- package/docs/how-to/workflows/bmgd-quick-flow.md +156 -0
- package/docs/how-to/workflows/conduct-research.md +97 -0
- package/docs/how-to/workflows/create-architecture.md +119 -0
- package/docs/how-to/workflows/create-epics-and-stories.md +109 -0
- package/docs/how-to/workflows/create-prd.md +91 -0
- package/docs/how-to/workflows/create-product-brief.md +94 -0
- package/docs/how-to/workflows/create-story.md +102 -0
- package/docs/how-to/workflows/create-ux-design.md +100 -0
- package/docs/how-to/workflows/implement-story.md +97 -0
- package/docs/how-to/workflows/quick-spec.md +122 -0
- package/docs/how-to/workflows/run-atdd.md +436 -0
- package/docs/how-to/workflows/run-automate.md +653 -0
- package/docs/how-to/workflows/run-brainstorming-session.md +73 -0
- package/docs/how-to/workflows/run-code-review.md +89 -0
- package/docs/how-to/workflows/run-implementation-readiness.md +125 -0
- package/docs/how-to/workflows/run-nfr-assess.md +679 -0
- package/docs/how-to/workflows/run-sprint-planning.md +94 -0
- package/docs/how-to/workflows/run-test-design.md +98 -0
- package/docs/how-to/workflows/run-test-review.md +605 -0
- package/docs/how-to/workflows/run-trace.md +883 -0
- package/docs/how-to/workflows/setup-ci.md +712 -0
- package/docs/how-to/workflows/setup-party-mode.md +89 -0
- package/docs/how-to/workflows/setup-test-framework.md +98 -0
- package/docs/index.md +63 -0
- package/docs/migration-guide.md +365 -0
- package/docs/multi-scope-guide.md +379 -0
- package/docs/plans/multi-scope-parallel-artifacts-plan.md +695 -0
- package/docs/reference/agents/index.md +109 -0
- package/docs/reference/configuration/core-tasks.md +67 -0
- package/docs/reference/configuration/global-config.md +28 -0
- package/docs/reference/glossary/index.md +159 -0
- package/docs/reference/tea/commands.md +254 -0
- package/docs/reference/tea/configuration.md +678 -0
- package/docs/reference/tea/knowledge-base.md +340 -0
- package/docs/reference/workflows/core-workflows.md +32 -0
- package/docs/reference/workflows/document-project.md +73 -0
- package/docs/reference/workflows/index.md +12 -0
- package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw +5034 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.svg +4 -0
- package/docs/tutorials/getting-started/images/workflow-overview.jpg +0 -0
- package/docs/tutorials/getting-started/tea-lite-quickstart.md +444 -0
- package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
- package/eslint.config.mjs +152 -0
- package/package.json +117 -0
- package/prettier.config.mjs +32 -0
- package/src/bmm/_module-installer/installer.js +48 -0
- package/src/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
- package/src/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
- package/src/bmm/agents/analyst.agent.yaml +41 -0
- package/src/bmm/agents/architect.agent.yaml +33 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/pm.agent.yaml +51 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +47 -0
- package/src/bmm/agents/tea.agent.yaml +68 -0
- package/src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
- package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +49 -0
- package/src/bmm/agents/ux-designer.agent.yaml +30 -0
- package/src/bmm/data/README.md +29 -0
- package/src/bmm/data/project-context-template.md +40 -0
- package/src/bmm/module.yaml +64 -0
- package/src/bmm/sub-modules/claude-code/config.yaml +4 -0
- package/src/bmm/sub-modules/claude-code/injections.yaml +242 -0
- package/src/bmm/sub-modules/claude-code/readme.md +87 -0
- package/src/bmm/teams/default-party.csv +21 -0
- package/src/bmm/teams/team-fullstack.yaml +12 -0
- package/src/bmm/testarch/knowledge/api-request.md +442 -0
- package/src/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/src/bmm/testarch/knowledge/auth-session.md +552 -0
- package/src/bmm/testarch/knowledge/burn-in.md +273 -0
- package/src/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/src/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/src/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/src/bmm/testarch/knowledge/data-factories.md +500 -0
- package/src/bmm/testarch/knowledge/email-auth.md +721 -0
- package/src/bmm/testarch/knowledge/error-handling.md +725 -0
- package/src/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/src/bmm/testarch/knowledge/file-utils.md +463 -0
- package/src/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/src/bmm/testarch/knowledge/fixtures-composition.md +382 -0
- package/src/bmm/testarch/knowledge/intercept-network-call.md +430 -0
- package/src/bmm/testarch/knowledge/log.md +429 -0
- package/src/bmm/testarch/knowledge/network-error-monitor.md +405 -0
- package/src/bmm/testarch/knowledge/network-first.md +486 -0
- package/src/bmm/testarch/knowledge/network-recorder.md +527 -0
- package/src/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/src/bmm/testarch/knowledge/overview.md +286 -0
- package/src/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/src/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/src/bmm/testarch/knowledge/recurse.md +421 -0
- package/src/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/src/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/src/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/src/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/src/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/src/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/src/bmm/testarch/knowledge/test-quality.md +664 -0
- package/src/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/src/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/src/bmm/testarch/tea-index.csv +34 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +194 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
- package/src/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
- package/src/bmm/workflows/1-analysis/research/workflow.md +173 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
- package/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/src/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
- package/src/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/src/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/src/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
- package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
- package/src/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/src/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
- package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
- package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/src/bmm/workflows/document-project/checklist.md +245 -0
- package/src/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/src/bmm/workflows/document-project/instructions.md +221 -0
- package/src/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/src/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/src/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/src/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/src/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/src/bmm/workflows/document-project/workflow.yaml +30 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/src/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
- package/src/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/src/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/src/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -0
- package/src/bmm/workflows/testarch/atdd/checklist.md +374 -0
- package/src/bmm/workflows/testarch/atdd/instructions.md +806 -0
- package/src/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/automate/checklist.md +582 -0
- package/src/bmm/workflows/testarch/automate/instructions.md +1324 -0
- package/src/bmm/workflows/testarch/automate/workflow.yaml +54 -0
- package/src/bmm/workflows/testarch/ci/checklist.md +248 -0
- package/src/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
- package/src/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
- package/src/bmm/workflows/testarch/ci/instructions.md +536 -0
- package/src/bmm/workflows/testarch/ci/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/framework/checklist.md +321 -0
- package/src/bmm/workflows/testarch/framework/instructions.md +481 -0
- package/src/bmm/workflows/testarch/framework/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/src/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
- package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -0
- package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/test-design/checklist.md +235 -0
- package/src/bmm/workflows/testarch/test-design/instructions.md +788 -0
- package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/src/bmm/workflows/testarch/test-design/workflow.yaml +56 -0
- package/src/bmm/workflows/testarch/test-review/checklist.md +472 -0
- package/src/bmm/workflows/testarch/test-review/instructions.md +628 -0
- package/src/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
- package/src/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
- package/src/bmm/workflows/testarch/trace/checklist.md +655 -0
- package/src/bmm/workflows/testarch/trace/instructions.md +1047 -0
- package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/src/bmm/workflows/workflow-status/init/instructions.md +346 -0
- package/src/bmm/workflows/workflow-status/init/workflow.yaml +30 -0
- package/src/bmm/workflows/workflow-status/instructions.md +397 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/project-levels.yaml +59 -0
- package/src/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
- package/src/bmm/workflows/workflow-status/workflow.yaml +32 -0
- package/src/core/_module-installer/installer.js +60 -0
- package/src/core/agents/bmad-master.agent.yaml +30 -0
- package/src/core/lib/scope/artifact-resolver.js +298 -0
- package/src/core/lib/scope/event-logger.js +411 -0
- package/src/core/lib/scope/index.js +30 -0
- package/src/core/lib/scope/scope-context.js +307 -0
- package/src/core/lib/scope/scope-initializer.js +458 -0
- package/src/core/lib/scope/scope-manager.js +512 -0
- package/src/core/lib/scope/scope-migrator.js +442 -0
- package/src/core/lib/scope/scope-sync.js +489 -0
- package/src/core/lib/scope/scope-validator.js +299 -0
- package/src/core/lib/scope/state-lock.js +342 -0
- package/src/core/module.yaml +53 -0
- package/src/core/resources/excalidraw/README.md +160 -0
- package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
- package/src/core/resources/excalidraw/library-loader.md +50 -0
- package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
- package/src/core/tasks/editorial-review-prose.xml +91 -0
- package/src/core/tasks/editorial-review-structure.xml +198 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +46 -0
- package/src/core/tasks/shard-doc.xml +109 -0
- package/src/core/tasks/workflow.xml +277 -0
- package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/src/core/workflows/advanced-elicitation/workflow.xml +117 -0
- package/src/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/src/core/workflows/brainstorming/template.md +15 -0
- package/src/core/workflows/brainstorming/workflow.md +58 -0
- package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
- package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
- package/src/core/workflows/party-mode/workflow.md +194 -0
- package/src/utility/agent-components/activation-rules.txt +6 -0
- package/src/utility/agent-components/activation-steps.txt +28 -0
- package/src/utility/agent-components/agent-command-header.md +1 -0
- package/src/utility/agent-components/agent.customize.template.yaml +41 -0
- package/src/utility/agent-components/handler-action.txt +4 -0
- package/src/utility/agent-components/handler-data.txt +5 -0
- package/src/utility/agent-components/handler-exec.txt +19 -0
- package/src/utility/agent-components/handler-multi.txt +14 -0
- package/src/utility/agent-components/handler-tmpl.txt +5 -0
- package/src/utility/agent-components/handler-validate-workflow.txt +7 -0
- package/src/utility/agent-components/handler-workflow.txt +10 -0
- package/src/utility/agent-components/menu-handlers.txt +6 -0
- package/test/README.md +295 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
- package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
- package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
- package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
- package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
- package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
- package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
- package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
- package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
- package/test/test-agent-schema.js +387 -0
- package/test/test-cli-integration.sh +159 -0
- package/test/test-installation-components.js +214 -0
- package/test/test-scope-e2e.js +450 -0
- package/test/test-scope-system.js +787 -0
- package/test/unit-test-schema.js +133 -0
- package/tools/bmad-npx-wrapper.js +38 -0
- package/tools/build-docs.js +577 -0
- package/tools/cli/README.md +7 -0
- package/tools/cli/bmad-cli.js +58 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/scope.js +474 -0
- package/tools/cli/external-official-modules.yaml +41 -0
- package/tools/cli/installers/install-messages.yaml +58 -0
- package/tools/cli/installers/lib/core/config-collector.js +1079 -0
- package/tools/cli/installers/lib/core/custom-module-cache.js +259 -0
- package/tools/cli/installers/lib/core/dependency-resolver.js +739 -0
- package/tools/cli/installers/lib/core/detector.js +223 -0
- package/tools/cli/installers/lib/core/ide-config-manager.js +156 -0
- package/tools/cli/installers/lib/core/installer.js +2585 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +963 -0
- package/tools/cli/installers/lib/core/manifest.js +590 -0
- package/tools/cli/installers/lib/custom/handler.js +363 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +654 -0
- package/tools/cli/installers/lib/ide/antigravity.js +486 -0
- package/tools/cli/installers/lib/ide/auggie.js +244 -0
- package/tools/cli/installers/lib/ide/claude-code.js +487 -0
- package/tools/cli/installers/lib/ide/cline.js +269 -0
- package/tools/cli/installers/lib/ide/codex.js +375 -0
- package/tools/cli/installers/lib/ide/crush.js +300 -0
- package/tools/cli/installers/lib/ide/cursor.js +169 -0
- package/tools/cli/installers/lib/ide/gemini.js +301 -0
- package/tools/cli/installers/lib/ide/github-copilot.js +383 -0
- package/tools/cli/installers/lib/ide/iflow.js +191 -0
- package/tools/cli/installers/lib/ide/kilo.js +250 -0
- package/tools/cli/installers/lib/ide/kiro-cli.js +326 -0
- package/tools/cli/installers/lib/ide/manager.js +244 -0
- package/tools/cli/installers/lib/ide/opencode.js +257 -0
- package/tools/cli/installers/lib/ide/qwen.js +372 -0
- package/tools/cli/installers/lib/ide/roo.js +270 -0
- package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +96 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +158 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +119 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +242 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +29 -0
- package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +30 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +45 -0
- package/tools/cli/installers/lib/ide/trae.js +313 -0
- package/tools/cli/installers/lib/ide/windsurf.js +258 -0
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/installers/lib/modules/external-manager.js +133 -0
- package/tools/cli/installers/lib/modules/manager.js +1362 -0
- package/tools/cli/lib/activation-builder.js +163 -0
- package/tools/cli/lib/agent/compiler.js +522 -0
- package/tools/cli/lib/agent/installer.js +716 -0
- package/tools/cli/lib/agent/template-engine.js +152 -0
- package/tools/cli/lib/agent-analyzer.js +109 -0
- package/tools/cli/lib/agent-party-generator.js +194 -0
- package/tools/cli/lib/cli-utils.js +227 -0
- package/tools/cli/lib/config.js +213 -0
- package/tools/cli/lib/file-ops.js +204 -0
- package/tools/cli/lib/platform-codes.js +116 -0
- package/tools/cli/lib/project-root.js +77 -0
- package/tools/cli/lib/prompts.js +433 -0
- package/tools/cli/lib/ui.js +1591 -0
- package/tools/cli/lib/xml-handler.js +177 -0
- package/tools/cli/lib/xml-to-markdown.js +82 -0
- package/tools/cli/lib/yaml-format.js +245 -0
- package/tools/cli/lib/yaml-xml-builder.js +587 -0
- package/tools/cli/scripts/migrate-workflows.js +281 -0
- package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
- package/tools/docs/index.md +2 -0
- package/tools/fix-doc-links.js +288 -0
- package/tools/flattener/aggregate.js +76 -0
- package/tools/flattener/binary.js +80 -0
- package/tools/flattener/discovery.js +71 -0
- package/tools/flattener/files.js +35 -0
- package/tools/flattener/ignoreRules.js +172 -0
- package/tools/flattener/main.js +483 -0
- package/tools/flattener/projectRoot.js +201 -0
- package/tools/flattener/prompts.js +44 -0
- package/tools/flattener/stats.helpers.js +368 -0
- package/tools/flattener/stats.js +75 -0
- package/tools/flattener/test-matrix.js +409 -0
- package/tools/flattener/xml.js +82 -0
- package/tools/format-workflow-md.js +263 -0
- package/tools/lib/xml-utils.js +13 -0
- package/tools/maintainer/review-pr-README.md +55 -0
- package/tools/maintainer/review-pr.md +242 -0
- package/tools/migrate-custom-module-paths.js +124 -0
- package/tools/platform-codes.yaml +157 -0
- package/tools/schema/agent.js +493 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +363 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/website/README.md +76 -0
- package/website/astro.config.mjs +228 -0
- package/website/public/favicon.ico +0 -0
- package/website/public/img/bmad-dark.png +0 -0
- package/website/public/img/bmad-light.png +0 -0
- package/website/public/img/logo.svg +4 -0
- package/website/public/robots.txt +37 -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 +485 -0
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "BMGD Quick-Flow Guide"
|
|
3
|
+
description: Fast-track workflows for rapid game prototyping and flexible development
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Testing a game mechanic idea
|
|
11
|
+
- Implementing a small feature
|
|
12
|
+
- Rapid prototyping before committing to design
|
|
13
|
+
- Bug fixes and tweaks
|
|
14
|
+
|
|
15
|
+
## When to Use Full BMGD Instead
|
|
16
|
+
|
|
17
|
+
- Building a major feature or system
|
|
18
|
+
- The scope is unclear or large
|
|
19
|
+
- Multiple team members need alignment
|
|
20
|
+
- The work affects game pillars or core loop
|
|
21
|
+
- You need documentation for future reference
|
|
22
|
+
|
|
23
|
+
:::note[Prerequisites]
|
|
24
|
+
- BMad Method installed with BMGD module
|
|
25
|
+
- Game Solo Dev agent (Indie) or other BMGD agent available
|
|
26
|
+
:::
|
|
27
|
+
|
|
28
|
+
## Game Solo Dev Agent
|
|
29
|
+
|
|
30
|
+
For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases.
|
|
31
|
+
|
|
32
|
+
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE.
|
|
33
|
+
|
|
34
|
+
Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework`
|
|
35
|
+
|
|
36
|
+
## Quick-Prototype
|
|
37
|
+
|
|
38
|
+
Use `quick-prototype` to rapidly test gameplay ideas with minimal setup.
|
|
39
|
+
|
|
40
|
+
### When to Use
|
|
41
|
+
|
|
42
|
+
- You have a mechanic idea and want to test the "feel"
|
|
43
|
+
- You're not sure if something will be fun
|
|
44
|
+
- You want to experiment before committing to design
|
|
45
|
+
- You need a proof of concept
|
|
46
|
+
|
|
47
|
+
### Steps
|
|
48
|
+
|
|
49
|
+
1. Run `quick-prototype`
|
|
50
|
+
2. Define what you're prototyping (mechanic, feature, system)
|
|
51
|
+
3. Set success criteria (2-3 items)
|
|
52
|
+
4. Build the minimum to test the idea
|
|
53
|
+
5. Playtest and evaluate
|
|
54
|
+
|
|
55
|
+
### Prototype Principles
|
|
56
|
+
|
|
57
|
+
- **Minimum Viable Prototype** — Only what's needed to test the idea
|
|
58
|
+
- **Hardcode First** — Magic numbers are fine, extract later
|
|
59
|
+
- **Skip Edge Cases** — Happy path only for now
|
|
60
|
+
- **Placeholder Everything** — Cubes, debug text, temp sounds
|
|
61
|
+
- **Comment Intent** — Mark what's temporary vs keeper code
|
|
62
|
+
|
|
63
|
+
### After Prototyping
|
|
64
|
+
|
|
65
|
+
- **Develop** (`d`) — Use `quick-dev` to build production code
|
|
66
|
+
- **Iterate** (`i`) — Adjust and re-test the prototype
|
|
67
|
+
- **Archive** (`a`) — Keep as reference, move on to other ideas
|
|
68
|
+
|
|
69
|
+
## Quick-Dev
|
|
70
|
+
|
|
71
|
+
Use `quick-dev` for flexible development with game-specific considerations.
|
|
72
|
+
|
|
73
|
+
### When to Use
|
|
74
|
+
|
|
75
|
+
- Implementing a feature from a tech-spec
|
|
76
|
+
- Building on a successful prototype
|
|
77
|
+
- Making changes that don't need full story workflow
|
|
78
|
+
- Quick fixes and improvements
|
|
79
|
+
|
|
80
|
+
### Workflow Modes
|
|
81
|
+
|
|
82
|
+
**Mode A: Tech-Spec Driven**
|
|
83
|
+
```
|
|
84
|
+
quick-dev tech-spec-combat.md
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Mode B: Direct Instructions**
|
|
88
|
+
```
|
|
89
|
+
quick-dev implement double-jump for the player
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**Mode C: From Prototype**
|
|
93
|
+
```
|
|
94
|
+
quick-dev from the grappling hook prototype
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Game-Specific Checks
|
|
98
|
+
|
|
99
|
+
Quick-dev includes automatic consideration of:
|
|
100
|
+
- **Performance** — No allocations in hot paths, object pooling
|
|
101
|
+
- **Feel** — Input responsiveness, visual/audio feedback
|
|
102
|
+
- **Integration** — Save/load, multiplayer sync, platform testing
|
|
103
|
+
|
|
104
|
+
### Complexity Routing
|
|
105
|
+
|
|
106
|
+
| Signals | Recommendation |
|
|
107
|
+
|---------|----------------|
|
|
108
|
+
| Single mechanic, bug fix, tweak | Execute directly |
|
|
109
|
+
| Multiple systems, performance-critical | Plan first (tech-spec) |
|
|
110
|
+
| Platform/system level work | Use full BMGD workflow |
|
|
111
|
+
|
|
112
|
+
## Choosing Between Quick-Flows
|
|
113
|
+
|
|
114
|
+
| Scenario | Use |
|
|
115
|
+
|----------|-----|
|
|
116
|
+
| "Will this be fun?" | `quick-prototype` |
|
|
117
|
+
| "How should this feel?" | `quick-prototype` |
|
|
118
|
+
| "Build this feature" | `quick-dev` |
|
|
119
|
+
| "Fix this bug" | `quick-dev` |
|
|
120
|
+
| "Test then build" | `quick-prototype` → `quick-dev` |
|
|
121
|
+
|
|
122
|
+
## Flow Comparison
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
Full BMGD Flow:
|
|
126
|
+
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
|
127
|
+
|
|
128
|
+
Quick-Flow:
|
|
129
|
+
Idea → Quick-Prototype → Quick-Dev → Done
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Checklists
|
|
133
|
+
|
|
134
|
+
**Quick-Prototype:**
|
|
135
|
+
- [ ] Prototype scope defined
|
|
136
|
+
- [ ] Success criteria established (2-3 items)
|
|
137
|
+
- [ ] Minimum viable code written
|
|
138
|
+
- [ ] Placeholder assets used
|
|
139
|
+
- [ ] Each criterion evaluated
|
|
140
|
+
- [ ] Decision made (develop/iterate/archive)
|
|
141
|
+
|
|
142
|
+
**Quick-Dev:**
|
|
143
|
+
- [ ] Context loaded (spec, prototype, or guidance)
|
|
144
|
+
- [ ] Files to modify identified
|
|
145
|
+
- [ ] All tasks completed
|
|
146
|
+
- [ ] No allocations in hot paths
|
|
147
|
+
- [ ] Game runs without errors
|
|
148
|
+
- [ ] Manual playtest completed
|
|
149
|
+
|
|
150
|
+
## Tips
|
|
151
|
+
|
|
152
|
+
- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back
|
|
153
|
+
- **Embrace programmer art** — Focus on feel, not visuals
|
|
154
|
+
- **Test on target hardware** — What feels right on dev machine might not on target
|
|
155
|
+
- **Document learnings** — Even failed prototypes teach something
|
|
156
|
+
- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Conduct Research"
|
|
3
|
+
description: How to conduct market, technical, and competitive research using BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Need market viability validation
|
|
11
|
+
- Choosing frameworks or platforms
|
|
12
|
+
- Understanding competitive landscape
|
|
13
|
+
- Need user understanding
|
|
14
|
+
- Understanding domain or industry
|
|
15
|
+
- Need deeper AI-assisted research
|
|
16
|
+
|
|
17
|
+
:::note[Prerequisites]
|
|
18
|
+
- BMad Method installed
|
|
19
|
+
- Analyst agent available
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
## Steps
|
|
23
|
+
|
|
24
|
+
### 1. Load the Analyst Agent
|
|
25
|
+
|
|
26
|
+
Start a fresh chat and load the Analyst agent.
|
|
27
|
+
|
|
28
|
+
### 2. Run the Research Workflow
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
*research
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 3. Choose Research Type
|
|
35
|
+
|
|
36
|
+
Select the type of research you need:
|
|
37
|
+
|
|
38
|
+
| Type | Purpose | Use When |
|
|
39
|
+
|------|---------|----------|
|
|
40
|
+
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
|
|
41
|
+
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
|
|
42
|
+
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
|
|
43
|
+
| **user** | Customer insights, personas, JTBD | Need user understanding |
|
|
44
|
+
| **domain** | Industry deep dives, trends | Understanding domain/industry |
|
|
45
|
+
| **deep_prompt** | Generate AI research prompts | Need deeper AI-assisted research |
|
|
46
|
+
|
|
47
|
+
### 4. Provide Context
|
|
48
|
+
|
|
49
|
+
Give the agent details about what you're researching:
|
|
50
|
+
|
|
51
|
+
- "SaaS project management tool"
|
|
52
|
+
- "React vs Vue for our dashboard"
|
|
53
|
+
- "Fintech compliance requirements"
|
|
54
|
+
|
|
55
|
+
### 5. Set Research Depth
|
|
56
|
+
|
|
57
|
+
Choose your depth level:
|
|
58
|
+
|
|
59
|
+
- **Quick** — Fast overview
|
|
60
|
+
- **Standard** — Balanced depth
|
|
61
|
+
- **Comprehensive** — Deep analysis
|
|
62
|
+
|
|
63
|
+
## What You Get
|
|
64
|
+
|
|
65
|
+
Research output varies by type:
|
|
66
|
+
|
|
67
|
+
**Market Research:**
|
|
68
|
+
- TAM/SAM/SOM analysis
|
|
69
|
+
- Top competitors
|
|
70
|
+
- Positioning recommendation
|
|
71
|
+
|
|
72
|
+
**Technical Research:**
|
|
73
|
+
- Comparison matrix
|
|
74
|
+
- Trade-off analysis
|
|
75
|
+
- Recommendations with rationale
|
|
76
|
+
|
|
77
|
+
## Key Features
|
|
78
|
+
|
|
79
|
+
- Real-time web research
|
|
80
|
+
- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle)
|
|
81
|
+
- Platform-specific optimization for deep_prompt type
|
|
82
|
+
- Configurable research depth
|
|
83
|
+
|
|
84
|
+
## Tips
|
|
85
|
+
|
|
86
|
+
- **Use market research early** — Validates new product ideas
|
|
87
|
+
- **Technical research helps architecture** — Inform ADRs with data
|
|
88
|
+
- **Competitive research informs positioning** — Differentiate your product
|
|
89
|
+
- **Domain research for specialized industries** — Fintech, healthcare, etc.
|
|
90
|
+
|
|
91
|
+
## Next Steps
|
|
92
|
+
|
|
93
|
+
After research:
|
|
94
|
+
|
|
95
|
+
1. **Product Brief** — Capture strategic vision informed by research
|
|
96
|
+
2. **PRD** — Use findings as context for requirements
|
|
97
|
+
3. **Architecture** — Use technical research in ADRs
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Create Architecture"
|
|
3
|
+
description: How to create system architecture using the BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Multi-epic projects (BMad Method, Enterprise)
|
|
11
|
+
- Cross-cutting technical concerns
|
|
12
|
+
- Multiple agents implementing different parts
|
|
13
|
+
- Integration complexity exists
|
|
14
|
+
- Technology choices need alignment
|
|
15
|
+
|
|
16
|
+
## When to Skip This
|
|
17
|
+
|
|
18
|
+
- Quick Flow (simple changes)
|
|
19
|
+
- BMad Method Simple with straightforward tech stack
|
|
20
|
+
- Single epic with clear technical approach
|
|
21
|
+
|
|
22
|
+
:::note[Prerequisites]
|
|
23
|
+
- BMad Method installed
|
|
24
|
+
- Architect agent available
|
|
25
|
+
- PRD completed
|
|
26
|
+
:::
|
|
27
|
+
|
|
28
|
+
## Steps
|
|
29
|
+
|
|
30
|
+
### 1. Load the Architect Agent
|
|
31
|
+
|
|
32
|
+
Start a fresh chat and load the Architect agent.
|
|
33
|
+
|
|
34
|
+
### 2. Run the Architecture Workflow
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
*create-architecture
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 3. Engage in Discovery
|
|
41
|
+
|
|
42
|
+
This is NOT a template filler. The architecture workflow:
|
|
43
|
+
|
|
44
|
+
1. **Discovers** technical needs through conversation
|
|
45
|
+
2. **Proposes** architectural options with trade-offs
|
|
46
|
+
3. **Documents** decisions that prevent agent conflicts
|
|
47
|
+
4. **Focuses** on decision points, not exhaustive documentation
|
|
48
|
+
|
|
49
|
+
### 4. Document Key Decisions
|
|
50
|
+
|
|
51
|
+
Work with the agent to create Architecture Decision Records (ADRs) for significant choices.
|
|
52
|
+
|
|
53
|
+
### 5. Review the Architecture
|
|
54
|
+
|
|
55
|
+
The agent produces a decision-focused architecture document.
|
|
56
|
+
|
|
57
|
+
## What You Get
|
|
58
|
+
|
|
59
|
+
An `architecture.md` document containing:
|
|
60
|
+
|
|
61
|
+
1. **Architecture Overview** — System context, principles, style
|
|
62
|
+
2. **System Architecture** — High-level diagram, component interactions
|
|
63
|
+
3. **Data Architecture** — Database design, state management, caching
|
|
64
|
+
4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning
|
|
65
|
+
5. **Frontend Architecture** — Framework, state management, components
|
|
66
|
+
6. **Integration Architecture** — Third-party integrations, messaging
|
|
67
|
+
7. **Security Architecture** — Auth/authorization, data protection
|
|
68
|
+
8. **Deployment Architecture** — CI/CD, environments, monitoring
|
|
69
|
+
9. **ADRs** — Key decisions with context, options, rationale
|
|
70
|
+
10. **FR/NFR-Specific Guidance** — Technical approach per requirement
|
|
71
|
+
11. **Standards and Conventions** — Directory structure, naming, testing
|
|
72
|
+
|
|
73
|
+
## ADR Format
|
|
74
|
+
|
|
75
|
+
```markdown
|
|
76
|
+
## ADR-001: Use GraphQL for All APIs
|
|
77
|
+
|
|
78
|
+
**Status:** Accepted | **Date:** 2025-11-02
|
|
79
|
+
|
|
80
|
+
**Context:** PRD requires flexible querying across multiple epics
|
|
81
|
+
|
|
82
|
+
**Decision:** Use GraphQL for all client-server communication
|
|
83
|
+
|
|
84
|
+
**Options Considered:**
|
|
85
|
+
1. REST - Familiar but requires multiple endpoints
|
|
86
|
+
2. GraphQL - Flexible querying, learning curve
|
|
87
|
+
3. gRPC - High performance, poor browser support
|
|
88
|
+
|
|
89
|
+
**Rationale:**
|
|
90
|
+
- PRD requires flexible data fetching (Epic 1, 3)
|
|
91
|
+
- Mobile app needs bandwidth optimization (Epic 2)
|
|
92
|
+
- Team has GraphQL experience
|
|
93
|
+
|
|
94
|
+
**Consequences:**
|
|
95
|
+
- Positive: Flexible querying, reduced versioning
|
|
96
|
+
- Negative: Caching complexity, N+1 query risk
|
|
97
|
+
- Mitigation: Use DataLoader for batching
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Example
|
|
101
|
+
|
|
102
|
+
E-commerce platform produces:
|
|
103
|
+
- Monolith + PostgreSQL + Redis + Next.js + GraphQL
|
|
104
|
+
- ADRs explaining each choice
|
|
105
|
+
- FR/NFR-specific implementation guidance
|
|
106
|
+
|
|
107
|
+
## Tips
|
|
108
|
+
|
|
109
|
+
- **Focus on decisions that prevent conflicts** — Multiple agents need alignment
|
|
110
|
+
- **Use ADRs for every significant choice** — Document the "why"
|
|
111
|
+
- **Keep it practical** — Don't over-architect
|
|
112
|
+
- **Architecture is living** — Update as you learn
|
|
113
|
+
|
|
114
|
+
## Next Steps
|
|
115
|
+
|
|
116
|
+
After architecture:
|
|
117
|
+
|
|
118
|
+
1. **Create Epics and Stories** — Work breakdown informed by architecture
|
|
119
|
+
2. **Implementation Readiness** — Gate check before Phase 4
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Create Epics and Stories"
|
|
3
|
+
description: How to break PRD requirements into epics and stories using BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- After architecture workflow completes
|
|
11
|
+
- When PRD contains FRs/NFRs ready for implementation breakdown
|
|
12
|
+
- Before implementation-readiness gate check
|
|
13
|
+
|
|
14
|
+
:::note[Prerequisites]
|
|
15
|
+
- BMad Method installed
|
|
16
|
+
- PM agent available
|
|
17
|
+
- PRD completed
|
|
18
|
+
- Architecture completed
|
|
19
|
+
:::
|
|
20
|
+
|
|
21
|
+
## Why After Architecture?
|
|
22
|
+
|
|
23
|
+
This workflow runs AFTER architecture because:
|
|
24
|
+
|
|
25
|
+
1. **Informed Story Sizing** — Architecture decisions affect story complexity
|
|
26
|
+
2. **Dependency Awareness** — Architecture reveals technical dependencies
|
|
27
|
+
3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack
|
|
28
|
+
4. **Consistency** — All stories align with documented architectural patterns
|
|
29
|
+
|
|
30
|
+
## Steps
|
|
31
|
+
|
|
32
|
+
### 1. Load the PM Agent
|
|
33
|
+
|
|
34
|
+
Start a fresh chat and load the PM agent.
|
|
35
|
+
|
|
36
|
+
### 2. Run the Workflow
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
*create-epics-and-stories
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 3. Provide Context
|
|
43
|
+
|
|
44
|
+
Point the agent to:
|
|
45
|
+
- Your PRD (FRs/NFRs)
|
|
46
|
+
- Your architecture document
|
|
47
|
+
- Optional: UX design artifacts
|
|
48
|
+
|
|
49
|
+
### 4. Review Epic Breakdown
|
|
50
|
+
|
|
51
|
+
The agent organizes requirements into logical epics with user stories.
|
|
52
|
+
|
|
53
|
+
### 5. Validate Story Quality
|
|
54
|
+
|
|
55
|
+
Ensure each story has:
|
|
56
|
+
- Clear acceptance criteria
|
|
57
|
+
- Appropriate priority
|
|
58
|
+
- Identified dependencies
|
|
59
|
+
- Technical notes from architecture
|
|
60
|
+
|
|
61
|
+
## What You Get
|
|
62
|
+
|
|
63
|
+
Epic files (one per epic) containing:
|
|
64
|
+
|
|
65
|
+
1. **Epic objective and scope**
|
|
66
|
+
2. **User stories with acceptance criteria**
|
|
67
|
+
3. **Story priorities** (P0/P1/P2/P3)
|
|
68
|
+
4. **Dependencies between stories**
|
|
69
|
+
5. **Technical notes** referencing architecture decisions
|
|
70
|
+
|
|
71
|
+
## Example
|
|
72
|
+
|
|
73
|
+
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
|
74
|
+
|
|
75
|
+
- **Epic 1: User Management** (3 stories)
|
|
76
|
+
- Story 1.1: User registration form
|
|
77
|
+
- Story 1.2: Email verification
|
|
78
|
+
- Story 1.3: Login/logout
|
|
79
|
+
|
|
80
|
+
- **Epic 2: Product Display** (4 stories)
|
|
81
|
+
- Story 2.1: Product listing page
|
|
82
|
+
- Story 2.2: Product detail page
|
|
83
|
+
- Story 2.3: Search functionality
|
|
84
|
+
- Story 2.4: Category filtering
|
|
85
|
+
|
|
86
|
+
Each story references relevant ADRs from architecture.
|
|
87
|
+
|
|
88
|
+
## Story Priority Levels
|
|
89
|
+
|
|
90
|
+
| Priority | Meaning |
|
|
91
|
+
|----------|---------|
|
|
92
|
+
| **P0** | Critical — Must have for MVP |
|
|
93
|
+
| **P1** | High — Important for release |
|
|
94
|
+
| **P2** | Medium — Nice to have |
|
|
95
|
+
| **P3** | Low — Future consideration |
|
|
96
|
+
|
|
97
|
+
## Tips
|
|
98
|
+
|
|
99
|
+
- **Keep stories small** — Complete in a single session
|
|
100
|
+
- **Make criteria testable** — Acceptance criteria should be verifiable
|
|
101
|
+
- **Document dependencies clearly** — Know what blocks what
|
|
102
|
+
- **Reference architecture** — Include ADR references in technical notes
|
|
103
|
+
|
|
104
|
+
## Next Steps
|
|
105
|
+
|
|
106
|
+
After creating epics and stories:
|
|
107
|
+
|
|
108
|
+
1. **Implementation Readiness** — Validate alignment before Phase 4
|
|
109
|
+
2. **Sprint Planning** — Organize work for implementation
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Create a PRD"
|
|
3
|
+
description: How to create a Product Requirements Document using the BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Medium to large feature sets
|
|
11
|
+
- Multi-screen user experiences
|
|
12
|
+
- Complex business logic
|
|
13
|
+
- Multiple system integrations
|
|
14
|
+
- Phased delivery required
|
|
15
|
+
|
|
16
|
+
:::note[Prerequisites]
|
|
17
|
+
- BMad Method installed
|
|
18
|
+
- PM agent available
|
|
19
|
+
- Optional: Product brief from Phase 1
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
## Steps
|
|
23
|
+
|
|
24
|
+
### 1. Load the PM Agent
|
|
25
|
+
|
|
26
|
+
Start a fresh chat and load the PM agent.
|
|
27
|
+
|
|
28
|
+
### 2. Run the PRD Workflow
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
*create-prd
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 3. Provide Context
|
|
35
|
+
|
|
36
|
+
The workflow will:
|
|
37
|
+
- Load any existing product brief
|
|
38
|
+
- Ask about your project scope
|
|
39
|
+
- Gather requirements through conversation
|
|
40
|
+
|
|
41
|
+
### 4. Define Requirements
|
|
42
|
+
|
|
43
|
+
Work with the agent to define:
|
|
44
|
+
- Functional Requirements (FRs) — What the system should do
|
|
45
|
+
- Non-Functional Requirements (NFRs) — How well it should do it
|
|
46
|
+
|
|
47
|
+
### 5. Review the PRD
|
|
48
|
+
|
|
49
|
+
The agent produces a comprehensive PRD scaled to your project.
|
|
50
|
+
|
|
51
|
+
## What You Get
|
|
52
|
+
|
|
53
|
+
A `PRD.md` document containing:
|
|
54
|
+
|
|
55
|
+
- Executive summary
|
|
56
|
+
- Problem statement
|
|
57
|
+
- User personas
|
|
58
|
+
- Functional requirements (FRs)
|
|
59
|
+
- Non-functional requirements (NFRs)
|
|
60
|
+
- Success metrics
|
|
61
|
+
- Risks and assumptions
|
|
62
|
+
|
|
63
|
+
## Scale-Adaptive Structure
|
|
64
|
+
|
|
65
|
+
The PRD adapts to your project complexity:
|
|
66
|
+
|
|
67
|
+
| Scale | Pages | Focus |
|
|
68
|
+
|-------|-------|-------|
|
|
69
|
+
| **Light** | 10-15 | Focused FRs/NFRs, simplified analysis |
|
|
70
|
+
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
|
71
|
+
| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis |
|
|
72
|
+
|
|
73
|
+
## Example
|
|
74
|
+
|
|
75
|
+
E-commerce checkout → PRD with:
|
|
76
|
+
- 15 FRs (user account, cart management, payment flow)
|
|
77
|
+
- 8 NFRs (performance, security, scalability)
|
|
78
|
+
|
|
79
|
+
## Tips
|
|
80
|
+
|
|
81
|
+
- **Do Product Brief first** — Run product-brief from Phase 1 for better results
|
|
82
|
+
- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3
|
|
83
|
+
- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context
|
|
84
|
+
|
|
85
|
+
## Next Steps
|
|
86
|
+
|
|
87
|
+
After PRD:
|
|
88
|
+
|
|
89
|
+
1. **Create UX Design** (optional) — If UX is critical
|
|
90
|
+
2. **Create Architecture** — Technical design
|
|
91
|
+
3. **Create Epics and Stories** — After architecture
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Create a Product Brief"
|
|
3
|
+
description: How to create a product brief using the BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Starting new product or major feature initiative
|
|
11
|
+
- Aligning stakeholders before detailed planning
|
|
12
|
+
- Transitioning from exploration to strategy
|
|
13
|
+
- Need executive-level product documentation
|
|
14
|
+
|
|
15
|
+
:::note[Prerequisites]
|
|
16
|
+
- BMad Method installed
|
|
17
|
+
- Analyst agent available
|
|
18
|
+
- Optional: Research documents from previous workflows
|
|
19
|
+
:::
|
|
20
|
+
|
|
21
|
+
## Steps
|
|
22
|
+
|
|
23
|
+
### 1. Load the Analyst Agent
|
|
24
|
+
|
|
25
|
+
Start a fresh chat and load the Analyst agent.
|
|
26
|
+
|
|
27
|
+
### 2. Run the Product Brief Workflow
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
*product-brief
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 3. Answer the Interactive Questions
|
|
34
|
+
|
|
35
|
+
The workflow guides you through strategic product vision definition:
|
|
36
|
+
|
|
37
|
+
- What problem are you solving?
|
|
38
|
+
- Who are your target users?
|
|
39
|
+
- What makes this solution different?
|
|
40
|
+
- What's the MVP scope?
|
|
41
|
+
|
|
42
|
+
### 4. Review and Refine
|
|
43
|
+
|
|
44
|
+
The agent will draft sections and let you refine them interactively.
|
|
45
|
+
|
|
46
|
+
## What You Get
|
|
47
|
+
|
|
48
|
+
The `product-brief.md` document includes:
|
|
49
|
+
|
|
50
|
+
- **Executive summary** — High-level overview
|
|
51
|
+
- **Problem statement** — With evidence
|
|
52
|
+
- **Proposed solution** — And differentiators
|
|
53
|
+
- **Target users** — Segmented
|
|
54
|
+
- **MVP scope** — Ruthlessly defined
|
|
55
|
+
- **Financial impact** — And ROI
|
|
56
|
+
- **Strategic alignment** — With business goals
|
|
57
|
+
- **Risks and open questions** — Documented upfront
|
|
58
|
+
|
|
59
|
+
## Integration with Other Workflows
|
|
60
|
+
|
|
61
|
+
The product brief feeds directly into the PRD workflow:
|
|
62
|
+
|
|
63
|
+
| Analysis Output | Planning Input |
|
|
64
|
+
|-----------------|----------------|
|
|
65
|
+
| product-brief.md | **prd** workflow |
|
|
66
|
+
| market-research.md | **prd** context |
|
|
67
|
+
| technical-research.md | **architecture** (Phase 3) |
|
|
68
|
+
|
|
69
|
+
Planning workflows automatically load the product brief if it exists.
|
|
70
|
+
|
|
71
|
+
## Common Patterns
|
|
72
|
+
|
|
73
|
+
**Greenfield Software (Full Analysis):**
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
1. brainstorm-project - explore approaches
|
|
77
|
+
2. research (market/technical/domain) - validate viability
|
|
78
|
+
3. product-brief - capture strategic vision
|
|
79
|
+
4. → Phase 2: prd
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Skip Analysis (Clear Requirements):**
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
→ Phase 2: prd or tech-spec directly
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Tips
|
|
89
|
+
|
|
90
|
+
- **Be specific about the problem** — Vague problems lead to vague solutions
|
|
91
|
+
- **Ruthlessly prioritize MVP scope** — Less is more
|
|
92
|
+
- **Document assumptions and risks** — Surface unknowns early
|
|
93
|
+
- **Use research findings as evidence** — Back up claims with data
|
|
94
|
+
- **Recommended for greenfield projects** — Sets strategic foundation
|