MDPress

Desenvolvimento

Modelo de relatório de bug em Markdown

Um bug é corrigido mais rápido quando outra pessoa consegue reproduzi-lo na primeira tentativa. Este modelo organiza os fatos numa ordem fixa: um resumo em uma frase, o ambiente, passos numerados, o que você esperava, o que aconteceu e as evidências. Preencha e exporte um PDF.

Abrir este modelo no editor
Categoria
Desenvolvimento
Estilo padrão
Técnico

Quando usar

Use quando um problema precisa sair do seu sistema de acompanhamento: para um fornecedor, um cliente, um suporte ou um gestor que quer um registro arquivado. Quem lê costuma ser um desenvolvedor ou testador que não estava presente quando o problema ocorreu, então cada seção responde a uma pergunta que ele teria que fazer a você.

O que tem dentro

  • Um cabeçalho com campos para preencher o projeto, seu nome e a data, além de uma linha de severidade.
  • Uma tabela de ambiente para versão do app, navegador e sistema operacional, e tipo de dispositivo.
  • Passos numerados para reproduzir, comportamento esperado e real, evidências e uma seção de solução alternativa.

Dicas para um documento melhor

  • Copie o texto exato do erro em vez de descrevê-lo. Cole trechos de log num bloco de código para manter o espaçamento, e remova senhas e dados pessoais antes.
  • Reduza os passos ao mínimo necessário para ainda provocar o problema. O modelo abre no estilo Técnico, que mantém tabelas e código fáceis de ler.

Pré-visualização do modelo

Relatório de bug: Projeto ou tema

Relatado por: Seu nome · Data: Data
Gravidade: Baixa / Média / Alta

Resumo

Descreva o problema em uma frase, incluindo a ação que o desencadeia.

Ambiente

DetalheValor
Versão do appAdicionar versão
Navegador / SOAdicionar detalhes
DispositivoDesktop / Celular

Passos para reproduzir

  1. Abra a página relevante.
  2. Informe o mínimo de dados necessário.
  3. Execute a ação.

Comportamento esperado

Descreva o que deveria acontecer.

Comportamento atual

Descreva o que acontece, incluindo o texto exato do erro.

Evidências

Adicione uma captura de tela ou um trecho de log higienizado. Remova credenciais e dados pessoais.

Solução alternativa

Registre uma solução temporária, se houver.

Os campos de preenchimento, como seu nome e a data, são substituídos quando você abre o modelo no editor.