1. Visão Geral
A porta de entrada. O que é o sistema, por que ele existe, e — tão importante quanto —
o que ele explicitamente não faz. Quem só tem dois minutos deveria ler só esta
página.
2. Como Funciona
O fluxo operacional do dia a dia: coletar → consolidar → sincronizar, com diagrama e
o princípio de dados append-only (nada é sobrescrito). Responde "o que acontece
todo dia, na prática".
3. Glossário de Domínio
Definição fechada de cada termo do domínio (Operation, Instance, License, Package,
Consumption, os três jobs). Página de referência rápida — as outras páginas linkam
pra cá em vez de redefinir os termos cada uma à sua maneira.
4. Perguntas Frequentes
Perguntas reais que alguém de fora do time faz ("calcula preço?", "gera fatura?",
"por que um registro sumiu?"). Escrita pensando tanto em leitura humana quanto em
ser a fonte que uma IA cita ao responder dúvidas sobre o projeto.
5. Segurança e Acesso
Os dois mecanismos de autenticação do sistema — Keycloak para a UI interna, chave de
API + escopos para integradores externos — e por que são mantidos separados.
6. Decisões de Arquitetura
Resumo em tabela das ADRs do repositório: a versão "para quem não é do time de
engenharia" de por que o sistema foi construído do jeito que foi.
Comentários
0 comentário
Escreva seu comentário aqui
Por favor, entre para comentar.