Esta es una guía para redactar informes de errores efectivos en Discourse, con el fin de maximizar las probabilidades de que se corrijan.
Nivel de usuario requerido: Cualquier usuario puede informar un error
Redactar un buen informe de error es fundamental para ayudar al equipo de Discourse a solucionar los problemas de manera eficiente. Esta guía te guiará a través de los pasos y las mejores prácticas para asegurarte de que tu informe 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 adecuado en tu informe
- Errores comunes y soluciones
Pasos para redactar un informe de error efectivo
Prioridad/Gravedad
Determina la urgencia de la corrección del error. Aunque todos quieren que sus problemas se resuelvan rápidamente, reserva la mayor prioridad para los errores críticos que impactan significativamente la funcionalidad.
Plataforma
Especifica siempre 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
Si es posible, replica el error en varias plataformas para confirmar su presencia.
Descripción
Sé conciso. Describe el problema de forma sencilla y sin detalles innecesarios. Separa diferentes problemas si pueden informarse individualmente. Un formato de descripción claro incluye:
Resultado real: ¿Qué está ocurriendo?
Resultado esperado: ¿Qué debería haber ocurrido?
Evita asumir lo que el lector ya sabe. Sé explícito sobre lo que se debería haber visto o ocurrido.
Pasos reproducibles
Asegúrate de que el error se pueda reproducir de forma constante. Escribe instrucciones paso a paso comenzando desde la pantalla de inicio de Discourse. Si el error aparece de forma aleatoria, especifica con qué frecuencia ocurre (por ejemplo, 1 de cada 10 intentos). Para errores relacionados con la interfaz de usuario/experiencia de usuario (UI/UX), añade capturas de pantalla o vídeos para mayor claridad.
Tono
Mantén un tono respetuoso y educado. Evites usar el informe de error para expresar frustración. Cualquier lenguaje o comportamiento tóxico puede provocar que tu informe se retrase o se ignore.
Plantilla
Utiliza esta plantilla para comenzar rápidamente un nuevo tema de informe de error:
Prioridad/Gravedad:
Plataforma:
Descripción:
Pasos reproducibles:
Mejores prácticas
- Reproducir en modo seguro: Antes de informar, intenta reproducir el problema en el modo seguro de Discourse si sospechas que las personalizaciones podrían estar causándolo.
- Cuestionar supuestos: Los informes de error a menudo surgen de supuestos falsos. Incluso en tu informe, cuestiona y aclara cualquier suposición que puedas tener.
- Sé detallado: Para errores esquivos o raros, proporciona tantos detalles como sea posible. Incluye cualquier cosa que creas que pueda estar relacionada, como mensajes de error o archivos de registro.
Problemas comunes y soluciones
Problema: No se puede reproducir el error de forma consistente.
Solución: Documenta el entorno y las condiciones bajo las cuales aparece el error. Anota cualquier patrón o similitud.
Problema: Falta de respuesta a un informe de error.
Solución: Asegúrate de que tu informe sea detallado pero conciso y esté redactado en un tono cortés.
Preguntas frecuentes
P: ¿Qué hago si no tengo tiempo para un informe detallado?
R: Sigue siendo útil abrir un informe con la información que tienes. Indica que lo actualizarás con más detalles más adelante.
P: ¿Dónde debo publicar mi informe de error?
R: Utiliza la categoría adecuada: los informes de errores deben publicarse en la categoría Contribute > Bug.