Esta es una guía para escribir informes de errores efectivos en Discourse y maximizar las posibilidades de que se solucionen los errores.
Nivel de usuario requerido: Cualquiera puede reportar un error
Escribir un buen informe de errores es esencial para ayudar al equipo de Discourse a solucionar problemas de manera eficiente. Esta guía le guiará a través de los pasos y las mejores prácticas para garantizar que su informe de errores sea claro, conciso y accionable.
Resumen
En esta documentación, cubriremos:
- La importancia de proporcionar pasos reproducibles y detalles específicos
- Cómo describir el problema y el comportamiento esperado
- Mejores prácticas para informar en diferentes plataformas
- Mantener un tono apropiado en su informe
- Errores comunes y soluciones
Pasos para escribir un informe de errores efectivo
Prioridad/Severidad
Determine la urgencia de la corrección del error. Si bien todos desean que sus problemas se resuelvan rápidamente, reserve la máxima prioridad para los problemas críticos que afectan significativamente la funcionalidad.
Plataforma
Siempre especifique el entorno en el que se observó el error. Esto incluye:
- Tipo de dispositivo (escritorio, móvil, pantalla táctil, tableta)
- Sistema operativo y su versión
- Navegador web y su versión
Siempre que sea posible, reproduzca el error en varias plataformas para confirmar su presencia.
Descripción
Sea conciso. Describa el problema de forma sencilla y sin detalles innecesarios. Separe los diferentes problemas si se pueden informar individualmente. Un formato de descripción claro incluye:
Resultado Real: ¿Qué está sucediendo?
Resultado Esperado: ¿Qué debería haber sucedido?
Evite suposiciones sobre lo que el lector ya sabe. Sea explícito sobre lo que debería haberse visto u ocurrido.
Pasos reproducibles
Asegúrese de que el error se pueda reproducir de manera consistente. Escriba instrucciones paso a paso comenzando desde la pantalla de inicio de Discourse. Si el error aparece al azar, especifique con qué frecuencia ocurre (por ejemplo, 1 de cada 10 intentos). Para errores relacionados con la interfaz de usuario/experiencia de usuario, agregue capturas de pantalla o videos para mayor claridad.
Tono
Mantenga un tono respetuoso y cortés. Evite usar el informe de errores para expresar frustración. Cualquier lenguaje o comportamiento tóxico puede resultar en que su informe se retrase o se ignore.
Plantilla
Utilice esta plantilla para iniciar rápidamente un nuevo tema de informe de errores:
Prioridad/Severidad:
Plataforma:
Descripción:
Pasos reproducibles:
Mejores Prácticas
- Reproducir en Modo Seguro: Antes de informar, intente reproducir el problema en el Modo Seguro de Discourse si sospecha que las personalizaciones podrían estar causando el problema.
- Cuestionar Suposiciones: Los informes de errores a menudo surgen de suposiciones falsas. Incluso en su informe, cuestione y aclare cualquier suposición que pueda tener.
- Sea Detallado: Para errores esquivos o raros, proporcione tantos detalles como sea posible. Incluya todo lo que crea que podría estar relacionado, como mensajes de error o archivos de registro.
Problemas Comunes y Soluciones
Problema: No se puede reproducir el error de manera consistente.
Solución: Documente el entorno y las condiciones bajo las cuales aparece el error. Observe cualquier patrón o similitud.
Problema: Falta de respuesta a un informe de errores.
Solución: Asegúrese de que su informe sea detallado pero conciso y esté escrito en un tono cortés.
Preguntas Frecuentes
P: ¿Qué pasa si no tengo tiempo para un informe detallado?
R: Sigue siendo útil abrir un informe con la información que tiene. Indique que lo actualizará con más detalles más tarde.
P: ¿Dónde debo publicar mi informe de errores?
R: Utilice la categoría apropiada: los informes de errores deben ir a la categoría bug.