Menu
Guides
Grammar
Formatting
Interface copy
Documentation
Glossary
Abbreviations
5 min read

Abbreviations include acronyms, shortened words, and contractions.

In documentation, spell out abbreviations on the first reference if they’re not common and include the abbreviation in parentheses immediately after.

Do ✅Don't ❌
The Filter component is used to filter products inside the Product Listing Page (PLP) and Search Page.The Filter component is used to filter products inside the PLP and Search Page.

Don’t use i.e. or e.g. They are not localization friendly.

Do ✅Don't ❌
It is frequently necessary to send the item price to the gateway or to your ERP with the tax shown separately from the price.It’s frequently necessary to send the item price to the Gateway or to your ERP with the tax shown, i.e. separately from the price.
In this function, create an event object specifying the desired event type (example: purchase) and then call sendAnalyticsEvent.In this function, create an event object specifying the desired event type (e.g., purchase) and then call sendAnalyticsEvent.

Periods with abbreviations

Don't use periods with acronyms or the abbreviation for the name of a country.

Do ✅Don't ❌
You need to send the item price to your ERP with the tax shown separately from the price.You need to send the item price to your E.R.P. with the tax shown separately from the price.
This amount is shown in US dollars.This amount is shown in U.S. dollars.

If you write or say an abbreviation as a word (for example, app or sync), don't put a period after it.

Do ✅Don't ❌
The app is available in the Extensions Hub.The app. is available in the Extensions Hub.
You can sync your catalog with Amazon.You can sync. your catalog with Amazon.

Put a period at the end of a shortened word in text, including strings that are full phrases. Omit for date and time, forms, and column headers in the UI.

Do ✅Don't ❌
Check the item qty. in the cart
  1. Check the item qty in the cart
  2. No.

Contractions

Always use common contractions, such as it’s, you’re, that's, don’t, can’t, you’ll. Contractions help avoid misreading, as it's easier for readers to overlook the word not in a sentence than to misinterpret a contraction like don’t as do.

Do ✅Don't ❌
You don't have any manually added products.You do not have any manually added products.

Don’t mix contractions and spelled-out equivalents within the same sentence.

Do ✅Don't ❌
It’s key for data encoding to be part of this routine, but it's important noting that creating cookies can also interfere with the store in other ways.It is key for data encoding to be part of this routine, but it’s important noting that creating cookies can also interfere with the store in other ways.

Avoid contractions formed from nouns and verbs.

Do ✅Don't ❌
VTEX is continuously evolving our products.VTEX’s continuously evolving our products.

Don’t use double contractions like mustn't've or shouldn't've, and avoid ambiguous or awkward contractions, such as there’d, it’ll, and they’d.

Do ✅Don't ❌
It will disappear from the list on the SKU Bindings page.It'll disappear from the list on the SKU Bindings page.

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.

Don't spell out common acronyms.

Do ✅Don't ❌
  1. API, REST, POST
  2. File formats (CSV, XML, JSON)
  3. ID, URL, HTML
  4. SKU, EAN
  5. KPI, ROI, GMV
  6. MB, GB
  7. Renew the API token before the duration ends.
  1. Megabyte, Gigabyte
  2. Renew the API (Application Programming Interface) token before the duration ends.

Don't create acronyms from product or feature names.

Do ✅Don't ❌
Delivery Promise (Beta) is suitable for all types of operations.DP (Beta) is suitable for all types of operations

Use a or an based on pronunciation.

Do ✅Don't ❌
A URLAn URL
A SKU (preferred US pronunciation is /skjuː/)An SKU

Avoid the possessive form. An alternative is using the preposition of using nouns as adjectives, which may require using a definite article or omitting the article.

Do ✅Don't ❌
The purpose of this FAQ.This FAQ's purpose.
This means providing Google with the address of the store website.This means providing Google with the address of your store's website.
The vteximg.com.br domain delivers store image files.The vteximg.com.br domain is responsible for delivering your store's image files.

When making acronyms, initialisms, and other abbreviations plural, treat them as regular words.

Do ✅Don't ❌
URL mapping is used to redirect specific URLs to other URLs.URL mapping is used to redirect specific URL to other URL.
This type of app allows you to create integrations between services using REST APIs or create GraphQL APIs to use data in custom React components.This type of app allows you to create integrations between services using REST API’s or create GraphQL APIs to use data in custom React components.

Prefer to use the acronyms of file formats and capitalize them. When specifying file extensions, use lowercase letters (example: faststore.config.js).

Do ✅Don't ❌
You can set up synonyms individually or by importing a spreadsheet in CSV format.You can set up synonyms individually or by importing a spreadsheet in csv format.
package.json: JSON file describing the dependencies, script commands for building, and version details.package.JSON: json file describing the dependencies, script commands for building, and version details.
Contributors
0
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
0
On this page
GithubComunityFeedback