bmad-method 4.37.0 → 4.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.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
|
@@ -77,71 +77,17 @@ commands:
|
|
|
77
77
|
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
|
|
78
78
|
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
|
79
79
|
dependencies:
|
|
80
|
+
data:
|
|
81
|
+
- technical-preferences.md
|
|
80
82
|
tasks:
|
|
81
|
-
- generate-ai-frontend-prompt.md
|
|
82
83
|
- create-doc.md
|
|
83
84
|
- execute-checklist.md
|
|
85
|
+
- generate-ai-frontend-prompt.md
|
|
84
86
|
templates:
|
|
85
87
|
- front-end-spec-tmpl.yaml
|
|
86
|
-
data:
|
|
87
|
-
- technical-preferences.md
|
|
88
88
|
```
|
|
89
89
|
==================== END: .bmad-core/agents/ux-expert.md ====================
|
|
90
90
|
|
|
91
|
-
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
92
|
-
# Create AI Frontend Prompt Task
|
|
93
|
-
|
|
94
|
-
## Purpose
|
|
95
|
-
|
|
96
|
-
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
|
97
|
-
|
|
98
|
-
## Inputs
|
|
99
|
-
|
|
100
|
-
- Completed UI/UX Specification (`front-end-spec.md`)
|
|
101
|
-
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
|
102
|
-
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
|
103
|
-
|
|
104
|
-
## Key Activities & Instructions
|
|
105
|
-
|
|
106
|
-
### 1. Core Prompting Principles
|
|
107
|
-
|
|
108
|
-
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
|
109
|
-
|
|
110
|
-
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
|
111
|
-
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
|
112
|
-
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
|
113
|
-
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
|
114
|
-
|
|
115
|
-
### 2. The Structured Prompting Framework
|
|
116
|
-
|
|
117
|
-
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
|
118
|
-
|
|
119
|
-
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
|
120
|
-
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
|
121
|
-
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
|
122
|
-
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
|
123
|
-
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
|
124
|
-
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
|
125
|
-
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
|
126
|
-
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
|
127
|
-
|
|
128
|
-
### 3. Assembling the Master Prompt
|
|
129
|
-
|
|
130
|
-
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
|
131
|
-
|
|
132
|
-
1. **Gather Foundational Context**:
|
|
133
|
-
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
|
134
|
-
2. **Describe the Visuals**:
|
|
135
|
-
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
|
136
|
-
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
|
137
|
-
3. **Build the Prompt using the Structured Framework**:
|
|
138
|
-
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
|
139
|
-
4. **Present and Refine**:
|
|
140
|
-
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
141
|
-
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
|
142
|
-
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
|
143
|
-
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
144
|
-
|
|
145
91
|
==================== START: .bmad-core/tasks/create-doc.md ====================
|
|
146
92
|
# Create Document from Template (YAML Driven)
|
|
147
93
|
|
|
@@ -258,7 +204,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
258
204
|
## Instructions
|
|
259
205
|
|
|
260
206
|
1. **Initial Assessment**
|
|
261
|
-
|
|
262
207
|
- If user or the task being run provides a checklist name:
|
|
263
208
|
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
|
264
209
|
- If multiple matches found, ask user to clarify
|
|
@@ -271,14 +216,12 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
271
216
|
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
|
272
217
|
|
|
273
218
|
2. **Document and Artifact Gathering**
|
|
274
|
-
|
|
275
219
|
- Each checklist will specify its required documents/artifacts at the beginning
|
|
276
220
|
- 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.
|
|
277
221
|
|
|
278
222
|
3. **Checklist Processing**
|
|
279
223
|
|
|
280
224
|
If in interactive mode:
|
|
281
|
-
|
|
282
225
|
- Work through each section of the checklist one at a time
|
|
283
226
|
- For each section:
|
|
284
227
|
- Review all items in the section following instructions for that section embedded in the checklist
|
|
@@ -287,7 +230,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
287
230
|
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
|
288
231
|
|
|
289
232
|
If in YOLO mode:
|
|
290
|
-
|
|
291
233
|
- Process all sections at once
|
|
292
234
|
- Create a comprehensive report of all findings
|
|
293
235
|
- Present the complete analysis to the user
|
|
@@ -295,7 +237,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
295
237
|
4. **Validation Approach**
|
|
296
238
|
|
|
297
239
|
For each checklist item:
|
|
298
|
-
|
|
299
240
|
- Read and understand the requirement
|
|
300
241
|
- Look for evidence in the documentation that satisfies the requirement
|
|
301
242
|
- Consider both explicit mentions and implicit coverage
|
|
@@ -309,7 +250,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
309
250
|
5. **Section Analysis**
|
|
310
251
|
|
|
311
252
|
For each section:
|
|
312
|
-
|
|
313
253
|
- think step by step to calculate pass rate
|
|
314
254
|
- Identify common themes in failed items
|
|
315
255
|
- Provide specific recommendations for improvement
|
|
@@ -319,7 +259,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
|
|
319
259
|
6. **Final Report**
|
|
320
260
|
|
|
321
261
|
Prepare a summary that includes:
|
|
322
|
-
|
|
323
262
|
- Overall checklist completion status
|
|
324
263
|
- Pass rates by section
|
|
325
264
|
- List of failed items with context
|
|
@@ -342,6 +281,60 @@ The LLM will:
|
|
|
342
281
|
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
|
343
282
|
==================== END: .bmad-core/tasks/execute-checklist.md ====================
|
|
344
283
|
|
|
284
|
+
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
285
|
+
# Create AI Frontend Prompt Task
|
|
286
|
+
|
|
287
|
+
## Purpose
|
|
288
|
+
|
|
289
|
+
To generate a masterful, comprehensive, and optimized prompt that can be used with any AI-driven frontend development tool (e.g., Vercel v0, Lovable.ai, or similar) to scaffold or generate significant portions of a frontend application.
|
|
290
|
+
|
|
291
|
+
## Inputs
|
|
292
|
+
|
|
293
|
+
- Completed UI/UX Specification (`front-end-spec.md`)
|
|
294
|
+
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
|
295
|
+
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
|
296
|
+
|
|
297
|
+
## Key Activities & Instructions
|
|
298
|
+
|
|
299
|
+
### 1. Core Prompting Principles
|
|
300
|
+
|
|
301
|
+
Before generating the prompt, you must understand these core principles for interacting with a generative AI for code.
|
|
302
|
+
|
|
303
|
+
- **Be Explicit and Detailed**: The AI cannot read your mind. Provide as much detail and context as possible. Vague requests lead to generic or incorrect outputs.
|
|
304
|
+
- **Iterate, Don't Expect Perfection**: Generating an entire complex application in one go is rare. The most effective method is to prompt for one component or one section at a time, then build upon the results.
|
|
305
|
+
- **Provide Context First**: Always start by providing the AI with the necessary context, such as the tech stack, existing code snippets, and overall project goals.
|
|
306
|
+
- **Mobile-First Approach**: Frame all UI generation requests with a mobile-first design mindset. Describe the mobile layout first, then provide separate instructions for how it should adapt for tablet and desktop.
|
|
307
|
+
|
|
308
|
+
### 2. The Structured Prompting Framework
|
|
309
|
+
|
|
310
|
+
To ensure the highest quality output, you MUST structure every prompt using the following four-part framework.
|
|
311
|
+
|
|
312
|
+
1. **High-Level Goal**: Start with a clear, concise summary of the overall objective. This orients the AI on the primary task.
|
|
313
|
+
- _Example: "Create a responsive user registration form with client-side validation and API integration."_
|
|
314
|
+
2. **Detailed, Step-by-Step Instructions**: Provide a granular, numbered list of actions the AI should take. Break down complex tasks into smaller, sequential steps. This is the most critical part of the prompt.
|
|
315
|
+
- _Example: "1. Create a new file named `RegistrationForm.js`. 2. Use React hooks for state management. 3. Add styled input fields for 'Name', 'Email', and 'Password'. 4. For the email field, ensure it is a valid email format. 5. On submission, call the API endpoint defined below."_
|
|
316
|
+
3. **Code Examples, Data Structures & Constraints**: Include any relevant snippets of existing code, data structures, or API contracts. This gives the AI concrete examples to work with. Crucially, you must also state what _not_ to do.
|
|
317
|
+
- _Example: "Use this API endpoint: `POST /api/register`. The expected JSON payload is `{ "name": "string", "email": "string", "password": "string" }`. Do NOT include a 'confirm password' field. Use Tailwind CSS for all styling."_
|
|
318
|
+
4. **Define a Strict Scope**: Explicitly define the boundaries of the task. Tell the AI which files it can modify and, more importantly, which files to leave untouched to prevent unintended changes across the codebase.
|
|
319
|
+
- _Example: "You should only create the `RegistrationForm.js` component and add it to the `pages/register.js` file. Do NOT alter the `Navbar.js` component or any other existing page or component."_
|
|
320
|
+
|
|
321
|
+
### 3. Assembling the Master Prompt
|
|
322
|
+
|
|
323
|
+
You will now synthesize the inputs and the above principles into a final, comprehensive prompt.
|
|
324
|
+
|
|
325
|
+
1. **Gather Foundational Context**:
|
|
326
|
+
- Start the prompt with a preamble describing the overall project purpose, the full tech stack (e.g., Next.js, TypeScript, Tailwind CSS), and the primary UI component library being used.
|
|
327
|
+
2. **Describe the Visuals**:
|
|
328
|
+
- If the user has design files (Figma, etc.), instruct them to provide links or screenshots.
|
|
329
|
+
- If not, describe the visual style: color palette, typography, spacing, and overall aesthetic (e.g., "minimalist", "corporate", "playful").
|
|
330
|
+
3. **Build the Prompt using the Structured Framework**:
|
|
331
|
+
- Follow the four-part framework from Section 2 to build out the core request, whether it's for a single component or a full page.
|
|
332
|
+
4. **Present and Refine**:
|
|
333
|
+
- Output the complete, generated prompt in a clear, copy-pasteable format (e.g., a large code block).
|
|
334
|
+
- Explain the structure of the prompt and why certain information was included, referencing the principles above.
|
|
335
|
+
- <important_note>Conclude by reminding the user that all AI-generated code will require careful human review, testing, and refinement to be considered production-ready.</important_note>
|
|
336
|
+
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
|
|
337
|
+
|
|
345
338
|
==================== START: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
|
|
346
339
|
template:
|
|
347
340
|
id: frontend-spec-template-v2
|
|
@@ -361,7 +354,7 @@ sections:
|
|
|
361
354
|
title: Introduction
|
|
362
355
|
instruction: |
|
|
363
356
|
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.
|
|
364
|
-
|
|
357
|
+
|
|
365
358
|
Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
|
|
366
359
|
content: |
|
|
367
360
|
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.
|
|
@@ -370,7 +363,7 @@ sections:
|
|
|
370
363
|
title: Overall UX Goals & Principles
|
|
371
364
|
instruction: |
|
|
372
365
|
Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
|
|
373
|
-
|
|
366
|
+
|
|
374
367
|
1. Target User Personas - elicit details or confirm existing ones from PRD
|
|
375
368
|
2. Key Usability Goals - understand what success looks like for users
|
|
376
369
|
3. Core Design Principles - establish 3-5 guiding principles
|
|
@@ -411,7 +404,7 @@ sections:
|
|
|
411
404
|
title: Information Architecture (IA)
|
|
412
405
|
instruction: |
|
|
413
406
|
Collaborate with the user to create a comprehensive information architecture:
|
|
414
|
-
|
|
407
|
+
|
|
415
408
|
1. Build a Site Map or Screen Inventory showing all major areas
|
|
416
409
|
2. Define the Navigation Structure (primary, secondary, breadcrumbs)
|
|
417
410
|
3. Use Mermaid diagrams for visual representation
|
|
@@ -441,22 +434,22 @@ sections:
|
|
|
441
434
|
title: Navigation Structure
|
|
442
435
|
template: |
|
|
443
436
|
**Primary Navigation:** {{primary_nav_description}}
|
|
444
|
-
|
|
437
|
+
|
|
445
438
|
**Secondary Navigation:** {{secondary_nav_description}}
|
|
446
|
-
|
|
439
|
+
|
|
447
440
|
**Breadcrumb Strategy:** {{breadcrumb_strategy}}
|
|
448
441
|
|
|
449
442
|
- id: user-flows
|
|
450
443
|
title: User Flows
|
|
451
444
|
instruction: |
|
|
452
445
|
For each critical user task identified in the PRD:
|
|
453
|
-
|
|
446
|
+
|
|
454
447
|
1. Define the user's goal clearly
|
|
455
448
|
2. Map out all steps including decision points
|
|
456
449
|
3. Consider edge cases and error states
|
|
457
450
|
4. Use Mermaid flow diagrams for clarity
|
|
458
451
|
5. Link to external tools (Figma/Miro) if detailed flows exist there
|
|
459
|
-
|
|
452
|
+
|
|
460
453
|
Create subsections for each major flow.
|
|
461
454
|
elicit: true
|
|
462
455
|
repeatable: true
|
|
@@ -465,9 +458,9 @@ sections:
|
|
|
465
458
|
title: "{{flow_name}}"
|
|
466
459
|
template: |
|
|
467
460
|
**User Goal:** {{flow_goal}}
|
|
468
|
-
|
|
461
|
+
|
|
469
462
|
**Entry Points:** {{entry_points}}
|
|
470
|
-
|
|
463
|
+
|
|
471
464
|
**Success Criteria:** {{success_criteria}}
|
|
472
465
|
sections:
|
|
473
466
|
- id: flow-diagram
|
|
@@ -498,14 +491,14 @@ sections:
|
|
|
498
491
|
title: "{{screen_name}}"
|
|
499
492
|
template: |
|
|
500
493
|
**Purpose:** {{screen_purpose}}
|
|
501
|
-
|
|
494
|
+
|
|
502
495
|
**Key Elements:**
|
|
503
496
|
- {{element_1}}
|
|
504
497
|
- {{element_2}}
|
|
505
498
|
- {{element_3}}
|
|
506
|
-
|
|
499
|
+
|
|
507
500
|
**Interaction Notes:** {{interaction_notes}}
|
|
508
|
-
|
|
501
|
+
|
|
509
502
|
**Design File Reference:** {{specific_frame_link}}
|
|
510
503
|
|
|
511
504
|
- id: component-library
|
|
@@ -524,11 +517,11 @@ sections:
|
|
|
524
517
|
title: "{{component_name}}"
|
|
525
518
|
template: |
|
|
526
519
|
**Purpose:** {{component_purpose}}
|
|
527
|
-
|
|
520
|
+
|
|
528
521
|
**Variants:** {{component_variants}}
|
|
529
|
-
|
|
522
|
+
|
|
530
523
|
**States:** {{component_states}}
|
|
531
|
-
|
|
524
|
+
|
|
532
525
|
**Usage Guidelines:** {{usage_guidelines}}
|
|
533
526
|
|
|
534
527
|
- id: branding-style
|
|
@@ -574,13 +567,13 @@ sections:
|
|
|
574
567
|
title: Iconography
|
|
575
568
|
template: |
|
|
576
569
|
**Icon Library:** {{icon_library}}
|
|
577
|
-
|
|
570
|
+
|
|
578
571
|
**Usage Guidelines:** {{icon_guidelines}}
|
|
579
572
|
- id: spacing-layout
|
|
580
573
|
title: Spacing & Layout
|
|
581
574
|
template: |
|
|
582
575
|
**Grid System:** {{grid_system}}
|
|
583
|
-
|
|
576
|
+
|
|
584
577
|
**Spacing Scale:** {{spacing_scale}}
|
|
585
578
|
|
|
586
579
|
- id: accessibility
|
|
@@ -598,12 +591,12 @@ sections:
|
|
|
598
591
|
- Color contrast ratios: {{contrast_requirements}}
|
|
599
592
|
- Focus indicators: {{focus_requirements}}
|
|
600
593
|
- Text sizing: {{text_requirements}}
|
|
601
|
-
|
|
594
|
+
|
|
602
595
|
**Interaction:**
|
|
603
596
|
- Keyboard navigation: {{keyboard_requirements}}
|
|
604
597
|
- Screen reader support: {{screen_reader_requirements}}
|
|
605
598
|
- Touch targets: {{touch_requirements}}
|
|
606
|
-
|
|
599
|
+
|
|
607
600
|
**Content:**
|
|
608
601
|
- Alternative text: {{alt_text_requirements}}
|
|
609
602
|
- Heading structure: {{heading_requirements}}
|
|
@@ -630,11 +623,11 @@ sections:
|
|
|
630
623
|
title: Adaptation Patterns
|
|
631
624
|
template: |
|
|
632
625
|
**Layout Changes:** {{layout_adaptations}}
|
|
633
|
-
|
|
626
|
+
|
|
634
627
|
**Navigation Changes:** {{nav_adaptations}}
|
|
635
|
-
|
|
628
|
+
|
|
636
629
|
**Content Priority:** {{content_adaptations}}
|
|
637
|
-
|
|
630
|
+
|
|
638
631
|
**Interaction Changes:** {{interaction_adaptations}}
|
|
639
632
|
|
|
640
633
|
- id: animation
|
|
@@ -668,7 +661,7 @@ sections:
|
|
|
668
661
|
title: Next Steps
|
|
669
662
|
instruction: |
|
|
670
663
|
After completing the UI/UX specification:
|
|
671
|
-
|
|
664
|
+
|
|
672
665
|
1. Recommend review with stakeholders
|
|
673
666
|
2. Suggest creating/updating visual designs in design tool
|
|
674
667
|
3. Prepare for handoff to Design Architect for frontend architecture
|