Ir para o conteúdo principal

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

1. Título Principal

  • Fonte: Tamanho grande (ex.: 18-24 pt)
  • Estilo: Negrito
  • Alinhamento: Centralizado ou alinhado à esquerda

 

2. Seções e Subseções

  • Seções principais:

    • Fonte: Tamanho médio (ex.: 16-18 pt)
    • 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
    • Espaçamento: Uma linha em branco antes e depois

 

4. Itens e Opções

  • Bullet points: Utilize listas com marcadores para itens não sequenciais
    • Fonte: Tamanho padrão (ex.: 12-14 pt)
    • Estilo: Normal
    • Alinhamento: Alinhado à esquerda
    • Espaçamento: Sem linha em branco entre itens de lista

 

5. Campos, Botões e Módulos

  • Negrito: Use negrito para destacar nomes de campos, módulos e botões
    • Exemplo: "Clique no botão Salvar."

 

6. Imagens e Capturas de Tela

  • Legenda: Inclua uma legenda descritiva abaixo de cada imagem
    • Fonte: Tamanho pequeno (ex.: 10-12 pt)
    • Estilo: Itálico ou normal
    • Alinhamento: Centralizado
    • Espaçamento: Uma linha em branco antes e depois da imagem
  • Imagem: 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