← Voltar a studyAI — Documentação do Projeto

📑 Índice da Documentação

studyAI — Documentação do Projeto

Apresentação

Índice da Documentação — studyAI

Guia de navegação da documentação do projeto.

Por tema

Visão e conceito

Documento	Descrição
README.md	Visão geral do produto, ideia, fluxos principais

Arquitetura e decisões

Documento	Descrição
ARCHITECTURE.md	Camadas, componentes, diagrama de alto nível, fluxo de dados
TECH_DECISIONS.md	Decisões tecnológicas com rationale e alternativas

Diagramas

Documento	Descrição
DIAGRAMS.md	Índice de todos os diagramas (Mermaid)

Especificações técnicas

Documento	Descrição
API_SPEC.md	Especificação completa da API REST
DATA_MODEL.md	Schema da base de dados, entidades, relações
RAG_DESIGN.md	Chunking, indexação, retrieval, uso por agente

Agentes e fluxos

Documento	Descrição
AGENTS.md	Todos os agentes (core, opcionais), grafo, conditional edges
FLOWS.md	Fluxos do utilizador, sequências, diagramas de estado
AGENTS_DISCUSSION.md	Notas de discussão e decisões sobre agentes (em aberto)

Learning e produto

Documento	Descrição
LEARNING_LOOP.md	Loop de aprendizagem adaptativa, spaced repetition
USER_INTELLIGENCE.md	User state, memory, adaptação dos agentes
COST_CONTROL.md	Caching, model selection, limites por plano
ROADMAP.md	Sprints, timeline, checklists, prioridades
JOBS_ASYNC.md	Workers, retry, progress, Celery
STATE_SCHEMA.md	Contrato Planner-Writer (LangGraph)
TESTING.md	Estratégia de testes
PROMPTS_VERSIONING.md	Versionamento de prompts
PDF_INGESTION.md	Parsing de PDFs
CITATIONS_UX.md	Citações e groundedness na UI

Segurança e operações

Documento	Descrição
SECURITY.md	Auth, autorização, rate limiting, multi-tenant
DEPLOYMENT.md	Ambientes, Docker, CI/CD, monitorização

Por fase de desenvolvimento

Fase	Documentos relevantes
Fundação	ARCHITECTURE, TECH_DECISIONS, DATA_MODEL, SECURITY
API	API_SPEC, DATA_MODEL
Agentes	AGENTS, RAG_DESIGN, FLOWS
Learning	LEARNING_LOOP, USER_INTELLIGENCE
Produção	DEPLOYMENT, SECURITY, COST_CONTROL, ROADMAP

Diagramas

Índice completo: DIAGRAMS.md — todos os diagramas Mermaid em um único ficheiro.

Diagrama	Localização
Visão geral, jornada, arquitetura	README.md
Arquitetura de alto nível	ARCHITECTURE.md
Camadas do sistema	ARCHITECTURE.md
Fluxos do utilizador	FLOWS.md
Sequência chat (QA)	FLOWS.md
Sequência geração de conteúdo	FLOWS.md
Sequência avaliação	FLOWS.md
Pipeline RAG	RAG_DESIGN.md
Grafo de agentes	AGENTS.md
Ciclo de vida de jobs	JOBS_ASYNC.md
Multi-tenant, auth flow	SECURITY.md
Auth flow	API_SPEC.md
Diagrama ER	DATA_MODEL.md
Deploy produção	DEPLOYMENT.md
Learning Loop	LEARNING_LOOP.md
Fases e sprints	ROADMAP.md
Controlo de custos	COST_CONTROL.md

Zona de prática

Sem perguntas. Clica em Editar para adicionar.