Este é um guia para escrever relatórios de bugs eficazes no Discourse, maximizando as chances de que os bugs sejam corrigidos.
Nível de usuário necessário: Qualquer um pode relatar um bug
Escrever um bom relatório de bug é essencial para ajudar a equipe do Discourse a corrigir problemas com eficiência. Este guia irá guiá-lo pelas etapas e melhores práticas para garantir que seu relatório de bug seja claro, conciso e acionável.
Resumo
Nesta documentação, abordaremos:
- A importância de fornecer passos reprodutíveis e detalhes específicos
- Como descrever o problema e o comportamento esperado
- Melhores práticas para relatar em diferentes plataformas
- Manter um tom adequado em seu relatório
- Armadilhas comuns e soluções
Etapas para escrever um relatório de bug eficaz
Prioridade/Severidade
Determine a urgência da correção do bug. Embora todos queiram que seus problemas sejam resolvidos rapidamente, reserve a maior prioridade para problemas críticos que impactam significativamente a funcionalidade.
Plataforma
Sempre especifique o ambiente em que o bug foi observado. Isso inclui:
- Tipo de dispositivo (desktop, mobile, touchscreen, tablet)
- Sistema operacional e sua versão
- Navegador web e sua versão
Sempre que possível, reproduza o bug em várias plataformas para confirmar sua presença.
Descrição
Seja conciso. Descreva o problema de forma simples e sem detalhes desnecessários. Separe problemas diferentes se puderem ser relatados individualmente. Um formato de descrição claro inclui:
Resultado Real: O que está acontecendo?
Resultado Esperado: O que deveria ter acontecido?
Evite suposições sobre o que o leitor já sabe. Seja explícito sobre o que deveria ter sido visto ou ocorrido.
Passos reprodutíveis
Garanta que o bug possa ser reproduzido consistentemente. Escreva instruções passo a passo começando pela tela inicial do Discourse. Se o bug aparecer aleatoriamente, especifique com que frequência ele ocorre (por exemplo, 1 em cada 10 tentativas). Para bugs relacionados à UI/UX, adicione capturas de tela ou vídeos para maior clareza.
Tom
Mantenha um tom respeitoso e educado. Evite usar o relatório de bug para expressar frustração. Qualquer linguagem ou comportamento tóxico pode resultar na demora ou ignorância do seu relatório.
Modelo
Use este modelo para iniciar rapidamente um novo tópico de relatório de bug:
Prioridade/Severidade:
Plataforma:
Descrição:
Passos reprodutíveis:
Melhores Práticas
- Reproduza no Modo Seguro: Antes de relatar, tente reproduzir o problema no Modo Seguro do Discourse se suspeitar que personalizações possam estar causando o problema.
- Questione Suposições: Relatórios de bugs frequentemente decorrem de suposições falsas. Mesmo em seu relatório, questione e esclareça quaisquer suposições que você possa ter.
- Seja Detalhista: Para bugs elusivos ou raros, forneça o máximo de detalhes possível. Inclua qualquer coisa que você ache que possa estar relacionada, como mensagens de erro ou arquivos de log.
Problemas Comuns e Soluções
Problema: Incapaz de reproduzir o bug consistentemente.
Solução: Documente o ambiente e as condições sob as quais o bug aparece. Anote quaisquer padrões ou semelhanças.
Problema: Falta de resposta a um relatório de bug.
Solução: Certifique-se de que seu relatório seja detalhado, mas conciso, e escrito em um tom cortês.
Perguntas Frequentes
P: E se eu não tiver tempo para um relatório detalhado?
R: Ainda é útil abrir um relatório com as informações que você tem. Indique que você o atualizará com mais detalhes posteriormente.
P: Onde devo postar meu relatório de bug?
R: Use a categoria apropriada - os relatórios de bug devem ir para a categoria Contribute > Bug.