fraim-framework 2.0.67 → 2.0.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -2
- package/dist/registry/ai-manager-rules/customer-development-phases/phase1-customer-profiling.md +0 -101
- package/dist/registry/ai-manager-rules/customer-development-phases/phase2-platform-discovery.md +0 -235
- package/dist/registry/ai-manager-rules/customer-development-phases/phase3-prospect-qualification.md +0 -243
- package/dist/registry/ai-manager-rules/customer-development-phases/phase4-inventory-compilation.md +0 -206
- package/dist/registry/ai-manager-rules/design-phases/design-completeness-review.md +0 -73
- package/dist/registry/ai-manager-rules/design-phases/design-design.md +0 -145
- package/dist/registry/ai-manager-rules/design-phases/design.md +0 -108
- package/dist/registry/ai-manager-rules/design-phases/finalize.md +0 -60
- package/dist/registry/ai-manager-rules/design-phases/validate.md +0 -125
- package/dist/registry/ai-manager-rules/design.json +0 -97
- package/dist/registry/ai-manager-rules/implement-phases/code.md +0 -323
- package/dist/registry/ai-manager-rules/implement-phases/completeness-review.md +0 -94
- package/dist/registry/ai-manager-rules/implement-phases/finalize.md +0 -177
- package/dist/registry/ai-manager-rules/implement-phases/implement-code.md +0 -283
- package/dist/registry/ai-manager-rules/implement-phases/implement-completeness-review.md +0 -120
- package/dist/registry/ai-manager-rules/implement-phases/implement-regression.md +0 -173
- package/dist/registry/ai-manager-rules/implement-phases/implement-repro.md +0 -104
- package/dist/registry/ai-manager-rules/implement-phases/implement-scoping.md +0 -100
- package/dist/registry/ai-manager-rules/implement-phases/implement-smoke.md +0 -237
- package/dist/registry/ai-manager-rules/implement-phases/implement-spike.md +0 -121
- package/dist/registry/ai-manager-rules/implement-phases/implement-validate.md +0 -375
- package/dist/registry/ai-manager-rules/implement-phases/quality-review.md +0 -304
- package/dist/registry/ai-manager-rules/implement-phases/regression.md +0 -159
- package/dist/registry/ai-manager-rules/implement-phases/repro.md +0 -101
- package/dist/registry/ai-manager-rules/implement-phases/scoping.md +0 -93
- package/dist/registry/ai-manager-rules/implement-phases/smoke.md +0 -225
- package/dist/registry/ai-manager-rules/implement-phases/spike.md +0 -118
- package/dist/registry/ai-manager-rules/implement-phases/validate.md +0 -347
- package/dist/registry/ai-manager-rules/implement.json +0 -153
- package/dist/registry/ai-manager-rules/retrospective.md +0 -116
- package/dist/registry/ai-manager-rules/shared-phases/address-pr-feedback.md +0 -188
- package/dist/registry/ai-manager-rules/shared-phases/finalize.md +0 -169
- package/dist/registry/ai-manager-rules/shared-phases/submit-pr.md +0 -202
- package/dist/registry/ai-manager-rules/shared-phases/wait-for-pr-review.md +0 -170
- package/dist/registry/ai-manager-rules/spec-phases/finalize.md +0 -60
- package/dist/registry/ai-manager-rules/spec-phases/spec-competitor-analysis.md +0 -105
- package/dist/registry/ai-manager-rules/spec-phases/spec-completeness-review.md +0 -66
- package/dist/registry/ai-manager-rules/spec-phases/spec-spec.md +0 -139
- package/dist/registry/ai-manager-rules/spec-phases/spec.md +0 -102
- package/dist/registry/ai-manager-rules/spec-phases/validate.md +0 -118
- package/dist/registry/ai-manager-rules/spec.json +0 -112
- package/dist/registry/ai-manager-rules/test.json +0 -98
- package/dist/registry/ai-manager-rules/user-survey-phases/phase1-survey-scoping.md +0 -60
- package/dist/registry/ai-manager-rules/user-survey-phases/phase2-survey-build-linkedin.md +0 -23
- package/dist/registry/ai-manager-rules/user-survey-phases/phase3-survey-build-reddit.md +0 -22
- package/dist/registry/ai-manager-rules/user-survey-phases/phase4-survey-build-x.md +0 -21
- package/dist/registry/ai-manager-rules/user-survey-phases/phase5-survey-build-facebook.md +0 -19
- package/dist/registry/ai-manager-rules/user-survey-phases/phase6-survey-build-custom.md +0 -15
- package/dist/registry/ai-manager-rules/user-survey-phases/phase7-survey-dispatch.md +0 -45
- package/dist/registry/delivery/address-feedback.md +0 -83
- package/dist/registry/delivery/retrospective.md +0 -78
- package/dist/registry/delivery/submit.md +0 -79
- package/dist/registry/providers/ado.json +0 -19
- package/dist/registry/providers/delivery-conversation.json +0 -9
- package/dist/registry/providers/delivery-pr.json +0 -9
- package/dist/registry/providers/github.json +0 -19
- package/dist/registry/rules/agent-success-criteria.md +0 -101
- package/dist/registry/rules/agent-testing-guidelines.md +0 -502
- package/dist/registry/rules/architecture.md +0 -126
- package/dist/registry/rules/communication.md +0 -122
- package/dist/registry/rules/continuous-learning.md +0 -55
- package/dist/registry/rules/debugging-multitenancy-issues.md +0 -85
- package/dist/registry/rules/ephemeral-execution.md +0 -54
- package/dist/registry/rules/git-safe-commands.md +0 -34
- package/dist/registry/rules/hitl-ppe-record-analysis.md +0 -302
- package/dist/registry/rules/integrity-and-test-ethics.md +0 -275
- package/dist/registry/rules/local-development.md +0 -275
- package/dist/registry/rules/mandatory-pre-completion-reflection.md +0 -193
- package/dist/registry/rules/merge-requirements.md +0 -238
- package/dist/registry/rules/simplicity.md +0 -118
- package/dist/registry/rules/software-development-lifecycle.md +0 -105
- package/dist/registry/rules/spike-first-development.md +0 -205
- package/dist/registry/rules/successful-debugging-patterns.md +0 -488
- package/dist/registry/scripts/build-scripts-generator.js +0 -205
- package/dist/registry/scripts/cleanup-branch.js +0 -287
- package/dist/registry/scripts/evaluate-code-quality.js +0 -66
- package/dist/registry/scripts/exec-with-timeout.js +0 -142
- package/dist/registry/scripts/fraim-config.js +0 -61
- package/dist/registry/scripts/generate-engagement-emails.js +0 -705
- package/dist/registry/scripts/generic-issues-api.js +0 -100
- package/dist/registry/scripts/newsletter-helpers.js +0 -671
- package/dist/registry/scripts/openapi-generator.js +0 -664
- package/dist/registry/scripts/performance/profile-server.js +0 -390
- package/dist/registry/scripts/profile-server.js +0 -389
- package/dist/registry/scripts/run-thank-you-workflow.js +0 -92
- package/dist/registry/scripts/send-newsletter-simple.js +0 -85
- package/dist/registry/scripts/send-thank-you-emails.js +0 -54
- package/dist/registry/scripts/validate-openapi-limits.js +0 -311
- package/dist/registry/scripts/validate-test-coverage.js +0 -262
- package/dist/registry/scripts/verify-test-coverage.js +0 -66
- package/dist/registry/stubs/workflows/azure/cost-optimization.md +0 -11
- package/dist/registry/stubs/workflows/bootstrap/create-architecture.md +0 -11
- package/dist/registry/stubs/workflows/bootstrap/detect-broken-windows.md +0 -11
- package/dist/registry/stubs/workflows/bootstrap/evaluate-code-quality.md +0 -11
- package/dist/registry/stubs/workflows/bootstrap/verify-test-coverage.md +0 -11
- package/dist/registry/stubs/workflows/brainstorming/blue-sky-brainstorming.md +0 -11
- package/dist/registry/stubs/workflows/brainstorming/codebase-brainstorming.md +0 -11
- package/dist/registry/stubs/workflows/business-development/create-business-plan.md +0 -11
- package/dist/registry/stubs/workflows/business-development/ideate-business-opportunity.md +0 -11
- package/dist/registry/stubs/workflows/business-development/price-product.md +0 -18
- package/dist/registry/stubs/workflows/compliance/detect-compliance-requirements.md +0 -11
- package/dist/registry/stubs/workflows/compliance/generate-audit-evidence.md +0 -11
- package/dist/registry/stubs/workflows/compliance/soc2-evidence-generator.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/insight-analysis.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/insight-triage.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/interview-preparation.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/linkedin-outreach.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/strategic-brainstorming.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/thank-customers.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/user-survey-dispatch.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/users-to-target.md +0 -11
- package/dist/registry/stubs/workflows/customer-development/weekly-newsletter.md +0 -11
- package/dist/registry/stubs/workflows/deploy/cloud-deployment.md +0 -11
- package/dist/registry/stubs/workflows/improve-fraim/contribute.md +0 -11
- package/dist/registry/stubs/workflows/improve-fraim/file-issue.md +0 -11
- package/dist/registry/stubs/workflows/learning/build-skillset.md +0 -11
- package/dist/registry/stubs/workflows/learning/synthesize-learnings.md +0 -11
- package/dist/registry/stubs/workflows/legal/contract-review-analysis.md +0 -11
- package/dist/registry/stubs/workflows/legal/nda.md +0 -11
- package/dist/registry/stubs/workflows/legal/patent-filing.md +0 -11
- package/dist/registry/stubs/workflows/legal/saas-contract-development.md +0 -11
- package/dist/registry/stubs/workflows/legal/trademark-filing.md +0 -11
- package/dist/registry/stubs/workflows/marketing/content-creation.md +0 -11
- package/dist/registry/stubs/workflows/marketing/convert-to-pdf.md +0 -11
- package/dist/registry/stubs/workflows/marketing/create-modern-website.md +0 -11
- package/dist/registry/stubs/workflows/marketing/domain-registration.md +0 -11
- package/dist/registry/stubs/workflows/marketing/evangelize.md +0 -11
- package/dist/registry/stubs/workflows/marketing/hbr-article.md +0 -11
- package/dist/registry/stubs/workflows/marketing/launch-checklist.md +0 -11
- package/dist/registry/stubs/workflows/marketing/marketing-strategy.md +0 -11
- package/dist/registry/stubs/workflows/marketing/storytelling.md +0 -11
- package/dist/registry/stubs/workflows/performance/analyze-performance.md +0 -11
- package/dist/registry/stubs/workflows/product-building/design.md +0 -11
- package/dist/registry/stubs/workflows/product-building/implement.md +0 -11
- package/dist/registry/stubs/workflows/product-building/iterate-on-pr-comments.md +0 -11
- package/dist/registry/stubs/workflows/product-building/prep-issue.md +0 -11
- package/dist/registry/stubs/workflows/product-building/prototype.md +0 -11
- package/dist/registry/stubs/workflows/product-building/resolve.md +0 -11
- package/dist/registry/stubs/workflows/product-building/retrospect.md +0 -11
- package/dist/registry/stubs/workflows/product-building/spec.md +0 -11
- package/dist/registry/stubs/workflows/product-building/test.md +0 -11
- package/dist/registry/stubs/workflows/productivity-report/productivity-report.md +0 -11
- package/dist/registry/stubs/workflows/quality-assurance/browser-validation.md +0 -11
- package/dist/registry/stubs/workflows/quality-assurance/iterative-improvement-cycle.md +0 -11
- package/dist/registry/stubs/workflows/replicate/replicate-discovery.md +0 -11
- package/dist/registry/stubs/workflows/replicate/replicate-to-issues.md +0 -11
- package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-design-spec.md +0 -11
- package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -11
- package/dist/registry/stubs/workflows/startup-credits/aws-activate-application.md +0 -11
- package/dist/registry/stubs/workflows/startup-credits/google-cloud-application.md +0 -11
- package/dist/registry/stubs/workflows/startup-credits/microsoft-azure-application.md +0 -11
- package/dist/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +0 -53
- package/dist/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +0 -37
- package/dist/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +0 -35
- package/dist/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +0 -29
- package/dist/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +0 -126
- package/dist/registry/templates/customer-development/customer-interview-template.md +0 -99
- package/dist/registry/templates/customer-development/customer-persona-template.md +0 -69
- package/dist/registry/templates/customer-development/follow-up-email-templates.md +0 -132
- package/dist/registry/templates/customer-development/insight-analysis-template.md +0 -74
- package/dist/registry/templates/customer-development/prospect-inventory-template.csv +0 -3
- package/dist/registry/templates/customer-development/search-strategy-template.md +0 -123
- package/dist/registry/templates/customer-development/strategic-recommendations-template.md +0 -53
- package/dist/registry/templates/customer-development/thank-you-email-template.html +0 -124
- package/dist/registry/templates/customer-development/thank-you-note-template.md +0 -16
- package/dist/registry/templates/customer-development/triage-log-template.md +0 -278
- package/dist/registry/templates/customer-development/weekly-newsletter-template.html +0 -204
- package/dist/registry/templates/evidence/Design-Evidence.md +0 -30
- package/dist/registry/templates/evidence/Implementation-BugEvidence.md +0 -122
- package/dist/registry/templates/evidence/Implementation-FeatureEvidence.md +0 -160
- package/dist/registry/templates/evidence/Spec-Evidence.md +0 -19
- package/dist/registry/templates/help/HelpNeeded.md +0 -14
- package/dist/registry/templates/legal/NDA-TEMPLATE.md +0 -170
- package/dist/registry/templates/legal/PATENT-TEMPLATE.md +0 -372
- package/dist/registry/templates/legal/TRADEMARK-TEMPLATE.md +0 -339
- package/dist/registry/templates/legal/contract-review-checklist.md +0 -193
- package/dist/registry/templates/legal/review-report-template.md +0 -198
- package/dist/registry/templates/legal/saas-terms-template.md +0 -174
- package/dist/registry/templates/legal/sow-template.md +0 -117
- package/dist/registry/templates/legal/template-variables.md +0 -131
- package/dist/registry/templates/marketing/DOMAIN-REGISTRATION-TEMPLATE.md +0 -194
- package/dist/registry/templates/marketing/EVANGELIZE-TEMPLATE.md +0 -102
- package/dist/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +0 -66
- package/dist/registry/templates/marketing/STORYTELLING-TEMPLATE.md +0 -130
- package/dist/registry/templates/marketing/WEBSITE-TEMPLATE.md +0 -262
- package/dist/registry/templates/marketing/github-pages-workflow.yml +0 -64
- package/dist/registry/templates/replicate/implementation-checklist.md +0 -39
- package/dist/registry/templates/replicate/use-cases-template.md +0 -88
- package/dist/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +0 -55
- package/dist/registry/templates/specs/BUGSPEC-TEMPLATE.md +0 -37
- package/dist/registry/templates/specs/FEATURESPEC-TEMPLATE.md +0 -66
- package/dist/registry/templates/specs/TECHSPEC-TEMPLATE.md +0 -39
- package/dist/registry/workflows/azure/cost-optimization.md +0 -772
- package/dist/registry/workflows/bootstrap/create-architecture.md +0 -37
- package/dist/registry/workflows/bootstrap/detect-broken-windows.md +0 -300
- package/dist/registry/workflows/bootstrap/evaluate-code-quality.md +0 -35
- package/dist/registry/workflows/bootstrap/verify-test-coverage.md +0 -36
- package/dist/registry/workflows/brainstorming/blue-sky-brainstorming.md +0 -211
- package/dist/registry/workflows/brainstorming/codebase-brainstorming.md +0 -159
- package/dist/registry/workflows/business-development/create-business-plan.md +0 -737
- package/dist/registry/workflows/business-development/ideate-business-opportunity.md +0 -55
- package/dist/registry/workflows/business-development/price-product.md +0 -325
- package/dist/registry/workflows/compliance/detect-compliance-requirements.md +0 -80
- package/dist/registry/workflows/compliance/generate-audit-evidence.md +0 -80
- package/dist/registry/workflows/compliance/soc2-evidence-generator.md +0 -332
- package/dist/registry/workflows/customer-development/insight-analysis.md +0 -156
- package/dist/registry/workflows/customer-development/insight-triage.md +0 -933
- package/dist/registry/workflows/customer-development/interview-preparation.md +0 -452
- package/dist/registry/workflows/customer-development/linkedin-outreach.md +0 -599
- package/dist/registry/workflows/customer-development/strategic-brainstorming.md +0 -146
- package/dist/registry/workflows/customer-development/thank-customers.md +0 -203
- package/dist/registry/workflows/customer-development/user-survey-dispatch.md +0 -312
- package/dist/registry/workflows/customer-development/users-to-target.md +0 -427
- package/dist/registry/workflows/customer-development/weekly-newsletter.md +0 -366
- package/dist/registry/workflows/deploy/cloud-deployment.md +0 -310
- package/dist/registry/workflows/improve-fraim/contribute.md +0 -32
- package/dist/registry/workflows/improve-fraim/file-issue.md +0 -32
- package/dist/registry/workflows/learning/build-skillset.md +0 -212
- package/dist/registry/workflows/learning/synthesize-learnings.md +0 -369
- package/dist/registry/workflows/legal/contract-review-analysis.md +0 -382
- package/dist/registry/workflows/legal/nda.md +0 -69
- package/dist/registry/workflows/legal/patent-filing.md +0 -76
- package/dist/registry/workflows/legal/saas-contract-development.md +0 -204
- package/dist/registry/workflows/legal/trademark-filing.md +0 -77
- package/dist/registry/workflows/marketing/content-creation.md +0 -40
- package/dist/registry/workflows/marketing/convert-to-pdf.md +0 -265
- package/dist/registry/workflows/marketing/create-modern-website.md +0 -456
- package/dist/registry/workflows/marketing/domain-registration.md +0 -323
- package/dist/registry/workflows/marketing/evangelize.md +0 -426
- package/dist/registry/workflows/marketing/hbr-article.md +0 -73
- package/dist/registry/workflows/marketing/launch-checklist.md +0 -37
- package/dist/registry/workflows/marketing/marketing-strategy.md +0 -45
- package/dist/registry/workflows/marketing/storytelling.md +0 -65
- package/dist/registry/workflows/performance/analyze-performance.md +0 -65
- package/dist/registry/workflows/product-building/design.md +0 -263
- package/dist/registry/workflows/product-building/implement.md +0 -771
- package/dist/registry/workflows/product-building/iterate-on-pr-comments.md +0 -70
- package/dist/registry/workflows/product-building/prep-issue.md +0 -41
- package/dist/registry/workflows/product-building/prototype.md +0 -60
- package/dist/registry/workflows/product-building/resolve.md +0 -175
- package/dist/registry/workflows/product-building/retrospect.md +0 -86
- package/dist/registry/workflows/product-building/spec.md +0 -303
- package/dist/registry/workflows/product-building/test.md +0 -125
- package/dist/registry/workflows/productivity-report/productivity-report.md +0 -263
- package/dist/registry/workflows/quality-assurance/browser-validation.md +0 -221
- package/dist/registry/workflows/quality-assurance/iterative-improvement-cycle.md +0 -562
- package/dist/registry/workflows/replicate/replicate-discovery.md +0 -336
- package/dist/registry/workflows/replicate/replicate-to-issues.md +0 -319
- package/dist/registry/workflows/reviewer/review-implementation-vs-design-spec.md +0 -694
- package/dist/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -734
- package/dist/registry/workflows/startup-credits/aws-activate-application.md +0 -535
- package/dist/registry/workflows/startup-credits/google-cloud-application.md +0 -647
- package/dist/registry/workflows/startup-credits/microsoft-azure-application.md +0 -538
|
@@ -1,204 +0,0 @@
|
|
|
1
|
-
## INTENT
|
|
2
|
-
Create comprehensive, legally protective contract packages for SaaS engagements including SOWs, Terms & Conditions, and strategic pricing negotiations. This skill enables rapid development of professional-grade legal documents that protect IP, limit liability, and position for business growth.
|
|
3
|
-
|
|
4
|
-
## PRINCIPLES
|
|
5
|
-
- **Legal Protection First**: Always prioritize IP protection and liability limitation
|
|
6
|
-
- **Business Growth Alignment**: Structure contracts to enable expansion and renewal
|
|
7
|
-
- **Clear Boundaries**: Explicitly define scope, responsibilities, and limitations
|
|
8
|
-
- **Professional Positioning**: Use language that establishes expertise and authority
|
|
9
|
-
- **Flexibility with Protection**: Allow for scope changes while maintaining legal safeguards
|
|
10
|
-
|
|
11
|
-
## WORKFLOW
|
|
12
|
-
|
|
13
|
-
### Step 1: Engagement Analysis
|
|
14
|
-
**Objective**: Understand the business context and legal requirements
|
|
15
|
-
|
|
16
|
-
**Actions**:
|
|
17
|
-
1. Analyze customer profile and industry (financial services, healthcare, etc.)
|
|
18
|
-
2. Identify service delivery model (training, managed services, software licensing)
|
|
19
|
-
3. Assess pricing strategy and revenue model
|
|
20
|
-
4. Determine liability exposure and risk factors
|
|
21
|
-
5. Review existing customer feedback and scope changes
|
|
22
|
-
|
|
23
|
-
**Tools/Resources**:
|
|
24
|
-
- Customer discovery documents
|
|
25
|
-
- Pricing strategy documents
|
|
26
|
-
- Industry-specific compliance requirements
|
|
27
|
-
- Existing contract templates
|
|
28
|
-
|
|
29
|
-
**Output**: Clear understanding of engagement scope, risks, and legal requirements
|
|
30
|
-
|
|
31
|
-
### Step 2: Document Structure Planning
|
|
32
|
-
**Objective**: Design the optimal contract package structure
|
|
33
|
-
|
|
34
|
-
**Actions**:
|
|
35
|
-
1. Determine if MSA is needed (single engagement vs. ongoing relationship)
|
|
36
|
-
2. Plan SOW scope and deliverables structure
|
|
37
|
-
3. Identify Terms & Conditions requirements
|
|
38
|
-
4. Map pricing model to contract terms
|
|
39
|
-
5. Plan signature and execution process
|
|
40
|
-
|
|
41
|
-
**Tools/Resources**:
|
|
42
|
-
- Contract template library
|
|
43
|
-
- Legal precedent research
|
|
44
|
-
- Industry standard practices
|
|
45
|
-
|
|
46
|
-
**Output**: Complete document package plan with clear hierarchy
|
|
47
|
-
|
|
48
|
-
### Step 3: SOW Development
|
|
49
|
-
**Objective**: Create a comprehensive Statement of Work
|
|
50
|
-
|
|
51
|
-
**Actions**:
|
|
52
|
-
1. **Engagement Summary**: Clear objective and delivery model
|
|
53
|
-
2. **Scope Definition**: Detailed in-scope and out-of-scope items
|
|
54
|
-
3. **Pricing Structure**: Transparent pricing with flexibility clauses
|
|
55
|
-
4. **Success Metrics**: Measurable outcomes and evaluation criteria
|
|
56
|
-
5. **IP and Confidentiality**: Clear ownership and protection terms
|
|
57
|
-
6. **Signature Block**: Professional execution format
|
|
58
|
-
|
|
59
|
-
**Key SOW Elements**:
|
|
60
|
-
- Advisory vs. delivery accountability boundaries
|
|
61
|
-
- Pricing reevaluation clauses for expansion
|
|
62
|
-
- Flexible scope change management
|
|
63
|
-
- Clear customer responsibility statements
|
|
64
|
-
|
|
65
|
-
**Tools/Resources**:
|
|
66
|
-
- SOW templates (`templates/sow-template.md`)
|
|
67
|
-
- Pricing calculators
|
|
68
|
-
- Success metrics frameworks
|
|
69
|
-
- Template variables guide (`templates/template-variables.md`)
|
|
70
|
-
|
|
71
|
-
**Output**: Complete, professional SOW ready for negotiation
|
|
72
|
-
|
|
73
|
-
### Step 4: Terms & Conditions Creation
|
|
74
|
-
**Objective**: Develop comprehensive SaaS Terms & Conditions
|
|
75
|
-
|
|
76
|
-
**Actions**:
|
|
77
|
-
1. **Service Description**: Clear platform and service definitions
|
|
78
|
-
2. **IP Protection**: Comprehensive ownership and licensing terms
|
|
79
|
-
3. **Liability Limitation**: Maximum protection within legal bounds
|
|
80
|
-
4. **Data Protection**: Privacy and security commitments
|
|
81
|
-
5. **Service Levels**: Realistic availability and support commitments
|
|
82
|
-
6. **Legal Framework**: Governing law, dispute resolution, termination
|
|
83
|
-
|
|
84
|
-
**Critical T&C Sections**:
|
|
85
|
-
- Zero or minimal liability clauses
|
|
86
|
-
- Strong IP retention language
|
|
87
|
-
- Minimal data retention policies
|
|
88
|
-
- Flexible support commitments
|
|
89
|
-
- Comprehensive indemnification
|
|
90
|
-
|
|
91
|
-
**Tools/Resources**:
|
|
92
|
-
- Legal template libraries (`templates/saas-terms-template.md`)
|
|
93
|
-
- Industry standard T&C examples
|
|
94
|
-
- Jurisdiction-specific requirements
|
|
95
|
-
- Template variables guide (`templates/template-variables.md`)
|
|
96
|
-
|
|
97
|
-
**Output**: Legally protective Terms & Conditions document
|
|
98
|
-
|
|
99
|
-
### Step 5: Document Integration & Review
|
|
100
|
-
**Objective**: Ensure document consistency and legal coherence
|
|
101
|
-
|
|
102
|
-
**Actions**:
|
|
103
|
-
1. Cross-reference SOW and T&C for consistency
|
|
104
|
-
2. Verify pricing alignment across documents
|
|
105
|
-
3. Check IP ownership consistency
|
|
106
|
-
4. Validate liability protection coverage
|
|
107
|
-
5. Ensure professional formatting and presentation
|
|
108
|
-
|
|
109
|
-
**Review Checklist**:
|
|
110
|
-
- [ ] IP ownership clearly defined in both documents
|
|
111
|
-
- [ ] Liability limitations consistent
|
|
112
|
-
- [ ] Pricing terms align with business model
|
|
113
|
-
- [ ] Scope boundaries clearly established
|
|
114
|
-
- [ ] Professional presentation quality
|
|
115
|
-
|
|
116
|
-
**Tools/Resources**:
|
|
117
|
-
- Document comparison tools
|
|
118
|
-
- Legal review checklists
|
|
119
|
-
- Professional formatting standards
|
|
120
|
-
|
|
121
|
-
**Output**: Integrated, consistent contract package
|
|
122
|
-
|
|
123
|
-
### Step 6: PDF Generation & Delivery
|
|
124
|
-
**Objective**: Create professional presentation-ready documents
|
|
125
|
-
|
|
126
|
-
**Actions**:
|
|
127
|
-
1. Install markdown-to-PDF conversion tools (`npm install -g md-to-pdf`)
|
|
128
|
-
2. Convert documents with professional formatting
|
|
129
|
-
3. Verify PDF quality and readability
|
|
130
|
-
4. Organize files for client delivery
|
|
131
|
-
5. Prepare document package for negotiation
|
|
132
|
-
|
|
133
|
-
**PDF Generation Commands**:
|
|
134
|
-
```bash
|
|
135
|
-
md-to-pdf "document.md" --pdf-options '{"format": "A4", "margin": {"top": "1in", "right": "1in", "bottom": "1in", "left": "1in"}}'
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
**Tools/Resources**:
|
|
139
|
-
- md-to-pdf npm package
|
|
140
|
-
- PDF formatting standards
|
|
141
|
-
- Professional document templates
|
|
142
|
-
|
|
143
|
-
**Output**: Professional PDF contract package ready for client presentation
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
### Common Pitfalls
|
|
147
|
-
- **Scope Creep**: Not clearly defining out-of-scope items
|
|
148
|
-
- **Liability Exposure**: Insufficient liability limitation language
|
|
149
|
-
- **IP Confusion**: Unclear ownership of work product vs. platform
|
|
150
|
-
- **Pricing Rigidity**: No mechanism for scope or pricing adjustments
|
|
151
|
-
- **Poor Presentation**: Unprofessional document formatting
|
|
152
|
-
|
|
153
|
-
## SUCCESS CRITERIA
|
|
154
|
-
- [ ] Complete contract package (SOW + T&C) created
|
|
155
|
-
- [ ] IP ownership clearly protected
|
|
156
|
-
- [ ] Liability exposure minimized or eliminated
|
|
157
|
-
- [ ] Pricing structure supports business growth
|
|
158
|
-
- [ ] Professional PDF documents generated
|
|
159
|
-
- [ ] Client-ready presentation package delivered
|
|
160
|
-
- [ ] Legal boundaries clearly established
|
|
161
|
-
- [ ] Expansion/renewal mechanisms included
|
|
162
|
-
|
|
163
|
-
## PRICING STRATEGY INTEGRATION
|
|
164
|
-
|
|
165
|
-
### Tier-Based Pricing Approach
|
|
166
|
-
- **Core Framework**: Low-cost entry point
|
|
167
|
-
- **Acceleration Academy**: Training + software bundle
|
|
168
|
-
- **Managed Delivery**: High-touch service delivery
|
|
169
|
-
|
|
170
|
-
### Contract Pricing Tactics
|
|
171
|
-
- Hybrid models (licensing + services)
|
|
172
|
-
- Reevaluation clauses for expansion
|
|
173
|
-
- Volume discounts for longer commitments
|
|
174
|
-
- Success-based pricing adjustments
|
|
175
|
-
|
|
176
|
-
## LEGAL PROTECTION CHECKLIST
|
|
177
|
-
|
|
178
|
-
### IP Protection
|
|
179
|
-
- [ ] Platform ownership retained
|
|
180
|
-
- [ ] Work product ownership defined
|
|
181
|
-
- [ ] Improvement rights reserved
|
|
182
|
-
- [ ] Feedback usage rights secured
|
|
183
|
-
|
|
184
|
-
### Liability Limitation
|
|
185
|
-
- [ ] Zero liability clause (where legally permissible)
|
|
186
|
-
- [ ] Warranty disclaimers included
|
|
187
|
-
- [ ] Consequential damages excluded
|
|
188
|
-
- [ ] Maximum liability caps set
|
|
189
|
-
|
|
190
|
-
### Data Protection
|
|
191
|
-
- [ ] Minimal data retention policies
|
|
192
|
-
- [ ] Processing purpose limitations
|
|
193
|
-
- [ ] Security commitment levels
|
|
194
|
-
- [ ] Breach notification procedures
|
|
195
|
-
|
|
196
|
-
## NOTES
|
|
197
|
-
- Always customize jurisdiction and governing law based on business location
|
|
198
|
-
- Consider industry-specific compliance requirements (SOC 2, HIPAA, etc.)
|
|
199
|
-
- Maintain template library for rapid contract development
|
|
200
|
-
- Keep pricing strategy documents aligned with contract terms
|
|
201
|
-
- Regular legal review recommended for template updates
|
|
202
|
-
- PDF generation ensures professional presentation and prevents unauthorized edits
|
|
203
|
-
- **Templates Available**: Use `templates/sow-template.md` and `templates/saas-terms-template.md` with `templates/template-variables.md` guide for rapid contract creation. Get these files using get_fraim_file MCP toolcall
|
|
204
|
-
- **Variable Substitution**: All `[VARIABLE]` placeholders must be replaced before finalizing documents
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
# Workflow: trademark-filing
|
|
2
|
-
|
|
3
|
-
**Path:** `workflows/legal/trademark-filing.md`
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Trademark Filing Workflow
|
|
8
|
-
|
|
9
|
-
## INTENT
|
|
10
|
-
To conduct comprehensive trademark searches, analyze registrability, and file trademark applications that protect brand names, logos, and slogans while avoiding conflicts with existing marks and maximizing protection scope.
|
|
11
|
-
|
|
12
|
-
## PRINCIPLES
|
|
13
|
-
- **Comprehensive Search**: Thorough analysis of existing trademarks and common law rights
|
|
14
|
-
- **Strategic Classification**: Optimal selection of goods/services classes for maximum protection
|
|
15
|
-
- **Strong Distinctiveness**: Ensure marks are distinctive and protectable
|
|
16
|
-
- **Global Perspective**: Consider international trademark strategy and Madrid Protocol
|
|
17
|
-
- **Brand Protection**: Create comprehensive brand protection strategy
|
|
18
|
-
|
|
19
|
-
## TRADEMARK FILING WORKFLOW
|
|
20
|
-
|
|
21
|
-
### Step 1: Trademark Identification
|
|
22
|
-
Define the marks to be protected:
|
|
23
|
-
- Word marks (brand names, slogans)
|
|
24
|
-
- Design marks (logos, symbols)
|
|
25
|
-
- Combined marks (word + design)
|
|
26
|
-
- Trade dress (product appearance)
|
|
27
|
-
- Sound marks or other non-traditional marks
|
|
28
|
-
|
|
29
|
-
### Step 2: Comprehensive Trademark Search
|
|
30
|
-
Conduct multi-level search strategy:
|
|
31
|
-
- USPTO Trademark Electronic Search System (TESS)
|
|
32
|
-
- State trademark databases
|
|
33
|
-
- Common law trademark search
|
|
34
|
-
- Domain name availability
|
|
35
|
-
- Social media handle availability
|
|
36
|
-
- International trademark databases
|
|
37
|
-
|
|
38
|
-
### Step 3: Registrability Analysis
|
|
39
|
-
Evaluate trademark strength and registrability:
|
|
40
|
-
- **Distinctiveness**: Arbitrary, suggestive, descriptive, or generic
|
|
41
|
-
- **Likelihood of Confusion**: Similarity to existing marks
|
|
42
|
-
- **Absolute Bars**: Descriptive, deceptive, scandalous content
|
|
43
|
-
- **Prior Rights**: Common law and registered trademark conflicts
|
|
44
|
-
|
|
45
|
-
### Step 4: Goods and Services Classification
|
|
46
|
-
Strategic class selection and description:
|
|
47
|
-
- International Classification (Nice Classification)
|
|
48
|
-
- Broad vs. narrow descriptions
|
|
49
|
-
- Future business expansion considerations
|
|
50
|
-
- Multi-class filing strategy
|
|
51
|
-
|
|
52
|
-
### Step 5: Filing Strategy Development
|
|
53
|
-
Determine optimal filing approach:
|
|
54
|
-
- Intent-to-Use vs. Use-in-Commerce
|
|
55
|
-
- Madrid Protocol for international protection
|
|
56
|
-
- Priority filing jurisdictions
|
|
57
|
-
- Timing and budget considerations
|
|
58
|
-
|
|
59
|
-
### Step 6: Application Preparation and Filing
|
|
60
|
-
Create complete trademark application:
|
|
61
|
-
- Mark identification and description
|
|
62
|
-
- Goods/services descriptions
|
|
63
|
-
- Specimens of use (if applicable)
|
|
64
|
-
- Declaration and signatures
|
|
65
|
-
- Filing fees and forms
|
|
66
|
-
|
|
67
|
-
## TEMPLATE USAGE
|
|
68
|
-
|
|
69
|
-
Use `get_fraim_file({ path: "templates/legal/TRADEMARK-TEMPLATE.md" })` to create:
|
|
70
|
-
- `docs/legal/trademarks/{mark-name}-{date}-application.md`
|
|
71
|
-
|
|
72
|
-
## OUTPUT
|
|
73
|
-
- Comprehensive trademark search report
|
|
74
|
-
- Registrability analysis and recommendations
|
|
75
|
-
- Professional trademark application
|
|
76
|
-
- International filing strategy
|
|
77
|
-
- Brand protection roadmap
|
|
@@ -1,40 +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
|
-
|
|
25
|
-
{{include:orchestration/parallelization-guidance.md}}
|
|
26
|
-
|
|
27
|
-
- Create drafts for each asset in `docs/marketing/content/{issue_number}/`
|
|
28
|
-
- Follow the brand voice guidelines.
|
|
29
|
-
|
|
30
|
-
### Step 3: Visual Asset Prep
|
|
31
|
-
- Identify core screenshots or diagrams needed.
|
|
32
|
-
- Write descriptions for images.
|
|
33
|
-
|
|
34
|
-
### Step 4: Review
|
|
35
|
-
- Ensure content is free of errors and aligns with the strategy.
|
|
36
|
-
|
|
37
|
-
## OUTPUT
|
|
38
|
-
- Blog Post Draft
|
|
39
|
-
- Social Media Thread Draft
|
|
40
|
-
- Email Campaign Draft
|
|
@@ -1,265 +0,0 @@
|
|
|
1
|
-
# Convert to PDF Workflow
|
|
2
|
-
|
|
3
|
-
## INTENT
|
|
4
|
-
To provide agents with a reliable workflow for converting markdown files to professional PDF documents, enabling seamless document sharing and archival while maintaining formatting integrity and visual appeal.
|
|
5
|
-
|
|
6
|
-
## PRINCIPLES
|
|
7
|
-
- **Format Preservation**: Maintain all markdown formatting including tables, code blocks, and images
|
|
8
|
-
- **Professional Output**: Generate clean, readable PDFs suitable for business use
|
|
9
|
-
- **Flexible Configuration**: Support various paper formats, margins, and styling options
|
|
10
|
-
- **Error Resilience**: Handle common conversion issues gracefully with clear error messages
|
|
11
|
-
- **Cross-Platform Compatibility**: Work consistently across Windows, macOS, and Linux
|
|
12
|
-
|
|
13
|
-
## Overview
|
|
14
|
-
This workflow guides agents through converting markdown files to PDF format using the markdown-to-pdf script. The conversion maintains formatting, supports code highlighting, tables, and images while producing professional-looking PDF documents.
|
|
15
|
-
|
|
16
|
-
## When to Use
|
|
17
|
-
- User requests converting markdown documentation to PDF
|
|
18
|
-
- Need to generate PDF reports from markdown content
|
|
19
|
-
- Creating printable versions of specifications or documentation
|
|
20
|
-
- Sharing formatted documents with stakeholders who prefer PDF format
|
|
21
|
-
- Archiving documentation in a portable format
|
|
22
|
-
|
|
23
|
-
## Prerequisites
|
|
24
|
-
Before using this workflow, ensure the following dependencies are installed:
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
npm install puppeteer markdown-it markdown-it-highlightjs
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## Script and Style Locations
|
|
31
|
-
- **Conversion script**: `~/.fraim/scripts/markdown-to-pdf.js`
|
|
32
|
-
- **Professional CSS styles**: `~/.fraim/scripts/pdf-styles.css`
|
|
33
|
-
|
|
34
|
-
## Workflow Steps
|
|
35
|
-
|
|
36
|
-
### Phase 1: Validate Environment
|
|
37
|
-
|
|
38
|
-
1. **Check Dependencies**
|
|
39
|
-
```bash
|
|
40
|
-
node -e "console.log('puppeteer:', require.resolve('puppeteer')); console.log('markdown-it:', require.resolve('markdown-it')); console.log('markdown-it-highlightjs:', require.resolve('markdown-it-highlightjs'));"
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
2. **Verify Script Availability**
|
|
44
|
-
- Confirm `~/.fraim/scripts/markdown-to-pdf.js` exists
|
|
45
|
-
- Check script permissions (executable on Unix systems)
|
|
46
|
-
|
|
47
|
-
3. **Test Basic Functionality**
|
|
48
|
-
```bash
|
|
49
|
-
node ~/.fraim/scripts/markdown-to-pdf.js --help
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Phase 2: Prepare Input
|
|
53
|
-
|
|
54
|
-
1. **Validate Input File**
|
|
55
|
-
- Confirm markdown file exists and is readable
|
|
56
|
-
- Check for any syntax issues in markdown
|
|
57
|
-
- Verify image paths are correct and accessible
|
|
58
|
-
|
|
59
|
-
2. **Determine Output Requirements**
|
|
60
|
-
- Ask user about desired output location
|
|
61
|
-
- Confirm paper format preferences (A4, Letter, etc.)
|
|
62
|
-
- Check if custom styling is needed
|
|
63
|
-
- Determine header/footer requirements
|
|
64
|
-
|
|
65
|
-
3. **Prepare Output Directory**
|
|
66
|
-
- Ensure output directory exists
|
|
67
|
-
- Verify write permissions
|
|
68
|
-
|
|
69
|
-
### Phase 3: Execute Conversion
|
|
70
|
-
|
|
71
|
-
1. **Professional Conversion (Recommended)**
|
|
72
|
-
```bash
|
|
73
|
-
node ~/.fraim/scripts/markdown-to-pdf.js <input.md> [output.pdf] --css ~/.fraim/scripts/pdf-styles.css
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
2. **Basic Conversion**
|
|
77
|
-
```bash
|
|
78
|
-
node ~/.fraim/scripts/markdown-to-pdf.js <input.md>
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
3. **Advanced Conversion with Custom Options**
|
|
82
|
-
```bash
|
|
83
|
-
node ~/.fraim/scripts/markdown-to-pdf.js <input.md> [output.pdf] [options]
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
4. **Monitor Progress**
|
|
87
|
-
- Watch for error messages
|
|
88
|
-
- Verify successful completion
|
|
89
|
-
- Check output file size and accessibility
|
|
90
|
-
|
|
91
|
-
### Phase 4: Validate Output
|
|
92
|
-
|
|
93
|
-
1. **Verify PDF Generation**
|
|
94
|
-
- Confirm PDF file was created
|
|
95
|
-
- Check file size is reasonable
|
|
96
|
-
- Verify file is not corrupted
|
|
97
|
-
|
|
98
|
-
2. **Quality Check**
|
|
99
|
-
- Review formatting preservation
|
|
100
|
-
- Check image rendering
|
|
101
|
-
- Verify code block highlighting
|
|
102
|
-
- Confirm table alignment
|
|
103
|
-
|
|
104
|
-
3. **User Acceptance**
|
|
105
|
-
- Share output location with user
|
|
106
|
-
- Confirm output meets requirements
|
|
107
|
-
- Offer to regenerate with different options if needed
|
|
108
|
-
|
|
109
|
-
### Available Options
|
|
110
|
-
|
|
111
|
-
| Option | Description | Example |
|
|
112
|
-
|--------|-------------|---------|
|
|
113
|
-
| `--format <format>` | Paper format (A4, Letter, Legal, etc.) | `--format Letter` |
|
|
114
|
-
| `--margin <margin>` | Page margins in inches | `--margin 1` |
|
|
115
|
-
| `--css <file>` | Custom CSS file for styling | `--css custom.css` |
|
|
116
|
-
| `--header <text>` | Header text | `--header "Company Report"` |
|
|
117
|
-
| `--footer <text>` | Footer text | `--footer "Page <span class='pageNumber'></span>"` |
|
|
118
|
-
| `--landscape` | Use landscape orientation | `--landscape` |
|
|
119
|
-
| `--no-background` | Disable background graphics | `--no-background` |
|
|
120
|
-
|
|
121
|
-
### Common Examples
|
|
122
|
-
|
|
123
|
-
1. **Professional conversion (recommended):**
|
|
124
|
-
```bash
|
|
125
|
-
node ~/.fraim/scripts/markdown-to-pdf.js README.md --css ~/.fraim/scripts/pdf-styles.css
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
2. **Basic conversion:**
|
|
129
|
-
```bash
|
|
130
|
-
node ~/.fraim/scripts/markdown-to-pdf.js README.md
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
3. **Specify output location with professional styling:**
|
|
134
|
-
```bash
|
|
135
|
-
node ~/.fraim/scripts/markdown-to-pdf.js docs/spec.md output/specification.pdf --css ~/.fraim/scripts/pdf-styles.css
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
4. **Letter format with professional styling:**
|
|
139
|
-
```bash
|
|
140
|
-
node ~/.fraim/scripts/markdown-to-pdf.js report.md --format Letter --css ~/.fraim/scripts/pdf-styles.css
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
5. **With custom styling:**
|
|
144
|
-
```bash
|
|
145
|
-
node ~/.fraim/scripts/markdown-to-pdf.js document.md --css styles/custom.css --header "Project Documentation"
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
6. **Landscape orientation:**
|
|
149
|
-
```bash
|
|
150
|
-
node ~/.fraim/scripts/markdown-to-pdf.js wide-table.md --landscape --format A3
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
## Agent Instructions
|
|
154
|
-
|
|
155
|
-
When a user requests markdown to PDF conversion:
|
|
156
|
-
|
|
157
|
-
1. **Identify the source file(s)**: Confirm which markdown file(s) need to be converted
|
|
158
|
-
2. **Check dependencies**: Verify that required npm packages are installed
|
|
159
|
-
3. **Determine output requirements**: Ask about:
|
|
160
|
-
- Desired output location
|
|
161
|
-
- Paper format preferences
|
|
162
|
-
- Custom styling needs (default to professional styling)
|
|
163
|
-
- Header/footer requirements
|
|
164
|
-
4. **Execute conversion**: Use professional styling by default:
|
|
165
|
-
```bash
|
|
166
|
-
node ~/.fraim/scripts/markdown-to-pdf.js <input.md> [output.pdf] --css ~/.fraim/scripts/pdf-styles.css
|
|
167
|
-
```
|
|
168
|
-
5. **Verify output**: Confirm the PDF was generated successfully and meets requirements
|
|
169
|
-
|
|
170
|
-
### Professional Styling Benefits
|
|
171
|
-
The included `pdf-styles.css` provides:
|
|
172
|
-
- **Professional fonts**: Times New Roman at appropriate sizes (11pt body, 18pt/14pt/12pt headers)
|
|
173
|
-
- **Business-appropriate colors**: Dark blue headers with subtle accents
|
|
174
|
-
- **Proper spacing**: Optimized margins and line spacing for readability
|
|
175
|
-
- **Clean formatting**: Professional table styling, code blocks, and page layout
|
|
176
|
-
- **Print optimization**: A4 format with proper page margins and numbering
|
|
177
|
-
|
|
178
|
-
### Error Handling
|
|
179
|
-
|
|
180
|
-
If the script fails:
|
|
181
|
-
- Check that all dependencies are installed
|
|
182
|
-
- Verify the input file exists and is readable
|
|
183
|
-
- Ensure the output directory is writable
|
|
184
|
-
- Check for any syntax errors in the markdown file
|
|
185
|
-
|
|
186
|
-
### Troubleshooting Common Issues
|
|
187
|
-
|
|
188
|
-
1. **Missing dependencies**: Install required packages with npm
|
|
189
|
-
2. **Permission errors**: Ensure write permissions for output directory
|
|
190
|
-
3. **Large files**: Consider breaking large markdown files into smaller sections
|
|
191
|
-
4. **Image issues**: Verify image paths are correct and accessible
|
|
192
|
-
5. **Font rendering**: Use web-safe fonts or include custom font CSS
|
|
193
|
-
|
|
194
|
-
## Customization
|
|
195
|
-
|
|
196
|
-
### Professional CSS Styling (Default)
|
|
197
|
-
FRAIM includes professional PDF styling at `~/.fraim/scripts/pdf-styles.css` with:
|
|
198
|
-
- Times New Roman font family (11pt body text)
|
|
199
|
-
- Professional color scheme (dark blue headers)
|
|
200
|
-
- Optimized spacing and margins
|
|
201
|
-
- Clean table and code block formatting
|
|
202
|
-
- A4 page format with page numbering
|
|
203
|
-
|
|
204
|
-
### Custom CSS Styling
|
|
205
|
-
Create a CSS file to customize the PDF appearance further:
|
|
206
|
-
|
|
207
|
-
```css
|
|
208
|
-
/* custom-style.css */
|
|
209
|
-
body {
|
|
210
|
-
font-family: 'Arial', sans-serif;
|
|
211
|
-
font-size: 12pt;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
h1 {
|
|
215
|
-
color: #2c3e50;
|
|
216
|
-
border-bottom: 3px solid #3498db;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
code {
|
|
220
|
-
background-color: #f0f0f0;
|
|
221
|
-
border: 1px solid #ccc;
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
@page {
|
|
225
|
-
margin: 1in;
|
|
226
|
-
@top-center {
|
|
227
|
-
content: "Confidential Document";
|
|
228
|
-
}
|
|
229
|
-
}
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
### Batch Processing
|
|
233
|
-
For converting multiple files with professional styling, create a simple loop:
|
|
234
|
-
|
|
235
|
-
```bash
|
|
236
|
-
for file in docs/*.md; do
|
|
237
|
-
node ~/.fraim/scripts/markdown-to-pdf.js "$file" "output/$(basename "$file" .md).pdf" --css ~/.fraim/scripts/pdf-styles.css
|
|
238
|
-
done
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
## Quality Assurance
|
|
242
|
-
|
|
243
|
-
After conversion, verify:
|
|
244
|
-
- All content is present and properly formatted
|
|
245
|
-
- Images are displayed correctly
|
|
246
|
-
- Code blocks maintain syntax highlighting
|
|
247
|
-
- Tables are properly aligned
|
|
248
|
-
- Page breaks occur at appropriate locations
|
|
249
|
-
- Headers and footers appear as expected
|
|
250
|
-
|
|
251
|
-
## Best Practices
|
|
252
|
-
|
|
253
|
-
1. **Test with sample content** before processing important documents
|
|
254
|
-
2. **Use consistent styling** across related documents
|
|
255
|
-
3. **Optimize images** for better PDF file size
|
|
256
|
-
4. **Consider accessibility** when choosing fonts and colors
|
|
257
|
-
5. **Version control** both source markdown and generated PDFs when appropriate
|
|
258
|
-
|
|
259
|
-
## Integration with Other Workflows
|
|
260
|
-
|
|
261
|
-
This workflow can be combined with:
|
|
262
|
-
- Documentation generation workflows
|
|
263
|
-
- Report automation processes
|
|
264
|
-
- CI/CD pipelines for document publishing
|
|
265
|
-
- Content review and approval workflows
|