Skip to main content

TDD — Technical Design Document

Documentos de design técnico: especificação de implementação, APIs, contratos e detalhes técnicos.

Estrutura (espelha a árvore da aplicação)​

A pasta TDD reflete a navegação e contenção da app. Ao percorrer as pastas, o leitor segue o mesmo caminho que na interface:

tdd/
├── home/           → HomePage
│   ├── help/      → Popup de ajuda
│   │   └── debug/ → Ferramentas de debug
│   └── profile-dialog/ → Diálogo de perfil
├── auth/           → Login e registro
│   ├── login/
│   └── register/
│       └── signup-email/
└── api/            → Contratos cross-cutting (gateway, healthcheck, etc.)

Uso​

  • Detalhamento técnico de uma feature ou componente
  • Contratos de API, fluxos de dados, integrações
  • Complementa ADRs com nível de detalhe de implementação

Convenção​

  • Um TDD por feature ou contrato (ex.: tdd-snapshot.md, tdd-gateway-usuario.md)
  • Referenciar ADRs relacionados; manter alinhado ao código
Last updated on