Um modelo de bug report
para você copiar.
Um bom modelo de bug report leva o desenvolvedor da leitura à reprodução de uma vez só: o que aconteceu, o que era esperado, os passos e onde. Copie o modelo abaixo para um documento, um formulário ou um gerenciador de tarefas, ou monte os mesmos campos em um quadro que também recebe os arquivos.
O modelo de bug report
Sete perguntas. Exija o título e os passos; deixe o resto opcional.
Título
O que está quebrado, e onde. Uma linha.
Exemplo: A exportação em CSV baixa um arquivo vazio
O que aconteceu?
O que você viu, em uma ou duas frases.
O que você esperava?
O que deveria ter acontecido.
Passos para reproduzir
1.
2.
3.
Com que frequência?
Sempre, às vezes ou uma única vez.
Onde?
Navegador ou versão do aplicativo, sistema operacional, conta ou workspace.
Tem algo para mostrar?
Uma captura de tela, uma gravação de tela, um log, um arquivo HAR.
Um exemplo de bug report preenchido
O mesmo modelo, preenchido. O produto e os números são inventados.
Título
A exportação em CSV baixa um arquivo vazio
O que aconteceu?
Cliquei em Exportar na página Relatórios. Um arquivo foi baixado,
mas só tem a linha de cabeçalho.
O que você esperava?
As 214 linhas da tabela que aparece na tela.
Passos para reproduzir
1. Abra Relatórios e escolha os últimos 30 dias.
2. Filtre pelo plano “Scale”.
3. Clique em Exportar e depois em CSV.
Com que frequência?
Sempre que o filtro está ativo. Sem ele, a exportação funciona.
Onde?
Chrome 141 no macOS 15. Workspace: northwind.
Tem algo para mostrar?
export.csv (o arquivo vazio), reports.har
Para que serve cada campo
- Título. O que está quebrado e onde, para o relato ser achado de novo e as duplicatas se encontrarem.
- O que aconteceu? O sintoma nas palavras de quem relata, antes de qualquer interpretação.
- O que você esperava? Metade dos relatos é um mal-entendido, e esta linha mostra qual metade.
- Passos para reproduzir. A parte que o desenvolvedor não tem como adivinhar. Numerados, uma ação por linha.
- Com que frequência? “Sempre” aponta para a lógica; “às vezes” aponta para timing ou para os dados.
- Onde? Navegador, versão e conta reduzem a busca mais do que qualquer descrição.
- Tem algo para mostrar? Uma gravação ou um log substitui três parágrafos.
Como transformar o modelo em um formulário de bug report
Um formulário de bug report deve pedir menos do que o modelo. Cada campo obrigatório faz alguns relatos se perderem, e um relato que não chega custa mais do que um detalhe que falta.
- Exija o título e os passos para reproduzir, e nada mais.
- Coloque um exemplo no texto de apoio de cada campo, para as pessoas verem o nível de detalhe que você espera.
- Mostre os relatos parecidos antes do envio, para a pessoa poder votar em vez de criar uma duplicata.
- Deixe anexar arquivos só arrastando para o formulário.
- Diga o que acontece depois: onde o relato aparece e como a resposta vai chegar.
O que anexar a um bug report
Evidência encurta a conversa. Estes são os arquivos que vale a pena pedir, e o que cada um esclarece.
- Uma captura de tela, para tudo o que é visual.
- Uma gravação de tela em MP4, quando os passos são difíceis de explicar em palavras.
- Um arquivo HAR, quando uma página não carrega, não salva ou não exporta.
- Um log do console ou do servidor, em TXT ou LOG.
- O próprio e-mail, em EML, para problemas de entrega e de formatação.
- O arquivo CSV, XLSX ou JSON que não foi importado, ou o que saiu errado.
Como receber bug reports em um quadro do Kjerr
Um quadro do Kjerr pode fazer as perguntas do modelo e guardar a evidência. A ferramenta de gestão de feedback por trás dele mostra à equipe o que há de novo.
- O formulário é editável: acrescente Passos para reproduzir, Esperado e Onde como campos seus, até 10 campos no total, cada um obrigatório ou opcional e com seu próprio texto de apoio.
- Até 5 arquivos de 10 MB em um relato ou comentário: imagens, PDF, EML, TXT, LOG, CSV, JSON, HAR, ZIP, DOCX, XLSX, PPTX e MP4.
- Os relatos parecidos aparecem enquanto o título é digitado, cada um com seu botão de voto.
- Para um quadro de QA, deixe-o restrito a membros e limite o login ao domínio de e-mail da sua empresa, a mesma configuração de uma caixa de sugestões digital.
- Quando o status muda para Shipped, quem relatou e todo mundo que votou recebem um e-mail.
- Não é um gerenciador de tarefas: não há responsáveis, níveis de severidade nem sprints.
Perguntas, com respostas diretas.
O que é um modelo de bug report?
Um modelo de bug report é um conjunto fixo de perguntas que tira os mesmos fatos de todo relato: o que aconteceu, o que era esperado, os passos para reproduzir e onde ocorreu. Com ele, o desenvolvedor vai da leitura à reprodução sem uma rodada de perguntas.
O que um relatório de bug deve conter?
Um título de uma linha, o que aconteceu, o que era esperado, os passos numerados para reproduzir, a frequência, o ambiente e evidências, como uma captura de tela ou um log. Se só der para exigir duas coisas, exija o título e os passos.
Qual a diferença entre um bug report e um feature request?
O bug report diz que o produto não faz o que promete. O feature request pede algo que ele nunca prometeu. Cada um pede perguntas diferentes; para o segundo, use o modelo de feature request.
Como reportar um bug com bons passos para reproduzir?
Comece de um estado a que qualquer pessoa consegue chegar, escreva uma ação por linha e inclua os valores exatos que você digitou ou escolheu. Pare no passo em que o problema aparece. Se um passo às vezes é necessário e às vezes não, diga isso.
O que é um arquivo HAR, e devo anexar um?
Um arquivo HAR é um registro das requisições que uma página fez, salvo pelas ferramentas de desenvolvedor do navegador. Anexe um quando uma página não carregar, não salvar ou não exportar. Confira antes: ele pode conter cookies de sessão e dados pessoais.
O Kjerr substitui um bug tracker?
Não. O Kjerr recebe os relatos, elimina as duplicatas e avisa quem relatou quando o status muda. Ele não tem responsáveis, níveis de severidade nem sprints, e não sincroniza com Jira ou Linear. As equipes o usam como porta de entrada e mantêm o gerenciador de tarefas atrás dele.
Páginas relacionadas
Dê uma resposta aos seus usuários.
O Kjerr é gratuito durante o acesso antecipado: todos os recursos, sem cartão de crédito. Quando os planos pagos chegarem, o preço será por workspace, nunca por assento de administrador.