trending/DeskcommCRM
1
0
Fork 0
mirror of https://github.com/melgarafael/DeskcommCRM.git synced 2026-10-02 01:28:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
9152ab27dff56b0f031e41968279c004eeb21379
DeskcommCRM/docs/index.md
T
Rafael MelgaçoandClaude Opus 5 9152ab27df docs(auditoria): remede os numeros e declara a regua de cada um 
Revisao de manutencao do PR #60, medida contra origin/main @ b190bbf.
Cada correcao veio de uma contagem refeita, nao de leitura:

- AGENTS.md: "Zod 3" -> Zod 4 (package.json declara ^4.4.3). Importa porque a
  secao e rotulada CONFIRMADO: um agente escreveria idioma zod 3 num repo zod 4.
- AGENTS.md: Playwright 1.61 -> 1.62 (^1.62.0).
- AGENTS.md: o CI roda 22 -> o job `ci` roda 22, mas `perf` ainda builda em 20,
  divergindo de engines >=22. Fica registrado como bug, nao escondido.
- ARCHITECTURE.md: 149 handlers -> 166. O 149 era resquicio da primeira passada;
  169 e a contagem de app/api/**, 166 e a de /api/v1/. Regua declarada nos dois.
- ARCHITECTURE.md: 9 endpoints de cron -> 10.
- index/current-state/harness-audit: 123 docs -> 119 .md em docs/, 23 subpastas,
  com o comando que reproduz o numero.
- threat-model/current-state: 109 PNGs -> 116. O 78 de evidence/ contava so o
  nivel de cima; ha mais 7 em evidence/wave3-pulso/.

Os 97 links internos foram revalidados apos as edicoes: 0 quebrados.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01H4GmcUD87RRTwHonr7v7pr
2026-07-30 10:49:11 -03:00

9.2 KiB
Raw Blame History

type, project, status, last_updated, generated_by, confidence, audited_against
type project status last_updated generated_by confidence audited_against
index DeskcommCRM draft 2026-07-29 auditoria documental (Claude Code) alta (inventário de arquivos é CONFIRMADO; agrupamento temático é INFERIDO) origin/main @ 789dfa6 (v1.0.0, 2026-07-27)

Índice da documentação — DeskcommCRM

Mapa dos 119 arquivos .md de docs/, espalhados por 23 subpastas — régua: git ls-files 'docs/**/*.md' | wc -l. Existe porque a documentação cresceu sem ponto de entrada: sem este índice, humano e agente não acham o que já foi decidido e reescrevem por cima.

Regra de precedência quando dois docs discordam: CLAUDE.md (doutrina) > docs/specs/ (contrato técnico) > docs/prd/ (intenção) > HANDOFF-*.md (estado de sessão) > README. Se achou divergência, corrija a fonte de menor precedência e registre.

1. Comece por aqui

Doc Para quê
README.md O que é, quickstart de 5 min, stack, roadmap. Também em EN / ES
VISION.md Posicionamento, por que self-host, para quem
ARCHITECTURE.md Arquitetura em 1 página
AGENTS.md Contrato para agentes de código (qualquer ferramenta)
CLAUDE.md Doutrina não-negociável. Convenções, anti-patterns, Definition of Done
CONTRIBUTING.md Como contribuir
CHANGELOG.md Mudanças por versão (SemVer). Quem roda VPS lê antes de update.sh — mudança que exige ação manual aparece sob "⚠️ Requer atenção"
docs/current-state.md O que está pronto, incompleto e quebrado hoje

2. Produto e intenção

Doc Conteúdo
prd/00-prd-master.md PRD mestre — visão, escopo MVP, KPIs, restrições
prd/01-prd-platform-base.md Auth, tenancy, RBAC, framework LGPD
prd/02-prd-customer-360.md Customer 360 + identity resolution determinística
prd/03-prd-whatsapp-waha.md Canal WhatsApp, anti-banimento, janela 24h
prd/04-prd-pipeline-attendance.md Kanban, atendimento, tickets, handoff
prd/05-prd-ai-rag-handoff.md IA conversacional, RAG por tenant, sentiment
prd/06-prd-nuvemshop-lgpd.md Integração Nuvemshop + webhooks LGPD
business-rules/00-business-rules-catalog.md Catálogo de regras de negócio — fonte da verdade fora do código
presentation/pitch-deck.md Pitch

3. Contrato técnico (specs)

Detalham schema SQL e payloads exatos. Consulte antes de modelar qualquer coisa.

Spec Domínio
specs/01 Plataforma base — tenancy, RLS, RBAC, API, audit
specs/02 Customer 360
specs/03 WAHA — fila outbound, warm-up, spinning, crons
specs/04 Pipeline e atendimento
specs/05 IA, RAG, gatilhos de handoff
specs/06 Nuvemshop + LGPD
specs/07 event_log, workers, claim atômico, backoff/DLQ
specs/08 Deploy e observabilidade
specs/09 Integração front/back
specs/10 Runtime dos AI Agents
specs/11 MCP server interno + catálogo de tools
specs/12 UI dos AI Agents
specs/13 Governança de atendimento (épico G1–G6)
specs/14 Contrato para agentes de IA externos
specs/15 Casos humanos (IA delega a humano)
specs/RECONCILIATION-LOG.md Log de reconciliação entre specs

4. Doutrina e arquitetura

Doc Conteúdo
doctrine/sistema-vivo.md Doutrina do Sistema Vivo — 5 invariantes + Living System Checklist (item 13 do DoD)
architecture/agent-turn.html Diagrama do turno do agente (inbound → guardrails → outbound)
research/architecture-diagrams.md Diagramas de arquitetura
research/reference-synthesis.md Arquitetura herdada da referência WAHA
research/followup-reference-mining.md Pesquisa do motor de follow-up
threat-model.md Superfície de ataque real do self-host

5. Design system

design-system/README.md é o ponto de entrada (v1.0, 5 escolhas visuais lockadas: paleta Sage, Atkinson Hyperlegible, densidade aerada, Phosphor duotone, IBM Plex Mono). Numerados 00–09: overview, tokens, paleta, tipografia, densidade, iconografia, componentes, motion, voice & tone, anti-patterns. Fluxo de tela em design-system/screen-flow/ (jornadas, clickflows, máquinas de estado, acessibilidade).

6. Operar e instalar

Doc Conteúdo
SETUP.md Guia completo de env vars e setup local
deploy-selfhost/README.md Self-host genérico
deploy-hostgator/README.md VPS HostGator (install.sh, backup.sh, reset-mfa.sh)
DEPLOY-CHECKLIST.md Checklist de deploy
ATUALIZANDO.md update.sh, restore.sh, healthcheck.sh
runbooks/waha-hostgator.md Runbook do WAHA em produção
runbooks/ai-credentials-rotation.md Rotação de credenciais de IA
../SECURITY.md Política de reporte de vulnerabilidade

7. Testes e QA

Doc Conteúdo
testing/user-journey-map.md Mapa de jornadas vivo — casos, prioridade [P0], achados. Atualizar sempre
testing/HANDOFF-vps-qa.md Receita do ambiente fresco estilo VPS
harness-audit.md Auditoria do harness — 20 itens + nível de maturidade
../tests/e2e/README.md Como rodar os E2E

8. Execução — planos, épicos, handoffs

Documentação de processo. Alta rotatividade; trate como estado, não como contrato.

Convenção observada: épico vivo mantém o HANDOFF na raiz do repo; épico encerrado é arquivado em handoffs/. Use isso para saber o que está em voo.

  • Raiz (em voo): HANDOFF.md (follow-up), HANDOFF-harness-evolution.md, HANDOFF-operacao-visivel.md
  • handoffs/ — arquivados: casos humanos, inbox multimodal, CRM vivo, LGPD, wave1-devvivo, contrato wave5, briefing CRM vivo
  • stories/ — épicos e stories (epics/MASTER.md = plano por epic/wave)
  • superpowers/ — plans/ e specs/ datados por onda, mais handoffs/
  • growth/ — material de crescimento · brand/ — marca · white-label.md — instalação com marca própria
  • ../plan/ — backlog do gov-loop (features.json 31/31, phases.md, progress.md)
  • ../loop/ — máquina do gov-loop (LOOP.md, CHECKPOINT.md, checkpoints/G1..G6-report.md + .approved)
  • ../tasks/todo.md — workflow de construção original (Fase 0 → PRD → specs)

9. Grafo de conhecimento

graphify-out/ — grafo do repositório (7310 nós, 17705 arestas, 538 comunidades na última geração). Consulte via skill graphify antes de varrer código bruto. GRAPH_REPORT.md traz god nodes, hyperedges e comunidades. Gerado — não editar. ⚠️ Foi gerado contra uma árvore anterior à v1.0.0; regenere (/graphify .) antes de confiar em detalhe fino.

Lacunas conhecidas deste índice

  • docs/vendaval-fusion-plan.md e docs/vendaval-vps-deploy-comandos.md referem-se a uma integração ("Vendaval") cujo status é A CONFIRMAR — o README não a lista mais em "Próximo", apesar de o gatilho (loop/checkpoints/G6.approved) existir.
  • docs/diagrams/ não tem .md e não foi inventariado. docs/evidence/ é evidência visual (18 PNGs), não documentação de leitura.
  • docs/architecture/ contém só o diagrama do agent-turn; a doutrina (CLAUDE.md, DoD item 13) pede que o "mapa vivo" da arquitetura reflita toda peça nova com ≥2 arestas — NÃO IDENTIFICADO se isso está sendo cumprido, e é a lacuna documental mais relevante que sobrou.
  • docs/growth/ (3 docs) e docs/brand/ (1) não foram lidos em detalhe — classificados por nome de pasta, portanto INFERIDO.
Reference in New Issue View Git Blame Copy Permalink