How do I publish release notes and a changelog for my product?

Before you start

• This feature is made for Help Center and Product Docs sites. It is on by default for the Software or SaaS starting point. A site of another kind can't add it.
• You need permission to manage the help centre.

Steps

1. Open Stories and choose Release notes. This opens the list of release notes.
2. Choose New.
3. Fill in Title, version and releasedOn, the date the version came out. These three are required.
4. Optional: Summary, up to 1,000 characters, and Link to a longer page.
5. Add one line for each change in the list field. In this form that list is shown as Moments. Choose its Kind: New, Improved or Fixed. Write the text in up to 300 characters. You can add up to 100 lines.
6. Put the note in the section of the right hub, then publish.

The form shows these support fields by their short names, such as version and releasedOn, instead of full sentences.

Good to know

• Order. Notes are listed newest release date first.
• Per hub. A hub's page lists the notes of its own section and topics.
• RSS. Readers can follow the changelog as a feed. The feed is at the address ending /help/release-notes.rss on your site.
• Search data. Each note is described to search engines as a technical article with its version. Nothing guarantees a special search display.
• Write for your reader. Say what changed for them, in plain words.

Questions

Related

• Known issues and notices
• Help hubs
• Help centre and product docs
• Jobs, events & more