Cómo escribir un informe de error con ejemplos

¿Qué es el informe de error? ¿Por qué necesitas un buen informe de errores?

Bug Report es un documento importante en STLC que ofrece varias ventajas al equipo de pruebas. Realiza un seguimiento de todos los defectos, múltiples errores, errores y otras discrepancias encontradas durante las pruebas de software y los informa.

El propósito de esta documentación posterior a la prueba es proporcionar información al equipo de profesionales correspondiente sobre el nivel de errores encontrados durante el proceso de prueba.

Su ingeniero de desarrollo de software Se puede conocer todos los defectos y problemas presentes en el software mediante este tipo de informe. También le permite descubrir qué está mal con un error, para que pueda utilizar el mejor método para solucionarlo. También le ayuda a ahorrar tiempo y dinero al ayudarle a detectar errores y problemas.

¿Por qué debería importarle una buena explicación de errores?

Este es el punto que debe considerar para escribir un buen y detallado informe de errores de software:

• Actúa como una guía para ayudar a evitar el mismo error en versiones futuras.
• Ahorra tiempo para la comunicación (correos electrónicos, llamadas).
• Less trabajo para desarrolladores (harán exactamente lo que usted quiera).
• Tendrás menos cuellos de botella en el proyecto; Los errores se solucionarán de forma más rápida y eficiente.

Cómo escribir un informe de errores (plantilla de informe de errores)

No existe una plantilla exacta de informe de errores, ya que depende de su sistema de seguimiento de errores. Su plantilla puede ser diferente.

Sin embargo, los siguientes campos comunes siempre son necesarios cuando desea escribir un informe de error:

• ID de error/Título.
• Severidad y Prioridad.
• Descripciones
• Medio Ambiente
• Pasos para reproducir.
• Resultado Esperado.
• Resultado actual.
• Archivos adjuntos (capturas de pantalla, vídeos, texto)

Veamos todos estos componentes de corrección de errores uno por uno:

1) Título/ID de error:

Cada error debe tener un número de identificación único. Las herramientas de notificación de errores deben tener números únicos para los errores detectados recientemente, de modo que podamos identificarlos fácilmente.

Ejemplos:

❌ Malo: “No puedo ver el producto cuando lo vuelvo a ver, pero no lo hace”.

• Ola
• Agresivo
• demasiado prolijo

pide que se implemente una solución.

✅ Bueno: “CARRITO – Nuevos artículos añadidos al carrito que no aparecen”.

• Este tipo de Título localiza instantáneamente el problema (CARRITO)
• Se centra en el problema técnico real.

2) Gravedad del error:

La gravedad del error es un factor muy importante en el informe de error. Describe el efecto del defecto en el rendimiento de la aplicación.

• bloqueador: Este error hace que la aplicación falle.
• Carrera: Un error crítico indica un cambio importante en la lógica empresarial.
• Minor: Un problema que no afecta a la funcionalidad de la aplicación pero sí a los resultados esperados.
• Trivial: No afecta la funcionalidad ni el funcionamiento de la aplicación. Podría tratarse de un error tipográfico.

3) Prioridad de errores:

A continuación se muestra la gradación general para decidir la prioridad de los errores:

• Alto: Cubre cualquier cosa que afecte el flujo o bloquee el uso de la aplicación.
• Medio: Afecta negativamente a la experiencia del usuario.
• Minor: Todos los demás errores como (errores tipográficos, iconos faltantes, problemas de diseño, etc.).

4) Medio ambiente:

Un Bug puede aparecer en un entorno concreto y no en otros. Por ejemplo, a veces aparece un error al ejecutar el sitio web en Firefox, o un mal funcionamiento de la aplicación solo cuando se ejecuta en un Android Dispositivo y funciona bien en iPhone.

Estos informes de errores solo se pueden identificar mediante pruebas en varios navegadores o dispositivos. Por lo tanto, al informar el error, los controles de calidad deberían poder especificar si el error debe observarse en uno o más entornos específicos.

5) Resumen:

Sin embargo, agregar solo el Título en el informe de error no sirve para este propósito. Entonces, si su título no es suficiente, puede agregar un breve resumen del informe.

Su resumen en la menor cantidad de palabras posible, incluyendo cuándo y cómo ocurrió el error. Su título y descripción del error también deben usarse en las búsquedas, por lo que debe asegurarse de haber cubierto las palabras clave importantes.

Ejemplos:

• Malo: "Estaba intentando agregar cosas a la prueba y no apareció nada cuando lo hice o hice clic en el botón".
• Bueno: "Cuando intenté agregar [PRODUCTO] al carrito de compras, pero no pasó nada cuando hice clic en el botón 'agregar' en la página web de descripción general del producto específico".

6) Pasos para reproducir:

Al informar un error, es importante especificar los pasos para reproducirlo. También debes incluir acciones que puedan causar el error. Aquí, no hagas declaraciones genéricas.

Sea específico en los pasos a seguir:

A continuación se muestra un ejemplo de un procedimiento bien redactado:

Pasos:

1. Seleccione el producto X1.
2. Haga clic en Agregar al carrito.
3. Haga clic en Eliminar para eliminar el producto del carrito.

7) Resultado esperado:

En los informes de errores, es importante describir el resultado esperado según la tarea técnica, el diseño de los resultados del caso de prueba o según la opinión del evaluador. Todo esto ayuda a los desarrolladores a concentrarse en encontrar rápidamente la información necesaria.

Por ejemplo:

Los campos obligatorios deben resaltarse en rojo después de hacer clic en el botón "Enviar".

8) Resultado real:

Como sugiere su nombre, este campo describe el efecto real del error. Es muy importante escribir una descripción clara del resultado real.

Por ejemplo:

Los campos obligatorios se resaltan en color verde después de hacer clic en el botón "Enviar".

9) Adjuntos (capturas de pantalla y vídeos):

En los informes de errores, se recomienda adjuntar archivos a los informes de errores, lo que facilita la percepción de la información cuando es necesario mostrarla visualmente:

Por ejemplo:

• Captura de pantalla: Las capturas de pantalla pueden explicar fácilmente errores en el programa; Esto es conveniente cuando el error está resaltado con una anotación específica, un círculo o una imagen de flecha).
• Video: A veces, es difícil describir el error con palabras, por lo que es mejor crear un vídeo para que el desarrollador pueda rectificar el defecto en el programa).

10) Versión afectada:

Es la versión de software afectada donde se informa el error.

11) Versión reparada:

Es la versión del software en la que se resuelve el error. Entonces, cuando el control de calidad que informó el error verifica si está solucionado, utiliza la versión de software correcta.

12). Target Versión:

La versión de destino a la que se debe dirigir un error para corregirlo. Entonces, cuando el equipo de desarrollo trabaja para corregir un error, principalmente se dirige a una versión de aplicación particular.

13) Fecha de cierre:

Es la fecha en la que el equipo de pruebas de software soluciona el error. Cerrar un error es una parte vital e integral de las pruebas de software.

14) Estado:

Cuando se crea un nuevo error, su estado debe ser abierto. Después de eso, pasa por etapas como En progreso, Corregido, En ejecución, Reabierto, etc.

Consejos para redactar informes de errores

A continuación se ofrecen algunos consejos importantes que debe recordar al redactar un informe de error eficaz:

• Sea específico al crear informes de errores. Asegúrese de no incluir ningún hecho inútil o irrelevante.
• Debe informar el error inmediatamente tan pronto como se detecte.
• Prepare el informe en detalle para permitir al desarrollador utilizar los hechos y la información para solucionar el problema.
• Debe probar la misma aparición de errores en otros módulos similares para su validación.
• RevLea el informe de error al menos una vez antes de enviarlo.
• Debe asegurarse de que el informe de error contenga la descripción de un solo error.
• Por último, no debe tener miedo de pedir ayuda al director del proyecto si no tiene claro algo.

Herramientas de informe de errores

El proceso de informe de errores, que se realiza manualmente, ahora se realiza con varias herramientas de informe de errores disponibles en el mercado.

• JIRA
• Rastreador de errores de Zoho
• Bugzilla

Puedes consultar nuestra reseña detallada del La mejor herramienta para informar errores.

Problema común y solución al escribir un informe de error:

A continuación se muestran algunos problemas comunes y sus soluciones al escribir un informe de error:

Ejemplo de informe de error	Problema
Al multiplicar 2 por 3, la respuesta será positiva.	Informe el patrón, no un ejemplo.
La lista se ordenará alfabéticamente al agregar un nuevo elemento para evitar esto.	No solo describas lo que está mal
Por ejemplo: Para ello, deberá abrir su navegador y escribir la URL del sitio. Encontrarás el primer campo, "nombre de usuario", mal escrito.	Siempre directo al grano (¡Nunca cuentes la historia!).
El nombre del cliente en el informe está mal escrito. Prioridad: alta, gravedad: alta	Nunca mezcle prioridad y severidad.
¡¡La fórmula de cálculo de impuestos es INCORRECTA!!??	No utiliza MAYÚSCULAS, letras rojas, círculos rojos, '!',
No creo que el diseño de Ul de la página de inicio sea bueno.	No uses tu criterio.
Ejemplo de descripción poco clara: acerca de nuestra discusión de hoy, realice la acción requerida para esta página.	Haga que su descripción sea comprensible para todos.
El fondo de la página debe ser azul, naranja o verde, o puedes hacerlo blanco o negro. Esto no es bueno ya que no está claro qué se necesita del equipo de diseño y desarrollo web.	Minimizar las opciones
A veces, la fórmula de cálculo de impuestos no funciona como se esperaba.	La regla de oro: no utilices la palabra "a veces".

Ejemplo de informe de error

Aquí hay un pequeño ejemplo de un informe de error:

[MI CUENTA] El subrayado se muestra al pasar el mouse sobre el botón Actualizar.

Descripción: Necesitamos eliminar el subrayado al pasar el mouse sobre el botón Actualizar en la sección Mi cuenta.

Enlace: http://test.com/mv-account/

Navegador/SO: Cromo 25. OSX Yosemite 10.10.2

Pasos para reproducir:

1. Vaya a www.test.com

2. Inicie sesión mediante credenciales de inicio de sesión

3. Navega a Mi cuenta

4. Pase el mouse sobre el botón Actualizar

Resultado actual: hay un subrayado.

Resultado Esperado: sin subrayado.

Datos de inicio de sesión: test@test.com / mysecretpass12

Debe evitar errores al redactar informes de errores.

Aquí hay algunos errores importantes que debes evitar al escribir un informe de error:

• No escriba sobre su insatisfacción y nunca incluya sus sentimientos personales.
• A las personas que quieren concentrarse en la tarea les molesta cuando sobrecargas tu publicación con muchos emoticones.
• Nunca sobrecargues tu publicación con signos de exclamación; no acelera el trabajo.
• Nadie quiere sentirse ofendido. Destruye la motivación y retarda la comprensión del problema.