Menu
Guides
Grammar
Formatting
Interface copy
Documentation
Glossary
Headings and titles
2 min read

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 projectFastStore 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 categoryCreate 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 categoryCloning the repository created
Install the VTEX IO CLI on your machineInstalling the VTEX IO CLI on your machine

Use sentence case, except with proper nouns.

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

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

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

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

Do ✅Don't ❌
How does promotion proration work?How does promotion proration work
What needs to be done?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 not use highlight expressions and generic words, such as attention, details, important observations, and examples.

Do ✅Don't ❌
Site Editor schema examplesExamples

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 RulesVTEX 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:
  1. Create a seller
  2. Edit a seller
In this article, you will learn to:
  1. Creating a seller
  2. Editing a seller

In the actual heading, use -ing.

Do ✅Don't ❌
Creating a sellerCreate a seller
Editing a sellerEdit a seller
Contributors
0
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
0
On this page
GithubComunityFeedback