Sample Documentation — Modelo-ouro
Use esta pasta como referência de como escrever bem a documentação da AEX. Não é sobre ter todos os arquivos — é sobre cada arquivo ser claro, direto e útil para outro desenvolv...
Exemplo da AEX Engineering. Enquanto o
sample-projectmostra a estrutura completa de um projeto, aqui o foco é a qualidade da escrita: um documento "modelo-ouro" comentado, explicando por que cada parte está boa.
Para que serve
Use esta pasta como referência de como escrever bem a documentação da AEX. Não é sobre ter todos os arquivos — é sobre cada arquivo ser claro, direto e útil para outro desenvolvedor (e para a IA).
O que faz uma boa documentação na AEX
| Princípio | O que significa na prática |
|---|---|
| Clareza acima de completude | Prefira 10 linhas certas a 3 páginas que ninguém lê. |
| Escreva para quem chega hoje | Sem contexto implícito; nomeie o óbvio uma vez. |
| Mostre, não só descreva | Um exemplo concreto vale mais que um parágrafo abstrato. |
| Fonte única | Não repita o que já está em outro documento; referencie. |
| Atualize junto com o código | Documento desatualizado é pior que ausência de documento. |
Documento comentado
ARCHITECTURE_COMENTADO.md— umARCHITECTURE.mdmodelo-ouro, com anotações> 💡explicando as escolhas de escrita.
Como usar
- Leia o documento comentado observando as anotações
> 💡. - Ao escrever o seu, siga o mesmo tom: objetivo, com exemplos e sem enrolação.
- Compare com o padrão oficial em
standards/DOCUMENTATION_STANDARD.mdda AEX Engineering.
ARCHITECTURE — Pulse (documento comentado)
Pulse coleta respostas de NPS via link público e mostra o resultado consolidado para o time do produto. É um Next.js único sobre Supabase — sem serviços extras, porque o MVP não...
CLAUDE.md — Agendou
Instruções para ferramentas de IA que trabalham neste repositório. Este projeto segue os padrões da AEX Engineering; em conflito, prevalece o padrão oficial.