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.
Files changed (251) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +3 -3
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +3 -3
  3. package/.github/workflows/discord.yaml +11 -2
  4. package/.github/workflows/format-check.yaml +42 -0
  5. package/.github/workflows/manual-release.yaml +173 -0
  6. package/.husky/pre-commit +3 -0
  7. package/.vscode/settings.json +26 -1
  8. package/CHANGELOG.md +2 -23
  9. package/README.md +2 -0
  10. package/bmad-core/agent-teams/team-all.yaml +1 -1
  11. package/bmad-core/agents/analyst.md +16 -15
  12. package/bmad-core/agents/architect.md +11 -11
  13. package/bmad-core/agents/bmad-master.md +23 -22
  14. package/bmad-core/agents/bmad-orchestrator.md +13 -17
  15. package/bmad-core/agents/dev.md +14 -11
  16. package/bmad-core/agents/pm.md +15 -14
  17. package/bmad-core/agents/po.md +9 -8
  18. package/bmad-core/agents/qa.md +42 -22
  19. package/bmad-core/agents/sm.md +7 -6
  20. package/bmad-core/agents/ux-expert.md +6 -5
  21. package/bmad-core/core-config.yaml +2 -0
  22. package/bmad-core/data/bmad-kb.md +1 -1
  23. package/bmad-core/data/test-levels-framework.md +146 -0
  24. package/bmad-core/data/test-priorities-matrix.md +172 -0
  25. package/bmad-core/tasks/apply-qa-fixes.md +148 -0
  26. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  27. package/bmad-core/tasks/nfr-assess.md +343 -0
  28. package/bmad-core/tasks/qa-gate.md +161 -0
  29. package/bmad-core/tasks/review-story.md +234 -74
  30. package/bmad-core/tasks/risk-profile.md +353 -0
  31. package/bmad-core/tasks/test-design.md +174 -0
  32. package/bmad-core/tasks/trace-requirements.md +264 -0
  33. package/bmad-core/templates/architecture-tmpl.yaml +49 -49
  34. package/bmad-core/templates/brainstorming-output-tmpl.yaml +5 -5
  35. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +31 -31
  36. package/bmad-core/templates/brownfield-prd-tmpl.yaml +13 -13
  37. package/bmad-core/templates/competitor-analysis-tmpl.yaml +19 -6
  38. package/bmad-core/templates/front-end-architecture-tmpl.yaml +21 -9
  39. package/bmad-core/templates/front-end-spec-tmpl.yaml +24 -24
  40. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +122 -104
  41. package/bmad-core/templates/market-research-tmpl.yaml +2 -2
  42. package/bmad-core/templates/prd-tmpl.yaml +9 -9
  43. package/bmad-core/templates/project-brief-tmpl.yaml +4 -4
  44. package/bmad-core/templates/qa-gate-tmpl.yaml +102 -0
  45. package/bmad-core/templates/story-tmpl.yaml +12 -12
  46. package/bmad-core/workflows/brownfield-fullstack.yaml +9 -9
  47. package/bmad-core/workflows/brownfield-service.yaml +1 -1
  48. package/bmad-core/workflows/brownfield-ui.yaml +1 -1
  49. package/bmad-core/workflows/greenfield-fullstack.yaml +1 -1
  50. package/bmad-core/workflows/greenfield-service.yaml +1 -1
  51. package/bmad-core/workflows/greenfield-ui.yaml +1 -1
  52. package/common/utils/bmad-doc-template.md +5 -5
  53. package/dist/agents/analyst.txt +1086 -1079
  54. package/dist/agents/architect.txt +1534 -1526
  55. package/dist/agents/bmad-master.txt +646 -632
  56. package/dist/agents/bmad-orchestrator.txt +40 -18
  57. package/dist/agents/dev.txt +158 -19
  58. package/dist/agents/pm.txt +1082 -1107
  59. package/dist/agents/po.txt +314 -332
  60. package/dist/agents/qa.txt +1754 -151
  61. package/dist/agents/sm.txt +88 -98
  62. package/dist/agents/ux-expert.txt +80 -87
  63. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +109 -146
  64. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +75 -86
  65. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +41 -48
  66. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +1903 -1941
  67. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +15 -50
  68. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +149 -195
  69. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -15
  70. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +20 -37
  71. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +2660 -2752
  72. package/dist/expansion-packs/bmad-creative-writing/agents/beta-reader.txt +871 -0
  73. package/dist/expansion-packs/bmad-creative-writing/agents/book-critic.txt +78 -0
  74. package/dist/expansion-packs/bmad-creative-writing/agents/character-psychologist.txt +839 -0
  75. package/dist/expansion-packs/bmad-creative-writing/agents/cover-designer.txt +85 -0
  76. package/dist/expansion-packs/bmad-creative-writing/agents/dialog-specialist.txt +861 -0
  77. package/dist/expansion-packs/bmad-creative-writing/agents/editor.txt +796 -0
  78. package/dist/expansion-packs/bmad-creative-writing/agents/genre-specialist.txt +927 -0
  79. package/dist/expansion-packs/bmad-creative-writing/agents/narrative-designer.txt +842 -0
  80. package/dist/expansion-packs/bmad-creative-writing/agents/plot-architect.txt +1126 -0
  81. package/dist/expansion-packs/bmad-creative-writing/agents/world-builder.txt +864 -0
  82. package/dist/expansion-packs/bmad-creative-writing/teams/agent-team.txt +5917 -0
  83. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +25 -27
  84. package/dist/teams/team-all.txt +5541 -3768
  85. package/dist/teams/team-fullstack.txt +3014 -2987
  86. package/dist/teams/team-ide-minimal.txt +2219 -469
  87. package/dist/teams/team-no-ui.txt +2993 -2966
  88. package/docs/enhanced-ide-development-workflow.md +220 -15
  89. package/docs/user-guide.md +271 -18
  90. package/docs/versioning-and-releases.md +122 -44
  91. package/docs/working-in-the-brownfield.md +264 -31
  92. package/eslint.config.mjs +119 -0
  93. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +4 -4
  94. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +1 -1
  95. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  96. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +26 -28
  97. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +50 -50
  98. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +23 -23
  99. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +24 -24
  100. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +42 -42
  101. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
  102. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +5 -5
  103. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +1 -1
  104. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +3 -3
  105. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
  106. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +1 -1
  107. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +23 -23
  108. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +63 -63
  109. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +20 -20
  110. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
  111. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +5 -5
  112. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +1 -1
  113. package/expansion-packs/bmad-creative-writing/README.md +132 -0
  114. package/expansion-packs/bmad-creative-writing/agent-teams/agent-team.yaml +19 -0
  115. package/expansion-packs/bmad-creative-writing/agents/beta-reader.md +91 -0
  116. package/expansion-packs/bmad-creative-writing/agents/book-critic.md +35 -0
  117. package/expansion-packs/bmad-creative-writing/agents/character-psychologist.md +90 -0
  118. package/expansion-packs/bmad-creative-writing/agents/cover-designer.md +41 -0
  119. package/expansion-packs/bmad-creative-writing/agents/dialog-specialist.md +89 -0
  120. package/expansion-packs/bmad-creative-writing/agents/editor.md +90 -0
  121. package/expansion-packs/bmad-creative-writing/agents/genre-specialist.md +92 -0
  122. package/expansion-packs/bmad-creative-writing/agents/narrative-designer.md +90 -0
  123. package/expansion-packs/bmad-creative-writing/agents/plot-architect.md +92 -0
  124. package/expansion-packs/bmad-creative-writing/agents/world-builder.md +91 -0
  125. package/expansion-packs/bmad-creative-writing/checklists/beta-feedback-closure-checklist.md +16 -0
  126. package/expansion-packs/bmad-creative-writing/checklists/character-consistency-checklist.md +16 -0
  127. package/expansion-packs/bmad-creative-writing/checklists/comedic-timing-checklist.md +16 -0
  128. package/expansion-packs/bmad-creative-writing/checklists/cyberpunk-aesthetic-checklist.md +16 -0
  129. package/expansion-packs/bmad-creative-writing/checklists/ebook-formatting-checklist.md +15 -0
  130. package/expansion-packs/bmad-creative-writing/checklists/epic-poetry-meter-checklist.md +16 -0
  131. package/expansion-packs/bmad-creative-writing/checklists/fantasy-magic-system-checklist.md +16 -0
  132. package/expansion-packs/bmad-creative-writing/checklists/foreshadowing-payoff-checklist.md +15 -0
  133. package/expansion-packs/bmad-creative-writing/checklists/genre-tropes-checklist.md +15 -0
  134. package/expansion-packs/bmad-creative-writing/checklists/historical-accuracy-checklist.md +16 -0
  135. package/expansion-packs/bmad-creative-writing/checklists/horror-suspense-checklist.md +16 -0
  136. package/expansion-packs/bmad-creative-writing/checklists/kdp-cover-ready-checklist.md +18 -0
  137. package/expansion-packs/bmad-creative-writing/checklists/line-edit-quality-checklist.md +16 -0
  138. package/expansion-packs/bmad-creative-writing/checklists/marketing-copy-checklist.md +16 -0
  139. package/expansion-packs/bmad-creative-writing/checklists/mystery-clue-trail-checklist.md +16 -0
  140. package/expansion-packs/bmad-creative-writing/checklists/orbital-mechanics-checklist.md +16 -0
  141. package/expansion-packs/bmad-creative-writing/checklists/plot-structure-checklist.md +49 -0
  142. package/expansion-packs/bmad-creative-writing/checklists/publication-readiness-checklist.md +16 -0
  143. package/expansion-packs/bmad-creative-writing/checklists/romance-emotional-beats-checklist.md +16 -0
  144. package/expansion-packs/bmad-creative-writing/checklists/scene-quality-checklist.md +16 -0
  145. package/expansion-packs/bmad-creative-writing/checklists/scifi-technology-plausibility-checklist.md +15 -0
  146. package/expansion-packs/bmad-creative-writing/checklists/sensitivity-representation-checklist.md +16 -0
  147. package/expansion-packs/bmad-creative-writing/checklists/steampunk-gadget-checklist.md +16 -0
  148. package/expansion-packs/bmad-creative-writing/checklists/thriller-pacing-stakes-checklist.md +16 -0
  149. package/expansion-packs/bmad-creative-writing/checklists/timeline-continuity-checklist.md +16 -0
  150. package/expansion-packs/bmad-creative-writing/checklists/world-building-continuity-checklist.md +16 -0
  151. package/expansion-packs/bmad-creative-writing/checklists/ya-appropriateness-checklist.md +16 -0
  152. package/expansion-packs/bmad-creative-writing/config.yaml +11 -0
  153. package/expansion-packs/bmad-creative-writing/data/bmad-kb.md +197 -0
  154. package/expansion-packs/bmad-creative-writing/data/story-structures.md +58 -0
  155. package/expansion-packs/bmad-creative-writing/docs/brief.md +183 -0
  156. package/expansion-packs/bmad-creative-writing/tasks/advanced-elicitation.md +117 -0
  157. package/expansion-packs/bmad-creative-writing/tasks/analyze-reader-feedback.md +16 -0
  158. package/expansion-packs/bmad-creative-writing/tasks/analyze-story-structure.md +55 -0
  159. package/expansion-packs/bmad-creative-writing/tasks/assemble-kdp-package.md +22 -0
  160. package/expansion-packs/bmad-creative-writing/tasks/brainstorm-premise.md +16 -0
  161. package/expansion-packs/bmad-creative-writing/tasks/build-world.md +17 -0
  162. package/expansion-packs/bmad-creative-writing/tasks/character-depth-pass.md +15 -0
  163. package/expansion-packs/bmad-creative-writing/tasks/create-doc.md +101 -0
  164. package/expansion-packs/bmad-creative-writing/tasks/create-draft-section.md +19 -0
  165. package/expansion-packs/bmad-creative-writing/tasks/critical-review.md +19 -0
  166. package/expansion-packs/bmad-creative-writing/tasks/develop-character.md +17 -0
  167. package/expansion-packs/bmad-creative-writing/tasks/execute-checklist.md +93 -0
  168. package/expansion-packs/bmad-creative-writing/tasks/expand-premise.md +16 -0
  169. package/expansion-packs/bmad-creative-writing/tasks/expand-synopsis.md +16 -0
  170. package/expansion-packs/bmad-creative-writing/tasks/final-polish.md +16 -0
  171. package/expansion-packs/bmad-creative-writing/tasks/generate-cover-brief.md +18 -0
  172. package/expansion-packs/bmad-creative-writing/tasks/generate-cover-prompts.md +19 -0
  173. package/expansion-packs/bmad-creative-writing/tasks/generate-scene-list.md +16 -0
  174. package/expansion-packs/bmad-creative-writing/tasks/incorporate-feedback.md +18 -0
  175. package/expansion-packs/bmad-creative-writing/tasks/outline-scenes.md +16 -0
  176. package/expansion-packs/bmad-creative-writing/tasks/provide-feedback.md +17 -0
  177. package/expansion-packs/bmad-creative-writing/tasks/publish-chapter.md +16 -0
  178. package/expansion-packs/bmad-creative-writing/tasks/quick-feedback.md +15 -0
  179. package/expansion-packs/bmad-creative-writing/tasks/select-next-arc.md +16 -0
  180. package/expansion-packs/bmad-creative-writing/tasks/workshop-dialog.md +51 -0
  181. package/expansion-packs/bmad-creative-writing/templates/beta-feedback-form.yaml +96 -0
  182. package/expansion-packs/bmad-creative-writing/templates/chapter-draft-tmpl.yaml +81 -0
  183. package/expansion-packs/bmad-creative-writing/templates/character-profile-tmpl.yaml +92 -0
  184. package/expansion-packs/bmad-creative-writing/templates/cover-design-brief-tmpl.yaml +97 -0
  185. package/expansion-packs/bmad-creative-writing/templates/premise-brief-tmpl.yaml +77 -0
  186. package/expansion-packs/bmad-creative-writing/templates/scene-list-tmpl.yaml +54 -0
  187. package/expansion-packs/bmad-creative-writing/templates/story-outline-tmpl.yaml +96 -0
  188. package/expansion-packs/bmad-creative-writing/templates/world-guide-tmpl.yaml +88 -0
  189. package/expansion-packs/bmad-creative-writing/workflows/book-cover-design-workflow.md +176 -0
  190. package/expansion-packs/bmad-creative-writing/workflows/novel-greenfield-workflow.yaml +58 -0
  191. package/expansion-packs/bmad-creative-writing/workflows/novel-serial-workflow.yaml +51 -0
  192. package/expansion-packs/bmad-creative-writing/workflows/novel-snowflake-workflow.yaml +69 -0
  193. package/expansion-packs/bmad-creative-writing/workflows/novel-writing.yaml +92 -0
  194. package/expansion-packs/bmad-creative-writing/workflows/screenplay-development.yaml +86 -0
  195. package/expansion-packs/bmad-creative-writing/workflows/series-planning.yaml +79 -0
  196. package/expansion-packs/bmad-creative-writing/workflows/short-story-creation.yaml +65 -0
  197. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  198. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +20 -20
  199. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +7 -7
  200. package/package.json +62 -39
  201. package/prettier.config.mjs +32 -0
  202. package/sync-version.sh +23 -0
  203. package/tools/bmad-npx-wrapper.js +10 -10
  204. package/tools/builders/web-builder.js +124 -130
  205. package/tools/bump-all-versions.js +42 -33
  206. package/tools/bump-expansion-version.js +23 -16
  207. package/tools/cli.js +10 -12
  208. package/tools/flattener/aggregate.js +10 -10
  209. package/tools/flattener/binary.js +44 -17
  210. package/tools/flattener/discovery.js +19 -18
  211. package/tools/flattener/files.js +6 -6
  212. package/tools/flattener/ignoreRules.js +125 -125
  213. package/tools/flattener/main.js +426 -70
  214. package/tools/flattener/projectRoot.js +186 -25
  215. package/tools/flattener/prompts.js +9 -9
  216. package/tools/flattener/stats.helpers.js +395 -0
  217. package/tools/flattener/stats.js +64 -14
  218. package/tools/flattener/test-matrix.js +413 -0
  219. package/tools/flattener/xml.js +33 -31
  220. package/tools/installer/bin/bmad.js +156 -113
  221. package/tools/installer/config/ide-agent-config.yaml +1 -1
  222. package/tools/installer/config/install.config.yaml +13 -3
  223. package/tools/installer/lib/config-loader.js +46 -42
  224. package/tools/installer/lib/file-manager.js +91 -113
  225. package/tools/installer/lib/ide-base-setup.js +57 -56
  226. package/tools/installer/lib/ide-setup.js +545 -399
  227. package/tools/installer/lib/installer.js +875 -714
  228. package/tools/installer/lib/memory-profiler.js +54 -53
  229. package/tools/installer/lib/module-manager.js +19 -15
  230. package/tools/installer/lib/resource-locator.js +26 -28
  231. package/tools/installer/package.json +19 -19
  232. package/tools/lib/dependency-resolver.js +26 -30
  233. package/tools/lib/yaml-utils.js +7 -7
  234. package/tools/preview-release-notes.js +66 -0
  235. package/tools/shared/bannerArt.js +3 -3
  236. package/tools/sync-installer-version.js +7 -9
  237. package/tools/update-expansion-version.js +14 -15
  238. package/tools/upgraders/v3-to-v4-upgrader.js +203 -294
  239. package/tools/version-bump.js +41 -26
  240. package/tools/yaml-format.js +56 -43
  241. package/.github/workflows/release.yaml +0 -60
  242. package/.releaserc.json +0 -21
  243. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
  244. 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
  245. 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
  246. 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
  247. 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
  248. 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
  249. 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
  250. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
  251. package/tools/semantic-release-sync-installer.js +0 -30
@@ -19,33 +19,33 @@ sections:
19
19
  elicit: true
20
20
  content: |
21
21
  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.
22
-
22
+
23
23
  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.
24
24
  sections:
25
25
  - id: starter-template
26
26
  title: Starter Template or Existing Project
27
27
  instruction: |
28
28
  Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases:
29
-
29
+
30
30
  1. Review the PRD and other documents for mentions of:
31
31
  - Fullstack starter templates (e.g., T3 Stack, MEAN/MERN starters, Django + React templates)
32
32
  - Monorepo templates (e.g., Nx, Turborepo starters)
33
33
  - Platform-specific starters (e.g., Vercel templates, AWS Amplify starters)
34
34
  - Existing projects being extended or cloned
35
-
35
+
36
36
  2. If starter templates or existing projects are mentioned:
37
37
  - Ask the user to provide access (links, repos, or files)
38
38
  - Analyze to understand pre-configured choices and constraints
39
39
  - Note any architectural decisions already made
40
40
  - Identify what can be modified vs what must be retained
41
-
41
+
42
42
  3. If no starter is mentioned but this is greenfield:
43
43
  - Suggest appropriate fullstack starters based on tech preferences
44
44
  - Consider platform-specific options (Vercel, AWS, etc.)
45
45
  - Let user decide whether to use one
46
-
46
+
47
47
  4. Document the decision and any constraints it imposes
48
-
48
+
49
49
  If none, state "N/A - Greenfield project"
50
50
  - id: changelog
51
51
  title: Change Log
@@ -71,17 +71,17 @@ sections:
71
71
  title: Platform and Infrastructure Choice
72
72
  instruction: |
73
73
  Based on PRD requirements and technical assumptions, make a platform recommendation:
74
-
74
+
75
75
  1. Consider common patterns (not an exhaustive list, use your own best judgement and search the web as needed for emerging trends):
76
76
  - **Vercel + Supabase**: For rapid development with Next.js, built-in auth/storage
77
77
  - **AWS Full Stack**: For enterprise scale with Lambda, API Gateway, S3, Cognito
78
78
  - **Azure**: For .NET ecosystems or enterprise Microsoft environments
79
79
  - **Google Cloud**: For ML/AI heavy applications or Google ecosystem integration
80
-
80
+
81
81
  2. Present 2-3 viable options with clear pros/cons
82
82
  3. Make a recommendation with rationale
83
83
  4. Get explicit user confirmation
84
-
84
+
85
85
  Document the choice and key services that will be used.
86
86
  template: |
87
87
  **Platform:** {{selected_platform}}
@@ -91,7 +91,7 @@ sections:
91
91
  title: Repository Structure
92
92
  instruction: |
93
93
  Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure:
94
-
94
+
95
95
  1. For modern fullstack apps, monorepo is often preferred
96
96
  2. Consider tooling (Nx, Turborepo, Lerna, npm workspaces)
97
97
  3. Define package/app boundaries
@@ -113,7 +113,7 @@ sections:
113
113
  - Databases and storage
114
114
  - External integrations
115
115
  - CDN and caching layers
116
-
116
+
117
117
  Use appropriate diagram type for clarity.
118
118
  - id: architectural-patterns
119
119
  title: Architectural Patterns
@@ -123,7 +123,7 @@ sections:
123
123
  - Frontend patterns (e.g., Component-based, State management)
124
124
  - Backend patterns (e.g., Repository, CQRS, Event-driven)
125
125
  - Integration patterns (e.g., BFF, API Gateway)
126
-
126
+
127
127
  For each pattern, provide recommendation and rationale.
128
128
  repeatable: true
129
129
  template: "- **{{pattern_name}}:** {{pattern_description}} - _Rationale:_ {{rationale}}"
@@ -137,7 +137,7 @@ sections:
137
137
  title: Tech Stack
138
138
  instruction: |
139
139
  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.
140
-
140
+
141
141
  Key areas to cover:
142
142
  - Frontend and backend languages/frameworks
143
143
  - Databases and caching
@@ -146,7 +146,7 @@ sections:
146
146
  - Testing tools for both frontend and backend
147
147
  - Build and deployment tools
148
148
  - Monitoring and logging
149
-
149
+
150
150
  Upon render, elicit feedback immediately.
151
151
  elicit: true
152
152
  sections:
@@ -156,11 +156,29 @@ sections:
156
156
  columns: [Category, Technology, Version, Purpose, Rationale]
157
157
  rows:
158
158
  - ["Frontend Language", "{{fe_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
159
- - ["Frontend Framework", "{{fe_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
160
- - ["UI Component Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
159
+ - [
160
+ "Frontend Framework",
161
+ "{{fe_framework}}",
162
+ "{{version}}",
163
+ "{{purpose}}",
164
+ "{{why_chosen}}",
165
+ ]
166
+ - [
167
+ "UI Component Library",
168
+ "{{ui_library}}",
169
+ "{{version}}",
170
+ "{{purpose}}",
171
+ "{{why_chosen}}",
172
+ ]
161
173
  - ["State Management", "{{state_mgmt}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
162
174
  - ["Backend Language", "{{be_language}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
163
- - ["Backend Framework", "{{be_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
175
+ - [
176
+ "Backend Framework",
177
+ "{{be_framework}}",
178
+ "{{version}}",
179
+ "{{purpose}}",
180
+ "{{why_chosen}}",
181
+ ]
164
182
  - ["API Style", "{{api_style}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
165
183
  - ["Database", "{{database}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
166
184
  - ["Cache", "{{cache}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
@@ -181,14 +199,14 @@ sections:
181
199
  title: Data Models
182
200
  instruction: |
183
201
  Define the core data models/entities that will be shared between frontend and backend:
184
-
202
+
185
203
  1. Review PRD requirements and identify key business entities
186
204
  2. For each model, explain its purpose and relationships
187
205
  3. Include key attributes and data types
188
206
  4. Show relationships between models
189
207
  5. Create TypeScript interfaces that can be shared
190
208
  6. Discuss design decisions with user
191
-
209
+
192
210
  Create a clear conceptual model before moving to database schema.
193
211
  elicit: true
194
212
  repeatable: true
@@ -197,7 +215,7 @@ sections:
197
215
  title: "{{model_name}}"
198
216
  template: |
199
217
  **Purpose:** {{model_purpose}}
200
-
218
+
201
219
  **Key Attributes:**
202
220
  - {{attribute_1}}: {{type_1}} - {{description_1}}
203
221
  - {{attribute_2}}: {{type_2}} - {{description_2}}
@@ -216,7 +234,7 @@ sections:
216
234
  title: API Specification
217
235
  instruction: |
218
236
  Based on the chosen API style from Tech Stack:
219
-
237
+
220
238
  1. If REST API, create an OpenAPI 3.0 specification
221
239
  2. If GraphQL, provide the GraphQL schema
222
240
  3. If tRPC, show router definitions
@@ -224,7 +242,7 @@ sections:
224
242
  5. Define request/response schemas based on data models
225
243
  6. Document authentication requirements
226
244
  7. Include example requests/responses
227
-
245
+
228
246
  Use appropriate format for the chosen API style. If no API (e.g., static site), skip this section.
229
247
  elicit: true
230
248
  sections:
@@ -259,7 +277,7 @@ sections:
259
277
  title: Components
260
278
  instruction: |
261
279
  Based on the architectural patterns, tech stack, and data models from above:
262
-
280
+
263
281
  1. Identify major logical components/services across the fullstack
264
282
  2. Consider both frontend and backend components
265
283
  3. Define clear boundaries and interfaces between components
@@ -268,7 +286,7 @@ sections:
268
286
  - Key interfaces/APIs exposed
269
287
  - Dependencies on other components
270
288
  - Technology specifics based on tech stack choices
271
-
289
+
272
290
  5. Create component diagrams where helpful
273
291
  elicit: true
274
292
  sections:
@@ -277,13 +295,13 @@ sections:
277
295
  title: "{{component_name}}"
278
296
  template: |
279
297
  **Responsibility:** {{component_description}}
280
-
298
+
281
299
  **Key Interfaces:**
282
300
  - {{interface_1}}
283
301
  - {{interface_2}}
284
-
302
+
285
303
  **Dependencies:** {{dependencies}}
286
-
304
+
287
305
  **Technology Stack:** {{component_tech_details}}
288
306
  - id: component-diagrams
289
307
  title: Component Diagrams
@@ -300,13 +318,13 @@ sections:
300
318
  condition: Project requires external API integrations
301
319
  instruction: |
302
320
  For each external service integration:
303
-
321
+
304
322
  1. Identify APIs needed based on PRD requirements and component design
305
323
  2. If documentation URLs are unknown, ask user for specifics
306
324
  3. Document authentication methods and security considerations
307
325
  4. List specific endpoints that will be used
308
326
  5. Note any rate limits or usage constraints
309
-
327
+
310
328
  If no external APIs are needed, state this explicitly and skip to next section.
311
329
  elicit: true
312
330
  repeatable: true
@@ -319,10 +337,10 @@ sections:
319
337
  - **Base URL(s):** {{api_base_url}}
320
338
  - **Authentication:** {{auth_method}}
321
339
  - **Rate Limits:** {{rate_limits}}
322
-
340
+
323
341
  **Key Endpoints Used:**
324
342
  - `{{method}} {{endpoint_path}}` - {{endpoint_purpose}}
325
-
343
+
326
344
  **Integration Notes:** {{integration_considerations}}
327
345
 
328
346
  - id: core-workflows
@@ -331,14 +349,14 @@ sections:
331
349
  mermaid_type: sequence
332
350
  instruction: |
333
351
  Illustrate key system workflows using sequence diagrams:
334
-
352
+
335
353
  1. Identify critical user journeys from PRD
336
354
  2. Show component interactions including external APIs
337
355
  3. Include both frontend and backend flows
338
356
  4. Include error handling paths
339
357
  5. Document async operations
340
358
  6. Create both high-level and detailed diagrams as needed
341
-
359
+
342
360
  Focus on workflows that clarify architecture decisions or complex interactions.
343
361
  elicit: true
344
362
 
@@ -346,13 +364,13 @@ sections:
346
364
  title: Database Schema
347
365
  instruction: |
348
366
  Transform the conceptual data models into concrete database schemas:
349
-
367
+
350
368
  1. Use the database type(s) selected in Tech Stack
351
369
  2. Create schema definitions using appropriate notation
352
370
  3. Include indexes, constraints, and relationships
353
371
  4. Consider performance and scalability
354
372
  5. For NoSQL, show document structures
355
-
373
+
356
374
  Present schema in format appropriate to database type (SQL DDL, JSON schema, etc.)
357
375
  elicit: true
358
376
 
@@ -488,60 +506,60 @@ sections:
488
506
  type: code
489
507
  language: plaintext
490
508
  examples:
491
- - |
492
- {{project-name}}/
493
- ├── .github/ # CI/CD workflows
494
- │ └── workflows/
495
- │ ├── ci.yaml
496
- │ └── deploy.yaml
497
- ├── apps/ # Application packages
498
- │ ├── web/ # Frontend application
499
- │ │ ├── src/
500
- │ │ │ ├── components/ # UI components
501
- │ │ │ ├── pages/ # Page components/routes
502
- │ │ │ ├── hooks/ # Custom React hooks
503
- │ │ │ ├── services/ # API client services
504
- │ │ │ ├── stores/ # State management
505
- │ │ │ ├── styles/ # Global styles/themes
506
- │ │ │ └── utils/ # Frontend utilities
507
- │ │ ├── public/ # Static assets
508
- │ │ ├── tests/ # Frontend tests
509
- │ │ └── package.json
510
- │ └── api/ # Backend application
511
- │ ├── src/
512
- │ │ ├── routes/ # API routes/controllers
513
- │ │ ├── services/ # Business logic
514
- │ │ ├── models/ # Data models
515
- │ │ ├── middleware/ # Express/API middleware
516
- │ │ ├── utils/ # Backend utilities
517
- │ │ └── {{serverless_or_server_entry}}
518
- │ ├── tests/ # Backend tests
519
- │ └── package.json
520
- ├── packages/ # Shared packages
521
- │ ├── shared/ # Shared types/utilities
522
- │ │ ├── src/
523
- │ │ │ ├── types/ # TypeScript interfaces
524
- │ │ │ ├── constants/ # Shared constants
525
- │ │ │ └── utils/ # Shared utilities
526
- │ │ └── package.json
527
- │ ├── ui/ # Shared UI components
528
- │ │ ├── src/
529
- │ │ └── package.json
530
- │ └── config/ # Shared configuration
531
- │ ├── eslint/
532
- │ ├── typescript/
533
- │ └── jest/
534
- ├── infrastructure/ # IaC definitions
535
- │ └── {{iac_structure}}
536
- ├── scripts/ # Build/deploy scripts
537
- ├── docs/ # Documentation
538
- │ ├── prd.md
539
- │ ├── front-end-spec.md
540
- │ └── fullstack-architecture.md
541
- ├── .env.example # Environment template
542
- ├── package.json # Root package.json
543
- ├── {{monorepo_config}} # Monorepo configuration
544
- └── README.md
509
+ - |
510
+ {{project-name}}/
511
+ ├── .github/ # CI/CD workflows
512
+ │ └── workflows/
513
+ │ ├── ci.yaml
514
+ │ └── deploy.yaml
515
+ ├── apps/ # Application packages
516
+ │ ├── web/ # Frontend application
517
+ │ │ ├── src/
518
+ │ │ │ ├── components/ # UI components
519
+ │ │ │ ├── pages/ # Page components/routes
520
+ │ │ │ ├── hooks/ # Custom React hooks
521
+ │ │ │ ├── services/ # API client services
522
+ │ │ │ ├── stores/ # State management
523
+ │ │ │ ├── styles/ # Global styles/themes
524
+ │ │ │ └── utils/ # Frontend utilities
525
+ │ │ ├── public/ # Static assets
526
+ │ │ ├── tests/ # Frontend tests
527
+ │ │ └── package.json
528
+ │ └── api/ # Backend application
529
+ │ ├── src/
530
+ │ │ ├── routes/ # API routes/controllers
531
+ │ │ ├── services/ # Business logic
532
+ │ │ ├── models/ # Data models
533
+ │ │ ├── middleware/ # Express/API middleware
534
+ │ │ ├── utils/ # Backend utilities
535
+ │ │ └── {{serverless_or_server_entry}}
536
+ │ ├── tests/ # Backend tests
537
+ │ └── package.json
538
+ ├── packages/ # Shared packages
539
+ │ ├── shared/ # Shared types/utilities
540
+ │ │ ├── src/
541
+ │ │ │ ├── types/ # TypeScript interfaces
542
+ │ │ │ ├── constants/ # Shared constants
543
+ │ │ │ └── utils/ # Shared utilities
544
+ │ │ └── package.json
545
+ │ ├── ui/ # Shared UI components
546
+ │ │ ├── src/
547
+ │ │ └── package.json
548
+ │ └── config/ # Shared configuration
549
+ │ ├── eslint/
550
+ │ ├── typescript/
551
+ │ └── jest/
552
+ ├── infrastructure/ # IaC definitions
553
+ │ └── {{iac_structure}}
554
+ ├── scripts/ # Build/deploy scripts
555
+ ├── docs/ # Documentation
556
+ │ ├── prd.md
557
+ │ ├── front-end-spec.md
558
+ │ └── fullstack-architecture.md
559
+ ├── .env.example # Environment template
560
+ ├── package.json # Root package.json
561
+ ├── {{monorepo_config}} # Monorepo configuration
562
+ └── README.md
545
563
 
546
564
  - id: development-workflow
547
565
  title: Development Workflow
@@ -568,13 +586,13 @@ sections:
568
586
  template: |
569
587
  # Start all services
570
588
  {{start_all_command}}
571
-
589
+
572
590
  # Start frontend only
573
591
  {{start_frontend_command}}
574
-
592
+
575
593
  # Start backend only
576
594
  {{start_backend_command}}
577
-
595
+
578
596
  # Run tests
579
597
  {{test_commands}}
580
598
  - id: environment-config
@@ -587,10 +605,10 @@ sections:
587
605
  template: |
588
606
  # Frontend (.env.local)
589
607
  {{frontend_env_vars}}
590
-
608
+
591
609
  # Backend (.env)
592
610
  {{backend_env_vars}}
593
-
611
+
594
612
  # Shared
595
613
  {{shared_env_vars}}
596
614
 
@@ -607,7 +625,7 @@ sections:
607
625
  - **Build Command:** {{frontend_build_command}}
608
626
  - **Output Directory:** {{frontend_output_dir}}
609
627
  - **CDN/Edge:** {{cdn_strategy}}
610
-
628
+
611
629
  **Backend Deployment:**
612
630
  - **Platform:** {{backend_deploy_platform}}
613
631
  - **Build Command:** {{backend_build_command}}
@@ -638,12 +656,12 @@ sections:
638
656
  - CSP Headers: {{csp_policy}}
639
657
  - XSS Prevention: {{xss_strategy}}
640
658
  - Secure Storage: {{storage_strategy}}
641
-
659
+
642
660
  **Backend Security:**
643
661
  - Input Validation: {{validation_approach}}
644
662
  - Rate Limiting: {{rate_limit_config}}
645
663
  - CORS Policy: {{cors_config}}
646
-
664
+
647
665
  **Authentication Security:**
648
666
  - Token Storage: {{token_strategy}}
649
667
  - Session Management: {{session_approach}}
@@ -655,7 +673,7 @@ sections:
655
673
  - Bundle Size Target: {{bundle_size}}
656
674
  - Loading Strategy: {{loading_approach}}
657
675
  - Caching Strategy: {{fe_cache_strategy}}
658
-
676
+
659
677
  **Backend Performance:**
660
678
  - Response Time Target: {{response_target}}
661
679
  - Database Optimization: {{db_optimization}}
@@ -671,10 +689,10 @@ sections:
671
689
  type: code
672
690
  language: text
673
691
  template: |
674
- E2E Tests
675
- / \
676
- Integration Tests
677
- / \
692
+ E2E Tests
693
+ / \
694
+ Integration Tests
695
+ / \
678
696
  Frontend Unit Backend Unit
679
697
  - id: test-organization
680
698
  title: Test Organization
@@ -793,7 +811,7 @@ sections:
793
811
  - JavaScript errors
794
812
  - API response times
795
813
  - User interactions
796
-
814
+
797
815
  **Backend Metrics:**
798
816
  - Request rate
799
817
  - Error rate
@@ -802,4 +820,4 @@ sections:
802
820
 
803
821
  - id: checklist-results
804
822
  title: Checklist Results Report
805
- instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.
823
+ instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.
@@ -130,7 +130,7 @@ sections:
130
130
  instruction: Map the end-to-end customer experience for primary segments
131
131
  template: |
132
132
  For primary customer segment:
133
-
133
+
134
134
  1. **Awareness:** {{discovery_process}}
135
135
  2. **Consideration:** {{evaluation_criteria}}
136
136
  3. **Purchase:** {{decision_triggers}}
@@ -249,4 +249,4 @@ sections:
249
249
  instruction: Include any complex calculations or models
250
250
  - id: additional-analysis
251
251
  title: C. Additional Analysis
252
- instruction: Any supplementary analysis not included in main body
252
+ instruction: Any supplementary analysis not included in main body
@@ -56,7 +56,7 @@ sections:
56
56
  condition: PRD has UX/UI requirements
57
57
  instruction: |
58
58
  Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
59
-
59
+
60
60
  1. Pre-fill all subsections with educated guesses based on project context
61
61
  2. Present the complete rendered section to user
62
62
  3. Clearly let the user know where assumptions were made
@@ -98,7 +98,7 @@ sections:
98
98
  title: Technical Assumptions
99
99
  instruction: |
100
100
  Gather technical decisions that will guide the Architect. Steps:
101
-
101
+
102
102
  1. Check if {root}/data/technical-preferences.yaml or an attached technical-preferences file exists - use it to pre-populate choices
103
103
  2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
104
104
  3. For unknowns, offer guidance based on project goals and MVP scope
@@ -126,9 +126,9 @@ sections:
126
126
  title: Epic List
127
127
  instruction: |
128
128
  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.
129
-
129
+
130
130
  CRITICAL: Epics MUST be logically sequential following agile best practices:
131
-
131
+
132
132
  - Each epic should deliver a significant, end-to-end, fully deployable increment of testable functionality
133
133
  - 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!
134
134
  - Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
@@ -147,11 +147,11 @@ sections:
147
147
  repeatable: true
148
148
  instruction: |
149
149
  After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
150
-
150
+
151
151
  For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
152
-
152
+
153
153
  CRITICAL STORY SEQUENCING REQUIREMENTS:
154
-
154
+
155
155
  - Stories within each epic MUST be logically sequential
156
156
  - Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
157
157
  - No story should depend on work from a later story or epic
@@ -179,7 +179,7 @@ sections:
179
179
  repeatable: true
180
180
  instruction: |
181
181
  Define clear, comprehensive, and testable acceptance criteria that:
182
-
182
+
183
183
  - Precisely define what "done" means from a functional perspective
184
184
  - Are unambiguous and serve as basis for verification
185
185
  - Include any critical non-functional requirements from the PRD
@@ -199,4 +199,4 @@ sections:
199
199
  instruction: This section will contain the prompt for the UX Expert, keep it short and to the point to initiate create architecture mode using this document as input.
200
200
  - id: architect-prompt
201
201
  title: Architect Prompt
202
- instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.
202
+ instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.
@@ -28,12 +28,12 @@ sections:
28
28
  - id: introduction
29
29
  instruction: |
30
30
  This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
31
-
31
+
32
32
  Start by asking the user which mode they prefer:
33
-
33
+
34
34
  1. **Interactive Mode** - Work through each section collaboratively
35
35
  2. **YOLO Mode** - Generate complete draft for review and refinement
36
-
36
+
37
37
  Before beginning, understand what inputs are available (brainstorming results, market research, competitive analysis, initial ideas) and gather project context.
38
38
 
39
39
  - id: executive-summary
@@ -218,4 +218,4 @@ sections:
218
218
  - id: pm-handoff
219
219
  title: PM Handoff
220
220
  content: |
221
- This Project Brief provides the full context for {{project_name}}. Please start in 'PRD Generation Mode', review the brief thoroughly to work with the user to create the PRD section by section as the template indicates, asking for any necessary clarification or suggesting improvements.
221
+ This Project Brief provides the full context for {{project_name}}. Please start in 'PRD Generation Mode', review the brief thoroughly to work with the user to create the PRD section by section as the template indicates, asking for any necessary clarification or suggesting improvements.