Announcement

2 min read

An announcement informs users about new features, improvements, bug fixes, and other product and system updates. In this guide, you’ll see general guidelines, the announcement template, and examples.

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

Writing an announcement

Topic	Description
Introduction	Start the first paragraph with an overview, explaining the change and its significant impact for merchants or customers. Make sure the reader immediately understands how the announcement will affect their store operations. Mention the region (for example, Global, Brazil, LATAM, APAC, US, or EMEA) and the product phase (Beta, Alpha, or General Availability) in the introduction paragraph.
Heading titles	Make sure the heading titles follow the standard text in all locales.
"What has changed?"	Explain the use case.
"Why did we make this change?"	Explain what motivates VTEX to create it and make a list using bullet points to explain the business problems that are solved.
"What needs to be done?"	Guide readers on how to leverage these new capabilities as fast as they can. Add a call to action to direct the reader to more information.

Announcement template

Announcement template

# Feature name + benefit
 
We created/modified this feature to <insert the key benefit> so you can <job to be done>. It's available in <, Alpha, Beta, for a specific country, or for all users (general availability)>.

## What has changed?

Previously, you had to <how the user used to solve the problem>. Now, you have this <new button/screen> 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?> in <the name of the module>. The key benefits are:

- Key benefit 1
- Key benefit 2
- Key benefit 3

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

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

ℹ Find examples of announcement articles on the Help Center.