A página principal deve ter a seguinte estrutura:
Estrutura
Introdução
Comece a página com uma breve introdução (no máximo 2–3 parágrafos), explicando o que é, por que existe e qual problema resolve.
Use contexto real para mostrar relevância.
Por que usar?
Destaque os benefícios, diferenciais e casos de uso ideais. Sinta-se à vontade para incluir:
- Ganhos de performance
- Melhorias de segurança
- Valor de compliance
- Cenários do mundo real
Conceitos-chave
Defina os termos, papéis ou componentes mais importantes. Esta seção constrói entendimento compartilhado e evita ambiguidade.
Especificações técnicas
Documente os detalhes de implementação que os desenvolvedores precisam saber. Inclua:
- Ambiente ou dependências necessárias
- Modelos de dados ou schemas
- Regras de validação internas
- Variáveis de configuração
Boas práticas
Ofereça conselhos práticos para ajudar os usuários a usar o produto de forma segura e eficiente. Inclua dicas sobre segurança, performance e armadilhas comuns.