Document toolboxDocument toolbox

Checklist

Owned by Paulo Henrique Paixão
Last updated: mai. 06, 2024
2 min read

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.

TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO TEXTO

Ícones

Devem ter o tamanho máximo de 64px.

Imagens

Devem estar alinhadas ao centro e com a sua descrição (Texto ALT).

Logo do time com o personagem Oogway

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.

  1. Lista ordenada

    1. Lista ordenada

  2. Lista ordenada

  • Lista não ordenada

    • Lista não ordenada

  • Lista não ordenada

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.

Artigos com conteúdo sensível serão excluídos.

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 sem espaço (incorreto)
Parágrafo sem espaço (incorreto)

Parágrafo com espaço (correto)

Passo a passo

Para descrever algum passo a passo, utilize as listas.

Para configurar o intervalo de envio

  1. Clique em Ferramentas

  2. Acesse o Grupo Servidor

  3. Clique na Ação Envio de dados

Sublinhado

Semelhante ao negrito, o sublinhado também serve para destacar os termos/palavras dentro do seu texto.

Quero destacar essa palavra

Tabelas

  • Os títulos das tabelas devem estar em negrito

  • Se utilizar cor nas colunas ou linhas, deve ser utilizada a cor cinza.

 

Títulos

Hierarquia de títulos dentro da página.

Título 1

Título 2

Título 3

Título 4

Título 5
Título 6