LocaleCI — Documentação de Engenharia¶
Documentação enterprise (docs-as-code), fundamentada no código do monorepo (v0.5.x, 314 testes). Termos técnicos e identificadores em inglês; narrativa em português. Fonte da verdade: o código.
Navegação por área¶
| # | Documento | Conteúdo |
|---|---|---|
| 1 | Visão Geral | Objetivo, problema, personas, casos de uso |
| 2–3 | Requisitos | Funcionais (RF-01..27) e não-funcionais (SLA/SLO/SLI, RTO/RPO) |
| 4 | Arquitetura | Estilo, padrões, diagramas Mermaid C4/sequência |
| 5,7 | Modelo de Dados | MER, schema físico, banco, migrations, retenção |
| 6 | APIs | Endpoints, exemplos, versionamento · openapi.yaml |
| 8 | Front-end | Telas, UX/UI, acessibilidade |
| 9 | Backend | Camadas, use cases, portas, workers, fila, cache |
| 10 | Infraestrutura | Cloud, KV, banco, secrets, rede |
| 11 | DevOps | CI/CD, Git flow, deploy, rollback, flags |
| 12 | Segurança | OWASP Top 10/API/LLM, STRIDE/DREAD/LINDDUN, LGPD |
| 13 | IA | LLM, RAG, embeddings, pgvector, guardrails, HITL |
| 14 | Observabilidade | Logs, métricas, tracing, alertas |
| 15 | Testes | Unit/integração/e2e/carga/SAST/DAST/SCA |
| 16–17 | Roadmap & Backlog | MVP→V3, backlog estruturado |
| 18 | Riscos | Matriz de riscos |
| 19 | Custos | Infra, cloud, LLM, equipe |
| 20 | Melhorias | Arquitetura/segurança/UX/performance |
| 21 | Premissas & Lacunas | Perguntas em aberto e decisões |
| 22 | Checklists | Dev, QA, segurança, deploy, produção |
Docs operacionais relacionados¶
O documento consolidado de página única foi dividido nestes arquivos por área.