Auditoria da Documentação
Índice único de todos os documentos do projeto, com data da última auditoria contra o código real. Arquivo vivo — atualizar o carimbo toda vez que o doc for revalidado. Objetivo: evitar que a documentação vire ficção. Quando o código muda, o doc relacionado precisa ser revalidado.Como usar este índice
- Antes de confiar num doc para tomar decisão técnica: conferir a data da última auditoria. Se passou dos 30 dias, revalidar antes de usar como fonte.
- Ao concluir um refactor grande: marcar todos os docs afetados com status
⚠️ Pendente revalidaçãoaté conferir. - Ao auditar um doc: atualizar a data + status + commit/sessão onde foi feita a auditoria.
Legenda de status
| Símbolo | Significado |
|---|---|
| ✅ | Auditado recentemente (≤30 dias) e alinhado com código |
| ⚠️ | Auditado mas com divergências conhecidas pendentes de correção |
| 🔄 | Revalidação pendente (última auditoria > 30 dias ou mudança recente no código) |
| 🆕 | Criado recentemente, não auditado ainda |
| 🗑️ | Deprecated — manter apenas como histórico |
Índice por categoria
Documentação (Tab 1)
| Doc | Última auditoria | Status | Notas |
|---|---|---|---|
introduction.md | 2026-04-17 | ✅ | Landing page Mintlify |
ONBOARDING.md | 2026-04-17 | ✅ | Corrigido: README → RUNNING |
ARCHITECTURE.md | 2026-04-17 | ✅ | Corrigido: 14→13 controllers, removida seção “refatoração pendente”, removido /tenant/users page |
REPORTS_SYSTEM.md | 2026-04-17 | 🆕 | Substitui antigo LAUDO_UI_PLAN.md. Descreve estado atual do sistema de laudos + invariantes críticas |
Operações (Tab 2)
| Doc | Última auditoria | Status | Notas |
|---|---|---|---|
RUNNING.md | 2026-04-17 | ✅ | Corrigido snippet de criação do primeiro super admin em prod (precisa Tenant + Unit — users.tenant_id NOT NULL); documentados os 3 .env (raiz, backend, frontend) em dev e prod; adicionado passo 3.5 “Edite o Caddyfile” + troubleshooting NXDOMAIN |
GIT_WORKFLOW.md | 2026-04-17 | ✅ | Branches, convenções, fluxo PR corretos |
DEV-TO-PROD.md | 2026-04-17 | ✅ | 95% alinhado. Adicionadas seções “V1 Stable” e “Arquivos .env usados em produção” (raiz + backend + frontend, com nota sobre NEXT_PUBLIC_* embutidas no build). Detalhe menor: allowedDevOrigins no código tem só 127.0.0.1 (doc lista mais — não afeta prod) |
STORAGE_ARCHITECTURE.md | 2026-04-17 | ✅ | Inventário PG e filesystem confere. Orthanc SQLite é estado atual, migração para Postgres é roadmap |
HOMOLOG_CHECKLIST.md | 2026-04-17 | 🆕 | Checklist criado em 2026-04-17. Vai ser validado no deploy em homolog |
Roadmap (Tab 3)
| Doc | Grupo | Última auditoria | Status | Notas |
|---|---|---|---|---|
MEMBERSHIPS_REFACTOR.md | Data e Model | 2026-04-17 | 🆕 | Planejamento — multi-tenant por vínculo. 10 decisões pendentes em §4 |
SUPER_ADMIN_REDESIGN.md | Admin e Operações | 2026-04-20 | 🆕 | Planejamento — redesign do painel super admin + onboarding guiado + memberships + impersonação. Depende do refactor de memberships. Nota: patch v1 pré-redesign aplicado 2026-04-20 (selects cascata em /admin/users, /admin/units, /admin/modalities) |
DICOM_OPERATIONS.md | DICOM | 2026-04-17 | 🆕 | Planejamento — modify, merge, C-GET, C-MOVE. Feature sensível com implicações médico-legais. 10 decisões pendentes em §4 |
API Reference (Tab 4)
| Doc | Última auditoria | Status | Notas |
|---|---|---|---|
api/auth.md | 2026-04-17 | ✅ | 4/4 endpoints cobertos |
api/studies.md | 2026-04-17 | ✅ | 7/7 endpoints, fallback de modalities documentado |
api/patients.md | 2026-04-17 | ✅ | 3/3 endpoints |
api/reports.md | 2026-04-17 | ✅ | 9/9 endpoints, RBAC + makeVisible documentados |
api/tenant.md | 2026-04-17 | ✅ | Escopo tenant + templates + presets + settings |
api/admin.md | 2026-04-17 | ✅ | 10/10 endpoints super admin confirmados |
api/viewer-webhook.md | 2026-04-17 | ✅ | Token viewer + webhook Orthanc |
Metodologia de auditoria
Vermemory/feedback_refactor_methodology.md e STORAGE_ARCHITECTURE.md §6.
Níveis de rigor:
- Nível 1 — Leitura manual: útil para docs pequenos ou auditoria ad-hoc. Comparar texto com código linha a linha.
- Nível 2 — Subagents Explore em paralelo: usado para auditorias abrangentes. Cada subagent audita 1-2 docs e retorna achados separados em ✅/⚠️/❌. Consolidar reports antes de editar.
- Nível 3 — Este índice: prática contínua. Toda vez que um doc for auditado, carimbar a data aqui.
Quando revalidar um doc
- Passou mais de 30 dias desde a última auditoria
- O código da área relacionada mudou (PRs grandes, refactors)
- Alguém reportou divergência entre doc e realidade
- Antes de um release estável (v1, v2, etc.)
Histórico de auditorias
2026-04-17 — Auditoria em lote pré-release v1
Disparados 6 subagents Explore em paralelo, cada um auditando 1-2 docs contra o código real:- Agent 1:
introduction.md+ONBOARDING.md— pequenos ajustes aplicados - Agent 2:
ARCHITECTURE.md— removida seção de refatoração pendente (Fase 1 concluída), corrigida contagem de controllers (14→13), removidotenant/users/page.tsx - Agent 3:
RUNNING.md+GIT_WORKFLOW.md— 100% alinhados, nenhuma mudança - Agent 4:
DEV-TO-PROD.md+STORAGE_ARCHITECTURE.md— 95-100% alinhados, adicionada seção V1 Stable - Agent 5:
LAUDO_UI_PLAN.md— deprecated; substituído porREPORTS_SYSTEM.mdcom invariantes críticas antes não documentadas - Agent 6:
docs/api/*.md(7 arquivos) — 100% alinhados, nenhuma divergência
2026-04-17 — Adição de docs de roadmap (tarde)
Criados 2 docs novos na tab Roadmap:SUPER_ADMIN_REDESIGN.md— redesign + expansão do painel super admin (onboarding guiado, memberships UI, impersonação)DICOM_OPERATIONS.md— manipulação de conteúdo DICOM (modify, merge, C-GET, C-MOVE)
Documentos deprecados (removidos)
Lista de arquivos que não existem mais mas têm histórico relevante. Se voltarem a ser referenciados, atualizar este índice.| Arquivo | Substituído por | Quando |
|---|---|---|
LAUDO_UI_PLAN.md | REPORTS_SYSTEM.md | 2026-04-17 — doc de plano virou doc de estado atual |
frontend/docs/API_ROUTES_AND_FLOW.md | docs/api/*.md (Mintlify) | 2026-04-16 |
frontend/docs/API_BACKEND_NOTES.md | docs/api/*.md | 2026-04-16 |
frontend/docs/FRONTEND_PHASE1_NEXT_STEPS.md | Memória + issues | 2026-04-16 |
backend/docs/openapi_phase1_viewer.yaml | docs/api/*.md | 2026-04-16 |
