fraim-framework 2.0.67 → 2.0.69

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 (280) hide show
  1. package/bin/fraim.js +1 -1
  2. package/dist/src/cli/commands/doctor.js +1 -1
  3. package/dist/src/cli/commands/init-project.js +6 -12
  4. package/dist/src/cli/commands/list.js +1 -1
  5. package/dist/src/cli/commands/setup.js +15 -29
  6. package/dist/src/cli/commands/sync.js +36 -143
  7. package/dist/src/cli/fraim.js +0 -4
  8. package/dist/src/cli/setup/first-run.js +4 -4
  9. package/dist/src/cli/setup/ide-detector.js +15 -5
  10. package/dist/src/fraim/template-processor.js +7 -35
  11. package/dist/src/local-mcp-server/stdio-server.js +170 -181
  12. package/dist/src/utils/git-utils.js +2 -2
  13. package/dist/src/utils/object-utils.js +11 -0
  14. package/dist/src/utils/provider-utils.js +14 -0
  15. package/dist/src/utils/request-utils.js +23 -0
  16. package/dist/src/utils/workflow-parser.js +7 -7
  17. package/package.json +7 -5
  18. package/dist/registry/ai-manager-rules/customer-development-phases/phase1-customer-profiling.md +0 -101
  19. package/dist/registry/ai-manager-rules/customer-development-phases/phase2-platform-discovery.md +0 -235
  20. package/dist/registry/ai-manager-rules/customer-development-phases/phase3-prospect-qualification.md +0 -243
  21. package/dist/registry/ai-manager-rules/customer-development-phases/phase4-inventory-compilation.md +0 -206
  22. package/dist/registry/ai-manager-rules/design-phases/design-completeness-review.md +0 -73
  23. package/dist/registry/ai-manager-rules/design-phases/design-design.md +0 -145
  24. package/dist/registry/ai-manager-rules/design-phases/design.md +0 -108
  25. package/dist/registry/ai-manager-rules/design-phases/finalize.md +0 -60
  26. package/dist/registry/ai-manager-rules/design-phases/validate.md +0 -125
  27. package/dist/registry/ai-manager-rules/design.json +0 -97
  28. package/dist/registry/ai-manager-rules/implement-phases/code.md +0 -323
  29. package/dist/registry/ai-manager-rules/implement-phases/completeness-review.md +0 -94
  30. package/dist/registry/ai-manager-rules/implement-phases/finalize.md +0 -177
  31. package/dist/registry/ai-manager-rules/implement-phases/implement-code.md +0 -283
  32. package/dist/registry/ai-manager-rules/implement-phases/implement-completeness-review.md +0 -120
  33. package/dist/registry/ai-manager-rules/implement-phases/implement-regression.md +0 -173
  34. package/dist/registry/ai-manager-rules/implement-phases/implement-repro.md +0 -104
  35. package/dist/registry/ai-manager-rules/implement-phases/implement-scoping.md +0 -100
  36. package/dist/registry/ai-manager-rules/implement-phases/implement-smoke.md +0 -237
  37. package/dist/registry/ai-manager-rules/implement-phases/implement-spike.md +0 -121
  38. package/dist/registry/ai-manager-rules/implement-phases/implement-validate.md +0 -375
  39. package/dist/registry/ai-manager-rules/implement-phases/quality-review.md +0 -304
  40. package/dist/registry/ai-manager-rules/implement-phases/regression.md +0 -159
  41. package/dist/registry/ai-manager-rules/implement-phases/repro.md +0 -101
  42. package/dist/registry/ai-manager-rules/implement-phases/scoping.md +0 -93
  43. package/dist/registry/ai-manager-rules/implement-phases/smoke.md +0 -225
  44. package/dist/registry/ai-manager-rules/implement-phases/spike.md +0 -118
  45. package/dist/registry/ai-manager-rules/implement-phases/validate.md +0 -347
  46. package/dist/registry/ai-manager-rules/implement.json +0 -153
  47. package/dist/registry/ai-manager-rules/retrospective.md +0 -116
  48. package/dist/registry/ai-manager-rules/shared-phases/address-pr-feedback.md +0 -188
  49. package/dist/registry/ai-manager-rules/shared-phases/finalize.md +0 -169
  50. package/dist/registry/ai-manager-rules/shared-phases/submit-pr.md +0 -202
  51. package/dist/registry/ai-manager-rules/shared-phases/wait-for-pr-review.md +0 -170
  52. package/dist/registry/ai-manager-rules/spec-phases/finalize.md +0 -60
  53. package/dist/registry/ai-manager-rules/spec-phases/spec-competitor-analysis.md +0 -105
  54. package/dist/registry/ai-manager-rules/spec-phases/spec-completeness-review.md +0 -66
  55. package/dist/registry/ai-manager-rules/spec-phases/spec-spec.md +0 -139
  56. package/dist/registry/ai-manager-rules/spec-phases/spec.md +0 -102
  57. package/dist/registry/ai-manager-rules/spec-phases/validate.md +0 -118
  58. package/dist/registry/ai-manager-rules/spec.json +0 -112
  59. package/dist/registry/ai-manager-rules/test.json +0 -98
  60. package/dist/registry/ai-manager-rules/user-survey-phases/phase1-survey-scoping.md +0 -60
  61. package/dist/registry/ai-manager-rules/user-survey-phases/phase2-survey-build-linkedin.md +0 -23
  62. package/dist/registry/ai-manager-rules/user-survey-phases/phase3-survey-build-reddit.md +0 -22
  63. package/dist/registry/ai-manager-rules/user-survey-phases/phase4-survey-build-x.md +0 -21
  64. package/dist/registry/ai-manager-rules/user-survey-phases/phase5-survey-build-facebook.md +0 -19
  65. package/dist/registry/ai-manager-rules/user-survey-phases/phase6-survey-build-custom.md +0 -15
  66. package/dist/registry/ai-manager-rules/user-survey-phases/phase7-survey-dispatch.md +0 -45
  67. package/dist/registry/delivery/address-feedback.md +0 -83
  68. package/dist/registry/delivery/retrospective.md +0 -78
  69. package/dist/registry/delivery/submit.md +0 -79
  70. package/dist/registry/providers/ado.json +0 -19
  71. package/dist/registry/providers/delivery-conversation.json +0 -9
  72. package/dist/registry/providers/delivery-pr.json +0 -9
  73. package/dist/registry/providers/github.json +0 -19
  74. package/dist/registry/rules/agent-success-criteria.md +0 -101
  75. package/dist/registry/rules/agent-testing-guidelines.md +0 -502
  76. package/dist/registry/rules/architecture.md +0 -126
  77. package/dist/registry/rules/communication.md +0 -122
  78. package/dist/registry/rules/continuous-learning.md +0 -55
  79. package/dist/registry/rules/debugging-multitenancy-issues.md +0 -85
  80. package/dist/registry/rules/ephemeral-execution.md +0 -54
  81. package/dist/registry/rules/git-safe-commands.md +0 -34
  82. package/dist/registry/rules/hitl-ppe-record-analysis.md +0 -302
  83. package/dist/registry/rules/integrity-and-test-ethics.md +0 -275
  84. package/dist/registry/rules/local-development.md +0 -275
  85. package/dist/registry/rules/mandatory-pre-completion-reflection.md +0 -193
  86. package/dist/registry/rules/merge-requirements.md +0 -238
  87. package/dist/registry/rules/simplicity.md +0 -118
  88. package/dist/registry/rules/software-development-lifecycle.md +0 -105
  89. package/dist/registry/rules/spike-first-development.md +0 -205
  90. package/dist/registry/rules/successful-debugging-patterns.md +0 -488
  91. package/dist/registry/scripts/build-scripts-generator.js +0 -205
  92. package/dist/registry/scripts/cleanup-branch.js +0 -287
  93. package/dist/registry/scripts/evaluate-code-quality.js +0 -66
  94. package/dist/registry/scripts/exec-with-timeout.js +0 -142
  95. package/dist/registry/scripts/fraim-config.js +0 -61
  96. package/dist/registry/scripts/generate-engagement-emails.js +0 -705
  97. package/dist/registry/scripts/generic-issues-api.js +0 -100
  98. package/dist/registry/scripts/newsletter-helpers.js +0 -671
  99. package/dist/registry/scripts/openapi-generator.js +0 -664
  100. package/dist/registry/scripts/performance/profile-server.js +0 -390
  101. package/dist/registry/scripts/profile-server.js +0 -389
  102. package/dist/registry/scripts/run-thank-you-workflow.js +0 -92
  103. package/dist/registry/scripts/send-newsletter-simple.js +0 -85
  104. package/dist/registry/scripts/send-thank-you-emails.js +0 -54
  105. package/dist/registry/scripts/validate-openapi-limits.js +0 -311
  106. package/dist/registry/scripts/validate-test-coverage.js +0 -262
  107. package/dist/registry/scripts/verify-test-coverage.js +0 -66
  108. package/dist/registry/stubs/workflows/azure/cost-optimization.md +0 -11
  109. package/dist/registry/stubs/workflows/bootstrap/create-architecture.md +0 -11
  110. package/dist/registry/stubs/workflows/bootstrap/detect-broken-windows.md +0 -11
  111. package/dist/registry/stubs/workflows/bootstrap/evaluate-code-quality.md +0 -11
  112. package/dist/registry/stubs/workflows/bootstrap/verify-test-coverage.md +0 -11
  113. package/dist/registry/stubs/workflows/brainstorming/blue-sky-brainstorming.md +0 -11
  114. package/dist/registry/stubs/workflows/brainstorming/codebase-brainstorming.md +0 -11
  115. package/dist/registry/stubs/workflows/business-development/create-business-plan.md +0 -11
  116. package/dist/registry/stubs/workflows/business-development/ideate-business-opportunity.md +0 -11
  117. package/dist/registry/stubs/workflows/business-development/price-product.md +0 -18
  118. package/dist/registry/stubs/workflows/compliance/detect-compliance-requirements.md +0 -11
  119. package/dist/registry/stubs/workflows/compliance/generate-audit-evidence.md +0 -11
  120. package/dist/registry/stubs/workflows/compliance/soc2-evidence-generator.md +0 -11
  121. package/dist/registry/stubs/workflows/customer-development/insight-analysis.md +0 -11
  122. package/dist/registry/stubs/workflows/customer-development/insight-triage.md +0 -11
  123. package/dist/registry/stubs/workflows/customer-development/interview-preparation.md +0 -11
  124. package/dist/registry/stubs/workflows/customer-development/linkedin-outreach.md +0 -11
  125. package/dist/registry/stubs/workflows/customer-development/strategic-brainstorming.md +0 -11
  126. package/dist/registry/stubs/workflows/customer-development/thank-customers.md +0 -11
  127. package/dist/registry/stubs/workflows/customer-development/user-survey-dispatch.md +0 -11
  128. package/dist/registry/stubs/workflows/customer-development/users-to-target.md +0 -11
  129. package/dist/registry/stubs/workflows/customer-development/weekly-newsletter.md +0 -11
  130. package/dist/registry/stubs/workflows/deploy/cloud-deployment.md +0 -11
  131. package/dist/registry/stubs/workflows/improve-fraim/contribute.md +0 -11
  132. package/dist/registry/stubs/workflows/improve-fraim/file-issue.md +0 -11
  133. package/dist/registry/stubs/workflows/learning/build-skillset.md +0 -11
  134. package/dist/registry/stubs/workflows/learning/synthesize-learnings.md +0 -11
  135. package/dist/registry/stubs/workflows/legal/contract-review-analysis.md +0 -11
  136. package/dist/registry/stubs/workflows/legal/nda.md +0 -11
  137. package/dist/registry/stubs/workflows/legal/patent-filing.md +0 -11
  138. package/dist/registry/stubs/workflows/legal/saas-contract-development.md +0 -11
  139. package/dist/registry/stubs/workflows/legal/trademark-filing.md +0 -11
  140. package/dist/registry/stubs/workflows/marketing/content-creation.md +0 -11
  141. package/dist/registry/stubs/workflows/marketing/convert-to-pdf.md +0 -11
  142. package/dist/registry/stubs/workflows/marketing/create-modern-website.md +0 -11
  143. package/dist/registry/stubs/workflows/marketing/domain-registration.md +0 -11
  144. package/dist/registry/stubs/workflows/marketing/evangelize.md +0 -11
  145. package/dist/registry/stubs/workflows/marketing/hbr-article.md +0 -11
  146. package/dist/registry/stubs/workflows/marketing/launch-checklist.md +0 -11
  147. package/dist/registry/stubs/workflows/marketing/marketing-strategy.md +0 -11
  148. package/dist/registry/stubs/workflows/marketing/storytelling.md +0 -11
  149. package/dist/registry/stubs/workflows/performance/analyze-performance.md +0 -11
  150. package/dist/registry/stubs/workflows/product-building/design.md +0 -11
  151. package/dist/registry/stubs/workflows/product-building/implement.md +0 -11
  152. package/dist/registry/stubs/workflows/product-building/iterate-on-pr-comments.md +0 -11
  153. package/dist/registry/stubs/workflows/product-building/prep-issue.md +0 -11
  154. package/dist/registry/stubs/workflows/product-building/prototype.md +0 -11
  155. package/dist/registry/stubs/workflows/product-building/resolve.md +0 -11
  156. package/dist/registry/stubs/workflows/product-building/retrospect.md +0 -11
  157. package/dist/registry/stubs/workflows/product-building/spec.md +0 -11
  158. package/dist/registry/stubs/workflows/product-building/test.md +0 -11
  159. package/dist/registry/stubs/workflows/productivity-report/productivity-report.md +0 -11
  160. package/dist/registry/stubs/workflows/quality-assurance/browser-validation.md +0 -11
  161. package/dist/registry/stubs/workflows/quality-assurance/iterative-improvement-cycle.md +0 -11
  162. package/dist/registry/stubs/workflows/replicate/replicate-discovery.md +0 -11
  163. package/dist/registry/stubs/workflows/replicate/replicate-to-issues.md +0 -11
  164. package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-design-spec.md +0 -11
  165. package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -11
  166. package/dist/registry/stubs/workflows/startup-credits/aws-activate-application.md +0 -11
  167. package/dist/registry/stubs/workflows/startup-credits/google-cloud-application.md +0 -11
  168. package/dist/registry/stubs/workflows/startup-credits/microsoft-azure-application.md +0 -11
  169. package/dist/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +0 -53
  170. package/dist/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +0 -37
  171. package/dist/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +0 -35
  172. package/dist/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +0 -29
  173. package/dist/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +0 -126
  174. package/dist/registry/templates/customer-development/customer-interview-template.md +0 -99
  175. package/dist/registry/templates/customer-development/customer-persona-template.md +0 -69
  176. package/dist/registry/templates/customer-development/follow-up-email-templates.md +0 -132
  177. package/dist/registry/templates/customer-development/insight-analysis-template.md +0 -74
  178. package/dist/registry/templates/customer-development/prospect-inventory-template.csv +0 -3
  179. package/dist/registry/templates/customer-development/search-strategy-template.md +0 -123
  180. package/dist/registry/templates/customer-development/strategic-recommendations-template.md +0 -53
  181. package/dist/registry/templates/customer-development/thank-you-email-template.html +0 -124
  182. package/dist/registry/templates/customer-development/thank-you-note-template.md +0 -16
  183. package/dist/registry/templates/customer-development/triage-log-template.md +0 -278
  184. package/dist/registry/templates/customer-development/weekly-newsletter-template.html +0 -204
  185. package/dist/registry/templates/evidence/Design-Evidence.md +0 -30
  186. package/dist/registry/templates/evidence/Implementation-BugEvidence.md +0 -122
  187. package/dist/registry/templates/evidence/Implementation-FeatureEvidence.md +0 -160
  188. package/dist/registry/templates/evidence/Spec-Evidence.md +0 -19
  189. package/dist/registry/templates/help/HelpNeeded.md +0 -14
  190. package/dist/registry/templates/legal/NDA-TEMPLATE.md +0 -170
  191. package/dist/registry/templates/legal/PATENT-TEMPLATE.md +0 -372
  192. package/dist/registry/templates/legal/TRADEMARK-TEMPLATE.md +0 -339
  193. package/dist/registry/templates/legal/contract-review-checklist.md +0 -193
  194. package/dist/registry/templates/legal/review-report-template.md +0 -198
  195. package/dist/registry/templates/legal/saas-terms-template.md +0 -174
  196. package/dist/registry/templates/legal/sow-template.md +0 -117
  197. package/dist/registry/templates/legal/template-variables.md +0 -131
  198. package/dist/registry/templates/marketing/DOMAIN-REGISTRATION-TEMPLATE.md +0 -194
  199. package/dist/registry/templates/marketing/EVANGELIZE-TEMPLATE.md +0 -102
  200. package/dist/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +0 -66
  201. package/dist/registry/templates/marketing/STORYTELLING-TEMPLATE.md +0 -130
  202. package/dist/registry/templates/marketing/WEBSITE-TEMPLATE.md +0 -262
  203. package/dist/registry/templates/marketing/github-pages-workflow.yml +0 -64
  204. package/dist/registry/templates/replicate/implementation-checklist.md +0 -39
  205. package/dist/registry/templates/replicate/use-cases-template.md +0 -88
  206. package/dist/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +0 -55
  207. package/dist/registry/templates/specs/BUGSPEC-TEMPLATE.md +0 -37
  208. package/dist/registry/templates/specs/FEATURESPEC-TEMPLATE.md +0 -66
  209. package/dist/registry/templates/specs/TECHSPEC-TEMPLATE.md +0 -39
  210. package/dist/registry/workflows/azure/cost-optimization.md +0 -772
  211. package/dist/registry/workflows/bootstrap/create-architecture.md +0 -37
  212. package/dist/registry/workflows/bootstrap/detect-broken-windows.md +0 -300
  213. package/dist/registry/workflows/bootstrap/evaluate-code-quality.md +0 -35
  214. package/dist/registry/workflows/bootstrap/verify-test-coverage.md +0 -36
  215. package/dist/registry/workflows/brainstorming/blue-sky-brainstorming.md +0 -211
  216. package/dist/registry/workflows/brainstorming/codebase-brainstorming.md +0 -159
  217. package/dist/registry/workflows/business-development/create-business-plan.md +0 -737
  218. package/dist/registry/workflows/business-development/ideate-business-opportunity.md +0 -55
  219. package/dist/registry/workflows/business-development/price-product.md +0 -325
  220. package/dist/registry/workflows/compliance/detect-compliance-requirements.md +0 -80
  221. package/dist/registry/workflows/compliance/generate-audit-evidence.md +0 -80
  222. package/dist/registry/workflows/compliance/soc2-evidence-generator.md +0 -332
  223. package/dist/registry/workflows/customer-development/insight-analysis.md +0 -156
  224. package/dist/registry/workflows/customer-development/insight-triage.md +0 -933
  225. package/dist/registry/workflows/customer-development/interview-preparation.md +0 -452
  226. package/dist/registry/workflows/customer-development/linkedin-outreach.md +0 -599
  227. package/dist/registry/workflows/customer-development/strategic-brainstorming.md +0 -146
  228. package/dist/registry/workflows/customer-development/thank-customers.md +0 -203
  229. package/dist/registry/workflows/customer-development/user-survey-dispatch.md +0 -312
  230. package/dist/registry/workflows/customer-development/users-to-target.md +0 -427
  231. package/dist/registry/workflows/customer-development/weekly-newsletter.md +0 -366
  232. package/dist/registry/workflows/deploy/cloud-deployment.md +0 -310
  233. package/dist/registry/workflows/improve-fraim/contribute.md +0 -32
  234. package/dist/registry/workflows/improve-fraim/file-issue.md +0 -32
  235. package/dist/registry/workflows/learning/build-skillset.md +0 -212
  236. package/dist/registry/workflows/learning/synthesize-learnings.md +0 -369
  237. package/dist/registry/workflows/legal/contract-review-analysis.md +0 -382
  238. package/dist/registry/workflows/legal/nda.md +0 -69
  239. package/dist/registry/workflows/legal/patent-filing.md +0 -76
  240. package/dist/registry/workflows/legal/saas-contract-development.md +0 -204
  241. package/dist/registry/workflows/legal/trademark-filing.md +0 -77
  242. package/dist/registry/workflows/marketing/content-creation.md +0 -40
  243. package/dist/registry/workflows/marketing/convert-to-pdf.md +0 -265
  244. package/dist/registry/workflows/marketing/create-modern-website.md +0 -456
  245. package/dist/registry/workflows/marketing/domain-registration.md +0 -323
  246. package/dist/registry/workflows/marketing/evangelize.md +0 -426
  247. package/dist/registry/workflows/marketing/hbr-article.md +0 -73
  248. package/dist/registry/workflows/marketing/launch-checklist.md +0 -37
  249. package/dist/registry/workflows/marketing/marketing-strategy.md +0 -45
  250. package/dist/registry/workflows/marketing/storytelling.md +0 -65
  251. package/dist/registry/workflows/performance/analyze-performance.md +0 -65
  252. package/dist/registry/workflows/product-building/design.md +0 -263
  253. package/dist/registry/workflows/product-building/implement.md +0 -771
  254. package/dist/registry/workflows/product-building/iterate-on-pr-comments.md +0 -70
  255. package/dist/registry/workflows/product-building/prep-issue.md +0 -41
  256. package/dist/registry/workflows/product-building/prototype.md +0 -60
  257. package/dist/registry/workflows/product-building/resolve.md +0 -175
  258. package/dist/registry/workflows/product-building/retrospect.md +0 -86
  259. package/dist/registry/workflows/product-building/spec.md +0 -303
  260. package/dist/registry/workflows/product-building/test.md +0 -125
  261. package/dist/registry/workflows/productivity-report/productivity-report.md +0 -263
  262. package/dist/registry/workflows/quality-assurance/browser-validation.md +0 -221
  263. package/dist/registry/workflows/quality-assurance/iterative-improvement-cycle.md +0 -562
  264. package/dist/registry/workflows/replicate/replicate-discovery.md +0 -336
  265. package/dist/registry/workflows/replicate/replicate-to-issues.md +0 -319
  266. package/dist/registry/workflows/reviewer/review-implementation-vs-design-spec.md +0 -694
  267. package/dist/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -734
  268. package/dist/registry/workflows/startup-credits/aws-activate-application.md +0 -535
  269. package/dist/registry/workflows/startup-credits/google-cloud-application.md +0 -647
  270. package/dist/registry/workflows/startup-credits/microsoft-azure-application.md +0 -538
  271. package/dist/src/cli/commands/init.js +0 -148
  272. package/dist/src/cli/commands/mcp.js +0 -65
  273. package/dist/src/cli/commands/wizard.js +0 -35
  274. package/dist/src/fraim/issue-tracking/ado-provider.js +0 -304
  275. package/dist/src/fraim/issue-tracking/factory.js +0 -63
  276. package/dist/src/fraim/issue-tracking/github-provider.js +0 -200
  277. package/dist/src/fraim/issue-tracking/types.js +0 -7
  278. package/dist/src/fraim/issue-tracking-config.js +0 -83
  279. package/dist/src/fraim/retrospective-learner.js +0 -301
  280. package/dist/src/fraim/setup-wizard.js +0 -99
@@ -1,262 +0,0 @@
1
- # Website Creation Brief: {PROJECT_NAME}
2
-
3
- **Project:** {PROJECT_NAME}
4
- **Date:** {DATE}
5
- **Stakeholders:** {STAKEHOLDERS}
6
- **Timeline:** {TIMELINE}
7
-
8
- ---
9
-
10
- ## Project Overview
11
-
12
- ### Product/Service Description
13
- {PRODUCT_DESCRIPTION}
14
-
15
- ### Target Audience
16
- {TARGET_AUDIENCE}
17
-
18
- ### Primary Goals
19
- - [ ] Lead generation
20
- - [ ] Product showcase
21
- - [ ] Brand awareness
22
- - [ ] User education
23
- - [ ] Customer support
24
- - [ ] Other: {OTHER_GOALS}
25
-
26
- ---
27
-
28
- ## User Preferences & Inspiration
29
-
30
- ### Favorite Websites
31
- 1. **{WEBSITE_1}** - {URL_1}
32
- - What you like: {WHAT_YOU_LIKE_1}
33
- - Specific elements: {SPECIFIC_ELEMENTS_1}
34
-
35
- 2. **{WEBSITE_2}** - {URL_2}
36
- - What you like: {WHAT_YOU_LIKE_2}
37
- - Specific elements: {SPECIFIC_ELEMENTS_2}
38
-
39
- 3. **{WEBSITE_3}** - {URL_3}
40
- - What you like: {WHAT_YOU_LIKE_3}
41
- - Specific elements: {SPECIFIC_ELEMENTS_3}
42
-
43
- ### Design Preferences
44
- - **Tone/Personality:** {TONE} (Professional, Playful, Technical, Friendly, etc.)
45
- - **Color Preferences:** {COLOR_PREFERENCES}
46
- - **Typography Style:** {TYPOGRAPHY_STYLE} (Modern, Classic, Technical, etc.)
47
- - **Layout Style:** {LAYOUT_STYLE} (Minimal, Rich, Grid-based, etc.)
48
-
49
- ### Required Features
50
- - [ ] Dark/Light mode toggle
51
- - [ ] Mobile responsive design
52
- - [ ] Contact forms
53
- - [ ] Newsletter signup
54
- - [ ] Interactive demos
55
- - [ ] Customer testimonials
56
- - [ ] Pricing tables
57
- - [ ] Blog/News section
58
- - [ ] Search functionality
59
- - [ ] Multi-language support
60
- - [ ] Other: {OTHER_FEATURES}
61
-
62
- ---
63
-
64
- ## Content Strategy
65
-
66
- ### Key Value Propositions
67
- 1. {VALUE_PROP_1}
68
- 2. {VALUE_PROP_2}
69
- 3. {VALUE_PROP_3}
70
-
71
- ### Primary Use Cases
72
- 1. **{USE_CASE_1}**
73
- - Description: {USE_CASE_1_DESC}
74
- - Target user: {USE_CASE_1_USER}
75
- - Benefit: {USE_CASE_1_BENEFIT}
76
-
77
- 2. **{USE_CASE_2}**
78
- - Description: {USE_CASE_2_DESC}
79
- - Target user: {USE_CASE_2_USER}
80
- - Benefit: {USE_CASE_2_BENEFIT}
81
-
82
- 3. **{USE_CASE_3}**
83
- - Description: {USE_CASE_3_DESC}
84
- - Target user: {USE_CASE_3_USER}
85
- - Benefit: {USE_CASE_3_BENEFIT}
86
-
87
- ### Content Inventory
88
- - [ ] Product descriptions
89
- - [ ] Feature explanations
90
- - [ ] Customer testimonials
91
- - [ ] Case studies
92
- - [ ] Team bios
93
- - [ ] Company story
94
- - [ ] Technical documentation
95
- - [ ] Pricing information
96
- - [ ] Contact information
97
- - [ ] Legal pages (Privacy, Terms)
98
-
99
- ---
100
-
101
- ## Competitive Analysis
102
-
103
- ### Direct Competitors
104
- 1. **{COMPETITOR_1}** - {COMPETITOR_1_URL}
105
- - Strengths: {COMPETITOR_1_STRENGTHS}
106
- - Weaknesses: {COMPETITOR_1_WEAKNESSES}
107
- - Key takeaways: {COMPETITOR_1_TAKEAWAYS}
108
-
109
- 2. **{COMPETITOR_2}** - {COMPETITOR_2_URL}
110
- - Strengths: {COMPETITOR_2_STRENGTHS}
111
- - Weaknesses: {COMPETITOR_2_WEAKNESSES}
112
- - Key takeaways: {COMPETITOR_2_TAKEAWAYS}
113
-
114
- 3. **{COMPETITOR_3}** - {COMPETITOR_3_URL}
115
- - Strengths: {COMPETITOR_3_STRENGTHS}
116
- - Weaknesses: {COMPETITOR_3_WEAKNESSES}
117
- - Key takeaways: {COMPETITOR_3_TAKEAWAYS}
118
-
119
- ### Differentiation Opportunities
120
- - {DIFFERENTIATION_1}
121
- - {DIFFERENTIATION_2}
122
- - {DIFFERENTIATION_3}
123
-
124
- ---
125
-
126
- ## Technical Requirements
127
-
128
- ### Performance Targets
129
- - Page load speed: < 3 seconds
130
- - Mobile performance score: > 90%
131
- - Accessibility score: > 90%
132
- - SEO score: > 85%
133
-
134
- ### Browser Support
135
- - [ ] Chrome (latest 2 versions)
136
- - [ ] Firefox (latest 2 versions)
137
- - [ ] Safari (latest 2 versions)
138
- - [ ] Edge (latest 2 versions)
139
- - [ ] Mobile browsers (iOS Safari, Chrome Mobile)
140
-
141
- ### Integrations Needed
142
- - [ ] Google Analytics
143
- - [ ] Email marketing platform: {EMAIL_PLATFORM}
144
- - [ ] CRM system: {CRM_SYSTEM}
145
- - [ ] Payment processing: {PAYMENT_SYSTEM}
146
- - [ ] Customer support: {SUPPORT_SYSTEM}
147
- - [ ] Social media platforms
148
- - [ ] Other: {OTHER_INTEGRATIONS}
149
-
150
- ---
151
-
152
- ## Hosting & Deployment
153
-
154
- ### Hosting Preferences
155
- - [ ] Free hosting (GitHub Pages, Netlify free tier)
156
- - [ ] Premium hosting (Netlify Pro, Vercel Pro)
157
- - [ ] Enterprise hosting (AWS, Google Cloud)
158
- - [ ] Existing hosting provider: {EXISTING_PROVIDER}
159
-
160
- ### Domain Information
161
- - **Domain name:** {DOMAIN_NAME}
162
- - **Domain registrar:** {DOMAIN_REGISTRAR}
163
- - **DNS provider:** {DNS_PROVIDER}
164
-
165
- ### Deployment Requirements
166
- - [ ] Automatic deployment on code changes
167
- - [ ] Staging environment for testing
168
- - [ ] Custom domain setup
169
- - [ ] SSL certificate configuration
170
- - [ ] CDN setup for performance
171
-
172
- ---
173
-
174
- ## Success Metrics
175
-
176
- ### Primary KPIs
177
- - {KPI_1}: Target {KPI_1_TARGET}
178
- - {KPI_2}: Target {KPI_2_TARGET}
179
- - {KPI_3}: Target {KPI_3_TARGET}
180
-
181
- ### Secondary Metrics
182
- - Time on site: Target {TIME_ON_SITE_TARGET}
183
- - Bounce rate: Target {BOUNCE_RATE_TARGET}
184
- - Page views per session: Target {PAGE_VIEWS_TARGET}
185
- - Conversion rate: Target {CONVERSION_RATE_TARGET}
186
-
187
- ---
188
-
189
- ## Timeline & Milestones
190
-
191
- ### Phase 1: Discovery & Research ({PHASE_1_TIMELINE})
192
- - [ ] User preference brainstorming session
193
- - [ ] Competitive analysis completion
194
- - [ ] Content strategy development
195
- - [ ] Design system creation
196
-
197
- ### Phase 2: Design & Development ({PHASE_2_TIMELINE})
198
- - [ ] Wireframes and mockups
199
- - [ ] Development environment setup
200
- - [ ] Core pages development
201
- - [ ] Content integration
202
-
203
- ### Phase 3: Testing & Optimization ({PHASE_3_TIMELINE})
204
- - [ ] Performance testing
205
- - [ ] Cross-browser testing
206
- - [ ] Accessibility validation
207
- - [ ] User experience testing
208
-
209
- ### Phase 4: Deployment & Launch ({PHASE_4_TIMELINE})
210
- - [ ] Hosting setup and configuration
211
- - [ ] Domain and SSL setup
212
- - [ ] Analytics and monitoring setup
213
- - [ ] Soft launch and testing
214
- - [ ] Public launch
215
-
216
- ---
217
-
218
- ## Budget & Resources
219
-
220
- ### Budget Range
221
- - Design & Development: {DESIGN_DEV_BUDGET}
222
- - Hosting & Domain: {HOSTING_BUDGET}
223
- - Third-party tools: {TOOLS_BUDGET}
224
- - Ongoing maintenance: {MAINTENANCE_BUDGET}
225
-
226
- ### Team & Responsibilities
227
- - **Project Manager:** {PROJECT_MANAGER}
228
- - **Designer:** {DESIGNER}
229
- - **Developer:** {DEVELOPER}
230
- - **Content Creator:** {CONTENT_CREATOR}
231
- - **Stakeholder/Approver:** {STAKEHOLDER}
232
-
233
- ---
234
-
235
- ## Additional Notes
236
-
237
- ### Special Requirements
238
- {SPECIAL_REQUIREMENTS}
239
-
240
- ### Constraints & Limitations
241
- {CONSTRAINTS}
242
-
243
- ### Future Enhancements
244
- {FUTURE_ENHANCEMENTS}
245
-
246
- ---
247
-
248
- ## Approval & Sign-off
249
-
250
- **Stakeholder Approval:**
251
- - [ ] Project scope approved
252
- - [ ] Timeline approved
253
- - [ ] Budget approved
254
- - [ ] Technical requirements approved
255
-
256
- **Approved by:** {APPROVER_NAME}
257
- **Date:** {APPROVAL_DATE}
258
- **Signature:** {SIGNATURE}
259
-
260
- ---
261
-
262
- *This document serves as the foundation for the website creation project. All stakeholders should review and approve before development begins.*
@@ -1,64 +0,0 @@
1
- # GitHub Pages deployment workflow for {PROJECT_NAME}
2
- name: Deploy {PROJECT_NAME} to GitHub Pages
3
-
4
- on:
5
- # Runs on pushes targeting the default branch
6
- push:
7
- branches: ["main", "master"]
8
- paths: ["{WEBSITE_FOLDER}/**"]
9
-
10
- # Allows you to run this workflow manually from the Actions tab
11
- workflow_dispatch:
12
-
13
- # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14
- permissions:
15
- contents: read
16
- pages: write
17
- id-token: write
18
-
19
- # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20
- # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21
- concurrency:
22
- group: "pages"
23
- cancel-in-progress: false
24
-
25
- jobs:
26
- # Build job
27
- build:
28
- runs-on: ubuntu-latest
29
- steps:
30
- - name: Checkout
31
- uses: actions/checkout@v4
32
-
33
- - name: Setup Pages
34
- uses: actions/configure-pages@v4
35
-
36
- # Optional: Add build steps here if needed
37
- # - name: Setup Node.js
38
- # uses: actions/setup-node@v4
39
- # with:
40
- # node-version: '18'
41
- #
42
- # - name: Install dependencies
43
- # run: npm ci
44
- #
45
- # - name: Build website
46
- # run: npm run build
47
-
48
- - name: Upload artifact
49
- uses: actions/upload-pages-artifact@v3
50
- with:
51
- # Upload the website directory
52
- path: './{WEBSITE_FOLDER}'
53
-
54
- # Deployment job
55
- deploy:
56
- environment:
57
- name: github-pages
58
- url: ${{ steps.deployment.outputs.page_url }}
59
- runs-on: ubuntu-latest
60
- needs: build
61
- steps:
62
- - name: Deploy to GitHub Pages
63
- id: deployment
64
- uses: actions/deploy-pages@v4
@@ -1,39 +0,0 @@
1
- # Implementation Checklist
2
-
3
- **Application**: [Application Name]
4
- **Date**: [Date]
5
-
6
- ## Feature Implementation Status
7
-
8
- ### Authentication & Account Management
9
-
10
- - [ ] **UC-001: User Registration**
11
- - [ ] Database model: User
12
- - [ ] API endpoint: POST /api/users/signup
13
- - [ ] Frontend: SignUpPage component
14
- - [ ] Integration: Connect frontend to API
15
- - [ ] Tests: Server, client, E2E
16
- - [ ] Validation: Test in browser
17
-
18
- - [ ] **UC-002: User Login**
19
- - [ ] API endpoint: POST /api/users/login
20
- - [ ] Frontend: LoginPage component
21
- - [ ] Auth context: Session management
22
- - [ ] Integration: Connect frontend to API
23
- - [ ] Tests: Server, client, E2E
24
- - [ ] Validation: Test in browser
25
-
26
- [Continue with more features...]
27
-
28
- ## Implementation Progress
29
-
30
- **Overall Progress**: [X]% Complete
31
-
32
- - **Not Started**: [Number] features
33
- - **In Progress**: [Number] features
34
- - **Complete**: [Number] features
35
- - **Blocked**: [Number] features
36
-
37
- ## Notes
38
-
39
- - [Add implementation notes, decisions, blockers, etc.]
@@ -1,88 +0,0 @@
1
- # Use Cases Documentation
2
-
3
- **Application**: [Application Name]
4
- **Date**: [Date]
5
- **Version**: [Version]
6
-
7
- ## Overview
8
-
9
- This document contains all identified use cases for the application, organized by category.
10
-
11
- ## Use Case Categories
12
-
13
- - [Authentication & Account Management](#authentication--account-management)
14
- - [Content Discovery & Browsing](#content-discovery--browsing)
15
- - [Content Creation & Management](#content-creation--management)
16
- - [Data Collection & Reporting](#data-collection--reporting)
17
- - [Administration & Configuration](#administration--configuration)
18
- - [Communication & Collaboration](#communication--collaboration)
19
-
20
- ---
21
-
22
- ## Authentication & Account Management
23
-
24
- ### UC-001: User Registration
25
-
26
- **Actor**: Guest User
27
- **Preconditions**: User is not logged in
28
- **Priority**: High
29
-
30
- **Steps**:
31
- 1. Navigate to sign up page
32
- 2. Fill in registration form (name, email, password)
33
- 3. Submit form
34
- 4. Receive confirmation message
35
- 5. Verify email (if required)
36
- 6. Redirect to login or dashboard
37
-
38
- **Postconditions**:
39
- - User account is created
40
- - User can log in
41
- - User profile is initialized
42
-
43
- **Screenshots**: `screenshots/signup_*.png`
44
-
45
- **Related Use Cases**: UC-002
46
-
47
- ---
48
-
49
- ### UC-002: User Login
50
-
51
- **Actor**: Registered User
52
- **Preconditions**: User has an account
53
- **Priority**: High
54
-
55
- **Steps**:
56
- 1. Navigate to login page
57
- 2. Enter email and password
58
- 3. Click "Login" button
59
- 4. System validates credentials
60
- 5. User is redirected to dashboard/home
61
-
62
- **Postconditions**:
63
- - User session is created
64
- - User is authenticated
65
- - User can access protected pages
66
-
67
- **Screenshots**: `screenshots/login_*.png`
68
-
69
- **Related Use Cases**: UC-001, UC-003
70
-
71
- ---
72
-
73
- [Continue with more use cases...]
74
-
75
- ## Use Case Index
76
-
77
- | ID | Name | Actor | Priority | Status |
78
- |----|------|-------|----------|--------|
79
- | UC-001 | User Registration | Guest | High | ✅ Complete |
80
- | UC-002 | User Login | User | High | ✅ Complete |
81
- | ... | ... | ... | ... | ... |
82
-
83
- ## Implementation Status
84
-
85
- - **Total Use Cases**: [Number]
86
- - **Implemented**: [Number]
87
- - **In Progress**: [Number]
88
- - **Not Started**: [Number]
@@ -1,55 +0,0 @@
1
- # Postmortem: {Issue Title} - Issue #{issue-number}
2
-
3
- **Date**: {current_date}
4
- **Duration**: {time_spent}
5
- **Objective**: {issue_description}
6
- **Outcome**: {success/failure/partial}
7
-
8
- ## Executive Summary
9
-
10
- {2-3 sentence summary of what happened and the outcome}
11
-
12
- ## Timeline of Events
13
-
14
- ### Phase 1: {Phase Name}
15
- - ✅/❌ **Action**: Description
16
- - ✅/❌ **Action**: Description
17
-
18
- ### Phase 2: {Phase Name}
19
- - ✅/❌ **Action**: Description
20
- - ✅/❌ **Action**: Description
21
-
22
- ## Root Cause Analysis
23
-
24
- ### 1. **Primary Cause**
25
- **Problem**: {main issue}
26
- **Impact**: {what this caused}
27
-
28
- ### 2. **Contributing Factors**
29
- **Problem**: {secondary issues}
30
- **Impact**: {what these caused}
31
-
32
- ## What Went Wrong
33
-
34
- 1. **Issue 1**: Description
35
- 2. **Issue 2**: Description
36
-
37
- ## What Went Right
38
-
39
- 1. **Success 1**: Description
40
- 2. **Success 2**: Description
41
-
42
- ## Lessons Learned
43
-
44
- 1. **Learning 1**: Description
45
- 2. **Learning 2**: Description
46
-
47
- ## Agent Rule Updates Made to avoid recurrence
48
-
49
- 1. **Rule 1**: Description
50
- 2. **Rule 2**: Description
51
-
52
- ## Enforcement Updates Made to avoid recurrence
53
-
54
- 1. **Improvement 1**: Description
55
- 2. **Improvement 2**: Description
@@ -1,37 +0,0 @@
1
- # Bug: <Title>
2
-
3
- Issue: #<issue>
4
- Owner: <agent>
5
-
6
- ## Customer
7
-
8
- ## Customer Problem being solved
9
-
10
- ## Repro Steps
11
- - Specific steps in the user workflow that reproduce the bug (eg start in dashboard, click on tab x, see list y, approve item z ....)
12
- - Confirm that you have reproduced the bug
13
-
14
- ## Root Cause
15
- - What root cause was identified after repro and code analysis
16
-
17
- ## Fix Details
18
- - UI, API, Service, DB changes: Which files will be modified and for what?
19
-
20
- ## Validation Plan
21
- - Table with following columns
22
- - User Scenario
23
- - Expected outcome
24
- - Validation method (UI validation, API validation, Database validation ...)
25
-
26
- ## Confidence Level
27
- - On a scale of 0 to 100, how confident are you that your fix will work?
28
-
29
- ## Test Matrix
30
- - Unit(as many as needed, mocking ok): what core functionality will be tested. What test suite will be added? Which existing test suites will be modified?
31
- - Integration(only mock external services): what tests will ensure the full stack integration does not regress. What test suite will be added? Which existing test suites will be modified?
32
- - E2E(1 at most, no mocking): If any changes are made to external integrations, what end to end tests will ensure external integrations work as expected.
33
-
34
- ## Future Prevention
35
- - What will prevent future introduction of similar bugs
36
- - What agent rules will you update to ensure similar bugs do not recur
37
- - What enforcement will you create to ensure similar bugs are caught before they are checked in
@@ -1,66 +0,0 @@
1
- # Feature: <Title>
2
-
3
- Issue: #<issue>
4
- Owner: <agent>
5
-
6
- ## Customer
7
-
8
- ## Customer's Desired Outcome
9
-
10
- ## Customer Problem being solved
11
-
12
- ## User Experience that will solve the problem
13
- - Specific steps in the user workflow (eg start in dashboard, click on tab x, see list y, approve item z ....)
14
- - UI mocks showing the desired experience. Put these in the `docs/feature specs/mocks` folder and link to them here.
15
-
16
- ## Compliance Requirements (if applicable)
17
- *Include this section if your feature involves anything that would need compliance review*
18
-
19
- Based on your project's `.fraim/config.json` compliance settings, ensure you list clear requirements that must be met to meet compliance standards.
20
-
21
- ## Validation Plan
22
- - How will you know the feature is working as intended (validate via browser, api, ...)
23
- - What steps will you follow to ensure the feature works
24
- - **Compliance Validation**: How will compliance requirements be tested and verified
25
-
26
- ## Alternatives
27
- - Table with following columns
28
- - Alternative: What other way could the customer solve their problem?
29
- - Why discard?: Why is this alternative not chosen?
30
-
31
- ## Competitive Analysis
32
-
33
- ### Configured Competitors Analysis
34
- *Analysis of competitors from .fraim/config.json*
35
-
36
- | Competitor | Current Solution | Strengths | Weaknesses | Customer Feedback | Market Position |
37
- |------------|------------------|-----------|------------|-------------------|-----------------|
38
- | [Name] | [How they solve this] | [Key strengths] | [Key weaknesses] | [What customers say] | [Market share/position] |
39
-
40
- ### Additional Competitors Analysis
41
- *Analysis of other relevant competitors discovered during research*
42
-
43
- | Competitor | Current Solution | Strengths | Weaknesses | Customer Feedback | Market Position |
44
- |------------|------------------|-----------|------------|-------------------|-----------------|
45
- | [Name] | [How they solve this] | [Key strengths] | [Key weaknesses] | [What customers say] | [Market share/position] |
46
-
47
- ### Competitive Positioning Strategy
48
-
49
- #### Our Differentiation
50
- - **Key Advantage 1**: [How we're different/better]
51
- - **Key Advantage 2**: [How we're different/better]
52
- - **Key Advantage 3**: [How we're different/better]
53
-
54
- #### Competitive Response Strategy
55
- - **If Competitor A does X**: [Our response strategy]
56
- - **If Competitor B does Y**: [Our response strategy]
57
-
58
- #### Market Positioning
59
- - **Target Segment**: [Who we're targeting vs competitors]
60
- - **Value Proposition**: [Our unique value vs competitors]
61
- - **Pricing Strategy**: [How we position on price vs competitors]
62
-
63
- ### Research Sources
64
- - [List of sources used for competitive research]
65
- - [Date of research]
66
- - [Research methodology]
@@ -1,39 +0,0 @@
1
- # Feature: <Title>
2
-
3
- Issue: #<issue>
4
- Owner: <agent>
5
-
6
- ## Customer
7
-
8
- ## Customer Problem being solved
9
-
10
- ## User Experience that will solve the problem
11
- - Specific steps in the user workflow
12
- - If UI feature: start on UI page a, click on tab x, see list y, approve item z, achieve outcome ....
13
- - If API feature: call API a with params x, y, z, receive result
14
- - If refactoring/rearchitecture: what is the simpler developer workflow
15
-
16
- ## Technical Details
17
- - UI changes: Which files will be modified and for what?
18
- - API surface (OpenAPI) changes
19
- - Data model / schema changes
20
- - Failure modes & timeouts
21
- - Telemetry & analytics
22
-
23
- ## Confidence Level
24
- - On a scale of 0 to 100, how confident are you that your solution will work?
25
-
26
- ## Validation Plan
27
- - Table with following columns
28
- - User Scenario
29
- - Expected outcome
30
- - Validation method (UI validation, API validation, Database validation ...)
31
-
32
- ## Test Matrix
33
- - Unit(as many as needed, mocking ok): what core functionality will be tested. What test suite will be added? Which existing test suites will be modified?
34
- - Integration(only mock external services): what tests will ensure the full stack integration does not regress. What test suite will be added? Which existing test suites will be modified?
35
- - E2E(1 at most, no mocking): If any changes are made to external integrations, what end to end tests will ensure external integrations work as expected.
36
-
37
- ## Risks & Mitigations
38
-
39
- ## Observability (logs, metrics, alerts)