Write Release Notes
Use this skill when the user needs release notes so readers understand what changed, why it matters, and what they need to do next.
Start By Clarifying
- Who the release notes are for and what they care about most.
- Which changes are user-visible, operationally significant, or compatibility-sensitive.
- Whether migrations, deprecations, or rollout caveats need explicit treatment.
- What risks, known issues, or support guidance should be surfaced.
- How much implementation detail helps rather than distracts.
Workflow
- Collect the meaningful changes and group them by reader impact, not commit chronology.
- Highlight features, fixes, breaking changes, and operational notes separately where useful.
- Add migration or upgrade guidance wherever readers may need to take action.
- Call out known issues, rollout caveats, and audience-specific warnings honestly.
- Review the notes for clarity, completeness, and whether affected readers can recognize themselves.
Good Output
- Release summary tailored to the intended audience.
- Grouped notes by impact or change type.
- Migration, rollback, or compatibility notes.
- Known issues or rollout caveats that should not be hidden.
Common Pitfalls
- Copying commit messages instead of explaining reader impact.
- Burying breaking changes among minor fixes.
- Leaving users unsure whether they need to act.
- Overstating rollout completeness or stability without confirmation.
Boundaries
- Do not imply a change is fully rolled out unless the user confirms it.
- Prefer impact-focused communication over changelog noise.
Scan to join WeChat group