Pular para o conteúdo

Convenção de Nomenclatura (B)

Todo artefato do repositório SinergIA segue o padrão de nome de ficheiro:

PV-TIPO-NNNN--descricao-em-kebab-case.md

Isto garante rastreabilidade entre ficheiro, ponto de vista (PV) e tipo documental.


  • Aplique o padrão a todo ficheiro .md criado sob artefatos/ (e extensões acordadas pelo projeto).
  • Atribua NNNN sequencial por tipo dentro do PV; use kebab-case sem acentos na descrição.
  • Valide YAML e regras em Regras de validação.

ArquivoInterpretação
ESP-HNI-0001--cadastro-de-usuario.mdESP · História Negócio Institucional · nº 1
ESP-HNU-0003--consultar-extrato-beneficio.mdESP · História Negócio de Usuário · nº 3
ESP-HRD-0001--regra-elegibilidade-auxilio.mdESP · Regra de Decisão · nº 1
GTI-ADR-0001--escolha-do-banco-de-dados.mdGTI · Architecture Decision Record · nº 1
GTI-RFC-0001--migracao-para-cloud.mdGTI · Request for Comments · nº 1
IMP-TDD-0001--desenho-tecnico-autenticacao.mdIMP · Technical Design Document · nº 1
IMP-API-0001--contrato-endpoint-usuarios.mdIMP · API Contract · nº 1
PDP-ADR-0001--politica-de-retencao-de-dados.mdPDP · ADR de Privacidade · nº 1
PDP-RIPD-0001--avaliacao-cadastro-beneficiario.mdPDP · Relatório de Impacto · nº 1
INF-HSI-0001--politica-seguranca-aplicacoes.mdINF · História Institucional · nº 1
PRO-PRT-0001--prototipo-tela-cadastro.mdPRO · Protótipo · nº 1
GDA-ERD-0001--diagrama-er-beneficios-v1.mdGDA · Diagrama ER · nº 1

DestinoLink
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/

ComponenteSignificado
PVSigla do ponto de vista (ESP, IMP, GTI, PDP, INF, PRO, GDA)
TIPOTipo do artefato (HNI, ADR, TDD, RIPD, etc.)
NNNNNúmero sequencial de 4 dígitos com zero à esquerda
descricaoDescriçã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.


← Estrutura & Visão Geral · Regras de Validação →