Convenção de Nomenclatura (B)
O que é
Seção intitulada “O que é”Todo artefato do repositório SinergIA segue o padrão de nome de ficheiro:
PV-TIPO-NNNN--descricao-em-kebab-case.mdIsto garante rastreabilidade entre ficheiro, ponto de vista (PV) e tipo documental.
Como usar
Seção intitulada “Como usar”- Aplique o padrão a todo ficheiro
.mdcriado sobartefatos/(e extensões acordadas pelo projeto). - Atribua
NNNNsequencial por tipo dentro do PV; use kebab-case sem acentos na descrição. - Valide YAML e regras em Regras de validação.
Exemplo
Seção intitulada “Exemplo”| Arquivo | Interpretação |
|---|---|
ESP-HNI-0001--cadastro-de-usuario.md | ESP · História Negócio Institucional · nº 1 |
ESP-HNU-0003--consultar-extrato-beneficio.md | ESP · História Negócio de Usuário · nº 3 |
ESP-HRD-0001--regra-elegibilidade-auxilio.md | ESP · Regra de Decisão · nº 1 |
GTI-ADR-0001--escolha-do-banco-de-dados.md | GTI · Architecture Decision Record · nº 1 |
GTI-RFC-0001--migracao-para-cloud.md | GTI · Request for Comments · nº 1 |
IMP-TDD-0001--desenho-tecnico-autenticacao.md | IMP · Technical Design Document · nº 1 |
IMP-API-0001--contrato-endpoint-usuarios.md | IMP · API Contract · nº 1 |
PDP-ADR-0001--politica-de-retencao-de-dados.md | PDP · ADR de Privacidade · nº 1 |
PDP-RIPD-0001--avaliacao-cadastro-beneficiario.md | PDP · Relatório de Impacto · nº 1 |
INF-HSI-0001--politica-seguranca-aplicacoes.md | INF · História Institucional · nº 1 |
PRO-PRT-0001--prototipo-tela-cadastro.md | PRO · Protótipo · nº 1 |
GDA-ERD-0001--diagrama-er-beneficios-v1.md | GDA · Diagrama ER · nº 1 |
Onde se aplica
Seção intitulada “Onde se aplica”| Destino | Link |
|---|---|
| Regras e YAML | /artefatos/nomenclatura/regras/ |
| Convenções (framework) | /framework/referencias/#11-convenção-de-nomenclatura-de-arquivos |
| Estrutura de pastas | /artefatos/visao-geral/ · /artefatos/ |
Componentes do nome
Seção intitulada “Componentes do nome”| Componente | Significado |
|---|---|
PV | Sigla do ponto de vista (ESP, IMP, GTI, PDP, INF, PRO, GDA) |
TIPO | Tipo do artefato (HNI, ADR, TDD, RIPD, etc.) |
NNNN | Número sequencial de 4 dígitos com zero à esquerda |
descricao | Descrição curta em kebab-case (minúsculas, hifens, sem acentos) |
O separador duplo -- distingue o código estruturado (PV-TIPO-NNNN) da descrição legível.