Centro de documentação
Esta página é o ponto de entrada da documentação do PESA: use os links abaixo para abrir cada guia.
O item Documentação no menu do sistema traz você até aqui.
Documentos principais
-
Arquitetura e fluxos
Visão geral da arquitetura (front-end, armazenamento local, APIs) e fluxos de uso entre páginas.
-
Páginas e responsabilidades
Inventário das páginas HTML, objetivo de cada uma e dados consumidos.
-
Modelos e score
Modelos de dados (estudante, intervenção, regras) e regras de risco/score.
-
Funções principais
Mapa das funções por arquivo e pontos de extensão/manutenção.
-
Manual do usuário
Guia operacional por perfil (Coordenação, NAP e Gestão) e rotinas comuns.
-
Documentação da API
Endpoints do backend, payloads e exemplos de request/response.
-
Conectores multi-fontes (P2-008)
Contrato LMS/ERP/CRM: payload, frequência, reconciliação e alertas.
-
Efetividade causal
Outcomes O1–O3, matching e recomendações operacionais.
-
Troubleshooting
Erros comuns, causa provável e resolução rápida.
Guias rápidos e indicadores
Setup e manutenção
-
Setup completo do ambiente
Entrypoint oficial:
uvicorn backend.app:app. app_main.py é legado.
-
Setup banco e usuários
Schema e usuário admin inicial.
-
Tokens CSS:
assets/pesa-tokens.css · Admin UI: assets/admin-ui.css · Export: pesa-export.js
Ordem sugerida de leitura
- Arquitetura e fluxos
- Modelos e score
- Páginas e responsabilidades
- Funções principais
- Manual do usuário
- Documentação da API
- Troubleshooting
Observações
O sistema é majoritariamente front-end, com persistência em localStorage e base compartilhada via /api/estudantes-data.
Backend canônico: backend.app:app. A documentação acompanha o estado atual do código.