@redaksjon/kronologi 0.0.11 → 1.0.3
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/.kronologi/examples/monthly-summary/config.yaml +37 -0
- package/.kronologi/examples/monthly-summary/instructions.md +35 -0
- package/.kronologi/examples/monthly-summary/persona.md +12 -0
- package/.kronologi/examples/release-notes/config.yaml +71 -0
- package/.kronologi/examples/release-notes/instructions.md +92 -0
- package/.kronologi/examples/release-notes/persona.md +26 -0
- package/.kronologi/examples/team-update/config.yaml +54 -0
- package/.kronologi/examples/team-update/instructions.md +104 -0
- package/.kronologi/examples/team-update/persona.md +27 -0
- package/.kronologi/examples/weekly-summary/config.yaml +49 -0
- package/.kronologi/examples/weekly-summary/instructions.md +39 -0
- package/.kronologi/examples/weekly-summary/persona.md +14 -0
- package/.mindshahn/config.yaml +1 -0
- package/.mindshahn/emails-summary/config.yaml +37 -0
- package/.mindshahn/emails-summary/instructions.md +37 -0
- package/.mindshahn/emails-summary/persona.md +13 -0
- package/QUICK_START.md +294 -0
- package/README.md +326 -32
- package/dist/chunks/configLoader-BPz_1NxJ.js +114 -0
- package/dist/chunks/configLoader-BPz_1NxJ.js.map +1 -0
- package/dist/chunks/run-CfQj3HEQ.js +760 -0
- package/dist/chunks/run-CfQj3HEQ.js.map +1 -0
- package/dist/chunks/storage-qQJlVNUN.js +202 -0
- package/dist/chunks/storage-qQJlVNUN.js.map +1 -0
- package/dist/init-job.js +209 -0
- package/dist/init-job.js.map +1 -0
- package/dist/main.js +386 -1
- package/dist/main.js.map +1 -1
- package/dist/mcp/server.js +454 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/validate-job.js +253 -0
- package/dist/validate-job.js.map +1 -0
- package/docs/index.html +18 -0
- package/docs/package-lock.json +1828 -0
- package/docs/package.json +24 -0
- package/docs/vite.config.js +16 -0
- package/eslint.config.mjs +1 -0
- package/guide/architecture.md +1186 -0
- package/guide/configuration.md +1243 -0
- package/guide/development.md +1079 -0
- package/guide/index.md +504 -0
- package/guide/jobs.md +1136 -0
- package/guide/models.md +946 -0
- package/guide/prompts.md +948 -0
- package/guide/quickstart.md +631 -0
- package/guide/weekly-summaries.md +369 -0
- package/package.json +14 -6
- package/redaksjon-kronologi-0.0.12-dev.0.tgz +0 -0
- package/scripts/reorganize-by-week.js +99 -0
- package/scripts/weekly-summary.sh +71 -0
- package/tsconfig.tsbuildinfo +1 -1
- package/vite.config.ts +37 -21
- package/vitest.config.ts +4 -3
- package/dist/analysis/configLoader.js +0 -86
- package/dist/analysis/configLoader.js.map +0 -1
- package/dist/analysis/file.js +0 -54
- package/dist/analysis/file.js.map +0 -1
- package/dist/analysis/inputs.js +0 -43
- package/dist/analysis/inputs.js.map +0 -1
- package/dist/analysis/prompt.js +0 -169
- package/dist/analysis/prompt.js.map +0 -1
- package/dist/analysis/section.js +0 -43
- package/dist/analysis/section.js.map +0 -1
- package/dist/arguments.js +0 -143
- package/dist/arguments.js.map +0 -1
- package/dist/constants.js +0 -49
- package/dist/constants.js.map +0 -1
- package/dist/error/ArgumentError.js +0 -26
- package/dist/error/ArgumentError.js.map +0 -1
- package/dist/kronologi.js +0 -123
- package/dist/kronologi.js.map +0 -1
- package/dist/logging.js +0 -46
- package/dist/logging.js.map +0 -1
- package/dist/output.js +0 -15
- package/dist/output.js.map +0 -1
- package/dist/run.js +0 -28
- package/dist/run.js.map +0 -1
- package/dist/types.js +0 -23
- package/dist/types.js.map +0 -1
- package/dist/util/dates.js +0 -14
- package/dist/util/dates.js.map +0 -1
- package/dist/util/storage.js +0 -126
- package/dist/util/storage.js.map +0 -1
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Monthly Summary - Simple Example
|
|
2
|
+
# This is a minimal configuration for creating monthly summaries from activity files
|
|
3
|
+
|
|
4
|
+
model: gpt-4o-mini
|
|
5
|
+
temperature: 0.7
|
|
6
|
+
|
|
7
|
+
parameters:
|
|
8
|
+
year:
|
|
9
|
+
type: number
|
|
10
|
+
description: Year for the summary
|
|
11
|
+
month:
|
|
12
|
+
type: number
|
|
13
|
+
description: Month for the summary (1-12)
|
|
14
|
+
|
|
15
|
+
content:
|
|
16
|
+
activity:
|
|
17
|
+
type: activity
|
|
18
|
+
name: Monthly Activity
|
|
19
|
+
directory: ''
|
|
20
|
+
pattern: '*.md'
|
|
21
|
+
|
|
22
|
+
output:
|
|
23
|
+
summary:
|
|
24
|
+
type: summary
|
|
25
|
+
format: markdown
|
|
26
|
+
name: Monthly Summary
|
|
27
|
+
pattern: 'summary.md'
|
|
28
|
+
|
|
29
|
+
completion:
|
|
30
|
+
type: metadata
|
|
31
|
+
format: json
|
|
32
|
+
pattern: 'completion.json'
|
|
33
|
+
|
|
34
|
+
inputs:
|
|
35
|
+
type: metadata
|
|
36
|
+
format: json
|
|
37
|
+
pattern: 'inputs.json'
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
Create a comprehensive monthly summary for {{parameters.month}}/{{parameters.year}}.
|
|
2
|
+
|
|
3
|
+
## Output Format
|
|
4
|
+
|
|
5
|
+
# Monthly Summary - {{parameters.month}}/{{parameters.year}}
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
Provide a high-level overview of the month's activities (2-3 sentences).
|
|
9
|
+
|
|
10
|
+
## Key Accomplishments
|
|
11
|
+
List the most important achievements and milestones:
|
|
12
|
+
- [Accomplishment 1]
|
|
13
|
+
- [Accomplishment 2]
|
|
14
|
+
- [Accomplishment 3]
|
|
15
|
+
|
|
16
|
+
## Activity Breakdown
|
|
17
|
+
Summarize activity by category or theme. Use subsections as appropriate:
|
|
18
|
+
|
|
19
|
+
### [Category 1]
|
|
20
|
+
- Brief summary of activities in this category
|
|
21
|
+
|
|
22
|
+
### [Category 2]
|
|
23
|
+
- Brief summary of activities in this category
|
|
24
|
+
|
|
25
|
+
## Challenges and Learnings
|
|
26
|
+
Note any significant challenges faced and what was learned.
|
|
27
|
+
|
|
28
|
+
## Looking Ahead
|
|
29
|
+
Brief note on what this month's work sets up for the future.
|
|
30
|
+
|
|
31
|
+
## Guidelines
|
|
32
|
+
- Be specific with dates, numbers, and metrics when available
|
|
33
|
+
- Focus on impact and outcomes, not just activities
|
|
34
|
+
- Keep each section concise (2-4 sentences or bullet points)
|
|
35
|
+
- Use clear, professional language
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
You are a helpful assistant specializing in creating clear, concise monthly summaries.
|
|
2
|
+
|
|
3
|
+
## Your Role
|
|
4
|
+
- Analyze activity and create meaningful summaries
|
|
5
|
+
- Focus on key accomplishments and important events
|
|
6
|
+
- Maintain a professional yet friendly tone
|
|
7
|
+
|
|
8
|
+
## Your Approach
|
|
9
|
+
- Highlight the most important activities and outcomes
|
|
10
|
+
- Group related items together logically
|
|
11
|
+
- Provide context where helpful
|
|
12
|
+
- Keep summaries focused and actionable
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Release Notes - Advanced Example
|
|
2
|
+
# Demonstrates using context, history, and multiple content sources
|
|
3
|
+
|
|
4
|
+
model: gpt-4o
|
|
5
|
+
temperature: 0.3 # Lower temperature for more factual, consistent output
|
|
6
|
+
|
|
7
|
+
parameters:
|
|
8
|
+
year:
|
|
9
|
+
type: number
|
|
10
|
+
description: Year for the release
|
|
11
|
+
month:
|
|
12
|
+
type: number
|
|
13
|
+
description: Month for the release (1-12)
|
|
14
|
+
version:
|
|
15
|
+
type: string
|
|
16
|
+
description: Version number for this release
|
|
17
|
+
required: false
|
|
18
|
+
|
|
19
|
+
context:
|
|
20
|
+
# Static context: guidelines that don't change
|
|
21
|
+
guidelines:
|
|
22
|
+
type: static
|
|
23
|
+
name: Release Notes Guidelines
|
|
24
|
+
directory: global
|
|
25
|
+
pattern: 'release-guidelines.md'
|
|
26
|
+
|
|
27
|
+
# Previous summary for continuity
|
|
28
|
+
previous_release:
|
|
29
|
+
type: history
|
|
30
|
+
name: Previous Release
|
|
31
|
+
from: summary
|
|
32
|
+
months: 1
|
|
33
|
+
|
|
34
|
+
content:
|
|
35
|
+
# Current month's commits
|
|
36
|
+
commits:
|
|
37
|
+
type: activity
|
|
38
|
+
name: Git Commits
|
|
39
|
+
directory: 'git'
|
|
40
|
+
pattern: 'commits-*.md'
|
|
41
|
+
|
|
42
|
+
# Changelog entries
|
|
43
|
+
changes:
|
|
44
|
+
type: activity
|
|
45
|
+
name: Changes
|
|
46
|
+
directory: 'changes'
|
|
47
|
+
pattern: '*.md'
|
|
48
|
+
|
|
49
|
+
# Bug fixes
|
|
50
|
+
fixes:
|
|
51
|
+
type: activity
|
|
52
|
+
name: Bug Fixes
|
|
53
|
+
directory: 'fixes'
|
|
54
|
+
pattern: '*.md'
|
|
55
|
+
|
|
56
|
+
output:
|
|
57
|
+
summary:
|
|
58
|
+
type: summary
|
|
59
|
+
format: markdown
|
|
60
|
+
name: Release Notes
|
|
61
|
+
pattern: 'RELEASE-NOTES.md'
|
|
62
|
+
|
|
63
|
+
completion:
|
|
64
|
+
type: metadata
|
|
65
|
+
format: json
|
|
66
|
+
pattern: 'completion.json'
|
|
67
|
+
|
|
68
|
+
inputs:
|
|
69
|
+
type: metadata
|
|
70
|
+
format: json
|
|
71
|
+
pattern: 'inputs.json'
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
Generate comprehensive release notes for {{parameters.month}}/{{parameters.year}}{{#parameters.version}} (Version {{parameters.version}}){{/parameters.version}}.
|
|
2
|
+
|
|
3
|
+
## Output Format
|
|
4
|
+
|
|
5
|
+
# Release Notes{{#parameters.version}} - Version {{parameters.version}}{{/parameters.version}}
|
|
6
|
+
|
|
7
|
+
**Release Date**: {{parameters.month}}/{{parameters.year}}
|
|
8
|
+
|
|
9
|
+
## 🌟 Highlights
|
|
10
|
+
|
|
11
|
+
List 3-5 most significant changes or features. Each highlight should:
|
|
12
|
+
- Be a complete sentence explaining the change
|
|
13
|
+
- Focus on user impact and value
|
|
14
|
+
- Include specific version numbers or identifiers where relevant
|
|
15
|
+
|
|
16
|
+
Example:
|
|
17
|
+
- **New API endpoint for batch processing**: Developers can now process up to 100 items in a single request, reducing latency by up to 80%.
|
|
18
|
+
|
|
19
|
+
## ✨ New Features
|
|
20
|
+
|
|
21
|
+
Detailed description of new capabilities added in this release. For each feature:
|
|
22
|
+
- Provide a clear title
|
|
23
|
+
- Explain what it does and why it's useful
|
|
24
|
+
- Include code examples or usage patterns if applicable
|
|
25
|
+
- Note any prerequisites or related changes
|
|
26
|
+
|
|
27
|
+
## 🔧 Improvements
|
|
28
|
+
|
|
29
|
+
Enhancements to existing features. For each improvement:
|
|
30
|
+
- Describe what changed
|
|
31
|
+
- Quantify the improvement where possible (performance gains, reduced errors, etc.)
|
|
32
|
+
- Explain user benefit
|
|
33
|
+
|
|
34
|
+
## 🐛 Bug Fixes
|
|
35
|
+
|
|
36
|
+
Important bugs that were resolved. For each fix:
|
|
37
|
+
- Describe the issue that was fixed
|
|
38
|
+
- Note any symptoms users may have experienced
|
|
39
|
+
- Reference issue numbers if available
|
|
40
|
+
|
|
41
|
+
## ⚠️ Breaking Changes
|
|
42
|
+
|
|
43
|
+
**CRITICAL**: Changes that require user action or may break existing implementations.
|
|
44
|
+
|
|
45
|
+
For each breaking change:
|
|
46
|
+
- Clearly state what changed
|
|
47
|
+
- Explain the impact on existing code
|
|
48
|
+
- Provide migration steps or workarounds
|
|
49
|
+
- Include before/after code examples
|
|
50
|
+
|
|
51
|
+
## 📚 Documentation Updates
|
|
52
|
+
|
|
53
|
+
Significant documentation improvements or additions.
|
|
54
|
+
|
|
55
|
+
## 🙏 Contributors
|
|
56
|
+
|
|
57
|
+
Acknowledge contributors if applicable.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Guidelines
|
|
62
|
+
|
|
63
|
+
### Content Requirements
|
|
64
|
+
- **Be specific**: Include version numbers, dates, metrics, and concrete examples
|
|
65
|
+
- **Show impact**: Explain how each change benefits users
|
|
66
|
+
- **Link liberally**: Reference documentation, issues, and pull requests
|
|
67
|
+
- **Quantify improvements**: Use metrics (performance gains, error reductions, etc.)
|
|
68
|
+
- **Code examples**: Include short, clear code snippets for complex changes
|
|
69
|
+
|
|
70
|
+
### Formatting Standards
|
|
71
|
+
- Use emoji sparingly - only for section headers as shown
|
|
72
|
+
- Keep bullet points concise (1-2 sentences)
|
|
73
|
+
- Use **bold** for feature/change names
|
|
74
|
+
- Use `code formatting` for technical terms, commands, and code
|
|
75
|
+
- Separate breaking changes section if there are ANY breaking changes
|
|
76
|
+
|
|
77
|
+
### Tone Guidelines
|
|
78
|
+
- Professional but accessible
|
|
79
|
+
- Technical accuracy is paramount
|
|
80
|
+
- User-focused language ("you can now..." vs "we added...")
|
|
81
|
+
- Avoid marketing speak or hyperbole
|
|
82
|
+
- Be honest about limitations or known issues
|
|
83
|
+
|
|
84
|
+
### Quality Checklist
|
|
85
|
+
Before finalizing, ensure:
|
|
86
|
+
- [ ] All version numbers are correct and consistent
|
|
87
|
+
- [ ] Breaking changes are clearly marked and explained
|
|
88
|
+
- [ ] Migration steps are provided for breaking changes
|
|
89
|
+
- [ ] Code examples are tested and accurate
|
|
90
|
+
- [ ] Links to documentation are valid
|
|
91
|
+
- [ ] Dates are accurate
|
|
92
|
+
- [ ] Content is organized from most to least important
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
You are an expert technical writer with 10+ years of experience creating release notes for developer tools and APIs.
|
|
2
|
+
|
|
3
|
+
## Your Expertise
|
|
4
|
+
- Clear, precise technical communication
|
|
5
|
+
- Deep understanding of software development lifecycle
|
|
6
|
+
- Ability to explain complex changes to diverse audiences
|
|
7
|
+
- Strong attention to detail and accuracy
|
|
8
|
+
|
|
9
|
+
## Your Style
|
|
10
|
+
- Professional and technical but accessible
|
|
11
|
+
- Fact-based and specific - avoid vague statements
|
|
12
|
+
- User-focused: explain impact and value
|
|
13
|
+
- Concise without sacrificing clarity
|
|
14
|
+
|
|
15
|
+
## Your Audience
|
|
16
|
+
Understanding your audience is critical:
|
|
17
|
+
- **Primary**: Developers using the product
|
|
18
|
+
- **Secondary**: Technical managers and DevOps engineers
|
|
19
|
+
- **Tertiary**: Non-technical stakeholders
|
|
20
|
+
|
|
21
|
+
## Your Principles
|
|
22
|
+
1. **Clarity First**: Technical accuracy with clear explanations
|
|
23
|
+
2. **User Impact**: Always explain "why this matters"
|
|
24
|
+
3. **Completeness**: Cover all significant changes
|
|
25
|
+
4. **Consistency**: Follow established format and style
|
|
26
|
+
5. **Accuracy**: Verify version numbers, dates, and technical details
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Team Update - Parameter Usage Example
|
|
2
|
+
# Demonstrates dynamic configuration using parameters
|
|
3
|
+
|
|
4
|
+
model: gpt-4o-mini
|
|
5
|
+
temperature: 0.7
|
|
6
|
+
maxCompletionTokens: 3000
|
|
7
|
+
|
|
8
|
+
parameters:
|
|
9
|
+
year:
|
|
10
|
+
type: number
|
|
11
|
+
description: Year for the update
|
|
12
|
+
month:
|
|
13
|
+
type: number
|
|
14
|
+
description: Month for the update (1-12)
|
|
15
|
+
team:
|
|
16
|
+
type: string
|
|
17
|
+
description: Team name
|
|
18
|
+
required: true
|
|
19
|
+
include_metrics:
|
|
20
|
+
type: boolean
|
|
21
|
+
description: Whether to include metrics section
|
|
22
|
+
default: true
|
|
23
|
+
|
|
24
|
+
content:
|
|
25
|
+
# Team-specific activity using parameter
|
|
26
|
+
team_activity:
|
|
27
|
+
type: activity
|
|
28
|
+
name: Team Activity
|
|
29
|
+
directory: 'teams/{{parameters.team}}'
|
|
30
|
+
pattern: '*.md'
|
|
31
|
+
|
|
32
|
+
# All team activities for context
|
|
33
|
+
all_teams:
|
|
34
|
+
type: activity
|
|
35
|
+
name: Organization Activity
|
|
36
|
+
directory: 'teams'
|
|
37
|
+
pattern: '**/*.md'
|
|
38
|
+
|
|
39
|
+
output:
|
|
40
|
+
summary:
|
|
41
|
+
type: summary
|
|
42
|
+
format: markdown
|
|
43
|
+
name: Team Update
|
|
44
|
+
pattern: '{{parameters.team}}-update.md'
|
|
45
|
+
|
|
46
|
+
completion:
|
|
47
|
+
type: metadata
|
|
48
|
+
format: json
|
|
49
|
+
pattern: 'completion.json'
|
|
50
|
+
|
|
51
|
+
inputs:
|
|
52
|
+
type: metadata
|
|
53
|
+
format: json
|
|
54
|
+
pattern: 'inputs.json'
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
Create an internal team update for the **{{parameters.team}}** team covering {{parameters.month}}/{{parameters.year}}.
|
|
2
|
+
|
|
3
|
+
## Output Format
|
|
4
|
+
|
|
5
|
+
# {{parameters.team}} Team Update - {{parameters.month}}/{{parameters.year}}
|
|
6
|
+
|
|
7
|
+
## 🎯 This Month in Brief
|
|
8
|
+
|
|
9
|
+
A 2-3 sentence executive summary of the month. What's the main story?
|
|
10
|
+
|
|
11
|
+
## 🎉 Wins & Accomplishments
|
|
12
|
+
|
|
13
|
+
Highlight what the team achieved this month:
|
|
14
|
+
- **[Achievement 1]**: Brief description and why it matters
|
|
15
|
+
- **[Achievement 2]**: Brief description and impact
|
|
16
|
+
- **[Achievement 3]**: Brief description and value delivered
|
|
17
|
+
|
|
18
|
+
Focus on:
|
|
19
|
+
- Completed projects or milestones
|
|
20
|
+
- Problems solved
|
|
21
|
+
- Improvements delivered
|
|
22
|
+
- Collaboration wins
|
|
23
|
+
|
|
24
|
+
## 🚧 Challenges & Blockers
|
|
25
|
+
|
|
26
|
+
Be honest about difficulties:
|
|
27
|
+
- **[Challenge 1]**: What's the issue and what's being done about it
|
|
28
|
+
- **[Blocker 1]**: What's blocked and what help is needed
|
|
29
|
+
|
|
30
|
+
This section builds trust through transparency.
|
|
31
|
+
|
|
32
|
+
## 📊 Team Health & Morale
|
|
33
|
+
|
|
34
|
+
Quick pulse check on the team:
|
|
35
|
+
- Overall team energy and morale
|
|
36
|
+
- Capacity and workload observations
|
|
37
|
+
- Any concerns or celebrations
|
|
38
|
+
- Team dynamic and collaboration notes
|
|
39
|
+
|
|
40
|
+
{{#parameters.include_metrics}}
|
|
41
|
+
## 📈 Key Metrics
|
|
42
|
+
|
|
43
|
+
Quantifiable measures of progress:
|
|
44
|
+
- **Velocity**: [metric and trend]
|
|
45
|
+
- **Quality**: [metric and trend]
|
|
46
|
+
- **Cycle Time**: [metric and trend]
|
|
47
|
+
- **Custom metrics**: [relevant to this team]
|
|
48
|
+
|
|
49
|
+
Include brief context for any significant changes.
|
|
50
|
+
{{/parameters.include_metrics}}
|
|
51
|
+
|
|
52
|
+
## 🔮 Looking Ahead
|
|
53
|
+
|
|
54
|
+
What's coming in the next period:
|
|
55
|
+
- **Top priorities**: What the team is focusing on
|
|
56
|
+
- **Key milestones**: Important dates or deliverables
|
|
57
|
+
- **Dependencies**: What the team needs from others
|
|
58
|
+
- **Opportunities**: Exciting possibilities on the horizon
|
|
59
|
+
|
|
60
|
+
## 💡 Asks & Needs
|
|
61
|
+
|
|
62
|
+
Be specific about what would help the team:
|
|
63
|
+
- Resources needed
|
|
64
|
+
- Decisions required
|
|
65
|
+
- Support from other teams
|
|
66
|
+
- Clarifications or guidance needed
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Guidelines
|
|
71
|
+
|
|
72
|
+
### Content Balance
|
|
73
|
+
- **Accomplishments**: Celebrate wins without being boastful
|
|
74
|
+
- **Challenges**: Be honest but constructive - focus on solutions
|
|
75
|
+
- **Metrics**: Use data to tell the story, not just report numbers
|
|
76
|
+
- **Forward-looking**: Balance reflection with future focus
|
|
77
|
+
|
|
78
|
+
### Tone & Style
|
|
79
|
+
- Conversational but professional
|
|
80
|
+
- Use "we" and "team" language
|
|
81
|
+
- Avoid jargon unless necessary
|
|
82
|
+
- Be specific with examples
|
|
83
|
+
- Show, don't just tell
|
|
84
|
+
|
|
85
|
+
### What to Include
|
|
86
|
+
- Specific examples and outcomes
|
|
87
|
+
- Context for why things matter
|
|
88
|
+
- Names of team members (celebrate contributions)
|
|
89
|
+
- Cross-team collaboration highlights
|
|
90
|
+
- Learning and growth moments
|
|
91
|
+
|
|
92
|
+
### What to Avoid
|
|
93
|
+
- Vague statements without examples
|
|
94
|
+
- Blame or negativity without solutions
|
|
95
|
+
- Overly technical details
|
|
96
|
+
- Comparisons to other teams
|
|
97
|
+
- Downplaying legitimate challenges
|
|
98
|
+
|
|
99
|
+
### Quality Standards
|
|
100
|
+
- Be honest and balanced
|
|
101
|
+
- Provide actionable insights
|
|
102
|
+
- Make asks clear and specific
|
|
103
|
+
- Celebrate people and collaboration
|
|
104
|
+
- Keep it human and relatable
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
You are a supportive team lead creating an internal update for stakeholders within the organization.
|
|
2
|
+
|
|
3
|
+
## Your Role
|
|
4
|
+
- Communicate team progress and achievements
|
|
5
|
+
- Provide transparency about challenges and blockers
|
|
6
|
+
- Foster understanding and alignment across the organization
|
|
7
|
+
- Maintain team morale through balanced, constructive communication
|
|
8
|
+
|
|
9
|
+
## Your Tone
|
|
10
|
+
- Conversational yet professional
|
|
11
|
+
- Honest and transparent about challenges
|
|
12
|
+
- Celebratory of achievements without being boastful
|
|
13
|
+
- Forward-looking and solution-oriented
|
|
14
|
+
|
|
15
|
+
## Your Audience
|
|
16
|
+
You're writing for:
|
|
17
|
+
- Team members (keeping everyone aligned)
|
|
18
|
+
- Leadership (providing visibility)
|
|
19
|
+
- Other teams (enabling collaboration)
|
|
20
|
+
- Stakeholders (building confidence)
|
|
21
|
+
|
|
22
|
+
## Communication Principles
|
|
23
|
+
1. **Transparency**: Be honest about progress and challenges
|
|
24
|
+
2. **Balance**: Celebrate wins while acknowledging difficulties
|
|
25
|
+
3. **Context**: Explain why things matter
|
|
26
|
+
4. **Actionability**: Highlight next steps and needs
|
|
27
|
+
5. **Humanity**: Remember these are people doing meaningful work
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Weekly Summary Template
|
|
2
|
+
# This template creates weekly summaries from activity files
|
|
3
|
+
# Weeks run Sunday through Saturday, starting from the first Sunday of the year
|
|
4
|
+
|
|
5
|
+
model: gpt-4o-mini
|
|
6
|
+
temperature: 0.7
|
|
7
|
+
|
|
8
|
+
parameters:
|
|
9
|
+
year:
|
|
10
|
+
type: number
|
|
11
|
+
description: Year for the summary
|
|
12
|
+
week:
|
|
13
|
+
type: number
|
|
14
|
+
description: Week number for the summary (1-53)
|
|
15
|
+
|
|
16
|
+
# Empty context section (required even if not used)
|
|
17
|
+
# Add historical context by uncommenting:
|
|
18
|
+
# context:
|
|
19
|
+
# previous_week:
|
|
20
|
+
# type: history
|
|
21
|
+
# name: Previous Week Summary
|
|
22
|
+
# from: summary
|
|
23
|
+
# weeks: 1
|
|
24
|
+
|
|
25
|
+
context: {}
|
|
26
|
+
|
|
27
|
+
content:
|
|
28
|
+
activity:
|
|
29
|
+
type: activity
|
|
30
|
+
name: Weekly Activity
|
|
31
|
+
directory: 'notes'
|
|
32
|
+
pattern: '*.md'
|
|
33
|
+
|
|
34
|
+
output:
|
|
35
|
+
summary:
|
|
36
|
+
type: summary
|
|
37
|
+
format: markdown
|
|
38
|
+
name: Weekly Summary
|
|
39
|
+
pattern: 'summary.md'
|
|
40
|
+
|
|
41
|
+
completion:
|
|
42
|
+
type: metadata
|
|
43
|
+
format: json
|
|
44
|
+
pattern: 'completion.json'
|
|
45
|
+
|
|
46
|
+
inputs:
|
|
47
|
+
type: metadata
|
|
48
|
+
format: json
|
|
49
|
+
pattern: 'inputs.json'
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
Create a comprehensive weekly summary for week {{parameters.week}} of {{parameters.year}}.
|
|
2
|
+
|
|
3
|
+
## Output Format
|
|
4
|
+
|
|
5
|
+
# Weekly Summary - Week {{parameters.week}} of {{parameters.year}}
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
Provide a high-level overview of the week's activities (2-3 sentences).
|
|
9
|
+
|
|
10
|
+
## Key Accomplishments
|
|
11
|
+
List the most important achievements and milestones:
|
|
12
|
+
- [Accomplishment 1]
|
|
13
|
+
- [Accomplishment 2]
|
|
14
|
+
- [Accomplishment 3]
|
|
15
|
+
|
|
16
|
+
## Activity Breakdown
|
|
17
|
+
Summarize activity by category, theme, or day. Use subsections as appropriate:
|
|
18
|
+
|
|
19
|
+
### [Category/Theme 1]
|
|
20
|
+
- Brief summary of activities in this area
|
|
21
|
+
|
|
22
|
+
### [Category/Theme 2]
|
|
23
|
+
- Brief summary of activities in this area
|
|
24
|
+
|
|
25
|
+
## Important Decisions and Insights
|
|
26
|
+
Note any significant decisions made or insights gained during the week.
|
|
27
|
+
|
|
28
|
+
## Recurring Themes or Patterns
|
|
29
|
+
Identify any patterns, recurring topics, or trends observed across the week.
|
|
30
|
+
|
|
31
|
+
## Looking Ahead
|
|
32
|
+
Brief note on what this week's work sets up for next week or the near future.
|
|
33
|
+
|
|
34
|
+
## Guidelines
|
|
35
|
+
- Be specific with dates and details when available
|
|
36
|
+
- Focus on impact and outcomes, not just activities
|
|
37
|
+
- Keep each section concise (2-4 sentences or bullet points)
|
|
38
|
+
- Use clear, professional language
|
|
39
|
+
- Highlight connections between different activities when relevant
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
You are a helpful assistant specializing in creating clear, insightful weekly summaries.
|
|
2
|
+
|
|
3
|
+
## Your Role
|
|
4
|
+
- Analyze weekly activity and create meaningful summaries
|
|
5
|
+
- Focus on key accomplishments and important events
|
|
6
|
+
- Identify patterns and recurring themes
|
|
7
|
+
- Maintain a professional yet friendly tone
|
|
8
|
+
|
|
9
|
+
## Your Approach
|
|
10
|
+
- Highlight the most important activities and outcomes
|
|
11
|
+
- Group related items together logically
|
|
12
|
+
- Provide context where helpful
|
|
13
|
+
- Keep summaries focused and actionable
|
|
14
|
+
- Note any trends or patterns across the week
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
model: gpt-4o
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
model: gpt-4o
|
|
2
|
+
temperature: 0.7
|
|
3
|
+
maxCompletionTokens: 4096
|
|
4
|
+
parameters:
|
|
5
|
+
year:
|
|
6
|
+
type: number
|
|
7
|
+
description: The year to summarize
|
|
8
|
+
required: true
|
|
9
|
+
month:
|
|
10
|
+
type: number
|
|
11
|
+
description: The month to summarize
|
|
12
|
+
required: true
|
|
13
|
+
context:
|
|
14
|
+
people:
|
|
15
|
+
directory: ./people
|
|
16
|
+
projects:
|
|
17
|
+
directory: ./projects
|
|
18
|
+
content:
|
|
19
|
+
emails:
|
|
20
|
+
directory: email
|
|
21
|
+
pattern: "**/*.txt"
|
|
22
|
+
output:
|
|
23
|
+
summary:
|
|
24
|
+
type: summary
|
|
25
|
+
format: markdown
|
|
26
|
+
name: Emails Summary
|
|
27
|
+
pattern: "emails-summary.md"
|
|
28
|
+
completion:
|
|
29
|
+
type: completion
|
|
30
|
+
format: json
|
|
31
|
+
name: Emails Summary Completion
|
|
32
|
+
pattern: "emails-summary.completion.json"
|
|
33
|
+
inputs:
|
|
34
|
+
type: inputs
|
|
35
|
+
format: json
|
|
36
|
+
name: Emails Summary Inputs
|
|
37
|
+
pattern: "emails-summary.inputs.json"
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
Please analyze the following monthly email content and create a summary of the emails received and sent in the month {{parameters.month}}/{{parameters.year}}.
|
|
2
|
+
|
|
3
|
+
Use the provided context to enhance the analysis.
|
|
4
|
+
|
|
5
|
+
The email data will be presented as text files that adhere to the following structure:
|
|
6
|
+
|
|
7
|
+
Subject: <message subject>
|
|
8
|
+
Date: <date received or sent>
|
|
9
|
+
From: <from email address>
|
|
10
|
+
To: <one or more recipients>
|
|
11
|
+
|
|
12
|
+
<message body>
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
The output format should adhere to the following Markdown:
|
|
16
|
+
|
|
17
|
+
# Email Summary for <month> <year>
|
|
18
|
+
|
|
19
|
+
## Email Summary for <owner>>/<reposiory> in <month> <year>
|
|
20
|
+
Total emails in <owner>>/<reposiory> for <month> <year>: <total emails>
|
|
21
|
+
|
|
22
|
+
- Emails Received: <number of emails received>
|
|
23
|
+
- Emails Sent: <number of emails sent>
|
|
24
|
+
|
|
25
|
+
<content generated>
|
|
26
|
+
|
|
27
|
+
EVERY header must contain the terms "Emails in <month> <year>" - for example, if there is a header for an "Overview" it should be "Overview of Emails in <month> <year>". Or if there is a header, "Analysis of Technology Trends" it should be "Analysis of Technology Trends in Emails in <month> <year>". It is important for the headers to be explicit because the output may be combined with data from other months.
|
|
28
|
+
|
|
29
|
+
In the context, there will be two types of files - files from "received" are the emails that were received, and emails in "sent" are the emails that were sent.
|
|
30
|
+
|
|
31
|
+
# Guidance for Analysis
|
|
32
|
+
|
|
33
|
+
This analysis is looking for trends related to the activity for issues in the array of projects that have been presented.
|
|
34
|
+
|
|
35
|
+
Try to identify relationships between emails and identify important emails senders.
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
You are an expert at analyzing documents and creating summaries.
|
|
2
|
+
|
|
3
|
+
Please analyze the provided monthly content and create a summary of key topics and themes discussed.
|
|
4
|
+
|
|
5
|
+
When generating a summary, don't put too much context into the summary.
|
|
6
|
+
|
|
7
|
+
For example, don't reference the founder's name or talk about about the goals for that person.
|
|
8
|
+
|
|
9
|
+
Also, assume that the person reading this summary has a basic understanding of what the projects are.
|
|
10
|
+
|
|
11
|
+
This summary is for the team.
|
|
12
|
+
|
|
13
|
+
I really am not looking for useless buzzwords and sterile corporate report. Instead what I'm looking for is more direct and actionable information.
|