fraim-framework 2.0.35 → 2.0.37

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 (159) hide show
  1. package/dist/registry/scripts/cleanup-branch.js +62 -33
  2. package/dist/registry/scripts/generate-engagement-emails.js +119 -44
  3. package/dist/registry/scripts/newsletter-helpers.js +208 -268
  4. package/dist/registry/scripts/profile-server.js +387 -0
  5. package/dist/scripts/build-stub-registry.js +108 -0
  6. package/dist/src/cli/commands/doctor.js +5 -5
  7. package/dist/src/cli/commands/sync.js +33 -19
  8. package/dist/tests/test-client-scripts-validation.js +133 -0
  9. package/dist/tests/test-package-size.js +88 -0
  10. package/dist/tests/test-script-location-independence.js +76 -28
  11. package/dist/tests/test-stub-registry.js +120 -0
  12. package/dist/tests/test-sync-stubs.js +143 -0
  13. package/package.json +7 -9
  14. package/registry/scripts/cleanup-branch.ts +341 -0
  15. package/registry/scripts/generate-engagement-emails.ts +830 -0
  16. package/registry/scripts/markdown-to-pdf.js +7 -3
  17. package/registry/scripts/newsletter-helpers.ts +777 -0
  18. package/registry/scripts/profile-server.ts +424 -0
  19. package/registry/scripts/run-thank-you-workflow.ts +122 -0
  20. package/registry/scripts/send-newsletter-simple.ts +102 -0
  21. package/registry/scripts/send-thank-you-emails.ts +57 -0
  22. package/registry/stubs/workflows/bootstrap/create-architecture.md +11 -0
  23. package/registry/stubs/workflows/bootstrap/detect-broken-windows.md +11 -0
  24. package/registry/stubs/workflows/bootstrap/evaluate-code-quality.md +11 -0
  25. package/registry/stubs/workflows/bootstrap/verify-test-coverage.md +11 -0
  26. package/registry/stubs/workflows/business-development/create-business-plan.md +11 -0
  27. package/registry/stubs/workflows/business-development/ideate-business-opportunity.md +11 -0
  28. package/registry/stubs/workflows/business-development/price-product.md +18 -0
  29. package/registry/stubs/workflows/convert-to-pdf.md +11 -0
  30. package/registry/stubs/workflows/customer-development/insight-analysis.md +11 -0
  31. package/registry/stubs/workflows/customer-development/insight-triage.md +11 -0
  32. package/registry/stubs/workflows/customer-development/interview-preparation.md +11 -0
  33. package/registry/stubs/workflows/customer-development/linkedin-outreach.md +11 -0
  34. package/registry/stubs/workflows/customer-development/strategic-brainstorming.md +11 -0
  35. package/registry/stubs/workflows/customer-development/thank-customers.md +11 -0
  36. package/registry/stubs/workflows/customer-development/weekly-newsletter.md +11 -0
  37. package/registry/stubs/workflows/deploy/cloud-deployment.md +11 -0
  38. package/registry/stubs/workflows/improve-fraim/contribute.md +11 -0
  39. package/registry/stubs/workflows/improve-fraim/file-issue.md +11 -0
  40. package/registry/stubs/workflows/marketing/content-creation.md +11 -0
  41. package/registry/stubs/workflows/marketing/hbr-article.md +11 -0
  42. package/registry/stubs/workflows/marketing/launch-checklist.md +11 -0
  43. package/registry/stubs/workflows/marketing/marketing-strategy.md +11 -0
  44. package/registry/stubs/workflows/marketing/storytelling.md +11 -0
  45. package/registry/stubs/workflows/performance/analyze-performance.md +11 -0
  46. package/registry/stubs/workflows/product-building/design.md +11 -0
  47. package/registry/stubs/workflows/product-building/implement.md +12 -0
  48. package/registry/stubs/workflows/product-building/iterate-on-pr-comments.md +11 -0
  49. package/registry/stubs/workflows/product-building/prep-issue.md +11 -0
  50. package/registry/stubs/workflows/product-building/prototype.md +11 -0
  51. package/registry/stubs/workflows/product-building/resolve.md +11 -0
  52. package/registry/stubs/workflows/product-building/retrospect.md +11 -0
  53. package/registry/stubs/workflows/product-building/spec.md +11 -0
  54. package/registry/stubs/workflows/product-building/test.md +11 -0
  55. package/registry/stubs/workflows/quality-assurance/browser-validation.md +11 -0
  56. package/registry/stubs/workflows/quality-assurance/iterative-improvement-cycle.md +11 -0
  57. package/registry/stubs/workflows/replicate/replicate-discovery.md +11 -0
  58. package/registry/stubs/workflows/replicate/replicate-to-issues.md +11 -0
  59. package/registry/stubs/workflows/reviewer/review-implementation-vs-design-spec.md +11 -0
  60. package/registry/stubs/workflows/reviewer/review-implementation-vs-feature-spec.md +11 -0
  61. package/registry/stubs/workflows/startup-credits/aws-activate-application.md +11 -0
  62. package/registry/stubs/workflows/startup-credits/google-cloud-application.md +11 -0
  63. package/registry/stubs/workflows/startup-credits/microsoft-azure-application.md +11 -0
  64. package/.github/workflows/ci.yml +0 -65
  65. package/.github/workflows/deploy-fraim.yml +0 -87
  66. package/.github/workflows/phase-change.yml +0 -251
  67. package/.github/workflows/status-change.yml +0 -68
  68. package/.github/workflows/sync-on-pr-review.yml +0 -66
  69. package/examples/simple-webapp/TESTING.md +0 -62
  70. package/examples/simple-webapp/example-test.ts +0 -186
  71. package/registry/github/workflows/ci.yml +0 -51
  72. package/registry/github/workflows/phase-change.yml +0 -251
  73. package/registry/github/workflows/status-change.yml +0 -68
  74. package/registry/github/workflows/sync-on-pr-review.yml +0 -66
  75. package/registry/mcp-template.jsonc +0 -29
  76. package/registry/rules/agent-success-criteria.md +0 -52
  77. package/registry/rules/agent-testing-guidelines.md +0 -502
  78. package/registry/rules/architecture.md +0 -52
  79. package/registry/rules/communication.md +0 -122
  80. package/registry/rules/continuous-learning.md +0 -55
  81. package/registry/rules/debugging-multitenancy-issues.md +0 -85
  82. package/registry/rules/ephemeral-execution.md +0 -57
  83. package/registry/rules/git-safe-commands.md +0 -34
  84. package/registry/rules/hitl-ppe-record-analysis.md +0 -302
  85. package/registry/rules/integrity-and-test-ethics.md +0 -275
  86. package/registry/rules/local-development.md +0 -254
  87. package/registry/rules/merge-requirements.md +0 -231
  88. package/registry/rules/simplicity.md +0 -118
  89. package/registry/rules/software-development-lifecycle.md +0 -105
  90. package/registry/rules/spike-first-development.md +0 -205
  91. package/registry/rules/successful-debugging-patterns.md +0 -491
  92. package/registry/rules/telemetry.md +0 -67
  93. package/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +0 -53
  94. package/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +0 -37
  95. package/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +0 -35
  96. package/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +0 -29
  97. package/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +0 -126
  98. package/registry/templates/customer-development/customer-interview-template.md +0 -99
  99. package/registry/templates/customer-development/follow-up-email-templates.md +0 -132
  100. package/registry/templates/customer-development/insight-analysis-template.md +0 -74
  101. package/registry/templates/customer-development/strategic-recommendations-template.md +0 -53
  102. package/registry/templates/customer-development/thank-you-email-template.html +0 -124
  103. package/registry/templates/customer-development/thank-you-note-template.md +0 -16
  104. package/registry/templates/customer-development/triage-log-template.md +0 -278
  105. package/registry/templates/customer-development/weekly-newsletter-template.html +0 -204
  106. package/registry/templates/evidence/Design-Evidence.md +0 -30
  107. package/registry/templates/evidence/Implementation-BugEvidence.md +0 -86
  108. package/registry/templates/evidence/Implementation-FeatureEvidence.md +0 -121
  109. package/registry/templates/evidence/Spec-Evidence.md +0 -19
  110. package/registry/templates/help/HelpNeeded.md +0 -14
  111. package/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +0 -66
  112. package/registry/templates/marketing/STORYTELLING-TEMPLATE.md +0 -130
  113. package/registry/templates/replicate/implementation-checklist.md +0 -39
  114. package/registry/templates/replicate/use-cases-template.md +0 -88
  115. package/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +0 -55
  116. package/registry/templates/specs/BUGSPEC-TEMPLATE.md +0 -37
  117. package/registry/templates/specs/FEATURESPEC-TEMPLATE.md +0 -29
  118. package/registry/templates/specs/TECHSPEC-TEMPLATE.md +0 -39
  119. package/registry/workflows/bootstrap/create-architecture.md +0 -38
  120. package/registry/workflows/bootstrap/evaluate-code-quality.md +0 -36
  121. package/registry/workflows/bootstrap/verify-test-coverage.md +0 -37
  122. package/registry/workflows/business-development/create-business-plan.md +0 -737
  123. package/registry/workflows/business-development/ideate-business-opportunity.md +0 -55
  124. package/registry/workflows/business-development/price-product.md +0 -325
  125. package/registry/workflows/convert-to-pdf.md +0 -235
  126. package/registry/workflows/customer-development/insight-analysis.md +0 -156
  127. package/registry/workflows/customer-development/insight-triage.md +0 -933
  128. package/registry/workflows/customer-development/interview-preparation.md +0 -421
  129. package/registry/workflows/customer-development/linkedin-outreach.md +0 -593
  130. package/registry/workflows/customer-development/strategic-brainstorming.md +0 -146
  131. package/registry/workflows/customer-development/thank-customers.md +0 -203
  132. package/registry/workflows/customer-development/weekly-newsletter.md +0 -366
  133. package/registry/workflows/deploy/cloud-deployment.md +0 -310
  134. package/registry/workflows/improve-fraim/contribute.md +0 -32
  135. package/registry/workflows/improve-fraim/file-issue.md +0 -32
  136. package/registry/workflows/marketing/content-creation.md +0 -37
  137. package/registry/workflows/marketing/hbr-article.md +0 -73
  138. package/registry/workflows/marketing/launch-checklist.md +0 -37
  139. package/registry/workflows/marketing/marketing-strategy.md +0 -45
  140. package/registry/workflows/marketing/storytelling.md +0 -65
  141. package/registry/workflows/performance/analyze-performance.md +0 -65
  142. package/registry/workflows/product-building/design.md +0 -130
  143. package/registry/workflows/product-building/implement.md +0 -315
  144. package/registry/workflows/product-building/iterate-on-pr-comments.md +0 -70
  145. package/registry/workflows/product-building/prep-issue.md +0 -43
  146. package/registry/workflows/product-building/prototype.md +0 -60
  147. package/registry/workflows/product-building/resolve.md +0 -164
  148. package/registry/workflows/product-building/retrospect.md +0 -86
  149. package/registry/workflows/product-building/spec.md +0 -117
  150. package/registry/workflows/product-building/test.md +0 -120
  151. package/registry/workflows/quality-assurance/browser-validation.md +0 -221
  152. package/registry/workflows/quality-assurance/iterative-improvement-cycle.md +0 -562
  153. package/registry/workflows/replicate/replicate-discovery.md +0 -336
  154. package/registry/workflows/replicate/replicate-to-issues.md +0 -319
  155. package/registry/workflows/reviewer/review-implementation-vs-design-spec.md +0 -632
  156. package/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -669
  157. package/registry/workflows/startup-credits/aws-activate-application.md +0 -535
  158. package/registry/workflows/startup-credits/google-cloud-application.md +0 -647
  159. package/registry/workflows/startup-credits/microsoft-azure-application.md +0 -538
@@ -1,32 +0,0 @@
1
- # Workflow: File Issue for FRAIM
2
-
3
- **Path:** `workflows/improve-fraim/file-issue.md`
4
-
5
- ---
6
-
7
- # File Issue Workflow
8
-
9
- ## INTENT
10
- Allows users to easily file bugs or feature requests for the FRAIM framework directly from their working environment.
11
-
12
- ## STEPS
13
-
14
- ### Step 1: Gather Information
15
- 1. Ask the user to describe the **Issue** (Bug or Feature Request).
16
- - Example: "Please describe the bug you encountered or the feature you would like to request."
17
-
18
- ### Step 2: Categorization (Optional)
19
- Ask if this is a **Bug** or a **Feature**.
20
- - If Bug: Use label `bug`.
21
- - If Feature: Use label `enhancement`.
22
- - Default: `triage`.
23
-
24
- ### Step 3: Execute Issue Filing
25
- Call the `file_issue` tool with the details gathered.
26
-
27
- - `title`: `"[ISSUE]: <Short Summary>"`
28
- - `body`: `"<Full Description>"`
29
- - `labels`: `["<bug/enhancement>"]`
30
-
31
- ### Step 4: Completion
32
- Notify the user that the issue has been filed successfully. Summarize the information (title and body) that was filed. Do not provide the issue number or URL.
@@ -1,37 +0,0 @@
1
- # Workflow: content-creation
2
-
3
- **Path:** `workflows/marketing/content-creation.md`
4
-
5
- ---
6
-
7
- # Content Creation Phase
8
-
9
- ## INTENT
10
- To produce high-quality marketing assets, including blog posts, social media content, and email campaigns, that effectively communicate the feature's value.
11
-
12
- ## PRINCIPLES
13
- - **Storytelling**: Use narratives to engage the audience.
14
- - **Visual Excellence**: Ensure all assets are visually appealing and on-brand.
15
- - **Consistency**: Maintain a consistent voice and style across all content.
16
- - **Action-Oriented**: Include clear calls to action in all materials.
17
-
18
- ## CONTENT CREATION WORKFLOW
19
-
20
- ### Step 1: Asset Identification
21
- - What assets are needed based on the strategy? (Blog post, Social thread, Email)
22
-
23
- ### Step 2: Drafting
24
- - Create drafts for each asset in `docs/marketing/content/{issue_number}/`
25
- - Follow the brand voice guidelines.
26
-
27
- ### Step 3: Visual Asset Prep
28
- - Identify core screenshots or diagrams needed.
29
- - Write descriptions for images.
30
-
31
- ### Step 4: Review
32
- - Ensure content is free of errors and aligns with the strategy.
33
-
34
- ## OUTPUT
35
- - Blog Post Draft
36
- - Social Media Thread Draft
37
- - Email Campaign Draft
@@ -1,73 +0,0 @@
1
- # Workflow: hbr-article
2
-
3
- **Path:** `workflows/marketing/hbr-article.md`
4
-
5
- ---
6
-
7
- # Harvard Business Review Article Phase
8
-
9
- ## INTENT
10
- Design a repeatable reviewable process for researching, drafting, and submitting an HBR or similar thought-leadership article that follows the Harvard Business Review author guidelines and documents each review before publication.
11
-
12
- ## PRINCIPLES
13
- - **Strategy First** – Explain why the piece matters to HBR readers and how it advances the product roadmap.
14
- - **Evidence-Led Storytelling** – Back every claim with customer insights, data, or experiments and include proper citations.
15
- - **Executive Clarity** – Keep the tone structured, concise, and professional while still being compelling.
16
- - **Review Discipline** – Require sign-offs during every milestone so the article progresses with confidence.
17
-
18
- ## HARVARD BUSINESS REVIEW GUIDELINES SUMMARY
19
- - **Audience & Outcome**: HBR serves ambitious senior leaders with rigorous, evidence-backed insights they can apply today.
20
- - **Topic Scope**: Strategy, leadership, culture, operations, technology change, innovation, communication, decision-making, talent, and transitions.
21
- - **Five Quality Criteria**: Expertise, evidence, originality (or a counterintuitive twist), practical usefulness, and excellent writing.
22
- - **Responsible Storytelling**: Represent diverse organizations, avoid bias/stereotypes, disclose conflicts, and explain any generative AI usage.
23
- - **Pitch Checklist** (covered during Step 2 and in the template): central message, importance/counterintuition, novelty, leader application, authority/backing, supporting research/examples, and relevant experiences.
24
-
25
- ## HBR ARTICLE WORKFLOW
26
-
27
- ### Step 1: Confirm the story belongs with HBR
28
- - Articulate the insight, the proposed HBR section (Strategy, Leadership, Technology, etc.), and why the timing is right.
29
- - Cite the HBR guidelines (https://hbr.org/guidelines-for-authors) for exclusivity, word count, bylines, and conflict-of-interest disclosures.
30
- - Document how the story ties to the product roadmap, clarify the customer problem, and capture any embargo or exclusivity constraints with marketing and executive reviewers.
31
-
32
- ### Step 2: Research & angle sharpening
33
- - Gather customer data, experiments, interviews, or telemetry that demonstrate the thesis.
34
- - Review two recent HBR pieces in the target section to understand structure, tone, and citation style.
35
- - Identify outstanding sourcing needs (people, metrics, visuals) and schedule them before drafting.
36
- - Use the HBR prompts to refine the story:
37
- - What is the central message of the article?
38
- - Why is it important, useful, or counterintuitive?
39
- - What is new about the idea?
40
- - Why do senior leaders need to know about it today, and how can they apply it?
41
- - What is the source of the team’s authority (prior work, credentials, experience)?
42
- - What research or examples will back the idea?
43
- - What academic, professional, or personal experience will you draw on?
44
-
45
- ### Step 3: Outline and structure guardrails
46
- - Draft an outline covering:
47
- - Hook and problem framing
48
- - Diagnostic/evidence blocks (data, quotes, frameworks)
49
- - Practice-ready recommendation and product-specific next steps
50
- - Annotate each section with required references and attachments.
51
- - Share the outline with product and marketing reviewers, collect feedback, and incorporate it prior to drafting.
52
-
53
- ### Step 4: Draft, iterate, and polish
54
- - Adhere to HBR word limits and formatting expectations; note disclosures, partnerships, or competing interests directly in the draft.
55
- - Run two review passes: one focused on clarity (peer reviewer) and one on strategic voice (executive reviewer).
56
- - Track edits through versioned drafts, doc comments, or PR history and finalize the headline/angle with the marketing lead.
57
- - Capture approvals for accuracy, voice, and compliance before locking the draft.
58
-
59
- ### Step 5: Finalize submission + collateral
60
- - Verify the draft satisfies the HBR checklist (tone, length, references, conflicts) and secure the final sign-off.
61
- - Draft the submission email (subject line, synopsis, attachments) and log it in `docs/marketing/hbr/submission-log.md` or an equivalent tracking document.
62
- - Plan accompanying collateral (blog post, newsletter snippet, executive update) that repurposes the article's insight and assign owners.
63
- - Note follow-up steps for publication tracking and audience engagement.
64
-
65
- ## OUTPUT
66
- - Thesis/angle memo that explains the fit for HBR.
67
- - Approved outline and draft with reviewer notes and version history.
68
- - Submission package (email, attachments, compliance checklist).
69
- - Launch collateral plan with asset owners and delivery status.
70
-
71
- ## DOCUMENT TEMPLATE STRUCTURE
72
-
73
- Use `get_fraim_file({ path: "templates/marketing/HBR-ARTICLE-TEMPLATE.md" })` to capture the thesis, outline, draft, review log, submission log, and launch collateral plan for each HBR article.
@@ -1,37 +0,0 @@
1
- # Workflow: launch-checklist
2
-
3
- **Path:** `workflows/marketing/launch-checklist.md`
4
-
5
- ---
6
-
7
- # Launch Checklist Phase
8
-
9
- ## INTENT
10
- To ensure a smooth and successful feature launch by systematically verifying all marketing, technical, and operational readiness.
11
-
12
- ## PRINCIPLES
13
- - **Meticulous Preparation**: Leave no stone unturned before launch.
14
- - **Cross-Functional Alignment**: Ensure all teams are ready for the launch.
15
- - **Timely Execution**: Follow the schedule for maximum impact.
16
- - **Post-Launch Verification**: Monitor performance and address issues immediately.
17
-
18
- ## LAUNCH CHECKLIST WORKFLOW
19
-
20
- ### Step 1: Readiness Check
21
- - Is the feature deployed and verified?
22
- - Are the marketing assets ready?
23
- - Is the support team briefed?
24
-
25
- ### Step 2: Launch Execution
26
- - Post to social channels.
27
- - Send announcement emails.
28
- - Update documentation.
29
-
30
- ### Step 3: Post-Launch Monitoring
31
- - Check for user feedback.
32
- - Monitor error rates.
33
- - Engagement metrics.
34
-
35
- ## OUTPUT
36
- - Launch Status Report
37
- - Post-Launch Feedback Summary
@@ -1,45 +0,0 @@
1
- # Workflow: marketing-strategy
2
-
3
- **Path:** `workflows/marketing/marketing-strategy.md`
4
-
5
- ---
6
-
7
- # Marketing Strategy Phase
8
-
9
- ## INTENT
10
- To define the value proposition, target audience, and launch strategy for new features, ensuring clear communication of benefits and effective market entry.
11
-
12
- ## PRINCIPLES
13
- - **Value-First**: Focus on the problem solved and the value delivered.
14
- - **Audience-Centric**: Identify exactly who the feature is for.
15
- - **Clear Messaging**: Ensure simplicity and clarity in all marketing materials.
16
- - **Channel Alignment**: Choose appropriate channels for the target audience.
17
-
18
- ## MARKETING STRATEGY WORKFLOW
19
-
20
- ### Step 1: Feature Analysis
21
- - What is the core problem being solved?
22
- - What are the key benefits?
23
- - Who is the primary persona?
24
-
25
- ### Step 2: Value Proposition Definition
26
- - Draft 1-2 sentences describing the feature's value.
27
- - Identify the "Hero" benefit.
28
-
29
- ### Step 3: Target Audience Identification
30
- - Define the specific segment of users this is for.
31
- - Identify there pain points.
32
-
33
- ### Step 4: Channel Strategy
34
- - Where will we announce this? (Twitter, LinkedIn, Email, In-app)
35
- - What is the tone for each channel?
36
-
37
- ### Step 5: Marketing Brief Creation
38
- - Create a `docs/marketing/strategy/{issue_number}-{feature-name}.md`
39
- - Use `MARKETING-STRATEGY-TEMPLATE.md`
40
-
41
- ## OUTPUT
42
- - Marketing Strategy Doc
43
- - Value Prop
44
- - Target Audience
45
- - Launch Checklist status
@@ -1,65 +0,0 @@
1
- # Workflow: storytelling
2
-
3
- **Path:** `workflows/marketing/storytelling.md`
4
-
5
- ---
6
-
7
- # Marketing Storytelling Workflow
8
-
9
- ## INTENT
10
- To transform product development experiences into compelling founder narratives for events, conferences, and speaking opportunities that connect technical reality with broadly applicable lessons.
11
-
12
- ## PRINCIPLES
13
- - **Grounded in Reality**: All narratives based on actual product development experiences
14
- - **Story Arc Focus**: Follow intent → friction → insight → outcome structure
15
- - **Audience-Specific**: Tailor messaging to event type and audience expectations
16
- - **Authentic Voice**: Avoid sales pitch tone, focus on genuine founder lessons
17
-
18
- ## STORYTELLING WORKFLOW
19
-
20
- ### Step 1: Artifact Collection
21
- Gather source materials that tell the product development story:
22
- - Product documentation (specs, architecture notes, design docs)
23
- - Development retrospectives or post-mortems
24
- - Code repositories and key commits
25
- - Prior pitches, emails, or presentations
26
-
27
- ### Step 2: Story Arc Extraction
28
- Extract the core narrative following the story structure:
29
- - **Intent**: What was the original vision and why it mattered?
30
- - **Friction**: What unexpected challenges or failures occurred?
31
- - **Insight**: What key learnings or "aha moments" emerged?
32
- - **Outcome**: What was built and why it works?
33
-
34
- ### Step 3: Founder Lessons Development
35
- Transform technical experience into broadly applicable lessons:
36
- - Identify 3-5 key takeaways that apply to other founders
37
- - Remove internal jargon and technical complexity
38
- - Focus on decision-making processes and trade-offs
39
- - Highlight counterintuitive or surprising discoveries
40
-
41
- ### Step 4: Event-Specific Adaptation
42
- Customize content for target event and audience:
43
- - Research event format (conference, panel, workshop, podcast)
44
- - Adapt language for audience (technical, business, mixed)
45
- - Create appropriate time formats (5min, 15min, 30min, 45min)
46
- - Develop supporting materials and Q&A preparation
47
-
48
- ### Step 5: Content Package Creation
49
- Generate complete materials for event submission:
50
- - Email pitch with compelling subject line
51
- - Session title with clear hook
52
- - 1-2 sentence session description
53
- - Speaker bio highlighting relevant experience
54
- - Presentation outline and talking points
55
-
56
- ## TEMPLATE USAGE
57
-
58
- Use `get_fraim_file({ path: "templates/marketing/STORYTELLING-TEMPLATE.md" })` to create:
59
- - `docs/marketing/storytelling/{issue_number}-{event-name}.md`
60
-
61
- ## OUTPUT
62
- - Compelling founder narrative grounded in product reality
63
- - Event-ready submission materials
64
- - Multi-format presentation content
65
- - Reusable story framework for future opportunities
@@ -1,65 +0,0 @@
1
- # Performance Analysis Phase
2
-
3
- ## INTENT
4
- To diagnose production performance issues (CPU, Memory, Swap) and provide actionable recommendations for stabilization without performing direct application or infrastructure modifications.
5
-
6
- ## PRINCIPLES
7
- - **Observational Only**: Do not modify code or infrastructure during this phase.
8
- - **Data-Driven**: Base all recommendations on metrics collected from the environment.
9
- - **Non-Invasive**: Use non-destructive commands that do not impact server stability.
10
- - **Actionable**: Provide clear, prioritized recommendations for remediation.
11
-
12
- ## ANALYSIS WORKFLOW
13
-
14
- ### Step 1: Run the Performance Profiler
15
- Execute the profiling script against the production environment to collect plan-level and process-level metrics.
16
-
17
- **Note**: `profile-server.ts` has FRAIM dependencies and requires ephemeral execution.
18
-
19
- ```bash
20
- # Get the profile-server script ephemerally (has FRAIM dependencies)
21
- # Use get_fraim_file({ path: "scripts/performance/profile-server.ts" }) and save to tmp/profile-server.ts
22
- npx tsx tmp/profile-server.ts --prod
23
- ```
24
-
25
- ### Step 2: Inspect Automated Diagnosis
26
- Review the "Step 4: Automated Diagnosis" section of the output.
27
- It will specifically check for:
28
- - **Swap Death**: If >95% swap is used, the server is thrashing.
29
- - **Absent Application**: If `server.js` is missing, the infrastructure is healthy but the app is crashed/not starting.
30
- - **Infrastructure Hogs**: If Azure agents (Kudu/dotnet) are consuming excessive RAM.
31
-
32
- ### Step 3: Deep Dive Log Analysis
33
- If a crash loop or high operation frequency is suspected, collect and analyze application logs using the same script with the `--logs` flag.
34
-
35
- ```bash
36
- # Use the same ephemeral script with logs flag
37
- npx tsx tmp/profile-server.ts --prod --logs
38
- ```
39
- Look for:
40
- - Frequency of initialization logs (e.g., "Ensured unique index").
41
- - Patterns indicative of OOM events or unhandled exceptions.
42
- - High volume of specific operations (e.g., decryptions) suggesting an infinite loop.
43
-
44
- ### Step 4: Formulate Recommendations
45
- Based on the diagnosis, provide specific recommendations in your response or an implementation plan (if a fix is needed in a subsequent phase).
46
- Examples:
47
- - **Restart**: If swap usage is high or rogue processes are detected.
48
- - **Upgrade Plan**: If physical memory is chronically saturated (B1 to P1v3).
49
- - **Code Optimization**: If log analysis reveals initialization loops or leaks.
50
-
51
- ## EXAMPLES
52
-
53
- ### Good Analysis
54
- > "The profiler shows 98% CPU usage and 'Swap Death'. The logs show 'Ensured unique index' occurring 100 times per minute. I recommend implementing an initialization guard in `PrismaDatabaseService` to break this loop."
55
-
56
- ### Bad Analysis (Do not do)
57
- > "I found a loop, so I've updated `server.ts` to fix it."
58
- > *Correction: Propose the fix first, do not implement it within the analysis workflow.*
59
-
60
- ## COMPLETION CHECKLIST
61
- - [ ] Profiler run successfully on production.
62
- - [ ] Resource bottlenecks (CPU/Mem/Swap) identified.
63
- - [ ] Application process stability verified.
64
- - [ ] Root cause hypothesis formulated based on metrics and logs.
65
- - [ ] Prioritized recommendations delivered to the user.
@@ -1,130 +0,0 @@
1
- # Workflow: design
2
-
3
- **Path:** `workflows/design.md`
4
-
5
- ---
6
-
7
- # Design Phase
8
-
9
- ## INTENT
10
- To create comprehensive, detailed technical design documents that plan solutions before implementation, ensuring proper architecture, clear requirements, and stakeholder alignment through structured RFCs and bug fix templates.
11
-
12
- ## PRINCIPLES
13
- - **Success Criteria**: Optimize for Integrity, Correctness, Completeness, Independence, and Speed - see `rules/agent-success-criteria.md` (fetch via `get_fraim_file`).
14
- - **Design First**: Plan before implementing to avoid rework
15
- - **Template Consistency**: Use established templates for different types of changes
16
- - **Stakeholder Alignment**: Get review and approval before implementation
17
- - **Clear Documentation**: Create detailed, actionable design documents
18
- - **Iterative Refinement**: Incorporate feedback and iterate on designs
19
- - **Spike-First Development**: Follow "Spike-First Development" rule (read `rules/spike-first-development.md` using `get_fraim_file`) to validate technology compatibility before building complex solutions
20
- - **Simplicity**: Follow "Simplicity" principle (read `rules/simplicity.md` using `get_fraim_file`)
21
- - **Architecture**: Follow existing architecture - see `.fraim/config.json` for the path (`customizations.architectureDoc`)
22
-
23
- ## DESIGN WORKFLOW
24
-
25
- ### Step 1: Issue Identification
26
- Ask for {issue_number} (and optional {slug})
27
- ### Step 2: Phase Initiation
28
- Label the issue 'phase:design' (GitHub Action will automatically create a draft PR if none exists, or update the existing PR with phase-specific details, and label the issue `status:wip`)
29
-
30
- ### Step 3: Environment Setup
31
- **IMPORTANT**: The user has already run `prep-issue.sh` which has:
32
- - ✅ Created the feature branch
33
- - ✅ Checked out the branch
34
- - ✅ Pushed the empty branch to origin
35
- - ✅ Indexed the codebase with Serena
36
- - ✅ Opened the editor in the prepared workspace
37
-
38
- You can start working immediately in the prepared environment. No need to create branches or wait for GitHub Actions.
39
-
40
- ### Step 4: Work Location
41
- You are already in the correct workspace prepared by the user. Confirm you're on the right branch and start working.
42
-
43
- ### Step 5: Pre-Creation Validation
44
- Before creating any design document, agents MUST:
45
-
46
- 1. **Spike-First Development Check**:
47
- - Read and follow "Spike-First Development" rule (retrieve via `get_fraim_file({ path: "rules/spike-first-development.md" })`)
48
- - If design involves unfamiliar technology, plan spike/proof-of-concept first
49
- - Validate technology compatibility before designing complex solutions
50
- - Avoid "Build First, Integrate Later" anti-pattern
51
-
52
- 2. **Verify Template Selection**:
53
- - For bug fixes: Use Bug Spec template (retrieve via `get_fraim_file({ path: "templates/specs/BUGSPEC-TEMPLATE.md" })`)
54
- - For new features: Use Tech Spec template (retrieve via `get_fraim_file({ path: "templates/specs/TECHSPEC-TEMPLATE.md" })`)
55
- - Confirm template exists before proceeding
56
- - If you cannot find the template, stop and ask for help as per "Communication" rule (retrieve via `get_fraim_file({ path: "rules/communication.md" })`)
57
-
58
- 3. **Validate Naming Convention**:
59
- - Format: `docs/rfcs/{issue_number}-{kebab-title}.md`
60
- - Example: `docs/rfcs/228-improve-token-refresh.md`
61
- - NO other naming patterns allowed
62
-
63
- 4. **Template Compliance Check**:
64
- - Read the selected template first
65
- - Ensure all required sections are included
66
- - Verify placeholder format matches template
67
-
68
- 5. **Workflow Rule Verification**:
69
- - Confirm issue is labeled `phase:design`
70
- - Verify branch exists before starting work
71
- - Check working directory is correct
72
-
73
- ### Step 6: Design Document Creation
74
- Your work entails the following:
75
- - Create docs/rfcs/{issue_number}-{slug}.md.
76
- - Use the correct template as per #1
77
- - Check if there is an existing spec for this issue. Specs are stored in `docs/feature specs/` and share the same naming convention as the RFCs. If there is an existing spec, read through it and understand if fully.
78
- - Understand the issue, the existing codebase, and be detailed in your technical design. The better your initial design, manual valiation, testing plan, the smoother the implementation will go.
79
-
80
-
81
- ### Step 7: Design Creation Checklist
82
- Before commiting your work, verify:
83
- - [ ] Correct template used (BUGFIX-TEMPLATE.md or RFC-TEMPLATE.md)
84
- - [ ] Proper file naming: `{issue_number}-{kebab-title}.md`
85
- - [ ] All template sections completed
86
- - [ ] No placeholder text remaining
87
- - [ ] Issue labeled `phase:design`
88
- - [ ] Working in correct branch
89
- - [ ] File saved in `docs/rfcs/` directory
90
- - [ ] If issue is a bug, you have reproduced it
91
- - [ ] You understand the codebase and have high confidence in your design
92
-
93
- ### Step 8: Submit for Review
94
- - Commit and sync your work
95
- - Label the issue 'status:needs-review' and remove 'status:wip'
96
- - Update the PR with a comment to include evidence - Use Design Evidence template (retrieve via `get_fraim_file({ path: "templates/evidence/Design-Evidence.md" })`)
97
- - **Next Step**: Switch to "Iterate on PR Comments" workflow (retrieve via `get_fraim_file({ path: "workflows/product-building/iterate-on-pr-comments.md" })`) to monitor actions and handle feedback.
98
-
99
- ### Step 9: Iteration
100
- If workflow actions or reviewer feedback indicates more work is needed:
101
- - Label the issue 'status:wip' and remove 'status:needs-review'
102
- - Go back to Step 6 and iterate until PR is approved
103
-
104
- ## EXAMPLES
105
-
106
- ### Good: Comprehensive Design Process
107
- ```
108
- Issue #84: "Fix calendar sync timeout"
109
- 1. ✅ Identified: Issue #84, slug: "fix-sync-timeout"
110
- 2. ✅ Phase: Set phase:design, PR created
111
- 3. ✅ Environment: User ran prep-issue.sh, ready to work
112
- 4. ✅ Location: Working in prepared workspace with Serena indexing
113
- 5. ✅ Design: Created docs/rfcs/84-fix-sync-timeout.md
114
- 6. ✅ Template: Used BUG-TEMPLATE.md for bug fix
115
- 7. ✅ Review: Set status:needs-review
116
- 8. ✅ Iteration: Incorporated feedback, updated design
117
- Result: Clear, actionable design document
118
- ```
119
-
120
- ### Bad: Incomplete Design Process
121
- ```
122
- Issue #84: "Fix calendar sync timeout"
123
- 1. ✅ Identified: Issue #84
124
- 2. ❌ Skip: Didn't set phase:design
125
- 3. ❌ Skip: Didn't create branch
126
- 4. ❌ Skip: Started coding without design
127
- 5. ❌ Skip: No RFC document created
128
- 6. ❌ Skip: No stakeholder review
129
- Result: Unclear requirements, potential rework
130
- ```