Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 2.88 KB

File metadata and controls

47 lines (36 loc) · 2.88 KB

Documentação do Sinapse

Este índice separa os guias operacionais, contratos e especificações de produto. O README da raiz apresenta o produto e o caminho rápido para executá-lo.

Começar e desenvolver

Documento Conteúdo
Guia de setup Docker Compose, execução local, variáveis, testes e solução de problemas.
Testes E2E Suítes de navegador, dependências e execução com dados descartáveis.
Migrations Baseline, migrations versionadas e validação do banco.
Seed Acervo curado, validação, modo de aplicação e política de segurança.

Produto e arquitetura

Documento Fonte de verdade para
PRD PRO4TECH Problema, visão, requisitos e regras de produto.
Arquitetura Componentes que existem hoje, fronteiras, fluxos e propostas ainda não implementadas.
Backlog Épicos, features e PBIs.
Planejamento Scrum Equipe, abordagem Scrum, estado concluído da Sprint 1 e sprints futuras ainda planejadas.
Interface e handoff Consulte o backlog e os materiais de design; o documento de handoff S1-28 não está versionado nesta branch.
Protótipo e Design System Telas, protótipo navegável e materiais de handoff.

Contratos e integrações

QA e decisões registradas

Como manter os documentos

  • Atualize este índice e o README quando um guia de referência mudar de local ou escopo.
  • Trate o código, as migrations e o OpenAPI como fontes do comportamento implementado.
  • Identifique no texto quando algo é requisito do PRD, decisão histórica, proposta futura ou comportamento já implementado.
  • Não publique credenciais, tokens, dados pessoais, documentos de clientes ou .env.
  • Ao adicionar imagens de produto, use capturas reais do app, texto alternativo descritivo e dados sintéticos. Explique o contexto da captura.