@zeyue0329/xiaoma-cli 1.0.8 → 1.0.9
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/CHANGELOG.md +686 -0
- package/LICENSE +6 -1
- package/README.md +173 -460
- package/common/tasks/create-doc.md +3 -1
- package/common/tasks/execute-checklist.md +2 -7
- package/common/utils/bmad-doc-template.md +7 -5
- package/common/utils/workflow-management.md +2 -0
- package/dist/agents/analyst.txt +1143 -1118
- package/dist/agents/architect.txt +1555 -1531
- package/dist/agents/dev.txt +170 -22
- package/dist/agents/pm.txt +1103 -1106
- package/dist/agents/po.txt +329 -334
- package/dist/agents/qa.txt +1773 -154
- package/dist/agents/sm.txt +101 -102
- package/dist/agents/ux-expert.txt +93 -91
- package/dist/agents/xiaoma-master.txt +745 -673
- package/dist/agents/xiaoma-orchestrator.txt +107 -77
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2386 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +1627 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +822 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +11008 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4031 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +3717 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +456 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +982 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +15450 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/beta-reader.txt +921 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/book-critic.txt +81 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/character-psychologist.txt +886 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/cover-designer.txt +85 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/dialog-specialist.txt +903 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/editor.txt +837 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/genre-specialist.txt +989 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/narrative-designer.txt +888 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/plot-architect.txt +1173 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/world-builder.txt +914 -0
- package/dist/expansion-packs/bmad-creative-writing/teams/agent-team.txt +6511 -0
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2087 -0
- package/dist/teams/team-all.txt +5710 -3857
- package/dist/teams/team-fullstack.txt +3242 -3157
- package/dist/teams/team-ide-minimal.txt +2330 -534
- package/dist/teams/team-no-ui.txt +2935 -2857
- package/docs/GUIDING-PRINCIPLES.md +91 -0
- package/docs/core-architecture.md +219 -0
- package/docs/enhanced-ide-development-workflow.md +248 -0
- package/docs/expansion-packs.md +200 -0
- package/docs/how-to-contribute-with-pull-requests.md +158 -0
- package/docs/user-guide.md +530 -0
- package/docs/versioning-and-releases.md +155 -0
- package/docs/versions.md +48 -0
- package/docs/working-in-the-brownfield.md +597 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +14 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +73 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +80 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +66 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +203 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +162 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +9 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +252 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +649 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +112 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +218 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +292 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +614 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +357 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +344 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +254 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +485 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +184 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +176 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +15 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +82 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +79 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +80 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +67 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +393 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +205 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +203 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +126 -0
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +7 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +771 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +588 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +112 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +143 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +186 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +292 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +202 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +1031 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +357 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +706 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +257 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +485 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +184 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +176 -0
- package/expansion-packs/bmad-creative-writing/README.md +146 -0
- package/expansion-packs/bmad-creative-writing/agent-teams/agent-team.yaml +20 -0
- package/expansion-packs/bmad-creative-writing/agents/beta-reader.md +94 -0
- package/expansion-packs/bmad-creative-writing/agents/book-critic.md +40 -0
- package/expansion-packs/bmad-creative-writing/agents/character-psychologist.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/cover-designer.md +46 -0
- package/expansion-packs/bmad-creative-writing/agents/dialog-specialist.md +92 -0
- package/expansion-packs/bmad-creative-writing/agents/editor.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/genre-specialist.md +95 -0
- package/expansion-packs/bmad-creative-writing/agents/narrative-designer.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/plot-architect.md +95 -0
- package/expansion-packs/bmad-creative-writing/agents/world-builder.md +94 -0
- package/expansion-packs/bmad-creative-writing/checklists/beta-feedback-closure-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/character-consistency-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/comedic-timing-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/cyberpunk-aesthetic-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/ebook-formatting-checklist.md +21 -0
- package/expansion-packs/bmad-creative-writing/checklists/epic-poetry-meter-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/fantasy-magic-system-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/foreshadowing-payoff-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/genre-tropes-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/historical-accuracy-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/horror-suspense-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/kdp-cover-ready-checklist.md +25 -0
- package/expansion-packs/bmad-creative-writing/checklists/line-edit-quality-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/marketing-copy-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/mystery-clue-trail-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/orbital-mechanics-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/plot-structure-checklist.md +59 -0
- package/expansion-packs/bmad-creative-writing/checklists/publication-readiness-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/romance-emotional-beats-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/scene-quality-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/scifi-technology-plausibility-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/sensitivity-representation-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/steampunk-gadget-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/thriller-pacing-stakes-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/timeline-continuity-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/world-building-continuity-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/ya-appropriateness-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/config.yaml +12 -0
- package/expansion-packs/bmad-creative-writing/data/bmad-kb.md +209 -0
- package/expansion-packs/bmad-creative-writing/data/story-structures.md +67 -0
- package/expansion-packs/bmad-creative-writing/docs/brief.md +212 -0
- package/expansion-packs/bmad-creative-writing/tasks/advanced-elicitation.md +119 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-reader-feedback.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-story-structure.md +67 -0
- package/expansion-packs/bmad-creative-writing/tasks/assemble-kdp-package.md +29 -0
- package/expansion-packs/bmad-creative-writing/tasks/brainstorm-premise.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/build-world.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/character-depth-pass.md +22 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-doc.md +103 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-draft-section.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/critical-review.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/develop-character.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/execute-checklist.md +88 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-premise.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-synopsis.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/final-polish.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-brief.md +25 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-prompts.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-scene-list.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/incorporate-feedback.md +25 -0
- package/expansion-packs/bmad-creative-writing/tasks/outline-scenes.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/provide-feedback.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/publish-chapter.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/quick-feedback.md +22 -0
- package/expansion-packs/bmad-creative-writing/tasks/select-next-arc.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/workshop-dialog.md +64 -0
- package/expansion-packs/bmad-creative-writing/templates/beta-feedback-form.yaml +97 -0
- package/expansion-packs/bmad-creative-writing/templates/chapter-draft-tmpl.yaml +82 -0
- package/expansion-packs/bmad-creative-writing/templates/character-profile-tmpl.yaml +92 -0
- package/expansion-packs/bmad-creative-writing/templates/cover-design-brief-tmpl.yaml +98 -0
- package/expansion-packs/bmad-creative-writing/templates/premise-brief-tmpl.yaml +78 -0
- package/expansion-packs/bmad-creative-writing/templates/scene-list-tmpl.yaml +55 -0
- package/expansion-packs/bmad-creative-writing/templates/story-outline-tmpl.yaml +96 -0
- package/expansion-packs/bmad-creative-writing/templates/world-guide-tmpl.yaml +89 -0
- package/expansion-packs/bmad-creative-writing/workflows/book-cover-design-workflow.md +218 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-greenfield-workflow.yaml +56 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-serial-workflow.yaml +50 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-snowflake-workflow.yaml +69 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-writing.yaml +91 -0
- package/expansion-packs/bmad-creative-writing/workflows/screenplay-development.yaml +85 -0
- package/expansion-packs/bmad-creative-writing/workflows/series-planning.yaml +78 -0
- package/expansion-packs/bmad-creative-writing/workflows/short-story-creation.yaml +64 -0
- package/expansion-packs/bmad-infrastructure-devops/README.md +147 -0
- package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +73 -0
- package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +486 -0
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +10 -0
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +307 -0
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +161 -0
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +155 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +425 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +630 -0
- package/implement-fork-friendly-ci.sh +229 -0
- package/package.json +75 -45
- package/prettier.config.mjs +32 -0
- package/test.md +1 -0
- package/tools/builders/web-builder.js +128 -129
- package/tools/bump-all-versions.js +42 -33
- package/tools/bump-expansion-version.js +23 -16
- package/tools/cli.js +15 -15
- package/tools/flattener/aggregate.js +76 -0
- package/tools/flattener/binary.js +80 -0
- package/tools/flattener/discovery.js +71 -0
- package/tools/flattener/files.js +35 -0
- package/tools/flattener/ignoreRules.js +176 -0
- package/tools/flattener/main.js +458 -460
- package/tools/flattener/projectRoot.js +206 -0
- package/tools/flattener/prompts.js +44 -0
- package/tools/flattener/stats.helpers.js +395 -0
- package/tools/flattener/stats.js +80 -0
- package/tools/flattener/test-matrix.js +413 -0
- package/tools/flattener/xml.js +88 -0
- package/tools/installer/README.md +1 -1
- package/tools/installer/bin/xiaoma.js +377 -137
- package/tools/installer/config/ide-agent-config.yaml +3 -3
- package/tools/installer/config/install.config.yaml +73 -22
- package/tools/installer/lib/config-loader.js +48 -44
- package/tools/installer/lib/file-manager.js +91 -116
- package/tools/installer/lib/ide-base-setup.js +57 -56
- package/tools/installer/lib/ide-setup.js +816 -407
- package/tools/installer/lib/installer.js +915 -690
- package/tools/installer/lib/memory-profiler.js +54 -53
- package/tools/installer/lib/module-manager.js +19 -15
- package/tools/installer/lib/resource-locator.js +26 -28
- package/tools/installer/package-lock.json +67 -56
- package/tools/installer/package.json +24 -23
- package/tools/lib/dependency-resolver.js +30 -34
- package/tools/lib/yaml-utils.js +7 -7
- package/tools/md-assets/web-agent-startup-instructions.md +1 -1
- package/tools/preview-release-notes.js +66 -0
- package/tools/setup-hooks.sh +37 -0
- package/tools/shared/bannerArt.js +105 -0
- package/tools/sync-installer-version.js +7 -9
- package/tools/sync-version.sh +23 -0
- package/tools/update-expansion-version.js +14 -15
- package/tools/upgraders/v3-to-v4-upgrader.js +208 -299
- package/tools/version-bump.js +41 -26
- package/tools/xiaoma-npx-wrapper.js +11 -11
- package/tools/yaml-format.js +56 -43
- package/xiaoma-core/agent-teams/team-all.yaml +2 -1
- package/xiaoma-core/agent-teams/team-fullstack.yaml +1 -0
- package/xiaoma-core/agent-teams/team-ide-minimal.yaml +1 -0
- package/xiaoma-core/agent-teams/team-no-ui.yaml +1 -0
- package/xiaoma-core/agents/analyst.md +20 -17
- package/xiaoma-core/agents/architect.md +15 -14
- package/xiaoma-core/agents/dev.md +23 -18
- package/xiaoma-core/agents/pm.md +18 -15
- package/xiaoma-core/agents/po.md +13 -10
- package/xiaoma-core/agents/qa.md +46 -24
- package/xiaoma-core/agents/sm.md +11 -8
- package/xiaoma-core/agents/ux-expert.md +10 -7
- package/xiaoma-core/agents/xiaoma-master.md +24 -22
- package/xiaoma-core/agents/xiaoma-orchestrator.md +30 -33
- package/xiaoma-core/checklists/architect-checklist.md +2 -5
- package/xiaoma-core/checklists/change-checklist.md +4 -2
- package/xiaoma-core/checklists/pm-checklist.md +2 -5
- package/xiaoma-core/checklists/po-master-checklist.md +2 -9
- package/xiaoma-core/checklists/story-dod-checklist.md +2 -7
- package/xiaoma-core/checklists/story-draft-checklist.md +2 -3
- package/xiaoma-core/core-config.yaml +4 -1
- package/xiaoma-core/data/{xiaoma-kb.md → bmad-kb.md} +43 -37
- package/xiaoma-core/data/brainstorming-techniques.md +2 -0
- package/xiaoma-core/data/elicitation-methods.md +22 -0
- package/xiaoma-core/data/technical-preferences.md +2 -0
- package/xiaoma-core/data/test-levels-framework.md +148 -0
- package/xiaoma-core/data/test-priorities-matrix.md +174 -0
- package/xiaoma-core/tasks/advanced-elicitation.md +2 -0
- package/xiaoma-core/tasks/apply-qa-fixes.md +150 -0
- package/xiaoma-core/tasks/brownfield-create-epic.md +2 -0
- package/xiaoma-core/tasks/brownfield-create-story.md +2 -0
- package/xiaoma-core/tasks/correct-course.md +2 -0
- package/xiaoma-core/tasks/create-brownfield-story.md +14 -4
- package/xiaoma-core/tasks/create-deep-research-prompt.md +2 -11
- package/xiaoma-core/tasks/create-next-story.md +3 -1
- package/xiaoma-core/tasks/document-project.md +17 -13
- package/xiaoma-core/tasks/facilitate-brainstorming-session.md +5 -3
- package/xiaoma-core/tasks/generate-ai-frontend-prompt.md +2 -0
- package/xiaoma-core/tasks/index-docs.md +2 -6
- package/xiaoma-core/tasks/kb-mode-interaction.md +17 -15
- package/xiaoma-core/tasks/nfr-assess.md +345 -0
- package/xiaoma-core/tasks/qa-gate.md +163 -0
- package/xiaoma-core/tasks/review-story.md +245 -74
- package/xiaoma-core/tasks/risk-profile.md +355 -0
- package/xiaoma-core/tasks/shard-doc.md +2 -2
- package/xiaoma-core/tasks/test-design.md +176 -0
- package/xiaoma-core/tasks/trace-requirements.md +266 -0
- package/xiaoma-core/tasks/validate-next-story.md +2 -0
- package/xiaoma-core/templates/architecture-tmpl.yaml +50 -49
- package/xiaoma-core/templates/brainstorming-output-tmpl.yaml +5 -5
- package/xiaoma-core/templates/brownfield-architecture-tmpl.yaml +32 -31
- package/xiaoma-core/templates/brownfield-prd-tmpl.yaml +14 -13
- package/xiaoma-core/templates/competitor-analysis-tmpl.yaml +20 -6
- package/xiaoma-core/templates/front-end-architecture-tmpl.yaml +22 -9
- package/xiaoma-core/templates/front-end-spec-tmpl.yaml +25 -24
- package/xiaoma-core/templates/fullstack-architecture-tmpl.yaml +123 -104
- package/xiaoma-core/templates/market-research-tmpl.yaml +3 -2
- package/xiaoma-core/templates/prd-tmpl.yaml +10 -9
- package/xiaoma-core/templates/project-brief-tmpl.yaml +5 -4
- package/xiaoma-core/templates/qa-gate-tmpl.yaml +103 -0
- package/xiaoma-core/templates/story-tmpl.yaml +13 -12
- package/xiaoma-core/workflows/brownfield-fullstack.yaml +13 -12
- package/xiaoma-core/workflows/brownfield-service.yaml +5 -4
- package/xiaoma-core/workflows/brownfield-ui.yaml +5 -4
- package/xiaoma-core/workflows/greenfield-fullstack.yaml +7 -6
- package/xiaoma-core/workflows/greenfield-service.yaml +5 -4
- package/xiaoma-core/workflows/greenfield-ui.yaml +6 -5
- package/.releaserc.json +0 -18
- package/.vscode/settings.json +0 -44
- package/XiaoMa-Web/345/244/232/346/231/272/350/203/275/344/275/2230-1/351/241/271/347/233/256/345/274/200/345/217/221/345/256/214/346/225/264/346/214/207/345/215/227.md +0 -977
- package/XiaoMa-Web/347/216/260/346/234/211/351/241/271/347/233/256/351/234/200/346/261/202/345/274/200/345/217/221/345/256/214/346/225/264/346/214/207/345/215/227.md +0 -873
- package/XiaoMa-Web/347/272/257/345/211/215/347/253/257/351/241/271/347/233/256Claude-Code/345/274/200/345/217/221/345/256/214/346/225/264/346/214/207/345/215/227.md +0 -372
- package/XiaoMa-Web/351/241/271/347/233/256/346/200/273/347/273/223/346/212/245/345/221/212.md +0 -310
- package/dist/agents/dev-cn.txt +0 -428
- package/docs/quick-start.md +0 -179
- package/tools/bmad-npx-wrapper.js +0 -39
- package/tools/semantic-release-sync-installer.js +0 -30
- package/xiaoma-core/bmad-core/user-guide.md +0 -0
- package/xiaoma-core/enhanced-ide-development-workflow.md +0 -43
- package/xiaoma-core/user-guide.md +0 -251
- package/xiaoma-core/working-in-the-brownfield.md +0 -364
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Web Agent Bundle Instructions
|
|
2
2
|
|
|
3
|
-
You are now operating as a specialized AI agent from the
|
|
3
|
+
You are now operating as a specialized AI agent from the BMad-Method framework. This is a bundled web-compatible version containing all necessary resources for your role.
|
|
4
4
|
|
|
5
5
|
## Important Instructions
|
|
6
6
|
|
|
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
|
|
34
34
|
|
|
35
35
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
|
36
36
|
|
|
37
|
-
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the
|
|
37
|
+
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -50,6 +50,7 @@ activation-instructions:
|
|
|
50
50
|
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
51
51
|
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
52
52
|
- STAY IN CHARACTER!
|
|
53
|
+
- 'CRITICAL: Do NOT scan filesystem or load any resources during startup, ONLY when commanded (Exception: Read xiaoma-core/core-config.yaml during activation)'
|
|
53
54
|
agent:
|
|
54
55
|
name: XiaoMa Master
|
|
55
56
|
id: xiaoma-master
|
|
@@ -58,7 +59,7 @@ agent:
|
|
|
58
59
|
whenToUse: Use when you need comprehensive expertise across all domains, running 1 off tasks that do not require a persona, or just wanting to use the same agent for many things.
|
|
59
60
|
persona:
|
|
60
61
|
role: Master Task Executor & XiaoMa Method Expert
|
|
61
|
-
identity: Universal executor of all XiaoMa-
|
|
62
|
+
identity: Universal executor of all XiaoMa-CLI capabilities, directly runs any resource
|
|
62
63
|
core_principles:
|
|
63
64
|
- Execute any resource directly without persona transformation
|
|
64
65
|
- Load resources at runtime, never pre-load
|
|
@@ -67,27 +68,39 @@ persona:
|
|
|
67
68
|
- Process (*) commands immediately, All commands require * prefix when used (e.g., *help)
|
|
68
69
|
commands:
|
|
69
70
|
- help: Show these listed commands in a numbered list
|
|
70
|
-
- kb: Toggle KB mode off (default) or on, when on will load and reference the .xiaoma-core/data/xiaoma-kb.md and converse with the user answering his questions with this informational resource
|
|
71
|
-
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
|
72
71
|
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
73
72
|
- doc-out: Output full document to current destination file
|
|
74
73
|
- document-project: execute the task document-project.md
|
|
75
74
|
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
|
75
|
+
- kb: Toggle KB mode off (default) or on, when on will load and reference the .xiaoma-core/data/bmad-kb.md and converse with the user answering his questions with this informational resource
|
|
76
76
|
- shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
|
|
77
|
+
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
|
77
78
|
- yolo: Toggle Yolo Mode
|
|
78
79
|
- exit: Exit (confirm)
|
|
79
80
|
dependencies:
|
|
81
|
+
checklists:
|
|
82
|
+
- architect-checklist.md
|
|
83
|
+
- change-checklist.md
|
|
84
|
+
- pm-checklist.md
|
|
85
|
+
- po-master-checklist.md
|
|
86
|
+
- story-dod-checklist.md
|
|
87
|
+
- story-draft-checklist.md
|
|
88
|
+
data:
|
|
89
|
+
- bmad-kb.md
|
|
90
|
+
- brainstorming-techniques.md
|
|
91
|
+
- elicitation-methods.md
|
|
92
|
+
- technical-preferences.md
|
|
80
93
|
tasks:
|
|
81
94
|
- advanced-elicitation.md
|
|
82
|
-
- facilitate-brainstorming-session.md
|
|
83
95
|
- brownfield-create-epic.md
|
|
84
96
|
- brownfield-create-story.md
|
|
85
97
|
- correct-course.md
|
|
86
98
|
- create-deep-research-prompt.md
|
|
87
99
|
- create-doc.md
|
|
88
|
-
- document-project.md
|
|
89
100
|
- create-next-story.md
|
|
101
|
+
- document-project.md
|
|
90
102
|
- execute-checklist.md
|
|
103
|
+
- facilitate-brainstorming-session.md
|
|
91
104
|
- generate-ai-frontend-prompt.md
|
|
92
105
|
- index-docs.md
|
|
93
106
|
- shard-doc.md
|
|
@@ -103,11 +116,6 @@ dependencies:
|
|
|
103
116
|
- prd-tmpl.yaml
|
|
104
117
|
- project-brief-tmpl.yaml
|
|
105
118
|
- story-tmpl.yaml
|
|
106
|
-
data:
|
|
107
|
-
- xiaoma-kb.md
|
|
108
|
-
- brainstorming-techniques.md
|
|
109
|
-
- elicitation-methods.md
|
|
110
|
-
- technical-preferences.md
|
|
111
119
|
workflows:
|
|
112
120
|
- brownfield-fullstack.md
|
|
113
121
|
- brownfield-service.md
|
|
@@ -115,17 +123,12 @@ dependencies:
|
|
|
115
123
|
- greenfield-fullstack.md
|
|
116
124
|
- greenfield-service.md
|
|
117
125
|
- greenfield-ui.md
|
|
118
|
-
checklists:
|
|
119
|
-
- architect-checklist.md
|
|
120
|
-
- change-checklist.md
|
|
121
|
-
- pm-checklist.md
|
|
122
|
-
- po-master-checklist.md
|
|
123
|
-
- story-dod-checklist.md
|
|
124
|
-
- story-draft-checklist.md
|
|
125
126
|
```
|
|
126
127
|
==================== END: .xiaoma-core/agents/xiaoma-master.md ====================
|
|
127
128
|
|
|
128
129
|
==================== START: .xiaoma-core/tasks/advanced-elicitation.md ====================
|
|
130
|
+
<!-- Powered by BMAD™ Core -->
|
|
131
|
+
|
|
129
132
|
# Advanced Elicitation Task
|
|
130
133
|
|
|
131
134
|
## Purpose
|
|
@@ -245,146 +248,9 @@ Choose a number (0-8) or 9 to proceed:
|
|
|
245
248
|
- **Maintain Flow**: Keep the process moving efficiently
|
|
246
249
|
==================== END: .xiaoma-core/tasks/advanced-elicitation.md ====================
|
|
247
250
|
|
|
248
|
-
==================== START: .xiaoma-core/tasks/facilitate-brainstorming-session.md ====================
|
|
249
|
-
---
|
|
250
|
-
docOutputLocation: docs/brainstorming-session-results.md
|
|
251
|
-
template: ".xiaoma-core/templates/brainstorming-output-tmpl.yaml"
|
|
252
|
-
---
|
|
253
|
-
|
|
254
|
-
# Facilitate Brainstorming Session Task
|
|
255
|
-
|
|
256
|
-
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
|
257
|
-
|
|
258
|
-
## Process
|
|
259
|
-
|
|
260
|
-
### Step 1: Session Setup
|
|
261
|
-
|
|
262
|
-
Ask 4 context questions (don't preview what happens next):
|
|
263
|
-
|
|
264
|
-
1. What are we brainstorming about?
|
|
265
|
-
2. Any constraints or parameters?
|
|
266
|
-
3. Goal: broad exploration or focused ideation?
|
|
267
|
-
4. Do you want a structured document output to reference later? (Default Yes)
|
|
268
|
-
|
|
269
|
-
### Step 2: Present Approach Options
|
|
270
|
-
|
|
271
|
-
After getting answers to Step 1, present 4 approach options (numbered):
|
|
272
|
-
|
|
273
|
-
1. User selects specific techniques
|
|
274
|
-
2. Analyst recommends techniques based on context
|
|
275
|
-
3. Random technique selection for creative variety
|
|
276
|
-
4. Progressive technique flow (start broad, narrow down)
|
|
277
|
-
|
|
278
|
-
### Step 3: Execute Techniques Interactively
|
|
279
|
-
|
|
280
|
-
**KEY PRINCIPLES:**
|
|
281
|
-
|
|
282
|
-
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
|
283
|
-
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
|
284
|
-
- **CAPTURE OUTPUT**: If (default) document output requested, capture all ideas generated in each technique section to the document from the beginning.
|
|
285
|
-
|
|
286
|
-
**Technique Selection:**
|
|
287
|
-
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number..
|
|
288
|
-
|
|
289
|
-
**Technique Execution:**
|
|
290
|
-
|
|
291
|
-
1. Apply selected technique according to data file description
|
|
292
|
-
2. Keep engaging with technique until user indicates they want to:
|
|
293
|
-
- Choose a different technique
|
|
294
|
-
- Apply current ideas to a new technique
|
|
295
|
-
- Move to convergent phase
|
|
296
|
-
- End session
|
|
297
|
-
|
|
298
|
-
**Output Capture (if requested):**
|
|
299
|
-
For each technique used, capture:
|
|
300
|
-
|
|
301
|
-
- Technique name and duration
|
|
302
|
-
- Key ideas generated by user
|
|
303
|
-
- Insights and patterns identified
|
|
304
|
-
- User's reflections on the process
|
|
305
|
-
|
|
306
|
-
### Step 4: Session Flow
|
|
307
|
-
|
|
308
|
-
1. **Warm-up** (5-10 min) - Build creative confidence
|
|
309
|
-
2. **Divergent** (20-30 min) - Generate quantity over quality
|
|
310
|
-
3. **Convergent** (15-20 min) - Group and categorize ideas
|
|
311
|
-
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
|
312
|
-
|
|
313
|
-
### Step 5: Document Output (if requested)
|
|
314
|
-
|
|
315
|
-
Generate structured document with these sections:
|
|
316
|
-
|
|
317
|
-
**Executive Summary**
|
|
318
|
-
|
|
319
|
-
- Session topic and goals
|
|
320
|
-
- Techniques used and duration
|
|
321
|
-
- Total ideas generated
|
|
322
|
-
- Key themes and patterns identified
|
|
323
|
-
|
|
324
|
-
**Technique Sections** (for each technique used)
|
|
325
|
-
|
|
326
|
-
- Technique name and description
|
|
327
|
-
- Ideas generated (user's own words)
|
|
328
|
-
- Insights discovered
|
|
329
|
-
- Notable connections or patterns
|
|
330
|
-
|
|
331
|
-
**Idea Categorization**
|
|
332
|
-
|
|
333
|
-
- **Immediate Opportunities** - Ready to implement now
|
|
334
|
-
- **Future Innovations** - Requires development/research
|
|
335
|
-
- **Moonshots** - Ambitious, transformative concepts
|
|
336
|
-
- **Insights & Learnings** - Key realizations from session
|
|
337
|
-
|
|
338
|
-
**Action Planning**
|
|
339
|
-
|
|
340
|
-
- Top 3 priority ideas with rationale
|
|
341
|
-
- Next steps for each priority
|
|
342
|
-
- Resources/research needed
|
|
343
|
-
- Timeline considerations
|
|
344
|
-
|
|
345
|
-
**Reflection & Follow-up**
|
|
346
|
-
|
|
347
|
-
- What worked well in this session
|
|
348
|
-
- Areas for further exploration
|
|
349
|
-
- Recommended follow-up techniques
|
|
350
|
-
- Questions that emerged for future sessions
|
|
351
|
-
|
|
352
|
-
## Key Principles
|
|
353
|
-
|
|
354
|
-
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them (unless they request it persistently)
|
|
355
|
-
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
|
356
|
-
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
|
357
|
-
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
|
358
|
-
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
|
359
|
-
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
|
360
|
-
- Maintain energy and momentum
|
|
361
|
-
- Defer judgment during generation
|
|
362
|
-
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
|
363
|
-
- Build on ideas collaboratively
|
|
364
|
-
- Document everything in output document
|
|
365
|
-
|
|
366
|
-
## Advanced Engagement Strategies
|
|
367
|
-
|
|
368
|
-
**Energy Management**
|
|
369
|
-
|
|
370
|
-
- Check engagement levels: "How are you feeling about this direction?"
|
|
371
|
-
- Offer breaks or technique switches if energy flags
|
|
372
|
-
- Use encouraging language and celebrate idea generation
|
|
373
|
-
|
|
374
|
-
**Depth vs. Breadth**
|
|
375
|
-
|
|
376
|
-
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
|
377
|
-
- Use "Yes, and..." to build on their ideas
|
|
378
|
-
- Help them make connections: "How does this relate to your earlier idea about...?"
|
|
379
|
-
|
|
380
|
-
**Transition Management**
|
|
381
|
-
|
|
382
|
-
- Always ask before switching techniques: "Ready to try a different approach?"
|
|
383
|
-
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
|
384
|
-
- Respect their process and timing
|
|
385
|
-
==================== END: .xiaoma-core/tasks/facilitate-brainstorming-session.md ====================
|
|
386
|
-
|
|
387
251
|
==================== START: .xiaoma-core/tasks/brownfield-create-epic.md ====================
|
|
252
|
+
<!-- Powered by BMAD™ Core -->
|
|
253
|
+
|
|
388
254
|
# Create Brownfield Epic Task
|
|
389
255
|
|
|
390
256
|
## Purpose
|
|
@@ -548,6 +414,8 @@ The epic creation is successful when:
|
|
|
548
414
|
==================== END: .xiaoma-core/tasks/brownfield-create-epic.md ====================
|
|
549
415
|
|
|
550
416
|
==================== START: .xiaoma-core/tasks/brownfield-create-story.md ====================
|
|
417
|
+
<!-- Powered by BMAD™ Core -->
|
|
418
|
+
|
|
551
419
|
# Create Brownfield Story Task
|
|
552
420
|
|
|
553
421
|
## Purpose
|
|
@@ -698,6 +566,8 @@ The story creation is successful when:
|
|
|
698
566
|
==================== END: .xiaoma-core/tasks/brownfield-create-story.md ====================
|
|
699
567
|
|
|
700
568
|
==================== START: .xiaoma-core/tasks/correct-course.md ====================
|
|
569
|
+
<!-- Powered by BMAD™ Core -->
|
|
570
|
+
|
|
701
571
|
# Correct Course Task
|
|
702
572
|
|
|
703
573
|
## Purpose
|
|
@@ -771,6 +641,8 @@ The story creation is successful when:
|
|
|
771
641
|
==================== END: .xiaoma-core/tasks/correct-course.md ====================
|
|
772
642
|
|
|
773
643
|
==================== START: .xiaoma-core/tasks/create-deep-research-prompt.md ====================
|
|
644
|
+
<!-- Powered by BMAD™ Core -->
|
|
645
|
+
|
|
774
646
|
# Create Deep Research Prompt Task
|
|
775
647
|
|
|
776
648
|
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
|
|
@@ -794,63 +666,54 @@ CRITICAL: First, help the user select the most appropriate research focus based
|
|
|
794
666
|
Present these numbered options to the user:
|
|
795
667
|
|
|
796
668
|
1. **Product Validation Research**
|
|
797
|
-
|
|
798
669
|
- Validate product hypotheses and market fit
|
|
799
670
|
- Test assumptions about user needs and solutions
|
|
800
671
|
- Assess technical and business feasibility
|
|
801
672
|
- Identify risks and mitigation strategies
|
|
802
673
|
|
|
803
674
|
2. **Market Opportunity Research**
|
|
804
|
-
|
|
805
675
|
- Analyze market size and growth potential
|
|
806
676
|
- Identify market segments and dynamics
|
|
807
677
|
- Assess market entry strategies
|
|
808
678
|
- Evaluate timing and market readiness
|
|
809
679
|
|
|
810
680
|
3. **User & Customer Research**
|
|
811
|
-
|
|
812
681
|
- Deep dive into user personas and behaviors
|
|
813
682
|
- Understand jobs-to-be-done and pain points
|
|
814
683
|
- Map customer journeys and touchpoints
|
|
815
684
|
- Analyze willingness to pay and value perception
|
|
816
685
|
|
|
817
686
|
4. **Competitive Intelligence Research**
|
|
818
|
-
|
|
819
687
|
- Detailed competitor analysis and positioning
|
|
820
688
|
- Feature and capability comparisons
|
|
821
689
|
- Business model and strategy analysis
|
|
822
690
|
- Identify competitive advantages and gaps
|
|
823
691
|
|
|
824
692
|
5. **Technology & Innovation Research**
|
|
825
|
-
|
|
826
693
|
- Assess technology trends and possibilities
|
|
827
694
|
- Evaluate technical approaches and architectures
|
|
828
695
|
- Identify emerging technologies and disruptions
|
|
829
696
|
- Analyze build vs. buy vs. partner options
|
|
830
697
|
|
|
831
698
|
6. **Industry & Ecosystem Research**
|
|
832
|
-
|
|
833
699
|
- Map industry value chains and dynamics
|
|
834
700
|
- Identify key players and relationships
|
|
835
701
|
- Analyze regulatory and compliance factors
|
|
836
702
|
- Understand partnership opportunities
|
|
837
703
|
|
|
838
704
|
7. **Strategic Options Research**
|
|
839
|
-
|
|
840
705
|
- Evaluate different strategic directions
|
|
841
706
|
- Assess business model alternatives
|
|
842
707
|
- Analyze go-to-market strategies
|
|
843
708
|
- Consider expansion and scaling paths
|
|
844
709
|
|
|
845
710
|
8. **Risk & Feasibility Research**
|
|
846
|
-
|
|
847
711
|
- Identify and assess various risk factors
|
|
848
712
|
- Evaluate implementation challenges
|
|
849
713
|
- Analyze resource requirements
|
|
850
714
|
- Consider regulatory and legal implications
|
|
851
715
|
|
|
852
716
|
9. **Custom Research Focus**
|
|
853
|
-
|
|
854
717
|
- User-defined research objectives
|
|
855
718
|
- Specialized domain investigation
|
|
856
719
|
- Cross-functional research needs
|
|
@@ -1019,13 +882,11 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
|
|
|
1019
882
|
### 5. Review and Refinement
|
|
1020
883
|
|
|
1021
884
|
1. **Present Complete Prompt**
|
|
1022
|
-
|
|
1023
885
|
- Show the full research prompt
|
|
1024
886
|
- Explain key elements and rationale
|
|
1025
887
|
- Highlight any assumptions made
|
|
1026
888
|
|
|
1027
889
|
2. **Gather Feedback**
|
|
1028
|
-
|
|
1029
890
|
- Are the objectives clear and correct?
|
|
1030
891
|
- Do the questions address all concerns?
|
|
1031
892
|
- Is the scope appropriate?
|
|
@@ -1063,6 +924,8 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
|
|
|
1063
924
|
==================== END: .xiaoma-core/tasks/create-deep-research-prompt.md ====================
|
|
1064
925
|
|
|
1065
926
|
==================== START: .xiaoma-core/tasks/create-doc.md ====================
|
|
927
|
+
<!-- Powered by BMAD™ Core -->
|
|
928
|
+
|
|
1066
929
|
# Create Document from Template (YAML Driven)
|
|
1067
930
|
|
|
1068
931
|
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
|
|
@@ -1080,7 +943,7 @@ When this task is invoked:
|
|
|
1080
943
|
|
|
1081
944
|
## Critical: Template Discovery
|
|
1082
945
|
|
|
1083
|
-
If a YAML Template has not been provided, list all templates from .
|
|
946
|
+
If a YAML Template has not been provided, list all templates from .xiaoma-core/templates or ask the user to provide another.
|
|
1084
947
|
|
|
1085
948
|
## CRITICAL: Mandatory Elicitation Format
|
|
1086
949
|
|
|
@@ -1166,65 +1029,184 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
|
1166
1029
|
- End with "Select 1-9 or just type your question/feedback:"
|
|
1167
1030
|
==================== END: .xiaoma-core/tasks/create-doc.md ====================
|
|
1168
1031
|
|
|
1169
|
-
==================== START: .xiaoma-core/tasks/
|
|
1170
|
-
|
|
1032
|
+
==================== START: .xiaoma-core/tasks/create-next-story.md ====================
|
|
1033
|
+
<!-- Powered by BMAD™ Core -->
|
|
1034
|
+
|
|
1035
|
+
# Create Next Story Task
|
|
1171
1036
|
|
|
1172
1037
|
## Purpose
|
|
1173
1038
|
|
|
1174
|
-
|
|
1039
|
+
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research or finding its own context.
|
|
1175
1040
|
|
|
1176
|
-
## Task
|
|
1041
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
1177
1042
|
|
|
1178
|
-
###
|
|
1043
|
+
### 0. Load Core Configuration and Check Workflow
|
|
1179
1044
|
|
|
1180
|
-
|
|
1045
|
+
- Load `.xiaoma-core/core-config.yaml` from the project root
|
|
1046
|
+
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can either: 1) Copy it from GITHUB xiaoma-core/core-config.yaml and configure it for your project OR 2) Run the BMad installer against your project to upgrade and add the file automatically. Please add and configure core-config.yaml before proceeding."
|
|
1047
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
1181
1048
|
|
|
1182
|
-
|
|
1049
|
+
### 1. Identify Next Story for Preparation
|
|
1183
1050
|
|
|
1184
|
-
|
|
1185
|
-
- Identify which modules, services, or areas will be affected
|
|
1186
|
-
- Focus documentation ONLY on these relevant areas
|
|
1187
|
-
- Skip unrelated parts of the codebase to keep docs lean
|
|
1051
|
+
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
1188
1052
|
|
|
1189
|
-
|
|
1190
|
-
|
|
1053
|
+
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
1054
|
+
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
1055
|
+
- **If highest story exists:**
|
|
1056
|
+
- Verify status is 'Done'. If not, alert user: "ALERT: Found incomplete story! File: {lastEpicNum}.{lastStoryNum}.story.md Status: [current status] You should fix this story first, but would you like to accept risk & override to create the next story in draft?"
|
|
1057
|
+
- If proceeding, select next sequential story in the current epic
|
|
1058
|
+
- If epic is complete, prompt user: "Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed. Would you like to: 1) Begin Epic {epicNum + 1} with story 1 2) Select a specific story to work on 3) Cancel story creation"
|
|
1059
|
+
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
1060
|
+
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
1061
|
+
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
1191
1062
|
|
|
1192
|
-
|
|
1063
|
+
### 2. Gather Story Requirements and Previous Story Context
|
|
1193
1064
|
|
|
1194
|
-
|
|
1065
|
+
- Extract story requirements from the identified epic file
|
|
1066
|
+
- If previous story exists, review Dev Agent Record sections for:
|
|
1067
|
+
- Completion Notes and Debug Log References
|
|
1068
|
+
- Implementation deviations and technical decisions
|
|
1069
|
+
- Challenges encountered and lessons learned
|
|
1070
|
+
- Extract relevant insights that inform the current story's preparation
|
|
1195
1071
|
|
|
1196
|
-
|
|
1072
|
+
### 3. Gather Architecture Context
|
|
1197
1073
|
|
|
1198
|
-
3.
|
|
1199
|
-
- 'Adding payment processing to the user service'
|
|
1200
|
-
- 'Refactoring the authentication module'
|
|
1201
|
-
- 'Integrating with a new third-party API'
|
|
1074
|
+
#### 3.1 Determine Architecture Reading Strategy
|
|
1202
1075
|
|
|
1203
|
-
|
|
1076
|
+
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
1077
|
+
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
1204
1078
|
|
|
1205
|
-
|
|
1079
|
+
#### 3.2 Read Architecture Documents Based on Story Type
|
|
1206
1080
|
|
|
1207
|
-
|
|
1081
|
+
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
1208
1082
|
|
|
1209
|
-
|
|
1210
|
-
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
|
1083
|
+
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
1211
1084
|
|
|
1212
|
-
|
|
1085
|
+
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
1213
1086
|
|
|
1214
|
-
|
|
1215
|
-
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
|
1216
|
-
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
|
1217
|
-
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
|
1218
|
-
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
|
1087
|
+
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
1219
1088
|
|
|
1220
|
-
|
|
1089
|
+
#### 3.3 Extract Story-Specific Technical Details
|
|
1221
1090
|
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
-
|
|
1227
|
-
-
|
|
1091
|
+
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
1092
|
+
|
|
1093
|
+
Extract:
|
|
1094
|
+
|
|
1095
|
+
- Specific data models, schemas, or structures the story will use
|
|
1096
|
+
- API endpoints the story must implement or consume
|
|
1097
|
+
- Component specifications for UI elements in the story
|
|
1098
|
+
- File paths and naming conventions for new code
|
|
1099
|
+
- Testing requirements specific to the story's features
|
|
1100
|
+
- Security or performance considerations affecting the story
|
|
1101
|
+
|
|
1102
|
+
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
1103
|
+
|
|
1104
|
+
### 4. Verify Project Structure Alignment
|
|
1105
|
+
|
|
1106
|
+
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
1107
|
+
- Ensure file paths, component locations, or module names align with defined structures
|
|
1108
|
+
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
1109
|
+
|
|
1110
|
+
### 5. Populate Story Template with Full Context
|
|
1111
|
+
|
|
1112
|
+
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
1113
|
+
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
1114
|
+
- **`Dev Notes` section (CRITICAL):**
|
|
1115
|
+
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
1116
|
+
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
1117
|
+
- **Previous Story Insights**: Key learnings from previous story
|
|
1118
|
+
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
1119
|
+
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
1120
|
+
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
1121
|
+
- **File Locations**: Exact paths where new code should be created based on project structure
|
|
1122
|
+
- **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
|
|
1123
|
+
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
1124
|
+
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
1125
|
+
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
1126
|
+
- **`Tasks / Subtasks` section:**
|
|
1127
|
+
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
1128
|
+
- Each task must reference relevant architecture documentation
|
|
1129
|
+
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
1130
|
+
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
1131
|
+
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
1132
|
+
|
|
1133
|
+
### 6. Story Draft Completion and Review
|
|
1134
|
+
|
|
1135
|
+
- Review all sections for completeness and accuracy
|
|
1136
|
+
- Verify all source references are included for technical details
|
|
1137
|
+
- Ensure tasks align with both epic requirements and architecture constraints
|
|
1138
|
+
- Update status to "Draft" and save the story file
|
|
1139
|
+
- Execute `.xiaoma-core/tasks/execute-checklist` `.xiaoma-core/checklists/story-draft-checklist`
|
|
1140
|
+
- Provide summary to user including:
|
|
1141
|
+
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
1142
|
+
- Status: Draft
|
|
1143
|
+
- Key technical components included from architecture docs
|
|
1144
|
+
- Any deviations or conflicts noted between epic and architecture
|
|
1145
|
+
- Checklist Results
|
|
1146
|
+
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.xiaoma-core/tasks/validate-next-story`
|
|
1147
|
+
==================== END: .xiaoma-core/tasks/create-next-story.md ====================
|
|
1148
|
+
|
|
1149
|
+
==================== START: .xiaoma-core/tasks/document-project.md ====================
|
|
1150
|
+
<!-- Powered by BMAD™ Core -->
|
|
1151
|
+
|
|
1152
|
+
# Document an Existing Project
|
|
1153
|
+
|
|
1154
|
+
## Purpose
|
|
1155
|
+
|
|
1156
|
+
Generate comprehensive documentation for existing projects optimized for AI development agents. This task creates structured reference materials that enable AI agents to understand project context, conventions, and patterns for effective contribution to any codebase.
|
|
1157
|
+
|
|
1158
|
+
## Task Instructions
|
|
1159
|
+
|
|
1160
|
+
### 1. Initial Project Analysis
|
|
1161
|
+
|
|
1162
|
+
**CRITICAL:** First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
|
1163
|
+
|
|
1164
|
+
**IF PRD EXISTS**:
|
|
1165
|
+
|
|
1166
|
+
- Review the PRD to understand what enhancement/feature is planned
|
|
1167
|
+
- Identify which modules, services, or areas will be affected
|
|
1168
|
+
- Focus documentation ONLY on these relevant areas
|
|
1169
|
+
- Skip unrelated parts of the codebase to keep docs lean
|
|
1170
|
+
|
|
1171
|
+
**IF NO PRD EXISTS**:
|
|
1172
|
+
Ask the user:
|
|
1173
|
+
|
|
1174
|
+
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
|
1175
|
+
|
|
1176
|
+
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
|
1177
|
+
|
|
1178
|
+
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
|
1179
|
+
|
|
1180
|
+
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
|
1181
|
+
- 'Adding payment processing to the user service'
|
|
1182
|
+
- 'Refactoring the authentication module'
|
|
1183
|
+
- 'Integrating with a new third-party API'
|
|
1184
|
+
|
|
1185
|
+
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
|
1186
|
+
|
|
1187
|
+
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
|
1188
|
+
|
|
1189
|
+
Based on their response:
|
|
1190
|
+
|
|
1191
|
+
- If they choose option 1-3: Use that context to focus documentation
|
|
1192
|
+
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
|
1193
|
+
|
|
1194
|
+
Begin by conducting analysis of the existing project. Use available tools to:
|
|
1195
|
+
|
|
1196
|
+
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
|
1197
|
+
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
|
1198
|
+
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
|
1199
|
+
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
|
1200
|
+
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
|
1201
|
+
|
|
1202
|
+
Ask the user these elicitation questions to better understand their needs:
|
|
1203
|
+
|
|
1204
|
+
- What is the primary purpose of this project?
|
|
1205
|
+
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
|
1206
|
+
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
|
1207
|
+
- Are there any existing documentation standards or formats you prefer?
|
|
1208
|
+
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
1209
|
+
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
1228
1210
|
|
|
1229
1211
|
### 2. Deep Codebase Analysis
|
|
1230
1212
|
|
|
@@ -1280,9 +1262,9 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1280
1262
|
|
|
1281
1263
|
### Change Log
|
|
1282
1264
|
|
|
1283
|
-
| Date
|
|
1284
|
-
|
|
1285
|
-
| [Date] | 1.0
|
|
1265
|
+
| Date | Version | Description | Author |
|
|
1266
|
+
| ------ | ------- | --------------------------- | --------- |
|
|
1267
|
+
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
|
1286
1268
|
|
|
1287
1269
|
## Quick Reference - Key Files and Entry Points
|
|
1288
1270
|
|
|
@@ -1305,11 +1287,11 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1305
1287
|
|
|
1306
1288
|
### Actual Tech Stack (from package.json/requirements.txt)
|
|
1307
1289
|
|
|
1308
|
-
| Category
|
|
1309
|
-
|
|
1310
|
-
| Runtime
|
|
1311
|
-
| Framework | Express
|
|
1312
|
-
| Database
|
|
1290
|
+
| Category | Technology | Version | Notes |
|
|
1291
|
+
| --------- | ---------- | ------- | -------------------------- |
|
|
1292
|
+
| Runtime | Node.js | 16.x | [Any constraints] |
|
|
1293
|
+
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
|
1294
|
+
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
|
1313
1295
|
|
|
1314
1296
|
etc...
|
|
1315
1297
|
|
|
@@ -1348,6 +1330,7 @@ project-root/
|
|
|
1348
1330
|
### Data Models
|
|
1349
1331
|
|
|
1350
1332
|
Instead of duplicating, reference actual model files:
|
|
1333
|
+
|
|
1351
1334
|
- **User Model**: See `src/models/User.js`
|
|
1352
1335
|
- **Order Model**: See `src/models/Order.js`
|
|
1353
1336
|
- **Related Types**: TypeScript definitions in `src/types/`
|
|
@@ -1377,10 +1360,10 @@ Instead of duplicating, reference actual model files:
|
|
|
1377
1360
|
|
|
1378
1361
|
### External Services
|
|
1379
1362
|
|
|
1380
|
-
| Service
|
|
1381
|
-
|
|
1382
|
-
| Stripe
|
|
1383
|
-
| SendGrid | Emails
|
|
1363
|
+
| Service | Purpose | Integration Type | Key Files |
|
|
1364
|
+
| -------- | -------- | ---------------- | ------------------------------ |
|
|
1365
|
+
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
|
1366
|
+
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
|
1384
1367
|
|
|
1385
1368
|
etc...
|
|
1386
1369
|
|
|
@@ -1425,6 +1408,7 @@ npm run test:integration # Runs integration tests (requires local DB)
|
|
|
1425
1408
|
### Files That Will Need Modification
|
|
1426
1409
|
|
|
1427
1410
|
Based on the enhancement requirements, these files will be affected:
|
|
1411
|
+
|
|
1428
1412
|
- `src/services/userService.js` - Add new user fields
|
|
1429
1413
|
- `src/models/User.js` - Update schema
|
|
1430
1414
|
- `src/routes/userRoutes.js` - New endpoints
|
|
@@ -1510,122 +1494,9 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|
|
1510
1494
|
- The goal is PRACTICAL documentation for AI agents doing real work
|
|
1511
1495
|
==================== END: .xiaoma-core/tasks/document-project.md ====================
|
|
1512
1496
|
|
|
1513
|
-
==================== START: .xiaoma-core/tasks/create-next-story.md ====================
|
|
1514
|
-
# Create Next Story Task
|
|
1515
|
-
|
|
1516
|
-
## Purpose
|
|
1517
|
-
|
|
1518
|
-
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research or finding its own context.
|
|
1519
|
-
|
|
1520
|
-
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
1521
|
-
|
|
1522
|
-
### 0. Load Core Configuration and Check Workflow
|
|
1523
|
-
|
|
1524
|
-
- Load `.xiaoma-core/core-config.yaml` from the project root
|
|
1525
|
-
- If the file does not exist, HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can either: 1) Copy it from GITHUB xiaoma-core/core-config.yaml and configure it for your project OR 2) Run the XiaoMa installer against your project to upgrade and add the file automatically. Please add and configure core-config.yaml before proceeding."
|
|
1526
|
-
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
1527
|
-
|
|
1528
|
-
### 1. Identify Next Story for Preparation
|
|
1529
|
-
|
|
1530
|
-
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
1531
|
-
|
|
1532
|
-
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
1533
|
-
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
1534
|
-
- **If highest story exists:**
|
|
1535
|
-
- Verify status is 'Done'. If not, alert user: "ALERT: Found incomplete story! File: {lastEpicNum}.{lastStoryNum}.story.md Status: [current status] You should fix this story first, but would you like to accept risk & override to create the next story in draft?"
|
|
1536
|
-
- If proceeding, select next sequential story in the current epic
|
|
1537
|
-
- If epic is complete, prompt user: "Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed. Would you like to: 1) Begin Epic {epicNum + 1} with story 1 2) Select a specific story to work on 3) Cancel story creation"
|
|
1538
|
-
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
1539
|
-
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
1540
|
-
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
1541
|
-
|
|
1542
|
-
### 2. Gather Story Requirements and Previous Story Context
|
|
1543
|
-
|
|
1544
|
-
- Extract story requirements from the identified epic file
|
|
1545
|
-
- If previous story exists, review Dev Agent Record sections for:
|
|
1546
|
-
- Completion Notes and Debug Log References
|
|
1547
|
-
- Implementation deviations and technical decisions
|
|
1548
|
-
- Challenges encountered and lessons learned
|
|
1549
|
-
- Extract relevant insights that inform the current story's preparation
|
|
1550
|
-
|
|
1551
|
-
### 3. Gather Architecture Context
|
|
1552
|
-
|
|
1553
|
-
#### 3.1 Determine Architecture Reading Strategy
|
|
1554
|
-
|
|
1555
|
-
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
1556
|
-
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
1557
|
-
|
|
1558
|
-
#### 3.2 Read Architecture Documents Based on Story Type
|
|
1559
|
-
|
|
1560
|
-
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
1561
|
-
|
|
1562
|
-
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
1563
|
-
|
|
1564
|
-
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
1565
|
-
|
|
1566
|
-
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
1567
|
-
|
|
1568
|
-
#### 3.3 Extract Story-Specific Technical Details
|
|
1569
|
-
|
|
1570
|
-
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
1571
|
-
|
|
1572
|
-
Extract:
|
|
1573
|
-
|
|
1574
|
-
- Specific data models, schemas, or structures the story will use
|
|
1575
|
-
- API endpoints the story must implement or consume
|
|
1576
|
-
- Component specifications for UI elements in the story
|
|
1577
|
-
- File paths and naming conventions for new code
|
|
1578
|
-
- Testing requirements specific to the story's features
|
|
1579
|
-
- Security or performance considerations affecting the story
|
|
1580
|
-
|
|
1581
|
-
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
1582
|
-
|
|
1583
|
-
### 4. Verify Project Structure Alignment
|
|
1584
|
-
|
|
1585
|
-
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
1586
|
-
- Ensure file paths, component locations, or module names align with defined structures
|
|
1587
|
-
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
1588
|
-
|
|
1589
|
-
### 5. Populate Story Template with Full Context
|
|
1590
|
-
|
|
1591
|
-
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
1592
|
-
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
1593
|
-
- **`Dev Notes` section (CRITICAL):**
|
|
1594
|
-
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
1595
|
-
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
1596
|
-
- **Previous Story Insights**: Key learnings from previous story
|
|
1597
|
-
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
1598
|
-
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
1599
|
-
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
1600
|
-
- **File Locations**: Exact paths where new code should be created based on project structure
|
|
1601
|
-
- **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
|
|
1602
|
-
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
1603
|
-
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
1604
|
-
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
1605
|
-
- **`Tasks / Subtasks` section:**
|
|
1606
|
-
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
1607
|
-
- Each task must reference relevant architecture documentation
|
|
1608
|
-
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
1609
|
-
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
1610
|
-
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
1611
|
-
|
|
1612
|
-
### 6. Story Draft Completion and Review
|
|
1613
|
-
|
|
1614
|
-
- Review all sections for completeness and accuracy
|
|
1615
|
-
- Verify all source references are included for technical details
|
|
1616
|
-
- Ensure tasks align with both epic requirements and architecture constraints
|
|
1617
|
-
- Update status to "Draft" and save the story file
|
|
1618
|
-
- Execute `.xiaoma-core/tasks/execute-checklist` `.xiaoma-core/checklists/story-draft-checklist`
|
|
1619
|
-
- Provide summary to user including:
|
|
1620
|
-
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
1621
|
-
- Status: Draft
|
|
1622
|
-
- Key technical components included from architecture docs
|
|
1623
|
-
- Any deviations or conflicts noted between epic and architecture
|
|
1624
|
-
- Checklist Results
|
|
1625
|
-
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.xiaoma-core/tasks/validate-next-story`
|
|
1626
|
-
==================== END: .xiaoma-core/tasks/create-next-story.md ====================
|
|
1627
|
-
|
|
1628
1497
|
==================== START: .xiaoma-core/tasks/execute-checklist.md ====================
|
|
1498
|
+
<!-- Powered by BMAD™ Core -->
|
|
1499
|
+
|
|
1629
1500
|
# Checklist Validation Task
|
|
1630
1501
|
|
|
1631
1502
|
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
|
@@ -1637,7 +1508,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1637
1508
|
## Instructions
|
|
1638
1509
|
|
|
1639
1510
|
1. **Initial Assessment**
|
|
1640
|
-
|
|
1641
1511
|
- If user or the task being run provides a checklist name:
|
|
1642
1512
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
1643
1513
|
- If multiple matches found, ask user to clarify
|
|
@@ -1650,14 +1520,12 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1650
1520
|
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
1651
1521
|
|
|
1652
1522
|
2. **Document and Artifact Gathering**
|
|
1653
|
-
|
|
1654
1523
|
- Each checklist will specify its required documents/artifacts at the beginning
|
|
1655
1524
|
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
|
|
1656
1525
|
|
|
1657
1526
|
3. **Checklist Processing**
|
|
1658
1527
|
|
|
1659
1528
|
If in interactive mode:
|
|
1660
|
-
|
|
1661
1529
|
- Work through each section of the checklist one at a time
|
|
1662
1530
|
- For each section:
|
|
1663
1531
|
- Review all items in the section following instructions for that section embedded in the checklist
|
|
@@ -1666,7 +1534,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1666
1534
|
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
1667
1535
|
|
|
1668
1536
|
If in YOLO mode:
|
|
1669
|
-
|
|
1670
1537
|
- Process all sections at once
|
|
1671
1538
|
- Create a comprehensive report of all findings
|
|
1672
1539
|
- Present the complete analysis to the user
|
|
@@ -1674,7 +1541,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1674
1541
|
4. **Validation Approach**
|
|
1675
1542
|
|
|
1676
1543
|
For each checklist item:
|
|
1677
|
-
|
|
1678
1544
|
- Read and understand the requirement
|
|
1679
1545
|
- Look for evidence in the documentation that satisfies the requirement
|
|
1680
1546
|
- Consider both explicit mentions and implicit coverage
|
|
@@ -1688,7 +1554,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1688
1554
|
5. **Section Analysis**
|
|
1689
1555
|
|
|
1690
1556
|
For each section:
|
|
1691
|
-
|
|
1692
1557
|
- think step by step to calculate pass rate
|
|
1693
1558
|
- Identify common themes in failed items
|
|
1694
1559
|
- Provide specific recommendations for improvement
|
|
@@ -1698,7 +1563,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1698
1563
|
6. **Final Report**
|
|
1699
1564
|
|
|
1700
1565
|
Prepare a summary that includes:
|
|
1701
|
-
|
|
1702
1566
|
- Overall checklist completion status
|
|
1703
1567
|
- Pass rates by section
|
|
1704
1568
|
- List of failed items with context
|
|
@@ -1721,7 +1585,150 @@ The LLM will:
|
|
|
1721
1585
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
|
1722
1586
|
==================== END: .xiaoma-core/tasks/execute-checklist.md ====================
|
|
1723
1587
|
|
|
1588
|
+
==================== START: .xiaoma-core/tasks/facilitate-brainstorming-session.md ====================
|
|
1589
|
+
## <!-- Powered by BMAD™ Core -->
|
|
1590
|
+
|
|
1591
|
+
docOutputLocation: docs/brainstorming-session-results.md
|
|
1592
|
+
template: '.xiaoma-core/templates/brainstorming-output-tmpl.yaml'
|
|
1593
|
+
|
|
1594
|
+
---
|
|
1595
|
+
|
|
1596
|
+
# Facilitate Brainstorming Session Task
|
|
1597
|
+
|
|
1598
|
+
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
|
1599
|
+
|
|
1600
|
+
## Process
|
|
1601
|
+
|
|
1602
|
+
### Step 1: Session Setup
|
|
1603
|
+
|
|
1604
|
+
Ask 4 context questions (don't preview what happens next):
|
|
1605
|
+
|
|
1606
|
+
1. What are we brainstorming about?
|
|
1607
|
+
2. Any constraints or parameters?
|
|
1608
|
+
3. Goal: broad exploration or focused ideation?
|
|
1609
|
+
4. Do you want a structured document output to reference later? (Default Yes)
|
|
1610
|
+
|
|
1611
|
+
### Step 2: Present Approach Options
|
|
1612
|
+
|
|
1613
|
+
After getting answers to Step 1, present 4 approach options (numbered):
|
|
1614
|
+
|
|
1615
|
+
1. User selects specific techniques
|
|
1616
|
+
2. Analyst recommends techniques based on context
|
|
1617
|
+
3. Random technique selection for creative variety
|
|
1618
|
+
4. Progressive technique flow (start broad, narrow down)
|
|
1619
|
+
|
|
1620
|
+
### Step 3: Execute Techniques Interactively
|
|
1621
|
+
|
|
1622
|
+
**KEY PRINCIPLES:**
|
|
1623
|
+
|
|
1624
|
+
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
|
1625
|
+
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
|
1626
|
+
- **CAPTURE OUTPUT**: If (default) document output requested, capture all ideas generated in each technique section to the document from the beginning.
|
|
1627
|
+
|
|
1628
|
+
**Technique Selection:**
|
|
1629
|
+
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number..
|
|
1630
|
+
|
|
1631
|
+
**Technique Execution:**
|
|
1632
|
+
|
|
1633
|
+
1. Apply selected technique according to data file description
|
|
1634
|
+
2. Keep engaging with technique until user indicates they want to:
|
|
1635
|
+
- Choose a different technique
|
|
1636
|
+
- Apply current ideas to a new technique
|
|
1637
|
+
- Move to convergent phase
|
|
1638
|
+
- End session
|
|
1639
|
+
|
|
1640
|
+
**Output Capture (if requested):**
|
|
1641
|
+
For each technique used, capture:
|
|
1642
|
+
|
|
1643
|
+
- Technique name and duration
|
|
1644
|
+
- Key ideas generated by user
|
|
1645
|
+
- Insights and patterns identified
|
|
1646
|
+
- User's reflections on the process
|
|
1647
|
+
|
|
1648
|
+
### Step 4: Session Flow
|
|
1649
|
+
|
|
1650
|
+
1. **Warm-up** (5-10 min) - Build creative confidence
|
|
1651
|
+
2. **Divergent** (20-30 min) - Generate quantity over quality
|
|
1652
|
+
3. **Convergent** (15-20 min) - Group and categorize ideas
|
|
1653
|
+
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
|
1654
|
+
|
|
1655
|
+
### Step 5: Document Output (if requested)
|
|
1656
|
+
|
|
1657
|
+
Generate structured document with these sections:
|
|
1658
|
+
|
|
1659
|
+
**Executive Summary**
|
|
1660
|
+
|
|
1661
|
+
- Session topic and goals
|
|
1662
|
+
- Techniques used and duration
|
|
1663
|
+
- Total ideas generated
|
|
1664
|
+
- Key themes and patterns identified
|
|
1665
|
+
|
|
1666
|
+
**Technique Sections** (for each technique used)
|
|
1667
|
+
|
|
1668
|
+
- Technique name and description
|
|
1669
|
+
- Ideas generated (user's own words)
|
|
1670
|
+
- Insights discovered
|
|
1671
|
+
- Notable connections or patterns
|
|
1672
|
+
|
|
1673
|
+
**Idea Categorization**
|
|
1674
|
+
|
|
1675
|
+
- **Immediate Opportunities** - Ready to implement now
|
|
1676
|
+
- **Future Innovations** - Requires development/research
|
|
1677
|
+
- **Moonshots** - Ambitious, transformative concepts
|
|
1678
|
+
- **Insights & Learnings** - Key realizations from session
|
|
1679
|
+
|
|
1680
|
+
**Action Planning**
|
|
1681
|
+
|
|
1682
|
+
- Top 3 priority ideas with rationale
|
|
1683
|
+
- Next steps for each priority
|
|
1684
|
+
- Resources/research needed
|
|
1685
|
+
- Timeline considerations
|
|
1686
|
+
|
|
1687
|
+
**Reflection & Follow-up**
|
|
1688
|
+
|
|
1689
|
+
- What worked well in this session
|
|
1690
|
+
- Areas for further exploration
|
|
1691
|
+
- Recommended follow-up techniques
|
|
1692
|
+
- Questions that emerged for future sessions
|
|
1693
|
+
|
|
1694
|
+
## Key Principles
|
|
1695
|
+
|
|
1696
|
+
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them (unless they request it persistently)
|
|
1697
|
+
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
|
1698
|
+
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
|
1699
|
+
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
|
1700
|
+
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
|
1701
|
+
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
|
1702
|
+
- Maintain energy and momentum
|
|
1703
|
+
- Defer judgment during generation
|
|
1704
|
+
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
|
1705
|
+
- Build on ideas collaboratively
|
|
1706
|
+
- Document everything in output document
|
|
1707
|
+
|
|
1708
|
+
## Advanced Engagement Strategies
|
|
1709
|
+
|
|
1710
|
+
**Energy Management**
|
|
1711
|
+
|
|
1712
|
+
- Check engagement levels: "How are you feeling about this direction?"
|
|
1713
|
+
- Offer breaks or technique switches if energy flags
|
|
1714
|
+
- Use encouraging language and celebrate idea generation
|
|
1715
|
+
|
|
1716
|
+
**Depth vs. Breadth**
|
|
1717
|
+
|
|
1718
|
+
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
|
1719
|
+
- Use "Yes, and..." to build on their ideas
|
|
1720
|
+
- Help them make connections: "How does this relate to your earlier idea about...?"
|
|
1721
|
+
|
|
1722
|
+
**Transition Management**
|
|
1723
|
+
|
|
1724
|
+
- Always ask before switching techniques: "Ready to try a different approach?"
|
|
1725
|
+
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
|
1726
|
+
- Respect their process and timing
|
|
1727
|
+
==================== END: .xiaoma-core/tasks/facilitate-brainstorming-session.md ====================
|
|
1728
|
+
|
|
1724
1729
|
==================== START: .xiaoma-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
1730
|
+
<!-- Powered by BMAD™ Core -->
|
|
1731
|
+
|
|
1725
1732
|
# Create AI Frontend Prompt Task
|
|
1726
1733
|
|
|
1727
1734
|
## Purpose
|
|
@@ -1776,6 +1783,8 @@ You will now synthesize the inputs and the above principles into a final, compre
|
|
|
1776
1783
|
==================== END: .xiaoma-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
1777
1784
|
|
|
1778
1785
|
==================== START: .xiaoma-core/tasks/index-docs.md ====================
|
|
1786
|
+
<!-- Powered by BMAD™ Core -->
|
|
1787
|
+
|
|
1779
1788
|
# Index Documentation Task
|
|
1780
1789
|
|
|
1781
1790
|
## Purpose
|
|
@@ -1789,14 +1798,12 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1789
1798
|
### Required Steps
|
|
1790
1799
|
|
|
1791
1800
|
1. First, locate and scan:
|
|
1792
|
-
|
|
1793
1801
|
- The `docs/` directory and all subdirectories
|
|
1794
1802
|
- The existing `docs/index.md` file (create if absent)
|
|
1795
1803
|
- All markdown (`.md`) and text (`.txt`) files in the documentation structure
|
|
1796
1804
|
- Note the folder structure for hierarchical organization
|
|
1797
1805
|
|
|
1798
1806
|
2. For the existing `docs/index.md`:
|
|
1799
|
-
|
|
1800
1807
|
- Parse current entries
|
|
1801
1808
|
- Note existing file references and descriptions
|
|
1802
1809
|
- Identify any broken links or missing files
|
|
@@ -1804,7 +1811,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1804
1811
|
- Preserve existing folder sections
|
|
1805
1812
|
|
|
1806
1813
|
3. For each documentation file found:
|
|
1807
|
-
|
|
1808
1814
|
- Extract the title (from first heading or filename)
|
|
1809
1815
|
- Generate a brief description by analyzing the content
|
|
1810
1816
|
- Create a relative markdown link to the file
|
|
@@ -1813,7 +1819,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1813
1819
|
- If missing or outdated, prepare an update
|
|
1814
1820
|
|
|
1815
1821
|
4. For any missing or non-existent files found in index:
|
|
1816
|
-
|
|
1817
1822
|
- Present a list of all entries that reference non-existent files
|
|
1818
1823
|
- For each entry:
|
|
1819
1824
|
- Show the full entry details (title, path, description)
|
|
@@ -1866,7 +1871,6 @@ Documents within the `another-folder/` directory:
|
|
|
1866
1871
|
### [Nested Document](./another-folder/document.md)
|
|
1867
1872
|
|
|
1868
1873
|
Description of nested document.
|
|
1869
|
-
|
|
1870
1874
|
```
|
|
1871
1875
|
|
|
1872
1876
|
### Index Entry Format
|
|
@@ -1935,7 +1939,6 @@ For each file referenced in the index but not found in the filesystem:
|
|
|
1935
1939
|
### Special Cases
|
|
1936
1940
|
|
|
1937
1941
|
1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
|
|
1938
|
-
|
|
1939
1942
|
- Use the folder's `index.md` title as the section title
|
|
1940
1943
|
- List the folder's documents as subsections
|
|
1941
1944
|
- Note in the description that this is a multi-part document
|
|
@@ -1958,6 +1961,8 @@ Would you like to proceed with documentation indexing? Please provide the requir
|
|
|
1958
1961
|
==================== END: .xiaoma-core/tasks/index-docs.md ====================
|
|
1959
1962
|
|
|
1960
1963
|
==================== START: .xiaoma-core/tasks/shard-doc.md ====================
|
|
1964
|
+
<!-- Powered by BMAD™ Core -->
|
|
1965
|
+
|
|
1961
1966
|
# Document Sharding Task
|
|
1962
1967
|
|
|
1963
1968
|
## Purpose
|
|
@@ -2051,13 +2056,11 @@ CRITICAL: Use proper parsing that understands markdown context. A ## inside a co
|
|
|
2051
2056
|
For each extracted section:
|
|
2052
2057
|
|
|
2053
2058
|
1. **Generate filename**: Convert the section heading to lowercase-dash-case
|
|
2054
|
-
|
|
2055
2059
|
- Remove special characters
|
|
2056
2060
|
- Replace spaces with dashes
|
|
2057
2061
|
- Example: "## Tech Stack" → `tech-stack.md`
|
|
2058
2062
|
|
|
2059
2063
|
2. **Adjust heading levels**:
|
|
2060
|
-
|
|
2061
2064
|
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
2062
2065
|
- All subsection levels decrease by 1:
|
|
2063
2066
|
|
|
@@ -2148,6 +2151,7 @@ Document sharded successfully:
|
|
|
2148
2151
|
==================== END: .xiaoma-core/tasks/shard-doc.md ====================
|
|
2149
2152
|
|
|
2150
2153
|
==================== START: .xiaoma-core/templates/architecture-tmpl.yaml ====================
|
|
2154
|
+
# <!-- Powered by BMAD™ Core -->
|
|
2151
2155
|
template:
|
|
2152
2156
|
id: architecture-template-v2
|
|
2153
2157
|
name: Architecture Document
|
|
@@ -2170,20 +2174,20 @@ sections:
|
|
|
2170
2174
|
- id: intro-content
|
|
2171
2175
|
content: |
|
|
2172
2176
|
This document outlines the overall project architecture for {{project_name}}, including backend systems, shared services, and non-UI specific concerns. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development, ensuring consistency and adherence to chosen patterns and technologies.
|
|
2173
|
-
|
|
2177
|
+
|
|
2174
2178
|
**Relationship to Frontend Architecture:**
|
|
2175
2179
|
If the project includes a significant user interface, a separate Frontend Architecture Document will detail the frontend-specific design and MUST be used in conjunction with this document. Core technology stack choices documented herein (see "Tech Stack") are definitive for the entire project, including any frontend components.
|
|
2176
2180
|
- id: starter-template
|
|
2177
2181
|
title: Starter Template or Existing Project
|
|
2178
2182
|
instruction: |
|
|
2179
2183
|
Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase:
|
|
2180
|
-
|
|
2184
|
+
|
|
2181
2185
|
1. Review the PRD and brainstorming brief for any mentions of:
|
|
2182
2186
|
- Starter templates (e.g., Create React App, Next.js, Vue CLI, Angular CLI, etc.)
|
|
2183
2187
|
- Existing projects or codebases being used as a foundation
|
|
2184
2188
|
- Boilerplate projects or scaffolding tools
|
|
2185
2189
|
- Previous projects to be cloned or adapted
|
|
2186
|
-
|
|
2190
|
+
|
|
2187
2191
|
2. If a starter template or existing project is mentioned:
|
|
2188
2192
|
- Ask the user to provide access via one of these methods:
|
|
2189
2193
|
- Link to the starter template documentation
|
|
@@ -2196,16 +2200,16 @@ sections:
|
|
|
2196
2200
|
- Existing architectural patterns and conventions
|
|
2197
2201
|
- Any limitations or constraints imposed by the starter
|
|
2198
2202
|
- Use this analysis to inform and align your architecture decisions
|
|
2199
|
-
|
|
2203
|
+
|
|
2200
2204
|
3. If no starter template is mentioned but this is a greenfield project:
|
|
2201
2205
|
- Suggest appropriate starter templates based on the tech stack preferences
|
|
2202
2206
|
- Explain the benefits (faster setup, best practices, community support)
|
|
2203
2207
|
- Let the user decide whether to use one
|
|
2204
|
-
|
|
2208
|
+
|
|
2205
2209
|
4. If the user confirms no starter template will be used:
|
|
2206
2210
|
- Proceed with architecture design from scratch
|
|
2207
2211
|
- Note that manual setup will be required for all tooling and configuration
|
|
2208
|
-
|
|
2212
|
+
|
|
2209
2213
|
Document the decision here before proceeding with the architecture design. If none, just say N/A
|
|
2210
2214
|
elicit: true
|
|
2211
2215
|
- id: changelog
|
|
@@ -2233,7 +2237,7 @@ sections:
|
|
|
2233
2237
|
title: High Level Overview
|
|
2234
2238
|
instruction: |
|
|
2235
2239
|
Based on the PRD's Technical Assumptions section, describe:
|
|
2236
|
-
|
|
2240
|
+
|
|
2237
2241
|
1. The main architectural style (e.g., Monolith, Microservices, Serverless, Event-Driven)
|
|
2238
2242
|
2. Repository structure decision from PRD (Monorepo/Polyrepo)
|
|
2239
2243
|
3. Service architecture decision from PRD
|
|
@@ -2250,17 +2254,17 @@ sections:
|
|
|
2250
2254
|
- Data flow directions
|
|
2251
2255
|
- External integrations
|
|
2252
2256
|
- User entry points
|
|
2253
|
-
|
|
2257
|
+
|
|
2254
2258
|
- id: architectural-patterns
|
|
2255
2259
|
title: Architectural and Design Patterns
|
|
2256
2260
|
instruction: |
|
|
2257
2261
|
List the key high-level patterns that will guide the architecture. For each pattern:
|
|
2258
|
-
|
|
2262
|
+
|
|
2259
2263
|
1. Present 2-3 viable options if multiple exist
|
|
2260
2264
|
2. Provide your recommendation with clear rationale
|
|
2261
2265
|
3. Get user confirmation before finalizing
|
|
2262
2266
|
4. These patterns should align with the PRD's technical assumptions and project goals
|
|
2263
|
-
|
|
2267
|
+
|
|
2264
2268
|
Common patterns to consider:
|
|
2265
2269
|
- Architectural style patterns (Serverless, Event-Driven, Microservices, CQRS, Hexagonal)
|
|
2266
2270
|
- Code organization patterns (Dependency Injection, Repository, Module, Factory)
|
|
@@ -2276,23 +2280,23 @@ sections:
|
|
|
2276
2280
|
title: Tech Stack
|
|
2277
2281
|
instruction: |
|
|
2278
2282
|
This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
|
2279
|
-
|
|
2283
|
+
|
|
2280
2284
|
1. Review PRD technical assumptions and any preferences from .xiaoma-core/data/technical-preferences.yaml or an attached technical-preferences
|
|
2281
2285
|
2. For each category, present 2-3 viable options with pros/cons
|
|
2282
2286
|
3. Make a clear recommendation based on project needs
|
|
2283
2287
|
4. Get explicit user approval for each selection
|
|
2284
2288
|
5. Document exact versions (avoid "latest" - pin specific versions)
|
|
2285
2289
|
6. This table is the single source of truth - all other docs must reference these choices
|
|
2286
|
-
|
|
2290
|
+
|
|
2287
2291
|
Key decisions to finalize - before displaying the table, ensure you are aware of or ask the user about - let the user know if they are not sure on any that you can also provide suggestions with rationale:
|
|
2288
|
-
|
|
2292
|
+
|
|
2289
2293
|
- Starter templates (if any)
|
|
2290
2294
|
- Languages and runtimes with exact versions
|
|
2291
2295
|
- Frameworks and libraries / packages
|
|
2292
2296
|
- Cloud provider and key services choices
|
|
2293
2297
|
- Database and storage solutions - if unclear suggest sql or nosql or other types depending on the project and depending on cloud provider offer a suggestion
|
|
2294
2298
|
- Development tools
|
|
2295
|
-
|
|
2299
|
+
|
|
2296
2300
|
Upon render of the table, ensure the user is aware of the importance of this sections choices, should also look for gaps or disagreements with anything, ask for any clarifications if something is unclear why its in the list, and also right away elicit feedback - this statement and the options should be rendered and then prompt right all before allowing user input.
|
|
2297
2301
|
elicit: true
|
|
2298
2302
|
sections:
|
|
@@ -2316,13 +2320,13 @@ sections:
|
|
|
2316
2320
|
title: Data Models
|
|
2317
2321
|
instruction: |
|
|
2318
2322
|
Define the core data models/entities:
|
|
2319
|
-
|
|
2323
|
+
|
|
2320
2324
|
1. Review PRD requirements and identify key business entities
|
|
2321
2325
|
2. For each model, explain its purpose and relationships
|
|
2322
2326
|
3. Include key attributes and data types
|
|
2323
2327
|
4. Show relationships between models
|
|
2324
2328
|
5. Discuss design decisions with user
|
|
2325
|
-
|
|
2329
|
+
|
|
2326
2330
|
Create a clear conceptual model before moving to database schema.
|
|
2327
2331
|
elicit: true
|
|
2328
2332
|
repeatable: true
|
|
@@ -2331,11 +2335,11 @@ sections:
|
|
|
2331
2335
|
title: "{{model_name}}"
|
|
2332
2336
|
template: |
|
|
2333
2337
|
**Purpose:** {{model_purpose}}
|
|
2334
|
-
|
|
2338
|
+
|
|
2335
2339
|
**Key Attributes:**
|
|
2336
2340
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
2337
2341
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
2338
|
-
|
|
2342
|
+
|
|
2339
2343
|
**Relationships:**
|
|
2340
2344
|
- {{relationship_1}}
|
|
2341
2345
|
- {{relationship_2}}
|
|
@@ -2344,7 +2348,7 @@ sections:
|
|
|
2344
2348
|
title: Components
|
|
2345
2349
|
instruction: |
|
|
2346
2350
|
Based on the architectural patterns, tech stack, and data models from above:
|
|
2347
|
-
|
|
2351
|
+
|
|
2348
2352
|
1. Identify major logical components/services and their responsibilities
|
|
2349
2353
|
2. Consider the repository structure (monorepo/polyrepo) from PRD
|
|
2350
2354
|
3. Define clear boundaries and interfaces between components
|
|
@@ -2353,7 +2357,7 @@ sections:
|
|
|
2353
2357
|
- Key interfaces/APIs exposed
|
|
2354
2358
|
- Dependencies on other components
|
|
2355
2359
|
- Technology specifics based on tech stack choices
|
|
2356
|
-
|
|
2360
|
+
|
|
2357
2361
|
5. Create component diagrams where helpful
|
|
2358
2362
|
elicit: true
|
|
2359
2363
|
sections:
|
|
@@ -2362,13 +2366,13 @@ sections:
|
|
|
2362
2366
|
title: "{{component_name}}"
|
|
2363
2367
|
template: |
|
|
2364
2368
|
**Responsibility:** {{component_description}}
|
|
2365
|
-
|
|
2369
|
+
|
|
2366
2370
|
**Key Interfaces:**
|
|
2367
2371
|
- {{interface_1}}
|
|
2368
2372
|
- {{interface_2}}
|
|
2369
|
-
|
|
2373
|
+
|
|
2370
2374
|
**Dependencies:** {{dependencies}}
|
|
2371
|
-
|
|
2375
|
+
|
|
2372
2376
|
**Technology Stack:** {{component_tech_details}}
|
|
2373
2377
|
- id: component-diagrams
|
|
2374
2378
|
title: Component Diagrams
|
|
@@ -2385,13 +2389,13 @@ sections:
|
|
|
2385
2389
|
condition: Project requires external API integrations
|
|
2386
2390
|
instruction: |
|
|
2387
2391
|
For each external service integration:
|
|
2388
|
-
|
|
2392
|
+
|
|
2389
2393
|
1. Identify APIs needed based on PRD requirements and component design
|
|
2390
2394
|
2. If documentation URLs are unknown, ask user for specifics
|
|
2391
2395
|
3. Document authentication methods and security considerations
|
|
2392
2396
|
4. List specific endpoints that will be used
|
|
2393
2397
|
5. Note any rate limits or usage constraints
|
|
2394
|
-
|
|
2398
|
+
|
|
2395
2399
|
If no external APIs are needed, state this explicitly and skip to next section.
|
|
2396
2400
|
elicit: true
|
|
2397
2401
|
repeatable: true
|
|
@@ -2404,10 +2408,10 @@ sections:
|
|
|
2404
2408
|
- **Base URL(s):** {{api_base_url}}
|
|
2405
2409
|
- **Authentication:** {{auth_method}}
|
|
2406
2410
|
- **Rate Limits:** {{rate_limits}}
|
|
2407
|
-
|
|
2411
|
+
|
|
2408
2412
|
**Key Endpoints Used:**
|
|
2409
2413
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
2410
|
-
|
|
2414
|
+
|
|
2411
2415
|
**Integration Notes:** {{integration_considerations}}
|
|
2412
2416
|
|
|
2413
2417
|
- id: core-workflows
|
|
@@ -2416,13 +2420,13 @@ sections:
|
|
|
2416
2420
|
mermaid_type: sequence
|
|
2417
2421
|
instruction: |
|
|
2418
2422
|
Illustrate key system workflows using sequence diagrams:
|
|
2419
|
-
|
|
2423
|
+
|
|
2420
2424
|
1. Identify critical user journeys from PRD
|
|
2421
2425
|
2. Show component interactions including external APIs
|
|
2422
2426
|
3. Include error handling paths
|
|
2423
2427
|
4. Document async operations
|
|
2424
2428
|
5. Create both high-level and detailed diagrams as needed
|
|
2425
|
-
|
|
2429
|
+
|
|
2426
2430
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
|
2427
2431
|
elicit: true
|
|
2428
2432
|
|
|
@@ -2433,13 +2437,13 @@ sections:
|
|
|
2433
2437
|
language: yaml
|
|
2434
2438
|
instruction: |
|
|
2435
2439
|
If the project includes a REST API:
|
|
2436
|
-
|
|
2440
|
+
|
|
2437
2441
|
1. Create an OpenAPI 3.0 specification
|
|
2438
2442
|
2. Include all endpoints from epics/stories
|
|
2439
2443
|
3. Define request/response schemas based on data models
|
|
2440
2444
|
4. Document authentication requirements
|
|
2441
2445
|
5. Include example requests/responses
|
|
2442
|
-
|
|
2446
|
+
|
|
2443
2447
|
Use YAML format for better readability. If no REST API, skip this section.
|
|
2444
2448
|
elicit: true
|
|
2445
2449
|
template: |
|
|
@@ -2456,13 +2460,13 @@ sections:
|
|
|
2456
2460
|
title: Database Schema
|
|
2457
2461
|
instruction: |
|
|
2458
2462
|
Transform the conceptual data models into concrete database schemas:
|
|
2459
|
-
|
|
2463
|
+
|
|
2460
2464
|
1. Use the database type(s) selected in Tech Stack
|
|
2461
2465
|
2. Create schema definitions using appropriate notation
|
|
2462
2466
|
3. Include indexes, constraints, and relationships
|
|
2463
2467
|
4. Consider performance and scalability
|
|
2464
2468
|
5. For NoSQL, show document structures
|
|
2465
|
-
|
|
2469
|
+
|
|
2466
2470
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
|
2467
2471
|
elicit: true
|
|
2468
2472
|
|
|
@@ -2472,14 +2476,14 @@ sections:
|
|
|
2472
2476
|
language: plaintext
|
|
2473
2477
|
instruction: |
|
|
2474
2478
|
Create a project folder structure that reflects:
|
|
2475
|
-
|
|
2479
|
+
|
|
2476
2480
|
1. The chosen repository structure (monorepo/polyrepo)
|
|
2477
2481
|
2. The service architecture (monolith/microservices/serverless)
|
|
2478
2482
|
3. The selected tech stack and languages
|
|
2479
2483
|
4. Component organization from above
|
|
2480
2484
|
5. Best practices for the chosen frameworks
|
|
2481
2485
|
6. Clear separation of concerns
|
|
2482
|
-
|
|
2486
|
+
|
|
2483
2487
|
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
|
2484
2488
|
elicit: true
|
|
2485
2489
|
examples:
|
|
@@ -2497,13 +2501,13 @@ sections:
|
|
|
2497
2501
|
title: Infrastructure and Deployment
|
|
2498
2502
|
instruction: |
|
|
2499
2503
|
Define the deployment architecture and practices:
|
|
2500
|
-
|
|
2504
|
+
|
|
2501
2505
|
1. Use IaC tool selected in Tech Stack
|
|
2502
2506
|
2. Choose deployment strategy appropriate for the architecture
|
|
2503
2507
|
3. Define environments and promotion flow
|
|
2504
2508
|
4. Establish rollback procedures
|
|
2505
2509
|
5. Consider security, monitoring, and cost optimization
|
|
2506
|
-
|
|
2510
|
+
|
|
2507
2511
|
Get user input on deployment preferences and CI/CD tool choices.
|
|
2508
2512
|
elicit: true
|
|
2509
2513
|
sections:
|
|
@@ -2539,13 +2543,13 @@ sections:
|
|
|
2539
2543
|
title: Error Handling Strategy
|
|
2540
2544
|
instruction: |
|
|
2541
2545
|
Define comprehensive error handling approach:
|
|
2542
|
-
|
|
2546
|
+
|
|
2543
2547
|
1. Choose appropriate patterns for the language/framework from Tech Stack
|
|
2544
2548
|
2. Define logging standards and tools
|
|
2545
2549
|
3. Establish error categories and handling rules
|
|
2546
2550
|
4. Consider observability and debugging needs
|
|
2547
2551
|
5. Ensure security (no sensitive data in logs)
|
|
2548
|
-
|
|
2552
|
+
|
|
2549
2553
|
This section guides both AI and human developers in consistent error handling.
|
|
2550
2554
|
elicit: true
|
|
2551
2555
|
sections:
|
|
@@ -2592,13 +2596,13 @@ sections:
|
|
|
2592
2596
|
title: Coding Standards
|
|
2593
2597
|
instruction: |
|
|
2594
2598
|
These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that:
|
|
2595
|
-
|
|
2599
|
+
|
|
2596
2600
|
1. This section directly controls AI developer behavior
|
|
2597
2601
|
2. Keep it minimal - assume AI knows general best practices
|
|
2598
2602
|
3. Focus on project-specific conventions and gotchas
|
|
2599
2603
|
4. Overly detailed standards bloat context and slow development
|
|
2600
2604
|
5. Standards will be extracted to separate file for dev agent use
|
|
2601
|
-
|
|
2605
|
+
|
|
2602
2606
|
For each standard, get explicit user confirmation it's necessary.
|
|
2603
2607
|
elicit: true
|
|
2604
2608
|
sections:
|
|
@@ -2620,7 +2624,7 @@ sections:
|
|
|
2620
2624
|
- "Never use console.log in production code - use logger"
|
|
2621
2625
|
- "All API responses must use ApiResponse wrapper type"
|
|
2622
2626
|
- "Database queries must use repository pattern, never direct ORM"
|
|
2623
|
-
|
|
2627
|
+
|
|
2624
2628
|
Avoid obvious rules like "use SOLID principles" or "write clean code"
|
|
2625
2629
|
repeatable: true
|
|
2626
2630
|
template: "- **{{rule_name}}:** {{rule_description}}"
|
|
@@ -2638,14 +2642,14 @@ sections:
|
|
|
2638
2642
|
title: Test Strategy and Standards
|
|
2639
2643
|
instruction: |
|
|
2640
2644
|
Work with user to define comprehensive test strategy:
|
|
2641
|
-
|
|
2645
|
+
|
|
2642
2646
|
1. Use test frameworks from Tech Stack
|
|
2643
2647
|
2. Decide on TDD vs test-after approach
|
|
2644
2648
|
3. Define test organization and naming
|
|
2645
2649
|
4. Establish coverage goals
|
|
2646
2650
|
5. Determine integration test infrastructure
|
|
2647
2651
|
6. Plan for test data and external dependencies
|
|
2648
|
-
|
|
2652
|
+
|
|
2649
2653
|
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference.
|
|
2650
2654
|
elicit: true
|
|
2651
2655
|
sections:
|
|
@@ -2666,7 +2670,7 @@ sections:
|
|
|
2666
2670
|
- **Location:** {{unit_test_location}}
|
|
2667
2671
|
- **Mocking Library:** {{mocking_library}}
|
|
2668
2672
|
- **Coverage Requirement:** {{unit_coverage}}
|
|
2669
|
-
|
|
2673
|
+
|
|
2670
2674
|
**AI Agent Requirements:**
|
|
2671
2675
|
- Generate tests for all public methods
|
|
2672
2676
|
- Cover edge cases and error conditions
|
|
@@ -2708,7 +2712,7 @@ sections:
|
|
|
2708
2712
|
title: Security
|
|
2709
2713
|
instruction: |
|
|
2710
2714
|
Define MANDATORY security requirements for AI and human developers:
|
|
2711
|
-
|
|
2715
|
+
|
|
2712
2716
|
1. Focus on implementation-specific rules
|
|
2713
2717
|
2. Reference security tools from Tech Stack
|
|
2714
2718
|
3. Define clear patterns for common scenarios
|
|
@@ -2777,16 +2781,16 @@ sections:
|
|
|
2777
2781
|
title: Next Steps
|
|
2778
2782
|
instruction: |
|
|
2779
2783
|
After completing the architecture:
|
|
2780
|
-
|
|
2784
|
+
|
|
2781
2785
|
1. If project has UI components:
|
|
2782
2786
|
- Use "Frontend Architecture Mode"
|
|
2783
2787
|
- Provide this document as input
|
|
2784
|
-
|
|
2788
|
+
|
|
2785
2789
|
2. For all projects:
|
|
2786
2790
|
- Review with Product Owner
|
|
2787
2791
|
- Begin story implementation with Dev agent
|
|
2788
2792
|
- Set up infrastructure with DevOps agent
|
|
2789
|
-
|
|
2793
|
+
|
|
2790
2794
|
3. Include specific prompts for next agents if needed
|
|
2791
2795
|
sections:
|
|
2792
2796
|
- id: architect-prompt
|
|
@@ -2801,6 +2805,7 @@ sections:
|
|
|
2801
2805
|
==================== END: .xiaoma-core/templates/architecture-tmpl.yaml ====================
|
|
2802
2806
|
|
|
2803
2807
|
==================== START: .xiaoma-core/templates/brownfield-architecture-tmpl.yaml ====================
|
|
2808
|
+
# <!-- Powered by BMAD™ Core -->
|
|
2804
2809
|
template:
|
|
2805
2810
|
id: brownfield-architecture-template-v2
|
|
2806
2811
|
name: Brownfield Enhancement Architecture
|
|
@@ -2819,40 +2824,40 @@ sections:
|
|
|
2819
2824
|
title: Introduction
|
|
2820
2825
|
instruction: |
|
|
2821
2826
|
IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
|
|
2822
|
-
|
|
2827
|
+
|
|
2823
2828
|
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
|
|
2824
|
-
|
|
2829
|
+
|
|
2825
2830
|
1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
|
|
2826
|
-
|
|
2831
|
+
|
|
2827
2832
|
2. **REQUIRED INPUTS**:
|
|
2828
2833
|
- Completed brownfield-prd.md
|
|
2829
2834
|
- Existing project technical documentation (from docs folder or user-provided)
|
|
2830
2835
|
- Access to existing project structure (IDE or uploaded files)
|
|
2831
|
-
|
|
2836
|
+
|
|
2832
2837
|
3. **DEEP ANALYSIS MANDATE**: You MUST conduct thorough analysis of the existing codebase, architecture patterns, and technical constraints before making ANY architectural recommendations. Every suggestion must be based on actual project analysis, not assumptions.
|
|
2833
|
-
|
|
2838
|
+
|
|
2834
2839
|
4. **CONTINUOUS VALIDATION**: Throughout this process, explicitly validate your understanding with the user. For every architectural decision, confirm: "Based on my analysis of your existing system, I recommend [decision] because [evidence from actual project]. Does this align with your system's reality?"
|
|
2835
|
-
|
|
2840
|
+
|
|
2836
2841
|
If any required inputs are missing, request them before proceeding.
|
|
2837
2842
|
elicit: true
|
|
2838
2843
|
sections:
|
|
2839
2844
|
- id: intro-content
|
|
2840
2845
|
content: |
|
|
2841
2846
|
This document outlines the architectural approach for enhancing {{project_name}} with {{enhancement_description}}. Its primary goal is to serve as the guiding architectural blueprint for AI-driven development of new features while ensuring seamless integration with the existing system.
|
|
2842
|
-
|
|
2847
|
+
|
|
2843
2848
|
**Relationship to Existing Architecture:**
|
|
2844
2849
|
This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements.
|
|
2845
2850
|
- id: existing-project-analysis
|
|
2846
2851
|
title: Existing Project Analysis
|
|
2847
2852
|
instruction: |
|
|
2848
2853
|
Analyze the existing project structure and architecture:
|
|
2849
|
-
|
|
2854
|
+
|
|
2850
2855
|
1. Review existing documentation in docs folder
|
|
2851
2856
|
2. Examine current technology stack and versions
|
|
2852
2857
|
3. Identify existing architectural patterns and conventions
|
|
2853
2858
|
4. Note current deployment and infrastructure setup
|
|
2854
2859
|
5. Document any constraints or limitations
|
|
2855
|
-
|
|
2860
|
+
|
|
2856
2861
|
CRITICAL: After your analysis, explicitly validate your findings: "Based on my analysis of your project, I've identified the following about your existing system: [key findings]. Please confirm these observations are accurate before I proceed with architectural recommendations."
|
|
2857
2862
|
elicit: true
|
|
2858
2863
|
sections:
|
|
@@ -2881,12 +2886,12 @@ sections:
|
|
|
2881
2886
|
title: Enhancement Scope and Integration Strategy
|
|
2882
2887
|
instruction: |
|
|
2883
2888
|
Define how the enhancement will integrate with the existing system:
|
|
2884
|
-
|
|
2889
|
+
|
|
2885
2890
|
1. Review the brownfield PRD enhancement scope
|
|
2886
2891
|
2. Identify integration points with existing code
|
|
2887
2892
|
3. Define boundaries between new and existing functionality
|
|
2888
2893
|
4. Establish compatibility requirements
|
|
2889
|
-
|
|
2894
|
+
|
|
2890
2895
|
VALIDATION CHECKPOINT: Before presenting the integration strategy, confirm: "Based on my analysis, the integration approach I'm proposing takes into account [specific existing system characteristics]. These integration points and boundaries respect your current architecture patterns. Is this assessment accurate?"
|
|
2891
2896
|
elicit: true
|
|
2892
2897
|
sections:
|
|
@@ -2915,7 +2920,7 @@ sections:
|
|
|
2915
2920
|
title: Tech Stack Alignment
|
|
2916
2921
|
instruction: |
|
|
2917
2922
|
Ensure new components align with existing technology choices:
|
|
2918
|
-
|
|
2923
|
+
|
|
2919
2924
|
1. Use existing technology stack as the foundation
|
|
2920
2925
|
2. Only introduce new technologies if absolutely necessary
|
|
2921
2926
|
3. Justify any new additions with clear rationale
|
|
@@ -2938,7 +2943,7 @@ sections:
|
|
|
2938
2943
|
title: Data Models and Schema Changes
|
|
2939
2944
|
instruction: |
|
|
2940
2945
|
Define new data models and how they integrate with existing schema:
|
|
2941
|
-
|
|
2946
|
+
|
|
2942
2947
|
1. Identify new entities required for the enhancement
|
|
2943
2948
|
2. Define relationships with existing data models
|
|
2944
2949
|
3. Plan database schema changes (additions, modifications)
|
|
@@ -2954,11 +2959,11 @@ sections:
|
|
|
2954
2959
|
template: |
|
|
2955
2960
|
**Purpose:** {{model_purpose}}
|
|
2956
2961
|
**Integration:** {{integration_with_existing}}
|
|
2957
|
-
|
|
2962
|
+
|
|
2958
2963
|
**Key Attributes:**
|
|
2959
2964
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
2960
2965
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
2961
|
-
|
|
2966
|
+
|
|
2962
2967
|
**Relationships:**
|
|
2963
2968
|
- **With Existing:** {{existing_relationships}}
|
|
2964
2969
|
- **With New:** {{new_relationships}}
|
|
@@ -2970,7 +2975,7 @@ sections:
|
|
|
2970
2975
|
- **Modified Tables:** {{modified_tables_list}}
|
|
2971
2976
|
- **New Indexes:** {{new_indexes_list}}
|
|
2972
2977
|
- **Migration Strategy:** {{migration_approach}}
|
|
2973
|
-
|
|
2978
|
+
|
|
2974
2979
|
**Backward Compatibility:**
|
|
2975
2980
|
- {{compatibility_measure_1}}
|
|
2976
2981
|
- {{compatibility_measure_2}}
|
|
@@ -2979,12 +2984,12 @@ sections:
|
|
|
2979
2984
|
title: Component Architecture
|
|
2980
2985
|
instruction: |
|
|
2981
2986
|
Define new components and their integration with existing architecture:
|
|
2982
|
-
|
|
2987
|
+
|
|
2983
2988
|
1. Identify new components required for the enhancement
|
|
2984
2989
|
2. Define interfaces with existing components
|
|
2985
2990
|
3. Establish clear boundaries and responsibilities
|
|
2986
2991
|
4. Plan integration points and data flow
|
|
2987
|
-
|
|
2992
|
+
|
|
2988
2993
|
MANDATORY VALIDATION: Before presenting component architecture, confirm: "The new components I'm proposing follow the existing architectural patterns I identified in your codebase: [specific patterns]. The integration interfaces respect your current component structure and communication patterns. Does this match your project's reality?"
|
|
2989
2994
|
elicit: true
|
|
2990
2995
|
sections:
|
|
@@ -2997,15 +3002,15 @@ sections:
|
|
|
2997
3002
|
template: |
|
|
2998
3003
|
**Responsibility:** {{component_description}}
|
|
2999
3004
|
**Integration Points:** {{integration_points}}
|
|
3000
|
-
|
|
3005
|
+
|
|
3001
3006
|
**Key Interfaces:**
|
|
3002
3007
|
- {{interface_1}}
|
|
3003
3008
|
- {{interface_2}}
|
|
3004
|
-
|
|
3009
|
+
|
|
3005
3010
|
**Dependencies:**
|
|
3006
3011
|
- **Existing Components:** {{existing_dependencies}}
|
|
3007
3012
|
- **New Components:** {{new_dependencies}}
|
|
3008
|
-
|
|
3013
|
+
|
|
3009
3014
|
**Technology Stack:** {{component_tech_details}}
|
|
3010
3015
|
- id: interaction-diagram
|
|
3011
3016
|
title: Component Interaction Diagram
|
|
@@ -3018,7 +3023,7 @@ sections:
|
|
|
3018
3023
|
condition: Enhancement requires API changes
|
|
3019
3024
|
instruction: |
|
|
3020
3025
|
Define new API endpoints and integration with existing APIs:
|
|
3021
|
-
|
|
3026
|
+
|
|
3022
3027
|
1. Plan new API endpoints required for the enhancement
|
|
3023
3028
|
2. Ensure consistency with existing API patterns
|
|
3024
3029
|
3. Define authentication and authorization integration
|
|
@@ -3068,17 +3073,17 @@ sections:
|
|
|
3068
3073
|
- **Base URL:** {{api_base_url}}
|
|
3069
3074
|
- **Authentication:** {{auth_method}}
|
|
3070
3075
|
- **Integration Method:** {{integration_approach}}
|
|
3071
|
-
|
|
3076
|
+
|
|
3072
3077
|
**Key Endpoints Used:**
|
|
3073
3078
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
3074
|
-
|
|
3079
|
+
|
|
3075
3080
|
**Error Handling:** {{error_handling_strategy}}
|
|
3076
3081
|
|
|
3077
3082
|
- id: source-tree-integration
|
|
3078
3083
|
title: Source Tree Integration
|
|
3079
3084
|
instruction: |
|
|
3080
3085
|
Define how new code will integrate with existing project structure:
|
|
3081
|
-
|
|
3086
|
+
|
|
3082
3087
|
1. Follow existing project organization patterns
|
|
3083
3088
|
2. Identify where new files/folders will be placed
|
|
3084
3089
|
3. Ensure consistency with existing naming conventions
|
|
@@ -3117,7 +3122,7 @@ sections:
|
|
|
3117
3122
|
title: Infrastructure and Deployment Integration
|
|
3118
3123
|
instruction: |
|
|
3119
3124
|
Define how the enhancement will be deployed alongside existing infrastructure:
|
|
3120
|
-
|
|
3125
|
+
|
|
3121
3126
|
1. Use existing deployment pipeline and infrastructure
|
|
3122
3127
|
2. Identify any infrastructure changes needed
|
|
3123
3128
|
3. Plan deployment strategy to minimize risk
|
|
@@ -3147,7 +3152,7 @@ sections:
|
|
|
3147
3152
|
title: Coding Standards and Conventions
|
|
3148
3153
|
instruction: |
|
|
3149
3154
|
Ensure new code follows existing project conventions:
|
|
3150
|
-
|
|
3155
|
+
|
|
3151
3156
|
1. Document existing coding standards from project analysis
|
|
3152
3157
|
2. Identify any enhancement-specific requirements
|
|
3153
3158
|
3. Ensure consistency with existing codebase patterns
|
|
@@ -3178,7 +3183,7 @@ sections:
|
|
|
3178
3183
|
title: Testing Strategy
|
|
3179
3184
|
instruction: |
|
|
3180
3185
|
Define testing approach for the enhancement:
|
|
3181
|
-
|
|
3186
|
+
|
|
3182
3187
|
1. Integrate with existing test suite
|
|
3183
3188
|
2. Ensure existing functionality remains intact
|
|
3184
3189
|
3. Plan for testing new features
|
|
@@ -3218,7 +3223,7 @@ sections:
|
|
|
3218
3223
|
title: Security Integration
|
|
3219
3224
|
instruction: |
|
|
3220
3225
|
Ensure security consistency with existing system:
|
|
3221
|
-
|
|
3226
|
+
|
|
3222
3227
|
1. Follow existing security patterns and tools
|
|
3223
3228
|
2. Ensure new features don't introduce vulnerabilities
|
|
3224
3229
|
3. Maintain existing security posture
|
|
@@ -3253,7 +3258,7 @@ sections:
|
|
|
3253
3258
|
title: Next Steps
|
|
3254
3259
|
instruction: |
|
|
3255
3260
|
After completing the brownfield architecture:
|
|
3256
|
-
|
|
3261
|
+
|
|
3257
3262
|
1. Review integration points with existing system
|
|
3258
3263
|
2. Begin story implementation with Dev agent
|
|
3259
3264
|
3. Set up deployment pipeline integration
|
|
@@ -3280,6 +3285,7 @@ sections:
|
|
|
3280
3285
|
==================== END: .xiaoma-core/templates/brownfield-architecture-tmpl.yaml ====================
|
|
3281
3286
|
|
|
3282
3287
|
==================== START: .xiaoma-core/templates/brownfield-prd-tmpl.yaml ====================
|
|
3288
|
+
# <!-- Powered by BMAD™ Core -->
|
|
3283
3289
|
template:
|
|
3284
3290
|
id: brownfield-prd-template-v2
|
|
3285
3291
|
name: Brownfield Enhancement PRD
|
|
@@ -3298,19 +3304,19 @@ sections:
|
|
|
3298
3304
|
title: Intro Project Analysis and Context
|
|
3299
3305
|
instruction: |
|
|
3300
3306
|
IMPORTANT - SCOPE ASSESSMENT REQUIRED:
|
|
3301
|
-
|
|
3307
|
+
|
|
3302
3308
|
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
|
|
3303
|
-
|
|
3309
|
+
|
|
3304
3310
|
1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
|
|
3305
|
-
|
|
3311
|
+
|
|
3306
3312
|
2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
|
|
3307
|
-
|
|
3313
|
+
|
|
3308
3314
|
3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.
|
|
3309
|
-
|
|
3315
|
+
|
|
3310
3316
|
Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
|
|
3311
|
-
|
|
3317
|
+
|
|
3312
3318
|
CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
|
|
3313
|
-
|
|
3319
|
+
|
|
3314
3320
|
Do not proceed with any recommendations until the user has validated your understanding of the existing system.
|
|
3315
3321
|
sections:
|
|
3316
3322
|
- id: existing-project-overview
|
|
@@ -3336,7 +3342,7 @@ sections:
|
|
|
3336
3342
|
- Note: "Document-project analysis available - using existing technical documentation"
|
|
3337
3343
|
- List key documents created by document-project
|
|
3338
3344
|
- Skip the missing documentation check below
|
|
3339
|
-
|
|
3345
|
+
|
|
3340
3346
|
Otherwise, check for existing documentation:
|
|
3341
3347
|
sections:
|
|
3342
3348
|
- id: available-docs
|
|
@@ -3460,7 +3466,7 @@ sections:
|
|
|
3460
3466
|
If document-project output available:
|
|
3461
3467
|
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
|
3462
3468
|
- Include version numbers and any noted constraints
|
|
3463
|
-
|
|
3469
|
+
|
|
3464
3470
|
Otherwise, document the current technology stack:
|
|
3465
3471
|
template: |
|
|
3466
3472
|
**Languages**: {{languages}}
|
|
@@ -3499,7 +3505,7 @@ sections:
|
|
|
3499
3505
|
- Reference "Technical Debt and Known Issues" section
|
|
3500
3506
|
- Include "Workarounds and Gotchas" that might impact enhancement
|
|
3501
3507
|
- Note any identified constraints from "Critical Technical Debt"
|
|
3502
|
-
|
|
3508
|
+
|
|
3503
3509
|
Build risk assessment incorporating existing known issues:
|
|
3504
3510
|
template: |
|
|
3505
3511
|
**Technical Risks**: {{technical_risks}}
|
|
@@ -3522,7 +3528,7 @@ sections:
|
|
|
3522
3528
|
title: "Epic 1: {{enhancement_title}}"
|
|
3523
3529
|
instruction: |
|
|
3524
3530
|
Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
|
|
3525
|
-
|
|
3531
|
+
|
|
3526
3532
|
CRITICAL STORY SEQUENCING FOR BROWNFIELD:
|
|
3527
3533
|
- Stories must ensure existing functionality remains intact
|
|
3528
3534
|
- Each story should include verification that existing features still work
|
|
@@ -3535,7 +3541,7 @@ sections:
|
|
|
3535
3541
|
- Each story must deliver value while maintaining system integrity
|
|
3536
3542
|
template: |
|
|
3537
3543
|
**Epic Goal**: {{epic_goal}}
|
|
3538
|
-
|
|
3544
|
+
|
|
3539
3545
|
**Integration Requirements**: {{integration_requirements}}
|
|
3540
3546
|
sections:
|
|
3541
3547
|
- id: story
|
|
@@ -3563,6 +3569,7 @@ sections:
|
|
|
3563
3569
|
==================== END: .xiaoma-core/templates/brownfield-prd-tmpl.yaml ====================
|
|
3564
3570
|
|
|
3565
3571
|
==================== START: .xiaoma-core/templates/competitor-analysis-tmpl.yaml ====================
|
|
3572
|
+
# <!-- Powered by BMAD™ Core -->
|
|
3566
3573
|
template:
|
|
3567
3574
|
id: competitor-analysis-template-v2
|
|
3568
3575
|
name: Competitive Analysis Report
|
|
@@ -3641,7 +3648,7 @@ sections:
|
|
|
3641
3648
|
title: Competitor Prioritization Matrix
|
|
3642
3649
|
instruction: |
|
|
3643
3650
|
Help categorize competitors by market share and strategic threat level
|
|
3644
|
-
|
|
3651
|
+
|
|
3645
3652
|
Create a 2x2 matrix:
|
|
3646
3653
|
- Priority 1 (Core Competitors): High Market Share + High Threat
|
|
3647
3654
|
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
|
@@ -3706,7 +3713,14 @@ sections:
|
|
|
3706
3713
|
title: Feature Comparison Matrix
|
|
3707
3714
|
instruction: Create a detailed comparison table of key features across competitors
|
|
3708
3715
|
type: table
|
|
3709
|
-
columns:
|
|
3716
|
+
columns:
|
|
3717
|
+
[
|
|
3718
|
+
"Feature Category",
|
|
3719
|
+
"{{your_company}}",
|
|
3720
|
+
"{{competitor_1}}",
|
|
3721
|
+
"{{competitor_2}}",
|
|
3722
|
+
"{{competitor_3}}",
|
|
3723
|
+
]
|
|
3710
3724
|
rows:
|
|
3711
3725
|
- category: "Core Functionality"
|
|
3712
3726
|
items:
|
|
@@ -3718,7 +3732,13 @@ sections:
|
|
|
3718
3732
|
- ["Onboarding Time", "{{time}}", "{{time}}", "{{time}}", "{{time}}"]
|
|
3719
3733
|
- category: "Integration & Ecosystem"
|
|
3720
3734
|
items:
|
|
3721
|
-
- [
|
|
3735
|
+
- [
|
|
3736
|
+
"API Availability",
|
|
3737
|
+
"{{availability}}",
|
|
3738
|
+
"{{availability}}",
|
|
3739
|
+
"{{availability}}",
|
|
3740
|
+
"{{availability}}",
|
|
3741
|
+
]
|
|
3722
3742
|
- ["Third-party Integrations", "{{number}}", "{{number}}", "{{number}}", "{{number}}"]
|
|
3723
3743
|
- category: "Pricing & Plans"
|
|
3724
3744
|
items:
|
|
@@ -3745,7 +3765,7 @@ sections:
|
|
|
3745
3765
|
title: Positioning Map
|
|
3746
3766
|
instruction: |
|
|
3747
3767
|
Describe competitor positions on key dimensions
|
|
3748
|
-
|
|
3768
|
+
|
|
3749
3769
|
Create a positioning description using 2 key dimensions relevant to the market, such as:
|
|
3750
3770
|
- Price vs. Features
|
|
3751
3771
|
- Ease of Use vs. Power
|
|
@@ -3780,7 +3800,7 @@ sections:
|
|
|
3780
3800
|
title: Blue Ocean Opportunities
|
|
3781
3801
|
instruction: |
|
|
3782
3802
|
Identify uncontested market spaces
|
|
3783
|
-
|
|
3803
|
+
|
|
3784
3804
|
List opportunities to create new market space:
|
|
3785
3805
|
- Underserved segments
|
|
3786
3806
|
- Unaddressed use cases
|
|
@@ -3859,6 +3879,7 @@ sections:
|
|
|
3859
3879
|
==================== END: .xiaoma-core/templates/competitor-analysis-tmpl.yaml ====================
|
|
3860
3880
|
|
|
3861
3881
|
==================== START: .xiaoma-core/templates/front-end-architecture-tmpl.yaml ====================
|
|
3882
|
+
# <!-- Powered by BMAD™ Core -->
|
|
3862
3883
|
template:
|
|
3863
3884
|
id: frontend-architecture-template-v2
|
|
3864
3885
|
name: Frontend Architecture Document
|
|
@@ -3877,16 +3898,16 @@ sections:
|
|
|
3877
3898
|
title: Template and Framework Selection
|
|
3878
3899
|
instruction: |
|
|
3879
3900
|
Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.
|
|
3880
|
-
|
|
3901
|
+
|
|
3881
3902
|
Before proceeding with frontend architecture design, check if the project is using a frontend starter template or existing codebase:
|
|
3882
|
-
|
|
3903
|
+
|
|
3883
3904
|
1. Review the PRD, main architecture document, and brainstorming brief for mentions of:
|
|
3884
3905
|
- Frontend starter templates (e.g., Create React App, Next.js, Vite, Vue CLI, Angular CLI, etc.)
|
|
3885
3906
|
- UI kit or component library starters
|
|
3886
3907
|
- Existing frontend projects being used as a foundation
|
|
3887
3908
|
- Admin dashboard templates or other specialized starters
|
|
3888
3909
|
- Design system implementations
|
|
3889
|
-
|
|
3910
|
+
|
|
3890
3911
|
2. If a frontend starter template or existing project is mentioned:
|
|
3891
3912
|
- Ask the user to provide access via one of these methods:
|
|
3892
3913
|
- Link to the starter template documentation
|
|
@@ -3902,7 +3923,7 @@ sections:
|
|
|
3902
3923
|
- Testing setup and patterns
|
|
3903
3924
|
- Build and development scripts
|
|
3904
3925
|
- Use this analysis to ensure your frontend architecture aligns with the starter's patterns
|
|
3905
|
-
|
|
3926
|
+
|
|
3906
3927
|
3. If no frontend starter is mentioned but this is a new UI, ensure we know what the ui language and framework is:
|
|
3907
3928
|
- Based on the framework choice, suggest appropriate starters:
|
|
3908
3929
|
- React: Create React App, Next.js, Vite + React
|
|
@@ -3910,11 +3931,11 @@ sections:
|
|
|
3910
3931
|
- Angular: Angular CLI
|
|
3911
3932
|
- Or suggest popular UI templates if applicable
|
|
3912
3933
|
- Explain benefits specific to frontend development
|
|
3913
|
-
|
|
3934
|
+
|
|
3914
3935
|
4. If the user confirms no starter template will be used:
|
|
3915
3936
|
- Note that all tooling, bundling, and configuration will need manual setup
|
|
3916
3937
|
- Proceed with frontend architecture from scratch
|
|
3917
|
-
|
|
3938
|
+
|
|
3918
3939
|
Document the starter template decision and any constraints it imposes before proceeding.
|
|
3919
3940
|
sections:
|
|
3920
3941
|
- id: changelog
|
|
@@ -3936,12 +3957,24 @@ sections:
|
|
|
3936
3957
|
rows:
|
|
3937
3958
|
- ["Framework", "{{framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3938
3959
|
- ["UI Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3939
|
-
- [
|
|
3960
|
+
- [
|
|
3961
|
+
"State Management",
|
|
3962
|
+
"{{state_management}}",
|
|
3963
|
+
"{{version}}",
|
|
3964
|
+
"{{purpose}}",
|
|
3965
|
+
"{{why_chosen}}",
|
|
3966
|
+
]
|
|
3940
3967
|
- ["Routing", "{{routing_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3941
3968
|
- ["Build Tool", "{{build_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3942
3969
|
- ["Styling", "{{styling_solution}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3943
3970
|
- ["Testing", "{{test_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3944
|
-
- [
|
|
3971
|
+
- [
|
|
3972
|
+
"Component Library",
|
|
3973
|
+
"{{component_lib}}",
|
|
3974
|
+
"{{version}}",
|
|
3975
|
+
"{{purpose}}",
|
|
3976
|
+
"{{why_chosen}}",
|
|
3977
|
+
]
|
|
3945
3978
|
- ["Form Handling", "{{form_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3946
3979
|
- ["Animation", "{{animation_lib}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3947
3980
|
- ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
@@ -4068,6 +4101,7 @@ sections:
|
|
|
4068
4101
|
==================== END: .xiaoma-core/templates/front-end-architecture-tmpl.yaml ====================
|
|
4069
4102
|
|
|
4070
4103
|
==================== START: .xiaoma-core/templates/front-end-spec-tmpl.yaml ====================
|
|
4104
|
+
# <!-- Powered by BMAD™ Core -->
|
|
4071
4105
|
template:
|
|
4072
4106
|
id: frontend-spec-template-v2
|
|
4073
4107
|
name: UI/UX Specification
|
|
@@ -4086,7 +4120,7 @@ sections:
|
|
|
4086
4120
|
title: Introduction
|
|
4087
4121
|
instruction: |
|
|
4088
4122
|
Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
|
|
4089
|
-
|
|
4123
|
+
|
|
4090
4124
|
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
|
4091
4125
|
content: |
|
|
4092
4126
|
This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
|
|
@@ -4095,7 +4129,7 @@ sections:
|
|
|
4095
4129
|
title: Overall UX Goals & Principles
|
|
4096
4130
|
instruction: |
|
|
4097
4131
|
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
|
4098
|
-
|
|
4132
|
+
|
|
4099
4133
|
1. Target User Personas - elicit details or confirm existing ones from PRD
|
|
4100
4134
|
2. Key Usability Goals - understand what success looks like for users
|
|
4101
4135
|
3. Core Design Principles - establish 3-5 guiding principles
|
|
@@ -4136,7 +4170,7 @@ sections:
|
|
|
4136
4170
|
title: Information Architecture (IA)
|
|
4137
4171
|
instruction: |
|
|
4138
4172
|
Collaborate with the user to create a comprehensive information architecture:
|
|
4139
|
-
|
|
4173
|
+
|
|
4140
4174
|
1. Build a Site Map or Screen Inventory showing all major areas
|
|
4141
4175
|
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
|
4142
4176
|
3. Use Mermaid diagrams for visual representation
|
|
@@ -4166,22 +4200,22 @@ sections:
|
|
|
4166
4200
|
title: Navigation Structure
|
|
4167
4201
|
template: |
|
|
4168
4202
|
**Primary Navigation:** {{primary_nav_description}}
|
|
4169
|
-
|
|
4203
|
+
|
|
4170
4204
|
**Secondary Navigation:** {{secondary_nav_description}}
|
|
4171
|
-
|
|
4205
|
+
|
|
4172
4206
|
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
|
4173
4207
|
|
|
4174
4208
|
- id: user-flows
|
|
4175
4209
|
title: User Flows
|
|
4176
4210
|
instruction: |
|
|
4177
4211
|
For each critical user task identified in the PRD:
|
|
4178
|
-
|
|
4212
|
+
|
|
4179
4213
|
1. Define the user's goal clearly
|
|
4180
4214
|
2. Map out all steps including decision points
|
|
4181
4215
|
3. Consider edge cases and error states
|
|
4182
4216
|
4. Use Mermaid flow diagrams for clarity
|
|
4183
4217
|
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
|
4184
|
-
|
|
4218
|
+
|
|
4185
4219
|
Create subsections for each major flow.
|
|
4186
4220
|
elicit: true
|
|
4187
4221
|
repeatable: true
|
|
@@ -4190,9 +4224,9 @@ sections:
|
|
|
4190
4224
|
title: "{{flow_name}}"
|
|
4191
4225
|
template: |
|
|
4192
4226
|
**User Goal:** {{flow_goal}}
|
|
4193
|
-
|
|
4227
|
+
|
|
4194
4228
|
**Entry Points:** {{entry_points}}
|
|
4195
|
-
|
|
4229
|
+
|
|
4196
4230
|
**Success Criteria:** {{success_criteria}}
|
|
4197
4231
|
sections:
|
|
4198
4232
|
- id: flow-diagram
|
|
@@ -4223,14 +4257,14 @@ sections:
|
|
|
4223
4257
|
title: "{{screen_name}}"
|
|
4224
4258
|
template: |
|
|
4225
4259
|
**Purpose:** {{screen_purpose}}
|
|
4226
|
-
|
|
4260
|
+
|
|
4227
4261
|
**Key Elements:**
|
|
4228
4262
|
- {{element_1}}
|
|
4229
4263
|
- {{element_2}}
|
|
4230
4264
|
- {{element_3}}
|
|
4231
|
-
|
|
4265
|
+
|
|
4232
4266
|
**Interaction Notes:** {{interaction_notes}}
|
|
4233
|
-
|
|
4267
|
+
|
|
4234
4268
|
**Design File Reference:** {{specific_frame_link}}
|
|
4235
4269
|
|
|
4236
4270
|
- id: component-library
|
|
@@ -4249,11 +4283,11 @@ sections:
|
|
|
4249
4283
|
title: "{{component_name}}"
|
|
4250
4284
|
template: |
|
|
4251
4285
|
**Purpose:** {{component_purpose}}
|
|
4252
|
-
|
|
4286
|
+
|
|
4253
4287
|
**Variants:** {{component_variants}}
|
|
4254
|
-
|
|
4288
|
+
|
|
4255
4289
|
**States:** {{component_states}}
|
|
4256
|
-
|
|
4290
|
+
|
|
4257
4291
|
**Usage Guidelines:** {{usage_guidelines}}
|
|
4258
4292
|
|
|
4259
4293
|
- id: branding-style
|
|
@@ -4299,13 +4333,13 @@ sections:
|
|
|
4299
4333
|
title: Iconography
|
|
4300
4334
|
template: |
|
|
4301
4335
|
**Icon Library:** {{icon_library}}
|
|
4302
|
-
|
|
4336
|
+
|
|
4303
4337
|
**Usage Guidelines:** {{icon_guidelines}}
|
|
4304
4338
|
- id: spacing-layout
|
|
4305
4339
|
title: Spacing & Layout
|
|
4306
4340
|
template: |
|
|
4307
4341
|
**Grid System:** {{grid_system}}
|
|
4308
|
-
|
|
4342
|
+
|
|
4309
4343
|
**Spacing Scale:** {{spacing_scale}}
|
|
4310
4344
|
|
|
4311
4345
|
- id: accessibility
|
|
@@ -4323,12 +4357,12 @@ sections:
|
|
|
4323
4357
|
- Color contrast ratios: {{contrast_requirements}}
|
|
4324
4358
|
- Focus indicators: {{focus_requirements}}
|
|
4325
4359
|
- Text sizing: {{text_requirements}}
|
|
4326
|
-
|
|
4360
|
+
|
|
4327
4361
|
**Interaction:**
|
|
4328
4362
|
- Keyboard navigation: {{keyboard_requirements}}
|
|
4329
4363
|
- Screen reader support: {{screen_reader_requirements}}
|
|
4330
4364
|
- Touch targets: {{touch_requirements}}
|
|
4331
|
-
|
|
4365
|
+
|
|
4332
4366
|
**Content:**
|
|
4333
4367
|
- Alternative text: {{alt_text_requirements}}
|
|
4334
4368
|
- Heading structure: {{heading_requirements}}
|
|
@@ -4355,11 +4389,11 @@ sections:
|
|
|
4355
4389
|
title: Adaptation Patterns
|
|
4356
4390
|
template: |
|
|
4357
4391
|
**Layout Changes:** {{layout_adaptations}}
|
|
4358
|
-
|
|
4392
|
+
|
|
4359
4393
|
**Navigation Changes:** {{nav_adaptations}}
|
|
4360
|
-
|
|
4394
|
+
|
|
4361
4395
|
**Content Priority:** {{content_adaptations}}
|
|
4362
|
-
|
|
4396
|
+
|
|
4363
4397
|
**Interaction Changes:** {{interaction_adaptations}}
|
|
4364
4398
|
|
|
4365
4399
|
- id: animation
|
|
@@ -4393,7 +4427,7 @@ sections:
|
|
|
4393
4427
|
title: Next Steps
|
|
4394
4428
|
instruction: |
|
|
4395
4429
|
After completing the UI/UX specification:
|
|
4396
|
-
|
|
4430
|
+
|
|
4397
4431
|
1. Recommend review with stakeholders
|
|
4398
4432
|
2. Suggest creating/updating visual designs in design tool
|
|
4399
4433
|
3. Prepare for handoff to Design Architect for frontend architecture
|
|
@@ -4420,6 +4454,7 @@ sections:
|
|
|
4420
4454
|
==================== END: .xiaoma-core/templates/front-end-spec-tmpl.yaml ====================
|
|
4421
4455
|
|
|
4422
4456
|
==================== START: .xiaoma-core/templates/fullstack-architecture-tmpl.yaml ====================
|
|
4457
|
+
# <!-- Powered by BMAD™ Core -->
|
|
4423
4458
|
template:
|
|
4424
4459
|
id: fullstack-architecture-template-v2
|
|
4425
4460
|
name: Fullstack Architecture Document
|
|
@@ -4441,33 +4476,33 @@ sections:
|
|
|
4441
4476
|
elicit: true
|
|
4442
4477
|
content: |
|
|
4443
4478
|
This document outlines the complete fullstack architecture for {{project_name}}, including backend systems, frontend implementation, and their integration. It serves as the single source of truth for AI-driven development, ensuring consistency across the entire technology stack.
|
|
4444
|
-
|
|
4479
|
+
|
|
4445
4480
|
This unified approach combines what would traditionally be separate backend and frontend architecture documents, streamlining the development process for modern fullstack applications where these concerns are increasingly intertwined.
|
|
4446
4481
|
sections:
|
|
4447
4482
|
- id: starter-template
|
|
4448
4483
|
title: Starter Template or Existing Project
|
|
4449
4484
|
instruction: |
|
|
4450
4485
|
Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases:
|
|
4451
|
-
|
|
4486
|
+
|
|
4452
4487
|
1. Review the PRD and other documents for mentions of:
|
|
4453
4488
|
- Fullstack starter templates (e.g., T3 Stack, MEAN/MERN starters, Django + React templates)
|
|
4454
4489
|
- Monorepo templates (e.g., Nx, Turborepo starters)
|
|
4455
4490
|
- Platform-specific starters (e.g., Vercel templates, AWS Amplify starters)
|
|
4456
4491
|
- Existing projects being extended or cloned
|
|
4457
|
-
|
|
4492
|
+
|
|
4458
4493
|
2. If starter templates or existing projects are mentioned:
|
|
4459
4494
|
- Ask the user to provide access (links, repos, or files)
|
|
4460
4495
|
- Analyze to understand pre-configured choices and constraints
|
|
4461
4496
|
- Note any architectural decisions already made
|
|
4462
4497
|
- Identify what can be modified vs what must be retained
|
|
4463
|
-
|
|
4498
|
+
|
|
4464
4499
|
3. If no starter is mentioned but this is greenfield:
|
|
4465
4500
|
- Suggest appropriate fullstack starters based on tech preferences
|
|
4466
4501
|
- Consider platform-specific options (Vercel, AWS, etc.)
|
|
4467
4502
|
- Let user decide whether to use one
|
|
4468
|
-
|
|
4503
|
+
|
|
4469
4504
|
4. Document the decision and any constraints it imposes
|
|
4470
|
-
|
|
4505
|
+
|
|
4471
4506
|
If none, state "N/A - Greenfield project"
|
|
4472
4507
|
- id: changelog
|
|
4473
4508
|
title: Change Log
|
|
@@ -4493,17 +4528,17 @@ sections:
|
|
|
4493
4528
|
title: Platform and Infrastructure Choice
|
|
4494
4529
|
instruction: |
|
|
4495
4530
|
Based on PRD requirements and technical assumptions, make a platform recommendation:
|
|
4496
|
-
|
|
4531
|
+
|
|
4497
4532
|
1. Consider common patterns (not an exhaustive list, use your own best judgement and search the web as needed for emerging trends):
|
|
4498
4533
|
- **Vercel + Supabase**: For rapid development with Next.js, built-in auth/storage
|
|
4499
4534
|
- **AWS Full Stack**: For enterprise scale with Lambda, API Gateway, S3, Cognito
|
|
4500
4535
|
- **Azure**: For .NET ecosystems or enterprise Microsoft environments
|
|
4501
4536
|
- **Google Cloud**: For ML/AI heavy applications or Google ecosystem integration
|
|
4502
|
-
|
|
4537
|
+
|
|
4503
4538
|
2. Present 2-3 viable options with clear pros/cons
|
|
4504
4539
|
3. Make a recommendation with rationale
|
|
4505
4540
|
4. Get explicit user confirmation
|
|
4506
|
-
|
|
4541
|
+
|
|
4507
4542
|
Document the choice and key services that will be used.
|
|
4508
4543
|
template: |
|
|
4509
4544
|
**Platform:** {{selected_platform}}
|
|
@@ -4513,7 +4548,7 @@ sections:
|
|
|
4513
4548
|
title: Repository Structure
|
|
4514
4549
|
instruction: |
|
|
4515
4550
|
Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure:
|
|
4516
|
-
|
|
4551
|
+
|
|
4517
4552
|
1. For modern fullstack apps, monorepo is often preferred
|
|
4518
4553
|
2. Consider tooling (Nx, Turborepo, Lerna, npm workspaces)
|
|
4519
4554
|
3. Define package/app boundaries
|
|
@@ -4535,7 +4570,7 @@ sections:
|
|
|
4535
4570
|
- Databases and storage
|
|
4536
4571
|
- External integrations
|
|
4537
4572
|
- CDN and caching layers
|
|
4538
|
-
|
|
4573
|
+
|
|
4539
4574
|
Use appropriate diagram type for clarity.
|
|
4540
4575
|
- id: architectural-patterns
|
|
4541
4576
|
title: Architectural Patterns
|
|
@@ -4545,7 +4580,7 @@ sections:
|
|
|
4545
4580
|
- Frontend patterns (e.g., Component-based, State management)
|
|
4546
4581
|
- Backend patterns (e.g., Repository, CQRS, Event-driven)
|
|
4547
4582
|
- Integration patterns (e.g., BFF, API Gateway)
|
|
4548
|
-
|
|
4583
|
+
|
|
4549
4584
|
For each pattern, provide recommendation and rationale.
|
|
4550
4585
|
repeatable: true
|
|
4551
4586
|
template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
|
|
@@ -4559,7 +4594,7 @@ sections:
|
|
|
4559
4594
|
title: Tech Stack
|
|
4560
4595
|
instruction: |
|
|
4561
4596
|
This is the DEFINITIVE technology selection for the entire project. Work with user to finalize all choices. This table is the single source of truth - all development must use these exact versions.
|
|
4562
|
-
|
|
4597
|
+
|
|
4563
4598
|
Key areas to cover:
|
|
4564
4599
|
- Frontend and backend languages/frameworks
|
|
4565
4600
|
- Databases and caching
|
|
@@ -4568,7 +4603,7 @@ sections:
|
|
|
4568
4603
|
- Testing tools for both frontend and backend
|
|
4569
4604
|
- Build and deployment tools
|
|
4570
4605
|
- Monitoring and logging
|
|
4571
|
-
|
|
4606
|
+
|
|
4572
4607
|
Upon render, elicit feedback immediately.
|
|
4573
4608
|
elicit: true
|
|
4574
4609
|
sections:
|
|
@@ -4578,11 +4613,29 @@ sections:
|
|
|
4578
4613
|
columns: [Category, Technology, Version, Purpose, Rationale]
|
|
4579
4614
|
rows:
|
|
4580
4615
|
- ["Frontend Language", "{{fe_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4581
|
-
- [
|
|
4582
|
-
|
|
4616
|
+
- [
|
|
4617
|
+
"Frontend Framework",
|
|
4618
|
+
"{{fe_framework}}",
|
|
4619
|
+
"{{version}}",
|
|
4620
|
+
"{{purpose}}",
|
|
4621
|
+
"{{why_chosen}}",
|
|
4622
|
+
]
|
|
4623
|
+
- [
|
|
4624
|
+
"UI Component Library",
|
|
4625
|
+
"{{ui_library}}",
|
|
4626
|
+
"{{version}}",
|
|
4627
|
+
"{{purpose}}",
|
|
4628
|
+
"{{why_chosen}}",
|
|
4629
|
+
]
|
|
4583
4630
|
- ["State Management", "{{state_mgmt}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4584
4631
|
- ["Backend Language", "{{be_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4585
|
-
- [
|
|
4632
|
+
- [
|
|
4633
|
+
"Backend Framework",
|
|
4634
|
+
"{{be_framework}}",
|
|
4635
|
+
"{{version}}",
|
|
4636
|
+
"{{purpose}}",
|
|
4637
|
+
"{{why_chosen}}",
|
|
4638
|
+
]
|
|
4586
4639
|
- ["API Style", "{{api_style}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4587
4640
|
- ["Database", "{{database}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4588
4641
|
- ["Cache", "{{cache}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
@@ -4603,14 +4656,14 @@ sections:
|
|
|
4603
4656
|
title: Data Models
|
|
4604
4657
|
instruction: |
|
|
4605
4658
|
Define the core data models/entities that will be shared between frontend and backend:
|
|
4606
|
-
|
|
4659
|
+
|
|
4607
4660
|
1. Review PRD requirements and identify key business entities
|
|
4608
4661
|
2. For each model, explain its purpose and relationships
|
|
4609
4662
|
3. Include key attributes and data types
|
|
4610
4663
|
4. Show relationships between models
|
|
4611
4664
|
5. Create TypeScript interfaces that can be shared
|
|
4612
4665
|
6. Discuss design decisions with user
|
|
4613
|
-
|
|
4666
|
+
|
|
4614
4667
|
Create a clear conceptual model before moving to database schema.
|
|
4615
4668
|
elicit: true
|
|
4616
4669
|
repeatable: true
|
|
@@ -4619,7 +4672,7 @@ sections:
|
|
|
4619
4672
|
title: "{{model_name}}"
|
|
4620
4673
|
template: |
|
|
4621
4674
|
**Purpose:** {{model_purpose}}
|
|
4622
|
-
|
|
4675
|
+
|
|
4623
4676
|
**Key Attributes:**
|
|
4624
4677
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
4625
4678
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
@@ -4638,7 +4691,7 @@ sections:
|
|
|
4638
4691
|
title: API Specification
|
|
4639
4692
|
instruction: |
|
|
4640
4693
|
Based on the chosen API style from Tech Stack:
|
|
4641
|
-
|
|
4694
|
+
|
|
4642
4695
|
1. If REST API, create an OpenAPI 3.0 specification
|
|
4643
4696
|
2. If GraphQL, provide the GraphQL schema
|
|
4644
4697
|
3. If tRPC, show router definitions
|
|
@@ -4646,7 +4699,7 @@ sections:
|
|
|
4646
4699
|
5. Define request/response schemas based on data models
|
|
4647
4700
|
6. Document authentication requirements
|
|
4648
4701
|
7. Include example requests/responses
|
|
4649
|
-
|
|
4702
|
+
|
|
4650
4703
|
Use appropriate format for the chosen API style. If no API (e.g., static site), skip this section.
|
|
4651
4704
|
elicit: true
|
|
4652
4705
|
sections:
|
|
@@ -4681,7 +4734,7 @@ sections:
|
|
|
4681
4734
|
title: Components
|
|
4682
4735
|
instruction: |
|
|
4683
4736
|
Based on the architectural patterns, tech stack, and data models from above:
|
|
4684
|
-
|
|
4737
|
+
|
|
4685
4738
|
1. Identify major logical components/services across the fullstack
|
|
4686
4739
|
2. Consider both frontend and backend components
|
|
4687
4740
|
3. Define clear boundaries and interfaces between components
|
|
@@ -4690,7 +4743,7 @@ sections:
|
|
|
4690
4743
|
- Key interfaces/APIs exposed
|
|
4691
4744
|
- Dependencies on other components
|
|
4692
4745
|
- Technology specifics based on tech stack choices
|
|
4693
|
-
|
|
4746
|
+
|
|
4694
4747
|
5. Create component diagrams where helpful
|
|
4695
4748
|
elicit: true
|
|
4696
4749
|
sections:
|
|
@@ -4699,13 +4752,13 @@ sections:
|
|
|
4699
4752
|
title: "{{component_name}}"
|
|
4700
4753
|
template: |
|
|
4701
4754
|
**Responsibility:** {{component_description}}
|
|
4702
|
-
|
|
4755
|
+
|
|
4703
4756
|
**Key Interfaces:**
|
|
4704
4757
|
- {{interface_1}}
|
|
4705
4758
|
- {{interface_2}}
|
|
4706
|
-
|
|
4759
|
+
|
|
4707
4760
|
**Dependencies:** {{dependencies}}
|
|
4708
|
-
|
|
4761
|
+
|
|
4709
4762
|
**Technology Stack:** {{component_tech_details}}
|
|
4710
4763
|
- id: component-diagrams
|
|
4711
4764
|
title: Component Diagrams
|
|
@@ -4722,13 +4775,13 @@ sections:
|
|
|
4722
4775
|
condition: Project requires external API integrations
|
|
4723
4776
|
instruction: |
|
|
4724
4777
|
For each external service integration:
|
|
4725
|
-
|
|
4778
|
+
|
|
4726
4779
|
1. Identify APIs needed based on PRD requirements and component design
|
|
4727
4780
|
2. If documentation URLs are unknown, ask user for specifics
|
|
4728
4781
|
3. Document authentication methods and security considerations
|
|
4729
4782
|
4. List specific endpoints that will be used
|
|
4730
4783
|
5. Note any rate limits or usage constraints
|
|
4731
|
-
|
|
4784
|
+
|
|
4732
4785
|
If no external APIs are needed, state this explicitly and skip to next section.
|
|
4733
4786
|
elicit: true
|
|
4734
4787
|
repeatable: true
|
|
@@ -4741,10 +4794,10 @@ sections:
|
|
|
4741
4794
|
- **Base URL(s):** {{api_base_url}}
|
|
4742
4795
|
- **Authentication:** {{auth_method}}
|
|
4743
4796
|
- **Rate Limits:** {{rate_limits}}
|
|
4744
|
-
|
|
4797
|
+
|
|
4745
4798
|
**Key Endpoints Used:**
|
|
4746
4799
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
4747
|
-
|
|
4800
|
+
|
|
4748
4801
|
**Integration Notes:** {{integration_considerations}}
|
|
4749
4802
|
|
|
4750
4803
|
- id: core-workflows
|
|
@@ -4753,14 +4806,14 @@ sections:
|
|
|
4753
4806
|
mermaid_type: sequence
|
|
4754
4807
|
instruction: |
|
|
4755
4808
|
Illustrate key system workflows using sequence diagrams:
|
|
4756
|
-
|
|
4809
|
+
|
|
4757
4810
|
1. Identify critical user journeys from PRD
|
|
4758
4811
|
2. Show component interactions including external APIs
|
|
4759
4812
|
3. Include both frontend and backend flows
|
|
4760
4813
|
4. Include error handling paths
|
|
4761
4814
|
5. Document async operations
|
|
4762
4815
|
6. Create both high-level and detailed diagrams as needed
|
|
4763
|
-
|
|
4816
|
+
|
|
4764
4817
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
|
4765
4818
|
elicit: true
|
|
4766
4819
|
|
|
@@ -4768,13 +4821,13 @@ sections:
|
|
|
4768
4821
|
title: Database Schema
|
|
4769
4822
|
instruction: |
|
|
4770
4823
|
Transform the conceptual data models into concrete database schemas:
|
|
4771
|
-
|
|
4824
|
+
|
|
4772
4825
|
1. Use the database type(s) selected in Tech Stack
|
|
4773
4826
|
2. Create schema definitions using appropriate notation
|
|
4774
4827
|
3. Include indexes, constraints, and relationships
|
|
4775
4828
|
4. Consider performance and scalability
|
|
4776
4829
|
5. For NoSQL, show document structures
|
|
4777
|
-
|
|
4830
|
+
|
|
4778
4831
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
|
4779
4832
|
elicit: true
|
|
4780
4833
|
|
|
@@ -4910,60 +4963,60 @@ sections:
|
|
|
4910
4963
|
type: code
|
|
4911
4964
|
language: plaintext
|
|
4912
4965
|
examples:
|
|
4913
|
-
|
|
4914
|
-
|
|
4915
|
-
|
|
4916
|
-
|
|
4917
|
-
|
|
4918
|
-
|
|
4919
|
-
|
|
4920
|
-
|
|
4921
|
-
|
|
4922
|
-
|
|
4923
|
-
|
|
4924
|
-
|
|
4925
|
-
|
|
4926
|
-
|
|
4927
|
-
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
|
|
4932
|
-
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
|
|
4937
|
-
|
|
4938
|
-
|
|
4939
|
-
|
|
4940
|
-
|
|
4941
|
-
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
|
|
4948
|
-
|
|
4949
|
-
|
|
4950
|
-
|
|
4951
|
-
|
|
4952
|
-
|
|
4953
|
-
|
|
4954
|
-
|
|
4955
|
-
|
|
4956
|
-
|
|
4957
|
-
|
|
4958
|
-
|
|
4959
|
-
|
|
4960
|
-
|
|
4961
|
-
|
|
4962
|
-
|
|
4963
|
-
|
|
4964
|
-
|
|
4965
|
-
|
|
4966
|
-
|
|
4966
|
+
- |
|
|
4967
|
+
{{project-name}}/
|
|
4968
|
+
├── .github/ # CI/CD workflows
|
|
4969
|
+
│ └── workflows/
|
|
4970
|
+
│ ├── ci.yaml
|
|
4971
|
+
│ └── deploy.yaml
|
|
4972
|
+
├── apps/ # Application packages
|
|
4973
|
+
│ ├── web/ # Frontend application
|
|
4974
|
+
│ │ ├── src/
|
|
4975
|
+
│ │ │ ├── components/ # UI components
|
|
4976
|
+
│ │ │ ├── pages/ # Page components/routes
|
|
4977
|
+
│ │ │ ├── hooks/ # Custom React hooks
|
|
4978
|
+
│ │ │ ├── services/ # API client services
|
|
4979
|
+
│ │ │ ├── stores/ # State management
|
|
4980
|
+
│ │ │ ├── styles/ # Global styles/themes
|
|
4981
|
+
│ │ │ └── utils/ # Frontend utilities
|
|
4982
|
+
│ │ ├── public/ # Static assets
|
|
4983
|
+
│ │ ├── tests/ # Frontend tests
|
|
4984
|
+
│ │ └── package.json
|
|
4985
|
+
│ └── api/ # Backend application
|
|
4986
|
+
│ ├── src/
|
|
4987
|
+
│ │ ├── routes/ # API routes/controllers
|
|
4988
|
+
│ │ ├── services/ # Business logic
|
|
4989
|
+
│ │ ├── models/ # Data models
|
|
4990
|
+
│ │ ├── middleware/ # Express/API middleware
|
|
4991
|
+
│ │ ├── utils/ # Backend utilities
|
|
4992
|
+
│ │ └── {{serverless_or_server_entry}}
|
|
4993
|
+
│ ├── tests/ # Backend tests
|
|
4994
|
+
│ └── package.json
|
|
4995
|
+
├── packages/ # Shared packages
|
|
4996
|
+
│ ├── shared/ # Shared types/utilities
|
|
4997
|
+
│ │ ├── src/
|
|
4998
|
+
│ │ │ ├── types/ # TypeScript interfaces
|
|
4999
|
+
│ │ │ ├── constants/ # Shared constants
|
|
5000
|
+
│ │ │ └── utils/ # Shared utilities
|
|
5001
|
+
│ │ └── package.json
|
|
5002
|
+
│ ├── ui/ # Shared UI components
|
|
5003
|
+
│ │ ├── src/
|
|
5004
|
+
│ │ └── package.json
|
|
5005
|
+
│ └── config/ # Shared configuration
|
|
5006
|
+
│ ├── eslint/
|
|
5007
|
+
│ ├── typescript/
|
|
5008
|
+
│ └── jest/
|
|
5009
|
+
├── infrastructure/ # IaC definitions
|
|
5010
|
+
│ └── {{iac_structure}}
|
|
5011
|
+
├── scripts/ # Build/deploy scripts
|
|
5012
|
+
├── docs/ # Documentation
|
|
5013
|
+
│ ├── prd.md
|
|
5014
|
+
│ ├── front-end-spec.md
|
|
5015
|
+
│ └── fullstack-architecture.md
|
|
5016
|
+
├── .env.example # Environment template
|
|
5017
|
+
├── package.json # Root package.json
|
|
5018
|
+
├── {{monorepo_config}} # Monorepo configuration
|
|
5019
|
+
└── README.md
|
|
4967
5020
|
|
|
4968
5021
|
- id: development-workflow
|
|
4969
5022
|
title: Development Workflow
|
|
@@ -4990,13 +5043,13 @@ sections:
|
|
|
4990
5043
|
template: |
|
|
4991
5044
|
# Start all services
|
|
4992
5045
|
{{start_all_command}}
|
|
4993
|
-
|
|
5046
|
+
|
|
4994
5047
|
# Start frontend only
|
|
4995
5048
|
{{start_frontend_command}}
|
|
4996
|
-
|
|
5049
|
+
|
|
4997
5050
|
# Start backend only
|
|
4998
5051
|
{{start_backend_command}}
|
|
4999
|
-
|
|
5052
|
+
|
|
5000
5053
|
# Run tests
|
|
5001
5054
|
{{test_commands}}
|
|
5002
5055
|
- id: environment-config
|
|
@@ -5009,10 +5062,10 @@ sections:
|
|
|
5009
5062
|
template: |
|
|
5010
5063
|
# Frontend (.env.local)
|
|
5011
5064
|
{{frontend_env_vars}}
|
|
5012
|
-
|
|
5065
|
+
|
|
5013
5066
|
# Backend (.env)
|
|
5014
5067
|
{{backend_env_vars}}
|
|
5015
|
-
|
|
5068
|
+
|
|
5016
5069
|
# Shared
|
|
5017
5070
|
{{shared_env_vars}}
|
|
5018
5071
|
|
|
@@ -5029,7 +5082,7 @@ sections:
|
|
|
5029
5082
|
- **Build Command:** {{frontend_build_command}}
|
|
5030
5083
|
- **Output Directory:** {{frontend_output_dir}}
|
|
5031
5084
|
- **CDN/Edge:** {{cdn_strategy}}
|
|
5032
|
-
|
|
5085
|
+
|
|
5033
5086
|
**Backend Deployment:**
|
|
5034
5087
|
- **Platform:** {{backend_deploy_platform}}
|
|
5035
5088
|
- **Build Command:** {{backend_build_command}}
|
|
@@ -5060,12 +5113,12 @@ sections:
|
|
|
5060
5113
|
- CSP Headers: {{csp_policy}}
|
|
5061
5114
|
- XSS Prevention: {{xss_strategy}}
|
|
5062
5115
|
- Secure Storage: {{storage_strategy}}
|
|
5063
|
-
|
|
5116
|
+
|
|
5064
5117
|
**Backend Security:**
|
|
5065
5118
|
- Input Validation: {{validation_approach}}
|
|
5066
5119
|
- Rate Limiting: {{rate_limit_config}}
|
|
5067
5120
|
- CORS Policy: {{cors_config}}
|
|
5068
|
-
|
|
5121
|
+
|
|
5069
5122
|
**Authentication Security:**
|
|
5070
5123
|
- Token Storage: {{token_strategy}}
|
|
5071
5124
|
- Session Management: {{session_approach}}
|
|
@@ -5077,7 +5130,7 @@ sections:
|
|
|
5077
5130
|
- Bundle Size Target: {{bundle_size}}
|
|
5078
5131
|
- Loading Strategy: {{loading_approach}}
|
|
5079
5132
|
- Caching Strategy: {{fe_cache_strategy}}
|
|
5080
|
-
|
|
5133
|
+
|
|
5081
5134
|
**Backend Performance:**
|
|
5082
5135
|
- Response Time Target: {{response_target}}
|
|
5083
5136
|
- Database Optimization: {{db_optimization}}
|
|
@@ -5093,10 +5146,10 @@ sections:
|
|
|
5093
5146
|
type: code
|
|
5094
5147
|
language: text
|
|
5095
5148
|
template: |
|
|
5096
|
-
|
|
5097
|
-
|
|
5098
|
-
|
|
5099
|
-
|
|
5149
|
+
E2E Tests
|
|
5150
|
+
/ \
|
|
5151
|
+
Integration Tests
|
|
5152
|
+
/ \
|
|
5100
5153
|
Frontend Unit Backend Unit
|
|
5101
5154
|
- id: test-organization
|
|
5102
5155
|
title: Test Organization
|
|
@@ -5215,7 +5268,7 @@ sections:
|
|
|
5215
5268
|
- JavaScript errors
|
|
5216
5269
|
- API response times
|
|
5217
5270
|
- User interactions
|
|
5218
|
-
|
|
5271
|
+
|
|
5219
5272
|
**Backend Metrics:**
|
|
5220
5273
|
- Request rate
|
|
5221
5274
|
- Error rate
|
|
@@ -5228,6 +5281,7 @@ sections:
|
|
|
5228
5281
|
==================== END: .xiaoma-core/templates/fullstack-architecture-tmpl.yaml ====================
|
|
5229
5282
|
|
|
5230
5283
|
==================== START: .xiaoma-core/templates/market-research-tmpl.yaml ====================
|
|
5284
|
+
# <!-- Powered by BMAD™ Core -->
|
|
5231
5285
|
template:
|
|
5232
5286
|
id: market-research-template-v2
|
|
5233
5287
|
name: Market Research Report
|
|
@@ -5360,7 +5414,7 @@ sections:
|
|
|
5360
5414
|
instruction: Map the end-to-end customer experience for primary segments
|
|
5361
5415
|
template: |
|
|
5362
5416
|
For primary customer segment:
|
|
5363
|
-
|
|
5417
|
+
|
|
5364
5418
|
1. **Awareness:** {{discovery_process}}
|
|
5365
5419
|
2. **Consideration:** {{evaluation_criteria}}
|
|
5366
5420
|
3. **Purchase:** {{decision_triggers}}
|
|
@@ -5483,6 +5537,7 @@ sections:
|
|
|
5483
5537
|
==================== END: .xiaoma-core/templates/market-research-tmpl.yaml ====================
|
|
5484
5538
|
|
|
5485
5539
|
==================== START: .xiaoma-core/templates/prd-tmpl.yaml ====================
|
|
5540
|
+
# <!-- Powered by BMAD™ Core -->
|
|
5486
5541
|
template:
|
|
5487
5542
|
id: prd-template-v2
|
|
5488
5543
|
name: Product Requirements Document
|
|
@@ -5541,7 +5596,7 @@ sections:
|
|
|
5541
5596
|
condition: PRD has UX/UI requirements
|
|
5542
5597
|
instruction: |
|
|
5543
5598
|
Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
|
|
5544
|
-
|
|
5599
|
+
|
|
5545
5600
|
1. Pre-fill all subsections with educated guesses based on project context
|
|
5546
5601
|
2. Present the complete rendered section to user
|
|
5547
5602
|
3. Clearly let the user know where assumptions were made
|
|
@@ -5583,7 +5638,7 @@ sections:
|
|
|
5583
5638
|
title: Technical Assumptions
|
|
5584
5639
|
instruction: |
|
|
5585
5640
|
Gather technical decisions that will guide the Architect. Steps:
|
|
5586
|
-
|
|
5641
|
+
|
|
5587
5642
|
1. Check if .xiaoma-core/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
|
|
5588
5643
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
|
5589
5644
|
3. For unknowns, offer guidance based on project goals and MVP scope
|
|
@@ -5611,9 +5666,9 @@ sections:
|
|
|
5611
5666
|
title: Epic List
|
|
5612
5667
|
instruction: |
|
|
5613
5668
|
Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
|
|
5614
|
-
|
|
5669
|
+
|
|
5615
5670
|
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
|
5616
|
-
|
|
5671
|
+
|
|
5617
5672
|
- Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
|
|
5618
5673
|
- Epic 1 must establish foundational project infrastructure (app setup, Git, CI/CD, core services) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, even as simple as a health-check route or display of a simple canary page - remember this when we produce the stories for the first epic!
|
|
5619
5674
|
- Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
|
|
@@ -5632,11 +5687,11 @@ sections:
|
|
|
5632
5687
|
repeatable: true
|
|
5633
5688
|
instruction: |
|
|
5634
5689
|
After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
|
|
5635
|
-
|
|
5690
|
+
|
|
5636
5691
|
For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
|
|
5637
|
-
|
|
5692
|
+
|
|
5638
5693
|
CRITICAL STORY SEQUENCING REQUIREMENTS:
|
|
5639
|
-
|
|
5694
|
+
|
|
5640
5695
|
- Stories within each epic MUST be logically sequential
|
|
5641
5696
|
- Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
|
|
5642
5697
|
- No story should depend on work from a later story or epic
|
|
@@ -5664,7 +5719,7 @@ sections:
|
|
|
5664
5719
|
repeatable: true
|
|
5665
5720
|
instruction: |
|
|
5666
5721
|
Define clear, comprehensive, and testable acceptance criteria that:
|
|
5667
|
-
|
|
5722
|
+
|
|
5668
5723
|
- Precisely define what "done" means from a functional perspective
|
|
5669
5724
|
- Are unambiguous and serve as basis for verification
|
|
5670
5725
|
- Include any critical non-functional requirements from the PRD
|
|
@@ -5688,6 +5743,7 @@ sections:
|
|
|
5688
5743
|
==================== END: .xiaoma-core/templates/prd-tmpl.yaml ====================
|
|
5689
5744
|
|
|
5690
5745
|
==================== START: .xiaoma-core/templates/project-brief-tmpl.yaml ====================
|
|
5746
|
+
# <!-- Powered by BMAD™ Core -->
|
|
5691
5747
|
template:
|
|
5692
5748
|
id: project-brief-template-v2
|
|
5693
5749
|
name: Project Brief
|
|
@@ -5718,12 +5774,12 @@ sections:
|
|
|
5718
5774
|
- id: introduction
|
|
5719
5775
|
instruction: |
|
|
5720
5776
|
This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
5721
|
-
|
|
5777
|
+
|
|
5722
5778
|
Start by asking the user which mode they prefer:
|
|
5723
|
-
|
|
5779
|
+
|
|
5724
5780
|
1. **Interactive Mode** - Work through each section collaboratively
|
|
5725
5781
|
2. **YOLO Mode** - Generate complete draft for review and refinement
|
|
5726
|
-
|
|
5782
|
+
|
|
5727
5783
|
Before beginning, understand what inputs are available (brainstorming results, market research, competitive analysis, initial ideas) and gather project context.
|
|
5728
5784
|
|
|
5729
5785
|
- id: executive-summary
|
|
@@ -5912,6 +5968,7 @@ sections:
|
|
|
5912
5968
|
==================== END: .xiaoma-core/templates/project-brief-tmpl.yaml ====================
|
|
5913
5969
|
|
|
5914
5970
|
==================== START: .xiaoma-core/templates/story-tmpl.yaml ====================
|
|
5971
|
+
# <!-- Powered by BMAD™ Core -->
|
|
5915
5972
|
template:
|
|
5916
5973
|
id: story-template-v2
|
|
5917
5974
|
name: Story Document
|
|
@@ -5926,7 +5983,7 @@ workflow:
|
|
|
5926
5983
|
elicitation: advanced-elicitation
|
|
5927
5984
|
|
|
5928
5985
|
agent_config:
|
|
5929
|
-
editable_sections:
|
|
5986
|
+
editable_sections:
|
|
5930
5987
|
- Status
|
|
5931
5988
|
- Story
|
|
5932
5989
|
- Acceptance Criteria
|
|
@@ -5943,7 +6000,7 @@ sections:
|
|
|
5943
6000
|
instruction: Select the current status of the story
|
|
5944
6001
|
owner: scrum-master
|
|
5945
6002
|
editors: [scrum-master, dev-agent]
|
|
5946
|
-
|
|
6003
|
+
|
|
5947
6004
|
- id: story
|
|
5948
6005
|
title: Story
|
|
5949
6006
|
type: template-text
|
|
@@ -5955,7 +6012,7 @@ sections:
|
|
|
5955
6012
|
elicit: true
|
|
5956
6013
|
owner: scrum-master
|
|
5957
6014
|
editors: [scrum-master]
|
|
5958
|
-
|
|
6015
|
+
|
|
5959
6016
|
- id: acceptance-criteria
|
|
5960
6017
|
title: Acceptance Criteria
|
|
5961
6018
|
type: numbered-list
|
|
@@ -5963,7 +6020,7 @@ sections:
|
|
|
5963
6020
|
elicit: true
|
|
5964
6021
|
owner: scrum-master
|
|
5965
6022
|
editors: [scrum-master]
|
|
5966
|
-
|
|
6023
|
+
|
|
5967
6024
|
- id: tasks-subtasks
|
|
5968
6025
|
title: Tasks / Subtasks
|
|
5969
6026
|
type: bullet-list
|
|
@@ -5980,7 +6037,7 @@ sections:
|
|
|
5980
6037
|
elicit: true
|
|
5981
6038
|
owner: scrum-master
|
|
5982
6039
|
editors: [scrum-master, dev-agent]
|
|
5983
|
-
|
|
6040
|
+
|
|
5984
6041
|
- id: dev-notes
|
|
5985
6042
|
title: Dev Notes
|
|
5986
6043
|
instruction: |
|
|
@@ -6004,7 +6061,7 @@ sections:
|
|
|
6004
6061
|
elicit: true
|
|
6005
6062
|
owner: scrum-master
|
|
6006
6063
|
editors: [scrum-master]
|
|
6007
|
-
|
|
6064
|
+
|
|
6008
6065
|
- id: change-log
|
|
6009
6066
|
title: Change Log
|
|
6010
6067
|
type: table
|
|
@@ -6012,7 +6069,7 @@ sections:
|
|
|
6012
6069
|
instruction: Track changes made to this story document
|
|
6013
6070
|
owner: scrum-master
|
|
6014
6071
|
editors: [scrum-master, dev-agent, qa-agent]
|
|
6015
|
-
|
|
6072
|
+
|
|
6016
6073
|
- id: dev-agent-record
|
|
6017
6074
|
title: Dev Agent Record
|
|
6018
6075
|
instruction: This section is populated by the development agent during implementation
|
|
@@ -6025,25 +6082,25 @@ sections:
|
|
|
6025
6082
|
instruction: Record the specific AI agent model and version used for development
|
|
6026
6083
|
owner: dev-agent
|
|
6027
6084
|
editors: [dev-agent]
|
|
6028
|
-
|
|
6085
|
+
|
|
6029
6086
|
- id: debug-log-references
|
|
6030
6087
|
title: Debug Log References
|
|
6031
6088
|
instruction: Reference any debug logs or traces generated during development
|
|
6032
6089
|
owner: dev-agent
|
|
6033
6090
|
editors: [dev-agent]
|
|
6034
|
-
|
|
6091
|
+
|
|
6035
6092
|
- id: completion-notes
|
|
6036
6093
|
title: Completion Notes List
|
|
6037
6094
|
instruction: Notes about the completion of tasks and any issues encountered
|
|
6038
6095
|
owner: dev-agent
|
|
6039
6096
|
editors: [dev-agent]
|
|
6040
|
-
|
|
6097
|
+
|
|
6041
6098
|
- id: file-list
|
|
6042
6099
|
title: File List
|
|
6043
6100
|
instruction: List all files created, modified, or affected during story implementation
|
|
6044
6101
|
owner: dev-agent
|
|
6045
6102
|
editors: [dev-agent]
|
|
6046
|
-
|
|
6103
|
+
|
|
6047
6104
|
- id: qa-results
|
|
6048
6105
|
title: QA Results
|
|
6049
6106
|
instruction: Results from QA Agent QA review of the completed story implementation
|
|
@@ -6052,6 +6109,8 @@ sections:
|
|
|
6052
6109
|
==================== END: .xiaoma-core/templates/story-tmpl.yaml ====================
|
|
6053
6110
|
|
|
6054
6111
|
==================== START: .xiaoma-core/checklists/architect-checklist.md ====================
|
|
6112
|
+
<!-- Powered by BMAD™ Core -->
|
|
6113
|
+
|
|
6055
6114
|
# Architect Solution Validation Checklist
|
|
6056
6115
|
|
|
6057
6116
|
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
|
|
@@ -6457,33 +6516,28 @@ Ask the user if they want to work through the checklist:
|
|
|
6457
6516
|
Now that you've completed the checklist, generate a comprehensive validation report that includes:
|
|
6458
6517
|
|
|
6459
6518
|
1. Executive Summary
|
|
6460
|
-
|
|
6461
6519
|
- Overall architecture readiness (High/Medium/Low)
|
|
6462
6520
|
- Critical risks identified
|
|
6463
6521
|
- Key strengths of the architecture
|
|
6464
6522
|
- Project type (Full-stack/Frontend/Backend) and sections evaluated
|
|
6465
6523
|
|
|
6466
6524
|
2. Section Analysis
|
|
6467
|
-
|
|
6468
6525
|
- Pass rate for each major section (percentage of items passed)
|
|
6469
6526
|
- Most concerning failures or gaps
|
|
6470
6527
|
- Sections requiring immediate attention
|
|
6471
6528
|
- Note any sections skipped due to project type
|
|
6472
6529
|
|
|
6473
6530
|
3. Risk Assessment
|
|
6474
|
-
|
|
6475
6531
|
- Top 5 risks by severity
|
|
6476
6532
|
- Mitigation recommendations for each
|
|
6477
6533
|
- Timeline impact of addressing issues
|
|
6478
6534
|
|
|
6479
6535
|
4. Recommendations
|
|
6480
|
-
|
|
6481
6536
|
- Must-fix items before development
|
|
6482
6537
|
- Should-fix items for better quality
|
|
6483
6538
|
- Nice-to-have improvements
|
|
6484
6539
|
|
|
6485
6540
|
5. AI Implementation Readiness
|
|
6486
|
-
|
|
6487
6541
|
- Specific concerns for AI agent implementation
|
|
6488
6542
|
- Areas needing additional clarification
|
|
6489
6543
|
- Complexity hotspots to address
|
|
@@ -6498,9 +6552,11 @@ After presenting the report, ask the user if they would like detailed analysis o
|
|
|
6498
6552
|
==================== END: .xiaoma-core/checklists/architect-checklist.md ====================
|
|
6499
6553
|
|
|
6500
6554
|
==================== START: .xiaoma-core/checklists/change-checklist.md ====================
|
|
6555
|
+
<!-- Powered by BMAD™ Core -->
|
|
6556
|
+
|
|
6501
6557
|
# Change Navigation Checklist
|
|
6502
6558
|
|
|
6503
|
-
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the
|
|
6559
|
+
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
|
6504
6560
|
|
|
6505
6561
|
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
|
6506
6562
|
|
|
@@ -6575,7 +6631,7 @@ Think about both immediate and downstream effects.]]
|
|
|
6575
6631
|
|
|
6576
6632
|
## 3. Artifact Conflict & Impact Analysis
|
|
6577
6633
|
|
|
6578
|
-
[[LLM: Documentation drives development in
|
|
6634
|
+
[[LLM: Documentation drives development in BMad. Check each artifact:
|
|
6579
6635
|
|
|
6580
6636
|
1. Does this change invalidate documented decisions?
|
|
6581
6637
|
2. Are architectural assumptions still valid?
|
|
@@ -6683,6 +6739,8 @@ Keep it action-oriented and forward-looking.]]
|
|
|
6683
6739
|
==================== END: .xiaoma-core/checklists/change-checklist.md ====================
|
|
6684
6740
|
|
|
6685
6741
|
==================== START: .xiaoma-core/checklists/pm-checklist.md ====================
|
|
6742
|
+
<!-- Powered by BMAD™ Core -->
|
|
6743
|
+
|
|
6686
6744
|
# Product Manager (PM) Requirements Checklist
|
|
6687
6745
|
|
|
6688
6746
|
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
|
|
@@ -6989,7 +7047,6 @@ Ask the user if they want to work through the checklist:
|
|
|
6989
7047
|
Create a comprehensive validation report that includes:
|
|
6990
7048
|
|
|
6991
7049
|
1. Executive Summary
|
|
6992
|
-
|
|
6993
7050
|
- Overall PRD completeness (percentage)
|
|
6994
7051
|
- MVP scope appropriateness (Too Large/Just Right/Too Small)
|
|
6995
7052
|
- Readiness for architecture phase (Ready/Nearly Ready/Not Ready)
|
|
@@ -6997,26 +7054,22 @@ Create a comprehensive validation report that includes:
|
|
|
6997
7054
|
|
|
6998
7055
|
2. Category Analysis Table
|
|
6999
7056
|
Fill in the actual table with:
|
|
7000
|
-
|
|
7001
7057
|
- Status: PASS (90%+ complete), PARTIAL (60-89%), FAIL (<60%)
|
|
7002
7058
|
- Critical Issues: Specific problems that block progress
|
|
7003
7059
|
|
|
7004
7060
|
3. Top Issues by Priority
|
|
7005
|
-
|
|
7006
7061
|
- BLOCKERS: Must fix before architect can proceed
|
|
7007
7062
|
- HIGH: Should fix for quality
|
|
7008
7063
|
- MEDIUM: Would improve clarity
|
|
7009
7064
|
- LOW: Nice to have
|
|
7010
7065
|
|
|
7011
7066
|
4. MVP Scope Assessment
|
|
7012
|
-
|
|
7013
7067
|
- Features that might be cut for true MVP
|
|
7014
7068
|
- Missing features that are essential
|
|
7015
7069
|
- Complexity concerns
|
|
7016
7070
|
- Timeline realism
|
|
7017
7071
|
|
|
7018
7072
|
5. Technical Readiness
|
|
7019
|
-
|
|
7020
7073
|
- Clarity of technical constraints
|
|
7021
7074
|
- Identified technical risks
|
|
7022
7075
|
- Areas needing architect investigation
|
|
@@ -7061,6 +7114,8 @@ After presenting the report, ask if the user wants:
|
|
|
7061
7114
|
==================== END: .xiaoma-core/checklists/pm-checklist.md ====================
|
|
7062
7115
|
|
|
7063
7116
|
==================== START: .xiaoma-core/checklists/po-master-checklist.md ====================
|
|
7117
|
+
<!-- Powered by BMAD™ Core -->
|
|
7118
|
+
|
|
7064
7119
|
# Product Owner (PO) Master Validation Checklist
|
|
7065
7120
|
|
|
7066
7121
|
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
|
|
@@ -7071,12 +7126,10 @@ PROJECT TYPE DETECTION:
|
|
|
7071
7126
|
First, determine the project type by checking:
|
|
7072
7127
|
|
|
7073
7128
|
1. Is this a GREENFIELD project (new from scratch)?
|
|
7074
|
-
|
|
7075
7129
|
- Look for: New project initialization, no existing codebase references
|
|
7076
7130
|
- Check for: prd.md, architecture.md, new project setup stories
|
|
7077
7131
|
|
|
7078
7132
|
2. Is this a BROWNFIELD project (enhancing existing system)?
|
|
7079
|
-
|
|
7080
7133
|
- Look for: References to existing codebase, enhancement/modification language
|
|
7081
7134
|
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
|
7082
7135
|
|
|
@@ -7410,7 +7463,6 @@ Ask the user if they want to work through the checklist:
|
|
|
7410
7463
|
Generate a comprehensive validation report that adapts to project type:
|
|
7411
7464
|
|
|
7412
7465
|
1. Executive Summary
|
|
7413
|
-
|
|
7414
7466
|
- Project type: [Greenfield/Brownfield] with [UI/No UI]
|
|
7415
7467
|
- Overall readiness (percentage)
|
|
7416
7468
|
- Go/No-Go recommendation
|
|
@@ -7420,42 +7472,36 @@ Generate a comprehensive validation report that adapts to project type:
|
|
|
7420
7472
|
2. Project-Specific Analysis
|
|
7421
7473
|
|
|
7422
7474
|
FOR GREENFIELD:
|
|
7423
|
-
|
|
7424
7475
|
- Setup completeness
|
|
7425
7476
|
- Dependency sequencing
|
|
7426
7477
|
- MVP scope appropriateness
|
|
7427
7478
|
- Development timeline feasibility
|
|
7428
7479
|
|
|
7429
7480
|
FOR BROWNFIELD:
|
|
7430
|
-
|
|
7431
7481
|
- Integration risk level (High/Medium/Low)
|
|
7432
7482
|
- Existing system impact assessment
|
|
7433
7483
|
- Rollback readiness
|
|
7434
7484
|
- User disruption potential
|
|
7435
7485
|
|
|
7436
7486
|
3. Risk Assessment
|
|
7437
|
-
|
|
7438
7487
|
- Top 5 risks by severity
|
|
7439
7488
|
- Mitigation recommendations
|
|
7440
7489
|
- Timeline impact of addressing issues
|
|
7441
7490
|
- [BROWNFIELD] Specific integration risks
|
|
7442
7491
|
|
|
7443
7492
|
4. MVP Completeness
|
|
7444
|
-
|
|
7445
7493
|
- Core features coverage
|
|
7446
7494
|
- Missing essential functionality
|
|
7447
7495
|
- Scope creep identified
|
|
7448
7496
|
- True MVP vs over-engineering
|
|
7449
7497
|
|
|
7450
7498
|
5. Implementation Readiness
|
|
7451
|
-
|
|
7452
7499
|
- Developer clarity score (1-10)
|
|
7453
7500
|
- Ambiguous requirements count
|
|
7454
7501
|
- Missing technical details
|
|
7455
7502
|
- [BROWNFIELD] Integration point clarity
|
|
7456
7503
|
|
|
7457
7504
|
6. Recommendations
|
|
7458
|
-
|
|
7459
7505
|
- Must-fix before development
|
|
7460
7506
|
- Should-fix for quality
|
|
7461
7507
|
- Consider for improvement
|
|
@@ -7505,6 +7551,8 @@ After presenting the report, ask if the user wants:
|
|
|
7505
7551
|
==================== END: .xiaoma-core/checklists/po-master-checklist.md ====================
|
|
7506
7552
|
|
|
7507
7553
|
==================== START: .xiaoma-core/checklists/story-dod-checklist.md ====================
|
|
7554
|
+
<!-- Powered by BMAD™ Core -->
|
|
7555
|
+
|
|
7508
7556
|
# Story Definition of Done (DoD) Checklist
|
|
7509
7557
|
|
|
7510
7558
|
## Instructions for Developer Agent
|
|
@@ -7532,14 +7580,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7532
7580
|
1. **Requirements Met:**
|
|
7533
7581
|
|
|
7534
7582
|
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
7535
|
-
|
|
7536
7583
|
- [ ] All functional requirements specified in the story are implemented.
|
|
7537
7584
|
- [ ] All acceptance criteria defined in the story are met.
|
|
7538
7585
|
|
|
7539
7586
|
2. **Coding Standards & Project Structure:**
|
|
7540
7587
|
|
|
7541
7588
|
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
7542
|
-
|
|
7543
7589
|
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
7544
7590
|
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
7545
7591
|
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
@@ -7551,7 +7597,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7551
7597
|
3. **Testing:**
|
|
7552
7598
|
|
|
7553
7599
|
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
7554
|
-
|
|
7555
7600
|
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
7556
7601
|
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
7557
7602
|
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
@@ -7560,14 +7605,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7560
7605
|
4. **Functionality & Verification:**
|
|
7561
7606
|
|
|
7562
7607
|
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
7563
|
-
|
|
7564
7608
|
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
7565
7609
|
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
7566
7610
|
|
|
7567
7611
|
5. **Story Administration:**
|
|
7568
7612
|
|
|
7569
7613
|
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
7570
|
-
|
|
7571
7614
|
- [ ] All tasks within the story file are marked as complete.
|
|
7572
7615
|
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
7573
7616
|
- [ ] The story wrap up section has been completed with notes of changes or information relevant to the next story or overall project, the agent model that was primarily used during development, and the changelog of any changes is properly updated.
|
|
@@ -7575,7 +7618,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7575
7618
|
6. **Dependencies, Build & Configuration:**
|
|
7576
7619
|
|
|
7577
7620
|
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
7578
|
-
|
|
7579
7621
|
- [ ] Project builds successfully without errors.
|
|
7580
7622
|
- [ ] Project linting passes
|
|
7581
7623
|
- [ ] Any new dependencies added were either pre-approved in the story requirements OR explicitly approved by the user during development (approval documented in story file).
|
|
@@ -7586,7 +7628,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7586
7628
|
7. **Documentation (If Applicable):**
|
|
7587
7629
|
|
|
7588
7630
|
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
7589
|
-
|
|
7590
7631
|
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
7591
7632
|
- [ ] User-facing documentation updated, if changes impact users.
|
|
7592
7633
|
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
@@ -7609,6 +7650,8 @@ Be honest - it's better to flag issues now than have them discovered later.]]
|
|
|
7609
7650
|
==================== END: .xiaoma-core/checklists/story-dod-checklist.md ====================
|
|
7610
7651
|
|
|
7611
7652
|
==================== START: .xiaoma-core/checklists/story-draft-checklist.md ====================
|
|
7653
|
+
<!-- Powered by BMAD™ Core -->
|
|
7654
|
+
|
|
7612
7655
|
# Story Draft Checklist
|
|
7613
7656
|
|
|
7614
7657
|
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
|
@@ -7728,19 +7771,16 @@ Note: We don't need every file listed - just the important ones.]]
|
|
|
7728
7771
|
Generate a concise validation report:
|
|
7729
7772
|
|
|
7730
7773
|
1. Quick Summary
|
|
7731
|
-
|
|
7732
7774
|
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
7733
7775
|
- Clarity score (1-10)
|
|
7734
7776
|
- Major gaps identified
|
|
7735
7777
|
|
|
7736
7778
|
2. Fill in the validation table with:
|
|
7737
|
-
|
|
7738
7779
|
- PASS: Requirements clearly met
|
|
7739
7780
|
- PARTIAL: Some gaps but workable
|
|
7740
7781
|
- FAIL: Critical information missing
|
|
7741
7782
|
|
|
7742
7783
|
3. Specific Issues (if any)
|
|
7743
|
-
|
|
7744
7784
|
- List concrete problems to fix
|
|
7745
7785
|
- Suggest specific improvements
|
|
7746
7786
|
- Identify any blocking dependencies
|
|
@@ -7767,12 +7807,14 @@ Be pragmatic - perfect documentation doesn't exist, but it must be enough to pro
|
|
|
7767
7807
|
- BLOCKED: External information required (specify what information)
|
|
7768
7808
|
==================== END: .xiaoma-core/checklists/story-draft-checklist.md ====================
|
|
7769
7809
|
|
|
7770
|
-
==================== START: .xiaoma-core/data/
|
|
7771
|
-
|
|
7810
|
+
==================== START: .xiaoma-core/data/bmad-kb.md ====================
|
|
7811
|
+
<!-- Powered by BMAD™ Core -->
|
|
7812
|
+
|
|
7813
|
+
# BMAD™ Knowledge Base
|
|
7772
7814
|
|
|
7773
7815
|
## Overview
|
|
7774
7816
|
|
|
7775
|
-
|
|
7817
|
+
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
|
7776
7818
|
|
|
7777
7819
|
### Key Features
|
|
7778
7820
|
|
|
@@ -7782,7 +7824,7 @@ XiaoMa-Method (Breakthrough Method of Agile AI-driven Development) is a framewor
|
|
|
7782
7824
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
7783
7825
|
- **Slash Command Integration**: Quick agent switching and control
|
|
7784
7826
|
|
|
7785
|
-
### When to Use
|
|
7827
|
+
### When to Use BMad
|
|
7786
7828
|
|
|
7787
7829
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
7788
7830
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -7790,11 +7832,11 @@ XiaoMa-Method (Breakthrough Method of Agile AI-driven Development) is a framewor
|
|
|
7790
7832
|
- **Quality Assurance**: Structured testing and validation
|
|
7791
7833
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
7792
7834
|
|
|
7793
|
-
## How
|
|
7835
|
+
## How BMad Works
|
|
7794
7836
|
|
|
7795
7837
|
### The Core Method
|
|
7796
7838
|
|
|
7797
|
-
|
|
7839
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
7798
7840
|
|
|
7799
7841
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
7800
7842
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -7856,7 +7898,7 @@ XiaoMa transforms you into a "Vibe CEO" - directing a team of specialized AI age
|
|
|
7856
7898
|
|
|
7857
7899
|
```bash
|
|
7858
7900
|
# Interactive installation (recommended)
|
|
7859
|
-
npx
|
|
7901
|
+
npx bmad-method install
|
|
7860
7902
|
```
|
|
7861
7903
|
|
|
7862
7904
|
**Installation Steps**:
|
|
@@ -7870,8 +7912,9 @@ npx xiaoma-web install
|
|
|
7870
7912
|
- **Cline**: VS Code extension with AI features
|
|
7871
7913
|
- **Roo Code**: Web-based IDE with agent support
|
|
7872
7914
|
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
|
7915
|
+
- **Auggie CLI (Augment Code)**: AI-powered development environment
|
|
7873
7916
|
|
|
7874
|
-
**Note for VS Code Users**:
|
|
7917
|
+
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
|
7875
7918
|
|
|
7876
7919
|
**Verify Installation**:
|
|
7877
7920
|
|
|
@@ -7879,7 +7922,7 @@ npx xiaoma-web install
|
|
|
7879
7922
|
- IDE-specific integration files created
|
|
7880
7923
|
- All agent commands/rules/modes available
|
|
7881
7924
|
|
|
7882
|
-
**Remember**: At its core,
|
|
7925
|
+
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
|
|
7883
7926
|
|
|
7884
7927
|
### Environment Selection Guide
|
|
7885
7928
|
|
|
@@ -7923,23 +7966,23 @@ npx xiaoma-web install
|
|
|
7923
7966
|
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
|
7924
7967
|
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
|
7925
7968
|
|
|
7926
|
-
**About
|
|
7969
|
+
**About bmad-master and bmad-orchestrator**:
|
|
7927
7970
|
|
|
7928
|
-
- **
|
|
7971
|
+
- **bmad-master**: CAN do any task without switching agents, BUT...
|
|
7929
7972
|
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
|
7930
7973
|
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
|
7931
|
-
- **If using
|
|
7974
|
+
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
|
7932
7975
|
|
|
7933
7976
|
**CRITICAL RULE for Development**:
|
|
7934
7977
|
|
|
7935
|
-
- **ALWAYS use SM agent for story creation** - Never use
|
|
7936
|
-
- **ALWAYS use Dev agent for implementation** - Never use
|
|
7978
|
+
- **ALWAYS use SM agent for story creation** - Never use bmad-master or bmad-orchestrator
|
|
7979
|
+
- **ALWAYS use Dev agent for implementation** - Never use bmad-master or bmad-orchestrator
|
|
7937
7980
|
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
|
7938
|
-
- **No exceptions**: Even if using
|
|
7981
|
+
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
|
7939
7982
|
|
|
7940
7983
|
**Best Practice for IDE-Only**:
|
|
7941
7984
|
|
|
7942
|
-
1. Use PM/Architect/UX agents for planning (better than
|
|
7985
|
+
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
|
7943
7986
|
2. Create documents directly in project
|
|
7944
7987
|
3. Shard immediately after creation
|
|
7945
7988
|
4. **MUST switch to SM agent** for story creation
|
|
@@ -7948,11 +7991,11 @@ npx xiaoma-web install
|
|
|
7948
7991
|
|
|
7949
7992
|
## Core Configuration (core-config.yaml)
|
|
7950
7993
|
|
|
7951
|
-
**New in V4**: The `xiaoma-core/core-config.yaml` file is a critical innovation that enables
|
|
7994
|
+
**New in V4**: The `xiaoma-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
7952
7995
|
|
|
7953
7996
|
### What is core-config.yaml?
|
|
7954
7997
|
|
|
7955
|
-
This configuration file acts as a map for
|
|
7998
|
+
This configuration file acts as a map for BMad agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
7956
7999
|
|
|
7957
8000
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
7958
8001
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -7984,7 +8027,7 @@ This configuration file acts as a map for XiaoMa agents, telling them exactly wh
|
|
|
7984
8027
|
|
|
7985
8028
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
7986
8029
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
7987
|
-
3. **Custom Workflows**: Configure
|
|
8030
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
7988
8031
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
7989
8032
|
|
|
7990
8033
|
### Common Configurations
|
|
@@ -8057,8 +8100,8 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
8057
8100
|
|
|
8058
8101
|
| Agent | Role | Primary Functions | When to Use |
|
|
8059
8102
|
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
|
|
8060
|
-
| `
|
|
8061
|
-
| `
|
|
8103
|
+
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
|
|
8104
|
+
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
|
|
8062
8105
|
|
|
8063
8106
|
### Agent Interaction Commands
|
|
8064
8107
|
|
|
@@ -8066,11 +8109,11 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
8066
8109
|
|
|
8067
8110
|
**Agent Loading by IDE**:
|
|
8068
8111
|
|
|
8069
|
-
- **Claude Code**: `/agent-name` (e.g., `/
|
|
8070
|
-
- **Cursor**: `@agent-name` (e.g., `@
|
|
8071
|
-
- **Windsurf**:
|
|
8072
|
-
- **Trae**: `@agent-name` (e.g., `@
|
|
8073
|
-
- **Roo Code**: Select mode from mode selector (e.g., `
|
|
8112
|
+
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
8113
|
+
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
8114
|
+
- **Windsurf**: `/agent-name` (e.g., `/bmad-master`)
|
|
8115
|
+
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
|
8116
|
+
- **Roo Code**: Select mode from mode selector (e.g., `bmad-master`)
|
|
8074
8117
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
8075
8118
|
|
|
8076
8119
|
**Chat Management Guidelines**:
|
|
@@ -8123,7 +8166,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
8123
8166
|
|
|
8124
8167
|
### System Overview
|
|
8125
8168
|
|
|
8126
|
-
The
|
|
8169
|
+
The BMAD-METHOD™ is built around a modular architecture centered on the `xiaoma-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
|
8127
8170
|
|
|
8128
8171
|
### Key Architectural Components
|
|
8129
8172
|
|
|
@@ -8171,9 +8214,9 @@ The XiaoMa-Method is built around a modular architecture centered on the `xiaoma
|
|
|
8171
8214
|
|
|
8172
8215
|
### Template Processing System
|
|
8173
8216
|
|
|
8174
|
-
|
|
8217
|
+
BMad employs a sophisticated template system with three key components:
|
|
8175
8218
|
|
|
8176
|
-
1. **Template Format** (`utils/
|
|
8219
|
+
1. **Template Format** (`utils/bmad-doc-template.md`): Defines markup language for variable substitution and AI processing directives from yaml templates
|
|
8177
8220
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction to transform yaml spec to final markdown output
|
|
8178
8221
|
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
|
8179
8222
|
|
|
@@ -8195,7 +8238,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
8195
8238
|
3. Concatenating content into single text files with clear separators
|
|
8196
8239
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
8197
8240
|
|
|
8198
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
8241
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
8199
8242
|
|
|
8200
8243
|
## Complete Development Workflow
|
|
8201
8244
|
|
|
@@ -8250,7 +8293,7 @@ that can handle [specific requirements]."
|
|
|
8250
8293
|
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
|
8251
8294
|
- Two methods to shard:
|
|
8252
8295
|
a) **Manual**: Drag `shard-doc` task + document file into chat
|
|
8253
|
-
b) **Agent**: Ask `@
|
|
8296
|
+
b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
|
|
8254
8297
|
- Shards `docs/prd.md` → `docs/prd/` folder
|
|
8255
8298
|
- Shards `docs/architecture.md` → `docs/architecture/` folder
|
|
8256
8299
|
- **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
|
|
@@ -8312,7 +8355,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
8312
8355
|
#### Greenfield Development
|
|
8313
8356
|
|
|
8314
8357
|
- Business analysis and market research
|
|
8315
|
-
- Product requirements and feature definition
|
|
8358
|
+
- Product requirements and feature definition
|
|
8316
8359
|
- System architecture and design
|
|
8317
8360
|
- Development execution
|
|
8318
8361
|
- Testing and deployment
|
|
@@ -8421,8 +8464,11 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
|
8421
8464
|
|
|
8422
8465
|
```markdown
|
|
8423
8466
|
## Goals and Background Context
|
|
8424
|
-
|
|
8467
|
+
|
|
8468
|
+
## Requirements
|
|
8469
|
+
|
|
8425
8470
|
## User Interface Design Goals
|
|
8471
|
+
|
|
8426
8472
|
## Success Metrics
|
|
8427
8473
|
```
|
|
8428
8474
|
|
|
@@ -8462,7 +8508,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
8462
8508
|
|
|
8463
8509
|
### Performance Optimization
|
|
8464
8510
|
|
|
8465
|
-
- Use specific agents vs. `
|
|
8511
|
+
- Use specific agents vs. `bmad-master` for focused tasks
|
|
8466
8512
|
- Choose appropriate team size for project needs
|
|
8467
8513
|
- Leverage technical preferences for consistency
|
|
8468
8514
|
- Regular context management and cache clearing
|
|
@@ -8470,12 +8516,12 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
8470
8516
|
## Success Tips
|
|
8471
8517
|
|
|
8472
8518
|
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
8473
|
-
- **Use
|
|
8519
|
+
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
8474
8520
|
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
8475
8521
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
8476
8522
|
- **Review everything** - Always review and approve before marking complete
|
|
8477
8523
|
|
|
8478
|
-
## Contributing to
|
|
8524
|
+
## Contributing to BMAD-METHOD™
|
|
8479
8525
|
|
|
8480
8526
|
### Quick Contribution Guidelines
|
|
8481
8527
|
|
|
@@ -8507,7 +8553,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
8507
8553
|
|
|
8508
8554
|
### What Are Expansion Packs?
|
|
8509
8555
|
|
|
8510
|
-
Expansion packs extend
|
|
8556
|
+
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
|
8511
8557
|
|
|
8512
8558
|
### Why Use Expansion Packs?
|
|
8513
8559
|
|
|
@@ -8547,7 +8593,7 @@ Expansion packs extend XiaoMa-Method beyond traditional software development int
|
|
|
8547
8593
|
3. **Install via CLI**:
|
|
8548
8594
|
|
|
8549
8595
|
```bash
|
|
8550
|
-
npx
|
|
8596
|
+
npx bmad-method install
|
|
8551
8597
|
# Select "Install expansion pack" option
|
|
8552
8598
|
```
|
|
8553
8599
|
|
|
@@ -8571,9 +8617,11 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8571
8617
|
- **Documentation**: Check `docs/` folder for project-specific context
|
|
8572
8618
|
- **Community**: Discord and GitHub resources available for support
|
|
8573
8619
|
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
|
8574
|
-
==================== END: .xiaoma-core/data/
|
|
8620
|
+
==================== END: .xiaoma-core/data/bmad-kb.md ====================
|
|
8575
8621
|
|
|
8576
8622
|
==================== START: .xiaoma-core/data/brainstorming-techniques.md ====================
|
|
8623
|
+
<!-- Powered by BMAD™ Core -->
|
|
8624
|
+
|
|
8577
8625
|
# Brainstorming Techniques Data
|
|
8578
8626
|
|
|
8579
8627
|
## Creative Expansion
|
|
@@ -8613,21 +8661,26 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8613
8661
|
==================== END: .xiaoma-core/data/brainstorming-techniques.md ====================
|
|
8614
8662
|
|
|
8615
8663
|
==================== START: .xiaoma-core/data/elicitation-methods.md ====================
|
|
8664
|
+
<!-- Powered by BMAD™ Core -->
|
|
8665
|
+
|
|
8616
8666
|
# Elicitation Methods Data
|
|
8617
8667
|
|
|
8618
8668
|
## Core Reflective Methods
|
|
8619
8669
|
|
|
8620
8670
|
**Expand or Contract for Audience**
|
|
8671
|
+
|
|
8621
8672
|
- Ask whether to 'expand' (add detail, elaborate) or 'contract' (simplify, clarify)
|
|
8622
8673
|
- Identify specific target audience if relevant
|
|
8623
8674
|
- Tailor content complexity and depth accordingly
|
|
8624
8675
|
|
|
8625
8676
|
**Explain Reasoning (CoT Step-by-Step)**
|
|
8677
|
+
|
|
8626
8678
|
- Walk through the step-by-step thinking process
|
|
8627
8679
|
- Reveal underlying assumptions and decision points
|
|
8628
8680
|
- Show how conclusions were reached from current role's perspective
|
|
8629
8681
|
|
|
8630
8682
|
**Critique and Refine**
|
|
8683
|
+
|
|
8631
8684
|
- Review output for flaws, inconsistencies, or improvement areas
|
|
8632
8685
|
- Identify specific weaknesses from role's expertise
|
|
8633
8686
|
- Suggest refined version reflecting domain knowledge
|
|
@@ -8635,12 +8688,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8635
8688
|
## Structural Analysis Methods
|
|
8636
8689
|
|
|
8637
8690
|
**Analyze Logical Flow and Dependencies**
|
|
8691
|
+
|
|
8638
8692
|
- Examine content structure for logical progression
|
|
8639
8693
|
- Check internal consistency and coherence
|
|
8640
8694
|
- Identify and validate dependencies between elements
|
|
8641
8695
|
- Confirm effective ordering and sequencing
|
|
8642
8696
|
|
|
8643
8697
|
**Assess Alignment with Overall Goals**
|
|
8698
|
+
|
|
8644
8699
|
- Evaluate content contribution to stated objectives
|
|
8645
8700
|
- Identify any misalignments or gaps
|
|
8646
8701
|
- Interpret alignment from specific role's perspective
|
|
@@ -8649,12 +8704,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8649
8704
|
## Risk and Challenge Methods
|
|
8650
8705
|
|
|
8651
8706
|
**Identify Potential Risks and Unforeseen Issues**
|
|
8707
|
+
|
|
8652
8708
|
- Brainstorm potential risks from role's expertise
|
|
8653
8709
|
- Identify overlooked edge cases or scenarios
|
|
8654
8710
|
- Anticipate unintended consequences
|
|
8655
8711
|
- Highlight implementation challenges
|
|
8656
8712
|
|
|
8657
8713
|
**Challenge from Critical Perspective**
|
|
8714
|
+
|
|
8658
8715
|
- Adopt critical stance on current content
|
|
8659
8716
|
- Play devil's advocate from specified viewpoint
|
|
8660
8717
|
- Argue against proposal highlighting weaknesses
|
|
@@ -8663,12 +8720,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8663
8720
|
## Creative Exploration Methods
|
|
8664
8721
|
|
|
8665
8722
|
**Tree of Thoughts Deep Dive**
|
|
8723
|
+
|
|
8666
8724
|
- Break problem into discrete "thoughts" or intermediate steps
|
|
8667
8725
|
- Explore multiple reasoning paths simultaneously
|
|
8668
8726
|
- Use self-evaluation to classify each path as "sure", "likely", or "impossible"
|
|
8669
8727
|
- Apply search algorithms (BFS/DFS) to find optimal solution paths
|
|
8670
8728
|
|
|
8671
8729
|
**Hindsight is 20/20: The 'If Only...' Reflection**
|
|
8730
|
+
|
|
8672
8731
|
- Imagine retrospective scenario based on current content
|
|
8673
8732
|
- Identify the one "if only we had known/done X..." insight
|
|
8674
8733
|
- Describe imagined consequences humorously or dramatically
|
|
@@ -8677,6 +8736,7 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8677
8736
|
## Multi-Persona Collaboration Methods
|
|
8678
8737
|
|
|
8679
8738
|
**Agile Team Perspective Shift**
|
|
8739
|
+
|
|
8680
8740
|
- Rotate through different Scrum team member viewpoints
|
|
8681
8741
|
- Product Owner: Focus on user value and business impact
|
|
8682
8742
|
- Scrum Master: Examine process flow and team dynamics
|
|
@@ -8684,12 +8744,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8684
8744
|
- QA: Identify testing scenarios and quality concerns
|
|
8685
8745
|
|
|
8686
8746
|
**Stakeholder Round Table**
|
|
8747
|
+
|
|
8687
8748
|
- Convene virtual meeting with multiple personas
|
|
8688
8749
|
- Each persona contributes unique perspective on content
|
|
8689
8750
|
- Identify conflicts and synergies between viewpoints
|
|
8690
8751
|
- Synthesize insights into actionable recommendations
|
|
8691
8752
|
|
|
8692
8753
|
**Meta-Prompting Analysis**
|
|
8754
|
+
|
|
8693
8755
|
- Step back to analyze the structure and logic of current approach
|
|
8694
8756
|
- Question the format and methodology being used
|
|
8695
8757
|
- Suggest alternative frameworks or mental models
|
|
@@ -8698,24 +8760,28 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8698
8760
|
## Advanced 2025 Techniques
|
|
8699
8761
|
|
|
8700
8762
|
**Self-Consistency Validation**
|
|
8763
|
+
|
|
8701
8764
|
- Generate multiple reasoning paths for same problem
|
|
8702
8765
|
- Compare consistency across different approaches
|
|
8703
8766
|
- Identify most reliable and robust solution
|
|
8704
8767
|
- Highlight areas where approaches diverge and why
|
|
8705
8768
|
|
|
8706
8769
|
**ReWOO (Reasoning Without Observation)**
|
|
8770
|
+
|
|
8707
8771
|
- Separate parametric reasoning from tool-based actions
|
|
8708
8772
|
- Create reasoning plan without external dependencies
|
|
8709
8773
|
- Identify what can be solved through pure reasoning
|
|
8710
8774
|
- Optimize for efficiency and reduced token usage
|
|
8711
8775
|
|
|
8712
8776
|
**Persona-Pattern Hybrid**
|
|
8777
|
+
|
|
8713
8778
|
- Combine specific role expertise with elicitation pattern
|
|
8714
8779
|
- Architect + Risk Analysis: Deep technical risk assessment
|
|
8715
8780
|
- UX Expert + User Journey: End-to-end experience critique
|
|
8716
8781
|
- PM + Stakeholder Analysis: Multi-perspective impact review
|
|
8717
8782
|
|
|
8718
8783
|
**Emergent Collaboration Discovery**
|
|
8784
|
+
|
|
8719
8785
|
- Allow multiple perspectives to naturally emerge
|
|
8720
8786
|
- Identify unexpected insights from persona interactions
|
|
8721
8787
|
- Explore novel combinations of viewpoints
|
|
@@ -8724,18 +8790,21 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8724
8790
|
## Game-Based Elicitation Methods
|
|
8725
8791
|
|
|
8726
8792
|
**Red Team vs Blue Team**
|
|
8793
|
+
|
|
8727
8794
|
- Red Team: Attack the proposal, find vulnerabilities
|
|
8728
8795
|
- Blue Team: Defend and strengthen the approach
|
|
8729
8796
|
- Competitive analysis reveals blind spots
|
|
8730
8797
|
- Results in more robust, battle-tested solutions
|
|
8731
8798
|
|
|
8732
8799
|
**Innovation Tournament**
|
|
8800
|
+
|
|
8733
8801
|
- Pit multiple alternative approaches against each other
|
|
8734
8802
|
- Score each approach across different criteria
|
|
8735
8803
|
- Crowd-source evaluation from different personas
|
|
8736
8804
|
- Identify winning combination of features
|
|
8737
8805
|
|
|
8738
8806
|
**Escape Room Challenge**
|
|
8807
|
+
|
|
8739
8808
|
- Present content as constraints to work within
|
|
8740
8809
|
- Find creative solutions within tight limitations
|
|
8741
8810
|
- Identify minimum viable approach
|
|
@@ -8744,12 +8813,15 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8744
8813
|
## Process Control
|
|
8745
8814
|
|
|
8746
8815
|
**Proceed / No Further Actions**
|
|
8816
|
+
|
|
8747
8817
|
- Acknowledge choice to finalize current work
|
|
8748
8818
|
- Accept output as-is or move to next step
|
|
8749
8819
|
- Prepare to continue without additional elicitation
|
|
8750
8820
|
==================== END: .xiaoma-core/data/elicitation-methods.md ====================
|
|
8751
8821
|
|
|
8752
8822
|
==================== START: .xiaoma-core/data/technical-preferences.md ====================
|
|
8823
|
+
<!-- Powered by BMAD™ Core -->
|
|
8824
|
+
|
|
8753
8825
|
# User-Defined Preferred Patterns and Preferences
|
|
8754
8826
|
|
|
8755
8827
|
None Listed
|