Standards da Engenharia
Os padrões oficiais da AEX. Esta é a camada normativa: define o que é obrigatório em todos os projetos e é o que entra em code review. Onde o handbook explica como pensamos, os...
Os padrões oficiais da AEX. Esta é a camada normativa: define o que é obrigatório em todos os projetos e é o que entra em code review. Onde o handbook explica como pensamos, os standards dizem o que fazer.
Como ler os padrões
- São obrigatórios por padrão. Todo projeto os segue, sem exceção implícita.
- Cada padrão é concreto e verificável — traz a regra, o formato e exemplos.
- Exceções são explícitas. Quando um projeto precisa divergir, isso exige aprovação do Tech Lead e registro no
DECISIONS.mddo projeto. Divergência não documentada é erro, não exceção. - Em conflito, o standard prevalece sobre handbook, guias de ferramenta e preferências pessoais.
Os padrões
| Padrão | Assunto | Use quando |
|---|---|---|
CLICKUP_STANDARD | Gestão: hierarquia, milestones, tarefas e status. | Organizar e rastrear qualquer trabalho. |
GITHUB_STANDARD | Estrutura de repositório e documentação técnica. | Criar ou organizar um repositório. |
DOCUMENTATION_STANDARD | Os documentos obrigatórios de todo projeto. | Documentar um projeto do início ao fim. |
BRANCH_STANDARD | Modelo e nomenclatura de branches. | Iniciar qualquer trabalho no código. |
COMMIT_STANDARD | Padrão de mensagens de commit. | A cada commit. |
DEPLOY_STANDARD | Pipeline automatizado e publicação. | Publicar uma versão em produção. |
Como um padrão evolui
Os padrões são vivos, mas mudam com critério — estabilidade é parte do valor.
- Proposta — abra um Pull Request neste repositório com a mudança e a justificativa.
- Revisão — o Tech Lead (e o CTO, quando estrutural) discute e aprova.
- Comunicação — a mudança é anunciada ao time.
- Critério — só vira padrão o que se repete e agrega valor real. Na dúvida, mantenha simples.
Base
Todos os padrões existem para servir à filosofia e às regras oficiais da engenharia. Se um padrão contradiz a filosofia, o padrão está errado — e deve ser corrigido.
Padrão Oficial do GitHub
O GitHub é a fonte oficial da documentação técnica. Todo repositório da AEX segue a mesma estrutura de raiz — abrir um projeto novo é sempre encontrar as coisas nos mesmos lugares.
Templates
Modelos prontos para copiar e preencher. Reduzem decisão repetida e garantem que todo projeto, tarefa e interação com IA nasça padronizado.