bmad-method 6.0.4 → 6.0.5-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.augment/code_review_guidelines.yaml +2 -42
- package/.claude/skills/bmad-os-findings-triage/SKILL.md +6 -0
- package/.claude/skills/bmad-os-findings-triage/prompts/agent-prompt.md +104 -0
- package/.claude/skills/bmad-os-findings-triage/prompts/instructions.md +286 -0
- package/.claude/skills/bmad-os-review-pr/SKILL.md +1 -1
- package/.claude/skills/bmad-os-review-pr/prompts/instructions.md +63 -6
- package/.claude/skills/bmad-os-review-prompt/SKILL.md +177 -0
- package/.github/workflows/publish.yaml +243 -0
- package/CONTRIBUTING.md +1 -1
- package/README_CN.md +121 -0
- package/docs/_STYLE_GUIDE.md +10 -10
- package/docs/explanation/brainstorming.md +1 -1
- package/docs/explanation/party-mode.md +1 -1
- package/docs/explanation/preventing-agent-conflicts.md +1 -1
- package/docs/explanation/project-context.md +15 -15
- package/docs/explanation/quick-flow.md +9 -9
- package/docs/how-to/established-projects.md +7 -7
- package/docs/how-to/get-answers-about-bmad.md +2 -2
- package/docs/how-to/install-bmad.md +16 -6
- package/docs/how-to/project-context.md +2 -2
- package/docs/how-to/quick-fixes.md +5 -5
- package/docs/how-to/shard-large-documents.md +1 -1
- package/docs/how-to/upgrade-to-v6.md +8 -5
- package/docs/index.md +1 -1
- package/docs/reference/agents.md +14 -14
- package/docs/reference/commands.md +64 -70
- package/docs/reference/testing.md +1 -1
- package/docs/reference/workflow-map.md +19 -19
- package/docs/tutorials/getting-started.md +34 -34
- package/docs/zh-cn/404.md +9 -0
- package/docs/zh-cn/_STYLE_GUIDE.md +370 -0
- package/docs/zh-cn/explanation/advanced-elicitation.md +62 -0
- package/docs/zh-cn/explanation/adversarial-review.md +71 -0
- package/docs/zh-cn/explanation/brainstorming.md +43 -0
- package/docs/zh-cn/explanation/established-projects-faq.md +60 -0
- package/docs/zh-cn/explanation/party-mode.md +79 -0
- package/docs/zh-cn/explanation/preventing-agent-conflicts.md +137 -0
- package/docs/zh-cn/explanation/project-context.md +176 -0
- package/docs/zh-cn/explanation/quick-flow.md +93 -0
- package/docs/zh-cn/explanation/why-solutioning-matters.md +90 -0
- package/docs/zh-cn/how-to/customize-bmad.md +182 -0
- package/docs/zh-cn/how-to/established-projects.md +134 -0
- package/docs/zh-cn/how-to/get-answers-about-bmad.md +144 -0
- package/docs/zh-cn/how-to/install-bmad.md +105 -0
- package/docs/zh-cn/how-to/non-interactive-installation.md +181 -0
- package/docs/zh-cn/how-to/project-context.md +152 -0
- package/docs/zh-cn/how-to/quick-fixes.md +140 -0
- package/docs/zh-cn/how-to/shard-large-documents.md +86 -0
- package/docs/zh-cn/how-to/upgrade-to-v6.md +120 -0
- package/docs/zh-cn/index.md +69 -0
- package/docs/zh-cn/reference/agents.md +41 -0
- package/docs/zh-cn/reference/commands.md +166 -0
- package/docs/zh-cn/reference/modules.md +94 -0
- package/docs/zh-cn/reference/testing.md +122 -0
- package/docs/zh-cn/reference/workflow-map.md +104 -0
- package/docs/zh-cn/roadmap.mdx +152 -0
- package/docs/zh-cn/tutorials/getting-started.md +300 -0
- package/package.json +1 -1
- package/src/bmm/agents/analyst.agent.yaml +1 -1
- package/src/bmm/agents/bmad-skill-manifest.yaml +39 -0
- package/src/bmm/agents/dev.agent.yaml +2 -2
- package/src/bmm/agents/pm.agent.yaml +1 -1
- package/src/bmm/agents/qa.agent.yaml +1 -1
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +6 -2
- package/src/bmm/agents/sm.agent.yaml +4 -4
- package/src/bmm/agents/tech-writer/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +1 -1
- package/src/bmm/module-help.csv +11 -10
- package/src/bmm/workflows/1-analysis/create-product-brief/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
- package/src/bmm/workflows/1-analysis/research/bmad-skill-manifest.yaml +14 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/bmad-skill-manifest.yaml +14 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-architecture/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +2 -2
- package/src/bmm/workflows/4-implementation/code-review/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/code-review/discover-inputs.md +88 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.md +271 -0
- package/src/bmm/workflows/4-implementation/correct-course/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
- package/src/bmm/workflows/4-implementation/correct-course/{instructions.md → workflow.md} +79 -12
- package/src/bmm/workflows/4-implementation/create-story/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +9 -10
- package/src/bmm/workflows/4-implementation/create-story/discover-inputs.md +88 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.md +388 -0
- package/src/bmm/workflows/4-implementation/dev-story/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/dev-story/{instructions.xml → workflow.md} +49 -2
- package/src/bmm/workflows/4-implementation/retrospective/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/retrospective/{instructions.md → workflow.md} +64 -23
- package/src/bmm/workflows/4-implementation/sprint-planning/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +1 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/{instructions.md → workflow.md} +55 -10
- package/src/bmm/workflows/4-implementation/sprint-status/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/sprint-status/{instructions.md → workflow.md} +45 -8
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md +6 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/bmad-skill-manifest.yaml +1 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-01-clarify-and-route.md +54 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-02-plan.md +39 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-03-implement.md +35 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md +55 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md +19 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/tech-spec-template.md +90 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/workflow.md +84 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +8 -14
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +4 -6
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +1 -1
- package/src/bmm/workflows/document-project/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/document-project/instructions.md +5 -7
- package/src/bmm/workflows/document-project/workflow.md +39 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -1
- package/src/bmm/workflows/document-project/workflows/deep-dive-workflow.md +42 -0
- package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1
- package/src/bmm/workflows/document-project/workflows/full-scan-workflow.md +42 -0
- package/src/bmm/workflows/generate-project-context/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
- package/src/bmm/workflows/qa-generate-e2e-tests/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/qa-generate-e2e-tests/checklist.md +1 -1
- package/src/bmm/workflows/qa-generate-e2e-tests/{instructions.md → workflow.md} +40 -7
- package/src/core/agents/bmad-master.agent.yaml +1 -1
- package/src/core/agents/bmad-skill-manifest.yaml +3 -0
- package/src/core/module-help.csv +3 -3
- package/src/core/module.yaml +1 -1
- package/src/core/tasks/bmad-help/SKILL.md +6 -0
- package/src/core/tasks/bmad-help/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/{help.md → bmad-help/workflow.md} +6 -4
- package/src/core/tasks/bmad-review-adversarial-general/SKILL.md +6 -0
- package/src/core/tasks/bmad-review-adversarial-general/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-review-adversarial-general/workflow.md +32 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/SKILL.md +6 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/workflow.md +62 -0
- package/src/core/tasks/bmad-skill-manifest.yaml +19 -0
- package/src/core/workflows/advanced-elicitation/bmad-skill-manifest.yaml +3 -0
- package/src/core/workflows/advanced-elicitation/workflow.md +138 -0
- package/src/core/workflows/brainstorming/bmad-skill-manifest.yaml +3 -0
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +1 -1
- package/src/core/workflows/brainstorming/workflow.md +1 -1
- package/src/core/workflows/party-mode/bmad-skill-manifest.yaml +3 -0
- package/src/utility/agent-components/activation-steps.txt +2 -2
- package/src/utility/agent-components/handler-multi.txt +1 -2
- package/test/adversarial-review-tests/README.md +3 -3
- package/test/adversarial-review-tests/test-cases.yaml +2 -2
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +1 -1
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +1 -1
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +1 -2
- package/test/fixtures/file-refs-csv/valid/bmm-style.csv +1 -1
- package/test/test-file-refs-csv.js +1 -1
- package/test/test-install-to-bmad.js +154 -0
- package/test/test-installation-components.js +1586 -2
- package/test/test-workflow-path-regex.js +88 -0
- package/tools/cli/installers/lib/core/installer.js +34 -1
- package/tools/cli/installers/lib/core/manifest-generator.js +328 -35
- package/tools/cli/installers/lib/ide/_base-ide.js +24 -15
- package/tools/cli/installers/lib/ide/_config-driven.js +472 -53
- package/tools/cli/installers/lib/ide/manager.js +23 -61
- package/tools/cli/installers/lib/ide/platform-codes.yaml +108 -30
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +1 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +7 -0
- package/tools/cli/installers/lib/ide/shared/path-utils.js +68 -3
- package/tools/cli/installers/lib/ide/shared/skill-manifest.js +90 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +2 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +6 -145
- package/tools/cli/installers/lib/modules/manager.js +9 -132
- package/tools/cli/lib/agent/compiler.js +1 -10
- package/tools/cli/lib/agent-analyzer.js +2 -14
- package/tools/cli/lib/yaml-xml-builder.js +1 -18
- package/tools/docs/native-skills-migration-checklist.md +281 -0
- package/tools/platform-codes.yaml +1 -1
- package/tools/schema/agent.js +1 -3
- package/tools/validate-file-refs.js +2 -0
- package/website/astro.config.mjs +24 -3
- package/website/src/content/config.ts +2 -1
- package/website/src/content/i18n/zh-CN.json +28 -0
- package/src/bmm/workflows/4-implementation/code-review/instructions.xml +0 -227
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +0 -43
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +0 -53
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +0 -346
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +0 -52
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +0 -20
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +0 -52
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +0 -47
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +0 -25
- package/src/bmm/workflows/document-project/workflow.yaml +0 -22
- package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
- package/src/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
- package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +0 -42
- package/src/core/tasks/review-adversarial-general.xml +0 -49
- package/src/core/tasks/review-edge-case-hunter.xml +0 -63
- package/src/core/tasks/workflow.xml +0 -235
- package/src/core/workflows/advanced-elicitation/workflow.xml +0 -118
- package/src/utility/agent-components/handler-validate-workflow.txt +0 -7
- package/src/utility/agent-components/handler-workflow.txt +0 -10
- package/tools/cli/installers/lib/ide/codex.js +0 -440
- package/tools/cli/installers/lib/ide/github-copilot.js +0 -699
- package/tools/cli/installers/lib/ide/kilo.js +0 -269
- package/tools/cli/installers/lib/ide/rovodev.js +0 -257
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +0 -14
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +0 -15
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +0 -13
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +0 -5
|
@@ -21,12 +21,12 @@ The `project-context.md` file solves this by documenting what agents need to kno
|
|
|
21
21
|
Every implementation workflow automatically loads `project-context.md` if it exists. The architect workflow also loads it to respect your technical preferences when designing the architecture.
|
|
22
22
|
|
|
23
23
|
**Loaded by these workflows:**
|
|
24
|
-
- `create-architecture` — respects technical preferences during solutioning
|
|
25
|
-
- `create-story` — informs story creation with project patterns
|
|
26
|
-
- `dev-story` — guides implementation decisions
|
|
27
|
-
- `code-review` — validates against project standards
|
|
28
|
-
- `quick-dev` — applies patterns when implementing tech-specs
|
|
29
|
-
- `sprint-planning`, `retrospective`, `correct-course` — provides project-wide context
|
|
24
|
+
- `bmad-create-architecture` — respects technical preferences during solutioning
|
|
25
|
+
- `bmad-create-story` — informs story creation with project patterns
|
|
26
|
+
- `bmad-dev-story` — guides implementation decisions
|
|
27
|
+
- `bmad-code-review` — validates against project standards
|
|
28
|
+
- `bmad-quick-dev` — applies patterns when implementing tech-specs
|
|
29
|
+
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — provides project-wide context
|
|
30
30
|
|
|
31
31
|
## When to Create It
|
|
32
32
|
|
|
@@ -34,10 +34,10 @@ The `project-context.md` file is useful at any stage of a project:
|
|
|
34
34
|
|
|
35
35
|
| Scenario | When to Create | Purpose |
|
|
36
36
|
|----------|----------------|---------|
|
|
37
|
-
| **New project, before architecture** | Manually, before `create-architecture` | Document your technical preferences so the architect respects them |
|
|
38
|
-
| **New project, after architecture** | Via `generate-project-context` or manually | Capture architecture decisions for implementation agents |
|
|
39
|
-
| **Existing project** | Via `generate-project-context` | Discover existing patterns so agents follow established conventions |
|
|
40
|
-
| **Quick Flow project** | Before or during `quick-dev` | Ensure quick implementation respects your patterns |
|
|
37
|
+
| **New project, before architecture** | Manually, before `bmad-create-architecture` | Document your technical preferences so the architect respects them |
|
|
38
|
+
| **New project, after architecture** | Via `bmad-generate-project-context` or manually | Capture architecture decisions for implementation agents |
|
|
39
|
+
| **Existing project** | Via `bmad-generate-project-context` | Discover existing patterns so agents follow established conventions |
|
|
40
|
+
| **Quick Flow project** | Before or during `bmad-quick-dev` | Ensure quick implementation respects your patterns |
|
|
41
41
|
|
|
42
42
|
:::tip[Recommended]
|
|
43
43
|
For new projects, create it manually before architecture if you have strong technical preferences. Otherwise, generate it after architecture to capture those decisions.
|
|
@@ -107,20 +107,20 @@ Edit it with your technology stack and implementation rules. The architect and i
|
|
|
107
107
|
|
|
108
108
|
### Generate After Architecture
|
|
109
109
|
|
|
110
|
-
Run the `generate-project-context` workflow after completing your architecture:
|
|
110
|
+
Run the `bmad-generate-project-context` workflow after completing your architecture:
|
|
111
111
|
|
|
112
112
|
```bash
|
|
113
|
-
|
|
113
|
+
bmad-generate-project-context
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
This scans your architecture document and project files to generate a context file capturing the decisions made.
|
|
117
117
|
|
|
118
118
|
### Generate for Existing Projects
|
|
119
119
|
|
|
120
|
-
For existing projects, run `generate-project-context` to discover existing patterns:
|
|
120
|
+
For existing projects, run `bmad-generate-project-context` to discover existing patterns:
|
|
121
121
|
|
|
122
122
|
```bash
|
|
123
|
-
|
|
123
|
+
bmad-generate-project-context
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
|
@@ -150,7 +150,7 @@ The `project-context.md` file is a living document. Update it when:
|
|
|
150
150
|
- Patterns evolve during implementation
|
|
151
151
|
- You identify gaps from agent behavior
|
|
152
152
|
|
|
153
|
-
You can edit it manually at any time, or re-run `generate-project-context` to update it after significant changes.
|
|
153
|
+
You can edit it manually at any time, or re-run `bmad-generate-project-context` to update it after significant changes.
|
|
154
154
|
|
|
155
155
|
:::note[File Location]
|
|
156
156
|
The default location is `_bmad-output/project-context.md`. Workflows search for it there, and also check `**/project-context.md` anywhere in your project.
|
|
@@ -5,7 +5,7 @@ sidebar:
|
|
|
5
5
|
order: 1
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
Skip the ceremony. Quick Flow takes you from idea to working code in two
|
|
8
|
+
Skip the ceremony. Quick Flow takes you from idea to working code in two skills - no Product Brief, no PRD, no Architecture doc.
|
|
9
9
|
|
|
10
10
|
## When to Use It
|
|
11
11
|
|
|
@@ -23,16 +23,16 @@ Skip the ceremony. Quick Flow takes you from idea to working code in two command
|
|
|
23
23
|
- Anything where requirements are unclear or contested
|
|
24
24
|
|
|
25
25
|
:::caution[Scope Creep]
|
|
26
|
-
If you start a Quick Flow and realize the scope is bigger than expected, `quick-dev` will detect this and offer to escalate. You can switch to a full PRD workflow at any point without losing your work.
|
|
26
|
+
If you start a Quick Flow and realize the scope is bigger than expected, `bmad-quick-dev` will detect this and offer to escalate. You can switch to a full PRD workflow at any point without losing your work.
|
|
27
27
|
:::
|
|
28
28
|
|
|
29
29
|
## How It Works
|
|
30
30
|
|
|
31
|
-
Quick Flow has two
|
|
31
|
+
Quick Flow has two skills, each backed by a structured workflow. You can run them together or independently.
|
|
32
32
|
|
|
33
33
|
### quick-spec: Plan
|
|
34
34
|
|
|
35
|
-
Run `quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
|
|
35
|
+
Run `bmad-quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
|
|
36
36
|
|
|
37
37
|
1. **Understand** - You describe what you want to build. Barry scans the codebase to ask informed questions, then captures a problem statement, solution approach, and scope boundaries.
|
|
38
38
|
2. **Investigate** - Barry reads relevant files, maps code patterns, identifies files to modify, and documents the technical context.
|
|
@@ -43,15 +43,15 @@ The output is a `tech-spec-{slug}.md` file saved to your project's implementatio
|
|
|
43
43
|
|
|
44
44
|
### quick-dev: Build
|
|
45
45
|
|
|
46
|
-
Run `quick-dev` and Barry implements the work. It operates in two modes:
|
|
46
|
+
Run `bmad-quick-dev` and Barry implements the work. It operates in two modes:
|
|
47
47
|
|
|
48
48
|
- **Tech-spec mode** - Point it at a spec file (`quick-dev tech-spec-auth.md`) and it executes every task in order, writes tests, and verifies acceptance criteria.
|
|
49
49
|
- **Direct mode** - Give it instructions directly (`quick-dev "refactor the auth middleware"`) and it gathers context, builds a mental plan, and executes.
|
|
50
50
|
|
|
51
|
-
After implementation, `quick-dev` runs a self-check audit against all tasks and acceptance criteria, then triggers an adversarial code review of the diff. Findings are presented for you to resolve before wrapping up.
|
|
51
|
+
After implementation, `bmad-quick-dev` runs a self-check audit against all tasks and acceptance criteria, then triggers an adversarial code review of the diff. Findings are presented for you to resolve before wrapping up.
|
|
52
52
|
|
|
53
53
|
:::tip[Fresh Context]
|
|
54
|
-
For best results, run `quick-dev` in a new conversation after finishing `quick-spec`. This gives the implementation agent clean context focused solely on building.
|
|
54
|
+
For best results, run `bmad-quick-dev` in a new conversation after finishing `bmad-quick-spec`. This gives the implementation agent clean context focused solely on building.
|
|
55
55
|
:::
|
|
56
56
|
|
|
57
57
|
## What Quick Flow Skips
|
|
@@ -65,9 +65,9 @@ The full BMad Method produces a Product Brief, PRD, Architecture doc, and Epic/S
|
|
|
65
65
|
|
|
66
66
|
## Escalating to Full BMad Method
|
|
67
67
|
|
|
68
|
-
Quick Flow includes built-in guardrails for scope detection. When you run `quick-dev` with a direct request, it evaluates signals like multi-component mentions, system-level language, and uncertainty about approach. If it detects the work is bigger than a quick flow:
|
|
68
|
+
Quick Flow includes built-in guardrails for scope detection. When you run `bmad-quick-dev` with a direct request, it evaluates signals like multi-component mentions, system-level language, and uncertainty about approach. If it detects the work is bigger than a quick flow:
|
|
69
69
|
|
|
70
|
-
- **Light escalation** - Recommends running `quick-spec` first to create a plan
|
|
70
|
+
- **Light escalation** - Recommends running `bmad-quick-spec` first to create a plan
|
|
71
71
|
- **Heavy escalation** - Recommends switching to the full BMad Method PRD process
|
|
72
72
|
|
|
73
73
|
You can also escalate manually at any time. Your tech-spec work carries forward - it becomes input for the broader planning process rather than being discarded.
|
|
@@ -32,7 +32,7 @@ Generate `project-context.md` to capture your existing codebase patterns and con
|
|
|
32
32
|
Run the generate project context workflow:
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
|
|
35
|
+
bmad-generate-project-context
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
This scans your codebase to identify:
|
|
@@ -55,22 +55,22 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
|
|
55
55
|
- Architecture
|
|
56
56
|
- Any other relevant project information
|
|
57
57
|
|
|
58
|
-
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.
|
|
58
|
+
For complex projects, consider using the `bmad-document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
|
59
59
|
|
|
60
60
|
## Step 3: Get Help
|
|
61
61
|
|
|
62
62
|
### BMad-Help: Your Starting Point
|
|
63
63
|
|
|
64
|
-
**Run
|
|
64
|
+
**Run `bmad-help` anytime you're unsure what to do next.** This intelligent guide:
|
|
65
65
|
|
|
66
66
|
- Inspects your project to see what's already been done
|
|
67
67
|
- Shows options based on your installed modules
|
|
68
68
|
- Understands natural language queries
|
|
69
69
|
|
|
70
70
|
```
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
71
|
+
bmad-help I have an existing Rails app, where should I start?
|
|
72
|
+
bmad-help What's the difference between quick-flow and full method?
|
|
73
|
+
bmad-help Show me what workflows are available
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
BMad-Help also **automatically runs at the end of every workflow**, providing clear guidance on exactly what to do next.
|
|
@@ -81,7 +81,7 @@ You have two primary options depending on the scope of changes:
|
|
|
81
81
|
|
|
82
82
|
| Scope | Recommended Approach |
|
|
83
83
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
84
|
-
| **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. |
|
|
84
|
+
| **Small updates or additions** | Use `bmad-quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill. |
|
|
85
85
|
| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |
|
|
86
86
|
|
|
87
87
|
### During PRD Creation
|
|
@@ -18,7 +18,7 @@ BMad-Help is more than a lookup tool — it:
|
|
|
18
18
|
|
|
19
19
|
### How to Use BMad-Help
|
|
20
20
|
|
|
21
|
-
Run it with just the
|
|
21
|
+
Run it with just the skill name:
|
|
22
22
|
|
|
23
23
|
```
|
|
24
24
|
/bmad-help
|
|
@@ -81,7 +81,7 @@ https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
|
81
81
|
:::note[Example]
|
|
82
82
|
**Q:** "Tell me the fastest way to build something with BMad"
|
|
83
83
|
|
|
84
|
-
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
|
84
|
+
**A:** Use Quick Flow: Run `bmad-quick-spec` to write a technical specification, then `bmad-quick-dev` to implement it—skipping the full planning phases.
|
|
85
85
|
:::
|
|
86
86
|
|
|
87
87
|
## What You Get
|
|
@@ -51,7 +51,11 @@ Pick which AI tools you use:
|
|
|
51
51
|
- Cursor
|
|
52
52
|
- Others
|
|
53
53
|
|
|
54
|
-
Each tool has its own way of integrating
|
|
54
|
+
Each tool has its own way of integrating skills. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
|
55
|
+
|
|
56
|
+
:::note[Enabling Skills]
|
|
57
|
+
Some platforms require skills to be explicitly enabled in settings before they appear. If you install BMad and don't see the skills, check your platform's settings or ask your AI assistant how to enable skills.
|
|
58
|
+
:::
|
|
55
59
|
|
|
56
60
|
### 4. Choose Modules
|
|
57
61
|
|
|
@@ -71,13 +75,19 @@ your-project/
|
|
|
71
75
|
│ ├── core/ # Required core module
|
|
72
76
|
│ └── ...
|
|
73
77
|
├── _bmad-output/ # Generated artifacts
|
|
74
|
-
├── .claude/ # Claude Code
|
|
75
|
-
└──
|
|
78
|
+
├── .claude/ # Claude Code skills (if using Claude Code)
|
|
79
|
+
│ └── skills/
|
|
80
|
+
│ ├── bmad-help/
|
|
81
|
+
│ ├── bmad-persona/
|
|
82
|
+
│ └── ...
|
|
83
|
+
└── .cursor/ # Cursor skills (if using Cursor)
|
|
84
|
+
└── skills/
|
|
85
|
+
└── ...
|
|
76
86
|
```
|
|
77
87
|
|
|
78
88
|
## Verify Installation
|
|
79
89
|
|
|
80
|
-
Run
|
|
90
|
+
Run `bmad-help` to verify everything works and see what to do next.
|
|
81
91
|
|
|
82
92
|
**BMad-Help is your intelligent guide** that will:
|
|
83
93
|
- Confirm your installation is working
|
|
@@ -86,8 +96,8 @@ Run `/bmad-help` to verify everything works and see what to do next.
|
|
|
86
96
|
|
|
87
97
|
You can also ask it questions:
|
|
88
98
|
```
|
|
89
|
-
|
|
90
|
-
|
|
99
|
+
bmad-help I just installed, what should I do first?
|
|
100
|
+
bmad-help What are my options for a SaaS project?
|
|
91
101
|
```
|
|
92
102
|
|
|
93
103
|
## Troubleshooting
|
|
@@ -77,7 +77,7 @@ sections_completed: ['technology_stack', 'critical_rules']
|
|
|
77
77
|
Run the workflow in a fresh chat:
|
|
78
78
|
|
|
79
79
|
```bash
|
|
80
|
-
|
|
80
|
+
bmad-generate-project-context
|
|
81
81
|
```
|
|
82
82
|
|
|
83
83
|
The workflow scans your architecture document and project files to generate a context file capturing the decisions made.
|
|
@@ -87,7 +87,7 @@ The workflow scans your architecture document and project files to generate a co
|
|
|
87
87
|
For existing projects, run:
|
|
88
88
|
|
|
89
89
|
```bash
|
|
90
|
-
|
|
90
|
+
bmad-generate-project-context
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
|
@@ -30,18 +30,18 @@ If you are unsure, start with the DEV agent. You can always escalate to Quick Fl
|
|
|
30
30
|
|
|
31
31
|
## Steps
|
|
32
32
|
|
|
33
|
-
### 1.
|
|
33
|
+
### 1. Invoke the DEV Agent
|
|
34
34
|
|
|
35
|
-
Start a **fresh chat** in your AI IDE and
|
|
35
|
+
Start a **fresh chat** in your AI IDE and invoke the DEV agent skill:
|
|
36
36
|
|
|
37
37
|
```text
|
|
38
|
-
|
|
38
|
+
bmad-dev
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
This loads the agent's persona and capabilities into the session. If you decide you need Quick Flow instead,
|
|
41
|
+
This loads the agent's persona and capabilities into the session. If you decide you need Quick Flow instead, invoke the **Quick Flow Solo Dev** agent skill in a fresh chat:
|
|
42
42
|
|
|
43
43
|
```text
|
|
44
|
-
|
|
44
|
+
bmad-quick-flow-solo-dev
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Once the Solo Dev agent is loaded, describe your change and ask it to create a **quick-spec**. The agent drafts a lightweight spec capturing what you want to change and how. After you approve the quick-spec, tell the agent to start the **Quick Flow dev cycle** -- it will implement the change, run tests, and perform a self-review, all guided by the spec you just approved.
|
|
@@ -5,7 +5,7 @@ sidebar:
|
|
|
5
5
|
order: 8
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
Use the `shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
|
8
|
+
Use the `bmad-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
|
9
9
|
|
|
10
10
|
:::caution[Deprecated]
|
|
11
11
|
This is no longer recommended, and soon with updated workflows and most major LLMs and tools supporting subprocesses this will be unnecessary.
|
|
@@ -33,12 +33,15 @@ When v4 is detected, you can:
|
|
|
33
33
|
|
|
34
34
|
If you named your bmad method folder something else - you will need to manually remove the folder yourself.
|
|
35
35
|
|
|
36
|
-
### 3. Clean Up IDE
|
|
36
|
+
### 3. Clean Up IDE Skills
|
|
37
37
|
|
|
38
|
-
Manually remove legacy v4 IDE commands - for example if you have
|
|
38
|
+
Manually remove legacy v4 IDE commands/skills - for example if you have Claude Code, look for any nested folders that start with bmad and remove them:
|
|
39
39
|
|
|
40
|
-
- `.claude/commands
|
|
41
|
-
|
|
40
|
+
- `.claude/commands/`
|
|
41
|
+
|
|
42
|
+
The new v6 skills are installed to:
|
|
43
|
+
|
|
44
|
+
- `.claude/skills/`
|
|
42
45
|
|
|
43
46
|
### 4. Migrate Planning Artifacts
|
|
44
47
|
|
|
@@ -58,7 +61,7 @@ If you have stories created or implemented:
|
|
|
58
61
|
|
|
59
62
|
1. Complete the v6 installation
|
|
60
63
|
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
|
|
61
|
-
3. Run the Scrum Master's `sprint-planning` workflow
|
|
64
|
+
3. Run the Scrum Master's `bmad-sprint-planning` workflow
|
|
62
65
|
4. Tell the SM which epics/stories are already complete
|
|
63
66
|
|
|
64
67
|
## What You Get
|
package/docs/index.md
CHANGED
|
@@ -19,7 +19,7 @@ The fastest way to understand BMad is to try it.
|
|
|
19
19
|
- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
|
|
20
20
|
|
|
21
21
|
:::tip[Just Want to Dive In?]
|
|
22
|
-
Install BMad and
|
|
22
|
+
Install BMad and use the `bmad-help` skill — it will guide you through everything based on your project and installed modules.
|
|
23
23
|
:::
|
|
24
24
|
|
|
25
25
|
## How to Use These Docs
|
package/docs/reference/agents.md
CHANGED
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Agents
|
|
3
|
-
description: Default BMM agents with their menu triggers and primary workflows
|
|
3
|
+
description: Default BMM agents with their skill IDs, menu triggers, and primary workflows
|
|
4
4
|
sidebar:
|
|
5
5
|
order: 2
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Default Agents
|
|
9
9
|
|
|
10
|
-
This page lists the default BMM (Agile suite) agents that install with BMad Method, along with their menu triggers and primary workflows.
|
|
10
|
+
This page lists the default BMM (Agile suite) agents that install with BMad Method, along with their skill IDs, menu triggers, and primary workflows. Each agent is invoked as a skill.
|
|
11
11
|
|
|
12
12
|
## Notes
|
|
13
13
|
|
|
14
|
+
- Each agent is available as a skill, generated by the installer. The skill ID (e.g., `bmad-dev`) is used to invoke the agent.
|
|
14
15
|
- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu.
|
|
15
|
-
- Slash commands are generated separately. See [Commands](./commands.md) for the slash command list and where they are defined.
|
|
16
16
|
- QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.
|
|
17
17
|
|
|
18
|
-
| Agent | Triggers | Primary workflows |
|
|
19
|
-
| --------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
-
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
|
21
|
-
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
|
22
|
-
| Architect (Winston) | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
|
23
|
-
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
|
24
|
-
| Developer (Amelia) | `DS`, `CR` | Dev Story, Code Review |
|
|
25
|
-
| QA Engineer (Quinn) | `QA` | Automate (generate tests for existing features) |
|
|
26
|
-
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
|
27
|
-
| UX Designer (Sally) | `CU` | Create UX Design |
|
|
28
|
-
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
|
18
|
+
| Agent | Skill ID | Triggers | Primary workflows |
|
|
19
|
+
| --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
|
21
|
+
| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
|
22
|
+
| Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
|
23
|
+
| Scrum Master (Bob) | `bmad-sm` | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
|
24
|
+
| Developer (Amelia) | `bmad-dev` | `DS`, `CR` | Dev Story, Code Review |
|
|
25
|
+
| QA Engineer (Quinn) | `bmad-qa` | `QA` | Automate (generate tests for existing features) |
|
|
26
|
+
| Quick Flow Solo Dev (Barry) | `bmad-master` | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
|
27
|
+
| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Create UX Design |
|
|
28
|
+
| Technical Writer (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
|
@@ -1,111 +1,113 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description: Reference for BMad
|
|
2
|
+
title: Skills
|
|
3
|
+
description: Reference for BMad skills — what they are, how they work, and where to find them.
|
|
4
4
|
sidebar:
|
|
5
5
|
order: 3
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Skills are pre-built prompts that load agents, run workflows, or execute tasks inside your IDE. The BMad installer generates them from your installed modules at install time. If you later add, remove, or change modules, re-run the installer to keep skills in sync (see [Troubleshooting](#troubleshooting)).
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Skills vs. Agent Menu Triggers
|
|
11
11
|
|
|
12
12
|
BMad offers two ways to start work, and they serve different purposes.
|
|
13
13
|
|
|
14
14
|
| Mechanism | How you invoke it | What happens |
|
|
15
15
|
| --- | --- | --- |
|
|
16
|
-
| **
|
|
16
|
+
| **Skill** | Type the skill name (e.g. `bmad-help`) in your IDE | Directly loads an agent, runs a workflow, or executes a task |
|
|
17
17
|
| **Agent menu trigger** | Load an agent first, then type a short code (e.g. `DS`) | The agent interprets the code and starts the matching workflow while staying in character |
|
|
18
18
|
|
|
19
|
-
Agent menu triggers require an active agent session. Use
|
|
19
|
+
Agent menu triggers require an active agent session. Use skills when you know which workflow you want. Use triggers when you are already working with an agent and want to switch tasks without leaving the conversation.
|
|
20
20
|
|
|
21
|
-
## How
|
|
21
|
+
## How Skills Are Generated
|
|
22
22
|
|
|
23
|
-
When you run `npx bmad-method install`, the installer reads the manifests for every selected module and writes one
|
|
23
|
+
When you run `npx bmad-method install`, the installer reads the manifests for every selected module and writes one skill per agent, workflow, task, and tool. Each skill is a directory containing a `SKILL.md` file that instructs the AI to load the corresponding source file and follow its instructions.
|
|
24
24
|
|
|
25
|
-
The installer uses templates for each
|
|
25
|
+
The installer uses templates for each skill type:
|
|
26
26
|
|
|
27
|
-
|
|
|
27
|
+
| Skill type | What the generated file does |
|
|
28
28
|
| --- | --- |
|
|
29
29
|
| **Agent launcher** | Loads the agent persona file, activates its menu, and stays in character |
|
|
30
|
-
| **Workflow
|
|
31
|
-
| **Task
|
|
32
|
-
| **Tool
|
|
30
|
+
| **Workflow skill** | Loads the workflow config and follows its steps |
|
|
31
|
+
| **Task skill** | Loads a standalone task file and follows its instructions |
|
|
32
|
+
| **Tool skill** | Loads a standalone tool file and follows its instructions |
|
|
33
33
|
|
|
34
34
|
:::note[Re-running the installer]
|
|
35
|
-
If you add or remove modules, run the installer again. It regenerates all
|
|
35
|
+
If you add or remove modules, run the installer again. It regenerates all skill files to match your current module selection.
|
|
36
36
|
:::
|
|
37
37
|
|
|
38
|
-
## Where
|
|
38
|
+
## Where Skill Files Live
|
|
39
39
|
|
|
40
|
-
The installer writes
|
|
40
|
+
The installer writes skill files into an IDE-specific directory inside your project. The exact path depends on which IDE you selected during installation.
|
|
41
41
|
|
|
42
|
-
| IDE / CLI |
|
|
42
|
+
| IDE / CLI | Skills directory |
|
|
43
43
|
| --- | --- |
|
|
44
|
-
| Claude Code | `.claude/
|
|
45
|
-
| Cursor | `.cursor/
|
|
46
|
-
| Windsurf | `.windsurf/
|
|
44
|
+
| Claude Code | `.claude/skills/` |
|
|
45
|
+
| Cursor | `.cursor/skills/` |
|
|
46
|
+
| Windsurf | `.windsurf/skills/` |
|
|
47
47
|
| Other IDEs | See the installer output for the target path |
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
Each skill is a directory containing a `SKILL.md` file. For example, a Claude Code installation looks like:
|
|
50
50
|
|
|
51
51
|
```text
|
|
52
|
-
.claude/
|
|
53
|
-
├── bmad-
|
|
54
|
-
|
|
55
|
-
├── bmad-
|
|
56
|
-
|
|
57
|
-
├── bmad-
|
|
52
|
+
.claude/skills/
|
|
53
|
+
├── bmad-help/
|
|
54
|
+
│ └── SKILL.md
|
|
55
|
+
├── bmad-create-prd/
|
|
56
|
+
│ └── SKILL.md
|
|
57
|
+
├── bmad-dev/
|
|
58
|
+
│ └── SKILL.md
|
|
58
59
|
└── ...
|
|
59
60
|
```
|
|
60
61
|
|
|
61
|
-
The
|
|
62
|
+
The directory name determines the skill name in your IDE. For example, the directory `bmad-dev/` registers the skill `bmad-dev`.
|
|
62
63
|
|
|
63
|
-
## How to Discover Your
|
|
64
|
+
## How to Discover Your Skills
|
|
64
65
|
|
|
65
|
-
Type
|
|
66
|
+
Type the skill name in your IDE to invoke it. Some platforms require you to enable skills in settings before they appear.
|
|
66
67
|
|
|
67
|
-
Run
|
|
68
|
+
Run `bmad-help` for context-aware guidance on your next step.
|
|
68
69
|
|
|
69
70
|
:::tip[Quick discovery]
|
|
70
|
-
The generated
|
|
71
|
+
The generated skill directories in your project are the canonical list. Open them in your file explorer to see every skill with its description.
|
|
71
72
|
:::
|
|
72
73
|
|
|
73
|
-
##
|
|
74
|
+
## Skill Categories
|
|
74
75
|
|
|
75
|
-
### Agent
|
|
76
|
+
### Agent Skills
|
|
76
77
|
|
|
77
|
-
Agent
|
|
78
|
+
Agent skills load a specialized AI persona with a defined role, communication style, and menu of workflows. Once loaded, the agent stays in character and responds to menu triggers.
|
|
78
79
|
|
|
79
|
-
| Example
|
|
80
|
+
| Example skill | Agent | Role |
|
|
80
81
|
| --- | --- | --- |
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
82
|
+
| `bmad-dev` | Amelia (Developer) | Implements stories with strict adherence to specs |
|
|
83
|
+
| `bmad-pm` | John (Product Manager) | Creates and validates PRDs |
|
|
84
|
+
| `bmad-architect` | Winston (Architect) | Designs system architecture |
|
|
85
|
+
| `bmad-sm` | Bob (Scrum Master) | Manages sprints and stories |
|
|
85
86
|
|
|
86
87
|
See [Agents](./agents.md) for the full list of default agents and their triggers.
|
|
87
88
|
|
|
88
|
-
### Workflow
|
|
89
|
+
### Workflow Skills
|
|
89
90
|
|
|
90
|
-
Workflow
|
|
91
|
+
Workflow skills run a structured, multi-step process without loading an agent persona first. They load a workflow configuration and follow its steps.
|
|
91
92
|
|
|
92
|
-
| Example
|
|
93
|
+
| Example skill | Purpose |
|
|
93
94
|
| --- | --- |
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
|
95
|
+
| `bmad-create-prd` | Create a Product Requirements Document |
|
|
96
|
+
| `bmad-create-architecture` | Design system architecture |
|
|
97
|
+
| `bmad-create-epics-and-stories` | Create epics and stories |
|
|
98
|
+
| `bmad-dev-story` | Implement a story |
|
|
99
|
+
| `bmad-code-review` | Run a code review |
|
|
100
|
+
| `bmad-quick-spec` | Define an ad-hoc change (Quick Flow) |
|
|
99
101
|
|
|
100
102
|
See [Workflow Map](./workflow-map.md) for the complete workflow reference organized by phase.
|
|
101
103
|
|
|
102
|
-
### Task and Tool
|
|
104
|
+
### Task and Tool Skills
|
|
103
105
|
|
|
104
106
|
Tasks and tools are standalone operations that do not require an agent or workflow context.
|
|
105
107
|
|
|
106
108
|
#### BMad-Help: Your Intelligent Guide
|
|
107
109
|
|
|
108
|
-
|
|
110
|
+
**`bmad-help`** is your primary interface for discovering what to do next. It's not just a lookup tool — it's an intelligent assistant that:
|
|
109
111
|
|
|
110
112
|
- **Inspects your project** to see what's already been done
|
|
111
113
|
- **Understands natural language queries** — ask questions in plain English
|
|
@@ -116,36 +118,28 @@ Tasks and tools are standalone operations that do not require an agent or workfl
|
|
|
116
118
|
**Examples:**
|
|
117
119
|
|
|
118
120
|
```
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
121
|
+
bmad-help
|
|
122
|
+
bmad-help I have a SaaS idea and know all the features. Where do I start?
|
|
123
|
+
bmad-help What are my options for UX design?
|
|
124
|
+
bmad-help I'm stuck on the PRD workflow
|
|
123
125
|
```
|
|
124
126
|
|
|
125
127
|
#### Other Tasks and Tools
|
|
126
128
|
|
|
127
|
-
| Example
|
|
129
|
+
| Example skill | Purpose |
|
|
128
130
|
| --- | --- |
|
|
129
|
-
|
|
|
130
|
-
|
|
|
131
|
-
|
|
|
131
|
+
| `bmad-shard-doc` | Split a large markdown file into smaller sections |
|
|
132
|
+
| `bmad-index-docs` | Index project documentation |
|
|
133
|
+
| `bmad-editorial-review-prose` | Review document prose quality |
|
|
132
134
|
|
|
133
135
|
## Naming Convention
|
|
134
136
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
| Pattern | Meaning | Example |
|
|
138
|
-
| --- | --- | --- |
|
|
139
|
-
| `bmad-agent-<module>-<name>` | Agent launcher | `bmad-agent-bmm-dev` |
|
|
140
|
-
| `bmad-<module>-<workflow>` | Workflow command | `bmad-bmm-create-prd` |
|
|
141
|
-
| `bmad-<name>` | Core task or tool | `bmad-help` |
|
|
142
|
-
|
|
143
|
-
Module codes: `bmm` (Agile suite), `bmb` (Builder), `tea` (Test Architect), `cis` (Creative Intelligence), `gds` (Game Dev Studio). See [Modules](./modules.md) for descriptions.
|
|
137
|
+
All skills use the `bmad-` prefix followed by a descriptive name (e.g., `bmad-dev`, `bmad-create-prd`, `bmad-help`). See [Modules](./modules.md) for available modules.
|
|
144
138
|
|
|
145
139
|
## Troubleshooting
|
|
146
140
|
|
|
147
|
-
**
|
|
141
|
+
**Skills not appearing after install.** Some platforms require skills to be explicitly enabled in settings. Check your IDE's documentation or ask your AI assistant how to enable skills. You may also need to restart your IDE or reload the window.
|
|
148
142
|
|
|
149
|
-
**Expected
|
|
143
|
+
**Expected skills are missing.** The installer only generates skills for modules you selected. Run `npx bmad-method install` again and verify your module selection. Check that the skill files exist in the expected directory.
|
|
150
144
|
|
|
151
|
-
**
|
|
145
|
+
**Skills from a removed module still appear.** The installer does not delete old skill files automatically. Remove the stale directories from your IDE's skills directory, or delete the entire skills directory and re-run the installer for a clean set.
|
|
@@ -26,7 +26,7 @@ Most projects should start with Quinn. If you later need test strategy, quality
|
|
|
26
26
|
|
|
27
27
|
Quinn is the built-in QA agent in the BMM (Agile suite) module. It generates working tests quickly using your project's existing test framework -- no configuration or additional installation required.
|
|
28
28
|
|
|
29
|
-
**Trigger:** `QA` or `bmad-
|
|
29
|
+
**Trigger:** `QA` or `bmad-qa-generate-e2e-tests`
|
|
30
30
|
|
|
31
31
|
### What Quinn Does
|
|
32
32
|
|