Pular para o conteúdo

Convenções, Ciclo e Governança

A convenção de nomes deverá seguir o padrão:

<PV>-<TIPO>-<NUM>--<descricao-curta>.md

Onde:

  • PV = ponto de vista geral;
  • TIPO = tipo do artefato, história ou documento;
  • NUM = número sequencial com 4 dígitos (0001–9999);
  • descricao-curta = resumo objetivo, sem acentos, sem caracteres especiais, separado por hífen.

Nota de design: o uso de 4 dígitos foi adotado para garantir capacidade de escala em projetos de alta volumetria de artefatos.

SiglaPonto de vista
ESP (Especificação)Especificação
INF (Infraestrutura)Infraestrutura
PRO (Prototipação)Prototipação
IMP (Implementação)Implantação e Construção
GTI (Governança de TI)Governança de TI
GDA (Governança de Dados)Governança de Dados
PDP (Proteção de Dados Pessoais)Proteção de Dados Pessoais

HNI, HNE, HNU, HS, HI, HRD, HUX, HC, HAI, HAC, HIVC

HII, HSI, HATI, HCTI, HCI, HSII, HAII, HIS, HSE, HDISP, HAUT, HMON, HSIS, HDEP, HAMB, HIOP, HAIS

SiglaDocumento
VISVision Document
BRDBusiness Requirements Document
PRDProduct Requirements Document
RFCRequest for Comments
ADRArchitecture Decision Record
SDDSystem Design Document
TDDTechnical Design Document
DOMDomain Model
ERDData Model / Entity-Relationship Diagram
APIAPI Contract
TPLTest Plan
DODDefinition of Done
RUNRunbook / Playbook
PMTPostmortem
RDMRoadmap
CHGChangelog
RELRelease Notes
EVDEvidência
CHKChecklist
DECDecisão
IDXÍndice
REFReferência
CTXContext Map
STYStyle Guide
ESP-HNI-0001--diretrizes-institucionais-de-atendimento.md
ESP-HAI-0004--autenticacao-govbr-por-nivel.md
INF-HMON-0003--regras-de-alerta-e-escalonamento.md
INF-HAUT-0002--pipeline-ci-cd-da-solucao.md
IMP-TDD-0001--implementacao-do-login-externo.md
GTI-ADR-0001--validacao-cruzada-obrigatoria-por-ia.md
GDA-ERD-0001--modelo-relacional-principal.md
PDP-RUN-0001--tratamento-de-incidente-com-dados-pessoais.md
ESP-CTX-0001--mapa-de-contexto-versao-atual.md
ESP-STY-0001--style-guide-identidade-visual.yaml

Cada ponto de vista geral deverá possuir repositório próprio, segregado dos demais, com histórico próprio, responsáveis próprios e trilha própria de evolução.

No mínimo: repositórios ESP (Especificação), INF (Infraestrutura), PRO (Prototipação), IMP (Implementação), GTI (Governança de TI), GDA (Governança de Dados) e PDP (Proteção de Dados Pessoais).

Sincronização entre repositórios: a rastreabilidade bidirecional deverá ser garantida por:

  • referência explícita ao identificador do artefato de origem em todo artefato derivado;
  • arquivo IDX de índice cruzado em cada repositório;
  • detecção automatizada de divergências pelo Artefato Orquestrador quando um artefato referenciado for alterado sem atualização correspondente;
  • autoridade documental definida: ESP (Especificação) é autoridade sobre requisitos; INF (Infraestrutura) sobre padrões de infraestrutura; GTI (Governança de TI) sobre decisões.

Alternativa para Modo Ágil: projetos classificados no Modo Ágil poderão utilizar monorepo com workspaces segregados por ponto de vista.

/00-indice
/01-visao-geral
/02-historias
/03-decisoes
/04-evidencias
/05-checklists
/06-modelos
/07-referencias
/08-publicado
  • Um documento deve tratar de um assunto principal;
  • Documentos longos deverão ser quebrados em partes;
  • A navegação deverá ocorrer por índice, links, referências e pastas temáticas.

Tudo deverá ser versionado: histórias, protótipos, decisões, artefatos de infraestrutura, códigos, testes, modelos de dados, políticas, documentação e evidências. O versionamento deverá permitir identificar: versão vigente, versões anteriores, data de cada alteração, autores ou responsáveis, justificativa e artefatos afetados.

Deverá existir ferramenta de geração automatizada de documentação funcional, técnica, operacional e de governança. Esta ferramenta é parte integrante do Artefato Orquestrador e constitui pré-requisito operacional para viabilidade do framework.

Todo documento gerado deverá apresentar, de forma visível: data da última alteração, autores, versão vigente, vínculos com artefatos correlatos e evidências relacionadas.


flowchart TD
A[Consolidação de histórias ESP (Especificação) por IA] --> B{Validação cruzada\nIA + humano}
B -->|Aprovado| C[PRO — prototipação preliminar]
B -->|Rejeitado| A
C --> D[Reunião a quente com demandante\n+ registro obrigatório]
D --> E[Histórias aprovadas e refinadas]
E --> F[INF — estruturação de ambientes\nautenticação, monitoração, CI/CD]
E --> G[IMP — construção por IA agêntica]
F --> G
G --> H{Validação cruzada\nIA + critério de divergência}
H -->|Divergência relevante| I[Escalada ao Validador Técnico]
H -->|Aprovado| J[Linter de Governança]
I --> J
J -->|Conforme| K[Gate de promoção de ambiente]
J -->|Não conforme| G
K --> L[Dossiê automatizado + evidências]
L --> M[GTI (Governança de TI) / GDA (Governança de Dados) / PDP — supervisão contínua]
EtapaResponsável principalApoio de IA
Consolidação de históriasIA primária (ESP (Especificação))
Validação cruzada de históriasIA secundária + Validador de NegócioBriefing por papel
Prototipação preliminarIA agêntica (PRO (Prototipação))
Reunião de refinamentoDemandante + IARegistro estruturado obrigatório
Estruturação de infraestruturaIA agêntica (INF (Infraestrutura)) + Validador Técnico
ConstruçãoIA agêntica (IMP (Implementação))
Validação cruzada da implementaçãoIA secundária + Validador TécnicoRelatório de impacto
Linter de GovernançaArtefato OrquestradorAutomático
Gate de promoçãoValidador Técnico + Validador de NegócioIA assiste
Dossiê e evidênciasArtefato OrquestradorAutomático
Supervisão contínuaGTI (Governança de TI) + GDA (Governança de Dados) + PDP (Proteção de Dados Pessoais)IA monitora

O framework é compatível com metodologias ágeis. Recomenda-se cadência de refinamento de histórias a cada sprint (ciclo de duas semanas), com o ciclo operacional mapeado para as cerimônias de refinamento, planejamento e revisão.

CondiçãoAção obrigatória
Divergência relevante entre engines de IAEscalada imediata ao Validador humano; execução bloqueada
Rejeição de história na validação humanaRetorno à ESP (Especificação) com registro formal de rejeição
Não-conformidade no Linter de GovernançaBloqueio do avanço de fase; correção obrigatória
Conflito entre validação de IA e humanaDecisão pertence ao humano; divergência registrada como DEC
Rollback após promoçãoAcionamento via pipeline; postmortem obrigatório para produção
Ausência de registro em reunião a quenteDecisões não reconhecidas para fins de rastreabilidade

Sempre que aplicável, as soluções construídas sob este framework deverão informar ao usuário:

  • identificação de que a solução ou parte dela opera com assistência de IA;
  • indicação das limitações funcionais relevantes conhecidas;
  • mecanismo de autenticação utilizado e nível de autenticação requerido;
  • finalidade do uso de dados pessoais, quando aplicável;
  • canal e momento adequados para apresentação dos disclaimers.

A adoção deste framework deverá permitir que a instituição desenvolva sistemas com: maior velocidade de construção, maior padronização de artefatos, maior reaproveitamento de conhecimento institucional, maior capacidade de rastreamento, auditoria e geração de evidências, maior aderência a normas e políticas, maior qualidade técnica e maior segurança jurídica, operacional e informacional no uso intensivo de inteligência artificial.

IndicadorDescriçãoMeta orientativa
Tempo de spec-to-deployTempo entre aprovação das primeiras histórias e entrega em produçãoA definir por projeto
Cobertura de testes automatizadosPercentual de cobertura gerada por IA≥ 80% no Modo Completo
Taxa de divergência relevanteProporção de artefatos com divergência que obrigou escaladaMonitorar tendência
Tempo médio de aprovação humanaTempo entre submissão ao validador e aprovaçãoA definir por nível
Volume de evidências automáticasProporção de evidências obrigatórias geradas automaticamente100% das obrigatórias
Taxa de bloqueio no LinterProporção de artefatos bloqueados antes do gateTendência decrescente

TermoDefinição
Agente agêntico / IA agênticaSistema de IA capaz de executar sequências de ações de forma autônoma com objetivo definido
AlucinaçãoGeração de conteúdo factualmente incorreto ou inventado por um modelo de IA
Artefato OrquestradorAgente central responsável por coordenar o ciclo operacional do framework
Contexto distintoConfiguração em que a segunda engine opera com modelo, provedor, sessão e perspectiva diferentes da engine primária
CTX (Context Map)Artefato que resume o estado atual do projeto para alimentar o contexto dos agentes de IA
Engine de IAModelo de linguagem utilizado para produzir, validar ou avaliar artefatos do framework
GroundingAncoragem de respostas de IA em dados e documentos verificáveis
HITL (Human-in-the-Loop)Modelo de operação em que um humano participa da decisão em pontos definidos do fluxo
Linter de GovernançaMecanismo que verifica se artefatos possuem todos os metadados, vínculos e evidências obrigatórias
Modo de aplicaçãoConfiguração de uso do framework proporcional à criticidade: Completo, Essencial ou Ágil
Ponto de vista (PV)Perspectiva estruturada e segregada de análise do sistema
STY (Style Guide)Arquivo estruturado (JSON/YAML) com parâmetros de identidade visual e acessibilidade
Validação cruzadaSubmeter um artefato gerado por uma engine à avaliação de outra engine em contexto distinto
Vendor lock-inDependência excessiva de um provedor que dificulta a migração para alternativas

O framework deverá ser aplicado de forma proporcional à criticidade, sensibilidade e complexidade do projeto.

Indicado para: sistemas com dados pessoais sensíveis, impacto financeiro relevante, risco à vida, obrigação legal, exposição pública ou dependência operacional crítica.

DimensãoEspecificação
Pontos de vistaTodos os 7 (ESP (Especificação), INF (Infraestrutura), PRO (Prototipação), IMP (Implementação), GTI (Governança de TI), GDA (Governança de Dados), PDP (Proteção de Dados Pessoais))
Histórias ESP (Especificação)11 tipos individuais (HNI a HIVC)
Repositórios7 segregados
ValidaçõesIA primária + IA secundária + humano
EvidênciasTodas as obrigatórias por seção
Linter de GovernançaObrigatório em todos os gates
Cobertura de testes≥ 80%

Indicado para: sistemas internos sem dados pessoais sensíveis, aplicações de suporte operacional.

DimensãoEspecificação
Pontos de vistaESP (Especificação), IMP (Implementação), GTI (Governança de TI), PDP (Proteção de Dados Pessoais) obrigatórios; INF (Infraestrutura), PRO (Prototipação), GDA (Governança de Dados) quando aplicável
Histórias ESP (Especificação)5 grupos temáticos
Repositórios4 segregados ou monorepo com workspaces
ValidaçõesIA primária + humano por amostragem
EvidênciasSimplificadas — apenas as mínimas obrigatórias

Agrupamento de histórias ESP (Especificação) no Modo Essencial:

GrupoTipos agrupados
NegócioHNI + HNE + HNU
SistemaHS + HRD
UX e ConformidadeHUX + HC + HAC + HIVC
IntegraçãoHI
AutenticaçãoHAI

Indicado para: protótipos, MVPs, sistemas de apoio e ferramentas internas de baixo impacto.

DimensãoEspecificação
Pontos de vistaESP (Especificação), IMP (obrigatórios)
Histórias ESP (Especificação)2 grupos: Negócio e Sistema
RepositóriosMonorepo com workspaces por ponto de vista
ValidaçõesIA primária
EvidênciasMínimas — aprovação e rastreabilidade básica

O Artefato Orquestrador é o componente central de automação do framework, responsável por tornar operacional a execução das regras, evidências e fluxos definidos neste documento.

O Artefato Orquestrador não é opcional. Sem ele, a execução do framework depende inteiramente de intervenção humana manual, o que inviabiliza o ganho de velocidade e a consistência de evidências prometidos.

  • monitorar os repositórios dos pontos de vista e detectar artefatos aprovados, alterados ou em pendência;
  • disparar automaticamente a validação cruzada quando um artefato for submetido para aprovação;
  • acionar a geração de prototipação preliminar quando histórias suficientes forem aprovadas na ESP (Especificação);
  • executar o Linter de Governança antes de cada gate de promoção;
  • gerenciar o fluxo de promoção entre fases e ambientes;
  • detectar divergências entre repositórios e gerar alertas de sincronização;
  • gerar automaticamente o dossiê de entrega, as evidências obrigatórias e o Context Map (CTX);
  • registrar o histórico de inferências das engines de IA para fins de auditoria;
  • controlar e reportar consumo de tokens por projeto e por engine.
  • integrar-se aos repositórios de todos os pontos de vista ativos;
  • possuir interface de configuração dos critérios de divergência e dos gates de aprovação;
  • expor trilha de auditoria própria de todas as ações automatizadas;
  • ser versionado e rastreado como qualquer outro artefato do framework.

Este apêndice é não prescritivo. As ferramentas listadas são referências de mercado compatíveis com os requisitos do framework. A adoção de qualquer ferramenta específica deverá ser decidida pela GTI (Governança de TI) conforme as políticas institucionais vigentes.

CategoriaFerramentas de referência
CI/CDGitHub Actions, GitLab CI, ArgoCD
Documentação automatizadaMkDocs, Docusaurus, Obsidian
Agentes de IALangChain, AutoGen, CrewAI
Banco vetorial para grounding (GDA (Governança de Dados))Chroma, Weaviate, pgvector
Prototipação assistida por IAFigma com plugins de IA, Galileo AI
Gestão de repositóriosGitHub, GitLab, Bitbucket
ObservabilidadePrometheus, Grafana, OpenTelemetry
Containers e ambientesDocker, Kubernetes, Colima
Gestão de segredosHashiCorp Vault, AWS Secrets Manager

← Anterior: Pontos de Vista · Início: Framework SinergIA