bmad-method 6.0.0-alpha.19 → 6.0.0-alpha.20
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/.github/workflows/docs.yaml +72 -0
- package/.github/workflows/quality.yaml +0 -3
- package/CHANGELOG.md +125 -0
- package/CONTRIBUTING.md +1 -3
- package/README.md +8 -7
- package/docs/agent-customization-guide.md +3 -3
- package/docs/custom-content-installation.md +1 -1
- package/docs/document-sharding-guide.md +2 -2
- package/docs/getting-started/installation.md +76 -0
- package/docs/ide-info/index.md +24 -0
- package/docs/ide-info/rovo-dev.md +14 -380
- package/docs/index.md +36 -45
- package/eslint.config.mjs +7 -2
- package/package.json +14 -8
- package/{docs → samples}/sample-custom-modules/README.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +2 -2
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md +1 -1
- package/src/core/tasks/review-adversarial-general.xml +41 -0
- package/src/modules/bmb/README.md +25 -0
- package/src/modules/bmb/docs/agents/expert-agent-architecture.md +3 -3
- package/src/modules/bmb/docs/agents/index.md +9 -9
- package/src/modules/bmb/docs/agents/simple-agent-architecture.md +1 -1
- package/src/modules/bmb/docs/agents/understanding-agent-types.md +1 -1
- package/src/modules/bmb/docs/{README.md → index.md} +10 -12
- package/src/modules/bmb/docs/workflows/index.md +6 -6
- package/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md +7 -7
- package/src/modules/bmb/docs/workflows/templates/step-1b-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/step-template.md +7 -7
- package/src/modules/bmb/docs/workflows/templates/workflow-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/workflow.md +1 -1
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md +3 -3
- package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +1 -1
- package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +5 -5
- package/src/modules/bmb/workflows/create-module/templates/agent.template.md +1 -1
- package/src/modules/bmb/workflows/create-module/validation.md +2 -2
- package/src/modules/bmb/workflows/create-module/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +2 -2
- package/src/modules/bmb/workflows/create-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-agent/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +1 -1
- package/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +1 -1
- package/src/modules/bmb/workflows-legacy/edit-module/checklist.md +1 -1
- package/src/modules/bmb/workflows-legacy/edit-module/instructions.md +3 -3
- package/src/modules/bmb/workflows-legacy/module-brief/instructions.md +2 -2
- package/src/modules/bmgd/_module-installer/installer.js +2 -2
- package/src/modules/bmgd/agents/game-architect.agent.yaml +4 -0
- package/src/modules/bmgd/docs/{README.md → index.md} +2 -2
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +4 -4
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/instructions.md +4 -4
- package/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +4 -4
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md +1 -1
- package/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +5 -5
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md +60 -6
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/project-context-template.md +20 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md +201 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md +373 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md +279 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md +48 -0
- package/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/4-production/correct-course/checklist.md +1 -1
- package/src/modules/bmgd/workflows/4-production/correct-course/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +4 -4
- package/src/modules/bmgd/workflows/4-production/retrospective/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +5 -5
- package/src/modules/bmgd/workflows/4-production/sprint-planning/instructions.md +11 -2
- package/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml +4 -4
- package/src/modules/bmgd/workflows/4-production/sprint-status/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md +3 -3
- package/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/workflow-status/init/instructions.md +2 -2
- package/src/modules/bmgd/workflows/workflow-status/init/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/workflow-status/instructions.md +2 -2
- package/src/modules/bmm/README.md +5 -6
- package/src/modules/bmm/_module-installer/installer.js +2 -2
- package/src/modules/bmm/agents/analyst.agent.yaml +1 -1
- package/src/modules/bmm/agents/dev.agent.yaml +8 -4
- package/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +8 -17
- package/src/modules/bmm/agents/sm.agent.yaml +6 -3
- package/src/modules/bmm/agents/tech-writer.agent.yaml +1 -1
- package/src/modules/bmm/agents/ux-designer.agent.yaml +6 -3
- package/src/modules/bmm/docs/agents-guide.md +83 -1026
- package/src/modules/bmm/docs/bmad-quick-flow.md +10 -32
- package/src/modules/bmm/docs/brownfield-guide.md +1 -1
- package/src/modules/bmm/docs/enterprise-agentic-development.md +1 -1
- package/src/modules/bmm/docs/{README.md → index.md} +7 -88
- package/src/modules/bmm/docs/quick-spec-flow.md +1 -1
- package/src/modules/bmm/docs/quick-start.md +7 -7
- package/src/modules/bmm/docs/scale-adaptive-system.md +1 -1
- package/src/modules/bmm/docs/test-architecture.md +13 -12
- package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
- package/src/modules/bmm/module.yaml +11 -10
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +7 -5
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +2 -4
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +7 -10
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/workflow.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/research/research.template.md +14 -0
- package/src/modules/bmm/workflows/1-analysis/research/workflow.md +8 -39
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +15 -15
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +5 -25
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +6 -6
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +3 -5
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +0 -1
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +9 -21
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +8 -8
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +4 -4
- package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
- package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +16 -14
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +2 -12
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +4 -4
- package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +1 -1
- package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +3 -3
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +7 -6
- package/src/modules/bmm/workflows/4-implementation/sprint-status/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +4 -3
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md +4 -4
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +4 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +51 -0
- package/src/modules/bmm/workflows/document-project/instructions.md +27 -28
- package/src/modules/bmm/workflows/document-project/workflow.yaml +2 -3
- package/src/modules/bmm/workflows/generate-project-context/project-context-template.md +2 -1
- package/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md +5 -15
- package/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
- package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +8 -7
- package/src/modules/bmm/workflows/testarch/atdd/checklist.md +1 -0
- package/src/modules/bmm/workflows/testarch/atdd/instructions.md +1 -0
- package/src/modules/bmm/workflows/testarch/automate/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/ci/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/ci/instructions.md +2 -0
- package/src/modules/bmm/workflows/testarch/nfr-assess/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +2 -0
- package/src/modules/bmm/workflows/testarch/test-design/checklist.md +3 -2
- package/src/modules/bmm/workflows/testarch/test-design/instructions.md +1 -1
- package/src/modules/bmm/workflows/testarch/test-design/test-design-template.md +9 -0
- package/src/modules/bmm/workflows/testarch/test-review/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/test-review/test-review-template.md +2 -0
- package/src/modules/bmm/workflows/testarch/trace/checklist.md +1 -0
- package/src/modules/bmm/workflows/testarch/trace/instructions.md +2 -0
- package/src/modules/bmm/workflows/testarch/trace/trace-template.md +2 -0
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/workflow-status/instructions.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -1
- package/src/modules/cis/{readme.md → docs/index.md} +2 -6
- package/src/modules/cis/workflows/design-thinking/instructions.md +2 -2
- package/src/modules/cis/workflows/innovation-strategy/instructions.md +2 -2
- package/src/modules/cis/workflows/problem-solving/instructions.md +2 -2
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-wrong-shortcut.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +30 -0
- package/tools/build-docs.js +630 -0
- package/tools/cli/commands/install.js +11 -5
- package/tools/cli/installers/install-messages.yaml +52 -0
- package/tools/cli/installers/lib/core/config-collector.js +25 -30
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/lib/ui.js +221 -41
- package/tools/schema/agent.js +68 -5
- package/website/css/custom.css +52 -0
- package/website/docusaurus.config.js +179 -0
- package/website/sidebars.js +157 -0
- package/website/src/pages/downloads.md +81 -0
- package/website/src/pages/index.js +50 -0
- package/website/static/favicon.ico +0 -0
- package/website/static/img/logo.svg +4 -0
- package/website/static/robots.txt +37 -0
- package/docs/installers-bundlers/ide-injections.md +0 -186
- package/docs/installers-bundlers/installers-modules-platforms-reference.md +0 -389
- package/src/modules/bmgd/README.md +0 -209
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/checklist.md +0 -25
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/instructions.md +0 -202
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml +0 -33
- package/tools/cli/commands/build.js +0 -283
- package/tools/cli/commands/list.js +0 -40
- package/tools/cli/commands/status.js +0 -47
- package/tools/cli/commands/uninstall.js +0 -44
- package/tools/cli/commands/update.js +0 -28
- package/tools/validate-bundles.js +0 -87
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/instructions.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/bundlers.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/deploy.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/tests.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/memories.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/module.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/templates/csv-headers.template +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/wassup/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/foo.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/addition1.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/insights.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/instructions.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/memories.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/patterns.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/module.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/daily-checkin/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/daily-checkin/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/guided-meditation/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/guided-meditation/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/wellness-journal/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/wellness-journal/workflow.md +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Edit Module - Module Editor Instructions
|
|
2
2
|
|
|
3
|
-
<critical>The workflow execution engine is governed by: {project-root}
|
|
4
|
-
<critical>You MUST have already loaded and processed: {project-root}
|
|
3
|
+
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
4
|
+
<critical>You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/edit-module/workflow.yaml</critical>
|
|
5
5
|
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
|
6
6
|
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
|
7
7
|
<critical>Communicate all responses in {communication_language}</critical>
|
|
@@ -186,7 +186,7 @@ Let the conversation flow naturally. Build a shared vision of what "better" look
|
|
|
186
186
|
**If setting up cross-module integration:**
|
|
187
187
|
|
|
188
188
|
- Identify which workflows from other modules are needed
|
|
189
|
-
- Show how to reference workflows properly: {project-root}
|
|
189
|
+
- Show how to reference workflows properly: {project-root}/_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml
|
|
190
190
|
- Document the integration in README
|
|
191
191
|
- Ensure dependencies are clear
|
|
192
192
|
- Consider adding example usage
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Module Brief Instructions
|
|
2
2
|
|
|
3
|
-
<critical>The workflow execution engine is governed by: {project-root}
|
|
4
|
-
<critical>You MUST have already loaded and processed: {project-root}
|
|
3
|
+
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
4
|
+
<critical>You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/module-brief/workflow.yaml</critical>
|
|
5
5
|
<critical>Communicate in {communication_language} throughout the module brief creation process</critical>
|
|
6
6
|
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
|
|
7
7
|
|
|
@@ -46,8 +46,8 @@ async function install(options) {
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
// Create implementation artifacts directory (sprint status, stories, reviews)
|
|
49
|
-
// Check both implementation_artifacts and
|
|
50
|
-
const implConfig = config['implementation_artifacts'] || config['
|
|
49
|
+
// Check both implementation_artifacts and implementation_artifacts for compatibility
|
|
50
|
+
const implConfig = config['implementation_artifacts'] || config['implementation_artifacts'];
|
|
51
51
|
if (implConfig && typeof implConfig === 'string') {
|
|
52
52
|
// Strip project-root prefix variations
|
|
53
53
|
const implConfigClean = implConfig.replace(/^\{project-root\}\/?/, '');
|
|
@@ -33,6 +33,10 @@ agent:
|
|
|
33
33
|
exec: "{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture/workflow.md"
|
|
34
34
|
description: Produce a Scale Adaptive Game Architecture
|
|
35
35
|
|
|
36
|
+
- trigger: generate-project-context
|
|
37
|
+
exec: "{project-root}/_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md"
|
|
38
|
+
description: Create optimized project-context.md for AI agent consistency
|
|
39
|
+
|
|
36
40
|
- trigger: correct-course
|
|
37
41
|
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
|
38
42
|
description: Course Correction Analysis (when implementation is off-track)
|
|
@@ -163,8 +163,8 @@ BMGD Documentation
|
|
|
163
163
|
|
|
164
164
|
### Related Documentation
|
|
165
165
|
|
|
166
|
-
- **[BMM Documentation](../../bmm/docs/
|
|
167
|
-
- **[IDE
|
|
166
|
+
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
|
167
|
+
- **[IDE Guides](../../ide-info/)** - Configure your development environment
|
|
168
168
|
|
|
169
169
|
---
|
|
170
170
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<critical>The workflow execution engine is governed by: {project_root}
|
|
1
|
+
<critical>The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml</critical>
|
|
2
2
|
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
|
3
3
|
<critical>Communicate all responses in {communication_language}</critical>
|
|
4
4
|
<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques</critical>
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
<workflow>
|
|
9
9
|
|
|
10
10
|
<step n="1" goal="Validate workflow readiness" tag="workflow-status">
|
|
11
|
-
<action>Check if {output_folder}/
|
|
11
|
+
<action>Check if {output_folder}/bmgd-workflow-status.yaml exists</action>
|
|
12
12
|
|
|
13
13
|
<check if="status file not found">
|
|
14
14
|
<output>No workflow status file found. Game brainstorming is optional - you can continue without status tracking.</output>
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</check>
|
|
17
17
|
|
|
18
18
|
<check if="status file found">
|
|
19
|
-
<action>Load the FULL file: {output_folder}/
|
|
19
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
20
20
|
<action>Parse workflow_status section</action>
|
|
21
21
|
<action>Check status of "brainstorm-game" workflow</action>
|
|
22
22
|
<action>Get project_level from YAML metadata</action>
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
|
|
86
86
|
<step n="4" goal="Update status and complete" tag="workflow-status">
|
|
87
87
|
<check if="standalone_mode != true">
|
|
88
|
-
<action>Load the FULL file: {output_folder}/
|
|
88
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
89
89
|
<action>Find workflow_status key "brainstorm-game"</action>
|
|
90
90
|
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
|
|
91
91
|
<action>Update workflow_status["brainstorm-game"] = "{output_folder}/bmm-brainstorming-session-{{date}}.md"</action>
|
|
@@ -58,7 +58,7 @@ Validate workflow readiness, check for workflow status tracking, and prepare for
|
|
|
58
58
|
|
|
59
59
|
**Search for workflow status file:**
|
|
60
60
|
|
|
61
|
-
Check if `{output_folder}/
|
|
61
|
+
Check if `{output_folder}/bmgd-workflow-status.yaml` exists.
|
|
62
62
|
|
|
63
63
|
**If status file NOT found:**
|
|
64
64
|
|
package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md
CHANGED
|
@@ -123,7 +123,7 @@ Or type 'all' to see the complete document."
|
|
|
123
123
|
|
|
124
124
|
**If not in standalone mode:**
|
|
125
125
|
|
|
126
|
-
Load `{output_folder}/
|
|
126
|
+
Load `{output_folder}/bmgd-workflow-status.yaml` and:
|
|
127
127
|
|
|
128
128
|
- Update `brainstorm-game` status to the output file path
|
|
129
129
|
- Preserve all comments and structure
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Game Brief - Interactive Workflow Instructions
|
|
2
2
|
|
|
3
|
-
<critical>The workflow execution engine is governed by: {project-root}
|
|
3
|
+
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
4
4
|
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
|
5
5
|
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
|
6
6
|
<critical>Generate all documents in {document_output_language}</critical>
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<workflow>
|
|
13
13
|
|
|
14
14
|
<step n="0" goal="Validate workflow readiness" tag="workflow-status">
|
|
15
|
-
<action>Check if {output_folder}/
|
|
15
|
+
<action>Check if {output_folder}/bmgd-workflow-status.yaml exists</action>
|
|
16
16
|
|
|
17
17
|
<check if="status file not found">
|
|
18
18
|
<output>No workflow status file found. Game brief is optional - you can continue without status tracking.</output>
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
</check>
|
|
21
21
|
|
|
22
22
|
<check if="status file found">
|
|
23
|
-
<action>Load the FULL file: {output_folder}/
|
|
23
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
24
24
|
<action>Parse workflow_status section</action>
|
|
25
25
|
<action>Check status of "game-brief" workflow</action>
|
|
26
26
|
<action>Get project_level from YAML metadata</action>
|
|
@@ -328,7 +328,7 @@ This brief will serve as the primary input for creating the Game Design Document
|
|
|
328
328
|
|
|
329
329
|
<step n="16" goal="Update status and complete" tag="workflow-status">
|
|
330
330
|
<check if="standalone_mode != true">
|
|
331
|
-
<action>Load the FULL file: {output_folder}/
|
|
331
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
332
332
|
<action>Find workflow_status key "game-brief"</action>
|
|
333
333
|
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
|
|
334
334
|
<action>Update workflow_status["game-brief"] = "{output_folder}/bmm-game-brief-{{game_name}}-{{date}}.md"</action>
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<workflow>
|
|
4
4
|
|
|
5
|
-
<critical>The workflow execution engine is governed by: {project_root}
|
|
5
|
+
<critical>The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml</critical>
|
|
6
6
|
<critical>You MUST have already completed the GDD workflow</critical>
|
|
7
7
|
<critical>Communicate all responses in {communication_language}</critical>
|
|
8
8
|
<critical>This workflow creates detailed narrative content for story-driven games</critical>
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<critical>⚠️ CHECKPOINT PROTOCOL: After EVERY <template-output> tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints.</critical>
|
|
13
13
|
|
|
14
14
|
<step n="0" goal="Check for workflow status" tag="workflow-status">
|
|
15
|
-
<action>Check if {output_folder}/
|
|
15
|
+
<action>Check if {output_folder}/bmgd-workflow-status.yaml exists</action>
|
|
16
16
|
|
|
17
17
|
<check if="status file not found">
|
|
18
18
|
<output>No workflow status file found. Narrative workflow is optional - you can continue without status tracking.</output>
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
</check>
|
|
21
21
|
|
|
22
22
|
<check if="status file found">
|
|
23
|
-
<action>Load the FULL file: {output_folder}/
|
|
23
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
24
24
|
<action>Parse workflow_status section</action>
|
|
25
25
|
<action>Check status of "narrative" workflow</action>
|
|
26
26
|
<action>Get project_level from YAML metadata</action>
|
|
@@ -558,7 +558,7 @@ Which would you like?</ask>
|
|
|
558
558
|
<step n="17" goal="Update status if tracking enabled" tag="workflow-status">
|
|
559
559
|
|
|
560
560
|
<check if="standalone_mode != true">
|
|
561
|
-
<action>Load the FULL file: {output_folder}/
|
|
561
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
562
562
|
<action>Find workflow_status key "narrative"</action>
|
|
563
563
|
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
|
|
564
564
|
<action>Update workflow_status["narrative"] = "{output_folder}/bmm-narrative-{{game_name}}-{{date}}.md"</action>
|
|
@@ -160,7 +160,7 @@ narrativeComplexity: '{{complexity}}'
|
|
|
160
160
|
|
|
161
161
|
**If not in standalone mode:**
|
|
162
162
|
|
|
163
|
-
Load `{output_folder}/
|
|
163
|
+
Load `{output_folder}/bmgd-workflow-status.yaml` and:
|
|
164
164
|
|
|
165
165
|
- Update `narrative` status to the output file path
|
|
166
166
|
- Preserve all comments and structure
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<workflow name="architecture">
|
|
4
4
|
|
|
5
|
-
<critical>The workflow execution engine is governed by: {project-root}
|
|
5
|
+
<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
|
|
6
6
|
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
|
7
7
|
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level}</critical>
|
|
8
8
|
<critical>The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs</critical>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<critical>⚠️ CHECKPOINT PROTOCOL: After EVERY <template-output> tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints.</critical>
|
|
16
16
|
|
|
17
17
|
<step n="0" goal="Validate workflow readiness" tag="workflow-status">
|
|
18
|
-
<action>Check if {output_folder}/
|
|
18
|
+
<action>Check if {output_folder}/bmgd-workflow-status.yaml exists</action>
|
|
19
19
|
|
|
20
20
|
<check if="status file not found">
|
|
21
21
|
<output>No workflow status file found. Decision Architecture can run standalone or as part of BMM workflow path.</output>
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
</check>
|
|
31
31
|
|
|
32
32
|
<check if="status file found">
|
|
33
|
-
<action>Load the FULL file: {output_folder}/
|
|
33
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
34
34
|
<action>Parse workflow_status section</action>
|
|
35
35
|
<action>Check status of "create-architecture" workflow</action>
|
|
36
36
|
<action>Get project_level from YAML metadata</action>
|
|
@@ -74,7 +74,7 @@ For Level {{project_level}}, we'll keep the architecture appropriately scoped.
|
|
|
74
74
|
|
|
75
75
|
Decision Architecture works from your Product Requirements Document (PRD).
|
|
76
76
|
|
|
77
|
-
Looking for:
|
|
77
|
+
Looking for: `*prd*.md`, or `prd/index.md` + files in {output_folder}
|
|
78
78
|
|
|
79
79
|
Please run the PRD workflow first to define your requirements.
|
|
80
80
|
|
|
@@ -662,7 +662,7 @@ Enforcement: "All agents MUST follow this pattern"
|
|
|
662
662
|
<action>Save document to {output_folder}/architecture.md</action>
|
|
663
663
|
|
|
664
664
|
<check if="standalone_mode != true">
|
|
665
|
-
<action>Load the FULL file: {output_folder}/
|
|
665
|
+
<action>Load the FULL file: {output_folder}/bmgd-workflow-status.yaml</action>
|
|
666
666
|
<action>Find workflow_status key "create-architecture"</action>
|
|
667
667
|
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
|
|
668
668
|
<action>Update workflow_status["create-architecture"] = "{output_folder}/bmm-architecture-{{date}}.md"</action>
|
|
@@ -12,6 +12,7 @@ outputFile: '{output_folder}/game-architecture.md'
|
|
|
12
12
|
|
|
13
13
|
# Handoff References
|
|
14
14
|
epicWorkflow: '{project-root}/_bmad/bmgd/workflows/4-production/epic-workflow/workflow.yaml'
|
|
15
|
+
projectContextWorkflow: '{project-root}/_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md'
|
|
15
16
|
---
|
|
16
17
|
|
|
17
18
|
# Step 9: Completion
|
|
@@ -131,7 +132,17 @@ platform: '{{platform}}'
|
|
|
131
132
|
---
|
|
132
133
|
````
|
|
133
134
|
|
|
134
|
-
### 4.
|
|
135
|
+
### 4. Update Workflow Status
|
|
136
|
+
|
|
137
|
+
**If not in standalone mode:**
|
|
138
|
+
|
|
139
|
+
Load `{output_folder}/bmgd-workflow-status.yaml` and:
|
|
140
|
+
|
|
141
|
+
- Update `create-architecture` status to the output file path
|
|
142
|
+
- Preserve all comments and structure
|
|
143
|
+
- Determine next workflow in sequence
|
|
144
|
+
|
|
145
|
+
### 5. Present Completion Summary
|
|
135
146
|
|
|
136
147
|
"**Architecture Complete!**
|
|
137
148
|
|
|
@@ -158,9 +169,50 @@ platform: '{{platform}}'
|
|
|
158
169
|
|
|
159
170
|
**Document saved to:** `{outputFile}`
|
|
160
171
|
|
|
161
|
-
Do you want to review or adjust anything before we finalize?
|
|
172
|
+
Do you want to review or adjust anything before we finalize?
|
|
173
|
+
|
|
174
|
+
**Optional Enhancement: Project Context File**
|
|
175
|
+
|
|
176
|
+
Would you like to create a `project-context.md` file? This is a concise, optimized guide for AI agents that captures:
|
|
177
|
+
|
|
178
|
+
- Critical engine-specific rules they might miss
|
|
179
|
+
- Specific patterns and conventions for your game project
|
|
180
|
+
- Performance and optimization requirements
|
|
181
|
+
- Anti-patterns and edge cases to avoid
|
|
182
|
+
|
|
183
|
+
{if_existing_project_context}
|
|
184
|
+
I noticed you already have a project context file. Would you like to update it with your new architectural decisions?
|
|
185
|
+
{else}
|
|
186
|
+
This file helps ensure AI agents implement game code consistently with your project's unique requirements and patterns.
|
|
187
|
+
{/if_existing_project_context}
|
|
188
|
+
|
|
189
|
+
**Create/Update project context?** [Y/N]"
|
|
190
|
+
|
|
191
|
+
### 6. Handle Project Context Creation Choice
|
|
192
|
+
|
|
193
|
+
If user responds 'Y' or 'yes' to creating/updating project context:
|
|
194
|
+
|
|
195
|
+
"Excellent choice! Let me launch the Generate Project Context workflow to create a comprehensive guide for AI agents.
|
|
196
|
+
|
|
197
|
+
This will help ensure consistent implementation by capturing:
|
|
198
|
+
|
|
199
|
+
- Engine-specific patterns and rules
|
|
200
|
+
- Performance and optimization conventions from your architecture
|
|
201
|
+
- Testing and quality standards
|
|
202
|
+
- Anti-patterns to avoid
|
|
203
|
+
|
|
204
|
+
The workflow will collaborate with you to create an optimized `project-context.md` file that AI agents will read before implementing any game code."
|
|
205
|
+
|
|
206
|
+
**Execute the Generate Project Context workflow:**
|
|
207
|
+
|
|
208
|
+
- Load and execute: `{projectContextWorkflow}`
|
|
209
|
+
- The workflow will handle discovery, generation, and completion of the project context file
|
|
210
|
+
- After completion, return here for final handoff
|
|
211
|
+
|
|
212
|
+
If user responds 'N' or 'no':
|
|
213
|
+
"Understood! Your architecture is complete and ready for implementation. You can always create a project context file later using the Generate Project Context workflow if needed."
|
|
162
214
|
|
|
163
|
-
###
|
|
215
|
+
### 7. Handle Review Requests
|
|
164
216
|
|
|
165
217
|
**If user wants to review:**
|
|
166
218
|
|
|
@@ -179,7 +231,7 @@ Or type 'all' to see the complete document."
|
|
|
179
231
|
|
|
180
232
|
**Show requested section and allow edits.**
|
|
181
233
|
|
|
182
|
-
###
|
|
234
|
+
### 8. Present Next Steps Menu
|
|
183
235
|
|
|
184
236
|
**After user confirms completion:**
|
|
185
237
|
|
|
@@ -204,7 +256,7 @@ Or type 'all' to see the complete document."
|
|
|
204
256
|
2. Proceed to Epic creation workflow
|
|
205
257
|
3. Exit workflow"
|
|
206
258
|
|
|
207
|
-
###
|
|
259
|
+
### 9. Handle User Selection
|
|
208
260
|
|
|
209
261
|
Based on user choice:
|
|
210
262
|
|
|
@@ -224,7 +276,7 @@ Based on user choice:
|
|
|
224
276
|
- Confirm document is saved and complete
|
|
225
277
|
- Exit workflow gracefully
|
|
226
278
|
|
|
227
|
-
###
|
|
279
|
+
### 10. Provide Handoff Guidance
|
|
228
280
|
|
|
229
281
|
**For Epic Creation handoff:**
|
|
230
282
|
|
|
@@ -270,6 +322,7 @@ This is the final step. Ensure:
|
|
|
270
322
|
- Development setup is complete
|
|
271
323
|
- Document status updated to 'complete'
|
|
272
324
|
- Frontmatter shows all steps completed
|
|
325
|
+
- Workflow status updated (if tracking)
|
|
273
326
|
- User has clear next steps
|
|
274
327
|
- Document saved and ready for AI agent consumption
|
|
275
328
|
|
|
@@ -278,6 +331,7 @@ This is the final step. Ensure:
|
|
|
278
331
|
- Missing executive summary
|
|
279
332
|
- Incomplete development setup
|
|
280
333
|
- Frontmatter not updated
|
|
334
|
+
- Status not updated when tracking
|
|
281
335
|
- No clear next steps provided
|
|
282
336
|
- User left without actionable guidance
|
|
283
337
|
|
package/src/modules/bmgd/workflows/3-technical/generate-project-context/project-context-template.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
project_name: '{{project_name}}'
|
|
3
|
+
user_name: '{{user_name}}'
|
|
4
|
+
date: '{{date}}'
|
|
5
|
+
sections_completed: []
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Project Context for AI Agents
|
|
9
|
+
|
|
10
|
+
_This file contains critical rules and patterns that AI agents must follow when implementing game code in this project. Focus on unobvious details that agents might otherwise miss._
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Technology Stack & Versions
|
|
15
|
+
|
|
16
|
+
_Documented after discovery phase_
|
|
17
|
+
|
|
18
|
+
## Critical Implementation Rules
|
|
19
|
+
|
|
20
|
+
_Documented after discovery phase_
|
package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
# Step 1: Context Discovery & Initialization
|
|
2
|
+
|
|
3
|
+
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
|
+
|
|
5
|
+
- NEVER generate content without user input
|
|
6
|
+
- ALWAYS treat this as collaborative discovery between technical peers
|
|
7
|
+
- YOU ARE A FACILITATOR, not a content generator
|
|
8
|
+
- FOCUS on discovering existing project context and technology stack
|
|
9
|
+
- IDENTIFY critical implementation rules that AI agents need
|
|
10
|
+
- ABSOLUTELY NO TIME ESTIMATES
|
|
11
|
+
|
|
12
|
+
## EXECUTION PROTOCOLS:
|
|
13
|
+
|
|
14
|
+
- Show your analysis before taking any action
|
|
15
|
+
- Read existing project files to understand current context
|
|
16
|
+
- Initialize document and update frontmatter
|
|
17
|
+
- FORBIDDEN to load next step until discovery is complete
|
|
18
|
+
|
|
19
|
+
## CONTEXT BOUNDARIES:
|
|
20
|
+
|
|
21
|
+
- Variables from workflow.md are available in memory
|
|
22
|
+
- Focus on existing project files and architecture decisions
|
|
23
|
+
- Look for patterns, conventions, and unique requirements
|
|
24
|
+
- Prioritize rules that prevent implementation mistakes
|
|
25
|
+
|
|
26
|
+
## YOUR TASK:
|
|
27
|
+
|
|
28
|
+
Discover the project's game engine, technology stack, existing patterns, and critical implementation rules that AI agents must follow when writing game code.
|
|
29
|
+
|
|
30
|
+
## DISCOVERY SEQUENCE:
|
|
31
|
+
|
|
32
|
+
### 1. Check for Existing Project Context
|
|
33
|
+
|
|
34
|
+
First, check if project context already exists:
|
|
35
|
+
|
|
36
|
+
- Look for file at `{output_folder}/project-context.md`
|
|
37
|
+
- If exists: Read complete file to understand existing rules
|
|
38
|
+
- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?"
|
|
39
|
+
|
|
40
|
+
### 2. Discover Game Engine & Technology Stack
|
|
41
|
+
|
|
42
|
+
Load and analyze project files to identify technologies:
|
|
43
|
+
|
|
44
|
+
**Architecture Document:**
|
|
45
|
+
|
|
46
|
+
- Look for `{output_folder}/game-architecture.md` or `{output_folder}/architecture.md`
|
|
47
|
+
- Extract engine choice with specific version (Unity, Unreal, Godot, custom)
|
|
48
|
+
- Note architectural decisions that affect implementation
|
|
49
|
+
|
|
50
|
+
**Engine-Specific Files:**
|
|
51
|
+
|
|
52
|
+
- Unity: Check for `ProjectSettings/ProjectVersion.txt`, `Packages/manifest.json`
|
|
53
|
+
- Unreal: Check for `.uproject` files, `Config/DefaultEngine.ini`
|
|
54
|
+
- Godot: Check for `project.godot`, `export_presets.cfg`
|
|
55
|
+
- Custom: Check for engine config files, build scripts
|
|
56
|
+
|
|
57
|
+
**Package/Dependency Files:**
|
|
58
|
+
|
|
59
|
+
- Unity: `Packages/manifest.json`, NuGet packages
|
|
60
|
+
- Unreal: `.Build.cs` files, plugin configs
|
|
61
|
+
- Godot: `addons/` directory, GDExtension configs
|
|
62
|
+
- Web-based: `package.json`, `requirements.txt`
|
|
63
|
+
|
|
64
|
+
**Configuration Files:**
|
|
65
|
+
|
|
66
|
+
- Build tool configs
|
|
67
|
+
- Linting and formatting configs
|
|
68
|
+
- Testing configurations
|
|
69
|
+
- CI/CD pipeline configs
|
|
70
|
+
|
|
71
|
+
### 3. Identify Existing Code Patterns
|
|
72
|
+
|
|
73
|
+
Search through existing codebase for patterns:
|
|
74
|
+
|
|
75
|
+
**Naming Conventions:**
|
|
76
|
+
|
|
77
|
+
- Script/class naming patterns
|
|
78
|
+
- Asset naming conventions
|
|
79
|
+
- Scene/level naming patterns
|
|
80
|
+
- Test file naming patterns
|
|
81
|
+
|
|
82
|
+
**Code Organization:**
|
|
83
|
+
|
|
84
|
+
- How components/scripts are structured
|
|
85
|
+
- Where utilities and helpers are placed
|
|
86
|
+
- How systems are organized
|
|
87
|
+
- Folder hierarchy patterns
|
|
88
|
+
|
|
89
|
+
**Engine-Specific Patterns:**
|
|
90
|
+
|
|
91
|
+
- Unity: MonoBehaviour patterns, ScriptableObject usage, serialization rules
|
|
92
|
+
- Unreal: Actor/Component patterns, Blueprint integration, UE macros
|
|
93
|
+
- Godot: Node patterns, signal usage, autoload patterns
|
|
94
|
+
|
|
95
|
+
### 4. Extract Critical Implementation Rules
|
|
96
|
+
|
|
97
|
+
Look for rules that AI agents might miss:
|
|
98
|
+
|
|
99
|
+
**Engine-Specific Rules:**
|
|
100
|
+
|
|
101
|
+
- Unity: Assembly definitions, Unity lifecycle methods, coroutine patterns
|
|
102
|
+
- Unreal: UPROPERTY/UFUNCTION usage, garbage collection rules, tick patterns
|
|
103
|
+
- Godot: `_ready` vs `_enter_tree`, node ownership, scene instancing
|
|
104
|
+
|
|
105
|
+
**Performance Rules:**
|
|
106
|
+
|
|
107
|
+
- Frame budget constraints
|
|
108
|
+
- Memory allocation patterns
|
|
109
|
+
- Hot path optimization requirements
|
|
110
|
+
- Object pooling patterns
|
|
111
|
+
|
|
112
|
+
**Platform-Specific Rules:**
|
|
113
|
+
|
|
114
|
+
- Target platform constraints
|
|
115
|
+
- Input handling conventions
|
|
116
|
+
- Platform-specific code patterns
|
|
117
|
+
- Build configuration rules
|
|
118
|
+
|
|
119
|
+
**Testing Rules:**
|
|
120
|
+
|
|
121
|
+
- Test structure requirements
|
|
122
|
+
- Mock usage conventions
|
|
123
|
+
- Integration vs unit test boundaries
|
|
124
|
+
- Play mode vs edit mode testing
|
|
125
|
+
|
|
126
|
+
### 5. Initialize Project Context Document
|
|
127
|
+
|
|
128
|
+
Based on discovery, create or update the context document:
|
|
129
|
+
|
|
130
|
+
#### A. Fresh Document Setup (if no existing context)
|
|
131
|
+
|
|
132
|
+
Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project-context.md`
|
|
133
|
+
Initialize frontmatter with:
|
|
134
|
+
|
|
135
|
+
```yaml
|
|
136
|
+
---
|
|
137
|
+
project_name: '{{project_name}}'
|
|
138
|
+
user_name: '{{user_name}}'
|
|
139
|
+
date: '{{date}}'
|
|
140
|
+
sections_completed: ['technology_stack']
|
|
141
|
+
existing_patterns_found: { { number_of_patterns_discovered } }
|
|
142
|
+
---
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
#### B. Existing Document Update
|
|
146
|
+
|
|
147
|
+
Load existing context and prepare for updates
|
|
148
|
+
Set frontmatter `sections_completed` to track what will be updated
|
|
149
|
+
|
|
150
|
+
### 6. Present Discovery Summary
|
|
151
|
+
|
|
152
|
+
Report findings to user:
|
|
153
|
+
|
|
154
|
+
"Welcome {{user_name}}! I've analyzed your game project for {{project_name}} to discover the context that AI agents need.
|
|
155
|
+
|
|
156
|
+
**Game Engine & Stack Discovered:**
|
|
157
|
+
{{engine_and_version}}
|
|
158
|
+
{{list_of_technologies_with_versions}}
|
|
159
|
+
|
|
160
|
+
**Existing Patterns Found:**
|
|
161
|
+
|
|
162
|
+
- {{number_of_patterns}} implementation patterns
|
|
163
|
+
- {{number_of_conventions}} coding conventions
|
|
164
|
+
- {{number_of_rules}} critical rules
|
|
165
|
+
|
|
166
|
+
**Key Areas for Context Rules:**
|
|
167
|
+
|
|
168
|
+
- {{area_1}} (e.g., Engine lifecycle and patterns)
|
|
169
|
+
- {{area_2}} (e.g., Performance and optimization)
|
|
170
|
+
- {{area_3}} (e.g., Platform-specific requirements)
|
|
171
|
+
|
|
172
|
+
{if_existing_context}
|
|
173
|
+
**Existing Context:** Found {{sections}} sections already defined. We can update or add to these.
|
|
174
|
+
{/if_existing_context}
|
|
175
|
+
|
|
176
|
+
Ready to create/update your project context. This will help AI agents implement game code consistently with your project's standards.
|
|
177
|
+
|
|
178
|
+
[C] Continue to context generation"
|
|
179
|
+
|
|
180
|
+
## SUCCESS METRICS:
|
|
181
|
+
|
|
182
|
+
- Existing project context properly detected and handled
|
|
183
|
+
- Game engine and technology stack accurately identified with versions
|
|
184
|
+
- Critical implementation patterns discovered
|
|
185
|
+
- Project context document properly initialized
|
|
186
|
+
- Discovery findings clearly presented to user
|
|
187
|
+
- User ready to proceed with context generation
|
|
188
|
+
|
|
189
|
+
## FAILURE MODES:
|
|
190
|
+
|
|
191
|
+
- Not checking for existing project context before creating new one
|
|
192
|
+
- Missing critical engine versions or configurations
|
|
193
|
+
- Overlooking important coding patterns or conventions
|
|
194
|
+
- Not initializing frontmatter properly
|
|
195
|
+
- Not presenting clear discovery summary to user
|
|
196
|
+
|
|
197
|
+
## NEXT STEP:
|
|
198
|
+
|
|
199
|
+
After user selects [C] to continue, load `./step-02-generate.md` to collaboratively generate the specific project context rules.
|
|
200
|
+
|
|
201
|
+
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and discovery is confirmed!
|