Writing practice / Template
Write release notes around user impact
Explain what changed, who is affected, and what to do next.
Use an impact-led entry
Name the change in plain language. Explain the previous limitation, the new behavior, and the affected audience. Include the version or release date and link to the relevant instructions.
Reusable template
Title: [User-visible change]. Available in: [Version/date]. Affects: [Audience or configuration]. What changed: [Old and new behavior]. Action required: [Steps, or none]. Learn more: [Guide]. Verification: [Owner and confirmed evidence].
Handle breaking changes explicitly
Describe the compatibility impact, the migration path, and the relevant deadline only when confirmed. Include a tested example if it makes the change easier to apply. Separate known issues from fixed issues.
Review before publication
Compare the entry with the actual release. Remove internal shorthand and unverified claims. Confirm links, product availability, and any required actions with the release owner.
Sources & further reading
Original guidance and examples by TechWriter, informed by these resources.