Cómo reportar Bugs o problemas de Soul - Consejos prácticos
Este documento está enfocado a cómo reportar de forma clara un error en el sistema, para ver cómo y dónde ve a Cómo realizar una solicitud .
Reportar un bug (error del sistema) de manera efectiva es crucial para que el equipo de desarrollo pueda entender y solucionar el problema rápidamente. Recuerda que la comunicación clara y la colaboración son clave. Siempre que estemos trabajando con un equipo de desarrollo, entender cómo reportar un bug efectivamente es una habilidad valiosa que puede mejorar significativamente el proceso de solución de problemas.
La forma más adoptada en el mundo para reportar un error sigue una sintaxis específica.
Sintaxis (receta):
Pasos para reproducir el error: describe de forma detallada y secuencial cómo reproducir el problema paso a paso.
Error: Describe el problema o mensaje de error que aparece.
Entorno o ambiente: Incluye información sobre el sistema operativo, navegador, versión de la aplicación, etc.
Resultado esperado: Explica qué debería haber sucedido si el sistema funcionara correctamente.
Ejemplo:
Pasos para reproducir el error:
Ingresar a Soul Interno > Herramientas > Descargar Documentos x Files
En el campo Clientes escribir solo una letra (ej. La c) y esperar a que liste los clientes.
Error
El buscador de clientes se queda cargando, no muestra ningún cliente y bloquea por completo el Soul Interno.
Resultado esperado
Poder listar los clientes cuando escribo una sola letra
Entorno (ambiente)
Navegador: Microsoft Edge
Soul Interno - productivo
Algunos consejos para hacerlo de manera efectiva:
Descripción detallada: Explica claramente qué está sucediendo. Incluye detalles específicos como qué estabas intentando hacer cuando ocurrió el error y exactamente qué salió mal.
Sé conciso pero completo: Brinda toda la información necesaria, pero intenta ser lo más claro y directo posible.
Validación de los pasos para reproducir el error: vuelve a leer (o ver el video) desde la posición del que lo va a recibir y corregir ¿Se puede reproducir el error? Esto es crucial para que los desarrolladores puedan ver el problema por sí mismos.
Resultados esperados vs. Resultados actuales: Describe lo que esperabas que sucediera y lo que sucedió en realidad. Esta comparación ayuda a entender la discrepancia.
Capturas de pantalla o videos: Si es posible, incluye imágenes o videos. Esto puede ser especialmente útil si el error es visual o difícil de describir con palabras.
Las imágenes deben ser de la pantalla completa, no solo un pedazo de ella, y ojalá que muestre la URL.
Ambiente y configuración: incluye detalles sobre el entorno en el que ocurrió el error (sistema operativo, versión del software, hardware específico si es relevante).
Registros o mensajes de error: Si hay mensajes de error o logs disponibles, inclúyelos. Estos detalles técnicos pueden ser muy valiosos.
Prioridad y severidad: Si puedes, indica qué tan grave es el error y qué impacto tiene. Esto puede ayudar a priorizar el trabajo de solución.
Comportamiento previo: Si el error empezó después de un cambio específico (como una actualización), menciona esto.
No asumas la causa: Evita especular sobre qué está causando el problema, a menos que tengas una buena razón para creerlo. Es mejor dejar que los desarrolladores hagan su propia investigación.