Release note

2 min read

A release note informs users about updates, enhancements, and bug fixes in a new product version. In this guide, you’ll see general guidelines on how to write a release note and the release note template.

Make sure to review the guidelines in the Best practices for writing documentation.

Writing a release note

Topic	Description
Introduction	Start the first paragraph with an overview, explaining the change and its impact. Ensure the reader immediately understands how the changes presented in the release note will affect their store operations.
"What has changed?"	Explain the changes introduced by the release.
"Why did we make this change?"	Explain what motivated VTEX to create it and the issues that were solved.
"What needs to be done?"	Guide readers on how to leverage these new capabilities or adapt to changes. Add a call to action to direct the reader to additional information.

Release note template

Release notes must have the following tags at their beginning:

Tag name	Icon	Description
`added`	`+`	New features, functionalities, or components introduced in the release.
`deprecated`	`➖`	A feature, function, or component is no longer recommended for use.
`info`	`ℹ`	Important information or updates that aren't tied to specific changes but are relevant for users.
`fixed`	`✔`	Bugs or issues that have been solved in the release.
`removed`	`x`	A feature, functionality, or component has been eliminated.
`improved`	`^`	Enhancements or optimizations made to existing features or products.

Release Note template

# Feature name: summary
 
We created/modified this feature to <insert the key benefit> so you can <job to be done>.

## What has changed?

Before, you had to <how the user used to solve the problem>. Now, you have this <new button/screen/experience> where you can <benefit>.

## Why did we make this change?

In order to <facilitate your job to be done>, we developed <subject>. This is available for <specific or general users?>.

## What needs to be done?
To <use this new resource> you have to <install something or adjust a configuration.>

To learn more <about the feature/module/product>, see <the article>.

See release note examples in the Developer Portal.