Guia Boas Práticas Documentação

• Padrão de Estilização da Documentação

Padrão de Estilização da Documentação

1. Título Principal

• Fonte: Cabeçalho pequeno
• Estilo: Negrito
• Alinhamento: Centralizado ou alinhado à esquerda

2. Seções e Subseções

• Seções principais:

  • Fonte: Aller, Montserrat
  • Estilo: Negrito
  • Alinhamento: Alinhado à esquerda
  • Espaçamento: Uma linha em branco antes e depois

• Subseções:

  • Fonte: Tamanho padrão (ex.: 14-16 pt)
  • Estilo: Negrito
  • Alinhamento: Alinhado à esquerda

4. Itens e Opções

• Bullet points: Utilize listas com marcadores para itens não sequenciais
  • Fonte: Tamanho paragrafo
  • Estilo: Normal
  • Alinhamento: Alinhado à esquerda
  • Espaçamento: Sem linha em branco entre itens de lista

5. Campos, Botões e Módulos

6. Imagens e Capturas de Tela

• Legenda: Inclua uma legenda descritiva acima de cada imagem caso necessário 
  • Fonte: Tamanho paragrafo
  • Estilo: Itálico
  • Alinhamento: Centralizado
  • Espaçamento: Uma linha em branco antes e depois da imagem
• Imagem(captura de tela): Utilizar sempre a cor vermelha nas formas de quadrado e seta para indicar na imagem
  

7. Notas e Observações

• Estilo: Itálico ou destacado com uma caixa de texto
  • Fonte: Tamanho padrão (ex.: 12-14 pt)
  • Alinhamento: Alinhado à esquerda
  • Espaçamento: Uma linha em branco antes e depois