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 ❌ |
|---|---|
|
|
Quando o item da lista ou tabela incluir dois-pontos, a palavra seguinte deve começar em minúscula.
| Correto ✅ | Incorreto ❌ |
|---|---|
|
|
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:
| Exemplo 1:
|
Use ponto final se houver mais elementos, como um callout, entre a introdução e a lista.
Correto ✅
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:
| Os cenários em que acontece concorrência de promoções são:
|
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:
|
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:
| Este artigo está dividido nas seguintes seções:
|