Para auxiliar a criação do conteúdo, disponibilizamos este checklist com o intuito de orientar nas verificações que devem ser realizadas no momento do desenvolvimento de qualquer um dos manuais, releases ou artigos de base de conhecimento.
Item
Descrição
Exemplo
Conteúdo longo | Quando o conteúdo for muito longo você pode utilizar o componente Expandir. |
| |||||
Ícones | Devem ter o tamanho máximo de 64px. | ||||||
Imagens | Devem estar alinhadas ao centro e com a sua descrição (Texto ALT). | ||||||
Itálico | Utilizamos a opção itálico sempre que tivermos termos estrangeiros em nosso texto. | O checklist é importante | |||||
Links | Verificar se não existem links “quebrados” ou que direcionem a páginas incorretas. | Este link não leva a lugar algum | |||||
Listas | Verificar se as listas (ordenadas e não ordenadas) estão corretas. |
| |||||
Negrito | O negrito deve ser utilizado para destacar termos/palavras dentro do seu texto. | Quero destacar essa palavra | |||||
Painéis | Verificar se o painel está de acordo com a informação passada. |
| |||||
Parágrafos | Verificar se os espaçamentos dos parágrafos estão corretos. | Parágrafo com espaço (correto) Parágrafo com espaço (correto) Parágrafo com espaço (correto) | |||||
Passo a passo | Para descrever algum passo a passo, utilize as listas. | Para configurar o intervalo de envio
| |||||
Sublinhado | Semelhante ao negrito, o sublinhado também serve para destacar os termos/palavras dentro do seu texto. | Quero destacar essa palavra | |||||
Tabelas |
| ||||||
Títulos | Hierarquia de títulos dentro da página. | Título 1Título 2Título 3Título 4Título 5Título 6 |