Um bom relatório de suporte separa observações de suposições. Registe a mensagem, a hora, o ambiente e os passos seguros para reproduzir o erro, sem partilhar dados confidenciais. Este guia é independente do sistema operativo; os nomes das janelas de versão variam conforme o programa.
1. Registar o incidente
Anote data, hora e fuso horário, aplicação afetada e versão exata. Acrescente a versão do sistema operativo, o tipo de dispositivo e o último momento conhecido em que funcionou. Escreva “desconhecido” quando faltar informação, em vez de adivinhar. Descreva o impacto: um ficheiro, um utilizador ou vários postos de trabalho?
2. Descrever o erro e os passos com precisão
- Copie a mensagem completa e o código, se possível. Caso contrário, faça uma captura de ecrã e transcreva também o texto. Não traduza nem abrevie o código de erro.
- Numere as ações até ao erro: estado inicial, ficheiro ou função aberta, botão exato e resultado. Use nomes neutros para os ficheiros quando necessário.
- Separe o resultado esperado do observado. Escreva “Guardar apresenta o erro X” em vez de “O servidor está avariado”, enquanto a causa não estiver comprovada.
- Indique se o erro ocorre sempre, ocasionalmente ou apenas uma vez. Repita só passos seguros com dados de teste ou uma cópia. Não repita pagamentos, eliminações ou ações com risco de perda de dados para reproduzir o problema.
3. Provas e tentativas anteriores
Acrescente alterações conhecidas pouco antes do erro e medidas já testadas, com o resultado de cada uma. Não altere várias definições ao mesmo tempo. Proteja o registo original; partilhe apenas os excertos necessários do período relevante. Um evento simultâneo é uma pista, não prova da causa.
4. Verificar antes de enviar
Remova palavras-passe, tokens de sessão, dados pessoais e conteúdos confidenciais da cópia a enviar. Confira também a barra de endereços, os caminhos de ficheiros e o fundo das capturas. Um retângulo sobreposto num ficheiro editável não garante a remoção segura. Reabra o anexo final e verifique o resultado. Use o canal de suporte previsto e confira destinatário e anexos; não publique pacotes de diagnóstico completos sem revisão num fórum.
Modelo para copiar
- Título curto e impacto:
- Data, hora, fuso horário:
- Aplicação/versão, sistema operativo/versão, dispositivo:
- Estado inicial e passos numerados:
- Esperado / observado:
- Mensagem completa e código:
- Frequência, último sucesso, alterações conhecidas:
- Tentativas anteriores / resultado de cada uma:
- Anexos verificados e sem dados confidenciais:
Verificação final: outra pessoa deve compreender a sequência sem perguntar pelos passos básicos. Problemas independentes devem ter relatórios separados.
Fonte
Mozilla: Bug Writing Guidelines – base para passos precisos, resultados claros e relatórios separados; a verificação de privacidade complementa o processo geral de suporte.