Pular para o conteúdo

Estrutura de Artefatos

O diretório artefatos/ na raiz do repositório contém toda a documentação estruturada do projeto, organizada segundo o Framework SinergIA em pontos de vista independentes.


O repositório opera em Modo Essencial: os pontos de vista ESP (Especificação), IMP (Implementação), GTI (Governança de TI) e PDP (Proteção de Dados Pessoais) são obrigatórios. Os pontos INF (Infraestrutura), PRO (Prototipação) e GDA (Governança de Dados) são opcionais e devem ser ativados conforme a necessidade do projeto.

SiglaPonto de VistaAutoridadeObrigatório
ESP (Especificação)EspecificaçãoRequisitos e histórias✅ Sim
IMP (Implementação)ImplementaçãoConstrução, entrega e qualidade✅ Sim
GTI (Governança de TI)Governança de TIDecisões arquiteturais e roadmap✅ Sim
PDP (Proteção de Dados Pessoais)Proteção de DadosPrivacidade e LGPD✅ Sim
INF (Infraestrutura)InfraestruturaInfraestrutura e CI/CD⚪ Opcional
PRO (Prototipação)PrototipaçãoProtótipos e validação visual⚪ Opcional
GDA (Governança de Dados)Governança de DadosModelos de dados e governança⚪ Opcional

Cada ponto de vista segue a mesma estrutura interna de subpastas numeradas:

artefatos/
├── README.md ← índice geral + autoridades documentais
├── ESP (Especificação)/ ← OBRIGATÓRIO — autoridade sobre requisitos
│ ├── README.md
│ ├── 00-indice/ ← IDX, CTX
│ ├── 01-visao-geral/ ← VIS, BRD, PRD, STY
│ ├── 02-historias/
│ │ ├── HNI/ HNE/ HNU/ HS/
│ │ ├── HRD/ HUX/ HC/ HAI/
│ │ ├── HAC/ HIVC/ HI/
│ ├── 03-decisoes/ ← DEC
│ ├── 04-evidencias/ ← EVD
│ ├── 05-checklists/ ← CHK
│ ├── 06-modelos/ ← DOM, STY, TPL
│ ├── 07-referencias/ ← REF
│ └── 08-publicado/
├── IMP (Implementação)/ ← OBRIGATÓRIO — construção e entrega
│ ├── 00-indice/ 01-visao-geral/ (DOD)
│ ├── 03-decisoes/ (TDD, API)
│ ├── 04-evidencias/ 05-checklists/ 06-modelos/ (TPL)
│ └── 07-referencias/ (CHG, REL)
├── GTI (Governança de TI)/ ← OBRIGATÓRIO — autoridade sobre decisões
│ ├── 01-visao-geral/ (RDM)
│ ├── 03-decisoes/ (ADR, DEC)
│ ├── 06-modelos/ (RFC)
│ └── 07-referencias/ (REF)
├── PDP (Proteção de Dados Pessoais)/ ← OBRIGATÓRIO — privacidade desde a origem
│ ├── 01-visao-geral/ (BRD de privacidade)
│ ├── 03-decisoes/ (ADR de privacidade)
│ ├── 04-evidencias/ (RIPD)
│ └── 06-modelos/ (RUN, PMT)
├── INF (Infraestrutura)/ ← OPCIONAL — infraestrutura
│ └── 02-historias/ HII/ HIS/
├── PRO (Prototipação)/ ← OPCIONAL — prototipação
│ └── 02-historias/ (protótipos vinculados ao ESP (Especificação))
└── GDA (Governança de Dados)/ ← OPCIONAL — governança de dados
├── 01-visao-geral/ (DOM)
└── 06-modelos/ (ERD)

flowchart TD
ESP (Especificação)["ESP (Especificação)\n(autoridade: requisitos)"]
INF (Infraestrutura)["INF (Infraestrutura)\n(infraestrutura)\nOPCIONAL"]
PRO (Prototipação)["PRO (Prototipação)\n(prototipação)\nOPCIONAL"]
IMP (Implementação)["IMP (Implementação)\n(entrega e construção)"]
GTI (Governança de TI)["GTI (Governança de TI)\n(autoridade: decisões)"]
GDA (Governança de Dados)["GDA (Governança de Dados)\n(dados)\nOPCIONAL"]
PDP (Proteção de Dados Pessoais)["PDP (Proteção de Dados Pessoais)\n(privacidade)"]
ESP (Especificação) --> PRO (Prototipação)
ESP (Especificação) --> INF (Infraestrutura)
PRO (Prototipação) --> IMP (Implementação)
INF (Infraestrutura) --> IMP (Implementação)
GTI (Governança de TI) -->|governa| ESP (Especificação)
GTI (Governança de TI) -->|governa| INF (Infraestrutura)
GTI (Governança de TI) -->|governa| PRO (Prototipação)
GTI (Governança de TI) -->|governa| IMP (Implementação)
GTI (Governança de TI) -->|governa| GDA (Governança de Dados)
GTI (Governança de TI) -->|governa| PDP (Proteção de Dados Pessoais)

Todo artefato segue o padrão:

PV-TIPO-NNNN--descricao-em-kebab-case.md
ExemploInterpretação
ESP-HNI-0001--cadastro-de-usuario.mdESP (Especificação) · História Negócio Institucional · nº 1
GTI-ADR-0001--escolha-do-banco-de-dados.mdGTI (Governança de TI) · Architecture Decision Record · nº 1
IMP-TDD-0001--plano-de-testes-autenticacao.mdIMP (Implementação) · Test Design Document · nº 1
PDP-ADR-0001--politica-de-retencao-de-dados.mdPDP (Proteção de Dados Pessoais) · ADR de Privacidade · nº 1

  1. Todo artefato deve ter cabeçalho YAML com id, tipo, status, autor e data.
  2. Histórias (ESP (Especificação)) devem ter critérios de aceite mensuráveis.
  3. Decisões (ADR/DEC) devem registrar contexto, alternativas e justificativa.
  4. Evidências (EVD) devem vincular ao artefato de origem.
  5. Nenhum artefato pode ser publicado em 08-publicado/ sem evidência de revisão.

Para detalhes de cada ponto de vista, consulte as páginas ESP (Especificação) & Histórias e Decisões & Governança.