Assistentes
Menu
Feedback
Guias
Gramática
Geral
Verbos
Verbos

Os verbos desempenham um papel fundamental na criação de conteúdo claro e acionável para interfaces de usuário e documentação. Eles orientam os usuários, indicam ações e garantem que as instruções sejam diretas e eficazes.

Documentação

Em títulos de documentação especificamente, use um verbo no infinitivo ou um substantivo. Utilizar o verbo no gerúndio é algo típico do inglês.

Correto ✅Incorreto ❌
  • Criar tabela de preços promocionais
  • Integração com o marketplace
  • Criando tabela de preços promocionais
  • Integrando o marketplace

Em subtítulos, é aceitável o uso de infinitivo ou substantivo, como nos títulos, e de imperativo. O imperativo deve ser usado caso o subtítulo seja um comando para o usuário.

Exemplo
  • Criar novo evento
  • Campos de cadastro
  • Clone o repositório criado

Quando houver instruções para determinada ação, elas devem estar no imperativo.

Correto ✅Incorreto ❌
Siga as etapas abaixo:
  1. No Admin VTEX, clique no módulo de Storefront, ou digite Storefront na barra de busca.
  2. Em Intelligent Search, clique em Regras de relevância.
Siga as etapas abaixo:
  1. No Admin VTEX, clicar no módulo de Storefront ou digite Storefront na barra de busca.
  2. Em Intelligent Search, clicar em Regras de relevância.

Em uma descrição de uma tabela, use o presente.

{"base64":"  ","img":{"width":1485,"height":925,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":153641,"url":"https://raw.githubusercontent.com/vtexdocs/content-portal-content/refs/heads/main/images/pt/verbs.png"}}

Interfaces de usuário

Inicie as frases com verbos no imperativo ao indicar as ações que os lojistas devem realizar.

Correto ✅Incorreto ❌
Informe seu CEPInformar CEP

Em botões, use o verbo no infinitivo.

Correto ✅Incorreto ❌
  • Criar produto
  • Visitar loja
  • Tentar novamente
  • Crie um produto
  • Visite a loja
  • Tente novamente

Em botões de texto clicável, use o imperativo.

Correto ✅Incorreto ❌
Saiba maisSaber mais

Não use verbos para nome de módulos no Admin.

Correto ✅Incorreto ❌
Gerenciamento de inventárioGerenciar inventário

Os títulos de modais devem conter um verbo no infinitivo para indicar a ação necessária.

Correto ✅Incorreto ❌
  • Excluir promoção
  • Confirmar alteração
  • Exclusão de promoção
  • Excluindo promoção
  • Exclua a promoção
  • Confirmação de alteração
  • Confirme a alteração
Contribuidores
1
Photo of the contributor
+ 1 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Pontuação
« Previous
Interfaces de usuário
Next »
Contribuidores
1
Photo of the contributor
+ 1 contributors
Nesta página
GitHubCommunityFeedback