Skip to content

Commit a1642f4

Browse files
authored
docs(skills): refine release notes tone guidelines to favor clarity over marketing language (#2982)
1 parent 2167bee commit a1642f4

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

  • .forge/skills/write-release-notes

.forge/skills/write-release-notes/SKILL.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Generate engaging, high-energy release notes for a given version ta
55

66
# Write Release Notes
77

8-
Generate compelling, high-energy release notes by pulling live data from GitHub and synthesizing every PR into a cohesive narrative.
8+
Generate clear, informative, and enthusiastic release notes by pulling live data from GitHub and synthesizing every PR into a cohesive narrative.
99

1010
## Workflow
1111

@@ -40,23 +40,23 @@ Dependency bumps (e.g. Dependabot PRs) go into Maintenance. Skip PRs with `error
4040

4141
### 3. Write the Release Notes
4242

43-
Produce a Markdown document with the following structure. Keep the tone **exciting, punchy, and developer-friendly**celebrate wins, highlight impact, and make readers feel the momentum.
43+
Produce a Markdown document with the following structure. Keep the tone **informative and enthusiastic**explain what changed and why it matters, without resorting to marketing fluff.
4444

4545
```markdown
46-
# [Product Name] [Version][Punchy Tagline]
46+
# [Product Name] [Version][Descriptive Tagline]
4747

48-
> One-sentence hook that captures the spirit of this release.
48+
> One-sentence summary of what this release focuses on.
4949
5050
## What's New
5151

52-
[2-4 sentence narrative that weaves together the biggest features and fixes.
53-
Speak to impact, not implementation. Use active voice. Be enthusiastic.]
52+
[2-4 sentence narrative covering the biggest features and fixes.
53+
Describe what changed and what users can now do. Use active voice. Be factual but upbeat.]
5454

5555
## Highlights
5656

5757
### [Feature/Fix Category]
58-
**[PR Title rephrased as user benefit]**
59-
[1-2 sentences expanding on the PR description. Focus on what the user gains.
58+
**[PR Title rephrased as a clear description of the change]**
59+
[1-2 sentences expanding on the PR description. Explain what changed and what users can now do differently.
6060
If the PR body has useful context, distill it. If empty, infer from the title.]
6161

6262
[Repeat for each significant PR — skip pure chores/dep bumps unless noteworthy]
@@ -80,13 +80,14 @@ A huge thank you to everyone who made this release happen: [list @handles — ex
8080

8181
### 4. Tone & Style Guidelines
8282

83-
- **Lead with value**: "You can now..." beats "We added..."
84-
- **Be specific**: Name the feature, not just the category
85-
- **Use energy words**: "blazing", "seamless", "rock-solid", "powerful", "finally"
83+
- **Lead with what changed**: "You can now..." or "Forge now..." beats "We added..."
84+
- **Be specific**: Name the feature and describe what it does, not just the category
85+
- **Be informative, not marketty**: Avoid vague adjectives like "seamless", "smarter", "blazing", "powerful", "rock-solid". Instead, state the concrete fact (e.g. "editor no longer spawns a git process on every keystroke" beats "blazing-fast editor")
86+
- **Enthusiasm through substance**: Let the actual improvement speak for itself. Use active, direct language.
8687
- **Short paragraphs**: Max 3 sentences per block
8788
- **Skip internal jargon**: Translate crate names and internal concepts into plain language
88-
- **Celebrate contributors**: Name them enthusiastically
89-
- **Tagline formula**: `[Version] — [Adjective] [Theme]` (e.g. "v1.32.0 — Smarter Config, Smoother Workflows")
89+
- **Celebrate contributors**: Name them by handle
90+
- **Tagline formula**: `[Version] — [Factual Theme Description]` (e.g. "v1.32.0 — Terminal Context, File Drop Support, Windows Performance")
9091
- **No implementation details**: Do not mention internal module names, struct names, function names, crate names, or how something was implemented. Focus purely on what the user experiences or gains.
9192
- **No PR/issue references**: Do not include PR numbers, issue numbers, or links to GitHub PRs/issues in the release notes. Focus on the changes themselves, not their tracking identifiers.
9293

0 commit comments

Comments
 (0)