DO ‐ Padrão para Documentação - manolito-fatec/dashflow-2025-1 GitHub Wiki
Padrão para Documentação
1. Estrutura Geral do Documento
- Título do Documento: Use
#
para o título principal. - Subtítulos: Use
##
,###
, etc., para subtítulos. - Corpo do Texto: Escreva o texto sem formatação de fonte e com alinhamento a esquerda.
- Espaçamento: Use uma linha horizontal entre parágrafos para melhor legibilidade.
2. Sumário
Utilize uma lista não ordenada com -
ou *
para criar o sumário.
Inclua links internos para as seções do documento (usando 
).
3. Indicadores e Métricas
- Gráficos e Imagens: Use a sintaxe

para inserir gráficos. - Tabelas: Use a sintaxe de tabelas do Markdown.
- Destaque de Valores: Use
**
para negrito ou*
para itálico.
4. Resultados
Utilize listas com -
ou *
para listar resultados.
Destaque os resultados mais importantes com **
.
5. Formatação de Imagens e Gráficos
- Legendas: Como o Markdown não suporta legendas, você pode adicionar uma descrição abaixo da imagem.
- Referência no Texto: Use links internos ou manualmente.
6. Anexos
Identifique os anexos com subtítulos e inclua uma breve descrição.