Pular para o conteúdo principal

Taxonomia de rastreabilidade de requisitos

Este documento define a taxonomia pública usada pelo Uni+ para identificar, classificar, publicar e rastrear requisitos. Ele serve como apoio para páginas de requisitos, regras de negócio, cenários BDD, issues, ADRs, PRs, testes e documentação de API.

A taxonomia não substitui os artefatos técnicos dos repositórios donos. Ela estabelece a linguagem comum que permite navegar da necessidade institucional até a implementação validada.

Objetivos

  • Manter requisitos com identificação estável durante todo o ciclo de vida do produto.
  • Separar requisitos de negócio, requisitos funcionais, regras de negócio, atributos de qualidade, segurança, conformidade, dados e integrações.
  • Evitar que itens agregadores virem issues de implementação ambíguas.
  • Permitir rastreabilidade bidirecional: origem, requisito, decisão, issue, PR, código, teste e documentação pública.
  • Publicar apenas conteúdo seguro, curado e adequado ao portal público.

Princípios

Identificador imutável

Todo requisito publicado recebe um identificador UNI-REQ-NNNN, com quatro dígitos e preenchimento por zero. O identificador é opaco: não codifica módulo, tipo, prioridade, status ou recorte.

Um requisito nunca é renumerado. Se deixar de representar o produto, deve ser marcado como histórico e apontar a substituição, quando houver.

Fonte estruturada e página humana

O registro estruturado é a base de validação e geração. As páginas do portal são a apresentação humana desse registro. Conteúdo narrativo é permitido, mas deve apontar para requisitos, decisões ou contratos verificáveis.

Status honesto

Um requisito aprovado, proposto, dependente de decisão externa ou planejado para incremento futuro deve aparecer com esse estado explícito. O portal não deve tratar proposta como implementação concluída.

Campos públicos mínimos

Cada requisito publicado deve ter, no mínimo:

CampoFunção
requisito_idChave estável no formato UNI-REQ-NNNN.
tituloNome curto do requisito.
enunciadoDeclaração verificável do que o produto deve atender.
grupoFamília de classificação usada para navegação e relatórios.
tipoNatureza do requisito.
nivelPosição na árvore de rastreabilidade.
parent_idRequisito agregador, quando existir.
moduloRecorte de produto ou plataforma.
recorteFronteira de entrega.
statusCiclo de vida atual.
prioridadePrioridade MoSCoW.
criterios_aceiteCondições verificáveis de aceite.
verificacaoEvidência esperada: teste, revisão, E2E, contrato ou validação manual.
pagina_developersPágina pública relacionada no portal.
ownerResponsável institucional ou técnico pelo acompanhamento.

Campos de rastreabilidade como ADRs, issues, PRs, código e testes podem iniciar vazios quando o requisito ainda não foi implementado. Eles devem ser preenchidos à medida que a entrega avança.

Classificação por grupo

grupo define a família de navegação do requisito.

ValorUso
negocioCapacidade, resultado ou regra institucional do domínio.
funcionalComportamento observável do sistema.
dadosEstrutura, identidade, integridade e ciclo de vida de dados.
qualidadeAtributos não funcionais, validação, robustez e regressão.
segurancaControles técnicos de segurança, como cifra, masking, auditoria e proteção de acesso.
desempenhoMetas de performance, escala, carga ou SLA.
conformidadeExigências legais, regulatórias ou institucionais.
integracaoIntegração com sistemas externos ou entre módulos.
governancaDocumentação, backlog, rastreabilidade e processo decisório.

Classificação por tipo

tipo define a natureza do item registrado.

ValorUso
requisito_negocioNecessidade institucional ou capacidade de alto nível.
requisito_funcionalFunção observável que o sistema deve executar.
regra_negocioRestrição, política ou condição de domínio.
requisito_qualidadeCritério de qualidade, validação ou robustez.
requisito_segurancaControle técnico de segurança.
requisito_conformidadeAtendimento legal, normativo ou institucional.
requisito_dadosEstrutura, retenção, origem ou integridade de dados.
requisito_integracaoTroca de dados ou contrato com outro sistema.
requisito_governancaRequisito de processo, documentação ou rastreabilidade.
restricaoLimite técnico, operacional ou institucional.
decisaoItem que exige decisão formal antes da implementação.
dependenciaDependência externa ou pré-condição.
incrementoEntrega futura registrada para manter contexto.

Nível hierárquico

nivel define onde o item aparece na árvore de rastreabilidade.

ValorUso
moduloAgrupador de alto nível, como Seleção ou Ingresso.
capacidadeCapacidade de produto composta por requisitos filhos.
requisitoRequisito rastreável e verificável.
regraRegra vinculada a um requisito ou capacidade.
decisaoPonto que depende de ADR ou deliberação formal.
dependenciaDependência de outro sistema, área ou decisão externa.

nivel e tipo são eixos diferentes. Um item pode ter nivel = regra e tipo = regra_negocio; outro pode ter nivel = decisao e tipo = requisito_governanca, conforme o papel que ocupa na árvore.

Recorte de entrega

recorte separa o que entra no MVP, o que é fundação, o que é incremento obrigatório e o que fica registrado fora do escopo imediato.

ValorUso
mvpEntrega necessária para o fluxo principal da primeira versão.
fundacaoBase técnica ou conceitual exigida para sustentar entregas futuras.
incremento_obrigatorioItem não entregue no primeiro corte, mas necessário para completar o produto.
fora_escopoItem conhecido, mas explicitamente fora da entrega atual.
governancaTrabalho de documentação, rastreabilidade, decisão ou organização.

Ciclo de vida

ValorUso
aprovadoRequisito aceito para orientar backlog, design e implementação.
propostoItem em análise, ainda sujeito a revisão.
dependencia_externaDepende de área, norma, sistema ou deliberação externa.
incremento_planejadoRegistrado para evolução posterior.
historicoPreservado para rastreabilidade, sem representar o estado atual do produto.

Política de backlog

Nem todo requisito deve virar issue de implementação direta.

ValorUso
agregadorAgrupa filhos; pode originar Epic ou Feature, mas não fecha PR sozinho.
implementavelPode virar issue de entrega.
criterio_verificacaoDeve aparecer como critério de aceite, subissue ou task de validação.
decisaoExige ADR ou deliberação antes de implementação definitiva.
dependencia_externaExige validação fora do time de implementação.
incremento_futuroNão entra no backlog imediato.
governancaTrabalho de documentação, curadoria, rastreabilidade ou processo.

Vínculo com issues

Toda issue de implementação deve referenciar pelo menos um requisito_id e trazer critérios de aceite rastreáveis. Uma issue pode cobrir mais de um requisito apenas quando eles forem inseparáveis na entrega.

Formato recomendado de título:

[UNI-REQ-0028] Implementar gate documental no submit da inscrição

Itens agregador não devem ser usados como única justificativa de PR de implementação. PRs devem fechar requisitos filhos implementáveis, critérios de verificação, decisões resolvidas ou tarefas de governança.

Cadeia de rastreabilidade

A cadeia mínima esperada é:

origem -> requisito -> decisão -> issue -> PR -> código -> teste -> documentação

Quando alguma etapa ainda não existir, o campo correspondente permanece vazio ou com status explícito. O vazio deve indicar ausência real de implementação ou validação, não esquecimento editorial.

Publicação no portal

As páginas derivadas desta taxonomia devem usar as seguintes rotas:

PáginaFinalidade
/produto/requisitos/Registro filtrável de requisitos.
/produto/regras-negocio/Regras de negócio publicáveis por módulo e fluxo.
/produto/rastreabilidade/Matriz requisito, issue, ADR, PR, código, teste e documentação.
/produto/mvp-selecao/Recorte do MVP do módulo Seleção.

Antes da publicação, o conteúdo deve ser revisado para remover dados reais, corrigir vocabulário divergente e garantir que links externos apontem para os artefatos publicados nos repositórios donos.

Critérios de aceite da taxonomia

  • O identificador UNI-REQ-NNNN é único, estável e não carrega significado semântico.
  • Todo requisito publicado possui grupo, tipo, nível, status, recorte, critérios de aceite e verificação esperada.
  • Requisitos agregadores não são tratados como entregas implementáveis por si só.
  • A publicação pública distingue requisito aprovado, proposta, dependência e incremento futuro.
  • Links para ADRs, contratos, schemas e código apontam para arquivos publicados na branch main dos repositórios donos.
  • Exemplos usam dados fictícios.

Referências