Template — modelagem de dados¶
Escopo: backend e infraestrutura associada, conforme a governança; consumidores aparecem somente como atores externos.
Modelo editorial para manter e ampliar a modelagem da plataforma.
Identificação¶
Domínio, owner, repositório/commit, data, tecnologia, database/collection ou estrutura equivalente; escopo tenant/global; fonte da escolha do banco; estado de implementação conforme a governança.
Entidades e campos¶
Tabela a preencher: nome lógico, nome serializado exato, tipo persistido, obrigatoriedade, default, mutabilidade, significado e fonte. Distinguir DTO, entidade e representação BSON/JSON. Incluir objetos aninhados e elementos de coleções quando fizerem parte do contrato.
Identidade, ownership e relações¶
IDs estáveis, chaves de referência, cardinalidades, owner e regra de resolução cross-tenant. Diagrama Mermaid adequado. Identificar relações lógicas; não desenhar foreign keys físicas inexistentes.
Índices e consultas¶
Tabela: nome, campos/ordem, unicidade, filtro parcial, TTL, consulta atendida e fonte. Separar índice criado pelo código de índice observado no banco; definir evidência de implantação antes de afirmar existência física.
Ciclo de vida e versionamento¶
Estados e transições, revisão versus identidade lógica, história/proveniência, snapshots, exclusão/retention, compatibilidade e migração. Referenciar invariantes e testes.
Consistência e concorrência¶
Limite transacional, locks/leases, idempotência, operações condicionais, efeitos externos, outbox/inbox e recuperação. Explicitar o que não é atômico.
Exemplo sanitizado¶
Inserir exemplo somente após localizar contrato, fixture ou teste real. Citar arquivo/commit e quais valores foram substituídos. Não criar campos ilustrativos como se fossem persistidos.
Validação e lacunas¶
Testes dos contratos e invariantes, limitações funcionais e riscos relevantes. Incertezas da análise ficam no relatório final da tarefa. Relacionar análises e fluxos quando estes existirem.
Ambiente e configuração operacional¶
Separar modelo implementado no código de topologia e configuração de persistência por ambiente. Réplicas, retenção, backups e disponibilidade do ambiente local não comprovam DEV, STAGING ou PROD; exigir evidências corporativas próprias ou registrar não confirmado.