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.
Modo de Aplicação
Seção intitulada “Modo de Aplicação”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.
Autoridades Documentais
Seção intitulada “Autoridades Documentais”| Sigla | Ponto de Vista | Autoridade | Obrigatório |
|---|---|---|---|
| ESP (Especificação) | Especificação | Requisitos e histórias | ✅ Sim |
| IMP (Implementação) | Implementação | Construção, entrega e qualidade | ✅ Sim |
| GTI (Governança de TI) | Governança de TI | Decisões arquiteturais e roadmap | ✅ Sim |
| PDP (Proteção de Dados Pessoais) | Proteção de Dados | Privacidade e LGPD | ✅ Sim |
| INF (Infraestrutura) | Infraestrutura | Infraestrutura e CI/CD | ⚪ Opcional |
| PRO (Prototipação) | Prototipação | Protótipos e validação visual | ⚪ Opcional |
| GDA (Governança de Dados) | Governança de Dados | Modelos de dados e governança | ⚪ Opcional |
Árvore de Pastas
Seção intitulada “Árvore de Pastas”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)Diagrama de Autoridades
Seção intitulada “Diagrama de Autoridades”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)Convenção de Nomenclatura
Seção intitulada “Convenção de Nomenclatura”Todo artefato segue o padrão:
PV-TIPO-NNNN--descricao-em-kebab-case.md| Exemplo | Interpretação |
|---|---|
ESP-HNI-0001--cadastro-de-usuario.md | ESP (Especificação) · História Negócio Institucional · nº 1 |
GTI-ADR-0001--escolha-do-banco-de-dados.md | GTI (Governança de TI) · Architecture Decision Record · nº 1 |
IMP-TDD-0001--plano-de-testes-autenticacao.md | IMP (Implementação) · Test Design Document · nº 1 |
PDP-ADR-0001--politica-de-retencao-de-dados.md | PDP (Proteção de Dados Pessoais) · ADR de Privacidade · nº 1 |
Regras Gerais de Validação
Seção intitulada “Regras Gerais de Validação”- Todo artefato deve ter cabeçalho YAML com
id,tipo,status,autoredata. - Histórias (ESP (Especificação)) devem ter critérios de aceite mensuráveis.
- Decisões (ADR/DEC) devem registrar contexto, alternativas e justificativa.
- Evidências (EVD) devem vincular ao artefato de origem.
- 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.