Namespaces e Convenção de IDs¶
Convenção Geral¶
{NAMESPACE}-{DOMAIN}-{SEQUENCE}
Onde:
NAMESPACE = tipo do objeto (3-4 letras maiúsculas)
DOMAIN = domínio ou contexto (BR = Brasil, SEC = Security…)
SEQUENCE = número sequencial com zero-padding (3 dígitos mínimo)
Para registros temporais (incidentes, mudanças, releases):
{NAMESPACE}-{YYYY}-{SEQUENCE}
Tabela de Namespaces¶
SVC
SVC-BR-001
Serviço. Nível de produto/contrato com o cliente.
API
API-BR-001
API. Mapeia para openapi.yaml de um repositório.
EP
EP-BR-001-005
Endpoint. Terceiro segmento = sequência dentro da API.
DATA
DATA-BR-001
Dataset. Registrado em dataset.yaml.
SRC
SRC-BR-001
Source (fonte de dados). Ex: IBGE, Receita Federal.
FIELD
FIELD-BR-001-003
Campo de dataset. Terceiro segmento = posição no schema.
PIPE
PIPE-BR-001
Pipeline de dados. Transforma SRC em DATA.
POL
POL-SEC-001
Política. Domain = área (SEC, ACC, CHG, INC, BAK, DEV, PRV…).
PROC
PROC-INC-001
Processo. Domain = área do processo.
ADR
ADR-0001
Architecture Decision Record. Sequencial simples, sem domain.
RISK
RISK-001
Risco no Risk Register. Sequencial global.
INC
INC-2026-0001
Incidente. Inclui ano para rastreabilidade temporal.
CHG
CHG-2026-0001
Change Request. Inclui ano.
REL
REL-2026-0001
Release record. Mapeia para GitHub Release tag.
SLA
SLA-BR-001
Documento SLA vinculado a um serviço.
SLO
SLO-BR-001
Documento SLO vinculado a um serviço.
Versionamento de Documentos¶
{ID}-v{MAJOR}.{MINOR}
Exemplos:
POL-SEC-001-v1.0 ← versão inicial aprovada
SLA-BR-001-v2.1 ← revisão menor sem mudança de obrigação
ADR-0001 ← ADRs são imutáveis (superceded = novo ADR)
MAJOR: mudança significativa de conteúdo ou escopoMINOR: correção, adição de seção menor, clarificação
ADRs são imutáveis
ADRs nunca são editados após aprovação. Quando uma decisão é revertida ou substituída, cria-se um novo ADR que referencia o anterior:
Ciclo de Vida de Documentos¶
| Status | Descrição | Transição |
|---|---|---|
draft |
Em elaboração, não operacional | → review |
review |
Aguardando revisão por par ou aprovador | → approved / draft |
approved |
Aprovado, aguardando ativação formal | → active |
active |
Em vigor e operacional | → deprecated |
deprecated |
Substituído por versão mais nova, ainda referenciável | → archived |
archived |
Fora de uso, mantido apenas como evidência histórica | — |
Transições de status são registradas no frontmatter do documento com data e responsável:
Dominios Predefinidos¶
| Domain | Uso |
|---|---|
BR |
Contexto Brasil (dados, APIs, serviços) |
SEC |
Segurança (políticas, processos, incidentes) |
ACC |
Controle de acesso |
CHG |
Gestão de mudanças |
INC |
Gestão de incidentes |
BAK |
Backup e recuperação |
DEV |
Desenvolvimento |
PRV |
Privacidade |
OPS |
Operações |
DAT |
Dados (processos) |
Próximo passo¶
Com o sistema de IDs definido, consulte Navegação de Dados para ver como os IDs conectam Customer → Source e Source → Customer.