Documentação, ADRs e contratos: modelo mental e decisões

O problema e por que importa

Documentação útil reduz a distância entre intenção e evidência. README orienta entrada, ADR preserva uma decisão difícil de reverter, runbook guia operação e contrato descreve uma interface. Um único documento tentando servir a todos esses objetivos fica desatualizado e difícil de verificar.

Quando o ERP muda seu contrato, a pergunta é: onde o desenvolvedor encontra a interface vigente, por que a estratégia foi escolhida, quem responde pelo sistema e como operar uma falha? A resposta deve apontar artefatos pequenos, donos e sinais verificáveis.

Vocabulário antes das siglas

• README: porta de entrada que explica propósito, execução, verificação e caminhos para documentação mais profunda.
• runbook: procedimento operacional acionável para diagnosticar, mitigar e recuperar uma condição.
• ADR: architecture decision record; registro curto do contexto, decisão, alternativas e consequências arquiteturais.
• RFC: proposta estruturada submetida a discussão antes de uma mudança relevante.
• OpenAPI: contrato estruturado de uma API HTTP, consumível por pessoas e ferramentas.
• changelog: registro orientado ao consumidor das mudanças relevantes entre versões.
• ownership: responsabilidade explícita por manter, decidir e responder por um artefato ou serviço.
• diagrama: representação visual com escopo e legenda definidos para comunicar relações específicas.
• source of truth: fonte canônica da qual representações derivadas são geradas ou reconciliadas.
• drift: divergência entre documentação, contrato, configuração ou comportamento real.

O artefato correto depende da pergunta. “Como rodar?” pertence ao README; “por que escolhemos?” ao ADR; “o que fazer às 3h?” ao runbook; “qual mensagem aceitamos?” ao contrato.

Modelo mental

documentação é uma interface para pessoas; deve responder uma decisão ou tarefa e ser testada como código. A analogia ajuda a localizar responsabilidades; ela deixa de valer quando esconde concorrência, falhas parciais ou atores maliciosos. Software distribuído não tem uma única percepção de tempo nem sucesso: uma resposta pode se perder depois de um efeito ter ocorrido.

Fronteira e responsabilidade

A fonte canônica deve ficar próxima do elemento que descreve e possuir um fluxo de revisão compatível. Código de exemplo precisa ser executado; contrato deve ser validado; runbook deve ser ensaiado. Páginas derivadas são geradas, não copiadas manualmente.

Documentar toda conversa cria ruído. Preserve decisões duráveis, interfaces, riscos, operação e evidências. Contexto efêmero pode permanecer em tickets; uma conclusão que muda a arquitetura merece ADR; uma regra determinística deve virar teste ou CI.

Decisão orientada por risco

Pergunta de projeto	Decisão inicial	Evidência exigida
Que pergunta o artefato responde?	Escolher README, ADR, RFC, contrato ou runbook	Leitor encontra a resposta sem adivinhar
Onde manter?	Junto da fonte que muda	Link e owner aparecem no repositório
Como detectar drift?	Geração e teste automatizados	CI falha quando contrato diverge
Quando arquivar?	Após substituição e janela de auditoria	Índice diferencia atual e histórico

A alternativa mais complexa só é promovida quando essa evidência mostra que a solução atual não atende ao risco. A decisão registra também custo operacional, forma de reversão e responsável.

Caso real: manutenção conectada ao ERP

O eletricista conclui a OS 742. O sistema valida identidade, unidade, estado atual e evidências; persiste a mudança; registra auditoria; publica a integração; informa “sincronização pendente” se o ERP não responder. A decisão deste livro aparece ao preservar contexto suficiente para operar, mudar e ensinar o sistema. O sucesso não é apenas HTTP 200: banco, usuário, fila, ERP e telemetria precisam convergir para um estado conhecido.

Falha orientadora

diagrama bonito contradiz produção e runbook depende da memória de quem saiu da empresa. Trate a falha como cenário de projeto, não exceção improvável. O controle principal é docs-as-code, owners, links verificáveis, exemplos testados e data de revisão. Seu teste deve falhar antes do controle e passar depois dele.

Segurança, privacidade e custo

• Redija exemplos com valores fictícios; documentação não é local para credenciais reais.
• Classifique diagramas e runbooks que revelem topologia ou procedimentos sensíveis.
• Registre owner e revisão de políticas críticas; ausência de dono é risco operacional.
• Preserve histórico suficiente para auditoria sem manter dados pessoais além da finalidade.

O manual de Cybersecurity aprofunda threat modeling, identidade, proteção de dados, supply chain e resposta a incidentes; os controles acima são a aplicação específica nesta disciplina.

Erros frequentes e diagnóstico

1. Tecnologia antes do problema: registre hipótese e atributo de qualidade que justificam a escolha.
2. Caminho feliz apenas: injete timeout, duplicata, concorrência, permissão negada e dado inválido.
3. Métrica de vaidade: acompanhe idade, links quebrados, tempo de onboarding, incidentes sem runbook e contratos divergentes e ligue o sinal a uma decisão.
4. Automação sem condição de parada: limite tentativas e torne o estado pendente visível.
5. Documentação sem prova: execute exemplos e conecte diagramas a arquivos, owners e testes.

Critérios de aceite

• Fronteira, dono, entradas, saídas e dependências estão diagramados.
• Caminho feliz e falha parcial possuem testes reproduzíveis.
• O controle “docs-as-code, owners, links verificáveis, exemplos testados e data de revisão” tem evidência observável.
• Segurança, privacidade, acessibilidade, custo e operação foram avaliados.
• A métrica “idade, links quebrados, tempo de onboarding, incidentes sem runbook e contratos divergentes” possui unidade, janela e responsável.
• Runbook informa diagnóstico, mitigação, recuperação e escalonamento.

Prática e recuperação ativa

1. Desenhe a jornada da OS 742 e marque onde esta camada começa e termina.
2. Explique a diferença entre ocultar uma ação e negar sua autorização no servidor.
3. Injete a falha “diagrama bonito contradiz produção e runbook depende da memória de quem saiu da empresa” e capture evidência antes/depois do controle.
4. Transfira o raciocínio para um pedido de e-commerce: o que permanece e o que muda?

Entregável verificável: README executável, ADR de uma decisão real, contrato validado no CI e runbook ensaiado com evidência de revisão. A entrega só é aceita quando outra pessoa consegue repetir a verificação.

Fontes primárias e oficiais

Revisão editorial: 2 de agosto de 2026. Confirme versões antes de implementar configuração volátil.

• https://spec.openapis.org/oas/latest.html
• https://adr.github.io/
• https://diataxis.fr/

Da compreensão à execução

O modelo anterior explica o que precisa permanecer verdadeiro. Agora o caderno transforma essa compreensão em um experimento. Antes de executar, escreva sua previsão; depois compare o observado com o esperado e registre a primeira fronteira onde o estado divergiu.

Objetivo, hipótese e ambiente

Objetivo: demonstrar preservar contexto suficiente para operar, mudar e ensinar o sistema em uma fatia da jornada de manutenção. Hipótese: o controle “docs-as-code, owners, links verificáveis, exemplos testados e data de revisão” reduz a falha escolhida sem violar o contrato das camadas vizinhas.

Pré-requisitos: Git, terminal, TypeScript ou a tecnologia indicada no exemplo, ambiente local isolado e dados sintéticos. Duração orientativa: 90–180 minutos; depende de prática, não de leitura. Não use credenciais reais nem produção.

sequenceDiagram
  actor E as Eletricista
  participant W as Aplicativo
  participant A as API de manutenção
  participant D as Estado canônico
  participant R as ERP
  E->>W: conclui OS 742
  W->>A: intenção + identidade + idempotency-key
  A->>D: valida e persiste
  A-->>W: estado confirmado ou pendente
  A->>R: integração controlada
  R-->>A: confirmação, rejeição ou timeout

Passo 1 — registre o contrato antes do código

Escreva pré-condição, pós-condição, erros esperados, timeout e política de repetição. Separe “aceito para processamento” de “confirmado pelo ERP”. Defina o que a pessoa verá durante incerteza. O contrato deve caber em uma tabela e ser revisado por negócio, desenvolvimento, segurança e operação.

Situação	Resultado público	Estado interno	Próxima ação
Entrada válida	confirmado ou 202 pendente	registrado	processar/observar
Sem permissão	negação estável	nenhuma mutação	auditar
Duplicata	mesmo resultado lógico	um efeito	responder idempotente
Dependência lenta	timeout controlado	pendente conhecido	retry com limite
Dado incompatível	erro de contrato	quarentena	corrigir/reprocessar

Passo 2 — implemente a menor fatia vertical

O trecho é didático e precisa ser adaptado ao runtime indicado. Ele ilustra a decisão central, não constitui aplicação completa.

# ADR-004: Outbox para integração com ERP
Status: aceita
Decisão: persistir evento na transação da OS.
Consequência: consumidor idempotente obrigatório.

Mantenha a mudança pequena: interface, regra, persistência, teste e sinal operacional no mesmo ticket. Evite construir “toda a infraestrutura” antes de uma jornada observável.

Passo 3 — prove o caminho feliz e o negativo

1. Execute uma OS válida e capture resposta, estado persistido e correlation ID.
2. Repita a mesma intenção; o efeito lógico deve continuar único.
3. Remova a permissão; nenhum estado deve mudar.
4. Force timeout do ERP; a UI deve mostrar estado honesto e a fila não pode crescer sem limite.
5. Corrompa um campo do contrato; rejeite-o com erro útil, sem stack trace nem segredo.

O teste negativo é parte do produto. Sem ele, o controle pode existir apenas no diagrama.

Passo 4 — instrumente a decisão

Registre duração, resultado, dependência, versão do contrato e correlação. Não use nome, e-mail, token, payload completo nem user_id como dimensão ilimitada de métrica. Para este livro, acompanhe idade, links quebrados, tempo de onboarding, incidentes sem runbook e contratos divergentes. Defina SLI, janela, limiar e ação humana associada.

Exemplo de evento estruturado conceitual:

{
  "event": "work_order.transition",
  "order_id": "742",
  "result": "pending_erp",
  "contract_version": "v1",
  "correlation_id": "demo-01",
  "duration_ms": 184
}

Passo 5 — injete falha e recupere

Falha-alvo: diagrama bonito contradiz produção e runbook depende da memória de quem saiu da empresa.

• Detectar: qual sinal diferencia falha real de tráfego normal?
• Conter: como impedir propagação, repetição ilimitada ou perda de dados?
• Mitigar: qual recurso pode ser desativado ou degradado com segurança?
• Recuperar: como reprocessar sem duplicar efeito?
• Aprender: qual teste, alerta, ADR ou limite impedirá recorrência?

Use timeout curto no laboratório e retry limitado com atraso e jitter. Um retry não é recuperação quando a operação não é idempotente. Registre itens que exigem intervenção humana em fila consultável; não esconda exceções em log.

Segurança e abuso

Faça uma mini análise: ativo, ator, fronteira, ameaça, impacto, controle e teste. Teste acesso horizontal entre unidades, elevação de perfil, payload grande, repetição rápida, dado fora de ordem e indisponibilidade. O controle esperado é docs-as-code, owners, links verificáveis, exemplos testados e data de revisão. Valide no servidor e preserve evidência sem expor segredos.

Troubleshooting

Sintoma	Hipótese	Verificação	Correção segura
Estado diverge do ERP	efeito parcial	correlação + outbox/inbox	reconciliar idempotentemente
Latência cresce	fila ou dependência saturada	p95/p99, lag, pool	backpressure e capacidade
Só um tenant falha	escopo, dado ou quota	dimensão de tenant controlada	corrigir política/dado
Retry aumenta erro	operação não idempotente	contar efeitos por chave	deduplicar e limitar
Dashboard “verde”	SLI não representa jornada	teste sintético E2E	medir resultado do usuário

Critérios de aceite verificáveis

• Caminho feliz, entrada inválida, negação, duplicata e timeout foram executados.
• O segundo envio com a mesma chave não produz segundo efeito.
• Nenhum segredo ou dado pessoal aparece em saída, log ou fixture.
• A falha é detectada por sinal antes da reclamação do usuário.
• Existe estado explícito para pendência e procedimento de reconciliação.
• O resultado inclui teste, captura de telemetria, ADR e atualização do runbook.

Evidência, limpeza e solução comentada

Guarde: comandos, versões, saída dos testes, screenshot do fluxo, consulta de estado e gráfico do sinal. Remova ambiente e dados sintéticos; revogue qualquer credencial de laboratório. A solução adequada não é uma ferramenta específica: é a menor composição que satisfaz o contrato e demonstra recuperação.

Exercícios de transferência

1. Troque ERP por gateway de pagamento. Quais garantias ficam mais rígidas?
2. Troque OS por leitura de sensor offline. Onde ordenar e deduplicar?
3. Reduza o RTO pela metade. Qual custo e complexidade aparecem?
4. Explique em voz alta por que documentação é uma interface para pessoas; deve responder uma decisão ou tarefa e ser testada como código é útil e onde a analogia quebra.

Fontes

Consulte as fontes oficiais do capítulo conceitual e registre versão/data no relatório do laboratório. Para observabilidade, use OpenTelemetry; para segurança, use o manual canônico.