# Changelog Writing

> Changelog and release notes writing patterns including versioning communication and user-facing updates.

- Skill: `dragoon0x/changelog-writing` (Agent Skill)
- Install (CLI): `npx skillmds@latest add dragoon0x/changelog-writing`
- Raw SKILL.md: https://api.skillmd.com/api/skills/dragoon0x/changelog-writing/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: dragoon0x (https://skillmd.com/u/dragoon0x)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/dragoon0x/changelog-writing

---


# Changelog Writing

## Changelog Format

### User-Facing
- Lead with benefit: "You can now export to PDF" not "Added PDF export module."
- Group: New, Improved, Fixed.
- Skip internal changes users don't care about.
- Link to docs for new features.

### Developer-Facing
- Follow Keep a Changelog format.
- Group: Added, Changed, Deprecated, Removed, Fixed, Security.
- Reference issue/PR numbers.
- Highlight breaking changes prominently.

## Semantic Versioning Communication
- **Major (2.0):** "Big update" — migration guide required.
- **Minor (1.5):** "New features" — backwards compatible.
- **Patch (1.5.1):** "Bug fixes" — no new features.

## Anti-Patterns
- "Various bug fixes and performance improvements" — be specific.
- Technical jargon in user-facing notes.
- No date on entries.
- Changelog that's just git commit messages.