Templates de documentação¶
Modelos editoriais para documentar contratos e decisões com base em evidências.
| Modelo | Uso |
|---|---|
| Microserviço | Responsabilidade, APIs, dependências, segurança, operação e evidências |
| Modelagem de dados | Manutenção de ownership, campos, índices, relações e versionamento |
| Fluxo E2E | Rastreabilidade de entrada até resultado final; próxima etapa |
| ADR | Registro de uma decisão arquitetural relevante |
Todos os modelos seguem o escopo permanente backend. Consumidores são atores externos; contratos e evidências pertencem ao backend e à infraestrutura associada.
Copie a estrutura para a área correspondente e substitua as instruções por evidências. A ficha do BFF é o primeiro exemplo de microserviço. O template de dados não inicia a modelagem dos bancos; o de E2E não documenta uma operação específica.
Todos os modelos devem aplicar as regras de evidência e ambiente: identificar ambiente, distinguir código de deployment e separar experimentos de adoção aprovada.