Governança, segurança e confiabilidade · 14 min de leitura

Como escrever um runbook que outra pessoa consiga usar durante um incidente

Transforme um problema operacional recorrente em um roteiro com evidências, decisões, limites e verificação de recuperação.

Publicado em · Atualizado em

Um runbook útil não é uma lista de comandos para executar às cegas. Ele ajuda a reconhecer o cenário, escolher uma ação dentro de limites conhecidos e verificar se o impacto realmente terminou.

Escolha um cenário reconhecível e delimitado

Um procedimento chamado “sistema com problema” não orienta uma resposta concreta. Escolha um cenário que tenha sinais observáveis, impacto conhecido e ações possíveis. Pode ser uma fila que deixou de avançar, uma integração que perdeu confirmação ou um processo que não iniciou. O runbook deve permitir identificar quando se aplica e quando a pessoa precisa seguir outra investigação. Essa fronteira evita que uma solução conhecida seja usada em qualquer falha parecida.

No exemplo fictício da empresa Operação Clara, relatórios solicitados permanecem aguardando enquanto a aplicação principal continua disponível. O cenário escolhido é ausência de avanço na fila de geração, com novas solicitações acumulando. O roteiro não cobre qualquer falha de relatório, como dados inválidos em um único arquivo. Essa distinção permite começar por sinais do trabalhador e da fila sem desperdiçar tempo em um problema que pertence a outra camada.

Registre o objetivo de resposta: reduzir o impacto, preservar trabalhos confirmados e restabelecer avanço verificável. O material do Google SRE sobre resposta a incidentes destaca a prioridade de conter impacto antes de aprofundar a causa quando necessário. Aplicado ao roteiro, isso significa separar a ação operacional imediata da investigação posterior, sem deixar que a pressa elimine evidências essenciais ou provoque efeitos não compreendidos.

Mostre como confirmar impacto e estado

Liste sinais que a pessoa deve verificar e o que cada um significa. Quantidade de pendências, idade do item mais antigo e última conclusão podem ajudar a reconhecer a ausência de avanço. Inclua a janela temporal relevante e referências de painéis ou consultas autorizadas. Não dependa de uma captura de tela antiga sem indicar onde obter a informação atual. O roteiro precisa funcionar quando a pessoa não conhece de memória a ferramenta.

Separe impacto percebido de causa presumida. Uma fila parada pode decorrer de trabalhador desligado, dependência indisponível ou item problemático. O primeiro passo confirma o sintoma e sua abrangência. Na Operação Clara fictícia, o responsável verifica se todas as empresas estão afetadas ou apenas uma classe de relatório. Essa informação orienta a contenção e evita reiniciar componentes amplos para resolver um problema localizado.

Defina evidências mínimas a preservar antes de agir, sem copiar dados sensíveis desnecessários. Registre horários, identificadores de execução e erros relevantes. Uma intervenção pode apagar estado transitório útil à investigação. Ao mesmo tempo, não exija uma coleta extensa que atrase uma contenção necessária sem benefício. O equilíbrio deve ser definido pelo cenário e pelo custo real de perder aquela evidência.

Explicite acesso, pré-condições e limites

Indique quais permissões e ambientes são necessários para executar o procedimento. A pessoa deve conseguir confirmar que está no contexto correto antes de qualquer alteração. Não inclua segredos diretamente no documento; referencie o mecanismo autorizado de acesso. Um runbook compartilhado amplamente não deve se tornar um repositório de credenciais. A clareza de acesso reduz improvisação durante pressão operacional.

Para cada ação, descreva a condição que a torna apropriada. Reiniciar um trabalhador pode ser aceitável se as tarefas são recuperáveis e não há uma operação não interrompível em andamento. Se essas garantias não existem, o roteiro precisa de outro caminho. Não copie uma ação que funcionou uma vez sem explicar o estado em que foi segura. O procedimento deve preservar o contexto que normalmente ficaria apenas na memória do especialista.

Declare limites de escopo, quantidade e duração. Se a ação deve atingir uma instância ou uma classe de fila, isso precisa estar explícito. Inclua o que fazer quando a evidência não corresponde ao esperado. Um roteiro que só oferece o caminho feliz incentiva a continuar por tentativa e erro. A pessoa precisa saber quando parar, pedir ajuda ou seguir uma ramificação de diagnóstico.

Organize ações como decisões verificáveis

Escreva cada etapa com condição, ação e resultado esperado. “Confira se há trabalhador ativo; se não houver, siga o procedimento de início autorizado; depois verifique que uma tarefa de teste avançou” é mais útil que “reinicie o serviço”. O nível de detalhe técnico depende de quem executa, mas a lógica deve permanecer compreensível. Comandos, quando existirem, precisam estar ligados ao motivo e ao escopo.

Evite uma sequência longa de alterações sem verificações intermediárias. Se a primeira ação resolve o impacto, não há motivo para executar as demais automaticamente. Se falha, a próxima decisão deve usar essa evidência. No exemplo fictício, uma dependência externa indisponível muda o caminho: reiniciar repetidamente o trabalhador não a recupera e pode aumentar a carga. O roteiro deve reconhecer essa situação e orientar a contenção apropriada.

Prefira ações reversíveis quando atendem ao objetivo, mas não transforme isso em uma regra abstrata que substitui análise. Algumas intervenções necessárias têm efeitos persistentes e precisam de autorização e preparação específicas. O runbook deve indicar essas fronteiras e a responsabilidade aplicável. Um documento não concede poderes que a pessoa não possui; ele organiza como agir dentro do processo da empresa.

Defina comunicação e coordenação durante a resposta

Uma pessoa precisa manter a visão do incidente quando várias atuam. Registre quem coordena, quem executa e onde as decisões são anotadas conforme a estrutura da equipe. Não é necessário reproduzir uma organização complexa em uma empresa pequena, mas é necessário evitar ações simultâneas contraditórias. Dois profissionais reiniciando e alterando a mesma fila sem coordenação podem dificultar a recuperação e apagar evidências.

Prepare mensagens de estado ligadas ao que foi confirmado: relatórios estão atrasados, a equipe está recuperando o processamento e solicitações permanecem registradas quando essa garantia foi verificada. Não anuncie ausência de perda sem evidência. A comunicação deve distinguir impacto, ação e previsão, reconhecendo incerteza. O roteiro pode orientar o conteúdo, mas o envio segue as responsabilidades e autorizações da organização.

O ChatBô pode ajudar a estruturar o procedimento e os sinais operacionais para que desenvolvimento e atendimento compartilhem uma leitura coerente. O objetivo é reduzir dependência de uma pessoa que conhece todos os detalhes, sem substituir julgamento por uma lista rígida. Uma boa coordenação deixa claro o que já foi tentado e qual resultado orienta a próxima ação.

Verifique recuperação pela tarefa do usuário

Um processo ativo não prova que o serviço voltou. Defina verificações de avanço e conclusão no cenário. Na Operação Clara fictícia, o trabalhador deve concluir uma tarefa controlada e reduzir o acumulado de forma sustentada. Verifique também se novos pedidos continuam entrando corretamente e se não há repetição indevida. O estado de infraestrutura ajuda, mas a recuperação precisa alcançar a função que estava indisponível.

Observe por uma janela adequada ao comportamento da tarefa, definida no roteiro. Uma conclusão isolada pode ser seguida de nova parada. Se o serviço oscila, registre a condição e mantenha o incidente em tratamento conforme o processo. Não marque resolvido apenas porque um comando terminou com sucesso. A verificação deve responder se o impacto cessou e se ainda existem pendências que exigem acompanhamento.

Separe recuperação imediata de tratamento do acumulado. A capacidade pode estar normal, mas relatórios antigos ainda precisam ser gerados ou classificados como sem utilidade. Defina quem acompanha essa continuidade e quais casos exigem revisão. O incidente técnico pode ter uma etapa de estabilização e outra de recuperação operacional, com estados claros para evitar que tarefas afetadas sejam esquecidas depois que o painel volta ao verde.

Ensaie o roteiro com alguém que não o escreveu

Use um ambiente e um cenário controlados para executar o procedimento. A pessoa que escreveu deve observar dúvidas sem preencher todas as lacunas verbalmente. Se uma informação é necessária, acrescente ao documento. O ensaio verifica linguagem, acesso, ordem e resultados esperados. Não precisa provocar impacto real em produção para descobrir que uma referência está quebrada ou que uma pré-condição foi omitida.

Inclua uma variação em que o cenário não corresponde e a pessoa deve interromper ou seguir outro caminho. Isso testa a fronteira do runbook, não apenas sua sequência principal. Verifique também o que acontece quando a primeira ação não resolve. Um roteiro útil ajuda a tomar decisões sob incerteza e evita transformar repetição de comandos em estratégia de diagnóstico.

Registre tempo e pontos de dificuldade, mas não use velocidade como único critério. Uma execução mais lenta que preserva escopo e verifica resultado pode ser melhor que uma intervenção rápida sem controle. O objetivo é uma resposta confiável e reproduzível. Corrija as lacunas encontradas e repita as etapas afetadas, mantendo o ensaio proporcional ao risco e às mudanças feitas.

Mantenha o runbook ligado à evolução do sistema

Identifique responsável, versão e data de última verificação. Atualize quando arquitetura, ferramentas ou permissões mudarem. Um procedimento desatualizado pode ser pior que ausência de documento se oferece falsa confiança. Relacione mudanças relevantes ao roteiro para que a revisão faça parte da manutenção, e não dependa de alguém lembrar depois do próximo incidente.

Depois de uma ocorrência real, registre o que funcionou, o que faltou e quais ações recorrentes podem ser eliminadas ou automatizadas. Não automatize uma sequência instável apenas para reduzir cliques. Primeiro esclareça condições e verificação. Partes determinísticas podem virar ferramentas, enquanto decisões que exigem contexto permanecem explícitas. O aprendizado deve melhorar o sistema e o procedimento, não apenas acrescentar páginas de exceções.

Finalize com um roteiro que começa por sinais, limita ações e termina em evidência de recuperação. A pessoa que o usa deve conseguir explicar por que executou cada etapa e quando decidiu parar. Essa estrutura reduz dependência de memória individual e ajuda a responder com consistência. O runbook cumpre sua função quando transforma conhecimento operacional em decisões utilizáveis, preservando o julgamento necessário ao cenário real.

Como enquadrar incidentes de software como uma decisão operacional

Antes de investir em incidentes de software, descreva o problema sem usar o nome de uma ferramenta. Registre quem inicia o processo, qual informação chega, onde ela é consultada, quem decide o próximo passo e qual resultado precisa ficar gravado. Esse recorte impede que uma iniciativa ampla demais misture aquisição, atendimento, venda e suporte em uma única promessa. O primeiro desenho deve mostrar um caso completo, inclusive exceções, espera e transferência de responsabilidade. A meta inicial é comece pelos sinais que permitem reconhecer o incidente., com uma fronteira que a equipe consiga explicar e testar.

Use conversas, pedidos, tarefas e perdas reais para confirmar o diagnóstico de incidentes de software. Uma amostra útil combina casos concluídos, abandonados, reabertos e encaminhados. Em cada caso, marque a necessidade apresentada, a primeira resposta útil, as fontes consultadas, as correções feitas e o desfecho conhecido. O objetivo não é encontrar exemplos que justifiquem uma solução já escolhida; é descobrir em qual etapa tempo, informação ou responsabilidade deixam de avançar. Se causas diferentes aparecem com frequência, elas devem virar fluxos ou regras distintas.

Transforme o diagnóstico em critérios de aceite. Para incidentes de software, um critério deve ser observável por outra pessoa: informação recuperada da fonte correta, registro criado com campos completos, encaminhamento feito para a fila adequada ou próxima ação combinada com o cliente. Evite critérios vagos como experiência melhor ou uso de IA. Eles podem orientar a intenção, mas não permitem verificar o funcionamento. O aceite também precisa declarar o que não será automatizado e como a operação continua quando uma dependência estiver indisponível.

Plano de implementação de incidentes de software por etapas

Na primeira etapa, documente o fluxo atual e escolha uma jornada limitada. Reúna responsáveis de operação, comercial, tecnologia e privacidade quando essas áreas participarem do caso. Defina entradas permitidas, campos obrigatórios, fonte autoritativa, estados possíveis e condição de encerramento. Para incidentes de software, preserve exemplos de linguagem real, mas anonimize dados pessoais usados em desenho e teste. Essa fase termina com um mapa simples, uma linha de base e uma lista explícita de dúvidas que ainda impedem a implantação.

Na segunda etapa do projeto de incidentes de software, construa uma prova completa em ambiente controlado. O teste deve começar na entrada realista e terminar no registro que a equipe utilizará depois, não apenas em uma resposta bonita na tela. Inclua casos comuns, mensagens incompletas, mudança de assunto, indisponibilidade de integração e solicitação de atendimento humano. Revise cada falha pela causa: conhecimento ausente, regra ambígua, dado desatualizado, permissão excessiva ou interface pouco clara. A decisão de avançar depende da correção desses padrões, e não de uma demonstração isolada.

Na terceira etapa, libere incidentes de software para um grupo, canal ou período definido. Mantenha contingência e responsáveis de plantão para incidentes relevantes. Compare o resultado com a linha de base e registre intervenções manuais, porque uma automação aparentemente eficiente pode estar transferindo trabalho invisível para outra equipe. Amplie somente quando qualidade, capacidade, custo e experiência permanecerem aceitáveis. O plano de expansão deve informar qual volume muda, quais novas exceções entram e quem aprova a próxima etapa.

Dados, fontes e integrações necessários para incidentes de software

Separe conhecimento editorial de dados transacionais. Políticas, orientações e descrições podem vir de uma base revisada; preço, estoque, pedido, agenda, pagamento e situação do cliente precisam ser consultados na fonte atual que responde por esses registros. Em incidentes de software, a camada de linguagem pode interpretar o pedido e explicar o resultado, mas não deve substituir o sistema autoritativo. Quando a fonte não responder, a experiência precisa declarar a indisponibilidade, preservar o contexto e oferecer uma continuação segura.

Para incidentes de software, defina contratos de integração antes de liberar ações. Cada operação precisa informar autenticação, campos de entrada, validações, tempo limite, tentativas, resposta esperada e tratamento de duplicidade. Mudanças que afetam cliente, pedido, cadastro ou compromisso comercial exigem confirmação proporcional ao impacto. Logs devem permitir reconstruir qual dado foi consultado, qual regra foi aplicada e qual resultado foi apresentado. Essa rastreabilidade protege tanto a equipe quanto o cliente quando uma informação precisa ser corrigida.

A governança das fontes faz parte de incidentes de software. Para cada documento ou dado, registre proprietário, frequência de atualização e caminho de correção. Conteúdo sem responsável envelhece; integração sem monitoramento falha silenciosamente. As referências editoriais deste artigo — Google SRE — Incident response — ajudam a estabelecer princípios, mas a implantação depende das regras, contratos e sistemas reais da empresa. A revisão deve distinguir recomendação de mercado, requisito normativo e decisão interna para evitar que uma fonte seja usada além do que realmente sustenta.

Perguntas frequentes

O runbook deve conter todos os incidentes possíveis?

Não. Comece por um cenário delimitado e recorrente, com sinais e ações conhecidos. Conecte outros roteiros quando houver relação clara.

Basta copiar comandos que resolveram uma vez?

Não. Registre pré-condições, escopo, efeitos e verificação, porque o mesmo comando pode ser inadequado em outro estado do sistema.

Quando automatizar o procedimento?

Depois de entender condições, limites e verificação. Partes estáveis podem ser automatizadas, mantendo intervenção humana onde a decisão ainda depende de contexto.

Prepare sua operação para responder com clareza

O ChatBô pode organizar diagnósticos e procedimentos de recuperação ligados à arquitetura e às tarefas do seu sistema.

Estruturar meus procedimentos operacionais

Fontes e referências