When to use it

Publish release notes with every version you ship, whether it is a major release or a small patch. Users and administrators read them to decide when to upgrade, and support teams read them to answer questions afterwards. A PDF copy is useful for customers who need release documentation for audits, change approval or an offline archive.

What is inside

• A title with a fill-in field for your project, followed by the version number and release date.
• Highlights, then separate added, improved and fixed lists in the familiar changelog order.
• Numbered upgrade notes, a known issues section and a feedback line with a fill-in field for your email.

Tips for a better document

• Describe fixes by the behavior users will now see, not by the internal cause. They care that exports no longer fail, not which function was patched.
• Put anything that needs action, such as a backup or a configuration change, in the upgrade notes and mention it in the highlights too. The Technical style keeps version numbers and commands easy to scan.