Ao longo dos meus anos trabalhando com qualidade de software, percebi que encontrar um bug nem sempre é a parte mais desafiadora. Muitas vezes, a dificuldade está em comunicar o problema de forma que outra pessoa consiga entendê-lo e reproduzi-lo.
Um registro bem elaborado economiza tempo, evita retrabalho e facilita a comunicação entre QA e desenvolvimento. Por isso, compartilho neste guia a estrutura que utilizo para documentar defeitos no dia a dia.
Por que o registro de bug é tão importante?
O registro de bug é a ponte entre quem encontrou o problema e quem vai corrigi-lo. Muitas vezes, a pessoa que vai analisar o defeito não estava presente no momento em que ele aconteceu. Por isso, o relato precisa ser:
- Preciso: descrever exatamente o que aconteceu, sem suposições.
- Objetivo: ir direto ao ponto, sem textos longos ou informações irrelevantes.
- Detalhado: trazer todas as informações necessárias para reproduzir o problema.
- Orientado à reprodução: fornecer informações para que outra pessoa tente reproduzir o comportamento, mesmo quando ele for intermitente.
Um bug mal relatado pode ser fechado como “não reproduzível”, ficar parado na fila ou ser corrigido de forma errada.
O que um bom registro de bug deve conter
1. Título
Curto e descritivo. Deve indicar onde ocorre o problema e qual é o comportamento identificado.
❌ “Erro no sistema”
✅ “Tela de Login: botão Entrar não responde ao informar senha com caractere especial”
2. Ambiente
Onde o bug foi encontrado: Desenvolvimento, Homologação, Produção etc. O mesmo defeito pode existir em um ambiente e não em outro.
3. Versão
Versão do sistema, build ou release testada. Isso ajuda o time a identificar a versão afetada e, em conjunto com outros registros, investigar quando o problema foi introduzido.
4. Navegador / Dispositivo
Navegador e versão (ex.: Chrome 130), sistema operacional, dispositivo (desktop, mobile) e resolução, quando relevante.
5. Funcionalidade
O módulo ou tela afetada (ex.: Cadastro de Clientes, Carrinho de Compras).
6. Descrição
Um resumo do problema em poucas linhas: o que está acontecendo e em qual contexto.
7. Precondições
Informe as condições necessárias antes de iniciar a reprodução, como perfil de acesso, configurações, permissões ou registros previamente cadastrados.
Possuir uma conta de teste ativa, com a senha fictícia informada no exemplo.
8. Passos para reprodução
A parte mais importante do registro. Liste os passos de forma numerada, na ordem exata, incluindo os dados utilizados.
10 - Acessar a tela de Login;
20 - Informar o usuário “teste.qa”;
30 - Informar a senha “Abc@123”;
40 - Clicar no botão “Entrar”;
50 - Verificar que o sistema não exibe nenhuma resposta.
Dica: sempre que possível, tente reproduzir o bug mais de uma vez para confirmar os passos. Se o defeito for intermitente, registre mesmo assim, informando as condições e a frequência observada.
Utilizo a numeração dos passos em intervalos de dez para facilitar a manutenção do registro. Assim, é possível inserir uma nova etapa entre os passos 20 e 30, por exemplo, sem renumerar toda a sequência.
9. Resultado obtido
O que o sistema fez de fato.
O botão “Entrar” não responde e nenhuma mensagem é exibida.
10. Resultado esperado
O que o sistema deveria fazer, com base no requisito, critério de aceite ou regra de negócio.
Ao clicar no botão “Entrar” com o usuário “teste.qa” e a senha “Abc@123”, o sistema deve autenticar o usuário e direcioná-lo para a tela inicial.
11. Log
Mensagens de erro, log do console do navegador, resposta da API (status code, payload) ou log do servidor. O log fornece informações que auxiliam na investigação da causa raiz e podem agilizar a análise.
Dica: o console do navegador (F12 → aba Console) é um grande aliado para identificar possíveis erros. Mensagens de erro e avisos ajudam na investigação. Na aba Network (Rede), é possível analisar as requisições e respostas da aplicação.
12. Evidência
Print de tela ou vídeo mostrando o problema. Uma imagem bem marcada (com destaque no ponto do erro) ou um vídeo curto da reprodução vale mais do que muitos parágrafos.
Quando houver erros relacionados ao defeito no console, inclua os registros relevantes junto com a evidência da tela. Remova informações sensíveis antes de compartilhar.
13. Frequência de ocorrência
Informe se o problema ocorre sempre, de forma intermitente ou se foi observado apenas uma vez. Quando possível, registre a proporção observada, como 3 ocorrências em 5 tentativas.
14. Referência
Vincule o requisito, caso de uso, história de usuário ou caso de teste relacionado, quando disponível. Isso facilita a rastreabilidade e a validação da correção.
15. Severidade e prioridade
Severidade representa o impacto do defeito no sistema ou no usuário. Prioridade indica a urgência da correção, considerando o contexto do negócio e do projeto.
Um erro de digitação na página inicial pode ter baixa severidade, mas alta prioridade se a página estiver prestes a ser divulgada em uma campanha.
Utilize a classificação definida pela equipe. Esses campos podem ser preenchidos ou revisados durante a triagem.
Modelo pronto para usar
Boas práticas
- Um bug por registro. Não misture problemas diferentes no mesmo relato.
- Verifique duplicidade. Antes de abrir, confira se o bug já não foi registrado.
- Seja neutro. Descreva o comportamento, não a pessoa. O foco é o produto.
- Informe os dados de teste. Utilize contas fictícias, massa de dados de teste e valores necessários à reprodução.
- Classifique severidade e prioridade, quando o processo do time pedir.
- Revise antes de enviar. Leia como se fosse a pessoa que vai corrigir: dá para reproduzir só com o que está escrito?
- Proteja informações sensíveis. Não exponha senhas reais, tokens, dados pessoais ou informações confidenciais em registros, logs, imagens e vídeos. Utilize dados fictícios e oculte informações sensíveis antes de anexar evidências.
Conclusão
Registrar um bug não é simplesmente informar que algo está errado. É documentar um comportamento, reunir evidências e fornecer informações que contribuam para a resolução do problema.
A qualidade do registro também faz parte da qualidade do software. Afinal, de pouco adianta encontrar um defeito se não conseguimos comunicar o que encontramos.