bmad-elsabro 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.auto-claude-security.json +209 -0
- package/.claude_settings.json +34 -0
- package/.coderabbit.yaml +40 -0
- package/.nvmrc +1 -0
- package/.prettierignore +9 -0
- package/AI_TEST_GENERATOR_VERIFICATION.md +260 -0
- package/BUDGET_ALERT_TESTING.md +325 -0
- package/CHANGELOG.md +1488 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +167 -0
- package/CONTRIBUTORS.md +32 -0
- package/LEGACY_MIGRATION_TESTING.md +428 -0
- package/LICENSE +30 -0
- package/PARTY_MODE_VERIFICATION.md +274 -0
- package/PROJECT_DETECTOR_TESTING.md +288 -0
- package/README.md +236 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/WORKFLOW_ROUTER_IMPLEMENTATION.md +379 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/build/icons/512x512.png +0 -0
- package/build-mac.sh +3 -0
- package/docs/404.md +9 -0
- package/docs/_STYLE_GUIDE.md +367 -0
- package/docs/developer/api-reference.md +945 -0
- package/docs/developer/architecture.md +563 -0
- package/docs/developer/contributing.md +831 -0
- package/docs/downloads.md +74 -0
- package/docs/explanation/advanced-elicitation.md +24 -0
- package/docs/explanation/adversarial-review.md +57 -0
- package/docs/explanation/brainstorming.md +31 -0
- package/docs/explanation/brownfield-faq.md +55 -0
- package/docs/explanation/party-mode.md +57 -0
- package/docs/explanation/preventing-agent-conflicts.md +110 -0
- package/docs/explanation/quick-flow.md +27 -0
- package/docs/explanation/why-solutioning-matters.md +75 -0
- package/docs/how-to/brownfield/index.md +84 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +76 -0
- package/docs/how-to/customize-bmad.md +158 -0
- package/docs/how-to/get-answers-about-bmad.md +102 -0
- package/docs/how-to/install-bmad.md +82 -0
- package/docs/how-to/shard-large-documents.md +101 -0
- package/docs/how-to/upgrade-to-v6.md +131 -0
- package/docs/index.md +56 -0
- package/docs/reference/workflow-map.md +83 -0
- package/docs/tea/explanation/engagement-models.md +710 -0
- package/docs/tea/explanation/fixture-architecture.md +457 -0
- package/docs/tea/explanation/knowledge-base-system.md +554 -0
- package/docs/tea/explanation/network-first-patterns.md +853 -0
- package/docs/tea/explanation/risk-based-testing.md +586 -0
- package/docs/tea/explanation/tea-overview.md +410 -0
- package/docs/tea/explanation/test-quality-standards.md +907 -0
- package/docs/tea/explanation/testing-as-engineering.md +112 -0
- package/docs/tea/glossary/index.md +159 -0
- package/docs/tea/how-to/brownfield/use-tea-for-enterprise.md +525 -0
- package/docs/tea/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
- package/docs/tea/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
- package/docs/tea/how-to/customization/integrate-playwright-utils.md +813 -0
- package/docs/tea/how-to/workflows/run-atdd.md +436 -0
- package/docs/tea/how-to/workflows/run-automate.md +653 -0
- package/docs/tea/how-to/workflows/run-nfr-assess.md +679 -0
- package/docs/tea/how-to/workflows/run-test-design.md +135 -0
- package/docs/tea/how-to/workflows/run-test-review.md +605 -0
- package/docs/tea/how-to/workflows/run-trace.md +883 -0
- package/docs/tea/how-to/workflows/setup-ci.md +712 -0
- package/docs/tea/how-to/workflows/setup-test-framework.md +98 -0
- package/docs/tea/reference/commands.md +276 -0
- package/docs/tea/reference/configuration.md +678 -0
- package/docs/tea/reference/knowledge-base.md +340 -0
- package/docs/tea/tutorials/tea-lite-quickstart.md +444 -0
- package/docs/tutorials/getting-started.md +205 -0
- package/docs/user-guide/getting-started.md +348 -0
- package/docs/user-guide/token-economy.md +601 -0
- package/docs/user-guide/workflows.md +546 -0
- package/electron-builder.yml +75 -0
- package/eslint.config.mjs +152 -0
- package/package.json +162 -0
- package/prettier.config.mjs +32 -0
- package/public/monaco-workers/index.js +21 -0
- package/renderer/App.tsx +311 -0
- package/renderer/components/ChatPanel.tsx +285 -0
- package/renderer/components/CodeEditor.tsx +327 -0
- package/renderer/components/CodeEditor.types.ts +245 -0
- package/renderer/components/FlowSelector.tsx +534 -0
- package/renderer/components/MessageInput.tsx +252 -0
- package/renderer/components/MessageList.tsx +204 -0
- package/renderer/components/MigrationWizard.tsx +896 -0
- package/renderer/components/NotificationCenter.tsx +291 -0
- package/renderer/components/OnboardingWizard.tsx +112 -0
- package/renderer/components/PartyMode.tsx +555 -0
- package/renderer/components/Sidebar.module.css +258 -0
- package/renderer/components/Sidebar.tsx +157 -0
- package/renderer/components/TemplateSelector.tsx +553 -0
- package/renderer/components/Terminal.tsx +523 -0
- package/renderer/components/TestCenter.tsx +364 -0
- package/renderer/components/TokenAnalytics.tsx +607 -0
- package/renderer/components/TokenMonitor.tsx +331 -0
- package/renderer/components/TutorialOverlay.tsx +483 -0
- package/renderer/components/WorkflowEditor.tsx +470 -0
- package/renderer/components/onboarding/Step1Welcome.tsx +72 -0
- package/renderer/components/onboarding/Step2Setup.tsx +193 -0
- package/renderer/components/onboarding/Step3CreateProject.tsx +209 -0
- package/renderer/components/test-center/CoverageDashboard.tsx +588 -0
- package/renderer/components/test-center/ELI5Guide.tsx +521 -0
- package/renderer/components/test-center/TestList.tsx +381 -0
- package/renderer/components/test-center/TestRunner.tsx +431 -0
- package/renderer/components/test-center/TestStepWizard.tsx +1000 -0
- package/renderer/components/test-center/VisualTestBuilder.tsx +460 -0
- package/renderer/components/workflow/DependencyEdge.tsx +200 -0
- package/renderer/components/workflow/StepNode.tsx +234 -0
- package/renderer/components/workflow/StepPalette.tsx +412 -0
- package/renderer/context/ThemeContext.tsx +97 -0
- package/renderer/data/shortcuts.json +94 -0
- package/renderer/data/testing-guides.json +261 -0
- package/renderer/data/tutorials.json +546 -0
- package/renderer/hooks/useKeyboardShortcuts.ts +249 -0
- package/renderer/hooks/useNotifications.ts +267 -0
- package/renderer/hooks/useTheme.ts +149 -0
- package/renderer/hooks/useTokenTracking.ts +464 -0
- package/renderer/hooks/useWorkflowState.ts +309 -0
- package/renderer/index.html +16 -0
- package/renderer/index.tsx +17 -0
- package/renderer/lib/MONACO_OFFLINE_CONFIG.md +153 -0
- package/renderer/lib/chart-utils.ts +472 -0
- package/renderer/lib/file-system-provider.ts +295 -0
- package/renderer/lib/monaco-loader.ts +247 -0
- package/renderer/renderer/components/NOTIFICATION_SYSTEM.md +192 -0
- package/renderer/styles.css +55 -0
- package/renderer/types/css-modules.d.ts +21 -0
- package/renderer/types/electron.d.ts +316 -0
- package/src/bmm/_module-installer/installer.js +48 -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/parallel-orchestrator.agent.yaml +50 -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/agents/yolo-dev.agent.yaml +41 -0
- package/src/bmm/data/auto-testing-config.yaml +84 -0
- package/src/bmm/data/guided-mode-instructions.yaml +112 -0
- package/src/bmm/data/parallelization-config.yaml +136 -0
- package/src/bmm/data/project-context-template.md +26 -0
- package/src/bmm/data/speed-profiles.yaml +127 -0
- package/src/bmm/module-help.csv +32 -0
- package/src/bmm/module.yaml +60 -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-prd/data/domain-complexity.csv +13 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +153 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +124 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/validation-report-prd-workflow.md +433 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow.md +150 -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/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 +32 -0
- package/src/bmm/workflows/4-implementation/fix-and-test/workflow.md +197 -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/brownfield-fast-track/steps/step-01-detect.md +55 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/steps/step-02-confirm.md +48 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/steps/step-03-implement.md +61 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/workflow.md +41 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +176 -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 +153 -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 +149 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +73 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +192 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +145 -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 +201 -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 +93 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/steps/step-01-rapid-spec.md +54 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/steps/step-02-ship-it.md +65 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/workflow.md +54 -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/parallel-work/parallel-analysis/steps/step-01-parse-target.md +49 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-02-launch-streams.md +135 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-03-sync-point.md +74 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-04-merge-insights.md +179 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/workflow.md +55 -0
- package/src/bmm/workflows/parallel-work/parallel-generation/workflow.md +109 -0
- package/src/bmm/workflows/parallel-work/parallel-reviews/workflow.md +111 -0
- package/src/bmm/workflows/parallel-work/parallel-stories/workflow.md +112 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-01-load-sprint.md +54 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-02-plan-execution.md +63 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-03-execute-stories.md +112 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-04-code-review.md +148 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-05-integration-testing.md +200 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-06-sprint-report.md +290 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/workflow.md +58 -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/tools/bmad-npx-wrapper.js +69 -0
- package/tools/build-docs.js +577 -0
- package/tools/cli/README.md +7 -0
- package/tools/cli/bmad-cli.js +65 -0
- package/tools/cli/commands/diagnostics.js +303 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/module.js +210 -0
- package/tools/cli/commands/status.js +65 -0
- package/tools/cli/commands/uninstall.js +86 -0
- package/tools/cli/external-official-modules.yaml +54 -0
- package/tools/cli/installers/install-messages.yaml +59 -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 +2812 -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/_base-ide.js +655 -0
- package/tools/cli/installers/lib/ide/_config-driven.js +450 -0
- package/tools/cli/installers/lib/ide/codex.js +440 -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 +271 -0
- package/tools/cli/installers/lib/ide/platform-codes.js +100 -0
- package/tools/cli/installers/lib/ide/platform-codes.yaml +227 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +181 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +163 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/path-utils.js +292 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +270 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +319 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/antigravity.md +8 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +6 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/rovodev.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/trae.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md +10 -0
- package/tools/cli/installers/lib/ide/templates/split/opencode/body.md +10 -0
- package/tools/cli/installers/lib/ide/templates/split/opencode/header.md +4 -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/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/compiler.ts +572 -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/types.ts +155 -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/config.ts +227 -0
- package/tools/cli/lib/file-ops.js +204 -0
- package/tools/cli/lib/file-ops.ts +215 -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/prompts.ts +541 -0
- package/tools/cli/lib/types/config.types.ts +43 -0
- package/tools/cli/lib/types/xml-handler.types.ts +50 -0
- package/tools/cli/lib/ui.js +1660 -0
- package/tools/cli/lib/xml-handler.js +177 -0
- package/tools/cli/lib/xml-handler.ts +188 -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/fix-refs.md +91 -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/aggregate.ts +78 -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/files.ts +31 -0
- package/tools/flattener/ignoreRules.js +172 -0
- package/tools/flattener/main.js +483 -0
- package/tools/flattener/main.ts +262 -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/types.ts +53 -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/schema/agent.ts +489 -0
- package/tools/schema/agent.types.ts +31 -0
- package/tools/update-bmad.sh +24 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +371 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/vite-plugin-monaco-editor.ts +108 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Downloads
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Download BMad Method resources for offline use, AI training, or integration.
|
|
6
|
+
|
|
7
|
+
## Source Bundles
|
|
8
|
+
|
|
9
|
+
Download these from the `downloads/` folder on the documentation site.
|
|
10
|
+
|
|
11
|
+
| File | Description |
|
|
12
|
+
| ------------------ | ------------------------------- |
|
|
13
|
+
| `bmad-sources.zip` | Complete BMad source files |
|
|
14
|
+
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
|
15
|
+
|
|
16
|
+
## LLM-Optimized Files
|
|
17
|
+
|
|
18
|
+
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
|
|
19
|
+
|
|
20
|
+
| File | Description | Use Case |
|
|
21
|
+
| --------------- | ----------------------------------- | -------------------------- |
|
|
22
|
+
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
|
23
|
+
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
|
24
|
+
|
|
25
|
+
### Using with LLMs
|
|
26
|
+
|
|
27
|
+
**Claude Projects:**
|
|
28
|
+
```
|
|
29
|
+
Upload llms-full.txt as project knowledge
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**ChatGPT:**
|
|
33
|
+
```
|
|
34
|
+
Paste llms.txt for navigation, or sections from llms-full.txt as needed
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**API Usage:**
|
|
38
|
+
```python
|
|
39
|
+
import requests
|
|
40
|
+
docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
|
|
41
|
+
# Include in your system prompt or context
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Installation Options
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npx bmad-method install
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[More details](/docs/how-to/install-bmad.md)
|
|
51
|
+
|
|
52
|
+
## Version Information
|
|
53
|
+
|
|
54
|
+
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
|
55
|
+
- **Release Notes:** Available on [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases)
|
|
56
|
+
|
|
57
|
+
## API Access
|
|
58
|
+
|
|
59
|
+
For programmatic access to BMad documentation:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Get documentation index
|
|
63
|
+
curl https://bmad-code-org.github.io/BMAD-METHOD/llms.txt
|
|
64
|
+
|
|
65
|
+
# Get full documentation
|
|
66
|
+
curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Contributing
|
|
70
|
+
|
|
71
|
+
Want to improve BMad Method? Check out:
|
|
72
|
+
|
|
73
|
+
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
|
|
74
|
+
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Advanced Elicitation"
|
|
3
|
+
description: Push the LLM to rethink its work using structured reasoning methods
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Make the LLM reconsider what it just generated. You pick a reasoning method, it applies that method to its own output, you decide whether to keep the improvements.
|
|
7
|
+
|
|
8
|
+
Dozens of methods are built in - things like First Principles, Red Team vs Blue Team, Pre-mortem Analysis, Socratic Questioning, and more.
|
|
9
|
+
|
|
10
|
+
## When to Use It
|
|
11
|
+
|
|
12
|
+
- After a workflow generates content and you want alternatives
|
|
13
|
+
- When output seems okay but you suspect there's more depth
|
|
14
|
+
- To stress-test assumptions or find weaknesses
|
|
15
|
+
- For high-stakes content where rethinking helps
|
|
16
|
+
|
|
17
|
+
Workflows offer advanced elicitation at decision points - after the LLM has generated something, you'll be asked if you want to run it.
|
|
18
|
+
|
|
19
|
+
## How It Works
|
|
20
|
+
|
|
21
|
+
1. LLM suggests 5 relevant methods for your content
|
|
22
|
+
2. You pick one (or reshuffle for different options)
|
|
23
|
+
3. Method is applied, improvements shown
|
|
24
|
+
4. Accept or discard, repeat or continue
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Adversarial Review"
|
|
3
|
+
description: Forced reasoning technique that prevents lazy "looks good" reviews
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Force deeper analysis by requiring problems to be found.
|
|
7
|
+
|
|
8
|
+
## What is Adversarial Review?
|
|
9
|
+
|
|
10
|
+
A review technique where the reviewer *must* find issues. No "looks good" allowed. The reviewer adopts a cynical stance - assume problems exist and find them.
|
|
11
|
+
|
|
12
|
+
This isn't about being negative. It's about forcing genuine analysis instead of a cursory glance that rubber-stamps whatever was submitted.
|
|
13
|
+
|
|
14
|
+
**The core rule:** You must find issues. Zero findings triggers a halt - re-analyze or explain why.
|
|
15
|
+
|
|
16
|
+
## Why It Works
|
|
17
|
+
|
|
18
|
+
Normal reviews suffer from confirmation bias. You skim the work, nothing jumps out, you approve it. The "find problems" mandate breaks this pattern:
|
|
19
|
+
|
|
20
|
+
- **Forces thoroughness** - Can't approve until you've looked hard enough to find issues
|
|
21
|
+
- **Catches missing things** - "What's not here?" becomes a natural question
|
|
22
|
+
- **Improves signal quality** - Findings are specific and actionable, not vague concerns
|
|
23
|
+
- **Information asymmetry** - Run reviews with fresh context (no access to original reasoning) so you evaluate the artifact, not the intent
|
|
24
|
+
|
|
25
|
+
## Where It's Used
|
|
26
|
+
|
|
27
|
+
Adversarial review appears throughout BMAD workflows - code review, implementation readiness checks, spec validation, and others. Sometimes it's a required step, sometimes optional (like advanced elicitation or party mode). The pattern adapts to whatever artifact needs scrutiny.
|
|
28
|
+
|
|
29
|
+
## Human Filtering Required
|
|
30
|
+
|
|
31
|
+
Because the AI is *instructed* to find problems, it will find problems - even when they don't exist. Expect false positives: nitpicks dressed as issues, misunderstandings of intent, or outright hallucinated concerns.
|
|
32
|
+
|
|
33
|
+
**You decide what's real.** Review each finding, dismiss the noise, fix what matters.
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
Instead of:
|
|
38
|
+
|
|
39
|
+
> "The authentication implementation looks reasonable. Approved."
|
|
40
|
+
|
|
41
|
+
An adversarial review produces:
|
|
42
|
+
|
|
43
|
+
> 1. **HIGH** - `login.ts:47` - No rate limiting on failed attempts
|
|
44
|
+
> 2. **HIGH** - Session token stored in localStorage (XSS vulnerable)
|
|
45
|
+
> 3. **MEDIUM** - Password validation happens client-side only
|
|
46
|
+
> 4. **MEDIUM** - No audit logging for failed login attempts
|
|
47
|
+
> 5. **LOW** - Magic number `3600` should be `SESSION_TIMEOUT_SECONDS`
|
|
48
|
+
|
|
49
|
+
The first review might miss a security vulnerability. The second caught four.
|
|
50
|
+
|
|
51
|
+
## Iteration and Diminishing Returns
|
|
52
|
+
|
|
53
|
+
After addressing findings, consider running it again. A second pass usually catches more. A third isn't always useless either. But each pass takes time, and eventually you hit diminishing returns - just nitpicks and false findings.
|
|
54
|
+
|
|
55
|
+
:::tip[Better Reviews]
|
|
56
|
+
Assume problems exist. Look for what's missing, not just what's wrong.
|
|
57
|
+
:::
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Brainstorming"
|
|
3
|
+
description: Interactive creative sessions using 60+ proven ideation techniques
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Unlock your creativity through guided exploration.
|
|
7
|
+
|
|
8
|
+
## What is Brainstorming?
|
|
9
|
+
|
|
10
|
+
Run `brainstorming` and you've got a creative facilitator pulling ideas out of you - not generating them for you. The AI acts as coach and guide, using proven techniques to create conditions where your best thinking emerges.
|
|
11
|
+
|
|
12
|
+
**Good for:**
|
|
13
|
+
|
|
14
|
+
- Breaking through creative blocks
|
|
15
|
+
- Generating product or feature ideas
|
|
16
|
+
- Exploring problems from new angles
|
|
17
|
+
- Developing raw concepts into action plans
|
|
18
|
+
|
|
19
|
+
## How It Works
|
|
20
|
+
|
|
21
|
+
1. **Setup** - Define topic, goals, constraints
|
|
22
|
+
2. **Choose approach** - Pick techniques yourself, get AI recommendations, go random, or follow a progressive flow
|
|
23
|
+
3. **Facilitation** - Work through techniques with probing questions and collaborative coaching
|
|
24
|
+
4. **Organize** - Ideas grouped into themes and prioritized
|
|
25
|
+
5. **Action** - Top ideas get next steps and success metrics
|
|
26
|
+
|
|
27
|
+
Everything gets captured in a session document you can reference later or share with stakeholders.
|
|
28
|
+
|
|
29
|
+
:::note[Your Ideas]
|
|
30
|
+
Every idea comes from you. The workflow creates conditions for insight - you're the source.
|
|
31
|
+
:::
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Brownfield Development FAQ"
|
|
3
|
+
description: Common questions about brownfield development in the BMad Method
|
|
4
|
+
---
|
|
5
|
+
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
|
|
6
|
+
|
|
7
|
+
## Questions
|
|
8
|
+
|
|
9
|
+
- [Questions](#questions)
|
|
10
|
+
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
|
11
|
+
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
|
12
|
+
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
|
13
|
+
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
|
14
|
+
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
|
15
|
+
|
|
16
|
+
### What is brownfield vs greenfield?
|
|
17
|
+
|
|
18
|
+
- **Greenfield** — New project, starting from scratch, clean slate
|
|
19
|
+
- **Brownfield** — Existing project, working with established codebase and patterns
|
|
20
|
+
|
|
21
|
+
### Do I have to run document-project for brownfield?
|
|
22
|
+
|
|
23
|
+
Highly recommended, especially if:
|
|
24
|
+
|
|
25
|
+
- No existing documentation
|
|
26
|
+
- Documentation is outdated
|
|
27
|
+
- AI agents need context about existing code
|
|
28
|
+
|
|
29
|
+
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
|
30
|
+
|
|
31
|
+
### What if I forget to run document-project?
|
|
32
|
+
|
|
33
|
+
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
|
34
|
+
|
|
35
|
+
### Can I use Quick Spec Flow for brownfield projects?
|
|
36
|
+
|
|
37
|
+
Yes! Quick Spec Flow works great for brownfield. It will:
|
|
38
|
+
|
|
39
|
+
- Auto-detect your existing stack
|
|
40
|
+
- Analyze brownfield code patterns
|
|
41
|
+
- Detect conventions and ask for confirmation
|
|
42
|
+
- Generate context-rich tech-spec that respects existing code
|
|
43
|
+
|
|
44
|
+
Perfect for bug fixes and small features in existing codebases.
|
|
45
|
+
|
|
46
|
+
### What if my existing code doesn't follow best practices?
|
|
47
|
+
|
|
48
|
+
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
|
49
|
+
|
|
50
|
+
- **Yes** → Maintain consistency with current codebase
|
|
51
|
+
- **No** → Establish new standards (document why in tech-spec)
|
|
52
|
+
|
|
53
|
+
BMM respects your choice — it won't force modernization, but it will offer it.
|
|
54
|
+
|
|
55
|
+
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Party Mode"
|
|
3
|
+
description: Multi-agent collaboration - get all your AI agents in one conversation
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Get all your AI agents in one conversation.
|
|
7
|
+
|
|
8
|
+
## What is Party Mode?
|
|
9
|
+
|
|
10
|
+
Run `party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. BMad Master orchestrates, picking relevant agents per message. Agents respond in character, agree, disagree, and build on each other's ideas.
|
|
11
|
+
|
|
12
|
+
The conversation continues as long as you want. Ask follow-ups, push back on answers, redirect the discussion - it's a real back-and-forth with your agents until you're done.
|
|
13
|
+
|
|
14
|
+
**Good for:**
|
|
15
|
+
|
|
16
|
+
- Big decisions with tradeoffs
|
|
17
|
+
- Brainstorming sessions
|
|
18
|
+
- Post-mortems when things go wrong
|
|
19
|
+
- Sprint retrospectives and planning
|
|
20
|
+
|
|
21
|
+
## Examples
|
|
22
|
+
|
|
23
|
+
### Calling Out Bad Architecture
|
|
24
|
+
|
|
25
|
+
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
|
26
|
+
|
|
27
|
+
**Architect:** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
|
28
|
+
|
|
29
|
+
**Dev:** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
|
30
|
+
|
|
31
|
+
**PM:** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
|
32
|
+
|
|
33
|
+
**TEA:** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
|
34
|
+
|
|
35
|
+
### Creative Brainstorming
|
|
36
|
+
|
|
37
|
+
**You:** "How do we make onboarding feel magical instead of boring?"
|
|
38
|
+
|
|
39
|
+
**UX Designer:** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
|
40
|
+
|
|
41
|
+
**Storyteller:** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
|
42
|
+
|
|
43
|
+
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
|
44
|
+
|
|
45
|
+
### Technical Decision
|
|
46
|
+
|
|
47
|
+
**You:** "Monolith or microservices for MVP?"
|
|
48
|
+
|
|
49
|
+
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
|
50
|
+
|
|
51
|
+
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
|
52
|
+
|
|
53
|
+
**Dev:** "Monolith with clear module boundaries. We can extract services later if needed."
|
|
54
|
+
|
|
55
|
+
:::tip[Better Decisions]
|
|
56
|
+
Better decisions through diverse perspectives. Welcome to party mode.
|
|
57
|
+
:::
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Preventing Agent Conflicts"
|
|
3
|
+
description: How architecture prevents conflicts when multiple agents implement a system
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
|
7
|
+
|
|
8
|
+
## Common Conflict Types
|
|
9
|
+
|
|
10
|
+
### API Style Conflicts
|
|
11
|
+
|
|
12
|
+
Without architecture:
|
|
13
|
+
- Agent A uses REST with `/users/{id}`
|
|
14
|
+
- Agent B uses GraphQL mutations
|
|
15
|
+
- Result: Inconsistent API patterns, confused consumers
|
|
16
|
+
|
|
17
|
+
With architecture:
|
|
18
|
+
- ADR specifies: "Use GraphQL for all client-server communication"
|
|
19
|
+
- All agents follow the same pattern
|
|
20
|
+
|
|
21
|
+
### Database Design Conflicts
|
|
22
|
+
|
|
23
|
+
Without architecture:
|
|
24
|
+
- Agent A uses snake_case column names
|
|
25
|
+
- Agent B uses camelCase column names
|
|
26
|
+
- Result: Inconsistent schema, confusing queries
|
|
27
|
+
|
|
28
|
+
With architecture:
|
|
29
|
+
- Standards document specifies naming conventions
|
|
30
|
+
- All agents follow the same patterns
|
|
31
|
+
|
|
32
|
+
### State Management Conflicts
|
|
33
|
+
|
|
34
|
+
Without architecture:
|
|
35
|
+
- Agent A uses Redux for global state
|
|
36
|
+
- Agent B uses React Context
|
|
37
|
+
- Result: Multiple state management approaches, complexity
|
|
38
|
+
|
|
39
|
+
With architecture:
|
|
40
|
+
- ADR specifies state management approach
|
|
41
|
+
- All agents implement consistently
|
|
42
|
+
|
|
43
|
+
## How Architecture Prevents Conflicts
|
|
44
|
+
|
|
45
|
+
### 1. Explicit Decisions via ADRs
|
|
46
|
+
|
|
47
|
+
Every significant technology choice is documented with:
|
|
48
|
+
- Context (why this decision matters)
|
|
49
|
+
- Options considered (what alternatives exist)
|
|
50
|
+
- Decision (what we chose)
|
|
51
|
+
- Rationale (why we chose it)
|
|
52
|
+
- Consequences (trade-offs accepted)
|
|
53
|
+
|
|
54
|
+
### 2. FR/NFR-Specific Guidance
|
|
55
|
+
|
|
56
|
+
Architecture maps each functional requirement to technical approach:
|
|
57
|
+
- FR-001: User Management → GraphQL mutations
|
|
58
|
+
- FR-002: Mobile App → Optimized queries
|
|
59
|
+
|
|
60
|
+
### 3. Standards and Conventions
|
|
61
|
+
|
|
62
|
+
Explicit documentation of:
|
|
63
|
+
- Directory structure
|
|
64
|
+
- Naming conventions
|
|
65
|
+
- Code organization
|
|
66
|
+
- Testing patterns
|
|
67
|
+
|
|
68
|
+
## Architecture as Shared Context
|
|
69
|
+
|
|
70
|
+
Think of architecture as the shared context that all agents read before implementing:
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
PRD: "What to build"
|
|
74
|
+
↓
|
|
75
|
+
Architecture: "How to build it"
|
|
76
|
+
↓
|
|
77
|
+
Agent A reads architecture → implements Epic 1
|
|
78
|
+
Agent B reads architecture → implements Epic 2
|
|
79
|
+
Agent C reads architecture → implements Epic 3
|
|
80
|
+
↓
|
|
81
|
+
Result: Consistent implementation
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Key ADR Topics
|
|
85
|
+
|
|
86
|
+
Common decisions that prevent conflicts:
|
|
87
|
+
|
|
88
|
+
| Topic | Example Decision |
|
|
89
|
+
| ---------------- | -------------------------------------------- |
|
|
90
|
+
| API Style | GraphQL vs REST vs gRPC |
|
|
91
|
+
| Database | PostgreSQL vs MongoDB |
|
|
92
|
+
| Auth | JWT vs Sessions |
|
|
93
|
+
| State Management | Redux vs Context vs Zustand |
|
|
94
|
+
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
|
95
|
+
| Testing | Jest + Playwright vs Vitest + Cypress |
|
|
96
|
+
|
|
97
|
+
## Anti-Patterns to Avoid
|
|
98
|
+
|
|
99
|
+
:::caution[Common Mistakes]
|
|
100
|
+
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
|
|
101
|
+
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
|
|
102
|
+
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
|
|
103
|
+
:::
|
|
104
|
+
|
|
105
|
+
:::tip[Correct Approach]
|
|
106
|
+
- Document decisions that cross epic boundaries
|
|
107
|
+
- Focus on conflict-prone areas
|
|
108
|
+
- Update architecture as you learn
|
|
109
|
+
- Use `correct-course` for significant changes
|
|
110
|
+
:::
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Quick Flow"
|
|
3
|
+
description: Fast-track for small changes - skip the full methodology
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Quick Flow is for when you don't need the full BMad Method. Skip Product Brief, PRD, and Architecture - go straight to implementation.
|
|
7
|
+
|
|
8
|
+
## How It Works
|
|
9
|
+
|
|
10
|
+
1. **Run `quick-spec`** — generates a focused tech-spec
|
|
11
|
+
2. **Run `quick-dev`** — implements it
|
|
12
|
+
|
|
13
|
+
That's it.
|
|
14
|
+
|
|
15
|
+
## When to Use It
|
|
16
|
+
|
|
17
|
+
- Bug fixes
|
|
18
|
+
- Refactoring
|
|
19
|
+
- Small features
|
|
20
|
+
- Prototyping
|
|
21
|
+
|
|
22
|
+
## When to Use Full BMad Method Instead
|
|
23
|
+
|
|
24
|
+
- New products
|
|
25
|
+
- Major features
|
|
26
|
+
- Multiple teams involved
|
|
27
|
+
- Stakeholder alignment needed
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Why Solutioning Matters"
|
|
3
|
+
description: Understanding why the solutioning phase is critical for multi-epic projects
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
|
8
|
+
|
|
9
|
+
## The Problem Without Solutioning
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
Agent 1 implements Epic 1 using REST API
|
|
13
|
+
Agent 2 implements Epic 2 using GraphQL
|
|
14
|
+
Result: Inconsistent API design, integration nightmare
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
|
18
|
+
|
|
19
|
+
## The Solution With Solutioning
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
architecture workflow decides: "Use GraphQL for all APIs"
|
|
23
|
+
All agents follow architecture decisions
|
|
24
|
+
Result: Consistent implementation, no conflicts
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
|
28
|
+
|
|
29
|
+
## Solutioning vs Planning
|
|
30
|
+
|
|
31
|
+
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
|
32
|
+
| -------- | ----------------------- | --------------------------------- |
|
|
33
|
+
| Question | What and Why? | How? Then What units of work? |
|
|
34
|
+
| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories |
|
|
35
|
+
| Agent | PM | Architect → PM |
|
|
36
|
+
| Audience | Stakeholders | Developers |
|
|
37
|
+
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
|
38
|
+
| Level | Business logic | Technical design + Work breakdown |
|
|
39
|
+
|
|
40
|
+
## Key Principle
|
|
41
|
+
|
|
42
|
+
**Make technical decisions explicit and documented** so all agents implement consistently.
|
|
43
|
+
|
|
44
|
+
This prevents:
|
|
45
|
+
- API style conflicts (REST vs GraphQL)
|
|
46
|
+
- Database design inconsistencies
|
|
47
|
+
- State management disagreements
|
|
48
|
+
- Naming convention mismatches
|
|
49
|
+
- Security approach variations
|
|
50
|
+
|
|
51
|
+
## When Solutioning is Required
|
|
52
|
+
|
|
53
|
+
| Track | Solutioning Required? |
|
|
54
|
+
|-------|----------------------|
|
|
55
|
+
| Quick Flow | No - skip entirely |
|
|
56
|
+
| BMad Method Simple | Optional |
|
|
57
|
+
| BMad Method Complex | Yes |
|
|
58
|
+
| Enterprise | Yes |
|
|
59
|
+
|
|
60
|
+
:::tip[Rule of Thumb]
|
|
61
|
+
If you have multiple epics that could be implemented by different agents, you need solutioning.
|
|
62
|
+
:::
|
|
63
|
+
|
|
64
|
+
## The Cost of Skipping
|
|
65
|
+
|
|
66
|
+
Skipping solutioning on complex projects leads to:
|
|
67
|
+
|
|
68
|
+
- **Integration issues** discovered mid-sprint
|
|
69
|
+
- **Rework** due to conflicting implementations
|
|
70
|
+
- **Longer development time** overall
|
|
71
|
+
- **Technical debt** from inconsistent patterns
|
|
72
|
+
|
|
73
|
+
:::caution[Cost Multiplier]
|
|
74
|
+
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
|
75
|
+
:::
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Brownfield Development"
|
|
3
|
+
description: How to use BMad Method on existing codebases
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use BMad Method effectively when working on existing projects and legacy codebases.
|
|
7
|
+
|
|
8
|
+
## What is Brownfield Development?
|
|
9
|
+
|
|
10
|
+
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
|
11
|
+
|
|
12
|
+
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
|
13
|
+
|
|
14
|
+
:::note[Prerequisites]
|
|
15
|
+
- BMad Method installed (`npx bmad-method install`)
|
|
16
|
+
- An existing codebase you want to work on
|
|
17
|
+
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
|
18
|
+
:::
|
|
19
|
+
|
|
20
|
+
## Step 1: Clean Up Completed Planning Artifacts
|
|
21
|
+
|
|
22
|
+
If you have completed all PRD epics and stories through the BMad process, clean up those files. Archive them, delete them, or rely on version history if needed. Do not keep these files in:
|
|
23
|
+
|
|
24
|
+
- `docs/`
|
|
25
|
+
- `_bmad-output/planning-artifacts/`
|
|
26
|
+
- `_bmad-output/implementation-artifacts/`
|
|
27
|
+
|
|
28
|
+
## Step 2: Maintain Quality Project Documentation
|
|
29
|
+
|
|
30
|
+
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
|
31
|
+
|
|
32
|
+
- Intent and business rationale
|
|
33
|
+
- Business rules
|
|
34
|
+
- Architecture
|
|
35
|
+
- Any other relevant project information
|
|
36
|
+
|
|
37
|
+
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
|
38
|
+
|
|
39
|
+
## Step 3: Get Help
|
|
40
|
+
|
|
41
|
+
Get help to know what to do next based on your unique needs
|
|
42
|
+
|
|
43
|
+
Run `bmad-help` to get guidance when you are not sure what to do next.
|
|
44
|
+
|
|
45
|
+
### Choosing Your Approach
|
|
46
|
+
|
|
47
|
+
You have two primary options depending on the scope of changes:
|
|
48
|
+
|
|
49
|
+
| Scope | Recommended Approach |
|
|
50
|
+
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad method is likely overkill. |
|
|
52
|
+
| **Major changes or additions** | Start with the BMad method, applying as much or as little rigor as needed. |
|
|
53
|
+
|
|
54
|
+
### During PRD Creation
|
|
55
|
+
|
|
56
|
+
When creating a brief or jumping directly into the PRD, ensure the agent:
|
|
57
|
+
|
|
58
|
+
- Finds and analyzes your existing project documentation
|
|
59
|
+
- Reads the proper context about your current system
|
|
60
|
+
|
|
61
|
+
You can guide the agent explicitly, but the goal is to ensure the new feature integrates well with your existing system.
|
|
62
|
+
|
|
63
|
+
### UX Considerations
|
|
64
|
+
|
|
65
|
+
UX work is optional. The decision depends not on whether your project has a UX, but on:
|
|
66
|
+
|
|
67
|
+
- Whether you will be working on UX changes
|
|
68
|
+
- Whether significant new UX designs or patterns are needed
|
|
69
|
+
|
|
70
|
+
If your changes amount to simple updates to existing screens you are happy with, a full UX process is unnecessary.
|
|
71
|
+
|
|
72
|
+
### Architecture Considerations
|
|
73
|
+
|
|
74
|
+
When doing architecture, ensure the architect:
|
|
75
|
+
|
|
76
|
+
- Uses the proper documented files
|
|
77
|
+
- Scans the existing codebase
|
|
78
|
+
|
|
79
|
+
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
|
80
|
+
|
|
81
|
+
## More Information
|
|
82
|
+
|
|
83
|
+
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
|
84
|
+
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "How to Make Quick Fixes in Brownfield Projects"
|
|
3
|
+
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
|
7
|
+
|
|
8
|
+
## When to Use This
|
|
9
|
+
|
|
10
|
+
- Simple bug fixes
|
|
11
|
+
- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts
|
|
12
|
+
- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow
|
|
13
|
+
- Learning about your codebase
|
|
14
|
+
|
|
15
|
+
## Steps
|
|
16
|
+
|
|
17
|
+
### 1. Load an Agent
|
|
18
|
+
|
|
19
|
+
For quick fixes, you can use:
|
|
20
|
+
|
|
21
|
+
- **DEV agent** - For implementation-focused work
|
|
22
|
+
- **Quick Flow Solo Dev** - For slightly larger changes that still need a quick-spec to keep the agent aligned to planning and standards
|
|
23
|
+
|
|
24
|
+
### 2. Describe the Change
|
|
25
|
+
|
|
26
|
+
Simply tell the agent what you need:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
Fix the login validation bug that allows empty passwords
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
or
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
Refactor the UserService to use async/await instead of callbacks
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 3. Let the Agent Work
|
|
39
|
+
|
|
40
|
+
The agent will:
|
|
41
|
+
|
|
42
|
+
- Analyze the relevant code
|
|
43
|
+
- Propose a solution
|
|
44
|
+
- Implement the change
|
|
45
|
+
- Run tests (if available)
|
|
46
|
+
|
|
47
|
+
### 4. Review and Commit
|
|
48
|
+
|
|
49
|
+
Review the changes made and commit when satisfied.
|
|
50
|
+
|
|
51
|
+
## Learning Your Codebase
|
|
52
|
+
|
|
53
|
+
This approach is also excellent for exploring unfamiliar code:
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
Explain how the authentication system works in this codebase
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
Show me where error handling happens in the API layer
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to:
|
|
64
|
+
|
|
65
|
+
- Learn about your project
|
|
66
|
+
- Understand how things are built
|
|
67
|
+
- Explore unfamiliar parts of the codebase
|
|
68
|
+
|
|
69
|
+
## When to Upgrade to Formal Planning
|
|
70
|
+
|
|
71
|
+
Consider using Quick Flow or full BMad Method when:
|
|
72
|
+
|
|
73
|
+
- The change affects multiple files or systems
|
|
74
|
+
- You're unsure about the scope
|
|
75
|
+
- The fix keeps growing in complexity
|
|
76
|
+
- You need documentation for the change
|