Headings and titles

General

Headings and titles

Headings and titles must be descriptive, as short as possible, and generally convey only one main action.

Make the learning objective of the article clear, preferably with only one verb.

Do ✅	Don't ❌
Starting a new FastStore project	FastStore project

When the title or heading starts with a verb, use it in the -ing form.

Do ✅	Don't ❌
Creating a specification group in a category	Create a specification group in a category

In texts where titles are commands for the user, use the imperative.

Do ✅	Don't ❌
Create a specification group in a category Install the VTEX IO CLI on your machine	Cloning the repository created Installing the VTEX IO CLI on your machine

Use sentence case, except with proper nouns.

Do ✅	Don't ❌
Setting up the Notify me option Configuring Price Divergence rule Order flow and status	Setting up the notify me option Configuring Price Divergence Rule Order Flow and Status

Do not use a full stop ( . ), bold, interrogation and exclamation marks, or italic.

Do ✅	Don't ❌
Managing shipping rates Creating synonyms Events available in Audit	Managing shipping rates. Creating synonyms Events available in Audit

An interrogation mark (?) can be used in FAQs and Announcements.

Do ✅	Don't ❌
How does promotion proration work? What needs to be done?	How does promotion proration work What needs to be done

When using an abbreviation or acronym in a heading or title, spell out the abbreviation in the first paragraph that follows the heading or title.

Do ✅	Don't ❌
Configuring SEO in your Store Framework store SEO (Search Engine Optimization) is one of the most important strategies to better position your site on organic search engine results pages.	Configuring SEO in your Store Framework store SEO is one of the most important strategies to better position your site on organic search engine results pages.

Do ✅

Don't ❌

Configuring SEO in your Store Framework store

SEO (Search Engine Optimization) is one of the most important strategies to better position your site on organic search engine results pages.

Configuring SEO in your Store Framework store

SEO is one of the most important strategies to better position your site on organic search engine results pages.

Do not use highlight expressions and generic words, such as attention, details, important observations, and examples.

Do ✅	Don't ❌
Site Editor schema examples	Examples

If your title includes a colon (:), treat the two parts of your title as one sentence each, meaning both parts will be capitalized using a sentence case.

Do ✅	Don't ❌
VTEX Intelligent Search: New visual editor for Merchandising Rules	VTEX Intelligent Search: new visual editor for Merchandising Rules

When listing section headings, use the infinitive.

Do ✅	Don't ❌
In this article, you will learn to: Create a seller Edit a seller	In this article, you will learn to: Creating a seller Editing a seller

In the actual heading, use -ing.

Do ✅	Don't ❌
Creating a seller Editing a seller	Create a seller Edit a seller