observer-ggboy-bmad-method 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/.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/quality.yaml +115 -0
- package/.health-status.json +7 -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 +167 -0
- package/CONTRIBUTORS.md +32 -0
- package/LICENSE +30 -0
- package/README.md +100 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/bmad-method-6.0.0-alpha.23.tgz +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 +525 -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 +135 -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/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 +276 -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 +36 -0
- package/src/bmm/agents/architect.agent.yaml +28 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/pm.agent.yaml +46 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +36 -0
- package/src/bmm/agents/tea.agent.yaml +63 -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 +45 -0
- package/src/bmm/agents/ux-designer.agent.yaml +26 -0
- package/src/bmm/data/project-context-template.md +26 -0
- package/src/bmm/module-help.csv +32 -0
- package/src/bmm/module.yaml +44 -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/adr-quality-readiness-checklist.md +350 -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 +35 -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 +162 -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 +171 -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 +124 -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 +231 -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 +135 -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 +76 -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 +149 -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/data/project-levels.yaml +59 -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 +50 -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/testarch/atdd/atdd-checklist-template.md +363 -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 +247 -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 +320 -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 +726 -0
- package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +461 -0
- package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/test-design/checklist.md +407 -0
- package/src/bmm/workflows/testarch/test-design/instructions.md +1158 -0
- package/src/bmm/workflows/testarch/test-design/test-design-architecture-template.md +213 -0
- package/src/bmm/workflows/testarch/test-design/test-design-qa-template.md +286 -0
- package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/src/bmm/workflows/testarch/test-design/workflow.yaml +71 -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 +642 -0
- package/src/bmm/workflows/testarch/trace/instructions.md +1030 -0
- package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/src/core/_module-installer/installer.js +60 -0
- package/src/core/agents/bmad-master.agent.yaml +29 -0
- package/src/core/module-help.csv +9 -0
- package/src/core/module.yaml +25 -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 +100 -0
- package/src/core/tasks/editorial-review-structure.xml +209 -0
- package/src/core/tasks/help.md +62 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +48 -0
- package/src/core/tasks/shard-doc.xml +109 -0
- package/src/core/tasks/workflow.xml +235 -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 +14 -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 +6 -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/adversarial-review-tests/README.md +56 -0
- package/test/adversarial-review-tests/sample-content.md +46 -0
- package/test/adversarial-review-tests/test-cases.yaml +103 -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/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/status.js +65 -0
- package/tools/cli/external-official-modules.yaml +56 -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 +2826 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +1054 -0
- package/tools/cli/installers/lib/core/manifest.js +1036 -0
- package/tools/cli/installers/lib/custom/handler.js +363 -0
- package/tools/cli/installers/lib/ide/STANDARDIZATION_PLAN.md +208 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +655 -0
- package/tools/cli/installers/lib/ide/antigravity.js +474 -0
- package/tools/cli/installers/lib/ide/auggie.js +244 -0
- package/tools/cli/installers/lib/ide/claude-code.js +506 -0
- package/tools/cli/installers/lib/ide/cline.js +272 -0
- package/tools/cli/installers/lib/ide/codex.js +412 -0
- package/tools/cli/installers/lib/ide/crush.js +149 -0
- package/tools/cli/installers/lib/ide/cursor.js +160 -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 +273 -0
- package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +165 -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/path-utils.js +165 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +268 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +293 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -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 +13 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +5 -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 +135 -0
- package/tools/cli/installers/lib/modules/manager.js +1375 -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 +1716 -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/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 +491 -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,224 @@
|
|
|
1
|
+
# Technical Documentation Standards for BMAD
|
|
2
|
+
|
|
3
|
+
CommonMark standards, technical writing best practices, and style guide compliance.
|
|
4
|
+
|
|
5
|
+
## User Specified CRITICAL Rules - Supersedes General CRITICAL RULES
|
|
6
|
+
|
|
7
|
+
None
|
|
8
|
+
|
|
9
|
+
## General CRITICAL RULES
|
|
10
|
+
|
|
11
|
+
### Rule 1: CommonMark Strict Compliance
|
|
12
|
+
|
|
13
|
+
ALL documentation MUST follow CommonMark specification exactly. No exceptions.
|
|
14
|
+
|
|
15
|
+
### Rule 2: NO TIME ESTIMATES
|
|
16
|
+
|
|
17
|
+
NEVER document time estimates, durations, level of effort or completion times for any workflow, task, or activity unless EXPLICITLY asked by the user. This includes:
|
|
18
|
+
|
|
19
|
+
- NO Workflow execution time (e.g., "30-60 min", "2-8 hours")
|
|
20
|
+
- NO Task duration and level of effort estimates
|
|
21
|
+
- NO Reading time estimates
|
|
22
|
+
- NO Implementation time ranges
|
|
23
|
+
- NO Any temporal or capacity based measurements
|
|
24
|
+
|
|
25
|
+
**Instead:** Focus on workflow steps, dependencies, and outputs. Let users determine their own timelines and level of effort.
|
|
26
|
+
|
|
27
|
+
### CommonMark Essentials
|
|
28
|
+
|
|
29
|
+
**Headers:**
|
|
30
|
+
|
|
31
|
+
- Use ATX-style ONLY: `#` `##` `###` (NOT Setext underlines)
|
|
32
|
+
- Single space after `#`: `# Title` (NOT `#Title`)
|
|
33
|
+
- No trailing `#`: `# Title` (NOT `# Title #`)
|
|
34
|
+
- Hierarchical order: Don't skip levels (h1→h2→h3, not h1→h3)
|
|
35
|
+
|
|
36
|
+
**Code Blocks:**
|
|
37
|
+
|
|
38
|
+
- Use fenced blocks with language identifier:
|
|
39
|
+
````markdown
|
|
40
|
+
```javascript
|
|
41
|
+
const example = 'code';
|
|
42
|
+
```
|
|
43
|
+
````
|
|
44
|
+
- NOT indented code blocks (ambiguous)
|
|
45
|
+
|
|
46
|
+
**Lists:**
|
|
47
|
+
|
|
48
|
+
- Consistent markers within list: all `-` or all `*` or all `+` (don't mix)
|
|
49
|
+
- Proper indentation for nested items (2 or 4 spaces, stay consistent)
|
|
50
|
+
- Blank line before/after list for clarity
|
|
51
|
+
|
|
52
|
+
**Links:**
|
|
53
|
+
|
|
54
|
+
- Inline: `[text](url)`
|
|
55
|
+
- Reference: `[text][ref]` then `[ref]: url` at bottom
|
|
56
|
+
- NO bare URLs without `<>` brackets
|
|
57
|
+
|
|
58
|
+
**Emphasis:**
|
|
59
|
+
|
|
60
|
+
- Italic: `*text*` or `_text_`
|
|
61
|
+
- Bold: `**text**` or `__text__`
|
|
62
|
+
- Consistent style within document
|
|
63
|
+
|
|
64
|
+
**Line Breaks:**
|
|
65
|
+
|
|
66
|
+
- Two spaces at end of line + newline, OR
|
|
67
|
+
- Blank line between paragraphs
|
|
68
|
+
- NO single line breaks (they're ignored)
|
|
69
|
+
|
|
70
|
+
## Mermaid Diagrams: Valid Syntax Required
|
|
71
|
+
|
|
72
|
+
**Critical Rules:**
|
|
73
|
+
|
|
74
|
+
1. Always specify diagram type first line
|
|
75
|
+
2. Use valid Mermaid v10+ syntax
|
|
76
|
+
3. Test syntax before outputting (mental validation)
|
|
77
|
+
4. Keep focused: 5-10 nodes ideal, max 15
|
|
78
|
+
|
|
79
|
+
**Diagram Type Selection:**
|
|
80
|
+
|
|
81
|
+
- **flowchart** - Process flows, decision trees, workflows
|
|
82
|
+
- **sequenceDiagram** - API interactions, message flows, time-based processes
|
|
83
|
+
- **classDiagram** - Object models, class relationships, system structure
|
|
84
|
+
- **erDiagram** - Database schemas, entity relationships
|
|
85
|
+
- **stateDiagram-v2** - State machines, lifecycle stages
|
|
86
|
+
- **gitGraph** - Branch strategies, version control flows
|
|
87
|
+
|
|
88
|
+
**Formatting:**
|
|
89
|
+
|
|
90
|
+
````markdown
|
|
91
|
+
```mermaid
|
|
92
|
+
flowchart TD
|
|
93
|
+
Start[Clear Label] --> Decision{Question?}
|
|
94
|
+
Decision -->|Yes| Action1[Do This]
|
|
95
|
+
Decision -->|No| Action2[Do That]
|
|
96
|
+
```
|
|
97
|
+
````
|
|
98
|
+
|
|
99
|
+
## Style Guide Principles (Distilled)
|
|
100
|
+
|
|
101
|
+
Apply in this hierarchy:
|
|
102
|
+
|
|
103
|
+
1. **Project-specific guide** (if exists) - always ask first
|
|
104
|
+
2. **BMAD conventions** (this document)
|
|
105
|
+
3. **Google Developer Docs style** (defaults below)
|
|
106
|
+
4. **CommonMark spec** (when in doubt)
|
|
107
|
+
|
|
108
|
+
### Core Writing Rules
|
|
109
|
+
|
|
110
|
+
**Task-Oriented Focus:**
|
|
111
|
+
|
|
112
|
+
- Write for user GOALS, not feature lists
|
|
113
|
+
- Start with WHY, then HOW
|
|
114
|
+
- Every doc answers: "What can I accomplish?"
|
|
115
|
+
|
|
116
|
+
**Clarity Principles:**
|
|
117
|
+
|
|
118
|
+
- Active voice: "Click the button" NOT "The button should be clicked"
|
|
119
|
+
- Present tense: "The function returns" NOT "The function will return"
|
|
120
|
+
- Direct language: "Use X for Y" NOT "X can be used for Y"
|
|
121
|
+
- Second person: "You configure" NOT "Users configure" or "One configures"
|
|
122
|
+
|
|
123
|
+
**Structure:**
|
|
124
|
+
|
|
125
|
+
- One idea per sentence
|
|
126
|
+
- One topic per paragraph
|
|
127
|
+
- Headings describe content accurately
|
|
128
|
+
- Examples follow explanations
|
|
129
|
+
|
|
130
|
+
**Accessibility:**
|
|
131
|
+
|
|
132
|
+
- Descriptive link text: "See the API reference" NOT "Click here"
|
|
133
|
+
- Alt text for diagrams: Describe what it shows
|
|
134
|
+
- Semantic heading hierarchy (don't skip levels)
|
|
135
|
+
- Tables have headers
|
|
136
|
+
|
|
137
|
+
## OpenAPI/API Documentation
|
|
138
|
+
|
|
139
|
+
**Required Elements:**
|
|
140
|
+
|
|
141
|
+
- Endpoint path and method
|
|
142
|
+
- Authentication requirements
|
|
143
|
+
- Request parameters (path, query, body) with types
|
|
144
|
+
- Request example (realistic, working)
|
|
145
|
+
- Response schema with types
|
|
146
|
+
- Response examples (success + common errors)
|
|
147
|
+
- Error codes and meanings
|
|
148
|
+
|
|
149
|
+
**Quality Standards:**
|
|
150
|
+
|
|
151
|
+
- OpenAPI 3.0+ specification compliance
|
|
152
|
+
- Complete schemas (no missing fields)
|
|
153
|
+
- Examples that actually work
|
|
154
|
+
- Clear error messages
|
|
155
|
+
- Security schemes documented
|
|
156
|
+
|
|
157
|
+
## Documentation Types: Quick Reference
|
|
158
|
+
|
|
159
|
+
**README:**
|
|
160
|
+
|
|
161
|
+
- What (overview), Why (purpose), How (quick start)
|
|
162
|
+
- Installation, Usage, Contributing, License
|
|
163
|
+
- Under 500 lines (link to detailed docs)
|
|
164
|
+
- Final Polish include a Table of Contents
|
|
165
|
+
|
|
166
|
+
**API Reference:**
|
|
167
|
+
|
|
168
|
+
- Complete endpoint coverage
|
|
169
|
+
- Request/response examples
|
|
170
|
+
- Authentication details
|
|
171
|
+
- Error handling
|
|
172
|
+
- Rate limits if applicable
|
|
173
|
+
|
|
174
|
+
**User Guide:**
|
|
175
|
+
|
|
176
|
+
- Task-based sections (How to...)
|
|
177
|
+
- Step-by-step instructions
|
|
178
|
+
- Screenshots/diagrams where helpful
|
|
179
|
+
- Troubleshooting section
|
|
180
|
+
|
|
181
|
+
**Architecture Docs:**
|
|
182
|
+
|
|
183
|
+
- System overview diagram (Mermaid)
|
|
184
|
+
- Component descriptions
|
|
185
|
+
- Data flow
|
|
186
|
+
- Technology decisions (ADRs)
|
|
187
|
+
- Deployment architecture
|
|
188
|
+
|
|
189
|
+
**Developer Guide:**
|
|
190
|
+
|
|
191
|
+
- Setup/environment requirements
|
|
192
|
+
- Code organization
|
|
193
|
+
- Development workflow
|
|
194
|
+
- Testing approach
|
|
195
|
+
- Contribution guidelines
|
|
196
|
+
|
|
197
|
+
## Quality Checklist
|
|
198
|
+
|
|
199
|
+
Before finalizing ANY documentation:
|
|
200
|
+
|
|
201
|
+
- [ ] CommonMark compliant (no violations)
|
|
202
|
+
- [ ] NO time estimates anywhere (Critical Rule 2)
|
|
203
|
+
- [ ] Headers in proper hierarchy
|
|
204
|
+
- [ ] All code blocks have language tags
|
|
205
|
+
- [ ] Links work and have descriptive text
|
|
206
|
+
- [ ] Mermaid diagrams render correctly
|
|
207
|
+
- [ ] Active voice, present tense
|
|
208
|
+
- [ ] Task-oriented (answers "how do I...")
|
|
209
|
+
- [ ] Examples are concrete and working
|
|
210
|
+
- [ ] Accessibility standards met
|
|
211
|
+
- [ ] Spelling/grammar checked
|
|
212
|
+
- [ ] Reads clearly at target skill level
|
|
213
|
+
|
|
214
|
+
**Frontmatter:**
|
|
215
|
+
Use YAML frontmatter when appropriate, for example:
|
|
216
|
+
|
|
217
|
+
```yaml
|
|
218
|
+
---
|
|
219
|
+
title: Document Title
|
|
220
|
+
description: Brief description
|
|
221
|
+
author: Author name
|
|
222
|
+
date: YYYY-MM-DD
|
|
223
|
+
---
|
|
224
|
+
```
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Technical Writer - Documentation Guide Agent Definition
|
|
2
|
+
|
|
3
|
+
agent:
|
|
4
|
+
metadata:
|
|
5
|
+
id: "_bmad/bmm/agents/tech-writer.md"
|
|
6
|
+
name: Paige
|
|
7
|
+
title: Technical Writer
|
|
8
|
+
icon: 📚
|
|
9
|
+
module: bmm
|
|
10
|
+
hasSidecar: false
|
|
11
|
+
|
|
12
|
+
persona:
|
|
13
|
+
role: Technical Documentation Specialist + Knowledge Curator
|
|
14
|
+
identity: Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.
|
|
15
|
+
communication_style: "Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines."
|
|
16
|
+
principles: |
|
|
17
|
+
- Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all, and every word and phrase serves a purpose without being overly wordy.
|
|
18
|
+
- I believe a picture/diagram is worth 1000s works and will include diagrams over drawn out text.
|
|
19
|
+
- I understand the intended audience or will clarify with the user so I know when to simplify vs when to be detailed.
|
|
20
|
+
- I will always strive to follow `_bmad/_memory/tech-writer-sidecar/documentation-standards.md` best practices.
|
|
21
|
+
|
|
22
|
+
menu:
|
|
23
|
+
- trigger: DP or fuzzy match on document-project
|
|
24
|
+
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
|
25
|
+
description: "[DP] Document Project: Generate comprehensive project documentation (brownfield analysis, architecture scanning)"
|
|
26
|
+
|
|
27
|
+
- trigger: WD or fuzzy match on write-document
|
|
28
|
+
action: "Engage in multi-turn conversation until you fully understand the ask, use subprocess if available for any web search, research or document review required to extract and return only relevant info to parent context. Author final document following all `_bmad/_memory/tech-writer-sidecar/documentation-standards.md`. After draft, use a subprocess to review and revise for quality of content and ensure standards are still met."
|
|
29
|
+
description: "[WD] Write Document: Describe in detail what you want, and the agent will follow the documentation best practices defined in agent memory."
|
|
30
|
+
|
|
31
|
+
- trigger: WD or fuzzy match on write-document
|
|
32
|
+
action: "Update `_bmad/_memory/tech-writer-sidecar/documentation-standards.md` adding user preferences to User Specified CRITICAL Rules section. Remove any contradictory rules as needed. Share with user the updates made."
|
|
33
|
+
description: "[US]: Update Standards: Agent Memory records your specific preferences if you discover missing document conventions."
|
|
34
|
+
|
|
35
|
+
- trigger: MG or fuzzy match on mermaid-gen
|
|
36
|
+
action: "Create a Mermaid diagram based on user description multi-turn user conversation until the complete details are understood to produce the requested artifact. If not specified, suggest diagram types based on ask. Strictly follow Mermaid syntax and CommonMark fenced code block standards."
|
|
37
|
+
description: "[MG] Mermaid Generate: Create a mermaid compliant diagram"
|
|
38
|
+
|
|
39
|
+
- trigger: VD or fuzzy match on validate-doc
|
|
40
|
+
action: "Review the specified document against `_bmad/_memory/tech-writer-sidecar/documentation-standards.md` along with anything additional the user asked you to focus on. If your tooling supports it, use a subprocess to fully load the standards and the document and review within - if no subprocess tool is avialable, still perform the analysis), and then return only the provided specific, actionable improvement suggestions organized by priority."
|
|
41
|
+
description: "[VD] Validate Documentation: Validate against user specific requests, standards and best practices"
|
|
42
|
+
|
|
43
|
+
- trigger: EC or fuzzy match on explain-concept
|
|
44
|
+
action: "Create a clear technical explanation with examples and diagrams for a complex concept. Break it down into digestible sections using task-oriented approach. Include code examples and Mermaid diagrams where helpful."
|
|
45
|
+
description: "[EC] Explain Concept: Create clear technical explanations with examples"
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UX Designer Agent Definition
|
|
2
|
+
|
|
3
|
+
agent:
|
|
4
|
+
metadata:
|
|
5
|
+
id: "_bmad/bmm/agents/ux-designer.md"
|
|
6
|
+
name: Sally
|
|
7
|
+
title: UX Designer
|
|
8
|
+
icon: 🎨
|
|
9
|
+
module: bmm
|
|
10
|
+
hasSidecar: false
|
|
11
|
+
|
|
12
|
+
persona:
|
|
13
|
+
role: User Experience Designer + UI Specialist
|
|
14
|
+
identity: Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.
|
|
15
|
+
communication_style: "Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair."
|
|
16
|
+
principles: |
|
|
17
|
+
- Every decision serves genuine user needs
|
|
18
|
+
- Start simple, evolve through feedback
|
|
19
|
+
- Balance empathy with edge case attention
|
|
20
|
+
- AI tools accelerate human-centered design
|
|
21
|
+
- Data-informed but always creative
|
|
22
|
+
|
|
23
|
+
menu:
|
|
24
|
+
- trigger: CU or fuzzy match on ux-design
|
|
25
|
+
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
|
26
|
+
description: "[CU] Create UX: Guidance through realizing the plan for your UX to inform architecture and implementation. PRovides more details that what was discovered in the PRD"
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Project Brainstorming Context Template
|
|
2
|
+
|
|
3
|
+
## Project Focus Areas
|
|
4
|
+
|
|
5
|
+
This brainstorming session focuses on software and product development considerations:
|
|
6
|
+
|
|
7
|
+
### Key Exploration Areas
|
|
8
|
+
|
|
9
|
+
- **User Problems and Pain Points** - What challenges do users face?
|
|
10
|
+
- **Feature Ideas and Capabilities** - What could the product do?
|
|
11
|
+
- **Technical Approaches** - How might we build it?
|
|
12
|
+
- **User Experience** - How will users interact with it?
|
|
13
|
+
- **Business Model and Value** - How does it create value?
|
|
14
|
+
- **Market Differentiation** - What makes it unique?
|
|
15
|
+
- **Technical Risks and Challenges** - What could go wrong?
|
|
16
|
+
- **Success Metrics** - How will we measure success?
|
|
17
|
+
|
|
18
|
+
### Integration with Project Workflow
|
|
19
|
+
|
|
20
|
+
Brainstorming results might feed into:
|
|
21
|
+
|
|
22
|
+
- Product Briefs for initial product vision
|
|
23
|
+
- PRDs for detailed requirements
|
|
24
|
+
- Technical Specifications for architecture plans
|
|
25
|
+
- Research Activities for validation needs
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs,
|
|
2
|
+
bmm,anytime,Document Project,DP,10,_bmad/bmm/workflows/document-project/workflow.yaml,bmad_bmm_document-project,false,analyst,Create Mode,"Analyze an existing project to produce useful documentation",project-knowledge,*,
|
|
3
|
+
bmm,anytime,Quick Spec,TS,20,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad_bmm_quick-spec,false,quick-flow-solo-dev,Create Mode,"Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps utilities without extensive planning",planning_artifacts,"tech spec",
|
|
4
|
+
bmm,anytime,Quick Dev,QD,30,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad_bmm_quick-dev,false,quick-flow-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,,
|
|
5
|
+
bmm,anytime,Correct Course,CC,40,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad_bmm_correct-course,false,sm,Create Mode,"Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories",planning_artifacts,"change proposal",
|
|
6
|
+
bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad_brainstorming,false,analyst,data=_bmad/bmm/data/project-context-template.md,"Expert Guided Facilitation through a single or multiple techniques",planning_artifacts,"brainstorming session",
|
|
7
|
+
bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode research_type=market,"Market analysis competitive landscape customer needs and trends","planning_artifacts|project-knowledge","research documents"
|
|
8
|
+
bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode research_type=domain,"Industry domain deep dive subject matter expertise and terminology","planning_artifacts|project-knowledge","research documents"
|
|
9
|
+
bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode research_type=technical,"Technical feasibility architecture options and implementation approaches","planning_artifacts|project-knowledge","research documents"
|
|
10
|
+
bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_create-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief",
|
|
11
|
+
bmm,1-analysis,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_validate-brief,false,analyst,Validate Mode,"Validates product brief completeness",planning_artifacts,"brief validation report",
|
|
12
|
+
bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd,
|
|
13
|
+
bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report",
|
|
14
|
+
bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_create-ux-design,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design",
|
|
15
|
+
bmm,2-planning,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_create-ux-design,false,ux-designer,Validate Mode,"Validates UX design deliverables",planning_artifacts,"ux validation report",
|
|
16
|
+
,anytime,Create Dataflow,CDF,50,_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml,bmad_bmm_create-excalidraw-dataflow,false,ux-designer,Create Mode,"Create data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentation",planning_artifacts,"dataflow diagram",
|
|
17
|
+
,anytime,Create Diagram,CED,51,_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml,bmad_bmm_create-excalidraw-diagram,false,ux-designer,Create Mode,"Create system architecture diagrams ERDs UML diagrams or general technical diagrams in Excalidraw format - use anytime or call from architecture workflow to add visual documentation",planning_artifacts,"diagram",
|
|
18
|
+
,anytime,Create Flowchart,CFC,52,_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml,bmad_bmm_create-excalidraw-flowchart,false,ux-designer,Create Mode,"Create a flowchart visualization in Excalidraw format for processes pipelines or logic flows - use anytime or during architecture to add process documentation",planning_artifacts,"flowchart",
|
|
19
|
+
,anytime,Create Wireframe,CEW,53,_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml,bmad_bmm_create-excalidraw-wireframe,false,ux-designer,Create Mode,"Create website or app wireframes in Excalidraw format - use anytime standalone or call from UX workflow to add UI mockups",planning_artifacts,"wireframe",
|
|
20
|
+
bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad_bmm_create-architecture,true,architect,Create Mode,"Guided Workflow to document technical decisions",planning_artifacts,architecture,
|
|
21
|
+
bmm,3-solutioning,Validate Architecture,VA,20,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad_bmm_create-architecture,false,architect,Validate Mode,"Validates architecture completeness",planning_artifacts,"architecture validation report",
|
|
22
|
+
bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad_bmm_create-epics-and-stories,true,pm,Create Mode,"Create the Epics and Stories Listing",planning_artifacts,"epics and stories",
|
|
23
|
+
bmm,3-solutioning,Validate Epics and Stories,VE,40,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad_bmm_create-epics-and-stories,false,pm,Validate Mode,"Validates epics and stories completeness",planning_artifacts,"epics validation report",
|
|
24
|
+
bmm,3-solutioning,Test Design,TD,50,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmad_bmm_testarch-test-design,false,tea,Create Mode,"Create comprehensive test scenarios ahead of development, recommended if string test compliance or assurance is needed. Very critical for distributed applications with separate front ends and backends outside of a monorepo.",planning_artifacts,"test design",
|
|
25
|
+
bmm,3-solutioning,Check Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad_bmm_check-implementation-readiness,true,architect,Validate Mode,"Ensure PRD UX Architecture and Epics Stories are aligned",planning_artifacts,"readiness report",
|
|
26
|
+
bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad_bmm_sprint-planning,true,sm,Create Mode,"Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.",implementation_artifacts,"sprint status",
|
|
27
|
+
bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad_bmm_sprint-status,false,sm,Create Mode,"Anytime: Summarize sprint status and route to next workflow",,,
|
|
28
|
+
bmm,4-implementation,Create Story,CS,30,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad_bmm_create-story,true,sm,Create Mode,"Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER",implementation_artifacts,story,
|
|
29
|
+
bmm,4-implementation,Validate Story,VS,35,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad_bmm_create-story,false,sm,Validate Mode,"Validates story readiness and completeness before development work begins",implementation_artifacts,"story validation report",
|
|
30
|
+
bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml,bmad_bmm_dev-story,true,dev,Create Mode,"Story cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed",,,
|
|
31
|
+
bmm,4-implementation,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad_bmm_code-review,false,dev,Create Mode,"Story cycle: If issues back to DS if approved then next CS or ER if epic complete",,,
|
|
32
|
+
bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad_bmm_retrospective,false,sm,Create Mode,"Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC",implementation_artifacts,retrospective,
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
code: bmm
|
|
2
|
+
name: "BMad Method Agile-AI Driven-Development"
|
|
3
|
+
description: "AI-driven agile development framework"
|
|
4
|
+
default_selected: true # This module will be selected by default for new installations
|
|
5
|
+
|
|
6
|
+
# Variables from Core Config inserted:
|
|
7
|
+
## user_name
|
|
8
|
+
## communication_language
|
|
9
|
+
## document_output_language
|
|
10
|
+
## output_folder
|
|
11
|
+
|
|
12
|
+
project_name:
|
|
13
|
+
prompt: "What is your project called?"
|
|
14
|
+
default: "{directory_name}"
|
|
15
|
+
result: "{value}"
|
|
16
|
+
|
|
17
|
+
user_skill_level:
|
|
18
|
+
prompt:
|
|
19
|
+
- "What is your development experience level?"
|
|
20
|
+
- "This affects how agents explain concepts in chat."
|
|
21
|
+
default: "intermediate"
|
|
22
|
+
result: "{value}"
|
|
23
|
+
single-select:
|
|
24
|
+
- value: "beginner"
|
|
25
|
+
label: "Beginner - Explain things clearly"
|
|
26
|
+
- value: "intermediate"
|
|
27
|
+
label: "Intermediate - Balance detail with speed"
|
|
28
|
+
- value: "expert"
|
|
29
|
+
label: "Expert - Be direct and technical"
|
|
30
|
+
|
|
31
|
+
planning_artifacts: # Phase 1-3 artifacts
|
|
32
|
+
prompt: "Where should planning artifacts be stored? (Brainstorming, Briefs, PRDs, UX Designs, Architecture, Epics)"
|
|
33
|
+
default: "{output_folder}/planning-artifacts"
|
|
34
|
+
result: "{project-root}/{value}"
|
|
35
|
+
|
|
36
|
+
implementation_artifacts: # Phase 4 artifacts and quick-dev flow output
|
|
37
|
+
prompt: "Where should implementation artifacts be stored? (Sprint status, stories, reviews, retrospectives, Quick Flow output)"
|
|
38
|
+
default: "{output_folder}/implementation-artifacts"
|
|
39
|
+
result: "{project-root}/{value}"
|
|
40
|
+
|
|
41
|
+
project_knowledge: # Artifacts from research, document-project output, other long lived accurate knowledge
|
|
42
|
+
prompt: "Where should long-term project knowledge be stored? (docs, research, references)"
|
|
43
|
+
default: "docs"
|
|
44
|
+
result: "{project-root}/{value}"
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
# Claude Code Content Injection Configuration
|
|
2
|
+
# This file defines content to be injected at specific points in BMAD files
|
|
3
|
+
# when Claude Code is selected as the IDE during installation
|
|
4
|
+
#
|
|
5
|
+
# The installer will:
|
|
6
|
+
# 1. Ask users if they want to install subagents (all/selective/none)
|
|
7
|
+
# 2. Ask where to install (project-level .claude/agents/_bmad/ or user-level ~/.claude/agents/_bmad/)
|
|
8
|
+
# 3. Only inject content related to selected subagents
|
|
9
|
+
# 4. Templates stay in _bmad/ directory and are referenced from there
|
|
10
|
+
# 5. Injections are placed at specific sections where each subagent is most valuable
|
|
11
|
+
|
|
12
|
+
injections:
|
|
13
|
+
# ===== PRD WORKFLOW INJECTIONS =====
|
|
14
|
+
|
|
15
|
+
# PRD Subagent Instructions
|
|
16
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
17
|
+
point: "prd-subagent-instructions"
|
|
18
|
+
requires: "all-prd-subagents"
|
|
19
|
+
content: |
|
|
20
|
+
|
|
21
|
+
**Subagent Usage**: Throughout this workflow, leverage specialized subagents at critical decision points:
|
|
22
|
+
- <CRITICAL>Use `bmm-requirements-analyst` when defining functional requirements</CRITICAL>
|
|
23
|
+
- <CRITICAL>Use `bmm-user-journey-mapper` for comprehensive journey mapping</CRITICAL>
|
|
24
|
+
- <CRITICAL>Use `bmm-epic-optimizer` when structuring epic boundaries</CRITICAL>
|
|
25
|
+
- <CRITICAL>Use `bmm-technical-decisions-curator` to capture all technical mentions</CRITICAL>
|
|
26
|
+
|
|
27
|
+
# PRD Requirements Analysis
|
|
28
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
29
|
+
point: "prd-requirements-analysis"
|
|
30
|
+
requires: "requirements-analyst"
|
|
31
|
+
content: |
|
|
32
|
+
|
|
33
|
+
**Subagent Hint**: Use `bmm-requirements-analyst` to validate requirements are testable and complete.
|
|
34
|
+
|
|
35
|
+
# PRD User Journey Mapping
|
|
36
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
37
|
+
point: "prd-user-journey"
|
|
38
|
+
requires: "user-journey-mapper"
|
|
39
|
+
content: |
|
|
40
|
+
|
|
41
|
+
**Subagent Hint**: Use `bmm-user-journey-mapper` to map all user types and their value paths.
|
|
42
|
+
|
|
43
|
+
# PRD Epic Optimization
|
|
44
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
45
|
+
point: "prd-epic-optimization"
|
|
46
|
+
requires: "epic-optimizer"
|
|
47
|
+
content: |
|
|
48
|
+
|
|
49
|
+
**Subagent Hint**: Use `bmm-epic-optimizer` to validate epic boundaries deliver coherent value.
|
|
50
|
+
|
|
51
|
+
# PRD Document Review
|
|
52
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
53
|
+
point: "prd-checklist-review"
|
|
54
|
+
requires: "document-reviewer"
|
|
55
|
+
content: |
|
|
56
|
+
|
|
57
|
+
**Subagent Hint**: Use `bmm-document-reviewer` to validate PRD completeness before finalizing.
|
|
58
|
+
|
|
59
|
+
# Technical Decisions Curator
|
|
60
|
+
- file: "_bmad/bmm/workflows/prd/instructions.md"
|
|
61
|
+
point: "technical-decisions-curator"
|
|
62
|
+
requires: "technical-decisions-curator"
|
|
63
|
+
content: |
|
|
64
|
+
|
|
65
|
+
**Automatic Capture**: The `bmm-technical-decisions-curator` should be invoked whenever:
|
|
66
|
+
- Technology, framework, or tool is mentioned
|
|
67
|
+
- Architecture patterns are discussed
|
|
68
|
+
- Infrastructure or deployment topics arise
|
|
69
|
+
- Integration requirements are specified
|
|
70
|
+
|
|
71
|
+
# ===== MARKET RESEARCH TEMPLATE INJECTIONS =====
|
|
72
|
+
|
|
73
|
+
# Market TAM/SAM/SOM Calculations
|
|
74
|
+
- file: "_bmad/bmm/templates/market.md"
|
|
75
|
+
point: "market-tam-calculations"
|
|
76
|
+
requires: "data-analyst"
|
|
77
|
+
content: |
|
|
78
|
+
|
|
79
|
+
<llm critical="true">
|
|
80
|
+
<i>MANDATORY: Use the 'bmm-data-analyst' subagent to perform all TAM, SAM, and SOM calculations.</i>
|
|
81
|
+
<i>The subagent will apply proper methodologies, validate assumptions, and provide defensible market sizing.</i>
|
|
82
|
+
</llm>
|
|
83
|
+
|
|
84
|
+
# Market Trends Analysis
|
|
85
|
+
- file: "_bmad/bmm/templates/market.md"
|
|
86
|
+
point: "market-trends-analysis"
|
|
87
|
+
requires: "trend-spotter"
|
|
88
|
+
content: |
|
|
89
|
+
|
|
90
|
+
<llm critical="true">
|
|
91
|
+
<i>MANDATORY: Use the 'bmm-trend-spotter' subagent to identify and analyze emerging market trends.</i>
|
|
92
|
+
<i>The subagent will detect disruption signals, technology shifts, and future opportunities.</i>
|
|
93
|
+
</llm>
|
|
94
|
+
|
|
95
|
+
# Market Customer Personas
|
|
96
|
+
- file: "_bmad/bmm/templates/market.md"
|
|
97
|
+
point: "market-customer-segments"
|
|
98
|
+
requires: "user-researcher"
|
|
99
|
+
content: |
|
|
100
|
+
|
|
101
|
+
<llm critical="true">
|
|
102
|
+
<i>MANDATORY: Use the 'bmm-user-researcher' subagent to develop detailed customer segment profiles and personas.</i>
|
|
103
|
+
<i>The subagent will analyze behavior patterns, needs, and journey maps for each segment.</i>
|
|
104
|
+
</llm>
|
|
105
|
+
|
|
106
|
+
# Market Research Review
|
|
107
|
+
- file: "_bmad/bmm/templates/market.md"
|
|
108
|
+
point: "market-executive-summary"
|
|
109
|
+
requires: "document-reviewer"
|
|
110
|
+
content: |
|
|
111
|
+
|
|
112
|
+
<llm critical="true">
|
|
113
|
+
<i>MANDATORY: Before finalizing the executive summary, use the 'bmm-document-reviewer' subagent to validate all market research findings and ensure data accuracy.</i>
|
|
114
|
+
</llm>
|
|
115
|
+
|
|
116
|
+
# ===== COMPETITOR ANALYSIS TEMPLATE INJECTIONS =====
|
|
117
|
+
|
|
118
|
+
# Competitor Intelligence Gathering
|
|
119
|
+
- file: "_bmad/bmm/templates/competitor.md"
|
|
120
|
+
point: "competitor-intelligence"
|
|
121
|
+
requires: "market-researcher"
|
|
122
|
+
content: |
|
|
123
|
+
|
|
124
|
+
<llm critical="true">
|
|
125
|
+
<i>MANDATORY: Use the 'bmm-market-researcher' subagent to gather comprehensive competitive intelligence for each competitor profile.</i>
|
|
126
|
+
<i>The subagent will analyze positioning, strategy, and market dynamics.</i>
|
|
127
|
+
</llm>
|
|
128
|
+
|
|
129
|
+
# Competitor Technical Analysis
|
|
130
|
+
- file: "_bmad/bmm/templates/competitor.md"
|
|
131
|
+
point: "competitor-tech-stack"
|
|
132
|
+
requires: "technical-evaluator"
|
|
133
|
+
content: |
|
|
134
|
+
|
|
135
|
+
<llm critical="true">
|
|
136
|
+
<i>MANDATORY: Use the 'bmm-technical-evaluator' subagent to analyze and compare competitor technology stacks.</i>
|
|
137
|
+
<i>The subagent will identify technical differentiators and architectural advantages.</i>
|
|
138
|
+
</llm>
|
|
139
|
+
|
|
140
|
+
# Competitor Metrics Analysis
|
|
141
|
+
- file: "_bmad/bmm/templates/competitor.md"
|
|
142
|
+
point: "competitor-metrics"
|
|
143
|
+
requires: "data-analyst"
|
|
144
|
+
content: |
|
|
145
|
+
|
|
146
|
+
<llm critical="true">
|
|
147
|
+
<i>MANDATORY: Use the 'bmm-data-analyst' subagent to analyze competitor performance metrics and market share data.</i>
|
|
148
|
+
</llm>
|
|
149
|
+
|
|
150
|
+
# Competitor Analysis Review
|
|
151
|
+
- file: "_bmad/bmm/templates/competitor.md"
|
|
152
|
+
point: "competitor-executive-summary"
|
|
153
|
+
requires: "document-reviewer"
|
|
154
|
+
content: |
|
|
155
|
+
|
|
156
|
+
<llm critical="true">
|
|
157
|
+
<i>MANDATORY: Before finalizing, use the 'bmm-document-reviewer' subagent to validate competitive analysis completeness and strategic recommendations.</i>
|
|
158
|
+
</llm>
|
|
159
|
+
|
|
160
|
+
# ===== PROJECT BRIEF TEMPLATE INJECTIONS =====
|
|
161
|
+
|
|
162
|
+
# Brief Problem Validation
|
|
163
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
164
|
+
point: "brief-problem-validation"
|
|
165
|
+
requires: "market-researcher"
|
|
166
|
+
content: |
|
|
167
|
+
|
|
168
|
+
<llm critical="true">
|
|
169
|
+
<i>IF market research has not been provided as input, MANDATORY: Use the 'bmm-market-researcher' subagent to validate the problem statement and assess market opportunity.</i>
|
|
170
|
+
</llm>
|
|
171
|
+
|
|
172
|
+
# Brief Target User Analysis
|
|
173
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
174
|
+
point: "brief-user-analysis"
|
|
175
|
+
requires: "user-researcher"
|
|
176
|
+
content: |
|
|
177
|
+
|
|
178
|
+
<llm critical="true">
|
|
179
|
+
<i>IF target user analysis has not been provided, MANDATORY: Use the 'bmm-user-researcher' subagent to develop detailed user profiles and validate user needs.</i>
|
|
180
|
+
</llm>
|
|
181
|
+
|
|
182
|
+
# Brief Success Metrics
|
|
183
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
184
|
+
point: "brief-success-metrics"
|
|
185
|
+
requires: "data-analyst"
|
|
186
|
+
content: |
|
|
187
|
+
|
|
188
|
+
<llm critical="true">
|
|
189
|
+
<i>MANDATORY: Use the 'bmm-data-analyst' subagent to define and validate KPIs, success metrics, and measurement approaches.</i>
|
|
190
|
+
</llm>
|
|
191
|
+
|
|
192
|
+
# Brief Technical Feasibility
|
|
193
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
194
|
+
point: "brief-technical-feasibility"
|
|
195
|
+
requires: "technical-evaluator"
|
|
196
|
+
content: |
|
|
197
|
+
|
|
198
|
+
<llm critical="true">
|
|
199
|
+
<i>IF technical assumptions need validation, use the 'bmm-technical-evaluator' subagent to assess feasibility and identify technical risks.</i>
|
|
200
|
+
</llm>
|
|
201
|
+
|
|
202
|
+
# Brief Requirements Extraction
|
|
203
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
204
|
+
point: "brief-requirements"
|
|
205
|
+
requires: "requirements-analyst"
|
|
206
|
+
content: |
|
|
207
|
+
|
|
208
|
+
<llm critical="true">
|
|
209
|
+
<i>MANDATORY: Use the 'bmm-requirements-analyst' subagent to extract initial high-level requirements from the brief content.</i>
|
|
210
|
+
</llm>
|
|
211
|
+
|
|
212
|
+
# Brief Document Review
|
|
213
|
+
- file: "_bmad/bmm/templates/brief.md"
|
|
214
|
+
point: "brief-final-review"
|
|
215
|
+
requires: "document-reviewer"
|
|
216
|
+
content: |
|
|
217
|
+
|
|
218
|
+
<llm critical="true">
|
|
219
|
+
<i>MANDATORY: Before finalizing the brief, use the 'bmm-document-reviewer' subagent to ensure completeness and internal consistency.</i>
|
|
220
|
+
</llm>
|
|
221
|
+
|
|
222
|
+
# Subagents to copy
|
|
223
|
+
subagents:
|
|
224
|
+
source: "sub-agents"
|
|
225
|
+
target: ".claude/agents"
|
|
226
|
+
files:
|
|
227
|
+
- "market-researcher.md"
|
|
228
|
+
- "requirements-analyst.md"
|
|
229
|
+
- "technical-evaluator.md"
|
|
230
|
+
- "epic-optimizer.md"
|
|
231
|
+
- "document-reviewer.md"
|
|
232
|
+
- "codebase-analyzer.md"
|
|
233
|
+
- "dependency-mapper.md"
|
|
234
|
+
- "pattern-detector.md"
|
|
235
|
+
- "tech-debt-auditor.md"
|
|
236
|
+
- "api-documenter.md"
|
|
237
|
+
- "test-coverage-analyzer.md"
|
|
238
|
+
- "user-researcher.md"
|
|
239
|
+
- "user-journey-mapper.md"
|
|
240
|
+
- "technical-decisions-curator.md"
|
|
241
|
+
- "data-analyst.md"
|
|
242
|
+
- "trend-spotter.md"
|