Cómo redactar un informe de error (+ Descarga gratuita de plantilla)
Saber cómo crear un informe de errores eficaz es una parte fundamental del trabajo de un tester de software para mantener la garantía de calidad, por lo que dedicamos mucho tiempo a registrar errores en nuestras herramientas de seguimiento. Encontrar un error puede resultar emocionante, especialmente si es un escenario interesante. Pero la forma en la que lo reportamos puede ser tan importante como el impacto que tiene en el sistema.
Un informe de errores mal redactado puede causar mucha fricción entre los miembros del equipo, especialmente entre los testers y los desarrolladores, lo que puede crear obstáculos para corregir los errores y, en última instancia, arruinar la experiencia del usuario.
En este artículo, compartiré detalles esenciales, como cómo:
Want more from The CTO Club?
Create a free account to finish this piece and join a community of CTOs and engineering leaders sharing real-world frameworks, tools, and insights for designing, deploying, and scaling AI-driven technology.
Have an account? Log In
- Dominar los informes de errores: Aprende los elementos clave que todo informe de errores eficaz debe incluir para agilizar la comunicación y acelerar las correcciones.
- Mejorar la armonía del equipo: Descubre cómo los informes de errores bien redactados previenen la fricción entre testers y desarrolladores, lo que conduce a flujos de trabajo más fluidos.
- Plantilla descargable gratis: Consigue una plantilla de seguimiento de errores gratuita y descargable para acelerar tu proceso eficiente de reporte de errores.
Elementos clave de un informe de errores
No importa el tipo de aplicación que estés probando, ya sea de escritorio, web, aplicación móvil o un proyecto de API, hay algunos elementos clave que todo buen informe de errores debe incluir. La mayoría de los softwares de seguimiento de errores incluyen campos para estos elementos, entre ellos:
- ID: Si utilizas una herramienta de gestión de proyectos, como Jira, se asignará automáticamente un ID a cada nuevo problema que se abra. También existen herramientas de gestión de pruebas para Jira para el seguimiento de errores.
- Título/Descripción: Esta es una breve descripción del problema. Debe ser lo suficientemente concisa como para ser fácil de leer pero también lo suficientemente descriptiva para que otros puedan entender dónde está el problema. Por ejemplo, “la ordenación de artículos por precio no funciona cuando se aplica un filtro.”
- Pasos para reproducir: Incluye aquí todos los detalles relevantes posibles. Asegúrate de que quien intente reproducir el error o verificar la corrección pueda hacerlo solo siguiendo los pasos. No omitas pasos pensando que todos supondrán que deben realizar ciertas acciones aunque no se mencionen; inclúyelos en el informe de errores.
- Resultados esperados: Nuevamente, no asumas que la gente ya sabe cómo debería funcionar la aplicación. Por supuesto que, si aparece una excepción en la interfaz al pulsar un botón, sabes que eso no es lo esperado. Sin embargo, no diría que el resultado esperado es “no se lanza excepción”, sino más bien la acción que debe realizar el botón, es decir, “se abre el cuadro de diálogo de configuración.”
- Resultados reales: Esto es autoexplicativo: debes describir lo que sucede en la aplicación después de realizar todos los pasos para reproducir el error.
- Severidad: Representa el impacto que tiene el error sobre la aplicación bajo prueba (AUT).
- Prioridad: Indica la rapidez con la que debe corregirse el error. Una prioridad mayor significa que el error deberá estar más arriba en la lista y corregirse antes.
Otra información importante a incluir
Aparte de los elementos mencionados, puede haber otra información relevante, especialmente cuando se introducen datos en una herramienta de reporte de errores. Dependen del tipo de proyecto, los requisitos o incluso del propio error:
- Versión del software: El número de compilación donde se identificó el error. Esto puede ayudar a aislar las versiones donde se introdujo el error y a identificar el código que lo causó.
- Adjuntos: Puede que no siempre sean necesarios o estén disponibles, pero usualmente aportan mucho valor. Considera adjuntar capturas de pantalla o grabaciones del problema encontrado, archivos de registro, trazas de pila, solicitudes y respuestas de red, etc.
- Datos de prueba: A veces, los errores solo se reproducen con ciertos conjuntos de datos. Si es el caso, asegúrate de incluirlos, ya sea en los pasos para reproducir (por ejemplo, “iniciar sesión con el usuario andreea@theqalead.com”) o en un campo específico de la herramienta de seguimiento.
- Detalles del entorno: Si el error solo ocurre en un sistema operativo, navegador o entorno de desarrollo específico, menciónalo.
Consejos para crear un buen informe de errores
- Limítate a un solo error por informe. Si detectas más errores en las mismas áreas, puedes vincularlos en tu sistema de seguimiento. Incluir más de un defecto puede causar confusión y retrasos en las posibles correcciones.
- Revisa en tu sistema de seguimiento que el error no haya sido reportado previamente. Si ya está abierto, añade cualquier detalle relevante que tú hayas encontrado y que no esté en el informe original del error.
- Intenta reproducir el error más de una vez. Puedes tratar de encontrar la forma más corta de reproducirlo (usando la menor cantidad de pasos posibles).
- No te pierdas en detalles irrelevantes. El informe del error y los pasos para reproducirlo deben ser fáciles de leer y seguir.
- No hagas suposiciones sobre por qué ocurre el error (a menos que estés 100% seguro de la causa).
Plantilla de informe de errores
Ahora, me gustaría compartir contigo algunas plantillas para informes de errores. Puedes copiarlas o modificarlas según las necesidades de tu proyecto.
Plantilla de seguimiento de errores en Jira
Jira es una herramienta de seguimiento de incidencias muy común de Atlassian. Si tu equipo la utiliza, probablemente el tipo de incidencia “bug” (error) ya está configurado. Como tester o como responsable del equipo de desarrollo de software, puedes configurar un flujo de trabajo de seguimiento de errores para el ciclo de vida de los bugs (esta capacidad es una de las ventajas del software de seguimiento de incidencias).
También puedes añadir campos personalizados en Jira, por ejemplo, para el entorno o un campo único en el que se indique la funcionalidad probada. O puedes agregar una descripción por defecto con toda la información que quieras que se incluya en cada informe de error. Aquí tienes una que he creado:
Ahora, cuando quiero crear un nuevo error, tendré esta información pre-cargada. Esta es mi plantilla de errores en Jira, usando campos personalizados y una descripción por defecto:
Incluye la información fundamental que dijimos que debe contener el informe de error:
- Un título (“Bug de ejemplo”)
- Dentro de la descripción: las precondiciones, los pasos para reproducirlo y los resultados esperados vs los obtenidos
- Un campo personalizado para el entorno
- Una severidad y una prioridad, seleccionadas de menús desplegables con valores predefinidos
- Dejé el responsable sin asignar. Dependiendo de las convenciones de tu proyecto, los nuevos errores pueden asignarse automáticamente a un miembro específico del equipo, o quien empiece a trabajar en él puede autoasignárselo
- Una etiqueta—esto puede ser útil si quieres hacer seguimiento de qué funcionalidad está impactada, por ejemplo
- Una fecha límite—puede quedar pendiente hasta que se priorice la lista de pendientes (backlog)
- La persona que lo reporta (que en este caso se autocompleta con el usuario de Jira que crea el bug)
Opcionalmente, Jira tiene varias integraciones y el error puede vincularse a casos de prueba, ramas de Git o incluso pull requests.
También puedes usar su plantilla de seguimiento de errores como plantilla de proyecto si solo necesitas Jira para seguimiento de defectos y no trabajas en un entorno ágil.
Plantilla de seguimiento de errores en Excel
Algunos equipos pueden utilizar hojas de cálculo como sistema de seguimiento de errores. Las encuentro útiles para proyectos muy pequeños donde no vale la pena configurar una herramienta de seguimiento de incidencias, o para registrar errores en nuevas funcionalidades que aún están en desarrollo.
Puedes usar Google Sheets/Docs, o Microsoft Excel/Word — en ambos casos, una plantilla de errores podría verse así:
Las columnas reflejan la información que debe contener el informe:
- El ID (Excel sabrá cómo aumentar automáticamente el valor cada vez que se agregue una nueva fila)
- Un título
- Los pasos para reproducir
- Resultados esperados y reales
- El nombre del informante
- La gravedad y la prioridad del error—aquí utilicé listas desplegables porque los valores deben estar predefinidos
- Entorno
- Información adicional: Esto es para cualquier otro dato que valga la pena mencionar y que no encaje en las otras columnas
Reflexiones finales
Redactar un buen informe de errores de software es una habilidad esencial para los testers, así que presta especial atención a las mejores prácticas explicadas arriba. También puedes apoyarte en los ejemplos de plantillas de seguimiento de errores que proporcioné. Estas pueden ajustarse a las diferentes herramientas que estés utilizando, como Trello o Asana.
¡Si te ha gustado este contenido, suscríbete al boletín The QA Lead para mantenerte al día con más noticias y tendencias sobre el proceso de pruebas de software!
