Pular para o conteúdo principal

Padrão de Documentação

 Este guia define as regras de escrita, organização e apresentação visual para manter as páginas do projeto no mesmo padrão.

1. Escrita de Parágrafos​

 Todo parágrafo deve começar com o comando  . Isso se aplica a todo texto corrido: aberturas, explicações, transições e encerramentos.

## Nome da Seção

 Texto de abertura.

 Explicação detalhada.

 Texto de encerramento.

2. Formato esperado de seções​

 Siga esta sequência ao escrever cada seção:

  1. Título objetivo
  2. Breve introdução
  3. Desenvolvimento do assunto
  4. Encerramento conectando ao projeto

Modelo base:

## Título da Seção

 Apresentação do tema.

 Explicação dos principais detalhes.

 Síntese do ponto central conectando ao projeto.

3. Padrão de imagens e tabelas​

 Toda imagem deve ter número, título e fonte:

<div align="center">
<small><strong style={{fontSize: '12px'}}>Figura X — Título da Imagem</strong></small>

![imagem](/img/NOME_DA_IMAGEM.png)

<small style={{marginTop: '4px', fontSize: '10px'}}>Fonte: Material produzido pelo grupo, 2026.</small>
</div>

 Toda tabela (Quadro) segue o mesmo padrão:

<div align="center">
<small><strong style={{fontSize: '12px'}}>Quadro X — Título da Tabela</strong></small>

| Coluna A | Coluna B |
|----------|----------|
| Dado 1   | Dado 2   |

<small style={{marginTop: '4px', fontSize: '10px'}}>Fonte: Material produzido pelo grupo, 2026.</small>
</div>

 Formato da fonte:

  • Externa: Fonte: Nome do Autor/Instituição, ANO
  • Interna: Fonte: Material produzido pelo grupo, 2026

4. Tom de escrita​

 A linguagem deve ser clara, objetiva e formal:

  • Evite gírias e linguagem informal
  • Defina termos técnicos na primeira menção
  • Nunca use primeira pessoa
  • Use voz passiva ou organizacional: "O sistema realiza", "O projeto propõe", "A solução desenvolvida"

5. Hierarquia de títulos no Docusaurus​

  • # = título principal da página
  • ## = seções
  • ### = subseções
  • Nunca pule níveis de hierarquia

6. Checklist de revisão final​

 Antes de abrir o Pull Request, verifique:

  • Parágrafos com &emsp; no início
  • Seções com introdução, desenvolvimento e encerramento
  • Imagens e tabelas numeradas com fonte
  • Tom formal e impessoal mantido
  • Conteúdo alinhado com os objetivos do projeto