bmad-method 4.37.0 → 4.39.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/ISSUE_TEMPLATE/bug_report.md +3 -3
- package/.github/ISSUE_TEMPLATE/feature_request.md +3 -3
- package/.github/workflows/discord.yaml +11 -2
- package/.github/workflows/format-check.yaml +42 -0
- package/.github/workflows/manual-release.yaml +173 -0
- package/.husky/pre-commit +3 -0
- package/.vscode/settings.json +26 -1
- package/CHANGELOG.md +2 -23
- package/README.md +2 -0
- package/bmad-core/agent-teams/team-all.yaml +1 -1
- package/bmad-core/agents/analyst.md +16 -15
- package/bmad-core/agents/architect.md +11 -11
- package/bmad-core/agents/bmad-master.md +23 -22
- package/bmad-core/agents/bmad-orchestrator.md +13 -17
- package/bmad-core/agents/dev.md +14 -11
- package/bmad-core/agents/pm.md +15 -14
- package/bmad-core/agents/po.md +9 -8
- package/bmad-core/agents/qa.md +42 -22
- package/bmad-core/agents/sm.md +7 -6
- package/bmad-core/agents/ux-expert.md +6 -5
- package/bmad-core/core-config.yaml +2 -0
- package/bmad-core/data/bmad-kb.md +1 -1
- package/bmad-core/data/test-levels-framework.md +146 -0
- package/bmad-core/data/test-priorities-matrix.md +172 -0
- package/bmad-core/tasks/apply-qa-fixes.md +148 -0
- package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
- package/bmad-core/tasks/nfr-assess.md +343 -0
- package/bmad-core/tasks/qa-gate.md +161 -0
- package/bmad-core/tasks/review-story.md +234 -74
- package/bmad-core/tasks/risk-profile.md +353 -0
- package/bmad-core/tasks/test-design.md +174 -0
- package/bmad-core/tasks/trace-requirements.md +264 -0
- package/bmad-core/templates/architecture-tmpl.yaml +49 -49
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +5 -5
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +31 -31
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +13 -13
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +19 -6
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +21 -9
- package/bmad-core/templates/front-end-spec-tmpl.yaml +24 -24
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +122 -104
- package/bmad-core/templates/market-research-tmpl.yaml +2 -2
- package/bmad-core/templates/prd-tmpl.yaml +9 -9
- package/bmad-core/templates/project-brief-tmpl.yaml +4 -4
- package/bmad-core/templates/qa-gate-tmpl.yaml +102 -0
- package/bmad-core/templates/story-tmpl.yaml +12 -12
- package/bmad-core/workflows/brownfield-fullstack.yaml +9 -9
- package/bmad-core/workflows/brownfield-service.yaml +1 -1
- package/bmad-core/workflows/brownfield-ui.yaml +1 -1
- package/bmad-core/workflows/greenfield-fullstack.yaml +1 -1
- package/bmad-core/workflows/greenfield-service.yaml +1 -1
- package/bmad-core/workflows/greenfield-ui.yaml +1 -1
- package/common/utils/bmad-doc-template.md +5 -5
- package/dist/agents/analyst.txt +1086 -1079
- package/dist/agents/architect.txt +1534 -1526
- package/dist/agents/bmad-master.txt +646 -632
- package/dist/agents/bmad-orchestrator.txt +40 -18
- package/dist/agents/dev.txt +158 -19
- package/dist/agents/pm.txt +1082 -1107
- package/dist/agents/po.txt +314 -332
- package/dist/agents/qa.txt +1754 -151
- package/dist/agents/sm.txt +88 -98
- package/dist/agents/ux-expert.txt +80 -87
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +109 -146
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +75 -86
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +41 -48
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +1903 -1941
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +15 -50
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +149 -195
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -15
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +20 -37
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +2660 -2752
- package/dist/expansion-packs/bmad-creative-writing/agents/beta-reader.txt +871 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/book-critic.txt +78 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/character-psychologist.txt +839 -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 +861 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/editor.txt +796 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/genre-specialist.txt +927 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/narrative-designer.txt +842 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/plot-architect.txt +1126 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/world-builder.txt +864 -0
- package/dist/expansion-packs/bmad-creative-writing/teams/agent-team.txt +5917 -0
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +25 -27
- package/dist/teams/team-all.txt +5541 -3768
- package/dist/teams/team-fullstack.txt +3014 -2987
- package/dist/teams/team-ide-minimal.txt +2219 -469
- package/dist/teams/team-no-ui.txt +2993 -2966
- package/docs/enhanced-ide-development-workflow.md +220 -15
- package/docs/user-guide.md +271 -18
- package/docs/versioning-and-releases.md +122 -44
- package/docs/working-in-the-brownfield.md +264 -31
- package/eslint.config.mjs +119 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +4 -4
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +26 -28
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +50 -50
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +23 -23
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +24 -24
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +42 -42
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +5 -5
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +3 -3
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +23 -23
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +63 -63
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +20 -20
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +5 -5
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +1 -1
- package/expansion-packs/bmad-creative-writing/README.md +132 -0
- package/expansion-packs/bmad-creative-writing/agent-teams/agent-team.yaml +19 -0
- package/expansion-packs/bmad-creative-writing/agents/beta-reader.md +91 -0
- package/expansion-packs/bmad-creative-writing/agents/book-critic.md +35 -0
- package/expansion-packs/bmad-creative-writing/agents/character-psychologist.md +90 -0
- package/expansion-packs/bmad-creative-writing/agents/cover-designer.md +41 -0
- package/expansion-packs/bmad-creative-writing/agents/dialog-specialist.md +89 -0
- package/expansion-packs/bmad-creative-writing/agents/editor.md +90 -0
- package/expansion-packs/bmad-creative-writing/agents/genre-specialist.md +92 -0
- package/expansion-packs/bmad-creative-writing/agents/narrative-designer.md +90 -0
- package/expansion-packs/bmad-creative-writing/agents/plot-architect.md +92 -0
- package/expansion-packs/bmad-creative-writing/agents/world-builder.md +91 -0
- package/expansion-packs/bmad-creative-writing/checklists/beta-feedback-closure-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/character-consistency-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/comedic-timing-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/cyberpunk-aesthetic-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/ebook-formatting-checklist.md +15 -0
- package/expansion-packs/bmad-creative-writing/checklists/epic-poetry-meter-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/fantasy-magic-system-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/foreshadowing-payoff-checklist.md +15 -0
- package/expansion-packs/bmad-creative-writing/checklists/genre-tropes-checklist.md +15 -0
- package/expansion-packs/bmad-creative-writing/checklists/historical-accuracy-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/horror-suspense-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/kdp-cover-ready-checklist.md +18 -0
- package/expansion-packs/bmad-creative-writing/checklists/line-edit-quality-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/marketing-copy-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/mystery-clue-trail-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/orbital-mechanics-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/plot-structure-checklist.md +49 -0
- package/expansion-packs/bmad-creative-writing/checklists/publication-readiness-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/romance-emotional-beats-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/scene-quality-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/scifi-technology-plausibility-checklist.md +15 -0
- package/expansion-packs/bmad-creative-writing/checklists/sensitivity-representation-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/steampunk-gadget-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/thriller-pacing-stakes-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/timeline-continuity-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/world-building-continuity-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/checklists/ya-appropriateness-checklist.md +16 -0
- package/expansion-packs/bmad-creative-writing/config.yaml +11 -0
- package/expansion-packs/bmad-creative-writing/data/bmad-kb.md +197 -0
- package/expansion-packs/bmad-creative-writing/data/story-structures.md +58 -0
- package/expansion-packs/bmad-creative-writing/docs/brief.md +183 -0
- package/expansion-packs/bmad-creative-writing/tasks/advanced-elicitation.md +117 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-reader-feedback.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-story-structure.md +55 -0
- package/expansion-packs/bmad-creative-writing/tasks/assemble-kdp-package.md +22 -0
- package/expansion-packs/bmad-creative-writing/tasks/brainstorm-premise.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/build-world.md +17 -0
- package/expansion-packs/bmad-creative-writing/tasks/character-depth-pass.md +15 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-doc.md +101 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-draft-section.md +19 -0
- package/expansion-packs/bmad-creative-writing/tasks/critical-review.md +19 -0
- package/expansion-packs/bmad-creative-writing/tasks/develop-character.md +17 -0
- package/expansion-packs/bmad-creative-writing/tasks/execute-checklist.md +93 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-premise.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-synopsis.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/final-polish.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-brief.md +18 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-prompts.md +19 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-scene-list.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/incorporate-feedback.md +18 -0
- package/expansion-packs/bmad-creative-writing/tasks/outline-scenes.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/provide-feedback.md +17 -0
- package/expansion-packs/bmad-creative-writing/tasks/publish-chapter.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/quick-feedback.md +15 -0
- package/expansion-packs/bmad-creative-writing/tasks/select-next-arc.md +16 -0
- package/expansion-packs/bmad-creative-writing/tasks/workshop-dialog.md +51 -0
- package/expansion-packs/bmad-creative-writing/templates/beta-feedback-form.yaml +96 -0
- package/expansion-packs/bmad-creative-writing/templates/chapter-draft-tmpl.yaml +81 -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 +97 -0
- package/expansion-packs/bmad-creative-writing/templates/premise-brief-tmpl.yaml +77 -0
- package/expansion-packs/bmad-creative-writing/templates/scene-list-tmpl.yaml +54 -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 +88 -0
- package/expansion-packs/bmad-creative-writing/workflows/book-cover-design-workflow.md +176 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-greenfield-workflow.yaml +58 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-serial-workflow.yaml +51 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-snowflake-workflow.yaml +69 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-writing.yaml +92 -0
- package/expansion-packs/bmad-creative-writing/workflows/screenplay-development.yaml +86 -0
- package/expansion-packs/bmad-creative-writing/workflows/series-planning.yaml +79 -0
- package/expansion-packs/bmad-creative-writing/workflows/short-story-creation.yaml +65 -0
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +20 -20
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +7 -7
- package/package.json +62 -39
- package/prettier.config.mjs +32 -0
- package/sync-version.sh +23 -0
- package/tools/bmad-npx-wrapper.js +10 -10
- package/tools/builders/web-builder.js +124 -130
- package/tools/bump-all-versions.js +42 -33
- package/tools/bump-expansion-version.js +23 -16
- package/tools/cli.js +10 -12
- package/tools/flattener/aggregate.js +10 -10
- package/tools/flattener/binary.js +44 -17
- package/tools/flattener/discovery.js +19 -18
- package/tools/flattener/files.js +6 -6
- package/tools/flattener/ignoreRules.js +125 -125
- package/tools/flattener/main.js +426 -70
- package/tools/flattener/projectRoot.js +186 -25
- package/tools/flattener/prompts.js +9 -9
- package/tools/flattener/stats.helpers.js +395 -0
- package/tools/flattener/stats.js +64 -14
- package/tools/flattener/test-matrix.js +413 -0
- package/tools/flattener/xml.js +33 -31
- package/tools/installer/bin/bmad.js +156 -113
- package/tools/installer/config/ide-agent-config.yaml +1 -1
- package/tools/installer/config/install.config.yaml +13 -3
- package/tools/installer/lib/config-loader.js +46 -42
- package/tools/installer/lib/file-manager.js +91 -113
- package/tools/installer/lib/ide-base-setup.js +57 -56
- package/tools/installer/lib/ide-setup.js +545 -399
- package/tools/installer/lib/installer.js +875 -714
- 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.json +19 -19
- package/tools/lib/dependency-resolver.js +26 -30
- package/tools/lib/yaml-utils.js +7 -7
- package/tools/preview-release-notes.js +66 -0
- package/tools/shared/bannerArt.js +3 -3
- package/tools/sync-installer-version.js +7 -9
- package/tools/update-expansion-version.js +14 -15
- package/tools/upgraders/v3-to-v4-upgrader.js +203 -294
- package/tools/version-bump.js +41 -26
- package/tools/yaml-format.js +56 -43
- package/.github/workflows/release.yaml +0 -60
- package/.releaserc.json +0 -21
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash copy.txt +0 -13
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash.txt +0 -13
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.2 Agent Development Kit Installation/1.2.2 - Basic Project Structure - txt.txt +0 -25
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.1 - settings.py +0 -34
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.2 - main.py - Base Application.py +0 -70
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +0 -26
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
- package/tools/semantic-release-sync-installer.js +0 -30
|
@@ -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 bmad-core/core-config.yaml during activation)'
|
|
53
54
|
agent:
|
|
54
55
|
name: BMad Master
|
|
55
56
|
id: bmad-master
|
|
@@ -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 .bmad-core/data/bmad-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 .bmad-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
|
-
- bmad-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,13 +123,6 @@ 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: .bmad-core/agents/bmad-master.md ====================
|
|
127
128
|
|
|
@@ -245,145 +246,6 @@ Choose a number (0-8) or 9 to proceed:
|
|
|
245
246
|
- **Maintain Flow**: Keep the process moving efficiently
|
|
246
247
|
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
|
|
247
248
|
|
|
248
|
-
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
249
|
-
---
|
|
250
|
-
docOutputLocation: docs/brainstorming-session-results.md
|
|
251
|
-
template: ".bmad-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: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
386
|
-
|
|
387
249
|
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
|
388
250
|
# Create Brownfield Epic Task
|
|
389
251
|
|
|
@@ -794,63 +656,54 @@ CRITICAL: First, help the user select the most appropriate research focus based
|
|
|
794
656
|
Present these numbered options to the user:
|
|
795
657
|
|
|
796
658
|
1. **Product Validation Research**
|
|
797
|
-
|
|
798
659
|
- Validate product hypotheses and market fit
|
|
799
660
|
- Test assumptions about user needs and solutions
|
|
800
661
|
- Assess technical and business feasibility
|
|
801
662
|
- Identify risks and mitigation strategies
|
|
802
663
|
|
|
803
664
|
2. **Market Opportunity Research**
|
|
804
|
-
|
|
805
665
|
- Analyze market size and growth potential
|
|
806
666
|
- Identify market segments and dynamics
|
|
807
667
|
- Assess market entry strategies
|
|
808
668
|
- Evaluate timing and market readiness
|
|
809
669
|
|
|
810
670
|
3. **User & Customer Research**
|
|
811
|
-
|
|
812
671
|
- Deep dive into user personas and behaviors
|
|
813
672
|
- Understand jobs-to-be-done and pain points
|
|
814
673
|
- Map customer journeys and touchpoints
|
|
815
674
|
- Analyze willingness to pay and value perception
|
|
816
675
|
|
|
817
676
|
4. **Competitive Intelligence Research**
|
|
818
|
-
|
|
819
677
|
- Detailed competitor analysis and positioning
|
|
820
678
|
- Feature and capability comparisons
|
|
821
679
|
- Business model and strategy analysis
|
|
822
680
|
- Identify competitive advantages and gaps
|
|
823
681
|
|
|
824
682
|
5. **Technology & Innovation Research**
|
|
825
|
-
|
|
826
683
|
- Assess technology trends and possibilities
|
|
827
684
|
- Evaluate technical approaches and architectures
|
|
828
685
|
- Identify emerging technologies and disruptions
|
|
829
686
|
- Analyze build vs. buy vs. partner options
|
|
830
687
|
|
|
831
688
|
6. **Industry & Ecosystem Research**
|
|
832
|
-
|
|
833
689
|
- Map industry value chains and dynamics
|
|
834
690
|
- Identify key players and relationships
|
|
835
691
|
- Analyze regulatory and compliance factors
|
|
836
692
|
- Understand partnership opportunities
|
|
837
693
|
|
|
838
694
|
7. **Strategic Options Research**
|
|
839
|
-
|
|
840
695
|
- Evaluate different strategic directions
|
|
841
696
|
- Assess business model alternatives
|
|
842
697
|
- Analyze go-to-market strategies
|
|
843
698
|
- Consider expansion and scaling paths
|
|
844
699
|
|
|
845
700
|
8. **Risk & Feasibility Research**
|
|
846
|
-
|
|
847
701
|
- Identify and assess various risk factors
|
|
848
702
|
- Evaluate implementation challenges
|
|
849
703
|
- Analyze resource requirements
|
|
850
704
|
- Consider regulatory and legal implications
|
|
851
705
|
|
|
852
706
|
9. **Custom Research Focus**
|
|
853
|
-
|
|
854
707
|
- User-defined research objectives
|
|
855
708
|
- Specialized domain investigation
|
|
856
709
|
- Cross-functional research needs
|
|
@@ -1019,13 +872,11 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
|
|
|
1019
872
|
### 5. Review and Refinement
|
|
1020
873
|
|
|
1021
874
|
1. **Present Complete Prompt**
|
|
1022
|
-
|
|
1023
875
|
- Show the full research prompt
|
|
1024
876
|
- Explain key elements and rationale
|
|
1025
877
|
- Highlight any assumptions made
|
|
1026
878
|
|
|
1027
879
|
2. **Gather Feedback**
|
|
1028
|
-
|
|
1029
880
|
- Are the objectives clear and correct?
|
|
1030
881
|
- Do the questions address all concerns?
|
|
1031
882
|
- Is the scope appropriate?
|
|
@@ -1166,67 +1017,182 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
|
1166
1017
|
- End with "Select 1-9 or just type your question/feedback:"
|
|
1167
1018
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
|
1168
1019
|
|
|
1169
|
-
==================== START: .bmad-core/tasks/
|
|
1170
|
-
#
|
|
1020
|
+
==================== START: .bmad-core/tasks/create-next-story.md ====================
|
|
1021
|
+
# Create Next Story Task
|
|
1171
1022
|
|
|
1172
1023
|
## Purpose
|
|
1173
1024
|
|
|
1174
|
-
|
|
1025
|
+
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
1026
|
|
|
1176
|
-
## Task
|
|
1027
|
+
## SEQUENTIAL Task Execution (Do not proceed until current Task is complete)
|
|
1177
1028
|
|
|
1178
|
-
###
|
|
1029
|
+
### 0. Load Core Configuration and Check Workflow
|
|
1179
1030
|
|
|
1180
|
-
|
|
1031
|
+
- Load `.bmad-core/core-config.yaml` from the project root
|
|
1032
|
+
- 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 bmad-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."
|
|
1033
|
+
- Extract key configurations: `devStoryLocation`, `prd.*`, `architecture.*`, `workflow.*`
|
|
1181
1034
|
|
|
1182
|
-
|
|
1035
|
+
### 1. Identify Next Story for Preparation
|
|
1183
1036
|
|
|
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
|
|
1037
|
+
#### 1.1 Locate Epic Files and Review Existing Stories
|
|
1188
1038
|
|
|
1189
|
-
|
|
1190
|
-
|
|
1039
|
+
- Based on `prdSharded` from config, locate epic files (sharded location/pattern or monolithic PRD sections)
|
|
1040
|
+
- If `devStoryLocation` has story files, load the highest `{epicNum}.{storyNum}.story.md` file
|
|
1041
|
+
- **If highest story exists:**
|
|
1042
|
+
- 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?"
|
|
1043
|
+
- If proceeding, select next sequential story in the current epic
|
|
1044
|
+
- 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"
|
|
1045
|
+
- **CRITICAL**: NEVER automatically skip to another epic. User MUST explicitly instruct which story to create.
|
|
1046
|
+
- **If no story files exist:** The next story is ALWAYS 1.1 (first story of first epic)
|
|
1047
|
+
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}"
|
|
1191
1048
|
|
|
1192
|
-
|
|
1049
|
+
### 2. Gather Story Requirements and Previous Story Context
|
|
1193
1050
|
|
|
1194
|
-
|
|
1051
|
+
- Extract story requirements from the identified epic file
|
|
1052
|
+
- If previous story exists, review Dev Agent Record sections for:
|
|
1053
|
+
- Completion Notes and Debug Log References
|
|
1054
|
+
- Implementation deviations and technical decisions
|
|
1055
|
+
- Challenges encountered and lessons learned
|
|
1056
|
+
- Extract relevant insights that inform the current story's preparation
|
|
1195
1057
|
|
|
1196
|
-
|
|
1058
|
+
### 3. Gather Architecture Context
|
|
1197
1059
|
|
|
1198
|
-
3.
|
|
1199
|
-
- 'Adding payment processing to the user service'
|
|
1200
|
-
- 'Refactoring the authentication module'
|
|
1201
|
-
- 'Integrating with a new third-party API'
|
|
1060
|
+
#### 3.1 Determine Architecture Reading Strategy
|
|
1202
1061
|
|
|
1203
|
-
|
|
1062
|
+
- **If `architectureVersion: >= v4` and `architectureSharded: true`**: Read `{architectureShardedLocation}/index.md` then follow structured reading order below
|
|
1063
|
+
- **Else**: Use monolithic `architectureFile` for similar sections
|
|
1204
1064
|
|
|
1205
|
-
|
|
1065
|
+
#### 3.2 Read Architecture Documents Based on Story Type
|
|
1206
1066
|
|
|
1207
|
-
|
|
1067
|
+
**For ALL Stories:** tech-stack.md, unified-project-structure.md, coding-standards.md, testing-strategy.md
|
|
1208
1068
|
|
|
1209
|
-
|
|
1210
|
-
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
|
1069
|
+
**For Backend/API Stories, additionally:** data-models.md, database-schema.md, backend-architecture.md, rest-api-spec.md, external-apis.md
|
|
1211
1070
|
|
|
1212
|
-
|
|
1071
|
+
**For Frontend/UI Stories, additionally:** frontend-architecture.md, components.md, core-workflows.md, data-models.md
|
|
1213
1072
|
|
|
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
|
|
1073
|
+
**For Full-Stack Stories:** Read both Backend and Frontend sections above
|
|
1219
1074
|
|
|
1220
|
-
|
|
1075
|
+
#### 3.3 Extract Story-Specific Technical Details
|
|
1221
1076
|
|
|
1222
|
-
|
|
1223
|
-
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
|
1224
|
-
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
|
1225
|
-
- Are there any existing documentation standards or formats you prefer?
|
|
1226
|
-
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
1227
|
-
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
1077
|
+
Extract ONLY information directly relevant to implementing the current story. Do NOT invent new libraries, patterns, or standards not in the source documents.
|
|
1228
1078
|
|
|
1229
|
-
|
|
1079
|
+
Extract:
|
|
1080
|
+
|
|
1081
|
+
- Specific data models, schemas, or structures the story will use
|
|
1082
|
+
- API endpoints the story must implement or consume
|
|
1083
|
+
- Component specifications for UI elements in the story
|
|
1084
|
+
- File paths and naming conventions for new code
|
|
1085
|
+
- Testing requirements specific to the story's features
|
|
1086
|
+
- Security or performance considerations affecting the story
|
|
1087
|
+
|
|
1088
|
+
ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
1089
|
+
|
|
1090
|
+
### 4. Verify Project Structure Alignment
|
|
1091
|
+
|
|
1092
|
+
- Cross-reference story requirements with Project Structure Guide from `docs/architecture/unified-project-structure.md`
|
|
1093
|
+
- Ensure file paths, component locations, or module names align with defined structures
|
|
1094
|
+
- Document any structural conflicts in "Project Structure Notes" section within the story draft
|
|
1095
|
+
|
|
1096
|
+
### 5. Populate Story Template with Full Context
|
|
1097
|
+
|
|
1098
|
+
- Create new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` using Story Template
|
|
1099
|
+
- Fill in basic story information: Title, Status (Draft), Story statement, Acceptance Criteria from Epic
|
|
1100
|
+
- **`Dev Notes` section (CRITICAL):**
|
|
1101
|
+
- CRITICAL: This section MUST contain ONLY information extracted from architecture documents. NEVER invent or assume technical details.
|
|
1102
|
+
- Include ALL relevant technical details from Steps 2-3, organized by category:
|
|
1103
|
+
- **Previous Story Insights**: Key learnings from previous story
|
|
1104
|
+
- **Data Models**: Specific schemas, validation rules, relationships [with source references]
|
|
1105
|
+
- **API Specifications**: Endpoint details, request/response formats, auth requirements [with source references]
|
|
1106
|
+
- **Component Specifications**: UI component details, props, state management [with source references]
|
|
1107
|
+
- **File Locations**: Exact paths where new code should be created based on project structure
|
|
1108
|
+
- **Testing Requirements**: Specific test cases or strategies from testing-strategy.md
|
|
1109
|
+
- **Technical Constraints**: Version requirements, performance considerations, security rules
|
|
1110
|
+
- Every technical detail MUST include its source reference: `[Source: architecture/{filename}.md#{section}]`
|
|
1111
|
+
- If information for a category is not found in the architecture docs, explicitly state: "No specific guidance found in architecture docs"
|
|
1112
|
+
- **`Tasks / Subtasks` section:**
|
|
1113
|
+
- Generate detailed, sequential list of technical tasks based ONLY on: Epic Requirements, Story AC, Reviewed Architecture Information
|
|
1114
|
+
- Each task must reference relevant architecture documentation
|
|
1115
|
+
- Include unit testing as explicit subtasks based on the Testing Strategy
|
|
1116
|
+
- Link tasks to ACs where applicable (e.g., `Task 1 (AC: 1, 3)`)
|
|
1117
|
+
- Add notes on project structure alignment or discrepancies found in Step 4
|
|
1118
|
+
|
|
1119
|
+
### 6. Story Draft Completion and Review
|
|
1120
|
+
|
|
1121
|
+
- Review all sections for completeness and accuracy
|
|
1122
|
+
- Verify all source references are included for technical details
|
|
1123
|
+
- Ensure tasks align with both epic requirements and architecture constraints
|
|
1124
|
+
- Update status to "Draft" and save the story file
|
|
1125
|
+
- Execute `.bmad-core/tasks/execute-checklist` `.bmad-core/checklists/story-draft-checklist`
|
|
1126
|
+
- Provide summary to user including:
|
|
1127
|
+
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
1128
|
+
- Status: Draft
|
|
1129
|
+
- Key technical components included from architecture docs
|
|
1130
|
+
- Any deviations or conflicts noted between epic and architecture
|
|
1131
|
+
- Checklist Results
|
|
1132
|
+
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.bmad-core/tasks/validate-next-story`
|
|
1133
|
+
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
|
1134
|
+
|
|
1135
|
+
==================== START: .bmad-core/tasks/document-project.md ====================
|
|
1136
|
+
# Document an Existing Project
|
|
1137
|
+
|
|
1138
|
+
## Purpose
|
|
1139
|
+
|
|
1140
|
+
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.
|
|
1141
|
+
|
|
1142
|
+
## Task Instructions
|
|
1143
|
+
|
|
1144
|
+
### 1. Initial Project Analysis
|
|
1145
|
+
|
|
1146
|
+
**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.
|
|
1147
|
+
|
|
1148
|
+
**IF PRD EXISTS**:
|
|
1149
|
+
|
|
1150
|
+
- Review the PRD to understand what enhancement/feature is planned
|
|
1151
|
+
- Identify which modules, services, or areas will be affected
|
|
1152
|
+
- Focus documentation ONLY on these relevant areas
|
|
1153
|
+
- Skip unrelated parts of the codebase to keep docs lean
|
|
1154
|
+
|
|
1155
|
+
**IF NO PRD EXISTS**:
|
|
1156
|
+
Ask the user:
|
|
1157
|
+
|
|
1158
|
+
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
|
1159
|
+
|
|
1160
|
+
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
|
1161
|
+
|
|
1162
|
+
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
|
1163
|
+
|
|
1164
|
+
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
|
1165
|
+
- 'Adding payment processing to the user service'
|
|
1166
|
+
- 'Refactoring the authentication module'
|
|
1167
|
+
- 'Integrating with a new third-party API'
|
|
1168
|
+
|
|
1169
|
+
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
|
1170
|
+
|
|
1171
|
+
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
|
1172
|
+
|
|
1173
|
+
Based on their response:
|
|
1174
|
+
|
|
1175
|
+
- If they choose option 1-3: Use that context to focus documentation
|
|
1176
|
+
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
|
1177
|
+
|
|
1178
|
+
Begin by conducting analysis of the existing project. Use available tools to:
|
|
1179
|
+
|
|
1180
|
+
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
|
1181
|
+
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
|
1182
|
+
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
|
1183
|
+
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
|
1184
|
+
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
|
1185
|
+
|
|
1186
|
+
Ask the user these elicitation questions to better understand their needs:
|
|
1187
|
+
|
|
1188
|
+
- What is the primary purpose of this project?
|
|
1189
|
+
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
|
1190
|
+
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
|
1191
|
+
- Are there any existing documentation standards or formats you prefer?
|
|
1192
|
+
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
1193
|
+
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
1194
|
+
|
|
1195
|
+
### 2. Deep Codebase Analysis
|
|
1230
1196
|
|
|
1231
1197
|
CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
|
|
1232
1198
|
|
|
@@ -1280,9 +1246,9 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1280
1246
|
|
|
1281
1247
|
### Change Log
|
|
1282
1248
|
|
|
1283
|
-
| Date
|
|
1284
|
-
|
|
1285
|
-
| [Date] | 1.0
|
|
1249
|
+
| Date | Version | Description | Author |
|
|
1250
|
+
| ------ | ------- | --------------------------- | --------- |
|
|
1251
|
+
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
|
1286
1252
|
|
|
1287
1253
|
## Quick Reference - Key Files and Entry Points
|
|
1288
1254
|
|
|
@@ -1305,11 +1271,11 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1305
1271
|
|
|
1306
1272
|
### Actual Tech Stack (from package.json/requirements.txt)
|
|
1307
1273
|
|
|
1308
|
-
| Category
|
|
1309
|
-
|
|
1310
|
-
| Runtime
|
|
1311
|
-
| Framework | Express
|
|
1312
|
-
| Database
|
|
1274
|
+
| Category | Technology | Version | Notes |
|
|
1275
|
+
| --------- | ---------- | ------- | -------------------------- |
|
|
1276
|
+
| Runtime | Node.js | 16.x | [Any constraints] |
|
|
1277
|
+
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
|
1278
|
+
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
|
1313
1279
|
|
|
1314
1280
|
etc...
|
|
1315
1281
|
|
|
@@ -1348,6 +1314,7 @@ project-root/
|
|
|
1348
1314
|
### Data Models
|
|
1349
1315
|
|
|
1350
1316
|
Instead of duplicating, reference actual model files:
|
|
1317
|
+
|
|
1351
1318
|
- **User Model**: See `src/models/User.js`
|
|
1352
1319
|
- **Order Model**: See `src/models/Order.js`
|
|
1353
1320
|
- **Related Types**: TypeScript definitions in `src/types/`
|
|
@@ -1377,10 +1344,10 @@ Instead of duplicating, reference actual model files:
|
|
|
1377
1344
|
|
|
1378
1345
|
### External Services
|
|
1379
1346
|
|
|
1380
|
-
| Service
|
|
1381
|
-
|
|
1382
|
-
| Stripe
|
|
1383
|
-
| SendGrid | Emails
|
|
1347
|
+
| Service | Purpose | Integration Type | Key Files |
|
|
1348
|
+
| -------- | -------- | ---------------- | ------------------------------ |
|
|
1349
|
+
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
|
1350
|
+
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
|
1384
1351
|
|
|
1385
1352
|
etc...
|
|
1386
1353
|
|
|
@@ -1425,6 +1392,7 @@ npm run test:integration # Runs integration tests (requires local DB)
|
|
|
1425
1392
|
### Files That Will Need Modification
|
|
1426
1393
|
|
|
1427
1394
|
Based on the enhancement requirements, these files will be affected:
|
|
1395
|
+
|
|
1428
1396
|
- `src/services/userService.js` - Add new user fields
|
|
1429
1397
|
- `src/models/User.js` - Update schema
|
|
1430
1398
|
- `src/routes/userRoutes.js` - New endpoints
|
|
@@ -1510,121 +1478,6 @@ Apply the advanced elicitation task after major sections to refine based on user
|
|
|
1510
1478
|
- The goal is PRACTICAL documentation for AI agents doing real work
|
|
1511
1479
|
==================== END: .bmad-core/tasks/document-project.md ====================
|
|
1512
1480
|
|
|
1513
|
-
==================== START: .bmad-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 `.bmad-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 bmad-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."
|
|
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 `.bmad-core/tasks/execute-checklist` `.bmad-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 `.bmad-core/tasks/validate-next-story`
|
|
1626
|
-
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
|
1627
|
-
|
|
1628
1481
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
|
1629
1482
|
# Checklist Validation Task
|
|
1630
1483
|
|
|
@@ -1637,7 +1490,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1637
1490
|
## Instructions
|
|
1638
1491
|
|
|
1639
1492
|
1. **Initial Assessment**
|
|
1640
|
-
|
|
1641
1493
|
- If user or the task being run provides a checklist name:
|
|
1642
1494
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
1643
1495
|
- If multiple matches found, ask user to clarify
|
|
@@ -1650,14 +1502,12 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1650
1502
|
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
1651
1503
|
|
|
1652
1504
|
2. **Document and Artifact Gathering**
|
|
1653
|
-
|
|
1654
1505
|
- Each checklist will specify its required documents/artifacts at the beginning
|
|
1655
1506
|
- 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
1507
|
|
|
1657
1508
|
3. **Checklist Processing**
|
|
1658
1509
|
|
|
1659
1510
|
If in interactive mode:
|
|
1660
|
-
|
|
1661
1511
|
- Work through each section of the checklist one at a time
|
|
1662
1512
|
- For each section:
|
|
1663
1513
|
- Review all items in the section following instructions for that section embedded in the checklist
|
|
@@ -1666,7 +1516,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1666
1516
|
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
1667
1517
|
|
|
1668
1518
|
If in YOLO mode:
|
|
1669
|
-
|
|
1670
1519
|
- Process all sections at once
|
|
1671
1520
|
- Create a comprehensive report of all findings
|
|
1672
1521
|
- Present the complete analysis to the user
|
|
@@ -1674,7 +1523,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1674
1523
|
4. **Validation Approach**
|
|
1675
1524
|
|
|
1676
1525
|
For each checklist item:
|
|
1677
|
-
|
|
1678
1526
|
- Read and understand the requirement
|
|
1679
1527
|
- Look for evidence in the documentation that satisfies the requirement
|
|
1680
1528
|
- Consider both explicit mentions and implicit coverage
|
|
@@ -1688,7 +1536,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1688
1536
|
5. **Section Analysis**
|
|
1689
1537
|
|
|
1690
1538
|
For each section:
|
|
1691
|
-
|
|
1692
1539
|
- think step by step to calculate pass rate
|
|
1693
1540
|
- Identify common themes in failed items
|
|
1694
1541
|
- Provide specific recommendations for improvement
|
|
@@ -1698,7 +1545,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
1698
1545
|
6. **Final Report**
|
|
1699
1546
|
|
|
1700
1547
|
Prepare a summary that includes:
|
|
1701
|
-
|
|
1702
1548
|
- Overall checklist completion status
|
|
1703
1549
|
- Pass rates by section
|
|
1704
1550
|
- List of failed items with context
|
|
@@ -1721,6 +1567,145 @@ The LLM will:
|
|
|
1721
1567
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
|
1722
1568
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
|
1723
1569
|
|
|
1570
|
+
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
1571
|
+
---
|
|
1572
|
+
docOutputLocation: docs/brainstorming-session-results.md
|
|
1573
|
+
template: '.bmad-core/templates/brainstorming-output-tmpl.yaml'
|
|
1574
|
+
---
|
|
1575
|
+
|
|
1576
|
+
# Facilitate Brainstorming Session Task
|
|
1577
|
+
|
|
1578
|
+
Facilitate interactive brainstorming sessions with users. Be creative and adaptive in applying techniques.
|
|
1579
|
+
|
|
1580
|
+
## Process
|
|
1581
|
+
|
|
1582
|
+
### Step 1: Session Setup
|
|
1583
|
+
|
|
1584
|
+
Ask 4 context questions (don't preview what happens next):
|
|
1585
|
+
|
|
1586
|
+
1. What are we brainstorming about?
|
|
1587
|
+
2. Any constraints or parameters?
|
|
1588
|
+
3. Goal: broad exploration or focused ideation?
|
|
1589
|
+
4. Do you want a structured document output to reference later? (Default Yes)
|
|
1590
|
+
|
|
1591
|
+
### Step 2: Present Approach Options
|
|
1592
|
+
|
|
1593
|
+
After getting answers to Step 1, present 4 approach options (numbered):
|
|
1594
|
+
|
|
1595
|
+
1. User selects specific techniques
|
|
1596
|
+
2. Analyst recommends techniques based on context
|
|
1597
|
+
3. Random technique selection for creative variety
|
|
1598
|
+
4. Progressive technique flow (start broad, narrow down)
|
|
1599
|
+
|
|
1600
|
+
### Step 3: Execute Techniques Interactively
|
|
1601
|
+
|
|
1602
|
+
**KEY PRINCIPLES:**
|
|
1603
|
+
|
|
1604
|
+
- **FACILITATOR ROLE**: Guide user to generate their own ideas through questions, prompts, and examples
|
|
1605
|
+
- **CONTINUOUS ENGAGEMENT**: Keep user engaged with chosen technique until they want to switch or are satisfied
|
|
1606
|
+
- **CAPTURE OUTPUT**: If (default) document output requested, capture all ideas generated in each technique section to the document from the beginning.
|
|
1607
|
+
|
|
1608
|
+
**Technique Selection:**
|
|
1609
|
+
If user selects Option 1, present numbered list of techniques from the brainstorming-techniques data file. User can select by number..
|
|
1610
|
+
|
|
1611
|
+
**Technique Execution:**
|
|
1612
|
+
|
|
1613
|
+
1. Apply selected technique according to data file description
|
|
1614
|
+
2. Keep engaging with technique until user indicates they want to:
|
|
1615
|
+
- Choose a different technique
|
|
1616
|
+
- Apply current ideas to a new technique
|
|
1617
|
+
- Move to convergent phase
|
|
1618
|
+
- End session
|
|
1619
|
+
|
|
1620
|
+
**Output Capture (if requested):**
|
|
1621
|
+
For each technique used, capture:
|
|
1622
|
+
|
|
1623
|
+
- Technique name and duration
|
|
1624
|
+
- Key ideas generated by user
|
|
1625
|
+
- Insights and patterns identified
|
|
1626
|
+
- User's reflections on the process
|
|
1627
|
+
|
|
1628
|
+
### Step 4: Session Flow
|
|
1629
|
+
|
|
1630
|
+
1. **Warm-up** (5-10 min) - Build creative confidence
|
|
1631
|
+
2. **Divergent** (20-30 min) - Generate quantity over quality
|
|
1632
|
+
3. **Convergent** (15-20 min) - Group and categorize ideas
|
|
1633
|
+
4. **Synthesis** (10-15 min) - Refine and develop concepts
|
|
1634
|
+
|
|
1635
|
+
### Step 5: Document Output (if requested)
|
|
1636
|
+
|
|
1637
|
+
Generate structured document with these sections:
|
|
1638
|
+
|
|
1639
|
+
**Executive Summary**
|
|
1640
|
+
|
|
1641
|
+
- Session topic and goals
|
|
1642
|
+
- Techniques used and duration
|
|
1643
|
+
- Total ideas generated
|
|
1644
|
+
- Key themes and patterns identified
|
|
1645
|
+
|
|
1646
|
+
**Technique Sections** (for each technique used)
|
|
1647
|
+
|
|
1648
|
+
- Technique name and description
|
|
1649
|
+
- Ideas generated (user's own words)
|
|
1650
|
+
- Insights discovered
|
|
1651
|
+
- Notable connections or patterns
|
|
1652
|
+
|
|
1653
|
+
**Idea Categorization**
|
|
1654
|
+
|
|
1655
|
+
- **Immediate Opportunities** - Ready to implement now
|
|
1656
|
+
- **Future Innovations** - Requires development/research
|
|
1657
|
+
- **Moonshots** - Ambitious, transformative concepts
|
|
1658
|
+
- **Insights & Learnings** - Key realizations from session
|
|
1659
|
+
|
|
1660
|
+
**Action Planning**
|
|
1661
|
+
|
|
1662
|
+
- Top 3 priority ideas with rationale
|
|
1663
|
+
- Next steps for each priority
|
|
1664
|
+
- Resources/research needed
|
|
1665
|
+
- Timeline considerations
|
|
1666
|
+
|
|
1667
|
+
**Reflection & Follow-up**
|
|
1668
|
+
|
|
1669
|
+
- What worked well in this session
|
|
1670
|
+
- Areas for further exploration
|
|
1671
|
+
- Recommended follow-up techniques
|
|
1672
|
+
- Questions that emerged for future sessions
|
|
1673
|
+
|
|
1674
|
+
## Key Principles
|
|
1675
|
+
|
|
1676
|
+
- **YOU ARE A FACILITATOR**: Guide the user to brainstorm, don't brainstorm for them (unless they request it persistently)
|
|
1677
|
+
- **INTERACTIVE DIALOGUE**: Ask questions, wait for responses, build on their ideas
|
|
1678
|
+
- **ONE TECHNIQUE AT A TIME**: Don't mix multiple techniques in one response
|
|
1679
|
+
- **CONTINUOUS ENGAGEMENT**: Stay with one technique until user wants to switch
|
|
1680
|
+
- **DRAW IDEAS OUT**: Use prompts and examples to help them generate their own ideas
|
|
1681
|
+
- **REAL-TIME ADAPTATION**: Monitor engagement and adjust approach as needed
|
|
1682
|
+
- Maintain energy and momentum
|
|
1683
|
+
- Defer judgment during generation
|
|
1684
|
+
- Quantity leads to quality (aim for 100 ideas in 60 minutes)
|
|
1685
|
+
- Build on ideas collaboratively
|
|
1686
|
+
- Document everything in output document
|
|
1687
|
+
|
|
1688
|
+
## Advanced Engagement Strategies
|
|
1689
|
+
|
|
1690
|
+
**Energy Management**
|
|
1691
|
+
|
|
1692
|
+
- Check engagement levels: "How are you feeling about this direction?"
|
|
1693
|
+
- Offer breaks or technique switches if energy flags
|
|
1694
|
+
- Use encouraging language and celebrate idea generation
|
|
1695
|
+
|
|
1696
|
+
**Depth vs. Breadth**
|
|
1697
|
+
|
|
1698
|
+
- Ask follow-up questions to deepen ideas: "Tell me more about that..."
|
|
1699
|
+
- Use "Yes, and..." to build on their ideas
|
|
1700
|
+
- Help them make connections: "How does this relate to your earlier idea about...?"
|
|
1701
|
+
|
|
1702
|
+
**Transition Management**
|
|
1703
|
+
|
|
1704
|
+
- Always ask before switching techniques: "Ready to try a different approach?"
|
|
1705
|
+
- Offer options: "Should we explore this idea deeper or generate more alternatives?"
|
|
1706
|
+
- Respect their process and timing
|
|
1707
|
+
==================== END: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
1708
|
+
|
|
1724
1709
|
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
1725
1710
|
# Create AI Frontend Prompt Task
|
|
1726
1711
|
|
|
@@ -1789,14 +1774,12 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1789
1774
|
### Required Steps
|
|
1790
1775
|
|
|
1791
1776
|
1. First, locate and scan:
|
|
1792
|
-
|
|
1793
1777
|
- The `docs/` directory and all subdirectories
|
|
1794
1778
|
- The existing `docs/index.md` file (create if absent)
|
|
1795
1779
|
- All markdown (`.md`) and text (`.txt`) files in the documentation structure
|
|
1796
1780
|
- Note the folder structure for hierarchical organization
|
|
1797
1781
|
|
|
1798
1782
|
2. For the existing `docs/index.md`:
|
|
1799
|
-
|
|
1800
1783
|
- Parse current entries
|
|
1801
1784
|
- Note existing file references and descriptions
|
|
1802
1785
|
- Identify any broken links or missing files
|
|
@@ -1804,7 +1787,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1804
1787
|
- Preserve existing folder sections
|
|
1805
1788
|
|
|
1806
1789
|
3. For each documentation file found:
|
|
1807
|
-
|
|
1808
1790
|
- Extract the title (from first heading or filename)
|
|
1809
1791
|
- Generate a brief description by analyzing the content
|
|
1810
1792
|
- Create a relative markdown link to the file
|
|
@@ -1813,7 +1795,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
|
|
|
1813
1795
|
- If missing or outdated, prepare an update
|
|
1814
1796
|
|
|
1815
1797
|
4. For any missing or non-existent files found in index:
|
|
1816
|
-
|
|
1817
1798
|
- Present a list of all entries that reference non-existent files
|
|
1818
1799
|
- For each entry:
|
|
1819
1800
|
- Show the full entry details (title, path, description)
|
|
@@ -1866,7 +1847,6 @@ Documents within the `another-folder/` directory:
|
|
|
1866
1847
|
### [Nested Document](./another-folder/document.md)
|
|
1867
1848
|
|
|
1868
1849
|
Description of nested document.
|
|
1869
|
-
|
|
1870
1850
|
```
|
|
1871
1851
|
|
|
1872
1852
|
### Index Entry Format
|
|
@@ -1935,7 +1915,6 @@ For each file referenced in the index but not found in the filesystem:
|
|
|
1935
1915
|
### Special Cases
|
|
1936
1916
|
|
|
1937
1917
|
1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
|
|
1938
|
-
|
|
1939
1918
|
- Use the folder's `index.md` title as the section title
|
|
1940
1919
|
- List the folder's documents as subsections
|
|
1941
1920
|
- Note in the description that this is a multi-part document
|
|
@@ -2051,13 +2030,11 @@ CRITICAL: Use proper parsing that understands markdown context. A ## inside a co
|
|
|
2051
2030
|
For each extracted section:
|
|
2052
2031
|
|
|
2053
2032
|
1. **Generate filename**: Convert the section heading to lowercase-dash-case
|
|
2054
|
-
|
|
2055
2033
|
- Remove special characters
|
|
2056
2034
|
- Replace spaces with dashes
|
|
2057
2035
|
- Example: "## Tech Stack" → `tech-stack.md`
|
|
2058
2036
|
|
|
2059
2037
|
2. **Adjust heading levels**:
|
|
2060
|
-
|
|
2061
2038
|
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
2062
2039
|
- All subsection levels decrease by 1:
|
|
2063
2040
|
|
|
@@ -2170,20 +2147,20 @@ sections:
|
|
|
2170
2147
|
- id: intro-content
|
|
2171
2148
|
content: |
|
|
2172
2149
|
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
|
-
|
|
2150
|
+
|
|
2174
2151
|
**Relationship to Frontend Architecture:**
|
|
2175
2152
|
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
2153
|
- id: starter-template
|
|
2177
2154
|
title: Starter Template or Existing Project
|
|
2178
2155
|
instruction: |
|
|
2179
2156
|
Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase:
|
|
2180
|
-
|
|
2157
|
+
|
|
2181
2158
|
1. Review the PRD and brainstorming brief for any mentions of:
|
|
2182
2159
|
- Starter templates (e.g., Create React App, Next.js, Vue CLI, Angular CLI, etc.)
|
|
2183
2160
|
- Existing projects or codebases being used as a foundation
|
|
2184
2161
|
- Boilerplate projects or scaffolding tools
|
|
2185
2162
|
- Previous projects to be cloned or adapted
|
|
2186
|
-
|
|
2163
|
+
|
|
2187
2164
|
2. If a starter template or existing project is mentioned:
|
|
2188
2165
|
- Ask the user to provide access via one of these methods:
|
|
2189
2166
|
- Link to the starter template documentation
|
|
@@ -2196,16 +2173,16 @@ sections:
|
|
|
2196
2173
|
- Existing architectural patterns and conventions
|
|
2197
2174
|
- Any limitations or constraints imposed by the starter
|
|
2198
2175
|
- Use this analysis to inform and align your architecture decisions
|
|
2199
|
-
|
|
2176
|
+
|
|
2200
2177
|
3. If no starter template is mentioned but this is a greenfield project:
|
|
2201
2178
|
- Suggest appropriate starter templates based on the tech stack preferences
|
|
2202
2179
|
- Explain the benefits (faster setup, best practices, community support)
|
|
2203
2180
|
- Let the user decide whether to use one
|
|
2204
|
-
|
|
2181
|
+
|
|
2205
2182
|
4. If the user confirms no starter template will be used:
|
|
2206
2183
|
- Proceed with architecture design from scratch
|
|
2207
2184
|
- Note that manual setup will be required for all tooling and configuration
|
|
2208
|
-
|
|
2185
|
+
|
|
2209
2186
|
Document the decision here before proceeding with the architecture design. If none, just say N/A
|
|
2210
2187
|
elicit: true
|
|
2211
2188
|
- id: changelog
|
|
@@ -2233,7 +2210,7 @@ sections:
|
|
|
2233
2210
|
title: High Level Overview
|
|
2234
2211
|
instruction: |
|
|
2235
2212
|
Based on the PRD's Technical Assumptions section, describe:
|
|
2236
|
-
|
|
2213
|
+
|
|
2237
2214
|
1. The main architectural style (e.g., Monolith, Microservices, Serverless, Event-Driven)
|
|
2238
2215
|
2. Repository structure decision from PRD (Monorepo/Polyrepo)
|
|
2239
2216
|
3. Service architecture decision from PRD
|
|
@@ -2250,17 +2227,17 @@ sections:
|
|
|
2250
2227
|
- Data flow directions
|
|
2251
2228
|
- External integrations
|
|
2252
2229
|
- User entry points
|
|
2253
|
-
|
|
2230
|
+
|
|
2254
2231
|
- id: architectural-patterns
|
|
2255
2232
|
title: Architectural and Design Patterns
|
|
2256
2233
|
instruction: |
|
|
2257
2234
|
List the key high-level patterns that will guide the architecture. For each pattern:
|
|
2258
|
-
|
|
2235
|
+
|
|
2259
2236
|
1. Present 2-3 viable options if multiple exist
|
|
2260
2237
|
2. Provide your recommendation with clear rationale
|
|
2261
2238
|
3. Get user confirmation before finalizing
|
|
2262
2239
|
4. These patterns should align with the PRD's technical assumptions and project goals
|
|
2263
|
-
|
|
2240
|
+
|
|
2264
2241
|
Common patterns to consider:
|
|
2265
2242
|
- Architectural style patterns (Serverless, Event-Driven, Microservices, CQRS, Hexagonal)
|
|
2266
2243
|
- Code organization patterns (Dependency Injection, Repository, Module, Factory)
|
|
@@ -2276,23 +2253,23 @@ sections:
|
|
|
2276
2253
|
title: Tech Stack
|
|
2277
2254
|
instruction: |
|
|
2278
2255
|
This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
|
2279
|
-
|
|
2256
|
+
|
|
2280
2257
|
1. Review PRD technical assumptions and any preferences from .bmad-core/data/technical-preferences.yaml or an attached technical-preferences
|
|
2281
2258
|
2. For each category, present 2-3 viable options with pros/cons
|
|
2282
2259
|
3. Make a clear recommendation based on project needs
|
|
2283
2260
|
4. Get explicit user approval for each selection
|
|
2284
2261
|
5. Document exact versions (avoid "latest" - pin specific versions)
|
|
2285
2262
|
6. This table is the single source of truth - all other docs must reference these choices
|
|
2286
|
-
|
|
2263
|
+
|
|
2287
2264
|
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
|
-
|
|
2265
|
+
|
|
2289
2266
|
- Starter templates (if any)
|
|
2290
2267
|
- Languages and runtimes with exact versions
|
|
2291
2268
|
- Frameworks and libraries / packages
|
|
2292
2269
|
- Cloud provider and key services choices
|
|
2293
2270
|
- 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
2271
|
- Development tools
|
|
2295
|
-
|
|
2272
|
+
|
|
2296
2273
|
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
2274
|
elicit: true
|
|
2298
2275
|
sections:
|
|
@@ -2316,13 +2293,13 @@ sections:
|
|
|
2316
2293
|
title: Data Models
|
|
2317
2294
|
instruction: |
|
|
2318
2295
|
Define the core data models/entities:
|
|
2319
|
-
|
|
2296
|
+
|
|
2320
2297
|
1. Review PRD requirements and identify key business entities
|
|
2321
2298
|
2. For each model, explain its purpose and relationships
|
|
2322
2299
|
3. Include key attributes and data types
|
|
2323
2300
|
4. Show relationships between models
|
|
2324
2301
|
5. Discuss design decisions with user
|
|
2325
|
-
|
|
2302
|
+
|
|
2326
2303
|
Create a clear conceptual model before moving to database schema.
|
|
2327
2304
|
elicit: true
|
|
2328
2305
|
repeatable: true
|
|
@@ -2331,11 +2308,11 @@ sections:
|
|
|
2331
2308
|
title: "{{model_name}}"
|
|
2332
2309
|
template: |
|
|
2333
2310
|
**Purpose:** {{model_purpose}}
|
|
2334
|
-
|
|
2311
|
+
|
|
2335
2312
|
**Key Attributes:**
|
|
2336
2313
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
2337
2314
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
2338
|
-
|
|
2315
|
+
|
|
2339
2316
|
**Relationships:**
|
|
2340
2317
|
- {{relationship_1}}
|
|
2341
2318
|
- {{relationship_2}}
|
|
@@ -2344,7 +2321,7 @@ sections:
|
|
|
2344
2321
|
title: Components
|
|
2345
2322
|
instruction: |
|
|
2346
2323
|
Based on the architectural patterns, tech stack, and data models from above:
|
|
2347
|
-
|
|
2324
|
+
|
|
2348
2325
|
1. Identify major logical components/services and their responsibilities
|
|
2349
2326
|
2. Consider the repository structure (monorepo/polyrepo) from PRD
|
|
2350
2327
|
3. Define clear boundaries and interfaces between components
|
|
@@ -2353,7 +2330,7 @@ sections:
|
|
|
2353
2330
|
- Key interfaces/APIs exposed
|
|
2354
2331
|
- Dependencies on other components
|
|
2355
2332
|
- Technology specifics based on tech stack choices
|
|
2356
|
-
|
|
2333
|
+
|
|
2357
2334
|
5. Create component diagrams where helpful
|
|
2358
2335
|
elicit: true
|
|
2359
2336
|
sections:
|
|
@@ -2362,13 +2339,13 @@ sections:
|
|
|
2362
2339
|
title: "{{component_name}}"
|
|
2363
2340
|
template: |
|
|
2364
2341
|
**Responsibility:** {{component_description}}
|
|
2365
|
-
|
|
2342
|
+
|
|
2366
2343
|
**Key Interfaces:**
|
|
2367
2344
|
- {{interface_1}}
|
|
2368
2345
|
- {{interface_2}}
|
|
2369
|
-
|
|
2346
|
+
|
|
2370
2347
|
**Dependencies:** {{dependencies}}
|
|
2371
|
-
|
|
2348
|
+
|
|
2372
2349
|
**Technology Stack:** {{component_tech_details}}
|
|
2373
2350
|
- id: component-diagrams
|
|
2374
2351
|
title: Component Diagrams
|
|
@@ -2385,13 +2362,13 @@ sections:
|
|
|
2385
2362
|
condition: Project requires external API integrations
|
|
2386
2363
|
instruction: |
|
|
2387
2364
|
For each external service integration:
|
|
2388
|
-
|
|
2365
|
+
|
|
2389
2366
|
1. Identify APIs needed based on PRD requirements and component design
|
|
2390
2367
|
2. If documentation URLs are unknown, ask user for specifics
|
|
2391
2368
|
3. Document authentication methods and security considerations
|
|
2392
2369
|
4. List specific endpoints that will be used
|
|
2393
2370
|
5. Note any rate limits or usage constraints
|
|
2394
|
-
|
|
2371
|
+
|
|
2395
2372
|
If no external APIs are needed, state this explicitly and skip to next section.
|
|
2396
2373
|
elicit: true
|
|
2397
2374
|
repeatable: true
|
|
@@ -2404,10 +2381,10 @@ sections:
|
|
|
2404
2381
|
- **Base URL(s):** {{api_base_url}}
|
|
2405
2382
|
- **Authentication:** {{auth_method}}
|
|
2406
2383
|
- **Rate Limits:** {{rate_limits}}
|
|
2407
|
-
|
|
2384
|
+
|
|
2408
2385
|
**Key Endpoints Used:**
|
|
2409
2386
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
2410
|
-
|
|
2387
|
+
|
|
2411
2388
|
**Integration Notes:** {{integration_considerations}}
|
|
2412
2389
|
|
|
2413
2390
|
- id: core-workflows
|
|
@@ -2416,13 +2393,13 @@ sections:
|
|
|
2416
2393
|
mermaid_type: sequence
|
|
2417
2394
|
instruction: |
|
|
2418
2395
|
Illustrate key system workflows using sequence diagrams:
|
|
2419
|
-
|
|
2396
|
+
|
|
2420
2397
|
1. Identify critical user journeys from PRD
|
|
2421
2398
|
2. Show component interactions including external APIs
|
|
2422
2399
|
3. Include error handling paths
|
|
2423
2400
|
4. Document async operations
|
|
2424
2401
|
5. Create both high-level and detailed diagrams as needed
|
|
2425
|
-
|
|
2402
|
+
|
|
2426
2403
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
|
2427
2404
|
elicit: true
|
|
2428
2405
|
|
|
@@ -2433,13 +2410,13 @@ sections:
|
|
|
2433
2410
|
language: yaml
|
|
2434
2411
|
instruction: |
|
|
2435
2412
|
If the project includes a REST API:
|
|
2436
|
-
|
|
2413
|
+
|
|
2437
2414
|
1. Create an OpenAPI 3.0 specification
|
|
2438
2415
|
2. Include all endpoints from epics/stories
|
|
2439
2416
|
3. Define request/response schemas based on data models
|
|
2440
2417
|
4. Document authentication requirements
|
|
2441
2418
|
5. Include example requests/responses
|
|
2442
|
-
|
|
2419
|
+
|
|
2443
2420
|
Use YAML format for better readability. If no REST API, skip this section.
|
|
2444
2421
|
elicit: true
|
|
2445
2422
|
template: |
|
|
@@ -2456,13 +2433,13 @@ sections:
|
|
|
2456
2433
|
title: Database Schema
|
|
2457
2434
|
instruction: |
|
|
2458
2435
|
Transform the conceptual data models into concrete database schemas:
|
|
2459
|
-
|
|
2436
|
+
|
|
2460
2437
|
1. Use the database type(s) selected in Tech Stack
|
|
2461
2438
|
2. Create schema definitions using appropriate notation
|
|
2462
2439
|
3. Include indexes, constraints, and relationships
|
|
2463
2440
|
4. Consider performance and scalability
|
|
2464
2441
|
5. For NoSQL, show document structures
|
|
2465
|
-
|
|
2442
|
+
|
|
2466
2443
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
|
2467
2444
|
elicit: true
|
|
2468
2445
|
|
|
@@ -2472,14 +2449,14 @@ sections:
|
|
|
2472
2449
|
language: plaintext
|
|
2473
2450
|
instruction: |
|
|
2474
2451
|
Create a project folder structure that reflects:
|
|
2475
|
-
|
|
2452
|
+
|
|
2476
2453
|
1. The chosen repository structure (monorepo/polyrepo)
|
|
2477
2454
|
2. The service architecture (monolith/microservices/serverless)
|
|
2478
2455
|
3. The selected tech stack and languages
|
|
2479
2456
|
4. Component organization from above
|
|
2480
2457
|
5. Best practices for the chosen frameworks
|
|
2481
2458
|
6. Clear separation of concerns
|
|
2482
|
-
|
|
2459
|
+
|
|
2483
2460
|
Adapt the structure based on project needs. For monorepos, show service separation. For serverless, show function organization. Include language-specific conventions.
|
|
2484
2461
|
elicit: true
|
|
2485
2462
|
examples:
|
|
@@ -2497,13 +2474,13 @@ sections:
|
|
|
2497
2474
|
title: Infrastructure and Deployment
|
|
2498
2475
|
instruction: |
|
|
2499
2476
|
Define the deployment architecture and practices:
|
|
2500
|
-
|
|
2477
|
+
|
|
2501
2478
|
1. Use IaC tool selected in Tech Stack
|
|
2502
2479
|
2. Choose deployment strategy appropriate for the architecture
|
|
2503
2480
|
3. Define environments and promotion flow
|
|
2504
2481
|
4. Establish rollback procedures
|
|
2505
2482
|
5. Consider security, monitoring, and cost optimization
|
|
2506
|
-
|
|
2483
|
+
|
|
2507
2484
|
Get user input on deployment preferences and CI/CD tool choices.
|
|
2508
2485
|
elicit: true
|
|
2509
2486
|
sections:
|
|
@@ -2539,13 +2516,13 @@ sections:
|
|
|
2539
2516
|
title: Error Handling Strategy
|
|
2540
2517
|
instruction: |
|
|
2541
2518
|
Define comprehensive error handling approach:
|
|
2542
|
-
|
|
2519
|
+
|
|
2543
2520
|
1. Choose appropriate patterns for the language/framework from Tech Stack
|
|
2544
2521
|
2. Define logging standards and tools
|
|
2545
2522
|
3. Establish error categories and handling rules
|
|
2546
2523
|
4. Consider observability and debugging needs
|
|
2547
2524
|
5. Ensure security (no sensitive data in logs)
|
|
2548
|
-
|
|
2525
|
+
|
|
2549
2526
|
This section guides both AI and human developers in consistent error handling.
|
|
2550
2527
|
elicit: true
|
|
2551
2528
|
sections:
|
|
@@ -2592,13 +2569,13 @@ sections:
|
|
|
2592
2569
|
title: Coding Standards
|
|
2593
2570
|
instruction: |
|
|
2594
2571
|
These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that:
|
|
2595
|
-
|
|
2572
|
+
|
|
2596
2573
|
1. This section directly controls AI developer behavior
|
|
2597
2574
|
2. Keep it minimal - assume AI knows general best practices
|
|
2598
2575
|
3. Focus on project-specific conventions and gotchas
|
|
2599
2576
|
4. Overly detailed standards bloat context and slow development
|
|
2600
2577
|
5. Standards will be extracted to separate file for dev agent use
|
|
2601
|
-
|
|
2578
|
+
|
|
2602
2579
|
For each standard, get explicit user confirmation it's necessary.
|
|
2603
2580
|
elicit: true
|
|
2604
2581
|
sections:
|
|
@@ -2620,7 +2597,7 @@ sections:
|
|
|
2620
2597
|
- "Never use console.log in production code - use logger"
|
|
2621
2598
|
- "All API responses must use ApiResponse wrapper type"
|
|
2622
2599
|
- "Database queries must use repository pattern, never direct ORM"
|
|
2623
|
-
|
|
2600
|
+
|
|
2624
2601
|
Avoid obvious rules like "use SOLID principles" or "write clean code"
|
|
2625
2602
|
repeatable: true
|
|
2626
2603
|
template: "- **{{rule_name}}:** {{rule_description}}"
|
|
@@ -2638,14 +2615,14 @@ sections:
|
|
|
2638
2615
|
title: Test Strategy and Standards
|
|
2639
2616
|
instruction: |
|
|
2640
2617
|
Work with user to define comprehensive test strategy:
|
|
2641
|
-
|
|
2618
|
+
|
|
2642
2619
|
1. Use test frameworks from Tech Stack
|
|
2643
2620
|
2. Decide on TDD vs test-after approach
|
|
2644
2621
|
3. Define test organization and naming
|
|
2645
2622
|
4. Establish coverage goals
|
|
2646
2623
|
5. Determine integration test infrastructure
|
|
2647
2624
|
6. Plan for test data and external dependencies
|
|
2648
|
-
|
|
2625
|
+
|
|
2649
2626
|
Note: Basic info goes in Coding Standards for dev agent. This detailed section is for QA agent and team reference.
|
|
2650
2627
|
elicit: true
|
|
2651
2628
|
sections:
|
|
@@ -2666,7 +2643,7 @@ sections:
|
|
|
2666
2643
|
- **Location:** {{unit_test_location}}
|
|
2667
2644
|
- **Mocking Library:** {{mocking_library}}
|
|
2668
2645
|
- **Coverage Requirement:** {{unit_coverage}}
|
|
2669
|
-
|
|
2646
|
+
|
|
2670
2647
|
**AI Agent Requirements:**
|
|
2671
2648
|
- Generate tests for all public methods
|
|
2672
2649
|
- Cover edge cases and error conditions
|
|
@@ -2708,7 +2685,7 @@ sections:
|
|
|
2708
2685
|
title: Security
|
|
2709
2686
|
instruction: |
|
|
2710
2687
|
Define MANDATORY security requirements for AI and human developers:
|
|
2711
|
-
|
|
2688
|
+
|
|
2712
2689
|
1. Focus on implementation-specific rules
|
|
2713
2690
|
2. Reference security tools from Tech Stack
|
|
2714
2691
|
3. Define clear patterns for common scenarios
|
|
@@ -2777,16 +2754,16 @@ sections:
|
|
|
2777
2754
|
title: Next Steps
|
|
2778
2755
|
instruction: |
|
|
2779
2756
|
After completing the architecture:
|
|
2780
|
-
|
|
2757
|
+
|
|
2781
2758
|
1. If project has UI components:
|
|
2782
2759
|
- Use "Frontend Architecture Mode"
|
|
2783
2760
|
- Provide this document as input
|
|
2784
|
-
|
|
2761
|
+
|
|
2785
2762
|
2. For all projects:
|
|
2786
2763
|
- Review with Product Owner
|
|
2787
2764
|
- Begin story implementation with Dev agent
|
|
2788
2765
|
- Set up infrastructure with DevOps agent
|
|
2789
|
-
|
|
2766
|
+
|
|
2790
2767
|
3. Include specific prompts for next agents if needed
|
|
2791
2768
|
sections:
|
|
2792
2769
|
- id: architect-prompt
|
|
@@ -2819,40 +2796,40 @@ sections:
|
|
|
2819
2796
|
title: Introduction
|
|
2820
2797
|
instruction: |
|
|
2821
2798
|
IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
|
|
2822
|
-
|
|
2799
|
+
|
|
2823
2800
|
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
|
|
2824
|
-
|
|
2801
|
+
|
|
2825
2802
|
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
|
-
|
|
2803
|
+
|
|
2827
2804
|
2. **REQUIRED INPUTS**:
|
|
2828
2805
|
- Completed brownfield-prd.md
|
|
2829
2806
|
- Existing project technical documentation (from docs folder or user-provided)
|
|
2830
2807
|
- Access to existing project structure (IDE or uploaded files)
|
|
2831
|
-
|
|
2808
|
+
|
|
2832
2809
|
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
|
-
|
|
2810
|
+
|
|
2834
2811
|
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
|
-
|
|
2812
|
+
|
|
2836
2813
|
If any required inputs are missing, request them before proceeding.
|
|
2837
2814
|
elicit: true
|
|
2838
2815
|
sections:
|
|
2839
2816
|
- id: intro-content
|
|
2840
2817
|
content: |
|
|
2841
2818
|
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
|
-
|
|
2819
|
+
|
|
2843
2820
|
**Relationship to Existing Architecture:**
|
|
2844
2821
|
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
2822
|
- id: existing-project-analysis
|
|
2846
2823
|
title: Existing Project Analysis
|
|
2847
2824
|
instruction: |
|
|
2848
2825
|
Analyze the existing project structure and architecture:
|
|
2849
|
-
|
|
2826
|
+
|
|
2850
2827
|
1. Review existing documentation in docs folder
|
|
2851
2828
|
2. Examine current technology stack and versions
|
|
2852
2829
|
3. Identify existing architectural patterns and conventions
|
|
2853
2830
|
4. Note current deployment and infrastructure setup
|
|
2854
2831
|
5. Document any constraints or limitations
|
|
2855
|
-
|
|
2832
|
+
|
|
2856
2833
|
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
2834
|
elicit: true
|
|
2858
2835
|
sections:
|
|
@@ -2881,12 +2858,12 @@ sections:
|
|
|
2881
2858
|
title: Enhancement Scope and Integration Strategy
|
|
2882
2859
|
instruction: |
|
|
2883
2860
|
Define how the enhancement will integrate with the existing system:
|
|
2884
|
-
|
|
2861
|
+
|
|
2885
2862
|
1. Review the brownfield PRD enhancement scope
|
|
2886
2863
|
2. Identify integration points with existing code
|
|
2887
2864
|
3. Define boundaries between new and existing functionality
|
|
2888
2865
|
4. Establish compatibility requirements
|
|
2889
|
-
|
|
2866
|
+
|
|
2890
2867
|
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
2868
|
elicit: true
|
|
2892
2869
|
sections:
|
|
@@ -2915,7 +2892,7 @@ sections:
|
|
|
2915
2892
|
title: Tech Stack Alignment
|
|
2916
2893
|
instruction: |
|
|
2917
2894
|
Ensure new components align with existing technology choices:
|
|
2918
|
-
|
|
2895
|
+
|
|
2919
2896
|
1. Use existing technology stack as the foundation
|
|
2920
2897
|
2. Only introduce new technologies if absolutely necessary
|
|
2921
2898
|
3. Justify any new additions with clear rationale
|
|
@@ -2938,7 +2915,7 @@ sections:
|
|
|
2938
2915
|
title: Data Models and Schema Changes
|
|
2939
2916
|
instruction: |
|
|
2940
2917
|
Define new data models and how they integrate with existing schema:
|
|
2941
|
-
|
|
2918
|
+
|
|
2942
2919
|
1. Identify new entities required for the enhancement
|
|
2943
2920
|
2. Define relationships with existing data models
|
|
2944
2921
|
3. Plan database schema changes (additions, modifications)
|
|
@@ -2954,11 +2931,11 @@ sections:
|
|
|
2954
2931
|
template: |
|
|
2955
2932
|
**Purpose:** {{model_purpose}}
|
|
2956
2933
|
**Integration:** {{integration_with_existing}}
|
|
2957
|
-
|
|
2934
|
+
|
|
2958
2935
|
**Key Attributes:**
|
|
2959
2936
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
2960
2937
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
2961
|
-
|
|
2938
|
+
|
|
2962
2939
|
**Relationships:**
|
|
2963
2940
|
- **With Existing:** {{existing_relationships}}
|
|
2964
2941
|
- **With New:** {{new_relationships}}
|
|
@@ -2970,7 +2947,7 @@ sections:
|
|
|
2970
2947
|
- **Modified Tables:** {{modified_tables_list}}
|
|
2971
2948
|
- **New Indexes:** {{new_indexes_list}}
|
|
2972
2949
|
- **Migration Strategy:** {{migration_approach}}
|
|
2973
|
-
|
|
2950
|
+
|
|
2974
2951
|
**Backward Compatibility:**
|
|
2975
2952
|
- {{compatibility_measure_1}}
|
|
2976
2953
|
- {{compatibility_measure_2}}
|
|
@@ -2979,12 +2956,12 @@ sections:
|
|
|
2979
2956
|
title: Component Architecture
|
|
2980
2957
|
instruction: |
|
|
2981
2958
|
Define new components and their integration with existing architecture:
|
|
2982
|
-
|
|
2959
|
+
|
|
2983
2960
|
1. Identify new components required for the enhancement
|
|
2984
2961
|
2. Define interfaces with existing components
|
|
2985
2962
|
3. Establish clear boundaries and responsibilities
|
|
2986
2963
|
4. Plan integration points and data flow
|
|
2987
|
-
|
|
2964
|
+
|
|
2988
2965
|
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
2966
|
elicit: true
|
|
2990
2967
|
sections:
|
|
@@ -2997,15 +2974,15 @@ sections:
|
|
|
2997
2974
|
template: |
|
|
2998
2975
|
**Responsibility:** {{component_description}}
|
|
2999
2976
|
**Integration Points:** {{integration_points}}
|
|
3000
|
-
|
|
2977
|
+
|
|
3001
2978
|
**Key Interfaces:**
|
|
3002
2979
|
- {{interface_1}}
|
|
3003
2980
|
- {{interface_2}}
|
|
3004
|
-
|
|
2981
|
+
|
|
3005
2982
|
**Dependencies:**
|
|
3006
2983
|
- **Existing Components:** {{existing_dependencies}}
|
|
3007
2984
|
- **New Components:** {{new_dependencies}}
|
|
3008
|
-
|
|
2985
|
+
|
|
3009
2986
|
**Technology Stack:** {{component_tech_details}}
|
|
3010
2987
|
- id: interaction-diagram
|
|
3011
2988
|
title: Component Interaction Diagram
|
|
@@ -3018,7 +2995,7 @@ sections:
|
|
|
3018
2995
|
condition: Enhancement requires API changes
|
|
3019
2996
|
instruction: |
|
|
3020
2997
|
Define new API endpoints and integration with existing APIs:
|
|
3021
|
-
|
|
2998
|
+
|
|
3022
2999
|
1. Plan new API endpoints required for the enhancement
|
|
3023
3000
|
2. Ensure consistency with existing API patterns
|
|
3024
3001
|
3. Define authentication and authorization integration
|
|
@@ -3068,17 +3045,17 @@ sections:
|
|
|
3068
3045
|
- **Base URL:** {{api_base_url}}
|
|
3069
3046
|
- **Authentication:** {{auth_method}}
|
|
3070
3047
|
- **Integration Method:** {{integration_approach}}
|
|
3071
|
-
|
|
3048
|
+
|
|
3072
3049
|
**Key Endpoints Used:**
|
|
3073
3050
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
3074
|
-
|
|
3051
|
+
|
|
3075
3052
|
**Error Handling:** {{error_handling_strategy}}
|
|
3076
3053
|
|
|
3077
3054
|
- id: source-tree-integration
|
|
3078
3055
|
title: Source Tree Integration
|
|
3079
3056
|
instruction: |
|
|
3080
3057
|
Define how new code will integrate with existing project structure:
|
|
3081
|
-
|
|
3058
|
+
|
|
3082
3059
|
1. Follow existing project organization patterns
|
|
3083
3060
|
2. Identify where new files/folders will be placed
|
|
3084
3061
|
3. Ensure consistency with existing naming conventions
|
|
@@ -3117,7 +3094,7 @@ sections:
|
|
|
3117
3094
|
title: Infrastructure and Deployment Integration
|
|
3118
3095
|
instruction: |
|
|
3119
3096
|
Define how the enhancement will be deployed alongside existing infrastructure:
|
|
3120
|
-
|
|
3097
|
+
|
|
3121
3098
|
1. Use existing deployment pipeline and infrastructure
|
|
3122
3099
|
2. Identify any infrastructure changes needed
|
|
3123
3100
|
3. Plan deployment strategy to minimize risk
|
|
@@ -3147,7 +3124,7 @@ sections:
|
|
|
3147
3124
|
title: Coding Standards and Conventions
|
|
3148
3125
|
instruction: |
|
|
3149
3126
|
Ensure new code follows existing project conventions:
|
|
3150
|
-
|
|
3127
|
+
|
|
3151
3128
|
1. Document existing coding standards from project analysis
|
|
3152
3129
|
2. Identify any enhancement-specific requirements
|
|
3153
3130
|
3. Ensure consistency with existing codebase patterns
|
|
@@ -3178,7 +3155,7 @@ sections:
|
|
|
3178
3155
|
title: Testing Strategy
|
|
3179
3156
|
instruction: |
|
|
3180
3157
|
Define testing approach for the enhancement:
|
|
3181
|
-
|
|
3158
|
+
|
|
3182
3159
|
1. Integrate with existing test suite
|
|
3183
3160
|
2. Ensure existing functionality remains intact
|
|
3184
3161
|
3. Plan for testing new features
|
|
@@ -3218,7 +3195,7 @@ sections:
|
|
|
3218
3195
|
title: Security Integration
|
|
3219
3196
|
instruction: |
|
|
3220
3197
|
Ensure security consistency with existing system:
|
|
3221
|
-
|
|
3198
|
+
|
|
3222
3199
|
1. Follow existing security patterns and tools
|
|
3223
3200
|
2. Ensure new features don't introduce vulnerabilities
|
|
3224
3201
|
3. Maintain existing security posture
|
|
@@ -3253,7 +3230,7 @@ sections:
|
|
|
3253
3230
|
title: Next Steps
|
|
3254
3231
|
instruction: |
|
|
3255
3232
|
After completing the brownfield architecture:
|
|
3256
|
-
|
|
3233
|
+
|
|
3257
3234
|
1. Review integration points with existing system
|
|
3258
3235
|
2. Begin story implementation with Dev agent
|
|
3259
3236
|
3. Set up deployment pipeline integration
|
|
@@ -3298,19 +3275,19 @@ sections:
|
|
|
3298
3275
|
title: Intro Project Analysis and Context
|
|
3299
3276
|
instruction: |
|
|
3300
3277
|
IMPORTANT - SCOPE ASSESSMENT REQUIRED:
|
|
3301
|
-
|
|
3278
|
+
|
|
3302
3279
|
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
|
|
3303
|
-
|
|
3280
|
+
|
|
3304
3281
|
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
|
-
|
|
3282
|
+
|
|
3306
3283
|
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
|
-
|
|
3284
|
+
|
|
3308
3285
|
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
|
-
|
|
3286
|
+
|
|
3310
3287
|
Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
|
|
3311
|
-
|
|
3288
|
+
|
|
3312
3289
|
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
|
-
|
|
3290
|
+
|
|
3314
3291
|
Do not proceed with any recommendations until the user has validated your understanding of the existing system.
|
|
3315
3292
|
sections:
|
|
3316
3293
|
- id: existing-project-overview
|
|
@@ -3336,7 +3313,7 @@ sections:
|
|
|
3336
3313
|
- Note: "Document-project analysis available - using existing technical documentation"
|
|
3337
3314
|
- List key documents created by document-project
|
|
3338
3315
|
- Skip the missing documentation check below
|
|
3339
|
-
|
|
3316
|
+
|
|
3340
3317
|
Otherwise, check for existing documentation:
|
|
3341
3318
|
sections:
|
|
3342
3319
|
- id: available-docs
|
|
@@ -3460,7 +3437,7 @@ sections:
|
|
|
3460
3437
|
If document-project output available:
|
|
3461
3438
|
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
|
3462
3439
|
- Include version numbers and any noted constraints
|
|
3463
|
-
|
|
3440
|
+
|
|
3464
3441
|
Otherwise, document the current technology stack:
|
|
3465
3442
|
template: |
|
|
3466
3443
|
**Languages**: {{languages}}
|
|
@@ -3499,7 +3476,7 @@ sections:
|
|
|
3499
3476
|
- Reference "Technical Debt and Known Issues" section
|
|
3500
3477
|
- Include "Workarounds and Gotchas" that might impact enhancement
|
|
3501
3478
|
- Note any identified constraints from "Critical Technical Debt"
|
|
3502
|
-
|
|
3479
|
+
|
|
3503
3480
|
Build risk assessment incorporating existing known issues:
|
|
3504
3481
|
template: |
|
|
3505
3482
|
**Technical Risks**: {{technical_risks}}
|
|
@@ -3522,7 +3499,7 @@ sections:
|
|
|
3522
3499
|
title: "Epic 1: {{enhancement_title}}"
|
|
3523
3500
|
instruction: |
|
|
3524
3501
|
Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
|
|
3525
|
-
|
|
3502
|
+
|
|
3526
3503
|
CRITICAL STORY SEQUENCING FOR BROWNFIELD:
|
|
3527
3504
|
- Stories must ensure existing functionality remains intact
|
|
3528
3505
|
- Each story should include verification that existing features still work
|
|
@@ -3535,7 +3512,7 @@ sections:
|
|
|
3535
3512
|
- Each story must deliver value while maintaining system integrity
|
|
3536
3513
|
template: |
|
|
3537
3514
|
**Epic Goal**: {{epic_goal}}
|
|
3538
|
-
|
|
3515
|
+
|
|
3539
3516
|
**Integration Requirements**: {{integration_requirements}}
|
|
3540
3517
|
sections:
|
|
3541
3518
|
- id: story
|
|
@@ -3641,7 +3618,7 @@ sections:
|
|
|
3641
3618
|
title: Competitor Prioritization Matrix
|
|
3642
3619
|
instruction: |
|
|
3643
3620
|
Help categorize competitors by market share and strategic threat level
|
|
3644
|
-
|
|
3621
|
+
|
|
3645
3622
|
Create a 2x2 matrix:
|
|
3646
3623
|
- Priority 1 (Core Competitors): High Market Share + High Threat
|
|
3647
3624
|
- Priority 2 (Emerging Threats): Low Market Share + High Threat
|
|
@@ -3706,7 +3683,14 @@ sections:
|
|
|
3706
3683
|
title: Feature Comparison Matrix
|
|
3707
3684
|
instruction: Create a detailed comparison table of key features across competitors
|
|
3708
3685
|
type: table
|
|
3709
|
-
columns:
|
|
3686
|
+
columns:
|
|
3687
|
+
[
|
|
3688
|
+
"Feature Category",
|
|
3689
|
+
"{{your_company}}",
|
|
3690
|
+
"{{competitor_1}}",
|
|
3691
|
+
"{{competitor_2}}",
|
|
3692
|
+
"{{competitor_3}}",
|
|
3693
|
+
]
|
|
3710
3694
|
rows:
|
|
3711
3695
|
- category: "Core Functionality"
|
|
3712
3696
|
items:
|
|
@@ -3718,7 +3702,13 @@ sections:
|
|
|
3718
3702
|
- ["Onboarding Time", "{{time}}", "{{time}}", "{{time}}", "{{time}}"]
|
|
3719
3703
|
- category: "Integration & Ecosystem"
|
|
3720
3704
|
items:
|
|
3721
|
-
- [
|
|
3705
|
+
- [
|
|
3706
|
+
"API Availability",
|
|
3707
|
+
"{{availability}}",
|
|
3708
|
+
"{{availability}}",
|
|
3709
|
+
"{{availability}}",
|
|
3710
|
+
"{{availability}}",
|
|
3711
|
+
]
|
|
3722
3712
|
- ["Third-party Integrations", "{{number}}", "{{number}}", "{{number}}", "{{number}}"]
|
|
3723
3713
|
- category: "Pricing & Plans"
|
|
3724
3714
|
items:
|
|
@@ -3745,7 +3735,7 @@ sections:
|
|
|
3745
3735
|
title: Positioning Map
|
|
3746
3736
|
instruction: |
|
|
3747
3737
|
Describe competitor positions on key dimensions
|
|
3748
|
-
|
|
3738
|
+
|
|
3749
3739
|
Create a positioning description using 2 key dimensions relevant to the market, such as:
|
|
3750
3740
|
- Price vs. Features
|
|
3751
3741
|
- Ease of Use vs. Power
|
|
@@ -3780,7 +3770,7 @@ sections:
|
|
|
3780
3770
|
title: Blue Ocean Opportunities
|
|
3781
3771
|
instruction: |
|
|
3782
3772
|
Identify uncontested market spaces
|
|
3783
|
-
|
|
3773
|
+
|
|
3784
3774
|
List opportunities to create new market space:
|
|
3785
3775
|
- Underserved segments
|
|
3786
3776
|
- Unaddressed use cases
|
|
@@ -3877,16 +3867,16 @@ sections:
|
|
|
3877
3867
|
title: Template and Framework Selection
|
|
3878
3868
|
instruction: |
|
|
3879
3869
|
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
|
-
|
|
3870
|
+
|
|
3881
3871
|
Before proceeding with frontend architecture design, check if the project is using a frontend starter template or existing codebase:
|
|
3882
|
-
|
|
3872
|
+
|
|
3883
3873
|
1. Review the PRD, main architecture document, and brainstorming brief for mentions of:
|
|
3884
3874
|
- Frontend starter templates (e.g., Create React App, Next.js, Vite, Vue CLI, Angular CLI, etc.)
|
|
3885
3875
|
- UI kit or component library starters
|
|
3886
3876
|
- Existing frontend projects being used as a foundation
|
|
3887
3877
|
- Admin dashboard templates or other specialized starters
|
|
3888
3878
|
- Design system implementations
|
|
3889
|
-
|
|
3879
|
+
|
|
3890
3880
|
2. If a frontend starter template or existing project is mentioned:
|
|
3891
3881
|
- Ask the user to provide access via one of these methods:
|
|
3892
3882
|
- Link to the starter template documentation
|
|
@@ -3902,7 +3892,7 @@ sections:
|
|
|
3902
3892
|
- Testing setup and patterns
|
|
3903
3893
|
- Build and development scripts
|
|
3904
3894
|
- Use this analysis to ensure your frontend architecture aligns with the starter's patterns
|
|
3905
|
-
|
|
3895
|
+
|
|
3906
3896
|
3. If no frontend starter is mentioned but this is a new UI, ensure we know what the ui language and framework is:
|
|
3907
3897
|
- Based on the framework choice, suggest appropriate starters:
|
|
3908
3898
|
- React: Create React App, Next.js, Vite + React
|
|
@@ -3910,11 +3900,11 @@ sections:
|
|
|
3910
3900
|
- Angular: Angular CLI
|
|
3911
3901
|
- Or suggest popular UI templates if applicable
|
|
3912
3902
|
- Explain benefits specific to frontend development
|
|
3913
|
-
|
|
3903
|
+
|
|
3914
3904
|
4. If the user confirms no starter template will be used:
|
|
3915
3905
|
- Note that all tooling, bundling, and configuration will need manual setup
|
|
3916
3906
|
- Proceed with frontend architecture from scratch
|
|
3917
|
-
|
|
3907
|
+
|
|
3918
3908
|
Document the starter template decision and any constraints it imposes before proceeding.
|
|
3919
3909
|
sections:
|
|
3920
3910
|
- id: changelog
|
|
@@ -3936,12 +3926,24 @@ sections:
|
|
|
3936
3926
|
rows:
|
|
3937
3927
|
- ["Framework", "{{framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3938
3928
|
- ["UI Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3939
|
-
- [
|
|
3929
|
+
- [
|
|
3930
|
+
"State Management",
|
|
3931
|
+
"{{state_management}}",
|
|
3932
|
+
"{{version}}",
|
|
3933
|
+
"{{purpose}}",
|
|
3934
|
+
"{{why_chosen}}",
|
|
3935
|
+
]
|
|
3940
3936
|
- ["Routing", "{{routing_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3941
3937
|
- ["Build Tool", "{{build_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3942
3938
|
- ["Styling", "{{styling_solution}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3943
3939
|
- ["Testing", "{{test_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3944
|
-
- [
|
|
3940
|
+
- [
|
|
3941
|
+
"Component Library",
|
|
3942
|
+
"{{component_lib}}",
|
|
3943
|
+
"{{version}}",
|
|
3944
|
+
"{{purpose}}",
|
|
3945
|
+
"{{why_chosen}}",
|
|
3946
|
+
]
|
|
3945
3947
|
- ["Form Handling", "{{form_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3946
3948
|
- ["Animation", "{{animation_lib}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
3947
3949
|
- ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
@@ -4086,7 +4088,7 @@ sections:
|
|
|
4086
4088
|
title: Introduction
|
|
4087
4089
|
instruction: |
|
|
4088
4090
|
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
|
-
|
|
4091
|
+
|
|
4090
4092
|
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
|
4091
4093
|
content: |
|
|
4092
4094
|
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 +4097,7 @@ sections:
|
|
|
4095
4097
|
title: Overall UX Goals & Principles
|
|
4096
4098
|
instruction: |
|
|
4097
4099
|
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
|
4098
|
-
|
|
4100
|
+
|
|
4099
4101
|
1. Target User Personas - elicit details or confirm existing ones from PRD
|
|
4100
4102
|
2. Key Usability Goals - understand what success looks like for users
|
|
4101
4103
|
3. Core Design Principles - establish 3-5 guiding principles
|
|
@@ -4136,7 +4138,7 @@ sections:
|
|
|
4136
4138
|
title: Information Architecture (IA)
|
|
4137
4139
|
instruction: |
|
|
4138
4140
|
Collaborate with the user to create a comprehensive information architecture:
|
|
4139
|
-
|
|
4141
|
+
|
|
4140
4142
|
1. Build a Site Map or Screen Inventory showing all major areas
|
|
4141
4143
|
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
|
4142
4144
|
3. Use Mermaid diagrams for visual representation
|
|
@@ -4166,22 +4168,22 @@ sections:
|
|
|
4166
4168
|
title: Navigation Structure
|
|
4167
4169
|
template: |
|
|
4168
4170
|
**Primary Navigation:** {{primary_nav_description}}
|
|
4169
|
-
|
|
4171
|
+
|
|
4170
4172
|
**Secondary Navigation:** {{secondary_nav_description}}
|
|
4171
|
-
|
|
4173
|
+
|
|
4172
4174
|
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
|
4173
4175
|
|
|
4174
4176
|
- id: user-flows
|
|
4175
4177
|
title: User Flows
|
|
4176
4178
|
instruction: |
|
|
4177
4179
|
For each critical user task identified in the PRD:
|
|
4178
|
-
|
|
4180
|
+
|
|
4179
4181
|
1. Define the user's goal clearly
|
|
4180
4182
|
2. Map out all steps including decision points
|
|
4181
4183
|
3. Consider edge cases and error states
|
|
4182
4184
|
4. Use Mermaid flow diagrams for clarity
|
|
4183
4185
|
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
|
4184
|
-
|
|
4186
|
+
|
|
4185
4187
|
Create subsections for each major flow.
|
|
4186
4188
|
elicit: true
|
|
4187
4189
|
repeatable: true
|
|
@@ -4190,9 +4192,9 @@ sections:
|
|
|
4190
4192
|
title: "{{flow_name}}"
|
|
4191
4193
|
template: |
|
|
4192
4194
|
**User Goal:** {{flow_goal}}
|
|
4193
|
-
|
|
4195
|
+
|
|
4194
4196
|
**Entry Points:** {{entry_points}}
|
|
4195
|
-
|
|
4197
|
+
|
|
4196
4198
|
**Success Criteria:** {{success_criteria}}
|
|
4197
4199
|
sections:
|
|
4198
4200
|
- id: flow-diagram
|
|
@@ -4223,14 +4225,14 @@ sections:
|
|
|
4223
4225
|
title: "{{screen_name}}"
|
|
4224
4226
|
template: |
|
|
4225
4227
|
**Purpose:** {{screen_purpose}}
|
|
4226
|
-
|
|
4228
|
+
|
|
4227
4229
|
**Key Elements:**
|
|
4228
4230
|
- {{element_1}}
|
|
4229
4231
|
- {{element_2}}
|
|
4230
4232
|
- {{element_3}}
|
|
4231
|
-
|
|
4233
|
+
|
|
4232
4234
|
**Interaction Notes:** {{interaction_notes}}
|
|
4233
|
-
|
|
4235
|
+
|
|
4234
4236
|
**Design File Reference:** {{specific_frame_link}}
|
|
4235
4237
|
|
|
4236
4238
|
- id: component-library
|
|
@@ -4249,11 +4251,11 @@ sections:
|
|
|
4249
4251
|
title: "{{component_name}}"
|
|
4250
4252
|
template: |
|
|
4251
4253
|
**Purpose:** {{component_purpose}}
|
|
4252
|
-
|
|
4254
|
+
|
|
4253
4255
|
**Variants:** {{component_variants}}
|
|
4254
|
-
|
|
4256
|
+
|
|
4255
4257
|
**States:** {{component_states}}
|
|
4256
|
-
|
|
4258
|
+
|
|
4257
4259
|
**Usage Guidelines:** {{usage_guidelines}}
|
|
4258
4260
|
|
|
4259
4261
|
- id: branding-style
|
|
@@ -4299,13 +4301,13 @@ sections:
|
|
|
4299
4301
|
title: Iconography
|
|
4300
4302
|
template: |
|
|
4301
4303
|
**Icon Library:** {{icon_library}}
|
|
4302
|
-
|
|
4304
|
+
|
|
4303
4305
|
**Usage Guidelines:** {{icon_guidelines}}
|
|
4304
4306
|
- id: spacing-layout
|
|
4305
4307
|
title: Spacing & Layout
|
|
4306
4308
|
template: |
|
|
4307
4309
|
**Grid System:** {{grid_system}}
|
|
4308
|
-
|
|
4310
|
+
|
|
4309
4311
|
**Spacing Scale:** {{spacing_scale}}
|
|
4310
4312
|
|
|
4311
4313
|
- id: accessibility
|
|
@@ -4323,12 +4325,12 @@ sections:
|
|
|
4323
4325
|
- Color contrast ratios: {{contrast_requirements}}
|
|
4324
4326
|
- Focus indicators: {{focus_requirements}}
|
|
4325
4327
|
- Text sizing: {{text_requirements}}
|
|
4326
|
-
|
|
4328
|
+
|
|
4327
4329
|
**Interaction:**
|
|
4328
4330
|
- Keyboard navigation: {{keyboard_requirements}}
|
|
4329
4331
|
- Screen reader support: {{screen_reader_requirements}}
|
|
4330
4332
|
- Touch targets: {{touch_requirements}}
|
|
4331
|
-
|
|
4333
|
+
|
|
4332
4334
|
**Content:**
|
|
4333
4335
|
- Alternative text: {{alt_text_requirements}}
|
|
4334
4336
|
- Heading structure: {{heading_requirements}}
|
|
@@ -4355,11 +4357,11 @@ sections:
|
|
|
4355
4357
|
title: Adaptation Patterns
|
|
4356
4358
|
template: |
|
|
4357
4359
|
**Layout Changes:** {{layout_adaptations}}
|
|
4358
|
-
|
|
4360
|
+
|
|
4359
4361
|
**Navigation Changes:** {{nav_adaptations}}
|
|
4360
|
-
|
|
4362
|
+
|
|
4361
4363
|
**Content Priority:** {{content_adaptations}}
|
|
4362
|
-
|
|
4364
|
+
|
|
4363
4365
|
**Interaction Changes:** {{interaction_adaptations}}
|
|
4364
4366
|
|
|
4365
4367
|
- id: animation
|
|
@@ -4393,7 +4395,7 @@ sections:
|
|
|
4393
4395
|
title: Next Steps
|
|
4394
4396
|
instruction: |
|
|
4395
4397
|
After completing the UI/UX specification:
|
|
4396
|
-
|
|
4398
|
+
|
|
4397
4399
|
1. Recommend review with stakeholders
|
|
4398
4400
|
2. Suggest creating/updating visual designs in design tool
|
|
4399
4401
|
3. Prepare for handoff to Design Architect for frontend architecture
|
|
@@ -4441,33 +4443,33 @@ sections:
|
|
|
4441
4443
|
elicit: true
|
|
4442
4444
|
content: |
|
|
4443
4445
|
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
|
-
|
|
4446
|
+
|
|
4445
4447
|
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
4448
|
sections:
|
|
4447
4449
|
- id: starter-template
|
|
4448
4450
|
title: Starter Template or Existing Project
|
|
4449
4451
|
instruction: |
|
|
4450
4452
|
Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases:
|
|
4451
|
-
|
|
4453
|
+
|
|
4452
4454
|
1. Review the PRD and other documents for mentions of:
|
|
4453
4455
|
- Fullstack starter templates (e.g., T3 Stack, MEAN/MERN starters, Django + React templates)
|
|
4454
4456
|
- Monorepo templates (e.g., Nx, Turborepo starters)
|
|
4455
4457
|
- Platform-specific starters (e.g., Vercel templates, AWS Amplify starters)
|
|
4456
4458
|
- Existing projects being extended or cloned
|
|
4457
|
-
|
|
4459
|
+
|
|
4458
4460
|
2. If starter templates or existing projects are mentioned:
|
|
4459
4461
|
- Ask the user to provide access (links, repos, or files)
|
|
4460
4462
|
- Analyze to understand pre-configured choices and constraints
|
|
4461
4463
|
- Note any architectural decisions already made
|
|
4462
4464
|
- Identify what can be modified vs what must be retained
|
|
4463
|
-
|
|
4465
|
+
|
|
4464
4466
|
3. If no starter is mentioned but this is greenfield:
|
|
4465
4467
|
- Suggest appropriate fullstack starters based on tech preferences
|
|
4466
4468
|
- Consider platform-specific options (Vercel, AWS, etc.)
|
|
4467
4469
|
- Let user decide whether to use one
|
|
4468
|
-
|
|
4470
|
+
|
|
4469
4471
|
4. Document the decision and any constraints it imposes
|
|
4470
|
-
|
|
4472
|
+
|
|
4471
4473
|
If none, state "N/A - Greenfield project"
|
|
4472
4474
|
- id: changelog
|
|
4473
4475
|
title: Change Log
|
|
@@ -4493,17 +4495,17 @@ sections:
|
|
|
4493
4495
|
title: Platform and Infrastructure Choice
|
|
4494
4496
|
instruction: |
|
|
4495
4497
|
Based on PRD requirements and technical assumptions, make a platform recommendation:
|
|
4496
|
-
|
|
4498
|
+
|
|
4497
4499
|
1. Consider common patterns (not an exhaustive list, use your own best judgement and search the web as needed for emerging trends):
|
|
4498
4500
|
- **Vercel + Supabase**: For rapid development with Next.js, built-in auth/storage
|
|
4499
4501
|
- **AWS Full Stack**: For enterprise scale with Lambda, API Gateway, S3, Cognito
|
|
4500
4502
|
- **Azure**: For .NET ecosystems or enterprise Microsoft environments
|
|
4501
4503
|
- **Google Cloud**: For ML/AI heavy applications or Google ecosystem integration
|
|
4502
|
-
|
|
4504
|
+
|
|
4503
4505
|
2. Present 2-3 viable options with clear pros/cons
|
|
4504
4506
|
3. Make a recommendation with rationale
|
|
4505
4507
|
4. Get explicit user confirmation
|
|
4506
|
-
|
|
4508
|
+
|
|
4507
4509
|
Document the choice and key services that will be used.
|
|
4508
4510
|
template: |
|
|
4509
4511
|
**Platform:** {{selected_platform}}
|
|
@@ -4513,7 +4515,7 @@ sections:
|
|
|
4513
4515
|
title: Repository Structure
|
|
4514
4516
|
instruction: |
|
|
4515
4517
|
Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure:
|
|
4516
|
-
|
|
4518
|
+
|
|
4517
4519
|
1. For modern fullstack apps, monorepo is often preferred
|
|
4518
4520
|
2. Consider tooling (Nx, Turborepo, Lerna, npm workspaces)
|
|
4519
4521
|
3. Define package/app boundaries
|
|
@@ -4535,7 +4537,7 @@ sections:
|
|
|
4535
4537
|
- Databases and storage
|
|
4536
4538
|
- External integrations
|
|
4537
4539
|
- CDN and caching layers
|
|
4538
|
-
|
|
4540
|
+
|
|
4539
4541
|
Use appropriate diagram type for clarity.
|
|
4540
4542
|
- id: architectural-patterns
|
|
4541
4543
|
title: Architectural Patterns
|
|
@@ -4545,7 +4547,7 @@ sections:
|
|
|
4545
4547
|
- Frontend patterns (e.g., Component-based, State management)
|
|
4546
4548
|
- Backend patterns (e.g., Repository, CQRS, Event-driven)
|
|
4547
4549
|
- Integration patterns (e.g., BFF, API Gateway)
|
|
4548
|
-
|
|
4550
|
+
|
|
4549
4551
|
For each pattern, provide recommendation and rationale.
|
|
4550
4552
|
repeatable: true
|
|
4551
4553
|
template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
|
|
@@ -4559,7 +4561,7 @@ sections:
|
|
|
4559
4561
|
title: Tech Stack
|
|
4560
4562
|
instruction: |
|
|
4561
4563
|
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
|
-
|
|
4564
|
+
|
|
4563
4565
|
Key areas to cover:
|
|
4564
4566
|
- Frontend and backend languages/frameworks
|
|
4565
4567
|
- Databases and caching
|
|
@@ -4568,7 +4570,7 @@ sections:
|
|
|
4568
4570
|
- Testing tools for both frontend and backend
|
|
4569
4571
|
- Build and deployment tools
|
|
4570
4572
|
- Monitoring and logging
|
|
4571
|
-
|
|
4573
|
+
|
|
4572
4574
|
Upon render, elicit feedback immediately.
|
|
4573
4575
|
elicit: true
|
|
4574
4576
|
sections:
|
|
@@ -4578,11 +4580,29 @@ sections:
|
|
|
4578
4580
|
columns: [Category, Technology, Version, Purpose, Rationale]
|
|
4579
4581
|
rows:
|
|
4580
4582
|
- ["Frontend Language", "{{fe_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4581
|
-
- [
|
|
4582
|
-
|
|
4583
|
+
- [
|
|
4584
|
+
"Frontend Framework",
|
|
4585
|
+
"{{fe_framework}}",
|
|
4586
|
+
"{{version}}",
|
|
4587
|
+
"{{purpose}}",
|
|
4588
|
+
"{{why_chosen}}",
|
|
4589
|
+
]
|
|
4590
|
+
- [
|
|
4591
|
+
"UI Component Library",
|
|
4592
|
+
"{{ui_library}}",
|
|
4593
|
+
"{{version}}",
|
|
4594
|
+
"{{purpose}}",
|
|
4595
|
+
"{{why_chosen}}",
|
|
4596
|
+
]
|
|
4583
4597
|
- ["State Management", "{{state_mgmt}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4584
4598
|
- ["Backend Language", "{{be_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4585
|
-
- [
|
|
4599
|
+
- [
|
|
4600
|
+
"Backend Framework",
|
|
4601
|
+
"{{be_framework}}",
|
|
4602
|
+
"{{version}}",
|
|
4603
|
+
"{{purpose}}",
|
|
4604
|
+
"{{why_chosen}}",
|
|
4605
|
+
]
|
|
4586
4606
|
- ["API Style", "{{api_style}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4587
4607
|
- ["Database", "{{database}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
4588
4608
|
- ["Cache", "{{cache}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
|
|
@@ -4603,14 +4623,14 @@ sections:
|
|
|
4603
4623
|
title: Data Models
|
|
4604
4624
|
instruction: |
|
|
4605
4625
|
Define the core data models/entities that will be shared between frontend and backend:
|
|
4606
|
-
|
|
4626
|
+
|
|
4607
4627
|
1. Review PRD requirements and identify key business entities
|
|
4608
4628
|
2. For each model, explain its purpose and relationships
|
|
4609
4629
|
3. Include key attributes and data types
|
|
4610
4630
|
4. Show relationships between models
|
|
4611
4631
|
5. Create TypeScript interfaces that can be shared
|
|
4612
4632
|
6. Discuss design decisions with user
|
|
4613
|
-
|
|
4633
|
+
|
|
4614
4634
|
Create a clear conceptual model before moving to database schema.
|
|
4615
4635
|
elicit: true
|
|
4616
4636
|
repeatable: true
|
|
@@ -4619,7 +4639,7 @@ sections:
|
|
|
4619
4639
|
title: "{{model_name}}"
|
|
4620
4640
|
template: |
|
|
4621
4641
|
**Purpose:** {{model_purpose}}
|
|
4622
|
-
|
|
4642
|
+
|
|
4623
4643
|
**Key Attributes:**
|
|
4624
4644
|
- {{attribute_1}}: {{type_1}} - {{description_1}}
|
|
4625
4645
|
- {{attribute_2}}: {{type_2}} - {{description_2}}
|
|
@@ -4638,7 +4658,7 @@ sections:
|
|
|
4638
4658
|
title: API Specification
|
|
4639
4659
|
instruction: |
|
|
4640
4660
|
Based on the chosen API style from Tech Stack:
|
|
4641
|
-
|
|
4661
|
+
|
|
4642
4662
|
1. If REST API, create an OpenAPI 3.0 specification
|
|
4643
4663
|
2. If GraphQL, provide the GraphQL schema
|
|
4644
4664
|
3. If tRPC, show router definitions
|
|
@@ -4646,7 +4666,7 @@ sections:
|
|
|
4646
4666
|
5. Define request/response schemas based on data models
|
|
4647
4667
|
6. Document authentication requirements
|
|
4648
4668
|
7. Include example requests/responses
|
|
4649
|
-
|
|
4669
|
+
|
|
4650
4670
|
Use appropriate format for the chosen API style. If no API (e.g., static site), skip this section.
|
|
4651
4671
|
elicit: true
|
|
4652
4672
|
sections:
|
|
@@ -4681,7 +4701,7 @@ sections:
|
|
|
4681
4701
|
title: Components
|
|
4682
4702
|
instruction: |
|
|
4683
4703
|
Based on the architectural patterns, tech stack, and data models from above:
|
|
4684
|
-
|
|
4704
|
+
|
|
4685
4705
|
1. Identify major logical components/services across the fullstack
|
|
4686
4706
|
2. Consider both frontend and backend components
|
|
4687
4707
|
3. Define clear boundaries and interfaces between components
|
|
@@ -4690,7 +4710,7 @@ sections:
|
|
|
4690
4710
|
- Key interfaces/APIs exposed
|
|
4691
4711
|
- Dependencies on other components
|
|
4692
4712
|
- Technology specifics based on tech stack choices
|
|
4693
|
-
|
|
4713
|
+
|
|
4694
4714
|
5. Create component diagrams where helpful
|
|
4695
4715
|
elicit: true
|
|
4696
4716
|
sections:
|
|
@@ -4699,13 +4719,13 @@ sections:
|
|
|
4699
4719
|
title: "{{component_name}}"
|
|
4700
4720
|
template: |
|
|
4701
4721
|
**Responsibility:** {{component_description}}
|
|
4702
|
-
|
|
4722
|
+
|
|
4703
4723
|
**Key Interfaces:**
|
|
4704
4724
|
- {{interface_1}}
|
|
4705
4725
|
- {{interface_2}}
|
|
4706
|
-
|
|
4726
|
+
|
|
4707
4727
|
**Dependencies:** {{dependencies}}
|
|
4708
|
-
|
|
4728
|
+
|
|
4709
4729
|
**Technology Stack:** {{component_tech_details}}
|
|
4710
4730
|
- id: component-diagrams
|
|
4711
4731
|
title: Component Diagrams
|
|
@@ -4722,13 +4742,13 @@ sections:
|
|
|
4722
4742
|
condition: Project requires external API integrations
|
|
4723
4743
|
instruction: |
|
|
4724
4744
|
For each external service integration:
|
|
4725
|
-
|
|
4745
|
+
|
|
4726
4746
|
1. Identify APIs needed based on PRD requirements and component design
|
|
4727
4747
|
2. If documentation URLs are unknown, ask user for specifics
|
|
4728
4748
|
3. Document authentication methods and security considerations
|
|
4729
4749
|
4. List specific endpoints that will be used
|
|
4730
4750
|
5. Note any rate limits or usage constraints
|
|
4731
|
-
|
|
4751
|
+
|
|
4732
4752
|
If no external APIs are needed, state this explicitly and skip to next section.
|
|
4733
4753
|
elicit: true
|
|
4734
4754
|
repeatable: true
|
|
@@ -4741,10 +4761,10 @@ sections:
|
|
|
4741
4761
|
- **Base URL(s):** {{api_base_url}}
|
|
4742
4762
|
- **Authentication:** {{auth_method}}
|
|
4743
4763
|
- **Rate Limits:** {{rate_limits}}
|
|
4744
|
-
|
|
4764
|
+
|
|
4745
4765
|
**Key Endpoints Used:**
|
|
4746
4766
|
- `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
|
|
4747
|
-
|
|
4767
|
+
|
|
4748
4768
|
**Integration Notes:** {{integration_considerations}}
|
|
4749
4769
|
|
|
4750
4770
|
- id: core-workflows
|
|
@@ -4753,14 +4773,14 @@ sections:
|
|
|
4753
4773
|
mermaid_type: sequence
|
|
4754
4774
|
instruction: |
|
|
4755
4775
|
Illustrate key system workflows using sequence diagrams:
|
|
4756
|
-
|
|
4776
|
+
|
|
4757
4777
|
1. Identify critical user journeys from PRD
|
|
4758
4778
|
2. Show component interactions including external APIs
|
|
4759
4779
|
3. Include both frontend and backend flows
|
|
4760
4780
|
4. Include error handling paths
|
|
4761
4781
|
5. Document async operations
|
|
4762
4782
|
6. Create both high-level and detailed diagrams as needed
|
|
4763
|
-
|
|
4783
|
+
|
|
4764
4784
|
Focus on workflows that clarify architecture decisions or complex interactions.
|
|
4765
4785
|
elicit: true
|
|
4766
4786
|
|
|
@@ -4768,13 +4788,13 @@ sections:
|
|
|
4768
4788
|
title: Database Schema
|
|
4769
4789
|
instruction: |
|
|
4770
4790
|
Transform the conceptual data models into concrete database schemas:
|
|
4771
|
-
|
|
4791
|
+
|
|
4772
4792
|
1. Use the database type(s) selected in Tech Stack
|
|
4773
4793
|
2. Create schema definitions using appropriate notation
|
|
4774
4794
|
3. Include indexes, constraints, and relationships
|
|
4775
4795
|
4. Consider performance and scalability
|
|
4776
4796
|
5. For NoSQL, show document structures
|
|
4777
|
-
|
|
4797
|
+
|
|
4778
4798
|
Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
|
|
4779
4799
|
elicit: true
|
|
4780
4800
|
|
|
@@ -4910,60 +4930,60 @@ sections:
|
|
|
4910
4930
|
type: code
|
|
4911
4931
|
language: plaintext
|
|
4912
4932
|
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
|
-
|
|
4933
|
+
- |
|
|
4934
|
+
{{project-name}}/
|
|
4935
|
+
├── .github/ # CI/CD workflows
|
|
4936
|
+
│ └── workflows/
|
|
4937
|
+
│ ├── ci.yaml
|
|
4938
|
+
│ └── deploy.yaml
|
|
4939
|
+
├── apps/ # Application packages
|
|
4940
|
+
│ ├── web/ # Frontend application
|
|
4941
|
+
│ │ ├── src/
|
|
4942
|
+
│ │ │ ├── components/ # UI components
|
|
4943
|
+
│ │ │ ├── pages/ # Page components/routes
|
|
4944
|
+
│ │ │ ├── hooks/ # Custom React hooks
|
|
4945
|
+
│ │ │ ├── services/ # API client services
|
|
4946
|
+
│ │ │ ├── stores/ # State management
|
|
4947
|
+
│ │ │ ├── styles/ # Global styles/themes
|
|
4948
|
+
│ │ │ └── utils/ # Frontend utilities
|
|
4949
|
+
│ │ ├── public/ # Static assets
|
|
4950
|
+
│ │ ├── tests/ # Frontend tests
|
|
4951
|
+
│ │ └── package.json
|
|
4952
|
+
│ └── api/ # Backend application
|
|
4953
|
+
│ ├── src/
|
|
4954
|
+
│ │ ├── routes/ # API routes/controllers
|
|
4955
|
+
│ │ ├── services/ # Business logic
|
|
4956
|
+
│ │ ├── models/ # Data models
|
|
4957
|
+
│ │ ├── middleware/ # Express/API middleware
|
|
4958
|
+
│ │ ├── utils/ # Backend utilities
|
|
4959
|
+
│ │ └── {{serverless_or_server_entry}}
|
|
4960
|
+
│ ├── tests/ # Backend tests
|
|
4961
|
+
│ └── package.json
|
|
4962
|
+
├── packages/ # Shared packages
|
|
4963
|
+
│ ├── shared/ # Shared types/utilities
|
|
4964
|
+
│ │ ├── src/
|
|
4965
|
+
│ │ │ ├── types/ # TypeScript interfaces
|
|
4966
|
+
│ │ │ ├── constants/ # Shared constants
|
|
4967
|
+
│ │ │ └── utils/ # Shared utilities
|
|
4968
|
+
│ │ └── package.json
|
|
4969
|
+
│ ├── ui/ # Shared UI components
|
|
4970
|
+
│ │ ├── src/
|
|
4971
|
+
│ │ └── package.json
|
|
4972
|
+
│ └── config/ # Shared configuration
|
|
4973
|
+
│ ├── eslint/
|
|
4974
|
+
│ ├── typescript/
|
|
4975
|
+
│ └── jest/
|
|
4976
|
+
├── infrastructure/ # IaC definitions
|
|
4977
|
+
│ └── {{iac_structure}}
|
|
4978
|
+
├── scripts/ # Build/deploy scripts
|
|
4979
|
+
├── docs/ # Documentation
|
|
4980
|
+
│ ├── prd.md
|
|
4981
|
+
│ ├── front-end-spec.md
|
|
4982
|
+
│ └── fullstack-architecture.md
|
|
4983
|
+
├── .env.example # Environment template
|
|
4984
|
+
├── package.json # Root package.json
|
|
4985
|
+
├── {{monorepo_config}} # Monorepo configuration
|
|
4986
|
+
└── README.md
|
|
4967
4987
|
|
|
4968
4988
|
- id: development-workflow
|
|
4969
4989
|
title: Development Workflow
|
|
@@ -4990,13 +5010,13 @@ sections:
|
|
|
4990
5010
|
template: |
|
|
4991
5011
|
# Start all services
|
|
4992
5012
|
{{start_all_command}}
|
|
4993
|
-
|
|
5013
|
+
|
|
4994
5014
|
# Start frontend only
|
|
4995
5015
|
{{start_frontend_command}}
|
|
4996
|
-
|
|
5016
|
+
|
|
4997
5017
|
# Start backend only
|
|
4998
5018
|
{{start_backend_command}}
|
|
4999
|
-
|
|
5019
|
+
|
|
5000
5020
|
# Run tests
|
|
5001
5021
|
{{test_commands}}
|
|
5002
5022
|
- id: environment-config
|
|
@@ -5009,10 +5029,10 @@ sections:
|
|
|
5009
5029
|
template: |
|
|
5010
5030
|
# Frontend (.env.local)
|
|
5011
5031
|
{{frontend_env_vars}}
|
|
5012
|
-
|
|
5032
|
+
|
|
5013
5033
|
# Backend (.env)
|
|
5014
5034
|
{{backend_env_vars}}
|
|
5015
|
-
|
|
5035
|
+
|
|
5016
5036
|
# Shared
|
|
5017
5037
|
{{shared_env_vars}}
|
|
5018
5038
|
|
|
@@ -5029,7 +5049,7 @@ sections:
|
|
|
5029
5049
|
- **Build Command:** {{frontend_build_command}}
|
|
5030
5050
|
- **Output Directory:** {{frontend_output_dir}}
|
|
5031
5051
|
- **CDN/Edge:** {{cdn_strategy}}
|
|
5032
|
-
|
|
5052
|
+
|
|
5033
5053
|
**Backend Deployment:**
|
|
5034
5054
|
- **Platform:** {{backend_deploy_platform}}
|
|
5035
5055
|
- **Build Command:** {{backend_build_command}}
|
|
@@ -5060,12 +5080,12 @@ sections:
|
|
|
5060
5080
|
- CSP Headers: {{csp_policy}}
|
|
5061
5081
|
- XSS Prevention: {{xss_strategy}}
|
|
5062
5082
|
- Secure Storage: {{storage_strategy}}
|
|
5063
|
-
|
|
5083
|
+
|
|
5064
5084
|
**Backend Security:**
|
|
5065
5085
|
- Input Validation: {{validation_approach}}
|
|
5066
5086
|
- Rate Limiting: {{rate_limit_config}}
|
|
5067
5087
|
- CORS Policy: {{cors_config}}
|
|
5068
|
-
|
|
5088
|
+
|
|
5069
5089
|
**Authentication Security:**
|
|
5070
5090
|
- Token Storage: {{token_strategy}}
|
|
5071
5091
|
- Session Management: {{session_approach}}
|
|
@@ -5077,7 +5097,7 @@ sections:
|
|
|
5077
5097
|
- Bundle Size Target: {{bundle_size}}
|
|
5078
5098
|
- Loading Strategy: {{loading_approach}}
|
|
5079
5099
|
- Caching Strategy: {{fe_cache_strategy}}
|
|
5080
|
-
|
|
5100
|
+
|
|
5081
5101
|
**Backend Performance:**
|
|
5082
5102
|
- Response Time Target: {{response_target}}
|
|
5083
5103
|
- Database Optimization: {{db_optimization}}
|
|
@@ -5093,10 +5113,10 @@ sections:
|
|
|
5093
5113
|
type: code
|
|
5094
5114
|
language: text
|
|
5095
5115
|
template: |
|
|
5096
|
-
|
|
5097
|
-
|
|
5098
|
-
|
|
5099
|
-
|
|
5116
|
+
E2E Tests
|
|
5117
|
+
/ \
|
|
5118
|
+
Integration Tests
|
|
5119
|
+
/ \
|
|
5100
5120
|
Frontend Unit Backend Unit
|
|
5101
5121
|
- id: test-organization
|
|
5102
5122
|
title: Test Organization
|
|
@@ -5215,7 +5235,7 @@ sections:
|
|
|
5215
5235
|
- JavaScript errors
|
|
5216
5236
|
- API response times
|
|
5217
5237
|
- User interactions
|
|
5218
|
-
|
|
5238
|
+
|
|
5219
5239
|
**Backend Metrics:**
|
|
5220
5240
|
- Request rate
|
|
5221
5241
|
- Error rate
|
|
@@ -5360,7 +5380,7 @@ sections:
|
|
|
5360
5380
|
instruction: Map the end-to-end customer experience for primary segments
|
|
5361
5381
|
template: |
|
|
5362
5382
|
For primary customer segment:
|
|
5363
|
-
|
|
5383
|
+
|
|
5364
5384
|
1. **Awareness:** {{discovery_process}}
|
|
5365
5385
|
2. **Consideration:** {{evaluation_criteria}}
|
|
5366
5386
|
3. **Purchase:** {{decision_triggers}}
|
|
@@ -5541,7 +5561,7 @@ sections:
|
|
|
5541
5561
|
condition: PRD has UX/UI requirements
|
|
5542
5562
|
instruction: |
|
|
5543
5563
|
Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
|
|
5544
|
-
|
|
5564
|
+
|
|
5545
5565
|
1. Pre-fill all subsections with educated guesses based on project context
|
|
5546
5566
|
2. Present the complete rendered section to user
|
|
5547
5567
|
3. Clearly let the user know where assumptions were made
|
|
@@ -5583,7 +5603,7 @@ sections:
|
|
|
5583
5603
|
title: Technical Assumptions
|
|
5584
5604
|
instruction: |
|
|
5585
5605
|
Gather technical decisions that will guide the Architect. Steps:
|
|
5586
|
-
|
|
5606
|
+
|
|
5587
5607
|
1. Check if .bmad-core/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
|
|
5588
5608
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
|
5589
5609
|
3. For unknowns, offer guidance based on project goals and MVP scope
|
|
@@ -5611,9 +5631,9 @@ sections:
|
|
|
5611
5631
|
title: Epic List
|
|
5612
5632
|
instruction: |
|
|
5613
5633
|
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
|
-
|
|
5634
|
+
|
|
5615
5635
|
CRITICAL: Epics MUST be logically sequential following agile best practices:
|
|
5616
|
-
|
|
5636
|
+
|
|
5617
5637
|
- Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
|
|
5618
5638
|
- 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
5639
|
- 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 +5652,11 @@ sections:
|
|
|
5632
5652
|
repeatable: true
|
|
5633
5653
|
instruction: |
|
|
5634
5654
|
After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
|
|
5635
|
-
|
|
5655
|
+
|
|
5636
5656
|
For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
|
|
5637
|
-
|
|
5657
|
+
|
|
5638
5658
|
CRITICAL STORY SEQUENCING REQUIREMENTS:
|
|
5639
|
-
|
|
5659
|
+
|
|
5640
5660
|
- Stories within each epic MUST be logically sequential
|
|
5641
5661
|
- Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
|
|
5642
5662
|
- No story should depend on work from a later story or epic
|
|
@@ -5664,7 +5684,7 @@ sections:
|
|
|
5664
5684
|
repeatable: true
|
|
5665
5685
|
instruction: |
|
|
5666
5686
|
Define clear, comprehensive, and testable acceptance criteria that:
|
|
5667
|
-
|
|
5687
|
+
|
|
5668
5688
|
- Precisely define what "done" means from a functional perspective
|
|
5669
5689
|
- Are unambiguous and serve as basis for verification
|
|
5670
5690
|
- Include any critical non-functional requirements from the PRD
|
|
@@ -5718,12 +5738,12 @@ sections:
|
|
|
5718
5738
|
- id: introduction
|
|
5719
5739
|
instruction: |
|
|
5720
5740
|
This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
|
|
5721
|
-
|
|
5741
|
+
|
|
5722
5742
|
Start by asking the user which mode they prefer:
|
|
5723
|
-
|
|
5743
|
+
|
|
5724
5744
|
1. **Interactive Mode** - Work through each section collaboratively
|
|
5725
5745
|
2. **YOLO Mode** - Generate complete draft for review and refinement
|
|
5726
|
-
|
|
5746
|
+
|
|
5727
5747
|
Before beginning, understand what inputs are available (brainstorming results, market research, competitive analysis, initial ideas) and gather project context.
|
|
5728
5748
|
|
|
5729
5749
|
- id: executive-summary
|
|
@@ -5926,7 +5946,7 @@ workflow:
|
|
|
5926
5946
|
elicitation: advanced-elicitation
|
|
5927
5947
|
|
|
5928
5948
|
agent_config:
|
|
5929
|
-
editable_sections:
|
|
5949
|
+
editable_sections:
|
|
5930
5950
|
- Status
|
|
5931
5951
|
- Story
|
|
5932
5952
|
- Acceptance Criteria
|
|
@@ -5943,7 +5963,7 @@ sections:
|
|
|
5943
5963
|
instruction: Select the current status of the story
|
|
5944
5964
|
owner: scrum-master
|
|
5945
5965
|
editors: [scrum-master, dev-agent]
|
|
5946
|
-
|
|
5966
|
+
|
|
5947
5967
|
- id: story
|
|
5948
5968
|
title: Story
|
|
5949
5969
|
type: template-text
|
|
@@ -5955,7 +5975,7 @@ sections:
|
|
|
5955
5975
|
elicit: true
|
|
5956
5976
|
owner: scrum-master
|
|
5957
5977
|
editors: [scrum-master]
|
|
5958
|
-
|
|
5978
|
+
|
|
5959
5979
|
- id: acceptance-criteria
|
|
5960
5980
|
title: Acceptance Criteria
|
|
5961
5981
|
type: numbered-list
|
|
@@ -5963,7 +5983,7 @@ sections:
|
|
|
5963
5983
|
elicit: true
|
|
5964
5984
|
owner: scrum-master
|
|
5965
5985
|
editors: [scrum-master]
|
|
5966
|
-
|
|
5986
|
+
|
|
5967
5987
|
- id: tasks-subtasks
|
|
5968
5988
|
title: Tasks / Subtasks
|
|
5969
5989
|
type: bullet-list
|
|
@@ -5980,7 +6000,7 @@ sections:
|
|
|
5980
6000
|
elicit: true
|
|
5981
6001
|
owner: scrum-master
|
|
5982
6002
|
editors: [scrum-master, dev-agent]
|
|
5983
|
-
|
|
6003
|
+
|
|
5984
6004
|
- id: dev-notes
|
|
5985
6005
|
title: Dev Notes
|
|
5986
6006
|
instruction: |
|
|
@@ -6004,7 +6024,7 @@ sections:
|
|
|
6004
6024
|
elicit: true
|
|
6005
6025
|
owner: scrum-master
|
|
6006
6026
|
editors: [scrum-master]
|
|
6007
|
-
|
|
6027
|
+
|
|
6008
6028
|
- id: change-log
|
|
6009
6029
|
title: Change Log
|
|
6010
6030
|
type: table
|
|
@@ -6012,7 +6032,7 @@ sections:
|
|
|
6012
6032
|
instruction: Track changes made to this story document
|
|
6013
6033
|
owner: scrum-master
|
|
6014
6034
|
editors: [scrum-master, dev-agent, qa-agent]
|
|
6015
|
-
|
|
6035
|
+
|
|
6016
6036
|
- id: dev-agent-record
|
|
6017
6037
|
title: Dev Agent Record
|
|
6018
6038
|
instruction: This section is populated by the development agent during implementation
|
|
@@ -6025,25 +6045,25 @@ sections:
|
|
|
6025
6045
|
instruction: Record the specific AI agent model and version used for development
|
|
6026
6046
|
owner: dev-agent
|
|
6027
6047
|
editors: [dev-agent]
|
|
6028
|
-
|
|
6048
|
+
|
|
6029
6049
|
- id: debug-log-references
|
|
6030
6050
|
title: Debug Log References
|
|
6031
6051
|
instruction: Reference any debug logs or traces generated during development
|
|
6032
6052
|
owner: dev-agent
|
|
6033
6053
|
editors: [dev-agent]
|
|
6034
|
-
|
|
6054
|
+
|
|
6035
6055
|
- id: completion-notes
|
|
6036
6056
|
title: Completion Notes List
|
|
6037
6057
|
instruction: Notes about the completion of tasks and any issues encountered
|
|
6038
6058
|
owner: dev-agent
|
|
6039
6059
|
editors: [dev-agent]
|
|
6040
|
-
|
|
6060
|
+
|
|
6041
6061
|
- id: file-list
|
|
6042
6062
|
title: File List
|
|
6043
6063
|
instruction: List all files created, modified, or affected during story implementation
|
|
6044
6064
|
owner: dev-agent
|
|
6045
6065
|
editors: [dev-agent]
|
|
6046
|
-
|
|
6066
|
+
|
|
6047
6067
|
- id: qa-results
|
|
6048
6068
|
title: QA Results
|
|
6049
6069
|
instruction: Results from QA Agent QA review of the completed story implementation
|
|
@@ -6457,33 +6477,28 @@ Ask the user if they want to work through the checklist:
|
|
|
6457
6477
|
Now that you've completed the checklist, generate a comprehensive validation report that includes:
|
|
6458
6478
|
|
|
6459
6479
|
1. Executive Summary
|
|
6460
|
-
|
|
6461
6480
|
- Overall architecture readiness (High/Medium/Low)
|
|
6462
6481
|
- Critical risks identified
|
|
6463
6482
|
- Key strengths of the architecture
|
|
6464
6483
|
- Project type (Full-stack/Frontend/Backend) and sections evaluated
|
|
6465
6484
|
|
|
6466
6485
|
2. Section Analysis
|
|
6467
|
-
|
|
6468
6486
|
- Pass rate for each major section (percentage of items passed)
|
|
6469
6487
|
- Most concerning failures or gaps
|
|
6470
6488
|
- Sections requiring immediate attention
|
|
6471
6489
|
- Note any sections skipped due to project type
|
|
6472
6490
|
|
|
6473
6491
|
3. Risk Assessment
|
|
6474
|
-
|
|
6475
6492
|
- Top 5 risks by severity
|
|
6476
6493
|
- Mitigation recommendations for each
|
|
6477
6494
|
- Timeline impact of addressing issues
|
|
6478
6495
|
|
|
6479
6496
|
4. Recommendations
|
|
6480
|
-
|
|
6481
6497
|
- Must-fix items before development
|
|
6482
6498
|
- Should-fix items for better quality
|
|
6483
6499
|
- Nice-to-have improvements
|
|
6484
6500
|
|
|
6485
6501
|
5. AI Implementation Readiness
|
|
6486
|
-
|
|
6487
6502
|
- Specific concerns for AI agent implementation
|
|
6488
6503
|
- Areas needing additional clarification
|
|
6489
6504
|
- Complexity hotspots to address
|
|
@@ -6989,7 +7004,6 @@ Ask the user if they want to work through the checklist:
|
|
|
6989
7004
|
Create a comprehensive validation report that includes:
|
|
6990
7005
|
|
|
6991
7006
|
1. Executive Summary
|
|
6992
|
-
|
|
6993
7007
|
- Overall PRD completeness (percentage)
|
|
6994
7008
|
- MVP scope appropriateness (Too Large/Just Right/Too Small)
|
|
6995
7009
|
- Readiness for architecture phase (Ready/Nearly Ready/Not Ready)
|
|
@@ -6997,26 +7011,22 @@ Create a comprehensive validation report that includes:
|
|
|
6997
7011
|
|
|
6998
7012
|
2. Category Analysis Table
|
|
6999
7013
|
Fill in the actual table with:
|
|
7000
|
-
|
|
7001
7014
|
- Status: PASS (90%+ complete), PARTIAL (60-89%), FAIL (<60%)
|
|
7002
7015
|
- Critical Issues: Specific problems that block progress
|
|
7003
7016
|
|
|
7004
7017
|
3. Top Issues by Priority
|
|
7005
|
-
|
|
7006
7018
|
- BLOCKERS: Must fix before architect can proceed
|
|
7007
7019
|
- HIGH: Should fix for quality
|
|
7008
7020
|
- MEDIUM: Would improve clarity
|
|
7009
7021
|
- LOW: Nice to have
|
|
7010
7022
|
|
|
7011
7023
|
4. MVP Scope Assessment
|
|
7012
|
-
|
|
7013
7024
|
- Features that might be cut for true MVP
|
|
7014
7025
|
- Missing features that are essential
|
|
7015
7026
|
- Complexity concerns
|
|
7016
7027
|
- Timeline realism
|
|
7017
7028
|
|
|
7018
7029
|
5. Technical Readiness
|
|
7019
|
-
|
|
7020
7030
|
- Clarity of technical constraints
|
|
7021
7031
|
- Identified technical risks
|
|
7022
7032
|
- Areas needing architect investigation
|
|
@@ -7071,12 +7081,10 @@ PROJECT TYPE DETECTION:
|
|
|
7071
7081
|
First, determine the project type by checking:
|
|
7072
7082
|
|
|
7073
7083
|
1. Is this a GREENFIELD project (new from scratch)?
|
|
7074
|
-
|
|
7075
7084
|
- Look for: New project initialization, no existing codebase references
|
|
7076
7085
|
- Check for: prd.md, architecture.md, new project setup stories
|
|
7077
7086
|
|
|
7078
7087
|
2. Is this a BROWNFIELD project (enhancing existing system)?
|
|
7079
|
-
|
|
7080
7088
|
- Look for: References to existing codebase, enhancement/modification language
|
|
7081
7089
|
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
|
7082
7090
|
|
|
@@ -7410,7 +7418,6 @@ Ask the user if they want to work through the checklist:
|
|
|
7410
7418
|
Generate a comprehensive validation report that adapts to project type:
|
|
7411
7419
|
|
|
7412
7420
|
1. Executive Summary
|
|
7413
|
-
|
|
7414
7421
|
- Project type: [Greenfield/Brownfield] with [UI/No UI]
|
|
7415
7422
|
- Overall readiness (percentage)
|
|
7416
7423
|
- Go/No-Go recommendation
|
|
@@ -7420,42 +7427,36 @@ Generate a comprehensive validation report that adapts to project type:
|
|
|
7420
7427
|
2. Project-Specific Analysis
|
|
7421
7428
|
|
|
7422
7429
|
FOR GREENFIELD:
|
|
7423
|
-
|
|
7424
7430
|
- Setup completeness
|
|
7425
7431
|
- Dependency sequencing
|
|
7426
7432
|
- MVP scope appropriateness
|
|
7427
7433
|
- Development timeline feasibility
|
|
7428
7434
|
|
|
7429
7435
|
FOR BROWNFIELD:
|
|
7430
|
-
|
|
7431
7436
|
- Integration risk level (High/Medium/Low)
|
|
7432
7437
|
- Existing system impact assessment
|
|
7433
7438
|
- Rollback readiness
|
|
7434
7439
|
- User disruption potential
|
|
7435
7440
|
|
|
7436
7441
|
3. Risk Assessment
|
|
7437
|
-
|
|
7438
7442
|
- Top 5 risks by severity
|
|
7439
7443
|
- Mitigation recommendations
|
|
7440
7444
|
- Timeline impact of addressing issues
|
|
7441
7445
|
- [BROWNFIELD] Specific integration risks
|
|
7442
7446
|
|
|
7443
7447
|
4. MVP Completeness
|
|
7444
|
-
|
|
7445
7448
|
- Core features coverage
|
|
7446
7449
|
- Missing essential functionality
|
|
7447
7450
|
- Scope creep identified
|
|
7448
7451
|
- True MVP vs over-engineering
|
|
7449
7452
|
|
|
7450
7453
|
5. Implementation Readiness
|
|
7451
|
-
|
|
7452
7454
|
- Developer clarity score (1-10)
|
|
7453
7455
|
- Ambiguous requirements count
|
|
7454
7456
|
- Missing technical details
|
|
7455
7457
|
- [BROWNFIELD] Integration point clarity
|
|
7456
7458
|
|
|
7457
7459
|
6. Recommendations
|
|
7458
|
-
|
|
7459
7460
|
- Must-fix before development
|
|
7460
7461
|
- Should-fix for quality
|
|
7461
7462
|
- Consider for improvement
|
|
@@ -7532,14 +7533,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7532
7533
|
1. **Requirements Met:**
|
|
7533
7534
|
|
|
7534
7535
|
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
7535
|
-
|
|
7536
7536
|
- [ ] All functional requirements specified in the story are implemented.
|
|
7537
7537
|
- [ ] All acceptance criteria defined in the story are met.
|
|
7538
7538
|
|
|
7539
7539
|
2. **Coding Standards & Project Structure:**
|
|
7540
7540
|
|
|
7541
7541
|
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
7542
|
-
|
|
7543
7542
|
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
7544
7543
|
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
7545
7544
|
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
@@ -7551,7 +7550,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7551
7550
|
3. **Testing:**
|
|
7552
7551
|
|
|
7553
7552
|
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
7554
|
-
|
|
7555
7553
|
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
7556
7554
|
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
7557
7555
|
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
@@ -7560,14 +7558,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7560
7558
|
4. **Functionality & Verification:**
|
|
7561
7559
|
|
|
7562
7560
|
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
7563
|
-
|
|
7564
7561
|
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
7565
7562
|
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
7566
7563
|
|
|
7567
7564
|
5. **Story Administration:**
|
|
7568
7565
|
|
|
7569
7566
|
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
7570
|
-
|
|
7571
7567
|
- [ ] All tasks within the story file are marked as complete.
|
|
7572
7568
|
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
7573
7569
|
- [ ] 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 +7571,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7575
7571
|
6. **Dependencies, Build & Configuration:**
|
|
7576
7572
|
|
|
7577
7573
|
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
7578
|
-
|
|
7579
7574
|
- [ ] Project builds successfully without errors.
|
|
7580
7575
|
- [ ] Project linting passes
|
|
7581
7576
|
- [ ] 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 +7581,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
7586
7581
|
7. **Documentation (If Applicable):**
|
|
7587
7582
|
|
|
7588
7583
|
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
7589
|
-
|
|
7590
7584
|
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
7591
7585
|
- [ ] User-facing documentation updated, if changes impact users.
|
|
7592
7586
|
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
@@ -7728,19 +7722,16 @@ Note: We don't need every file listed - just the important ones.]]
|
|
|
7728
7722
|
Generate a concise validation report:
|
|
7729
7723
|
|
|
7730
7724
|
1. Quick Summary
|
|
7731
|
-
|
|
7732
7725
|
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
7733
7726
|
- Clarity score (1-10)
|
|
7734
7727
|
- Major gaps identified
|
|
7735
7728
|
|
|
7736
7729
|
2. Fill in the validation table with:
|
|
7737
|
-
|
|
7738
7730
|
- PASS: Requirements clearly met
|
|
7739
7731
|
- PARTIAL: Some gaps but workable
|
|
7740
7732
|
- FAIL: Critical information missing
|
|
7741
7733
|
|
|
7742
7734
|
3. Specific Issues (if any)
|
|
7743
|
-
|
|
7744
7735
|
- List concrete problems to fix
|
|
7745
7736
|
- Suggest specific improvements
|
|
7746
7737
|
- Identify any blocking dependencies
|
|
@@ -8068,7 +8059,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
8068
8059
|
|
|
8069
8060
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
8070
8061
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
8071
|
-
- **Windsurf**:
|
|
8062
|
+
- **Windsurf**: `/agent-name` (e.g., `/bmad-master`)
|
|
8072
8063
|
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
|
8073
8064
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-master`)
|
|
8074
8065
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
@@ -8312,7 +8303,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
8312
8303
|
#### Greenfield Development
|
|
8313
8304
|
|
|
8314
8305
|
- Business analysis and market research
|
|
8315
|
-
- Product requirements and feature definition
|
|
8306
|
+
- Product requirements and feature definition
|
|
8316
8307
|
- System architecture and design
|
|
8317
8308
|
- Development execution
|
|
8318
8309
|
- Testing and deployment
|
|
@@ -8421,8 +8412,11 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
|
8421
8412
|
|
|
8422
8413
|
```markdown
|
|
8423
8414
|
## Goals and Background Context
|
|
8424
|
-
|
|
8415
|
+
|
|
8416
|
+
## Requirements
|
|
8417
|
+
|
|
8425
8418
|
## User Interface Design Goals
|
|
8419
|
+
|
|
8426
8420
|
## Success Metrics
|
|
8427
8421
|
```
|
|
8428
8422
|
|
|
@@ -8618,16 +8612,19 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8618
8612
|
## Core Reflective Methods
|
|
8619
8613
|
|
|
8620
8614
|
**Expand or Contract for Audience**
|
|
8615
|
+
|
|
8621
8616
|
- Ask whether to 'expand' (add detail, elaborate) or 'contract' (simplify, clarify)
|
|
8622
8617
|
- Identify specific target audience if relevant
|
|
8623
8618
|
- Tailor content complexity and depth accordingly
|
|
8624
8619
|
|
|
8625
8620
|
**Explain Reasoning (CoT Step-by-Step)**
|
|
8621
|
+
|
|
8626
8622
|
- Walk through the step-by-step thinking process
|
|
8627
8623
|
- Reveal underlying assumptions and decision points
|
|
8628
8624
|
- Show how conclusions were reached from current role's perspective
|
|
8629
8625
|
|
|
8630
8626
|
**Critique and Refine**
|
|
8627
|
+
|
|
8631
8628
|
- Review output for flaws, inconsistencies, or improvement areas
|
|
8632
8629
|
- Identify specific weaknesses from role's expertise
|
|
8633
8630
|
- Suggest refined version reflecting domain knowledge
|
|
@@ -8635,12 +8632,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8635
8632
|
## Structural Analysis Methods
|
|
8636
8633
|
|
|
8637
8634
|
**Analyze Logical Flow and Dependencies**
|
|
8635
|
+
|
|
8638
8636
|
- Examine content structure for logical progression
|
|
8639
8637
|
- Check internal consistency and coherence
|
|
8640
8638
|
- Identify and validate dependencies between elements
|
|
8641
8639
|
- Confirm effective ordering and sequencing
|
|
8642
8640
|
|
|
8643
8641
|
**Assess Alignment with Overall Goals**
|
|
8642
|
+
|
|
8644
8643
|
- Evaluate content contribution to stated objectives
|
|
8645
8644
|
- Identify any misalignments or gaps
|
|
8646
8645
|
- Interpret alignment from specific role's perspective
|
|
@@ -8649,12 +8648,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8649
8648
|
## Risk and Challenge Methods
|
|
8650
8649
|
|
|
8651
8650
|
**Identify Potential Risks and Unforeseen Issues**
|
|
8651
|
+
|
|
8652
8652
|
- Brainstorm potential risks from role's expertise
|
|
8653
8653
|
- Identify overlooked edge cases or scenarios
|
|
8654
8654
|
- Anticipate unintended consequences
|
|
8655
8655
|
- Highlight implementation challenges
|
|
8656
8656
|
|
|
8657
8657
|
**Challenge from Critical Perspective**
|
|
8658
|
+
|
|
8658
8659
|
- Adopt critical stance on current content
|
|
8659
8660
|
- Play devil's advocate from specified viewpoint
|
|
8660
8661
|
- Argue against proposal highlighting weaknesses
|
|
@@ -8663,12 +8664,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8663
8664
|
## Creative Exploration Methods
|
|
8664
8665
|
|
|
8665
8666
|
**Tree of Thoughts Deep Dive**
|
|
8667
|
+
|
|
8666
8668
|
- Break problem into discrete "thoughts" or intermediate steps
|
|
8667
8669
|
- Explore multiple reasoning paths simultaneously
|
|
8668
8670
|
- Use self-evaluation to classify each path as "sure", "likely", or "impossible"
|
|
8669
8671
|
- Apply search algorithms (BFS/DFS) to find optimal solution paths
|
|
8670
8672
|
|
|
8671
8673
|
**Hindsight is 20/20: The 'If Only...' Reflection**
|
|
8674
|
+
|
|
8672
8675
|
- Imagine retrospective scenario based on current content
|
|
8673
8676
|
- Identify the one "if only we had known/done X..." insight
|
|
8674
8677
|
- Describe imagined consequences humorously or dramatically
|
|
@@ -8677,6 +8680,7 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8677
8680
|
## Multi-Persona Collaboration Methods
|
|
8678
8681
|
|
|
8679
8682
|
**Agile Team Perspective Shift**
|
|
8683
|
+
|
|
8680
8684
|
- Rotate through different Scrum team member viewpoints
|
|
8681
8685
|
- Product Owner: Focus on user value and business impact
|
|
8682
8686
|
- Scrum Master: Examine process flow and team dynamics
|
|
@@ -8684,12 +8688,14 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8684
8688
|
- QA: Identify testing scenarios and quality concerns
|
|
8685
8689
|
|
|
8686
8690
|
**Stakeholder Round Table**
|
|
8691
|
+
|
|
8687
8692
|
- Convene virtual meeting with multiple personas
|
|
8688
8693
|
- Each persona contributes unique perspective on content
|
|
8689
8694
|
- Identify conflicts and synergies between viewpoints
|
|
8690
8695
|
- Synthesize insights into actionable recommendations
|
|
8691
8696
|
|
|
8692
8697
|
**Meta-Prompting Analysis**
|
|
8698
|
+
|
|
8693
8699
|
- Step back to analyze the structure and logic of current approach
|
|
8694
8700
|
- Question the format and methodology being used
|
|
8695
8701
|
- Suggest alternative frameworks or mental models
|
|
@@ -8698,24 +8704,28 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8698
8704
|
## Advanced 2025 Techniques
|
|
8699
8705
|
|
|
8700
8706
|
**Self-Consistency Validation**
|
|
8707
|
+
|
|
8701
8708
|
- Generate multiple reasoning paths for same problem
|
|
8702
8709
|
- Compare consistency across different approaches
|
|
8703
8710
|
- Identify most reliable and robust solution
|
|
8704
8711
|
- Highlight areas where approaches diverge and why
|
|
8705
8712
|
|
|
8706
8713
|
**ReWOO (Reasoning Without Observation)**
|
|
8714
|
+
|
|
8707
8715
|
- Separate parametric reasoning from tool-based actions
|
|
8708
8716
|
- Create reasoning plan without external dependencies
|
|
8709
8717
|
- Identify what can be solved through pure reasoning
|
|
8710
8718
|
- Optimize for efficiency and reduced token usage
|
|
8711
8719
|
|
|
8712
8720
|
**Persona-Pattern Hybrid**
|
|
8721
|
+
|
|
8713
8722
|
- Combine specific role expertise with elicitation pattern
|
|
8714
8723
|
- Architect + Risk Analysis: Deep technical risk assessment
|
|
8715
8724
|
- UX Expert + User Journey: End-to-end experience critique
|
|
8716
8725
|
- PM + Stakeholder Analysis: Multi-perspective impact review
|
|
8717
8726
|
|
|
8718
8727
|
**Emergent Collaboration Discovery**
|
|
8728
|
+
|
|
8719
8729
|
- Allow multiple perspectives to naturally emerge
|
|
8720
8730
|
- Identify unexpected insights from persona interactions
|
|
8721
8731
|
- Explore novel combinations of viewpoints
|
|
@@ -8724,18 +8734,21 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8724
8734
|
## Game-Based Elicitation Methods
|
|
8725
8735
|
|
|
8726
8736
|
**Red Team vs Blue Team**
|
|
8737
|
+
|
|
8727
8738
|
- Red Team: Attack the proposal, find vulnerabilities
|
|
8728
8739
|
- Blue Team: Defend and strengthen the approach
|
|
8729
8740
|
- Competitive analysis reveals blind spots
|
|
8730
8741
|
- Results in more robust, battle-tested solutions
|
|
8731
8742
|
|
|
8732
8743
|
**Innovation Tournament**
|
|
8744
|
+
|
|
8733
8745
|
- Pit multiple alternative approaches against each other
|
|
8734
8746
|
- Score each approach across different criteria
|
|
8735
8747
|
- Crowd-source evaluation from different personas
|
|
8736
8748
|
- Identify winning combination of features
|
|
8737
8749
|
|
|
8738
8750
|
**Escape Room Challenge**
|
|
8751
|
+
|
|
8739
8752
|
- Present content as constraints to work within
|
|
8740
8753
|
- Find creative solutions within tight limitations
|
|
8741
8754
|
- Identify minimum viable approach
|
|
@@ -8744,6 +8757,7 @@ Use the **expansion-creator** pack to build your own:
|
|
|
8744
8757
|
## Process Control
|
|
8745
8758
|
|
|
8746
8759
|
**Proceed / No Further Actions**
|
|
8760
|
+
|
|
8747
8761
|
- Acknowledge choice to finalize current work
|
|
8748
8762
|
- Accept output as-is or move to next step
|
|
8749
8763
|
- Prepare to continue without additional elicitation
|