Skip to content

Release notes

Adrià Castany 2 min

What are release notes?

Release notes are the public, dated record of what changes in a product. Each entry says what is new, what has improved and what has been fixed, in the customer’s words. They exist so that customers know what has changed without having to ask.

Also called

changelog, product updates, what’s new

Topic
Support concepts
On this page
  1. Changelog and release notes
  2. Why it matters
  3. What an entry contains
  4. Types of change
  5. What does not belong in release notes
  6. Where to publish them
  7. How Intake handles it
  8. Frequently asked questions

Changelog and release notes

In technical teams the changelog is the full list of changes in each version, written for developers, and release notes are the summary for users.

In business products both names are used for the same thing, the updates page.

Why it matters

Every change a customer discovers alone is a support request or an unpleasant surprise.

Release notes reduce both, and they also show whoever pays that the product is moving. A customer who sees nothing new for months starts to wonder why they keep paying.

What an entry contains

A release-notes entry contains five things, and the second is what makes it useful.

  • The date and, where it applies, the version number.
  • What the customer can now do that they could not before.
  • Who it affects, by plan or by feature.
  • What the customer has to do, if anything.
  • An image or a link to the documentation.

Types of change

Changes are usually grouped into four types.

  • New. Features that did not exist.
  • Improved. Changes to something that already existed.
  • Fixed. Bugs resolved.
  • Action required. Whatever stops working the same way and makes the customer do something.

What does not belong in release notes

Internal changes customers do not notice do not belong, and neither does a price rise or a change of terms.

Those are communicated separately, in advance and directly to whoever is affected.

Where to publish them

Release notes go on a page of their own and are taken to where customers already are.

Inside the product, in a regular email and, for support, as an internal heads-up before the change reaches customers.

How Intake handles it

Frequently asked questions

What is a changelog?

A product’s record of changes, ordered by date. In business products it is the updates page that says what has been added, improved and fixed.

How often should release notes be published?

At the pace the product changes. Regularity matters most. A page updated every two weeks says more than one with many entries and the last one six months old.

Who writes release notes?

Product knows the change and support knows the customer’s words. What works is product drafting and support reviewing before publishing, since support will receive the questions.

Does every change need announcing?

Every change customers can notice. Those that make them do something are also announced by email and in advance, not only on the updates page.

Glossary

Keep reading

Glossary

Related terms

See the full glossary

Add it without dropping what you use

15 minutes, no commitment