General
Use sentence case capitalization for documentation, including headings and all UI elements. This means capitalizing only the first letter of the first word in a sentence or phrase, except for proper nouns and acronyms.
Do ✅ | Don't ❌ |
---|---|
Create account | Create Account |
Try new experience | Try New Experience |
Getting started with Ad Network | Getting started with ad network |
Starting the integration with Catalog | Starting the integration with catalog |
Merchant ID | Merchant id |
Copy URL to clipboard | Copy url to clipboard |
Activate seller | Activate Seller |
Deactivate seller | Deactivate Seller |
Proper nouns
Capitalize all proper or trademarked nouns, including names of products, features, modules, pages, people, places, nationalities, names of languages, months, days of the week, and holidays. If the noun has more than one word, use title case.
Do ✅ | Don't ❌ |
---|---|
Black Friday will be on November 24 | Black friday will be on november 24 |
Intelligent Search determines the relevance of each product by combining weights. | Intelligent search determines the relevance of each product by combining weights. |
| Contact the support team. |
Requesting a trade policy for the Brazilian market. | Requesting a trade policy for the brazilian market. |
Personal Shopper is available in the following languages: English, Spanish, Portuguese, French, and German. | Personal Shopper is available in the following languages: english, spanish, portuguese, french, and german. |
Export to Excel | Export to excel |
Install Intelligent Search | Install intelligent search |
VTEX App Store | VTEX app store |
Respect the capitalization of company names as used in their copy material (not their logo), whether it’s all caps, a capital letter in between, or all lowercase.
Do ✅ | Don't ❌ |
---|---|
VTEX |
|
SAP | Sap |
ServiceNow | Servicenow |
If an official name begins with a lowercase letter, use it in lowercase even at the start of a sentence. If possible, rewrite the sentence to avoid a lowercase word at the beginning.
Do ✅ | Don't ❌ |
---|---|
To configure the easypay affiliation, follow the steps below. | To configure the Easypay affiliation, follow the steps below. |
Checkout customization for easypay. | easypay checkout customization |
VTEX is the highest-ranked Leader | Vtex is the highest-ranked Leader |
Letters following slashes
When a slash joins words, capitalize the word after the slash if the word before the slash is capitalized.
Do ✅ | Don't ❌ |
---|---|
Items/Units | Items/units |
Note/Sales associate code | Note/sales associate code |
Package/Order number | Package/order number |
File formats
Capitalize file formats.
Do ✅ | Don't ❌ |
---|---|
Export to CSV | Export to csv |
Endpoints and APIs
Capitalize the first word of labels and terms in APIs unless they're always lowercase.
Do ✅ | Don't ❌ |
---|---|
Create or update promotion endpoint | Create Or Update Promotion endpoint |
The Conversions API | The conversions API |
Acronyms
Most acronyms are fully capitalized, but not all. Follow the standard form used in the industry. Capitalize all words in the spelled-out form of an acronym. The names of many protocols and specifications are considered proper nouns and are capitalized when spelled out.
Do ✅ | Don't ❌ |
---|---|
Renew the API token before the duration ends. | Renew the api token before the duration ends. |
This option involves using a third-party platform, known as Platform as a Service (PaaS). | This option involves using a third-party platform, known as platform as a service (PAAS). |
How does VTEX ensure compliance with the General Data Protection Regulation (GDPR)? | How does VTEX ensure compliance with the general data protection regulation (GDPR)? |
Multiple redirects are possible in a single URL. | Multiple redirects are possible in a single url. |
A user ID screen is displayed so that the customer can continue trying to purchase. | A user id screen is displayed so that the customer can continue trying to purchase. |
Colons
Capitalize the first letter after a colon.
Do ✅ | Don't ❌ |
---|---|
Autocomplete: Provides search and product suggestions based on the shopper's context. | Autocomplete: provides search and product suggestions based on the shopper's context. |
User interfaces
Actions and nouns listed in action and content labels (including dropdown menus and filters) should be capitalized.
Do ✅ | Don't ❌ |
---|---|
Edit | edit |
Export file | export file |
Import file | import file |
Filter by status:
| Filter by status:
|
Documentation
User Interface elements
Follow the capitalization used on the UI including labels, buttons, and VTEX Admin module names. This also applies to UI from other platforms.

Do ✅ | Don't ❌ |
---|---|
In the Google Tag Manager field, enter the store identification code in GTM-XXXX format, as shown in the image below. | In the Google tag manager field, enter the store identification code in gtm-XXXX format, as shown in the image below. |
Technical references and developer fields
Use camel case for placeholders and developer fields. This means capitalizing the first letter of each word, except for the first letter of the entire compound word.
Do ✅ | Don't ❌ |
---|---|
The file name should follow the pattern {storeName}-favicon.ico. | The file name should follow the pattern {storename}-favicon.ico. |
Lists
Always capitalize the first letter in a bullet or numbered list.
Bullet list
Do ✅ | Don't ❌ |
---|---|
Search Console provides easy and free access to the following information: 1. Top search terms 2. Top URLs viewed | Search Console provides easy and free access to the following information: • top search terms • top URLs viewed |
Numbered list
Do ✅ | Don't ❌ |
---|---|
|
|