Ir para o conteúdo

Definition of Done — EvidencIA (Release 1.0.0 — GO)

Nesta página

DoD Geral (todas as entregas)

Uma entrega está Done quando todos os itens abaixo estiverem verificados:

  • Código commitado na branch correta (main, feat/, fix/, docs/) com mensagem Conventional Commits.
  • Testes passando (unitários e de integração relevantes) no CI/CD sem falhas (151 backend, 171 frontend).
  • Documentação atualizada no mesmo commit ou PR da entrega (sem docs atrasados).
  • Evidência reproduzível — qualquer revisor pode executar e obter o mesmo resultado com as mesmas condições.
  • Issue/tarefa vinculada no sistema de acompanhamento (GitHub Issues ou equivalente).
  • Revisão por outro integrante da equipe (ao menos 1 aprovação de PR) antes do merge.

DoD Específica — Código

Além da DoD Geral, código de produção satisfaz:

  • Lint e typecheck limpos — zero erros de ruff, tsc e linters no CI.
  • Cobertura de testes ≥ 80% para o módulo entregue (backend 91.2%, frontend 99.6%).
  • Nenhum secret ou credencial no código, logs ou artefatos (verificado por secret scan).
  • Mock de IA desativado — LLM_PROVIDER=mock estritamente bloqueado em builds de produção (MockInProductionError).
  • Critérios de aceitação Gherkin executáveis passando para todas as HUs correspondentes.
  • Sem console.log / print de debug não intencionais no código commitado.
  • TBT ≤ 50 ms e memória adicional ≤ 80 MB verificados na extensão.
  • Auditoria de acessibilidade com axe-core sem erros de nível AA (WCAG 2.1 AA compliant).

DoD Específica — Notebook / EDA

Um notebook de EDA está Done quando:

  • Executa do zero (Kernel → Restart & Run All) sem erros em ambiente limpo.
  • Seeds fixas declaradas e documentadas para reprodutibilidade estrita.
  • Sem dados brutos commitados — dados originais obtidos via script de download ou referência a artefato externo.
  • Métricas calculadas (Recall@k, MRR, nDCG) documentadas na célula de resultados.
  • Interpretação qualitativa dos top-k resultados documentada no notebook.
  • Conclusão com resposta explícita às Guiding Questions abordadas.
  • Versionamento — notebook commitado em pasta documentada com saídas limpas.

DoD Específica — Documentação

Uma entrega de documentação está Done quando:

  • Links relativos válidos — verificação automatizada com check_drift.py (0 links quebrados).
  • IDs de rastreabilidade atualizados — HU, RF, RNF, GQ e ADR citados existem nos documentos de origem.
  • Histórico de revisão atualizado em toda HU ou requisito alterado.
  • Sem A preencher bloqueante — todas as seções e portões preenchidos e homologados.
  • Linguagem consistente — sem termos legados em contexto atual, em conformidade com ADR-006.

DoD Específica — Requisito / HU

Uma História de Usuário ou Requisito Funcional está Done quando:

  • Critérios de Aceitação em Gherkin definidos com cenários verificáveis (Dado/Quando/Então).
  • Rastreabilidade bidirecional mapeando Guiding Questions (GQ), ADR correspondente e personas relacionadas.
  • Histórico de revisão preenchido registrando data, motivo da modificação e referência ao ADR.
  • Catálogo de Requisitos e Matriz de Rastreabilidade sincronizados com os IDs, prioridades MoSCoW e status correspondentes.

Ver também: Product Backlog · Estratégia de Testes · Contrato de API