Geral
Use letra maiúscula apenas na primeira letra da primeira palavra em uma frase em documentações ou elementos da UI, exceto para nomes próprios e acrônimos.
| Correto ✅ | Incorreto ❌ |
|---|
- Criar conta
- Testar nova experiência
- Ativar seller
- Desativar seller
| - Criar Conta
- Testar Nova Experiência
- Ativar Seller
- Desativar Seller
|
Nomes próprios
Use letra maiúscula em todos os substantivos próprios e marcas registradas, incluindo nomes de produtos, funcionalidades, módulos, páginas, pessoas, lugares e feriados. Em nomes compostos, use a maiúscula apenas nas palavras às quais a regra se aplica.
| Correto ✅ | Incorreto ❌ |
|---|
- A Black Friday acontecerá no dia 24 de novembro.
- O Intelligent Search determina a relevância de cada produto pela combinação dos pesos.
- Entre em contato com a equipe de Suporte.
- Exportar para Excel
- Instalar Intelligent Search
- VTEX App Store
| - A black friday acontecerá no dia 24 de novembro.
- O Intelligent search determina a relevância de cada produto pela combinação dos pesos.
- Entre em contato com a equipe de suporte.
- Export to excel
- Instalar intelligent search
- VTEX app store
|
Mantenha a capitalização original dos nomes de empresas conforme aparecem em seus materiais institucionais (exceto no logotipo). Isso inclui usos com todas as letras maiúsculas, uma letra maiúscula no meio ou todas as letras minúsculas.
Dias da semana, meses, nacionalidades e idiomas
Em português, dias da semana, meses e adjetivos de nacionalidade não levam letra maiúscula, a menos que estejam no início da frase.
| Correto ✅ | Incorreto ❌ |
|---|
- De segunda a sexta-feira
- Sábado
- Fatura de novembro
- Promoção válida até fevereiro
- Campanha voltada ao público colombiano
- Produto brasileiro
- Texto escrito em inglês
| - De Segunda a Sexta
- sábado
- Fatura de Novembro
- Promoção válida até Fevereiro
- Campanha voltada ao público Colombiano
- Produto Brasileiro
- Texto escrito em Inglês
|
Uso de maiúsculas após barra (/)
Se a palavra antes da barra estiver com inicial maiúscula, a palavra depois dela também deve começar com maiúscula.
| Correto ✅ | Incorreto ❌ |
|---|
- Itens/Unidades
- Observação/Código do vendedor
- Login/Cadastro do usuário
| - Itens/unidades
- Observação/código do vendedor
- Login/cadastro do usuário
|
Use letra maiúscula para nomes de formatos e programas que sejam marcas registradas ou nomes próprios, como Excel, Word, PowerPoint e PDF. Além disso, quando o nome do arquivo estiver em maiúsculas, ele não deve ser acompanhado de ponto.
| Correto ✅ | Incorreto ❌ |
|---|
| - Exportar em .csv
- Abrir pdf
|
Endpoints e APIs
Use letra maiúscula na primeira palavra de labels e termos em APIs, exceto quando forem sempre escritos com letras minúsculas. Siga a grafia original em inglês, como definida na documentação da VTEX.
| Correto ✅ | Incorreto ❌ |
|---|
- Para recuperar um produto usando o ID, use o endpoint
GET /api/catalog/pvt/product/{productId} - A API Conversions.
| - Para recuperar um produto usando o ID, use o endpoint
get /api/catalog/pvt/product/{productId}. - A API de conversões.
|
Acrônimos
Use letras maiúsculas na maioria dos acrônimos. Coloque todas as letras em maiúscula quando o acrônimo for soletrado (por exemplo, API, HTML, CSS). Muitos nomes de protocolos e especificações também são considerados nomes próprios e devem ser escritos com iniciais maiúsculas (como GraphQL e OAuth). Em caso de dúvida, siga o uso mais comum adotado no setor.
| Correto ✅ | Incorreto ❌ |
|---|
- Renove o token da API antes que expire.
- Essa opção envolve o uso de uma plataforma externa, conhecida como PaaS (Platform as a Service).
- Como a VTEX garante a conformidade com o Regulamento Geral de Proteção de Dados (GDPR)?
- Vários redirecionamentos são possíveis em uma única URL.
- Uma página de ID de usuário é exibida para que o cliente continue com a compra.
| - Renove o token da api antes que expire.
- Essa opção envolve o uso de uma plataforma externa, conhecida como platform as a service (PaaS).
- Como a VTEX garante a conformidade com o regulamento geral de proteção de dados (GDPR)?
- Vários redirecionamentos são possíveis em uma única url.
- Uma página de id de usuário é exibida para que o cliente continue com a compra.
|
Dois-pontos
A palavra seguinte aos dois-pontos deve estar em letra minúscula.
| Correto ✅ | Incorreto ❌ |
|---|
| Autocomplete: apresenta sugestões de pesquisa e de produtos com base no contexto do consumidor. | Autocomplete: Apresenta sugestões de pesquisa e de produtos com base no contexto do consumidor. |
Interfaces do usuário
As ações e os substantivos listados nas labels de ação e conteúdo (incluindo menus suspensos e filtros) devem começar com letras maiúsculas.
| Correto ✅ | Incorreto ❌ |
|---|
- Editar
- Exportar arquivo
- Importar arquivo
| - editar
- exportar arquivo
- importar arquivo
|
Filtrar por status: - Confirmado
- Expirado
- Preparado
| Filtrar por status: - confirmado
- expirado
- preparado
|
Documentação
Elementos da interface do usuário
Na documentação, siga a capitalização conforme aparece na interface da VTEX. Exceção: se um botão tiver todas as letras em maiúsculas, escreva-o com apenas a primeira letra em maiúscula na documentação.
| Correto ✅ | Incorreto ❌ |
|---|
A quantidade total de itens na página de Gerenciamento de inventário é atualizada em tempo real. Clique em Salvar. | A quantidade total de itens na página de Gerenciamento de Inventário é atualizada em tempo real. Clique em SALVAR. |
Quando a UI for externa à VTEX, siga a capitalização conforme foi usado nela.
| Correto ✅ | Incorreto ❌ |
|---|
| No campo Google Tag Manager, insira o ID do seu contêiner no formato GTM-XXXX, conforme aparece na imagem. | No campo Google tag manager, insira o ID do seu contêiner no formato Gtm-xxxx, conforme aparece na imagem. |
Referências técnicas e campos para desenvolvedores
Use camel case para placeholders e campos para desenvolvedores. Ou seja, coloque a primeira letra de cada palavra em maiúscula, exceto a primeira letra de toda a palavra composta. Se o texto for uma tradução, seguir o padrão de capitalização da fonte.
| Correto ✅ | Incorreto ❌ |
|---|
O nome do arquivo deve seguir o padrão {nomeDaLoja}-favicon.ico. | O nome do arquivo deve seguir o padrão {nomedaloja}-favicon.ico. |
Listas
A primeira letra em uma lista numerada ou de itens deve ser sempre maiúscula.
Lista de itens
| Correto ✅ | Incorreto ❌ |
|---|
O Search Console oferece acesso fácil e gratuito às seguintes informações: - Principais termos de pesquisa
- Principais URLs visualizados
| O Search Console oferece acesso fácil e gratuito às seguintes informações: - principais termos de pesquisa
- principais URLs visualizados
|
Lista numerada
| Correto ✅ | Incorreto ❌ |
|---|
- Na página Projetos, clique em
Criar novo. - Na página Novo projeto, preencha os campos.
- Após preencher os campos da página, clique em
Criar.
| - na página Projetos, clique em
Criar novo. - na página Novo projeto, preencha os campos.
- após preencher os campos da página, clique em
Criar.
|