Assistentes
Menu
Feedback
Guias
Formatação
Geral
Listas e tabelas
Listas e tabelas

Listas e tabelas são usadas para apresentar conteúdo estruturado. Veja algumas regras que você pode seguir ao criá-las:

Listas As listas ajudam a organizar conteúdos em sequência linear. Use listas para apresentar uma série de itens ou etapas individuais. Por exemplo, você pode usar uma lista com bullet points para apresentar as funcionalidades de um produto e uma lista numerada ao orientar os usuários nas etapas de instalação de um software.

Para mais informações, veja as especificações de listas.

Tabelas As tabelas ajudam a organizar dados com múltiplos atributos em linhas e colunas. Por exemplo, você pode usar uma tabela para comparar os requisitos de instalação de diferentes sistemas operacionais e suas especificações mínimas e recomendadas.

Para mais informações, veja as especificações de tabelas.

Regras gerais

Escreva uma frase para introduzir a lista ou tabela para o usuário. Use dois-pontos ao final da frase que precede o conteúdo apresentado.

Correto ✅Incorreto ❌
  • Para personalizar os botões, siga os passos abaixo:
  • Siga os passos abaixo para conferir a integração com a sua loja:
    1. No Admin VTEX, acesse Configurações da loja > Intelligent Search > Integrações.
    2. Na página Integrações, todos os status devem estar ticados, como na imagem a seguir.
  • Instruções:
  • Siga os passos abaixo para conferir a integração com a sua loja.
    1. No Admin VTEX, acesse Configurações da loja > Intelligent Search > Integrações.
    2. Na página Integrações, todos os status devem estar ticados, como na imagem a seguir.

Quando o item da lista ou tabela incluir dois-pontos, a palavra seguinte deve começar em minúscula.

Correto ✅Incorreto ❌
  • Reserva autorizada: após a finalização da compra.
  • Reserva confirmada: após a aprovação do pagamento.
  • Reserva autorizada: Após a finalização da compra.
  • Reserva confirmada: Após a aprovação do pagamento.

Para garantir que a estrutura da lista esteja consistente, comece todos os itens com a mesma classe gramatical, como verbos no imperativo, verbos no infinitivo ou substantivos.

Correto ✅Incorreto ❌
Exemplo 1:
  • Controle os resultados de busca usando condições específicas.
  • Visualize como os resultados de busca serão exibidos aos clientes na loja.
  • Altere a ordem dos itens listados como resultados de busca.
Exemplo 2:
  • Indica o tipo de edição utilizado na regra de merchandising.
  • Ativa ou desativa uma regra de merchandising.
OU
  • Tipo de edição utilizado na regra de merchandising.
  • Opção que ativa ou desativa uma regra de merchandising.
Exemplo 1:
  • Controla os resultados de busca usando condições específicas.
  • Visualize como os resultados de busca serão exibidos aos clientes na loja.
  • Você pode alterar a ordem dos itens listados como resultados de busca.
Exemplo 2:
  • Indica o tipo de edição utilizado na regra de merchandising.
  • Opção que ativa ou desativa uma regra de merchandising.

Use ponto final se houver mais elementos, como um callout, entre a introdução e a lista.

Correto ✅

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

Para itens de lista compostos por frases completas, use ponto final ao final de cada frase.

Correto ✅Incorreto ❌
Os cenários em que acontece concorrência de promoções são:
  • Promoções com o mesmo tipo de desconto.
  • Aplicação de mais de uma promoção no mesmo item.
Os cenários em que acontece concorrência de promoções são:
  • Promoções com o mesmo tipo de desconto
  • Aplicação de mais de uma promoção no mesmo item

Para itens da lista que não sejam compostos por frases completas, não use pontuação.

Exemplo
As promoções inseridas no carrinho seguem a seguinte disposição:
  • Percentual
  • Nominal
  • Compre Junto

No início da documentação, ao listar os tópicos que serão abordados, utilize os títulos no infinitivo. Em português, títulos e subtítulos devem permanecer no infinitivo, mesmo quando, em inglês, a forma equivalente usar o gerúndio (-ing).

Correto ✅Incorreto ❌
Este artigo está dividido nas seguintes seções:
  • Adicionar produtos
  • Editar produtos
Este artigo está dividido nas seguintes seções:
  • Adicionando produtos
  • Editando produtos
Contribuidores
1
Photo of the contributor
+ 1 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Cabeçalhos e títulos
« Previous
Instruções
Next »
Contribuidores
1
Photo of the contributor
+ 1 contributors
Nesta página
GitHubCommunityFeedback