Estrutura da documentação

Este guia organiza a documentação de cada domínio do NEAD Hub. As camadas seguem uma ordem de leitura: contexto, dados, necessidades, navegação, regras de negócio e contratos da API. Fluxos críticos complementam as histórias a que pertencem. Cada página registra o que foi definido, a fonte e o estado da revisão.

Como ler um domínio

Comece pelo Overview para entender o escopo. Consulte Entidades e relacionamentos para conhecer os dados definidos. Histórias do usuário registram necessidades, critérios e, quando necessários, os fluxos críticos que as complementam. Sitemap localiza páginas e rotas. Regras de negócio reúne decisões que governam o comportamento. API Reference detalha a interface entre sistemas.

As camadas se complementam. Um vínculo entre elas deve ser registrado quando o responsável o definir. Uma página ainda sem conteúdo indica que a definição está pendente nesta documentação; não indica ausência da funcionalidade no produto.

1. Overview do domínio

Apresenta propósito, escopo, fronteiras e vocabulário do domínio. É o ponto de entrada para entender o que está sendo documentado e quem responde por sua definição.

2. Entidades e relacionamentos

Descreve as entidades, seus atributos, identificadores, relações e cardinalidades definidos pelos responsáveis. Pode incluir um diagrama ER quando houver um modelo fornecido ou aprovado.

3. Histórias do usuário

Registra quem tem uma necessidade, qual resultado espera e os critérios de aceitação informados. Cada história deve ser identificável e rastreável até sua fonte.

4. Sitemap

Mapeia as páginas e rotas de um módulo ou fluxo, com os acessos e transições definidos. Ajuda a localizar a experiência de navegação, sem substituir as histórias e seus fluxos críticos.

5. Regras de negócio

Concentra enunciados normativos, condições, restrições, exceções e vigência definidos pelos responsáveis. Cada regra precisa de identificação e fonte para que sua aplicação possa ser rastreada nas outras camadas.

6. API Reference

Documenta operações e contratos de entrada e saída. Para cada operação definida, registra método e caminho, parâmetros, autenticação, respostas e erros, com versão e fonte quando aplicáveis.

Estado editorial

Cada página mostra se aguarda definição, está em rascunho ou foi aprovada por um responsável humano. Autoria, fonte e aprovação acompanham o conteúdo. O guia de contribuição explica como registrar e revisar essas informações.