diff --git a/.DS_Store b/.DS_Store index 2c1f9dc..c23e112 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/content/.DS_Store b/content/.DS_Store index 163ba93..df29633 100644 Binary files a/content/.DS_Store and b/content/.DS_Store differ diff --git a/content/loc_admin_review_logs/.DS_Store b/content/loc_admin_review_logs/.DS_Store new file mode 100644 index 0000000..8b9a73e Binary files /dev/null and b/content/loc_admin_review_logs/.DS_Store differ diff --git a/content/loc_admin_review_logs/VTEX Admin string standardization in English.zip b/content/loc_admin_review_logs/VTEX Admin string standardization in English.zip new file mode 100644 index 0000000..4698c91 Binary files /dev/null and b/content/loc_admin_review_logs/VTEX Admin string standardization in English.zip differ diff --git a/content/loc_admin_review_logs/VTEX Admin string standardization in Portuguese.zip b/content/loc_admin_review_logs/VTEX Admin string standardization in Portuguese.zip new file mode 100644 index 0000000..47490c5 Binary files /dev/null and b/content/loc_admin_review_logs/VTEX Admin string standardization in Portuguese.zip differ diff --git a/content/loc_admin_review_logs/VTEX Admin string standardization in Spanish.zip b/content/loc_admin_review_logs/VTEX Admin string standardization in Spanish.zip new file mode 100644 index 0000000..2234797 Binary files /dev/null and b/content/loc_admin_review_logs/VTEX Admin string standardization in Spanish.zip differ diff --git a/content/loc_admin_review_logs/VTEXAdminstringstandardizationinEnglish.html b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinEnglish.html new file mode 100644 index 0000000..7669e60 --- /dev/null +++ b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinEnglish.html @@ -0,0 +1 @@ +

VTEX Admin string standardization in English

The VTEX Admin strings were fully reviewed as proposed in the 2022 third-quarter OKR of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our Localization style guides, the CAT tool integrated Localization glossary, VTEX UX Writing Guidelines, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.

Capitalization

These patterns were adopted from the Voice Chart available in the UX Writing Guidelines.

UI Element

Case

Note

Table column header

Title

Tabs

Title

Buttons

Title

Unless it's a sentence. Many buttons in the UI display as all caps as recommended in the UX Writing guidelines, but many do not, so it is important to standardize them at the string level.

Page title

Title

Main (sde) menu

Title

Drop down menu

Title

Modal title

Title

Links

Sentence

Graph labels

Sentence

Counter label

Sentence

Date filters

Sentence

7 hours ago, This week, etc.

Show all

Sentence

View all

Sentence

Labels

Sentence

Grammar forms

Lexical preferences

\ No newline at end of file diff --git a/content/loc_admin_review_logs/VTEXAdminstringstandardizationinPortuguese.html b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinPortuguese.html new file mode 100644 index 0000000..b41f40e --- /dev/null +++ b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinPortuguese.html @@ -0,0 +1 @@ +

Padronizações de texto do VTEX Admin em português

O VTEX Admin passou por uma revisão integral de seus textos, como proposto no OKR do terceiro trimestre de 2022 de Localization. Nesse processo, aplicamos correções de gramática, tom e voz, visando oferecer uma experiência consistente aos nossos usuários através dos textos mostrados na plataforma. A revisão considerou os padrões já especificados nos guias de estilo de Localization, o glossário de Localization integrado a CAT tool, as UX Writing Guidelines da VTEX, bem como discussões sobre as nomenclaturas e suas padronizações com os PMs responsáveis. Neste documento, organizamos os principais pontos de padronização e preferência aplicados durante a revisão e que devem ser mantidos nos textos do admin.

Capitalização

Sempre usar sentence case para PT, independentemente se for título ou não. Para EN, cada parte da UI tem uma capitalização diferente. Para entendermos cada aplicação, seguimos o guia de UX e o contexto de exibição das frases.

Formas verbais

Via de regra, estas são as formas verbais utilizadas. Há exceções a depender do contexto.

Preferências lexicais

Mudanças de terminologia posteriores à revisão do Admin

Aplicação pendente

\ No newline at end of file diff --git a/content/loc_admin_review_logs/VTEXAdminstringstandardizationinSpanish.html b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinSpanish.html new file mode 100644 index 0000000..9f4fe3e --- /dev/null +++ b/content/loc_admin_review_logs/VTEXAdminstringstandardizationinSpanish.html @@ -0,0 +1 @@ +

VTEX Admin string standardization in Spanish

The VTEX Admin strings were fully reviewed as proposed in the 2022 third-quarter OKR of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our Localization style guides, the CAT tool integrated Localization glossary, VTEX UX Writing Guidelines, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.

Capitalization

Only the first letter of buttons should be capitalized.

Basic UI buttons and terminology

Verb

Comment

Agregar

Not añadir

Eliminar

Not borrar. Used when the element won’t exist anymore after the action is applied.

Remover

Used when the element is removed from a list or a group, but it still exists in the system.

Limpiar

Used as «clear filters.»

Crear

Used for create or cadastrar, since the official source will be EN.

Editar

Not modificar or cambiar.

Status

Not estado.

Éxito

Used for success messages. Example: «Política comercial creada con éxito.»

Lexical preferences

A

adquirente, not adquiriente

x administración, administrar

In general, use gestión to refer to management, especially in the Admin menu or other UI elements.

aplicación, app

Always use aplicación in texts. We also use aplicación in the UI, but if there is a tight space constraint, we can use app.

agregar, not añadir

For UI actions, always use agregar.

administrador de la tienda

Always use when referring to the retailer (lojista) in the VTEX Admin.

anexo

Use for SKU attachments used to customize products. See documentation.

adjunto

Use for files that will be attached.

B

boleto

Keep the Brazilian payment method as boleto so users can find information about it as they search it.

C

x correo electrónico

Don’t use. Always use email with no hyphen.

D

dashboard, not panel

Always use dashboard to refer to panel, unless the text is making a distinction and mentions both.

E

email, not e-mail or correo electrónico

Always use email with no hyphen when referring to email. Do not use correo electrónico.

endpoint, not punto de conexión or punto extremo

Always use endpoint. Do not substitute with Spanish alternatives.

éxito

This is the prefered adjective for success messages. Example: “Se agregó la categoría con éxito.”

eliminar, not borrar

This is used when deleting elements from the system (different from “remove” which is translated as “remover”).

x enlace

Always use link.

x estado (UI)

Always use status when referring to the status of a UI element.

F

G

gestión, gestionar, not administración, administrar

Use gestión and gestionar when referring to UI titles and processes.

H

x huso horario

Don’t use. Use zona horaria instead.

I

ícono, not icono

implementar, not implantar

limpiar, not borrar

This is the verb used for filters in the command «Clear Filters».

inventario

The difference between inventory and stock is subtle and they are often used interchangeably. Use stock for all, unless the text is making a distinction, in which case you can include inventario.

J

K

L

x libro electrónico

Don’t use. Always use ebook.

link, not enlace

M

máster

Avoid using. Example: usuario máster was changed to usuario titular.

marketplace

Do not substitute with any Spanish alternative.

medio de pago, not método de pago

x minorista

Use retailer.

N

O

P

periodo, not período

partner, not socio

Always use partner when referring to VTEX partners, other companies with whom VTEX collaborates. However, you may use asociación to translate partnership. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use socio.

x panel (UI)

Use dashboard.

política comercial

Trade policy was confirmed as the current official name for the module and agreed with the PM (Matheus Furtado).  Any instances of «política de ventas» and «canales de ventas» were updated to reflect this decision. This module presents a scope challenge that has made it difficult to define a name that encompasses all that the module does. This guided our decision to keep the current term. Keep in mind that «canales de ventas» may be a valid term in other contexts.

Q

R

redirección, not redireccionamiento

retailer

Use retailer when referring to minoristas. When referring to retailer as lojista (store admin in the VTEX admin), use administrador de la tienda.

remover

Used when removing elements from a list or group that will still exist in the system.

S

x socio

Always use partner when referring to VTEX partners, other companies with whom VTEX collaborates. However, you may use asociación to translate partnership. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use socio.

seller

Always use seller when referring to sellers of a marketplace. This is the most frequent case in the Admin. In the inStore app, use vendedor when they refer to a sales associate.

status

Always use to refer to statuses in the UI.

stock, not existencias

The difference between inventory and stock is subtle and they are often used interchangeably. Use stock for all, unless the text is making a distinction, in which case you can include inventario.

T

U

V

video, not vídeo

vendedor

Used in inStore to refer to sales associates. Never use it for marketplace sellers.

Z

zona horaria

Always use when talking about time zones. Do not use huso horario.

\ No newline at end of file diff --git a/content/loc_style_guides/.DS_Store b/content/loc_style_guides/.DS_Store new file mode 100644 index 0000000..90253e2 Binary files /dev/null and b/content/loc_style_guides/.DS_Store differ diff --git a/content/VTEX Localization Style Guide - EN.zip b/content/loc_style_guides/VTEX Localization Style Guide - EN.zip similarity index 100% rename from content/VTEX Localization Style Guide - EN.zip rename to content/loc_style_guides/VTEX Localization Style Guide - EN.zip diff --git a/content/loc_style_guides/VTEX Localization Style Guide - ES.zip b/content/loc_style_guides/VTEX Localization Style Guide - ES.zip new file mode 100644 index 0000000..27626a7 Binary files /dev/null and b/content/loc_style_guides/VTEX Localization Style Guide - ES.zip differ diff --git a/content/loc_style_guides/VTEX Localization Style Guide - ES/.DS_Store b/content/loc_style_guides/VTEX Localization Style Guide - ES/.DS_Store new file mode 100644 index 0000000..10f526f Binary files /dev/null and b/content/loc_style_guides/VTEX Localization Style Guide - ES/.DS_Store differ diff --git a/content/loc_style_guides/VTEX Localization Style Guide - ES/VTEXLocalizationStyleGuideES.html b/content/loc_style_guides/VTEX Localization Style Guide - ES/VTEXLocalizationStyleGuideES.html new file mode 100644 index 0000000..677aa94 --- /dev/null +++ b/content/loc_style_guides/VTEX Localization Style Guide - ES/VTEXLocalizationStyleGuideES.html @@ -0,0 +1 @@ +

VTEX Localization

Style Guide

SPANISH

Created by: Clara Cruz

Updated by: Clara Cruz

Last updated: April 5, 2023


Table of Contents

Introduction        4

Localization domains        4

Form of address        4

Gender-neutral language        4

LATAM vs. Spain        5

Capitalization        5

General Texts        5

UI        5

Legal        5

Document titles        5

Punctuation        6

Quotation Marks        6

Angle quotes «»        6

Straight quotes ""        6

Simple quotes  ''        6

Quotation marks and periods        6

Lists and semicolons        6

Team names        7

Position titles        7

Verb form in titles        7

Numbers        8

Decimals        8

Thousands and Millions        8

Billions        8

Currencies        8

Hour format        8

Acronyms        9

Foreign words        9

Word list        9

A        9

B        10

C        10

D        10

E        10

F        10

G        10

H        10

I        10

J        11

K        11

L        11

M        11

N        11

O        11

P        11

Q        11

R        11

S        11

T        11

U        11

Z        12

Resources        12


Introduction

Localization domains

Product Localization 

Marketing Enablement

Product Marketing

Education

Legal

Form of address

As of September 2021, we use the  across all texts.

For Spanish (Spain) materials, use  and vosotros.

Gender-neutral language

We maintain the third person masculine as the neutral pronoun in texts and UI elements. The same applies for nouns, the masculine form is considered neutral.

LATAM vs. Spain

Spanish Latin America is the standard for most content.

Some Marketing Enablement content is adapted for Spanish - Spain.

Differences in terminology are documented in the VTEX Localization Glossary and the Marketing Enablement Glossary.[b]

Capitalization

General Texts

Follow the Spanish rules for capitalization, regardless of capitalization in the source text.

Reference: DPD

UI

Only the first letter of buttons should be capitalized.

If you are quoting the name of a section, they should go in quotation marks with only the first letter capitalized.

If they have special formatting (bold, italics, etc.) the quotes are not necessary.

Example:

La «Capacidad de entrega programada», dentro de la «Política de envío».

Reference: Ortotipografía en informática

Legal

In legal documents, we follow the capitalization in the source text.

Document titles

Only the first letter of the first word is capitalized in document titles.

“Beta” version

The word “beta” to denote a phase or version is used in lowercase. It is considered a common noun.

Reference: Fundeu

Punctuation

Quotation Marks

Angle quotes «»

Use angle quotes in general texts like blog and social media posts and articles. This will generally be articles from Marketing, Education, Events, and Other.

Reference: DPD 

Straight quotes ""

As an exception to the RAE guidelines, use straight quotes in legal documents, headings, subheadings, and strings.

For headings and subheadings, this rule was adopted to avoid crowding in cases where there are several English words, which is common.

Simple quotes  ''

Use simple quotes when quoting terms in a heading.

Example:

VTEX fue declarada 'Líder'

Quotation marks and periods

In Spanish, the period always goes outside the quotation marks.

Lists and semicolons

When there is a list of items, it is better to use a period for each item rather than a colon as is common in source texts.

The one exception is legal text, where we usually keep the colon.

Team names

Internal team names are not translated.

Examples:

El sitio web fue desarrollado con tecnología nativa VTEX IO, y el proyecto fue llevado a cabo por el equipo de Partner Experience.

Si ya es un cliente B2C y desea configurar un escenario B2B, póngase en contacto con el equipo de Sales a través del {i>email<i} {1>sales-ops-br@vtex.com<1}<1} para conocer más detalles.

Position titles

Position titles, especially internal, are kept in English if they are an acronym or noun and adjective. If they include the preposition “of,” the preposition is translated.

Examples:

        

También habrá una sesión en vivo en el {1>{u>Instagram<u}<1} de VTEX Brasil con Mariano Gomide, fundador y co-CEO de la empresa, en una fecha por confirmar.

{1> ANFITRIÓN – GEORGE BRINDEIRO <1} {2> - Head de Education & Documentation<2}

        

El {i>webinar<i} estará a cargo de Jade Maravillas, Head de Global Marketing Enablement, Felipe Mattos, Director de Producto, y Angela Molano, Technical Account Manager; todos ellos del equipo de VTEX.

Verb form in titles

When titles describe actions, use the verb in infinitive and the noun. Do not use the gerund form.

Example:

Numbers

Decimals

There is no standard for the decimal separator since different countries use period or comma.

Thousands and Millions

Numbers that have more than four digits use a space as a separator. It is a best practice to use a non-breaking space (option+space in Mac, shift+space in PCs). Periods and commas are used exclusively for separating decimals.

Examples:

12 345 

678 901 

4 500 000

Reference: Fundeu 

Billions

A billion in English and Portuguese is equivalent to mil millones not billón in Spanish.

Reference: Fundeu

Currencies

The standard currency for Latin America is US dollars. When translating a Portuguese text for Latin America, convert Brazilian reals to US dollars.

Follow the general Spanish guidelines for writing currency symbols.

Hour format

For writing in the twelve-hour format, the abbreviation for morning and afternoon are written with a period and space after each other.

Example:

6 a. m.

If using the twenty-four-hour format, there is no need to use the abbreviation unless the zeros are being omitted. If that is the case, write h, no period, after the number.

Example:

5:00 or 5 h

Reference: Fundeu

Percentages

Use a space between the number and the %. If possible, make it a non-breaking space.

Reference: Fundeu

Acronyms

Acronyms in Spanish do not use ‘s’ for making the plural form. However, when there is ambiguity in technology texts and UI elements, use add an ‘s’ for to mark the plural.

Example:

Foreign words

Foreign words are italicized[c], except in titles.

Basic UI terminology

Verb

Comment

Agregar

Not añadir

Eliminar

Not borrar. Used when the element won’t exist anymore after the action is applied.

Remover

Used when the element is removed from a list or a group, but it still exists in the system.

Limpiar

Used as “clear filters.”

Crear

Used for create or cadastrar, since the official source will be EN.

Editar

Not modificar or cambiar.

Status

Not estado.

Éxito

Used for success messages. Example: “Política comercial creada con éxito.”

Word list

Special instructions about words within Spanish, including spelling or other factors.

A

adquirente, not adquiriente

x administración, administrar

In general, use gestión to refer to management, especially in the Admin menu or other UI elements.

aplicación, app

Always use aplicación in texts. We also use aplicación in the UI, but if there is a tight space constraint, we can use app.

agregar, not añadir

For UI actions, always use agregar.

administrador de la tienda

Always use when referring to the retailer (lojista) in the VTEX Admin.

B

C

x comercio electrónico

Don’t use. Use ecommerce instead.

x correo electrónico

Don’t use. Always use email with no hyphen.

D

dashboard, not panel

Always use dashboard to refer to panel, unless the text is making a distinction and mentions both.

E

ecommerce, not e-commerce

Use ecommerce. Never hyphenate. Also, don’t use comercio electrónico.

email, not e-mail or correo electrónico

Always use email with no hyphen when referring to email. Do not use correo electrónico.

ebook, not e-book or libro electrónico

Always use ebook with no hyphen. Do not use libro electrónico.

endpoint, not punto de conexión or punto extremo

Always use endpoint. Do not substitute with Spanish alternatives.

éxito

This is the prefered adjective for success messages. Example: “Se agregó la categoría con éxito.”

eliminar, not borrar

This is used when deleting elements from the system (different from “remove” which is translated as “remover”).

x enlace

Always use link.

x estado (UI)

Always use status when referring to the status of a UI element.

F

G

gestión, gestionar, not administración, administrar

Use gestión and gestionar when referring to UI titles and processes.

H

x huso horario

Don’t use. Use zona horaria instead.

I

ícono, not icono

implementar, not implantar

limpiar, not borrar

This is the verb used for filters in the command “clear filters.”

inventario

The difference between inventory and stock is subtle and they are often used interchangeably. Use stock for all, unless the text is making a distinction, in which case you can include inventario.

J

K

L

x libro electrónico

Don’t use. Always use ebook.

link, not enlace

M

máster

Avoid using. Example: usuario máster was changed to usuario titular.

marketplace

Do not substitute with any Spanish alternative.

medio de pago, not método de pago

x minorista

Use retailer.

N

O

P

periodo, not período

partner, not socio

Always use partner when referring to VTEX partners, other companies with whom VTEX collaborates. However, you may use asociación to translate partnership. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use socio.

x panel (UI)

Use dashboard.

Q

R

redirección, not redireccionamiento

retailer

Use retailer when referring to minoristas. When referring to retailer as lojista (store admin in the VTEX admin), use administrador de la tienda.

remover

Used when removing elements from a list or group that will still exist in the system.

S

x socio

Always use partner when referring to VTEX partners, other companies with whom VTEX collaborates. However, you may use asociación to translate partnership. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use socio.

seller

Always use seller when referring to sellers of a marketplace. This is the most frequent case in the Admin. In the inStore app, use vendedor when they refer to a sales associate.

status

Always use to refer to statuses in the UI.

stock, not existencias

The difference between inventory and stock is subtle and they are often used interchangeably. Use stock for all, unless the text is making a distinction, in which case you can include inventario.

T

U

V

video, not vídeo

vendedor

Used in inStore to refer to sales associates. Never use it for marketplace sellers.

Z

zona horaria

Always use when talking about time zones. Do not use huso horario.


Resources

Diccionario de la Lengua Española

Fundéu

Diccionario Panhispánico de Dudas

IATE - EU Terminology Base

Microsoft Terminology Base

Ortotipografía en informática - Wikilengua

Lista de Estados, territorios y monedas - European Union

Diccionario de construcciones preposicionales

Bilingual Dictionary of Legal and Business Terms

VTEX Help Center

Diccionario Politécnico de las Lenguas Española e Inglesa

VTEX UX Writing Guidelines

VTEX Content Marketing Styleguide

VTEX - Marketing Localization Guidelines

[a]Remove

[b]Update

[c]Should we change to roman?

\ No newline at end of file diff --git a/content/loc_style_guides/VTEX Localization Style Guide - ES/images/image1.png b/content/loc_style_guides/VTEX Localization Style Guide - ES/images/image1.png new file mode 100644 index 0000000..8860ed1 Binary files /dev/null and b/content/loc_style_guides/VTEX Localization Style Guide - ES/images/image1.png differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT.zip b/content/loc_style_guides/VTEX Portuguese Style Guide - PT.zip new file mode 100644 index 0000000..dae89d3 Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT.zip differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/.DS_Store b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/.DS_Store new file mode 100644 index 0000000..10f526f Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/.DS_Store differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/VTEXPortugueseStyleGuidePT.html b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/VTEXPortugueseStyleGuidePT.html new file mode 100644 index 0000000..bca1026 --- /dev/null +++ b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/VTEXPortugueseStyleGuidePT.html @@ -0,0 +1 @@ +

VTEX Localization

Style Guide

PORTUGUESE

Created by: Yuli Monarin

Updated by: Yuli Monarin

Last updated: July 7, 2023


Table of Contents

Localization areas        4

Voice        4

Tone        4

Translation goals        5

General guidelines        5

Capitalization        6

UI and Titles        6

Days of the week and Months        6

Job titles and Professions        6

Regions, Demonyms and Nationalities        6

Holidays        6

Education        6

Legal        7

UI Localization        7

English words        7

Numbers        7

Percentage        8

Pronouns        8

Punctuation        8

Exclamation marks        8

Commas        8

Colons        9

Em-dashes        9

En-dashes        9

Hyphens        9

Quotation marks        9

Quotation marks and periods        10

Lists        10

Consistency in lists        10

Verb form in titles        11

Syntactic parallelism        11

Hours        12

Date format        12

Currencies        12

Acronyms        13

Job titles        13

Team names and departments        13

Sayings and expressions        13

Gender        14

Inclusive writing        14

Non-localized UI in Education texts        15

CEP vs. Postal Code        15

Product Names        16

Resources        18

VTEX context        18

UI Localization        18

VTEX Portuguese Writing Style Guide        18

UX Writing Guidelines        18

Terminology        18

Content Marketing Localization        19

Dictionaries        19

Grammar        19

Books        19

Chrome extension        19

External style guides        19


Localization areas

Product Localization 

Product Marketing

Education

Legal

Voice

Serious, not playful — avoid jokes and puns, ambiguity, be straightforward.

Exclusive, not arrogant — a plus of sophistication, but the choice of words should be simple and clear.

Authority, not arbitrary.

Young, not naive — fresh and pleasant content.

Rebel, not inconsequential.

Tone

The tone of voice will be guided by the source content:

Interviews: The tone is set by the person that is being interviewed, adaptation will be only done to clarify where the source is missing clarity.

Corporate (Finance, PR): Serious and precise, little room for target adaption except when it makes it easier to understand the content (shorter sentences or topic changes that do not affect the source meaning).

Marketing (Blog posts): Concise and crisp, clear and on point, fresh and less formal than the Corporate or Interview texts.

Translation goals

Clarity: Content free from any ambiguities. Straightforwardness helps readers have a better understanding of the message.

Suitability: The text must match the audience, the channel and has to be focused on what is appropriate for each instance.

Precision: Do not alter the source meaning, even when less formal texts might leave room for adaptation.

General guidelines

The general style should be clear, friendly, and concise.

Keep the following guidelines in mind:

Language specifics

Capitalization

When translating texts to Portuguese, Portuguese capitalization standards must be followed. So use sentence case: keep the first letter of the first word of the sentence capitalized and then the rest of the words should be in lower case — unless there is a proper noun or a name/section that should start in upper case in the middle of the sentence.

UI and Titles

The section above applies to the VTEX Admin labels (UI) and titles as well.

incorrect: Detalhes do Produto

Correct: Detalhes do produto

Days of the week and Months

Use lower case for months and days of the week, for example: segunda-feira, domingo, janeiro, outubro.

Job titles and Professions

You should use uppercase for job titles and lower case for career fields and professions, for example: engenheiro, engenharia, Diretor de Engenharia.

Regions, Demonyms and Nationalities

Geographic regions should always be in upper case, whereas demonyms and nationalities are in lower case. Examples: Nordeste, América Latina, sudestino, brasileiro.

Holidays

Holidays are usually capitalized, for example: Ano Novo, Natal, Dia do Trabalho, Sete de Setembro.

Education

When mentioning a path to a specific UI in the Admin, use the capitalization as it is on the platform. The text must reflect what users see.

If you see common words capitalized in the middle of sentences when they do not need to or are not referring to a “path” the user must access on the platform, please consider using sentence case, as it can be an inconsistency in the source text. For example, this may happen with the term “Seller White Label”, which you can use as “seller white label”.

Legal

In legal documents, we follow the capitalization as it appears in the source text.

UI Localization

Please be clear and objective. While English usually includes “please”, the best practice for Portuguese text in the UI is to just be right to the point.

Examples:

English: Please try again. | Portuguese: Tente novamente.

English: Would you like to continue? | Portuguese: Deseja continuar?

In Q3 2022, the Localization team revised the Admin user interface, specifically focusing on the localization of text strings. Throughout this process, we applied the guidelines outlined in this style guide to ensure consistency and coherence in the Admin text. In the process, we’ve standardized the UI text and compiled all relevant information into a document. Please refer to the VTEX Admin string standardization in Portuguesefor more information.

English words

In the technology and marketing industries, it’s common to use terms in English amongst a text in Portuguese, unless there’s a widely used alternative in Portuguese. So remember this and question words that you cannot easily find on Google results.

We usually do not italicize these words, unlikely in Spanish.

Examples: start-up, direct-to-consumer, composable, chatbot, on demand.

Numbers

In general, numbers from one to ten must be spelled out, unless there are numbers bigger than ten in the same sentence (to keep the format consistent). Exceptions: For titles and currencies, always use digits.

Avoid starting sentences with numbers. If that is the case, however, write the number in full. Exception: Titles can begin with numerals.

Thousand units must be written with a dot, while commas are used in decimals. Note that in English it is the opposite.  Examples: in Portuguese, use 4.000 (not 4000 nor 4,000) and 1,2, not 1.2.

Always add a space between the number and its unit.

Note: While it is common to use “Nº”, “nº”, or “no.” as an abbreviation for "number" in Portuguese, the correct and preferred abbreviation is "N.º" (or “n.º” if it’s in the middle of the sentence), with the dot. Other possibilities of abbreviations accepted are “núm.” ou “n.”. When abbreviating "number" in Portuguese, it is essential to include the dot after the letter "N" to maintain accuracy and consistency. This follows the established typographical conventions in Portuguese writing.

Percentage

The percent sign should always follow the number without any spaces between them. For example: 10%.

Pronouns

In English, it’s common to use personal pronouns repeatedly. Avoid doing this in Portuguese and replace them with articles or remove them.

Punctuation

Do not follow the source punctuation blindly. Keep what makes sense for a fluent text in Portuguese and adapt accordingly. Do not use punctuation in titles and subheadings.  

Exclamation marks

Avoid using exclamations marks in the text.

Commas

Do not use the oxford comma in Portuguese.

Colons

Use lower case after colons.

Slashes

In Portuguese, it is the standard practice to remove spaces before and after the forward slash (/). This rule applies when using the forward slash as a separator or in cases such as abbreviations. Example: Price/month, enviar p/ alguém.

Incorrect: "Eu comprei um livro / revista na livraria."

Correct: "Eu comprei um livro/revista na livraria."

Em-dashes

In English, it’s common to use em-dashes where we would simply use commas in Portuguese. So they do not always need to be kept in the target text.

If you opt to use it to emphasize a sentence or word, make sure you are using the correct “travessão”: — (Alt+0151) and add a space before and after it.

En-dashes

It must be used to join the extreme values of a series, such as numbers, letters, or others. You can also use it to unite words that have a logical connection. The shortcut to use it is Alt+0150.

Examples: Rio–Niterói bridge, 1995–2004, A–Z.

Hyphens

Hyphens must only be used in compound words. If it is incorrectly used in the source text, please use it correctly in your translation. To use it, you can simply press the symbol on your keyboard.

Examples: pré-requisito, bem-sucedido, Covid-19.

Quotation marks

Both straight/curly quotation marks are acceptable. Choose one to use throughout the text and stick to it.

Quotation marks and periods

The period must be placed before the quotation mark when the quote starts and ends the sentence.

The period must be placed after the quotation mark when the quotation does not begin but ends the sentence.

Lists

Sometimes punctuation on lists differs according to the language. In Portuguese, there are three options for marking punctuation in lists: with periods, semicolons, or no punctuation mark.

For bulleted list items composed of full sentences, you should use a period at the end of the sentence. For bulleted list items not composed by full sentence, no punctuation is required.

Consistency in lists

Source texts may not always have consistent lists. It’s your job to guarantee the lists are consistent in translations.

If the list items start with verbs, the same verb format must be used for all items. The same applies to nouns. The important point is: their items’ form must be consistent.

Example:                                                            Incorrect vs. Correct

Verb form in titles

Avoid using gerunds. Prefer the infinitive form, or change the verb to a noun.

For Education texts, it’s common to see the gerund in English and a “How to” in Portuguese.

Example:

English (source): “Implementing the strategy”

Portuguese: “Implementar a estratégia”, “Implementação da estratégia”, or “Como implementar a estratégia” (preferred for Education)

Syntactic parallelism

The indirect object must always be linked to the verb by a preposition. This also applies to cases in which there is more than one direct object. Make sure your sentences are synthetically parallel.

Examples:

Incorrect: Esse cenário apresenta vantagens para o usuário, já que ele permite explorar o catálogo, inventário e preços com liberdade, conforme seu perfil de acesso.

Correct: Esse cenário apresenta vantagens para o usuário, já que ele permite explorar o catálogo, o inventário e os preços com liberdade, conforme seu perfil de acesso.

Incorrect: [...] problemas de negócio específicos relacionados à usabilidade da loja, vendas e pós-vendas.

Correct: (option 1) [...] problemas de negócio relacionados a usabilidade da loja, vendas e pós-vendas. (option 2) [...] problemas de negócio relacionados à usabilidade da loja, às vendas e ao pós-vendas.

Hours

For the 12-hour format, use the abbreviation in lowercase with dots. Add a space between the hour and the abbreviation. For the 24-hour format, use the hour unit (h) between the hour and the minutes, without spaces. Zeroed minutes are not required.

For indicating time zones, use the format (GMT) in front of the hour.

Examples: 6 p.m. (GMT-3), 10:30 a.m., 14h30, 16h

Date format

Dates should be written as follows:

22 de outubro de 2021, or 22/10/21 (day, month, year)

Currencies

For illustrative examples, as in Help Center: You can localize the examples that are given in another currency other than reais. Check if the context allows it.

For precise data in general: You can either use US$ for dollars (preferred) or only the number followed by “dólares”.

The abbreviation for real is R$. There must always be a space between the abbreviation and the number.

In Storefront or apps used by other people (such as end customers, and pickers and couriers in Pick and Pack and Last Mile) than the Admin, use the standard R$.

In Admin labels (technical context), prefer the 3-letter ISO format: USD, BRL. 

Acronyms

If you have an acronym and want to spell it out in the text, please write the spelled-out form followed by the acronym in parentheses.

Examples:

  1. Regulamento Geral de Proteção de Dados (GDPR) na Europa e a Lei Geral de Proteção de Dados (LGPD) no Brasil
  2. Direct-to-consumer (DTC)

In the case of acronyms with more than 3 letters that can be read as a word, only the first letter is capitalized. For example, you should write Covid-19, Unesco, Aids. When it's an acronym that requires reading letter by letter, capitalize all the letters, as in FGTS.

Job titles

Job titles, especially internal, are kept in English if they are an acronym or noun and adjective. If they include the preposition “of” or “at,” the preposition is translated.

If the job title is widely used in Portuguese, you may consider translating it but keeping the team name/area (if any) in English.

Examples: Head de Sales, Customer Success Manager, Diretor de Marketing

Team names and departments

Internal team names and departments are not translated.

Examples: Customer Success, Growth, Product

Sayings and expressions

In marketing texts, you may have to translate sayings, proverbs, or other typical expressions centered in the source language and that do not make sense if literally translated to Portuguese. In those cases, you should search for an equivalent that keeps the sentence’s intended meaning.

Examples:

English: “Early shoppers get the worms”

Portuguese: “Deus ajuda os compradores que cedo madrugam”

English: “Born omnichannel”

Portuguese: “Omnichannel de berço”

If you cannot find an equivalent, just translate and adapt the sentence, keeping the intended meaning in Portuguese.

Gender

When translating from English, the gender of the word may not always be clear. If you are unsure which gender to choose when using articles, for example, you can search out TMs on Crowdin or ask a team member. Sometimes, people tend to use inconsistent articles/genders for the same word, so please avoid that.

Examples:

Inclusive writing

As Portuguese is a gender-marked language, unlike English, avoid assuming the gender in situations in which you can be more gender-neutral.

Examples:

English: “The secretaries…”

Portuguese: Use “As pessoas que trabalham na secretaria…” instead of “As secretárias...”

English: “Welcome to…”

Portuguese: “Boas-vindas a…” or “Bem-vindo(a) a…” instead of “Bem-vindo a…”

Whenever referring to people with disabilities, you should always use: "pessoa com deficiência".

For IBGE, black people correspond to the sum of "pretos" and "pardos". And the nomenclature that you should use is "pessoas negras", which encompass both forms.

See more information on inclusion here.

Non-localized UI in Education texts

If by any chance, the UI mentioned in the article you are translating is not localized in the Admin, you should check with our Localization Engineers if they are localizable. If yes, open a task on JIRA requesting it. If not, write the UI in bilingual format in your translation. The bilingual format must be indicated with the word that appears currently in the Admin followed by the translation in parentheses. For example: Clique no botão “Add” (adicionar).

CEP vs. Postal Code

When localizing content for a broader audience, it is important to consider the regional differences in terminology. In Brazil, the term "CEP" (Código de Endereçamento Postal) is widely used to refer to the postal code system established by Correios, the national postal service. On the other hand, in Portugal and other Portuguese-speaking countries, the term "postal code" is more commonly used.

To provide a more localized experience and cater to the preferences of our primary customer base in Brazil, we usually opt to use "CEP" when translating and localizing content. This ensures that our platform aligns with the familiar terminology used by Brazilian users. However, when addressing a broader Portuguese-speaking audience, such as Portugal, and especially through our Checkout, we prioritize the use of "postal code" for better localization.

To address both scenarios for our clients' end customers, for Checkout, we have created separate folders in our localization management system, Crowdin, one for PT-BR and another one for PT-PT. In the "PT-BR" folder we used "CEP", while in the "PT-PT" folder we used "postal code".

Product Names

In the past, product names were defined in collaboration with the Product Marketing team. However, they are no longer directly involved in naming decisions. The responsibility for product name localization now lies with the Localization team in collaboration with Product Managers, as well as Designers and Education. The Localization team ensures that product names are accurately translated and localized to resonate with the target audience.

If you're asking yourself if we should translate product names, the answer is not definitive: it depends. We consider several factors to make an informed decision, including brand consistency, linguistic and cultural adaptation, market familiarity, legal and trademark considerations, user experience and ease of understanding, marketing and advertising strategies, etc.

When localizing Admin module names, our general practice is to adapt them to the target language unless they contain highly technical terms that are better known in English, even among speakers of other languages. In such cases, we may retain the English module names to ensure clarity and ease of understanding for users. For app names, we tend to keep them in English.

If translated, the capitalization of product names will follow the standard conventions of each language. For example, in Portuguese (PT), product names will be written in sentence case, while in English (EN), they will be written in Title Case. If kept in English, the capitalization of product names will follow the English capitalization rules.

Examples:

English: Dashboards > Sales Performance

Portuguese: Dashboards > Performance de vendas

English: Promotion Simulator

Portuguese: Simulador de promoções

English: Extensions Hub

Portuguese: Hub de extensões

English: VTEX Pick and Pack

Portuguese: VTEX Pick and Pack

English: Intelligent Search > Analytics

Portuguese: Intelligent Search > Analytics


Resources

VTEX context

Help Center

Admin/Stores: Different Admin versions are available. Please always confirm with the writer which store they used as a reference. Here are two main ones: cosmetics2 (Admin V3), storecomponents (Admin V4).

UI Localization

VTEX Admin string standardization in Portuguese 

VTEX Portuguese Writing Style Guide

Manual de estilo e redação (maintained by Thalita Uba, in Content Enablement/Growth)

UX Writing Guidelines

https://uxwriting.vtex.com/ (applies mainly for EN UI, but some sections can be used for PT too).

Terminology

Internal

VTEX Glossary (maintained by Localization)

Crowdin Termbase

Marketing glossary (discontinued, the relevant terms were added to VTEX Glossary)

External

Microsoft Terminology Search

Microsoft UI String Search

IATE - European Union terminology

Content Marketing Localization

Marketing Localization Guidelines

Dictionaries

Aulete Digital
Michaelis

VOLP (Vocabulário Ortográfico da Língua Portuguesa pela Academia Brasileira de Letras)

Priberam (focus on European Portuguese, but also has a part for Brazilian Portuguese)

Grammar

Books

CUNHA, Celso e CINTRA, Lindley. Nova Gramática do Português Contemporâneo. Rio de Janeiro: Editora Nova Fronteira.

Cartilha Tem hífen?

Chrome extension

LanguageTool (Grammar and spell checker)

External style guides

Microsoft

\ No newline at end of file diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image1.png b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image1.png new file mode 100644 index 0000000..db87047 Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image1.png differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image2.png b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image2.png new file mode 100644 index 0000000..5417035 Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image2.png differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image3.png b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image3.png new file mode 100644 index 0000000..2c6c383 Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image3.png differ diff --git a/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image4.png b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image4.png new file mode 100644 index 0000000..477f833 Binary files /dev/null and b/content/loc_style_guides/VTEX Portuguese Style Guide - PT/images/image4.png differ diff --git a/content/VTEXLocalizationStyleGuideEN.html b/content/loc_style_guides/VTEXLocalizationStyleGuideEN.html similarity index 100% rename from content/VTEXLocalizationStyleGuideEN.html rename to content/loc_style_guides/VTEXLocalizationStyleGuideEN.html diff --git a/content/marketing_style_guides/.DS_Store b/content/marketing_style_guides/.DS_Store new file mode 100644 index 0000000..70df2a0 Binary files /dev/null and b/content/marketing_style_guides/.DS_Store differ diff --git a/content/marketing_style_guides/Writing Style Guide - ES.zip b/content/marketing_style_guides/Writing Style Guide - ES.zip new file mode 100644 index 0000000..a0e691a Binary files /dev/null and b/content/marketing_style_guides/Writing Style Guide - ES.zip differ diff --git a/content/marketing_style_guides/Writing Style Guide - ES/WritingStyleGuideES.html b/content/marketing_style_guides/Writing Style Guide - ES/WritingStyleGuideES.html new file mode 100644 index 0000000..0e7f73c --- /dev/null +++ b/content/marketing_style_guides/Writing Style Guide - ES/WritingStyleGuideES.html @@ -0,0 +1 @@ +

Guía de estilo y redacción VTEX - Español

Volumen 1 – Marketing y comunicación externa

Creado por: Thalita Sdroiewski Uba
Lalo Aguilar

Última actualización: 12 de jul.

¡Te damos la bienvenida, profesional de marketing y comunicación!

Hemos elaborado esta guía de estilo especialmente para ti. Este es el primer volumen de una serie de guías de estilo que nos ayudarán a garantizar la armonía en el contenido del material editorial de VTEX.

¿POR QUÉ?

La meta que perseguimos, con esta serie de guías, es mejorar la legibilidad y mantener la uniformidad, con el propósito de que la audiencia a la que nos dirigimos reciba las directrices necesarias para desarrollar contenido con asertividad. Por eso, te presentamos esta Guía de estilo – una guía práctica y fácil de leer que te ayudará a navegar por nuestro mundo editorial. Aquí encontrarás normas sobre el tono de voz, la puntuación, las mayúsculas, los números, las fechas y la terminología, además de algunas buenas prácticas que debe seguir todo aquel que escriba cualquier tipo de texto en nombre de la empresa.

¿CÓMO?

Utiliza esta guía como material de consulta cada vez que redactes un nuevo texto que coincida con alguna de las siguientes categorías: entradas de blog, páginas de clientes, ebooks, guías, comunicados de prensa, publicaciones en redes sociales, solution briefs, guiones, documentos técnicos y otros formatos dirigidos a audiencias externas. Y, cuando hayas terminado de escribir y estés revisando el texto, recuerda consultar nuevamente esta guía.

¿QUÉ?

Esta guía va dirigida a todos los profesionales de marketing y comunicadores institucionales que escriben contenido para audiencias externas: medios pagados, propios o adquiridos. No contempla la comunicación interna ni el contenido de los productos (¡por el momento!).

Si deseas obtener más información, visita el canal #content de Slack o comunícate con Thalita Uba a través de Slack (@thalita.uba) o thalita.uba@vtex.com.br.

Tono de voz

La voz de VTEX representa los componentes básicos de nuestra marca con respecto a la forma de comunicarnos. Garantiza que nuestro material escrito reproduzca la personalidad y los estándares de calidad de VTEX en todos los puntos de contacto.

Realmente es muy importante que nuestro tono de voz sea uniforme en toda la empresa. Por eso, debemos respetar los lineamientos de la marca VTEX a la perfección.

Tono = Contexto

Antes de escribir un texto, pregúntate: ¿Cuál es el objetivo de esta pieza? ¿Se supone que debe llamar la atención de la audiencia? ¿Quiero explicar un concepto o comunicarme directamente con nuestros clientes? ¿Estoy intentando llamar la atención de alguien o comunicando una falla de nuestra plataforma? Nuestro tono debe adaptarse en función del contexto del usuario y del mensaje. Utiliza las respuestas como guía para encontrar el tono adecuado.

Voz = Personalidad

El equipo encargado de la marca basó la personalidad de VTEX en tres pilares: audacia, confianza y optimismo. 

Somos audaces

Somos especialistas en tecnología y comercio y estamos construyendo nuestra autoridad en el mercado. Nuestra audacia reside en nuestra capacidad de ser provocadores, evitar las palabras huecas e ir directamente al grano.

Somos dignos de confianza

Somos serios y calmamos las ansiedades de nuestros clientes. Nuestras palabras deben transmitir precisión y no suscitar dudas. Somos de fiar, cumplimos lo que decimos. Nuestros clientes saben que pueden contar con nosotros.

Somos optimistas

Tenemos muchas oportunidades por descubrir; el futuro es brillante. Perseguimos nuevas oportunidades y no huimos de los desafíos. Además, intentamos encontrar soluciones sin hablar mal de la competencia o de nuestra audiencia.

Veamos algunos ejemplos:

Anímate a dar el próximo paso en tu proceso comercial. Implementa, prueba y escala con más agilidad y menos riesgo con la plataforma empresarial de comercio digital de VTEX.

Ofrece a tus clientes el surtido y la comodidad que desean con una operación omnichannel eficiente.

Nuestro equipo de especialistas, quienes cuentan con más de 20 años de experiencia en el sector del comercio digital, está aquí para guiarte en este proceso.

Este es el resultado cuando unimos todas las piezas:

VTEX no es el héroe

La audiencia es el héroe, y VTEX es su guía. Tenemos mucho que ofrecer al mundo y solemos ubicarnos en el rol de protagonistas. Cambiemos este enfoque: cuando nos presentamos como guía, nos convertimos en la ayuda que los demás necesitan para superar los desafíos que se les presentan. Veamos algunos ejemplos:

Hablando en general.

🚫 Con el OMS de VTEX, los gerentes de ecommerce pueden visualizar toda su operación comercial en una única solución.

Más personal.

Asume el control de toda tu operación comercial con el OMS de VTEX.

Audiencia en primer lugar

Nunca se trata de nosotros. Creemos que nuestra estrategia de comunicación es el recurso más poderoso con el que contamos para iniciar una conversación; por lo tanto, es esencial conocer a quiénes nos dirigimos. ¿Vienen de un entorno tecnológico o comercial? ¿Desempeñan una función operativa o una posición de liderazgo? ¿Cuáles son sus aspiraciones? ¿Y sus debilidades? Intenta abordar aquello que nuestra audiencia busca puntualmente. Evita los mensajes genéricos que pretenden dirigirse a todo el mundo y terminan por hablar con nadie. Veamos algunos ejemplos:

Genérico

🚫 VTEX lanza un nuevo cargador masivo de SKU que facilita la carga de cientos de SKU en tu tienda.

Empoderador

Solías demorar varias horas al día en cargar cientos de miles de SKU. Con el cargador masivo de SKU, puedes recuperar todas esas horas.

Simple y directo

Sé sencillo. Como nuestra solución es compleja ya de por sí y utilizamos muchos conceptos y una jerga específica, debemos hacer que nuestros textos sean lo más claros y directos posible. Cualquiera que lea nuestros anuncios debería sentirse identificado con lo que estamos comunicando. Evita también las repeticiones y las ambigüedades. Siempre vuelve a leer el texto para asegurarte de que no repitas muchos términos o ideas o que sean poco claros.

Mucho ruido

🚫 Puedes exportar informes completos con los principales KPI de tu tienda y evaluar si es la mejor forma de alcanzar los objetivos de tu organización.

Preciso

Utiliza informes de rendimiento completos para hacer un seguimiento de la eficiencia de tu operación.

En resumen:

Siempre conoce a la audiencia a la que diriges el mensaje.

✅ Nuestra audiencia es la protagonista de cada mensaje. VTEX es el guía.

✅ Debe ser un mensaje simple y conciso.

✅ Encuentra el equilibrio entre audacia, confianza y optimismo para lograr el tono adecuado.

Buenas prácticas

La legibilidad nos indica el grado de claridad y accesibilidad de nuestros textos. Cuanto más simple sea el contenido, más fácil será avanzar. Por lo tanto, un texto legible no solo agrada a Google cuando clasifica nuestros artículos, sino que también agrada al lector.

Te presentamos algunas reglas generales para obtener buenas puntuaciones de legibilidad:

✅ Procura que las oraciones y los párrafos sean cortos y concisos.

✅ Agrupa ideas similares y complementarias en un mismo párrafo.

✅ Empieza un nuevo párrafo cuando quieres presentar una nueva idea o punto de vista.

✅ Evita escribir párrafos de una sola oración.

✅ Utiliza la voz activa lo más posible.

✅ Sustituye, en lo posible, las palabras largas por sinónimos cortos.

La jerga y las palabras rebuscadas deben reducirse al mínimo.

✅ Adecúate a la audiencia.

✅ Evita escribir verbos en gerundio, sobre todo en encabezados.

✅ Asegúrate de que todos los enunciados tienen un sujeto claro.

✅ Evita utilizar expresiones regionales o difíciles de entender para otros países.

Pautas

Formatos

En VTEX, los tipos de texto que solemos redactar son los siguientes:

Contenido para el sitio web

Artículos (Blog/Linkedin de VTEX) - accede a esta plantilla aquí

Página del cliente - accede a esta plantilla aquí

Ebooks

Documentos técnicos (recurso de la parte superior del embudo de ventas)

Guía (recurso de la parte media del embudo de ventas)

Ebook del cliente (recurso de la parte inferior del embudo de ventas)

Press releases

Press release de VTEX
Press release del cliente

Videos

Guion del cliente

Guion para entrevistas internas

Idioma estándar

Utilizamos español LATAM en nuestros textos, ya que la mayoría del contenido se dirige a América Latina. Sabemos que cada país tiene sus variantes, pero tratamos de mantener los términos lo más neutro posible.

Algunas pautas generales

En algunos casos, los textos se adaptan a español de España.

Puntuación

Comillas

Dado que la mayoría de nuestros textos solo se publican online, utilizamos las comillas inglesas (" ") como norma, y no las comillas angulares (« »).

Por ejemplo: El título de la sección es "Pautas de redacción".

Reserva las comillas simples para cuando deban entrecomillarse partes de un texto ya entrecomillado.

Por ejemplo: Antonio me contó: "Le dije al cliente: 'Te encantará la nueva funcionalidad de esta solución', y no me equivoqué".

Recuerda que las comillas de cierre se usan:

- antes de comas y puntos.

- después de otros signos de puntuación.

Excepción:

- El signo de puntuación forma parte del material citado; en este caso, escríbelo entrecomillado.

- Si las comillas indican un elemento de la interfaz de usuario.

El guion y la raya

El guion (-) es un signo de puntuación que se utiliza para unir palabras o partes de palabras e indicar intervalos de tiempo o rangos de cifras.

La raya (—) es un signo de puntuación que se puede utilizar en lugar de los paréntesis o las comas para introducir un inciso dentro de un texto más extenso. Las rayas se escriben pegadas a la primera y a la última palabra del inciso que enmarcan, y separadas por un espacio de la palabra o signo que las precede o las sigue; pero si lo que sigue a la raya de cierre es otro signo de puntuación, no se deja espacio entre ambos.

Notas a pie de página y notas finales

Los números de las notas a pie de página o de las notas finales deben ir después de los signos de puntuación al estilo inglés y colocarse preferentemente al final de una frase.

Referencia de la Fundeu.

Por ejemplo:

🚫 El valor medio del pedido (AOV) de ese retailer es de aproximadamente USD 701.

✅  El valor medio del pedido (AOV) de ese retailer es de aproximadamente USD 70.1

Números

Números vs. palabras

Escribe en letras todo número menor que 10 (incluido el 10), por ejemplo, uno, dos, tres, etc. Si es mayor que 10, escríbelo con dígitos (por ejemplo, 43 775).

❗Excepción: puedes no escribir en letras un número menor que 10 cuando aparece en un título porque se comprobó que la presencia de números en los títulos aumenta el porcentaje de clics.

Evita incluir números al principio de una oración, pero si es imprescindible que lo hagas, escríbelos con palabras.

Por ejemplo:

🚫 50 % de los compradores optaron por la recogida en tienda.

✅  La mitad / El cincuenta por ciento de los compradores optaron por la recogida en tienda.

Cuando escribas un número del 1 al 9 (por ejemplo, en fechas o importes), no antepongas un 0.

Por ejemplo:

🚫 El producto salió a la venta el 08 de octubre a un precio especial de solo USD 9.90.

  El producto salió a la venta el 8 de octubre a un precio especial de solo USD 9.90.

Separadores

Los números de hasta cuatro cifras (miles) se escriben juntos, sin separador. Para los números de más de cuatro cifras, utiliza un espacio fijo (non-breaking space) como separador. Las cifras se agruparán de tres en tres, empezando por la derecha, y separando los grupos con espacios en blanco. Por último, utiliza el punto para marcar los decimales.

Por ejemplo:

Referencias:
-
Separador de miles

Puedes utilizar las siguientes abreviaturas para acortar números grandes en textos informales:

Moneda

Cuando escribas importes, indica primero la moneda, agrega un espacio y, luego, escribe el monto. De acuerdo con los lineamientos de la norma ISO 4217 (Códigos de divisas), utiliza simplemente "USD" para expresar dólares estadounidenses. Utiliza "BRL" para expresar reales brasileños. Utiliza "EUR" para expresar euros. Y utiliza "GBP" para expresar libras esterlinas".

Fechas

Utilizamos el formato día-mes-año. 

Utiliza números cardinales (uno, dos, tres) en lugar de ordinales (primero, segundo, tercero).

Por ejemplo: Daniel nació el 13 de mayo.

Escribe una coma entre el día de la semana y la fecha.

Por ejemplo: Mi último día de trabajo fue el lunes, 5 de mayo de 2020.

Formato de la hora

Seguimos el modelo de 12 horas. Por lo tanto, utiliza minúsculas para a. m. y p. m., con puntos y espacio. No olvides agregar un espacio entre la hora y a. m. o p. m. Si es una hora exacta, no es necesario incluir ":00".

Por ejemplo: 6 p. m. | 6:30 a. m. | 8 p. m.

Cuando son las doce de la mañana, se recomienda la abreviatura m. (12 m.)

Cuando escribas una hora para Brasil, incluye el formato GMT.

Por ejemplo: 10:30 a. m. São Paulo (GMT-3).

Símbolos

Incluye un espacio entre el número y la unidad de medida. Siempre que sea posible, utiliza un espacio fijo (non-breaking space).

Por ejemplo: 5 MB

Cuando la unidad es un símbolo y no una abreviatura (letras), no se utiliza ningún espacio, a excepción del símbolo del porcentaje.

Por ejemplo: 36 %, 5’, 1.º

Si tienes dudas, puedes consultar aquí las claves.

Uso de mayúsculas

Títulos y encabezados

Escribe siempre en mayúsculas la primera palabra de un título, independientemente de su categoría.

Nunca escribas un título o un encabezado todo en mayúsculas (ni ninguna parte del texto).

No utilices puntos ( . ) en títulos o encabezados.

La plataforma de comercio con mayor tasa de crecimiento es VTEX, según IDC

🚫 La Plataforma de Comercio con mayor Tasa de Crecimiento es VTEX, Según IDC.

Si deseas utilizar dos puntos ( : ), considera que el título sigue siendo la misma frase, por lo tanto no hay razón para usar mayúsculas.

Comercio composable: la nueva era de la transformación digital

Si escribes un artículo para una publicación del blog, el título debe tener menos de 70 caracteres para asegurarte de que los motores de búsqueda lo muestren completo. En el caso de los ebooks, el título y el subtítulo (si lo hay) no deben superar los 200 caracteres en total. Puedes utilizar esta sencilla herramienta para comprobar la extensión del título.

Títulos de obras

Los títulos de obras completas como libros, periódicos, ebooks, documentos técnicos, películas, series o álbumes de música deben ir en cursiva.

Los títulos de obras breves como poemas, artículos, relatos, capítulos, episodios o canciones deben ir entre comillas.

Los títulos de libros que forman un conjunto más amplio pueden ir entre comillas si el nombre de la serie de libros está en cursiva.

Abreviaturas / Acrónimos

Hay ciertas abreviaturas y acrónimos que utilizamos ampliamente en nuestros textos; por lo tanto, no es necesario explicarlos, ya que son muy conocidos. Cabe resaltar, que muchos acrónimos de tecnología y negocios se mantienen con sus siglas en inglés. Sin embargo, a diferencia del inglés, no se utiliza "s" para marcar el plural, aunque sí se pronuncie oralmente. Utiliza las siguientes grafías:

Interfaz de programación de aplicaciones

API

Empresa a empresa (Business-to-business)

B2B

Empresa a cliente (Business-to-consumer)

B2C

Empresa a empresa a empresa (Business-to-business-to-business)

B2B2B

Empresa a empresa a cliente (Business-to-business-to-consumer)

B2B2C

Empresa a empleado (Business-to-employee)

B2E

Enfermedad del coronavirus

COVID-19

Directo al consumidor

DTC

América Latina

LATAM

Sistema de gestión de pedidos

OMS

Punto de venta

POS

Software como servicio

SaaS

Unidad de mantenimiento de stock

SKU

Estados Unidos de América

EE. UU.

Si deseas utilizar una abreviatura o acrónimo no tan conocido, escribe el significado completo la primera vez que aparece en el texto y menciona la abreviatura o el acrónimo entre paréntesis. En lo sucesivo, puedes utilizar la versión abreviada si así lo deseas.

Por ejemplo: En la actualidad, las empresas europeas deben tener en cuenta el Reglamento General de Protección de Datos (RGPD). El RGPD está vigente desde 2016 y puede acarrear cuantiosas multas a los retailers que no lo respeten.

Citas

En las publicaciones del blog y en los ebooks, separa las citas de clientes del cuerpo de la nota. En los textos destinados a relaciones públicas y otros, mantén las citas dentro de los párrafos.

Puedes editar las citas, pero no modificar el mensaje. En general, las citas son más impactantes si son breves y directas, así que elimina todo lo que no aporte valor. También puedes modificar o agregar palabras, pero mínimamente, solo para pulir el mensaje.

Negrita, cursiva y subrayado

La audiencia puede identificar rápidamente el énfasis que quieres asignar a determinadas palabras u oraciones. Utiliza la negrita y la cursiva, pero con moderación: si destacas todo, entonces, nada resalta. Te compartimos algunas pautas básicas:

VTEX

Nombre de la empresa

Siempre escribimos "VTEX" en mayúsculas.

Además, nuestra solución oficial debe escribirse VTEX Commerce Platform.

Tagline

Nuestro lema debería ser siempre: "La plataforma empresarial de comercio digital".

Boilerplate

Acerca de VTEX

VTEX (NYSE: VTEX) es la plataforma global de comercio digital donde los CEO y CIO visionarios encuentran eficiencia para sus ventas digitales. Nuestra plataforma composable y completa ayuda a las marcas y a los retailers a modernizar su stack y reducir los costes de mantenimiento mediante la rápida migración desde sistemas de código propio, conectando completamente toda la cadena de valor y unificando múltiples modelos de negocio en un solo lugar.

Como líder en plataformas de comercio digital, VTEX cuenta con la confianza de más de 2600 clientes B2C y B2B, entre ellos, Carrefour, Colgate, Motorola, Sony, Stanley Black & Decker y Whirlpool, con más de 3400 tiendas online activas en 38 países (datos del ejercicio fiscal que finalizó el 31/12/2022). Para más información, visita www.vtex.com.

Marcas y empresas

A continuación, incluimos una lista de marcas y empresas de VTEX junto con sus nombres oficiales. ¡Adhiérete siempre a ella!

GoCommerce

Indeva

Loja Integrada

VTEX HUB

Eventos y programas educativos

A continuación, incluimos una lista de los eventos y programas de VTEX y sus nombres oficiales. ¡Adhiérete siempre a ella!

COMMEX

VTEX Connect LATAM

VTEX Internship

DCS

VTEX Code Cup

VTEX Lab

DCX

VTEX DAY

VTEX Talks

EICOM

VTEX Gran Prix

VTEX Training Day

TETRIX

VTEX Hackathon

VTEX Accelerator

VTEX Immersion

Productos

A continuación, incluimos una lista de productos VTEX y sus nombres oficiales. ¡Adhiérete siempre a ella!

VTEX Assisted Sales

VTEX Intelligent Search

VTEX Shipping Network

VTEX Conversational Commerce

VTEX Live Shopping

VTEX Smart Checkout

VTEX Extensions Hub

VTEX Personal Shopper

VTEX Store Framework

VTEX Insurance

VTEX Pick and Pack

VTEX Tracking

VTEX IO

VTEX Sales App

Equipos y funciones

En general, consulta el organigrama en Workday cuando menciones una función interna de la empresa.

Escribe el nombre de los equipos, áreas y departamentos en mayúsculas. No escribas los cargos en mayúsculas a menos que se trate de una abreviatura de una función de nivel C (por ejemplo, CEO, CFO, etc.)

Por ejemplo:

  Lucas Bacic, head de Core Marketing, dirigió la iniciativa.

  Santiago Naranjo, CRO de VTEX, dijo que los resultados fueron magníficos.

Al referirte a Mariano y Geraldo, utiliza siempre sus títulos completos:

  Mariano Gomide de Faria, fundador y co-CEO de VTEX

  Geraldo Thomaz, fundador y co-CEO de VTEX

Términos mantenidos en inglés

backend

framework

partner

click-and-collect

frontend

retailer

digital-first

headless

seller

ebook

last mile

storefront

ecommerce

link

time to market

email

marketplace

time to revenue

endpoint

omnichannel

whitepaper

Términos traducidos

Publicación del blog

Blogpost

(Tienda) física

Brick-and-mortar

Envío directo

Dropship

(Datos) propios

First-party

Microservicios

Micro-services

Recogida en la tienda

Pickup in store

Envío desde la tienda

Ship from store

(Seller) externo

Third-party

Términos preferenciales cuando hay variaciones

🚫

adquirente

adquiriente

aplicación

app

auto

automóvil/coche/carro

gestión/gestionar

administración/administrar

ícono

icono

periodo

período

solo

sólo

video

vídeo

zona horaria

fuso horario


Conjunto de herramientas

Guía de estilo y glosario de Product Localization

Puedes encontrar la Guía de estilo de español del equipo de Product Localization de VTEX aquí y el glosario trilingüe (EN, ES y PT), con términos, definiciones y referencias, aquí.

Stilus

Stilus es un corrector eficaz de ortografía, gramática y estilo en español.

Diccionario de la Real Academia Española

El diccionario de la Real Academia Española es una herramienta bastante útil para confirmar el significado de las palabras y encontrar sinónimos y palabras nuevas en general.

Statista

Para los contenidos basados en datos, puedes utilizar Statista para mejorar tus conclusiones y proporcionar estadísticas sobre tendencias de mercado y datos de consumo. Disponemos de datos limitados para estadísticas prémium, pero comunícate con nosotros para obtener los datos que estás buscando.

\ No newline at end of file diff --git a/content/marketing_style_guides/Writing Style Guide - ES/images/image1.png b/content/marketing_style_guides/Writing Style Guide - ES/images/image1.png new file mode 100644 index 0000000..8a88466 Binary files /dev/null and b/content/marketing_style_guides/Writing Style Guide - ES/images/image1.png differ diff --git a/content/marketing_style_guides/Writing Style Guide - ES/images/image2.png b/content/marketing_style_guides/Writing Style Guide - ES/images/image2.png new file mode 100644 index 0000000..e3caffc Binary files /dev/null and b/content/marketing_style_guides/Writing Style Guide - ES/images/image2.png differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - EN.zip b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN.zip new file mode 100644 index 0000000..e2d20da Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN.zip differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/VTEXWritingStyleGuideEN.html b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/VTEXWritingStyleGuideEN.html new file mode 100644 index 0000000..7a32fbb --- /dev/null +++ b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/VTEXWritingStyleGuideEN.html @@ -0,0 +1 @@ +

VTEX

Writing

Style Guide -

English

Volume 1 – Marketing & External Communication

Created by: Thalita Sdroiewski Uba

Last updated: 12 de jul.

Table of Contents

Introduction

Tone of Voice

Core elements

Personality

Writing good practices

Writing guidelines

Formats

Standard language

Gender-neutral language

Stative verbs

Punctuation

Commas

Lists

Quotation marks

Dashes and hyphen

Numbers

Numerals vs. words

Separators

Currency

Dates

Time format

Symbols

Capitalization

Concepts

Titles and headings

Abbreviations / Acronyms

Compound and hyphenated words

Quotes

Bolding, italicizing, and underlining

Specific terminology

Application x Registration

Click vs. Click on vs. Click at

Client x Customer

Commerce expert x Commerce specialist

Data

Especially x Specially

Indefinite preposition a/an with SKU

Live shopping

Log in to vs. Log into

VTEX

Company name

Tagline

Boilerplate

Brands & Companies

Events & Educational Programs

Products

Teams and Roles

Toolbox

Grammarly

The Free Dictionary

Statista

Welcome, marketing and communication professionals!

This Writing Style Guide was created specially for you. This is the first volume of a series of Style Guides that will help us ensure consistency across the content we produce at VTEX.

WHY

Our goal here is to improve readability and build consistency to deliver the best content possible to our target audience. That's where the Style Guide comes in: a practical and easy-to-read guide through our writing world. Here, you will find standards regarding tone of voice, punctuation, capitalization, numbers, dates, and terminology, and also some good practices that should be followed by anyone who writes any sort of text on behalf of the company.

HOW

Use it as consulting material whenever you're about to start a new text that falls within the following categories: blog articles, customer pages, ebooks, guides, press releases, social media posts, solution briefs, scripts, whitepapers, and other formats targeted toward external audiences. And don't forget to check it after you're done, when reviewing the text.

WHAT

This guide was written for all marketing and institutional communication professionals that write content for external audiences—earned, paid, or owned media. It does not contemplate internal communication and Product content (yet!).

For further information, please visit the #content Slack channel or contact Thalita Uba via Slack (@thalita.uba) or at thalita.uba@vtex.com.br.

Tone of Voice

VTEX's voice represents our core brand elements in the way we communicate. It ensures that our writing embodies VTEX's personality and quality standards across all touchpoints.

It's really important that our tone of voice is standard throughout the whole company. That's why we need to be perfectly aligned with our brand guidelines.

Tone = Context

Before writing a text, ask yourself: what's the purpose of this piece? Is it supposed to catch people's attention? Do I want to explain a concept or communicate with our clients directly? Am I trying to catch someone's attention or communicating a failure within our platform? Our tone should adapt based on the user's and the message's context. Use the answers as a guide to find the right tone.

Voice = Personality

The Brand team grounded VTEX's personality in three pillars: boldness, trustworthiness, and optimism. 

We are bold

We are technology and commerce specialists building our authority in the market. Our boldness lies in our capacity to be provocative, avoid fluffy words, and go straight to the point.

We are trustworthy

We're serious and soothe our clients' anxieties. Our words must convey precision, and not trigger doubts. We're reliable, we mean what we say. Our clients know they can count on us.

We are optimistic

We have many opportunities to explore, and the future is bright. We chase new opportunities, and we don't run away from challenges. Instead, we try to find a solution without pointing fingers at our competitors or audience.

Let's take a look at some examples:

Take the next step in your commerce journey. Deploy, test, and scale with more agility and less risk with the VTEX Enterprise Digital Commerce Platform.

Give customers the choice and convenience they want while running an efficient omnichannel operation.

With over 20 years of digital commerce knowledge, our team of specialists is here to guide you through your journey.

This is what we get when we put it all together:

VTEX is not the hero

The audience is the hero, and VTEX is their guide. We have so much to deliver to the world, and we tend to place ourselves as protagonists. Let's change this approach: when we present ourselves as a guide, we become the help they need to overcome their challenges. Let's see some examples:

Talking to anybody

🚫 VTEX's distributed OMS is the solution that empowers ecommerce managers to view their complete commerce operation.

Relatable

Take control of your entire commerce operation with VTEX's distributed OMS.

Audience-first

It is never about us. We believe that our communication strategy is the most powerful resource to start a conversation, so it's crucial to understand who we are talking to. Are they from a technology or business background? Are they from an operational role or a leadership position? What are their desires and pains? Try to address what our audience is looking for specifically. Avoid generic messages that try to talk to everybody and end up talking to no one. Let's see some examples:

Generic

🚫 VTEX launches a new SKU bulk loader that makes it easier to upload hundreds of SKUs to your store.

Empowering

Uploading hundreds of thousands of SKUs used to take several hours of your day. With the SKU bulk loader, you can have all those hours back.

Simple and direct

Be straightforward. As a complex solution, we already use many concepts and specific jargon, so we must make our texts as clear and direct as possible. Anyone reading our announcements should be able to relate to what we are saying. Also, avoid repetitions and ambiguities. Always re-read your text to make sure there aren't too many repeated or unclear terms/ideas.

A bunch of noise

🚫 You can export complete reports with your store's main KPIs and assess if it's the best way to accomplish your organization's objectives. 

On point

Use complete performance reports to keep track of the efficiency of your operation.

Long story short:

Always know who you are talking to.

✅ Our audience is the protagonist of every message. VTEX is the guide.

✅ Keep it simple and straight to the point.

✅ Find the balance between boldness, trustworthiness, and optimism to achieve the right tone.

Good practices

Readability tells us how clear and accessible our texts are. Content that is easier to understand will be easier to navigate. Thus, a readable text not only pleases Google when it ranks our pieces, but it also pleases the reader.

Here are some rules of thumb for good readability scores:

✅ Keep your sentences and paragraphs short and concise.

✅ Keep similar and complementary ideas within the same paragraph.

✅ Start a new paragraph when you want to present a new idea or point.

✅ Avoid creating one-sentence paragraphs.

✅ Use active voice as much as possible.

✅ Replace long words with short synonyms, if possible.

Jargon and fancy words should be kept to a minimum.

✅ Adapt to your audience.

Guidelines

Formats

These are the most common text formats that we produce here at VTEX:

Website content

Article (VTEX Blog/Linkedin)

Customer page (currently us-en/cases/) - follow this template here

Ebooks

Whitepaper (Top-funnel asset)

Guide (Mid-funnel asset)

Customer ebook (Bottom-funnel asset)

Press releases

VTEX press releases

Customer press releases

Videos

Customer script

Internal interviews script

Standard language

The standard language for VTEX content is US English, which means:

Color

🚫 Colour

(No U after O)

Favorite

🚫 Favourite

Center

🚫 Centre

(TER, and not TRE)

Theater

🚫 Theatre

Centralize

🚫 Centralise

(ZE, and not SE)

Apologize

🚫 Apologise

Eventually, some of our content will be adapted to British English, but unless you're writing specifically for this audience, please make sure you're following the American English rules.

Gender-neutral language

You can use the singular "they" as a generic third-person singular pronoun to refer to a person whose gender is unknown or irrelevant to the context.

❗REMEMBER❗

When “they” is the subject of a sentence, it takes a plural verb regardless of whether “they” is meant to be singular or plural. Therefore, always write "they are" (and not "they is").

Stative verbs

Stative verbs describe a state rather than an action. We don't use them in the continuous form.

Here's a list of stative verbs.

agree

hear

possess

appear

imagine

prefer

astonish

impress

promise

be (=part of who you are)

include

realize

believe

involve

recognize

concern

know

remember

consist

lack

satisfy

contain

like

see (=understand)

deny

look (=seem)

seem

depend

love

smell (=have a certain smell)

deserve

matter

sound

disagree

mean

suppose

dislike

measure

surprise

doubt

mind

taste (=have a certain taste)

feel (=have an opinion)

need

think (=have an opinion)

fit

owe

understand

hate

own

want

have (=own)

please

wish

Examples:

🚫 This coffee is smelling good.

This coffee smells good.

🚫 He is seeming happy at the moment.

 He seems happy at the moment.

Punctuation

Commas

General rules:

USE

🚫 DON'T USE

To separate independent clauses joined by coordinating conjunctions: and, but, for, or, nor, so, yet.

Black Friday was over, but the results kept on coming.

Before "because".

🚫 You don’t need to create a new policy, because the same one can be used for different sales channels.

After introductory clauses, phrases, or words that come before the main clause, such as: therefore, however, thus, additionally, moreover, furthermore, firstly, lastly, consequently, in conclusion, on the other hand, in the beginning, today, when.

When the results came, everyone was surprised.

When the subject has two verbs.

🚫 We sent our proposal to the client, and scheduled a meeting with the supplier.

Before and after nonessential clauses.

VTEX, the fastest-growing platform according to IDC, has secured new funding.

Before "so" when you can add "that" after it.

🚫 The leaders shared their results, so the employees were all up-to-date.

To separate three or more words, phrases, or clauses written in a series (aka Oxford comma).

The new product has been adopted in England, Spain, and France.

Between the subject and the verb(s).

🚫 VTEX and its partners, have decided to launch the release earlier.

To separate the month and day from the year.

The company reached its goal on October 3, 2020.

Before and after direct quotations.

The director said, "Our revenue increased 300% with the new tool", said the director.

Lists

When there is a list of items, use periods at the end of each item, rather than commas or semicolons. Capitalize just the first word, unless they're all titles (books, articles, songs, etc.)

Example:

This is our current action plan:

Exception: Website texts that have a limited number of characters.

Quotation marks

In most content, use double quotation marks (" "), not single quotation marks (' ').

Example: The section title is "Writing guidelines."

Only use single quotation marks when nesting a quotation inside another quotation.

Example: He said, "I told the client, 'You will love the new feature', and I wasn't wrong."

In online content, use straight quotation marks (" "). In printed content, use curly quotation marks (“ ”).

Place closing quotation marks:

- Outside commas and periods.

- Inside other punctuation.

Exception:

- If punctuation is part of the quoted material, place it inside the quotation marks.

- If the quotation marks are indicating a UI element

Dashes and hyphen

A hyphen (-) is a punctuation mark that is used to join words or parts of words only.

An en dash (–) is a punctuation mark that is used to indicate intervals of time or ranges of numbers

An em dash (—) is a punctuation mark that can be used to replace parentheses or a colon to create emphasis in your writing. Do not add spaces before or after the em dash.

Footnotes and endnotes

Footnote or endnote numbers in the text should follow punctuation and preferably be placed at the end of a sentence.

Examples:

🚫 For that same retailer, the average order value (AOV) the retailer sees is about USD 701.

 For that same retailer, the average order value (AOV) the retailer sees is about USD 70.1

Numbers

Numerals vs. words

If a number is under 10 (including 10), spell it out (e.g. one, two, three, etc.) If it is over 10, write it using digits (e.g. 43,775).

❗Exception: You can refrain from spelling out numbers under 10 if they are present in the title because having numbers in titles has been shown to increase the click-through rate.

Avoid writing numbers at the beginning of the sentence, but if it’s a must, spell it out.

Example:

🚫 50% of shoppers have opted for pick-up in-store.

Half / Fifty percent of the shoppers have opted for pick-up in-store.

When writing a figure from 1 to 9 (in dates or amounts, for example), don't add a 0 in front of it.

Example:

 🚫 The product was released on October 08 for a special price, only USD 9.90.

 The product was released on October 8 for a special price, only USD 9.90.

Separators

Thousands, millions, billions, etc., should be indicated with commas (4,000; 10,500, and so on), and decimals should be indicated with periods (0.20; 0.67, and so on).

You can use large number abbreviations for informal pieces the following way:

Currency

When writing money figures, specify the currency first, add a space, then write the amount. Following the guidelines of ISO 4217 (Currency Codes), the symbol used for American dollars should be just "USD". For Brazilian Reais, the symbol used should be "BRL". For Euros, the symbol used should be "EUR". For British Pounds, the symbol used should be "GBP".

For other currencies, please follow the Economist's guidelines.

❗REMEMBER❗

Thousands, millions, billions, etc. should be indicated with commas, and decimals should be indicated with periods.

🚫 US$ 20 / USD 20$ / $US 20 / $ 20/ $20 USD

🚫 R$ 100.80

 USD 20

✅ BRL 100.80

✅ GBP 3,100.50

✅ EUR 10,590,800.30

Dates

We use the month-day-year format.

Use cardinal numbers (one, two, three) rather than ordinal numbers (first, second, third).

Example: Daniel was born on May 13.

Place commas after the day of the week, the day, and the year.

Example: My last day of work was Monday, May 5, 2020.

Time format

Use lowercase a.m. and p.m., with periods. Do not forget to add a space between the time and the a.m. or p.m. If it's an exact hour, no “:00” is required.

Examples: 6 p.m. | 6:30 a.m. | 8 p.m.

When a time is given in Brazil time, include the GMT format.

Example: 10:30 a.m. São Paulo (GMT-3).

Symbols

Use space between the number and the unit of measure.

Example: 5 MB

When the unit is a symbol and not an abbreviation (letters), no space is used.

Example: 36%, 5’

Capitalization

Concepts

Some of our most commonly-used words include composable, marketplace, omnichannel, headless, and microservices. Do not capitalize these unless they’re at the beginning of a sentence!

Only use capitalization of words when they imply a concept, rather than something tangible. Some of the concepts we regularly use, coupled with their associated meaning, are:

Commerce, Marketplace, and OMS solution = It's the official "full name" of VTEX's solution.

Composable Commerce = The modern approach by which a business is empowered to select and assemble various commerce solutions and use them to satisfy specific commercial requirements.

Headless Commerce = Ecommerce architecture where the front-end (head) is decoupled from the backend commerce functionality and can thus be updated or edited without interfering with the backend.

Headless Fatigue = Slow-paced evolution and loss of focus due to developer dependency and infrastructure maintenance after companies choose to build more than they can handle using headless technology.

Order Management System (OMS) = Computer software system used in a number of industries for order entry and processing.

Time to Revenue = Estimated period between the time a product or service is launched and when a business starts generating revenue or earning profits.

Unified Commerce = Combines in one platform ecommerce, m-commerce, order fulfillment, inventory management, customer relationship management, point of sale (POS) capabilities—and much more.

Titles and headings

Nouns, pronouns, verbs, adjectives, and adverbs should be capitalized in titles and headlines.

Do not capitalize conjunctions, prepositions, and articles.

Always capitalize the first word and the last word of a title, regardless of their category.

Never write a title or a heading in all caps (or any part of a text, for that matter).

Do not use periods ( . ) in titles or headings.

The commerce platform with the fastest growth rate is VTEX, according to IDC

🚫 The Commerce Platform With the Fastest Growth Rate Is VTEX, According to IDC.

If you want to use a colon ( : ) in your title, treat the two parts of your title as one sentence each, meaning both parts should be capitalized using a sentence case.

Composable Commerce: The new era of digital transformation

If you’re writing a blog article, keep your title under 70 characters to ensure it will be displayed completely by search engines. For ebooks, your title and subtitle (if any) together should not go above 200 characters. You can use this simple tool to double-check the length of your title.

Titles of works

Titles of full works like books, newspapers, ebooks, whitepapers, movies, series, or music albums should be italicized.

Titles of short works like poems, articles, short stories, chapters, episodes, or songs should be put in quotation marks.

Titles of books that form a larger body of work may be put in quotation marks if the name of the book series is italicized.

Abbreviations / Acronyms

There are certain abbreviations and acronyms that we use widely across our content pieces that do not necessarily require an explanation because they’re so well-known. Please use the following spellings:

Application programming interface

API

Business-to-business

B2B

Business-to-consumer

B2C

Business-to-business-to-business

B2B2B

Business-to-business-to-consumer

B2B2C

Business-to-employee

B2E

Buy online, pick up in-store

BOPIS

Coronavirus disease

COVID-19

Direct-to-consumer

DTC

Latin America

LATAM

Microservice-based, API-first, cloud-native, headless

MACH

Order Management System

OMS

Point of sale

POS

Software as a service

SaaS

Stock Keeping Unit

SKU

United States of America

US / USA

If you want to use a less-common abbreviation or acronym, please state the words in full the first time they appear in the text and mention the abbreviation/acronym in parentheses. From then on, feel free to use the shortened version.

Example: European businesses need to now take into account the General Data Protection Regulation (GDPR). The GDPR has been active since 2016 and can bring hefty fines to retailers not abiding by it.

Compound and hyphenated words

As the English language evolves, lots of word associations are becoming compound words. There are three ways to write these: open compound (spelled as two words, e.g. ice cream), closed compound (joined to form a single word, e.g. notebook), and hyphenated compound (words joined by a hyphen, e.g. long-term).

Here are some of the compounds we use regularly that should be written consistently throughout our content:

🚫

Backend

Back-end; back end

blog article

Blog post

Brick-and-mortar (store)

Brick and mortar

Click-and-collect

Click and collect

Digital-first

Digital first

Dropship

Drop ship; drop-ship

Ebook

E-book

Ecommerce

E-commerce

Email

E-mail

First-party (data)

First party; 1st party; 1P

Frontend

Front-end; front end

Microservices

Micro services; microsservices

Pickup in store

Pick up in store; pick-up in store, pickup in-store

Ship from store

Ship-from-store

Third-party (seller)

Third party; 3rd party; 3P

Time to market

Time-to-market

Time to revenue

Time-to-revenue

Whitepaper

White paper; white-paper

Use a hyphen if two or more words are functioning as an adjective before a noun: fastest-growing platform; world-class retailer; user-friendly UX, etc.

Quotes

In blog articles and ebooks, separate customer quotes from the body paragraphs. In PRs and other texts, keep the quotes within the paragraphs.

You may edit quotes, but do not change the message. Generally, quotes are more impactful if they are shorter and direct, so cut out what doesn’t deliver value. You can also alter or add words, but minimally, only to polish the message.

Bolding, italicizing, and underlining

Special emphasis on words/phrases will help your audience easily scan your content. Use bold and italics, but do it sparingly: if everything is emphasized, then nothing truly is. Here are some basic guidelines:

Specific terminology

App x Application

Applications are software programs that perform various functions developed for end-users to accomplish specific computing tasks.

Apps are a type of application software that performs a single function, usually on mobile devices.

Application x Registration

The word "application" refers to a process that may also involve interviews and tests. There's a chance of rejection.
T
he word "registration" refers to a process in which you fill in a form, send your documents, maybe pay a fee, and then get the confirmation of your enrollment. There's no chance of rejection.

Click vs. Click on vs. Click at

Click is about pressing a mouse button to select a link or item on the screen. Use "click" as a transitive verb that acts as an action verb and has a direct object—this means that no preposition is required after the verb.

🚫 In the Parameter Details column, click on the Edit button.

To save changes made to the parameter settings, click Save.

Collaborative commerce

Do not use the expression "collaborative commerce" in any of your texts.

Commerce expert x Commerce specialist

Avoid using the expression "commerce expert". Instead, use "commerce specialist."

Data

Treat “data” as a singular noun.

Especially x Specially

Use "especially" in the sense of "mainly."

Use "specially" in the sense of "for a particular purpose."

Future-proof

Do not use the expression "future-proof" in any of your texts.

SKU

SKU can be pronounced as individual letters or as a syllable. This changes the form of the indefinite preposition that should precede it.

An “S”-“K”-“U” / A “SKU”

We assume the “SKU” pronunciation and use the article “a.”

Live shopping

When talking about the concept, please only use "live shopping". See how we got to this naming convention here.

✅ Live shopping

🚫 Live commerce

🚫 Livestream ecommerce

🚫 Any other term combination

Log in to vs. Log into

Log in is a phrasal verb that means that you connect to a machine (such as a host, server, workstation, and so on) or authenticate to a user interface by providing your credentials. In this case, "to "is a preposition that links the phrasal verb to the upcoming word.

That is why the correct spelling is log in to not log into.

🚫 Log into the VAO UI as a VAO Administrator or Plan Author.

Log in to the VAO UI as a VAO Administrator or Plan Author.

🚫 Log into the machine where Veeam ONE Monitor Client is installed.

Log in to the machine where Veeam ONE Monitor Client is installed.

VTEX

Company name

We always write "VTEX" in all caps.

Likewise, our official solution should be referred to as VTEX Commerce Platform.

Tagline

Our tagline should always be The Enterprise Digital Commerce Platform.

Boilerplate

About VTEX

VTEX (NYSE: VTEX) is the enterprise digital commerce platform where forward-thinking CEOs and CIOs smarten up their investments. Our composable and complete platform helps brands and retailers modernize their stack and reduce maintenance costs by rapidly migrating from legacy systems, connecting their entire value chain, and making inventory and fulfillment their strength.

As a leader in digital commerce, VTEX is trusted by more than 2,600 B2C and B2B customers, including Carrefour, Colgate, Motorola, Sony, Stanley Black & Decker, and Whirlpool, having over 3,400 active online stores across 38 countries (as of FY ended on December 31, 2022). For more information, visit www.vtex.com.

Brands & Companies

Here’s a list of VTEX brands and companies and their official names. Do not deviate from them.

GoCommerce

Indeva

Loja Integrada

VTEX HUB
VTEX CONNECT

Events & Educational Programs

Here’s a list of VTEX events and programs and their official names. Do not deviate from them.

COMMEX

VTEX Code Cup

VTEX Internship

DCS

VTEX Connect LATAM

VTEX Lab

DCX

VTEX DAY

VTEX Talks

EICOM

VTEX Gran Prix

VTEX Training Day

TETRIX

VTEX Hackathon

VTEX Accelerator

VTEX Immersion

Products

Here’s a list of VTEX products and their official names. Do not deviate from them.

VTEX Assisted Sales

VTEX Intelligent Search

VTEX Shipping Network

VTEX Conversational Commerce

VTEX Live Shopping

VTEX Smart Checkout

VTEX Extensions Hub

VTEX Personal Shopper

VTEX Store Framework

VTEX Insurance

VTEX Pick and Pack

VTEX Tracking

VTEX IO

VTEX Sales App

Teams and Roles

Generally, refer back to the org chart on Workday when mentioning an internal role.

Capitalize teams. Do not capitalize roles unless it's an abbreviation of a C-level role (such as CEO, CFO, etc.)

Example:

✅ Lucas Bacic, head of Core Marketing, led the initiative.

✅ Santiago Naranjo, CRO of VTEX, said the results were great,

When referring to Mariano and Geraldo, always use their full titles:

✅ Mariano Gomide de Faria, founder and co-CEO of VTEX

✅ Geraldo Thomaz, founder and co-CEO of VTEX

Toolbox

Grammarly

Grammarly is an AI-powered writing assistant that checks your spelling and grammar and also offers writing suggestions. You can even add it as a Google Chrome extension! Go to the #grammarly Slack channel to sign up for Grammarly Premium access.

The Free Dictionary

The Free Dictionary is a pretty useful tool for confirming the meaning of words and finding synonyms and new words in general. You have access to Thesaurus, Wikipedia, a legal dictionary, an acronyms dictionary, and more within it.

Statista

For data-driven content pieces, you can use Statista to enhance your findings and provide statistics on market trends and consumer data. We have limited data to premium statistics, but do get in touch with us to obtain the data you’re looking for!

\ No newline at end of file diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image1.png b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image1.png new file mode 100644 index 0000000..8a88466 Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image1.png differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image2.png b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image2.png new file mode 100644 index 0000000..e3caffc Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - EN/images/image2.png differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - PT.zip b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT.zip new file mode 100644 index 0000000..dde1e80 Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT.zip differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/VTEXWritingStyleGuidePT.html b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/VTEXWritingStyleGuidePT.html new file mode 100644 index 0000000..87efa4f --- /dev/null +++ b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/VTEXWritingStyleGuidePT.html @@ -0,0 +1 @@ +

Manual de estilo e redação da VTEX -

Português

Volume 1 - Marketing & comunicação externa

Criado por: Thalita Sdroiewski Uba

Última atualização: 18 de jul.

Bem-vindos, profissionais de marketing e comunicação!

Este Manual de estilo e redação foi criado especialmente para você. Trata-se do primeiro volume de uma série de Manuais de estilo e redação que nos ajudarão a garantir a uniformidade no conteúdo que produzimos na VTEX.

POR QUÊ

Nosso objetivo aqui é melhorar a legibilidade e promover a consistência para entregar o melhor conteúdo possível ao nosso público-alvo. É aí que entra o Manual de estilo e redação: um guia prático e fácil de ler sobre o universo da escrita aqui na VTEX. Aqui, você encontrará normas relativas a tom de voz, pontuação, maiúsculas e minúsculas, números, datas e terminologia, além de algumas boas práticas que devem ser seguidas por todos que escrevem qualquer tipo de texto em nome da empresa.

COMO

Use-o como um material de consulta sempre que estiver prestes a iniciar um novo texto que se enquadre nas seguintes categorias: artigo para blog, página de cliente, ebook, guia, comunicado de imprensa, post para redes sociais, script, whitepaper e outros formatos voltados para o público externo. E não se esqueça dar mais uma olhada depois de terminar, quando for revisar o texto.

O QUÊ

Este manual foi escrito para todos os profissionais de marketing e comunicação institucional que escrevem conteúdo para o público externo – sejam mídias próprias, pagas ou orgânicas. Ele não contempla comunicação interna e conteúdo de Product (ainda!).

Para mais informações, acesse o canal #content no Slack ou contate a Thalita Uba pelo Slack (@thalita.uba) ou pelo e-mail thalita.uba@vtex.com.br.

Tom de voz

A voz da VTEX representa os principais elementos da nossa marca na forma como nos comunicamos. Ela garante a incorporação da personalidade e dos padrões de qualidade da VTEX em todos os nossos pontos de contato.

É de extrema importância que nosso tom de voz seja padronizado em toda a empresa. É por isso que precisamos estar perfeitamente alinhados com as diretrizes da nossa marca.

Tom = Contexto

Antes de escrever, pergunte-se: qual é a finalidade deste texto? Minha intenção é prender a atenção das pessoas? Quero explicar um conceito ou me comunicar diretamente com nossos clientes? Estou tentando captar a atenção de alguém ou informando sobre uma falha na nossa plataforma? Nosso tom deve se adaptar com base no contexto do usuário e da mensagem. Use as respostas como um guia para encontrar o tom certo.

Voz = Personalidade

A equipe de Brand fundamentou a personalidade da VTEX em três pilares: ousadia, credibilidade e otimismo. 

Somos ousados

Somos especialistas em tecnologia e comércio, construindo nossa autoridade no mercado. Nossa ousadia está em nossa capacidade de sermos provocadores, evitar palavras pomposas e ir direto ao ponto.

Somos confiáveis

Somos sérios e apaziguamos a ansiedade dos nossos clientes. Nossas palavras devem transmitir precisão, e não gerar dúvidas. Somos confiáveis, falamos a sério. Nossos clientes sabem que podem contar conosco.

Somos otimistas

Temos muitas oportunidades a explorar, e o futuro é promissor. Buscamos novas oportunidades e não fugimos dos desafios. Em vez disso, tentamos encontrar soluções sem apontar o dedo para nossos concorrentes ou nosso público.

Vamos ver alguns exemplos:

 Dê o próximo passo na sua jornada comercial. Implante, teste e escale com mais agilidade e menos riscos com a Plataforma de Comércio Digital Empresarial da VTEX.

Dê a seus clientes a variedade e a conveniência que eles desejam ao mesmo tempo em que conduz uma operação omnichannel eficiente.

Com mais de 20 anos de experiência em comércio digital, nossa equipe de especialistas está aqui para ajudá-lo na sua jornada.

Esse é o resultado que obtemos quando juntamos tudo:

A VTEX não é o herói

O público é o herói e a VTEX é o guia. Temos tanto para oferecer ao mundo que tendemos a nos posicionar como protagonistas. Vamos mudar essa abordagem: quando nos apresentamos como um guia, nos tornamos a ajuda de que eles precisam para superar os desafios. Vamos ver alguns exemplos:

Impessoal

🚫 O OMS distribuído da VTEX é a solução que permite que os gerentes de ecommerce visualizem sua operação comercial por completo.

Pessoal

Assuma o controle de toda a sua operação comercial com o OMS distribuído da VTEX.

Foco no público

Nunca somos o centro das atenções. Acreditamos que nossa estratégia de comunicação é o recurso mais poderoso que temos para iniciar uma conversa, por isso é crucial entender com quem estamos falando. É alguém da área tecnológica ou comercial? Tem um cargo operacional ou de uma posição de liderança? Quais são seus desejos e suas dores? Tente abordar especificamente o que nosso público está procurando. Evite mensagens genéricas que tentam falar com todo mundo e acabam não falando com ninguém. Vamos ver alguns exemplos:

Genérico

🚫 VTEX lança um novo carregador de múltiplos SKUs que facilita o carregamento de centenas de SKUs em sua loja.

Empoderador

✅ Carregar centenas de milhares de SKUs costumava tomar várias horas do seu dia. Com o carregador de múltiplos SKUs, você pode conseguir todas essas horas de volta.

Simples e direto

Seja objetivo. Como uma solução complexa, já usamos muitos conceitos e jargões específicos, por isso devemos tornar nossos textos tão claros e diretos quanto possível. Qualquer pessoa que leia nossos anúncios precisa conseguir se identificar com o que estamos dizendo. Além disso, evite repetições e ambiguidades. Sempre releia seu texto para ter certeza de que não há muitos termos/ideias repetidos ou pouco claros.

Um monte de barulho

🚫 Você pode exportar relatórios completos com os principais KPIs de sua loja e avaliar se essa é a melhor maneira de atingir os objetivos da sua organização.

Direto ao ponto

Use relatórios de desempenho completos para acompanhar a eficiência de sua operação.

Resumindo:

✅ Sempre saiba com quem você está falando.

✅ Nosso público é o protagonista de todas as mensagens. A VTEX é o guia.

✅ Mantenha o texto simples e direto ao ponto.

✅ Encontre o equilíbrio entre ousadia, credibilidade e otimismo para achar o tom certo.

Boas práticas

A legibilidade é a métrica que usamos para saber se nossos textos são claros e acessíveis. Um conteúdo que é fácil de entender também será fácil de navegar. Assim, um texto legível não agrada apenas ao Google quando classifica nossos textos, mas agrada também ao leitor.

Aqui vão algumas regras para uma boa pontuação de legibilidade:

✅ Escreva frases e parágrafos curtos e concisos.

✅ Mantenha ideias similares e complementares dentro do mesmo parágrafo.

✅ Comece um novo parágrafo quando quiser apresentar uma nova ideia ou ponto.

✅ Evite criar parágrafos com uma frase só.

✅ Use a voz ativa o máximo possível.

✅ Substitua palavras longas por sinônimos curtos, se possível.

✅ Utilize o mínimo possível de jargões e palavras rebuscadas.

✅ Adapte o texto ao público.

✅ Evite escrever verbos no gerúndio, especialmente nos títulos.

✅ Evite regionalismos e gírias.

Diretrizes

Formatos

Estes são os formatos de texto mais comuns que produzimos aqui na VTEX:

Conteúdo web

Artigo (VTEX Blog/Linkedin) - siga este modelo aqui

Página de cliente (atualmente us-en/cases/) - siga este modelo aqui

Ebooks

Whitepaper (recurso de topo de funil)

Guia (recurso de meio de funil)

Ebook de cliente (recurso de fundo de funil)

Press releases

Press release da VTEX

Press release de cliente - siga este modelo aqui

Vídeos

Roteiro de cliente

Roteiro de entrevistas internas

Idioma padrão

Utilizamos o português do Brasil como nosso idioma padrão. Em alguns casos, os textos podem ser adaptados ao português de Portugal.

Pontuação

Aspas

Via de regra, use aspas duplas (" ").

Exemplo: O título da seção é "Diretrizes de redação".

Use aspas simples (' ') apenas quando fizer uma citação dentro de outra citação.

Exemplo: Ele falou: "Eu disse ao cliente: 'Você vai adorar a nova funcionalidade', e eu não estava errado."

Para conteúdo online, use aspas retas (" "). Para conteúdo impresso, use aspas curvas (“ ”).

Posicione aspas de fechamento:

- Antes de pontos e vírgulas quando a citação for indireta.

- Depois do ponto final se a citação for direta.

Exemplos:

O diretor afirmou que "as vendas duplicaram no último trimestre".

O diretor afirmou: "As vendas duplicaram no último trimestre."

Travessão, hífen e meia-risca

Hífen (-) é um sinal gráfico usado para unir elementos de palavras compostas (bem-te-vi), ligar verbos a pronomes (disseram-me) e separar sílabas de palavras (ca-sa).

Travessão () é um sinal gráfico usado para separar frases e apostos, isolando um conteúdo que tenha propósito explicativo, ou introduzir perguntas e respostas em diálogos.

Meia-risca (–) é um sinal gráfico usado para unir elementos enumerados em série, como letras ou números, separando as extremidades de um intervalo e indicando ausência.

 

Notas de rodapé e notas de fim

Os números indicativos de notas de rodapé e notas de fim devem ser escritos após os sinais de pontuação e preferencialmente ao final da frase.

Exemplos:

O valor médio do pedido desse mesmo varejista é de aproximadamente US$ 70.1

🚫 O valor médio do pedido desse mesmo varejista é de aproximadamente US$ 701.

Números

Algarismos vs. palavras

Se um número for inferior a 10 (incluindo 10), escreva-o por extenso (por exemplo: um, dois, três etc.) Se for maior que 10, escreva-o em algarismos (por exemplo: 13, 124, 3.876, 43.775).

❗Exceção: Se um número abaixo de dez estiver em um título, você pode escrevê-lo em algarismo, pois a taxa de cliques é maior em títulos que contêm numerais.

Evite escrever números no início das frases, mas se for inevitável, escreva por extenso.

Exemplo:

Metade/Cinquenta por cento dos compradores optaram pela coleta na loja.

🚫 50% dos compradores optaram pela coleta na loja.

Ao escrever um número de 1 a 9 em datas, não acrescente "0" à frente.

Exemplo:

O produto foi lançado em 8 de outubro por um preço especial.

🚫 O produto foi lançado em 08 de outubro por um valor especial.

Ao escrever quantias monetárias exatas, não escreva "00" nas casas decimais.

Exemplo:

O produto foi lançado em 8 de outubro por um preço especial: apenas US$ 90.

🚫 O produto foi lançado em 08 de outubro por um valor especial: apenas US$ 90,00.

Separadores

Milhares, milhões, bilhões etc., devem ser indicados com pontos (4.000; 10.500 etc.), e decimais devem ser indicados com vírgulas (0,20; 3,67 etc.).

Moedas

Ao escrever valores referentes a dinheiro, especifique primeiro a moeda, acrescente um espaço e depois escreva a quantia (R$ 50; US$ 789,90; etc.).
O símbolo usado para dólares americanos deve ser "
US$".
Para Reais, o símbolo utilizado deve ser "
R$".
Para euros, o símbolo utilizado deve ser "
".
Para libras britânicas, o símbolo utilizado deve ser "
£".

Para outras moedas, por favor, siga as diretrizes do Economist.

Datas

Utilizamos o formato dia-mês-ano.

Exemplo: Daniel nasceu em 13 de maio.

Se informar o dia da semana, insira uma vírgula em seguida, antes de informar o dia do ano.

Lembre-se também de que não acrescentamos "0" antes de números de 1 a 9.

Exemplo: Meu primeiro dia de trabalho foi segunda-feira, 5 de maio de 2020.

Horários

Utilizamos o sistema horário de 24 horas. A abreviação utilizada para "horas" é "h". Se for uma hora exata, não é necessário acrescentar ":00". Também não é necessário colocar qualquer abreviação para indicar os minutos.

Exemplos:

🚫

8h

8hs/8hrs/8:00

18h

18hs/18hrs/18:00

2h30

2:30/2h30min/2:30min/2:30h/2hs30mins etc.

20h45

20:45/20h45min/20:45min/20hs45mins etc.

Símbolos

Insira um espaço entre os números e as abreviações de unidades de medida.

Exemplo: 5 MB

Quando a unidade for um símbolo e não uma abreviação (letras), não insira espaços.

Exemplo: 36% | 5'

Maiúsculas e minúsculas

Utilize inicial maiúscula nos seguintes casos:
- Início de frases e títulos.
- Nomes, sobrenomes e apelidos reais ou fictícios (Ana, José, Silva, Souza, Tati, Cadu, Rex, Cinderela, Poseidon).
- Nomes de cidades, estados, países, continentes etc. reais ou fictícios (São Paulo, Argentina, Europa, Pandora)
- Nomes e partes de nomes de instituições, entidades e edifícios (Ministério da Economia, Cruz Vermelha, Universidade Federal do Paraná, ministro das Relações Exteriores).
- Festas e festividades (Natal, Ano Novo, Dia das Crianças, Dia da Independência).
- Nomes de rios, lagos e oceanos (Amazonas, Titicaca, Pacífico).
- Nomes de planetas (Terra, Vênus, Júpiter).
- Disciplinas e cursos (Matemática, Português, Administração, Jornalismo).
- Pontos cardeais quando indicando uma região. (Norte do Brasil, Sudeste Asiático, Sul dos EUA, Leste Europeu).

- Palavra "Estado" quando no sentido de "nação" ou "organização política" (chefe de Estado, deveres do Estado).

- Palavra "Poder" quando se referir aos três poderes da república (Poder Executivo, Poder Legislativo, Poder Judiciário).

- Períodos históricos (Idade Média, Renascimento).

Utilize inicial minúscula nos seguintes casos:

- Palavras "curso", "graduação", "pós-graduação", "mestrado", "doutorado", "pós doutorado" e seus respectivos títulos (portanto: curso de Enfermagem, graduação em Design, mestre em Economia).

- Dias da semana e meses (segunda-feira, sábado, janeiro, novembro).

- Cargos e postos (presidente, vice-presidente, gerente, cônsul).

- Nacionalidades e gentílicos (francês, chileno, canadense).

- Pontos cardeais quando indicando uma direção (no nordeste do Brasil, pelo sul da França).

 

Títulos de artigos, comunicados e outros textos

Sempre escreva a primeira palavra do título com inicial maiúscula. As palavras seguintes devem iniciar com minúscula, a menos que se encaixem em uma das categorias citadas na seção "Maiúsculas e minúsculas".

Nunca escreva um título inteiro com todas as letras maiúsculas (ou qualquer outra palavra que não seja um acrônimo ou sigla).

Não coloque ponto final em títulos, mesmo entre seções.

VTEX é a plataforma de comércio com a taxa de crescimento mais rápida

🚫 VTEX É a Plataforma de Comércio com a Taxa de Crescimento Mais Rápida.

Se for usar dois pontos ( : ) em seu título, trate as duas partes do título como uma frase única, ou seja, a oração que se inicia após os dois pontos deve começar com letra minúscula.

Comércio composable: a nova era da transformação digital

Quando estiver escrevendo um artigo para blog, o título deve ter menos de 70 caracteres para garantir que será exibido inteiro pelos mecanismos de busca. Para ebooks, título e subtítulo (se houver) juntos não devem ultrapassar 200 caracteres. Você pode usar esta ferramenta aqui para confirmar o tamanho do seu título.

Nomes de obras

Títulos de obras completas, como livros, jornais, ebooks, whitepapers, filmes, séries ou álbuns de música devem ser escritos em itálico.

Títulos de obras curtas, como poemas, artigos, contos, capítulos, episódios, ou canções devem ser colocados entre aspas.
Exemplos:
✅ O episódio "Ozymandias", da série
Breaking Bad, é o episódio mais bem-avaliado de um seriado televisivo no IMDB.
Laços de família, livro de Clarice Lispector que contém o famoso conto "A menor mulher do mundo", é o preferido de muitos leitores.

Se for feita referência a um conjunto de obras que forma uma série ou equivalente, então o nome do conjunto deve vir em itálico e o nome da obra deve vir entre aspas.
Exemplo:
✅ O livro "O retorno do rei", terceiro volume da trilogia
O senhor dos anéis, inspirou o filme que venceu 11 prêmios no Oscar de 2004.

Abreviaturas / Siglas

Frequentemente, usamos algumas abreviações e siglas que não precisam necessariamente de uma explicação por serem amplamente conhecidas. Escreva-as da seguinte forma:

Application Programming Interface

API

Business-to-business (empresa para empresa)

B2B

Business-to-consumer (empresa para consumidor)

B2C

Business-to-business-to-business (empresa para empresa para empresa)

B2B2B

Business-to-business-to-consumer (empresa para empresa para consumidor)

B2B2C

Business-to-employee (empresa para empregado)

B2E

Doença provocada pelo coronavírus

Covid-19

Direto ao consumidor

DTC

Sistema de Gerenciamento de Pedidos

OMS

Software como serviço

SaaS

Stock Keeping Unit

SKU

Estados Unidos

EUA

Se for usar uma abreviatura ou sigla menos comum, escreva as palavras por extenso na primeira vez que aparecerem no texto e mencione a abreviatura/sigla entre parênteses. A partir daí, sinta-se à vontade para usar a versão abreviada.

Exemplo: Agora, as empresas europeias precisam levar em conta a Lei Geral de Proteção de Dados (LGPD). A LGPD está ativa desde 2016 e pode acarretar em multas pesadas para os varejistas que não a cumprirem. 

Siglas de até três letras devem ser escritas inteiramente em letras maiúsculas.

Exemplo: ONU, OMS, CLT, PIB.

Siglas de quatro ou mais letras que forem lidas como letras individuais devem ser escritas inteiramente em letras maiúsculas. Se forem lidas como palavras, apenas a inicial deve ser maiúscula.

Exemplos: UFRJ, FGTS, Otan, Unicamp.

Citações

Em artigos para blog e ebooks, separe as citações de clientes do corpo do texto. Em comunicados à imprensa e outros textos, coloque as citações dentro dos parágrafos.

Você pode editar as citações, mas não altere a mensagem. Geralmente, citações curtas e diretas são mais impactantes. Por isso, elimine o que não agrega qualquer valor. Você também pode alterar ou acrescentar palavras, mas ao mínimo, apenas para lapidar a mensagem.

Negrito, itálico e sublinhado

Dar uma ênfase especial a algumas palavras/frases ajudará seu público a analisar seu conteúdo com facilidade. Você pode usar negrito e itálico, mas com moderação – se tudo ficar em destaque, então nada é realmente importante. Aqui vão algumas diretrizes básicas:

Estrangeirismos

NA VTEX, nós não colocamos palavras de origem estrangeira em itálico nos materiais que serão publicados em nossos canais internos (blog, website, redes sociais etc.).

Em comunicados de imprensa (press releases), colocamos em itálico os estrangeirismos que ainda não foram dicionarizados ou não são de uso corriqueiro em ambientes não tecnológicos.

Termos de uso geral e comum (como "email", "internet", "ebook" etc.) não devem ser italizados em texto algum.

Via de regra, também não utilizamos hífens nos termos estrangeiros que escrevemos sem hífen aqui na VTEX (ecommerce, email, online, ebook, etc.).

Termos mantidos em inglês

all-in-one

dropshipping

multitenant

API/API-first

endpoint

omnichannel

backend

framework

seller

checkout

frontend

single-tenant

click and collect

headless

stack

compliance

fulfillment

storefront

composable

landing page

time to market

conversational sales/commerce

last mile

time to revenue

cross-border

live shopping

upselling

cross-selling

marketplace

whitepaper

Termos traduzidos

add-on

complemento

API-oriented

orientado a API

average order value

valor médio do pedido

average ticket

ticket médio

bounce rate

taxa de rejeição

brand awareness

consciência de marca

brick-and-mortar

(loja) física

bundle

compre junto

buy now pay later

compre agora, pague depois

buy one get one

compre e ganhe

curbside pickup

retirada na calçada

endless aisle

prateleira infinita

first-party

(dados) internos

fulfill

processar (pedidos)

influencer

influenciador

in-store pickup/pick up in store

retirada na loja

one-stop-shop

loja de parada única

third-party

(Seller) externo

VTEX

Nome da empresa

Sempre escrevemos "VTEX" em caixa alta.

Da mesma forma, o nome oficial da nossa solução deve ser referido como VTEX Commerce Platform.

Tagline

Nossa tagline é "A plataforma de comércio digital para grandes empresas".

Boilerplate

Sobre a VTEX

A VTEX (NYSE: VTEX) é a plataforma global de comércio digital onde CEOs e CIOs visionários encontram eficiência para suas vendas digitais. Nossa plataforma composable e completa ajuda marcas e varejistas a modernizar seu stack e potencializar resultados operacionais ao migrar de sistemas legados, operar diversos modelos de negócios em um mesmo local e otimizar processos de estoque e logística com canais de vendas conectados.

Como líder em plataformas de comércio digital, a VTEX tem a confiança de mais de 2.600 clientes B2C e B2B, entre eles Carrefour, Colgate, Motorola, Sony, Stanley Black & Decker e Whirlpool, tendo mais de 3.400 lojas online ativas em 38 países (dados do ano fiscal terminado em 31/12/2022). Para mais informações, visite www.vtex.com.

Marcas e empresas

Confira abaixo uma lista de marcas e empresas da VTEX e seus nomes oficiais. Atenha-se a eles!

GoCommerce

Indeva

Loja Integrada

VTEX HUB

Eventos e programas educacionais

Confira abaixo uma lista de eventos e programas da VTEX e seus nomes oficiais. Atenha-se a eles!

COMMEX

VTEX Code Cup

VTEX Internship

DCS

VTEX Connect LATAM

VTEX Lab

DCX

VTEX DAY

VTEX Talks

EICOM

VTEX Gran Prix

VTEX Training Day

TETRIX

VTEX Hackathon

VTEX Accelerator

VTEX Immersion

Produtos

Confira abaixo uma lista de produtos da VTEX e seus nomes oficiais. Atenha-se a eles!

VTEX Assisted Sales

VTEX Intelligent Search

VTEX Shipping Network

VTEX Conversational Commerce

VTEX Live Shopping

VTEX Smart Checkout

VTEX Extensions Hub

VTEX Personal Shopper

VTEX Store Framework

VTEX Insurance

VTEX Pick and Pack

VTEX Tracking

VTEX IO

VTEX Sales App

Equipes e cargos

Via de regra, consulte o organograma no Workday para mencionar um cargo interno.

Escreva nomes de equipes com inicial maiúscula. Não escreva nomes de cargos com inicial maiúscula a menos que se trate de uma abreviação de um cargo de nível C (tal como CEO, CFO etc.)

Exemplos:

 Lucas Bacic, líder de Core Marketing, liderou a iniciativa.

 Santiago Naranjo, CRO da VTEX, disse que os resultados foram ótimos.

Quando se referir ao Mariano e ao Geraldo, sempre escreva seus cargos completos:

 Mariano Gomide de Faria, fundador e co-CEO da VTEX

 Geraldo Thomaz, fundador e co-CEO da VTEX

Outras diretrizes

Evite usar verbo + substantivo quando puder usar apenas um verbo. Sempre opte pela opção mais simples e concisa.

Exemplo:

A operação tem progredido muito após a implantação da nova solução.

🚫 A operação tem feito muito progresso após a implantação da nova solução.

Não utilize "mesmo/mesma" como pronome pessoal. Use os pronomes pessoais do caso reto ou pronomes relativos para evitar repetições, se necessário.

Exemplo:

Conversamos com o presidente e ele afirmou que não há nada a temer.

🚫 Conversamos com o presidente e o mesmo afirmou que não há nada a temer.

Não utilize o verbo "possuir" como substituto para "ter" em frases que não indicam posse. Novamente, sempre opte pelo caminho mais simples e menos rebuscado para não ter erro.

Exemplo:

A empresa tem grande chance de vencer a licitação.

🚫 A empresa possui grande chance de vencer a licitação.

Ao utilizar pronomes demonstrativos, lembre-se de que "esta está para ser citada" – ou seja, utilizamos "esta/este/isto" para nos referir a algo que ainda será mencionado no texto, ao passo que para nos referirmos a algo que já foi dito, usamos "essa/esse/isso".

Exemplos:

A verdade é esta: o mercado está reaquecendo.

🚫 A verdade é essa: o mercado está reaquecendo.

A empresa foi processada. Foi por esse motivo que contrataram um advogado.

🚫 A empresa foi processada. Foi por este motivo que contrataram um advogado.

Tome cuidado ao utilizar os pronomes "seu/sua" para não incorrer em ambiguidades. Procure evitá-los sempre que a frase puder ficar ambígua.

Exemplo:

Empresa X melhora desempenho no mercado.

🚫 Empresa X melhora o seu desempenho no mercado.

Embora alguns linguistas já aceitem o uso intercambiável de "através" e "por meio de", há situações em que o uso de "através" pode acabar causando ambiguidades. Pensando nisso, procure dar preferência à expressão "por meio de" quando o sentido for de "por intermédio de".

Exemplo:

Conseguimos ótimos resultados por meio da nova parceria.

🚫 Conseguimos ótimos resultados através da nova parceria.

Cuidado com a construção do futuro composto. Use o verbo "ir" apenas no presente do indicativo acompanhado do verbo principal também no indicativo ("vai comprar") ou a forma simples do futuro do indicativo ("comprará").

Exemplo:

A empresa vai lançar o novo produto em janeiro.

A empresa lançará o novo produto em janeiro.

🚫 A empresa irá lançar o novo produto em janeiro.

Caixa de ferramentas

Guia de estilo e glossário de Product Localization

Você pode encontrar o Guia de estilo de português da equipe de Product Localization da VTEX aqui e o glossário trilingue (EN, ES e PT), com termos, definições e referências, aqui.

Aulete

O dicionário virtual Aulete traz mais de 800 verbetes da língua portuguesa e é uma ótima ferramenta de consulta gratuita.

Dicionário de sinônimos

Para evitar repetições e possíveis cacofonias nos textos, é sempre bom checar possíveis sinônimos para substituir os termos em questão. Este dicionário de sinônimos é ótimo para isso.

Statista

Para textos de conteúdo baseado em dados, você pode usar o Statista para reforçar seus argumentos e fornecer estatísticas sobre tendências de mercado e dados do consumidor. Temos dados limitados a estatísticas premium, mas basta entrar em contato conosco para obter as informações que você está procurando!

\ No newline at end of file diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image1.png b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image1.png new file mode 100644 index 0000000..e3caffc Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image1.png differ diff --git a/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image2.png b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image2.png new file mode 100644 index 0000000..9106fd0 Binary files /dev/null and b/content/marketing_style_guides/[VTEX] Writing Style Guide - PT/images/image2.png differ diff --git a/content/test b/content/test deleted file mode 100644 index e69de29..0000000