Este é um guia para escrever relatórios de bugs eficazes no Discourse para maximizar as chances de que os bugs sejam corrigidos.
Nível de usuário exigido: Qualquer um pode relatar um bug
Escrever um bom relatório de bug é essencial para ajudar a equipe do Discourse a corrigir problemas de forma eficiente. 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.
Sumário
Nesta documentação, abordaremos:
- A importância de fornecer etapas 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 apropriado em seu relatório
- Armadilhas comuns e soluções
Passos 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 prioridade mais alta para problemas críticos que afetam significativamente a funcionalidade.
Plataforma
Sempre especifique o ambiente em que o bug foi observado. Isso inclui:
- Tipo de dispositivo (desktop, celular, tela sensível ao toque, tablet)
- Sistema operacional e sua versão
- Navegador da 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 Atual: 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.
Etapas de Reprodução
Certifique-se de que o bug possa ser reproduzido de forma consistente. 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 10 tentativas). Para bugs relacionados a 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 no atraso 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:
Etapas de Reprodução:
Melhores Práticas
- Reproduzir no Modo de Segurança: Antes de relatar, tente reproduzir o problema no Modo de Segurança do Discourse se suspeitar que personalizações possam estar causando isso.
- Questionar Suposições: Relatórios de bugs geralmente decorrem de suposições falsas. Mesmo em seu relatório, questione e esclareça quaisquer suposições que você possa ter.
- Seja Detalhado: Para bugs esquivos 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: Impossível reproduzir o bug de forma consistente.
Solução: Documente o ambiente e as condições sob as quais o bug aparece. Observe 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.
FAQs
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 mais tarde.
P: Onde devo postar meu relatório de bug?
R: Use a categoria apropriada - relatórios de bugs devem ir para a categoria bug.