Como usar esta documentação

A documentação está dividida pelo tipo de necessidade de quem lê, conforme o framework Diátaxis de Daniele Procida. A ideia central é que tutorial, guia, referência e explicação são textos diferentes e misturá-los faz cada um ficar pior.

Quadrante Diátaxis	Pergunta do leitor	Seções aqui
Tutorial (aprender fazendo)	“Me leva pela mão do começo ao fim”	Tutorial
Guias (resolver uma tarefa)	“Como eu faço X?”	Guias
Referência (consultar)	“Qual é o valor/contrato exato de X?”	Referência, ADRs, Changelog
Explicação (entender)	“Por que é assim?”	Produto, Arquitetura, Experiência do usuário

Convenções

• Status das afirmações. Tudo o que está aqui foi verificado no código do monorepo moldape-v2 (branch develop) ou navegando a plataforma em produção em outubro de 2026. Quando algo é meta e não medição, o texto diz explicitamente.
• Diagramas como código. Os diagramas são escritos em Mermaid dentro do próprio Markdown, então são revisados em pull request como qualquer código.
• Capturas de tela. São geradas pelo script pnpm --filter @moldape/docs capture, nunca coladas à mão. Ver Manter esta documentação.
• Idioma. Português do Brasil. Nomes de código (entidades, rotas, variáveis) ficam como estão no código.

Dados pessoais

Nenhuma captura ou exemplo desta documentação contém dados reais de clientes. O painel administrativo é descrito pela sua estrutura (colunas, ações), nunca pelo conteúdo.

Público

• Equipe Moldapé (cliente): Produto, Tutorial, Experiência do usuário, Roadmap e Changelog (o que mudou em cada versão e o ganho de cada melhoria). Esse recorte é exportado em PDF.
• Pessoas desenvolvedoras: tudo, com foco em Arquitetura, ADRs, Referência e Guias.