Menú

¿Cómo escribir un buen informe de errores? Consejos y trucos

how write good bug report

Pruebe Nuestro Instrumento Para Eliminar Los Problemas

cómo encontrar archivos apk en un teléfono Android

¿Por qué un buen informe de errores?

Si su informe de error es efectivo, entonces sus posibilidades de solucionarse son mayores. Por lo tanto, corregir un error depende de la eficacia con la que lo informe. Informar un error no es más que una habilidad y explicaré cómo lograr esta habilidad.

“El objetivo de escribir un informe de problemas (informe de errores) es corregirlos” - Por Cem Kaner. Si un evaluador no informa un error correctamente, el programador probablemente rechazará este error y lo declarará irreproducible.

Cómo escribir un buen informe de errores

Esto puede dañar la moral de los probadores y, a veces, también el ego. (Sugiero no mantener ningún tipo de ego. El ego es como 'He informado el error correctamente', 'Puedo reproducirlo', '¿Por qué ha rechazado el error?', 'No es mi culpa', etc. ,).

Lo que vas a aprender:

¿Cuáles son las cualidades de un buen informe de errores de software?

Cualquiera puede escribir un informe de error. Pero no todo el mundo puede redactar un informe de error eficaz.

Debería poder distinguir entre un informe de error medio y un buen informe de error. ¿Cómo distinguir entre un informe de errores bueno y malo? Es muy simple, aplique las siguientes características y técnicas para informar un error.

Las características y técnicas incluyen

# 1) Tener un número de error claramente especificado: Asigne siempre un número único a cada informe de error. Esto, a su vez, le ayudará a identificar el registro de errores. Si está utilizando alguna herramienta automatizada de notificación de errores, este número único se generará automáticamente cada vez que informe del error.

Anote el número y una breve descripción de cada error que informó.

# 2) Reproducible: Si su error no es reproducible, nunca se solucionará.

Debe mencionar claramente los pasos para reproducir el error. No asuma ni omita ningún paso de reproducción. Un error que se describe paso a paso es fácil de reproducir y corregir.

# 3) Sea específico: No escriba un ensayo sobre el problema.

Sea específico y vaya al grano. Trate de resumir el problema en palabras mínimas pero de una manera eficaz. No combine varios problemas, incluso si parecen ser similares. Escribe diferentes informes para cada problema.

Informe de errores eficaz

La notificación de errores es un aspecto importante de las pruebas de software. Un informe de errores eficaz se comunica bien con el equipo de desarrollo y evita confusiones o problemas de comunicación.

Un buen informe de errores debe ser claro y conciso sin que falten puntos clave. Cualquier falta de claridad conduce a malentendidos y también ralentiza el proceso de desarrollo. La redacción de informes y los defectos es una de las áreas más importantes pero olvidadas en el ciclo de vida de las pruebas.

La buena redacción es muy importante para solucionar un error. El punto más importante que un evaluador debe tener en cuenta es no usar un tono de mando en el informe. Esto rompe la moral y crea una relación laboral poco saludable. Usa un tono sugerente.

No asuma que el desarrollador ha cometido un error y, por lo tanto, puede usar palabras duras. Antes de informar, es igualmente importante comprobar si se ha informado del mismo error o no.

Un error duplicado es una carga en el ciclo de prueba. Consulte la lista completa de errores conocidos. A veces, los desarrolladores pueden haber conocido el problema y haberlo ignorado para una versión futura. También se pueden utilizar herramientas como Bugzilla, que busca automáticamente errores duplicados. Sin embargo, es mejor buscar manualmente cualquier error duplicado.

La información de importación que debe comunicar un informe de error es '¿Cómo?' ¿y donde?' El informe debe responder claramente cómo se realizó la prueba y dónde ocurrió exactamente el defecto. El lector debería reproducir fácilmente el error y encontrar dónde está.

Tenga en cuenta que el objetivo de redactar el informe de errores es permitir que el desarrollador visualice el problema. Él / ella debe comprender claramente el defecto del informe de error. Recuerda dar toda la información relevante que busca el desarrollador.

Además, tenga en cuenta que un informe de error se conservará para uso futuro y debe estar bien escrito con la información requerida. Use oraciones significativas y palabras simples. para describir sus errores. No utilice declaraciones confusas que hagan perder el tiempo al revisor.

Informe cada error como un problema independiente. En caso de varios problemas en un solo informe de error, no puede cerrarlo a menos que se resuelvan todos los problemas.

Por tanto, es mejor dividir los problemas en errores separados . Esto asegura que cada error se pueda manejar por separado. Un informe de error bien escrito ayuda al desarrollador a reproducir el error en su terminal. Esto también les ayuda a diagnosticar el problema.

¿Cómo informar un error?

Utilice la siguiente plantilla simple de informe de errores:

Este es un formato de informe de error simple. Puede variar según la herramienta de informe de errores que esté utilizando. Si está escribiendo un informe de error manualmente, algunos campos deben mencionarse específicamente, como el número de error, que debe asignarse manualmente.

Reportero: Su nombre y dirección de correo electrónico.

Producto: En qué producto encontró este error.

Versión: La versión del producto, si la hubiera.

Componente: Estos son los principales submódulos del producto.

Plataforma: Mencione la plataforma de hardware donde encontró este error. Las diversas plataformas como 'PC', 'MAC', 'HP', 'Sun', etc.

Sistema operativo: Mencione todos los sistemas operativos donde encontró el error. Sistemas operativos como Windows, Linux, Unix, SunOS, Mac OS. Mencione las diferentes versiones del sistema operativo también como Windows NT, Windows 2000, Windows XP, etc., si corresponde.

Prioridad: ¿Cuándo se debe corregir un error? La prioridad generalmente se establece de P1 a P5. P1 como 'arreglar el error con la máxima prioridad' y P5 como 'arreglar cuando el tiempo lo permita'.

Gravedad: Esto describe el impacto del error.
Tipos de gravedad:

  • Bloqueador: No se pueden realizar más pruebas.
  • Crítico: Bloqueo de la aplicación, pérdida de datos.
  • Importante: Gran pérdida de función.
  • Menor: Pérdida menor de función.
  • Trivial: Algunas mejoras de la interfaz de usuario.
  • Mejora: Solicitud de una nueva característica o alguna mejora en la existente.

Estado: Cuando se registra el error en cualquier sistema de seguimiento de errores, el estado predeterminado del error será 'Nuevo'.
Más adelante, el error pasa por varias etapas como corregido, verificado, reabrir, no se arreglará, etc.

=> haga clic aquí para leer más sobre el ciclo de vida de errores detallado.

Asignar a: Si sabe qué desarrollador es responsable de ese módulo en particular en el que se produjo el error, puede especificar la dirección de correo electrónico de ese desarrollador. De lo contrario, manténgalo en blanco ya que esto asignará el error al propietario del módulo, si no, el administrador asignará el error al desarrollador. Posiblemente agregue la dirección de correo electrónico del gerente en la lista CC.

URL: La URL de la página en la que se produjo el error.

Resumen: Un breve resumen del error en su mayoría en 60 palabras o menos. Asegúrese de que su resumen refleje cuál es el problema y dónde se encuentra.

Descripción: Una descripción detallada del error.

Utilice los siguientes campos para el campo de descripción:

  • Reproducir pasos: Claramente, mencione los pasos para reproducir el error.
  • Resultado Esperado: Cómo debería comportarse la aplicación en los pasos mencionados anteriormente.
  • Resultado actual: ¿Cuál es el resultado real de ejecutar los pasos anteriores, es decir, el comportamiento del error?

Estos son los pasos importantes del informe de errores. También puede agregar el 'Tipo de informe' como un campo más que describirá el tipo de error.

Los tipos de informes incluyen:

1) Error de codificación
2) Error de diseño
3) Nueva sugerencia
4) Problema de documentación
5) Problema de hardware

Funciones importantes en su informe de errores

A continuación se muestran las características importantes del informe de errores:

# 1) Número / identificación de error

Un número de error o un número de identificación (como swb001) facilita la notificación de errores y la referencia a un error. El desarrollador puede verificar fácilmente si un error en particular se ha corregido o no. Hace que todo el proceso de prueba y reevaluación sea más fluido y sencillo.

# 2) Título del error

Un título de error se lee con más frecuencia que cualquier otra parte del informe de error. Debería decir todo sobre lo que viene en el error.

El título del error debe ser lo suficientemente sugerente para que el lector pueda entenderlo. Un título de error claro hace que sea fácil de entender y el lector puede saber si el error se informó anteriormente o se ha corregido.

# 3) Prioridad

Según la gravedad del error, se puede establecer una prioridad para él. Un error puede ser un Bloqueador, Crítico, Mayor, Menor, Trivial o una sugerencia. Se puede dar una prioridad de error de P1 a P5 para que los importantes se vean primero.

# 4) Plataforma / Entorno

La configuración del sistema operativo y del navegador es necesaria para un informe de error claro. Es la mejor manera de comunicar cómo se puede reproducir el error.

Sin la plataforma o el entorno exactos, la aplicación puede comportarse de manera diferente y el error en el extremo del probador puede no replicarse en el extremo del desarrollador. Por lo tanto, es mejor mencionar claramente el entorno en el que se detectó el error.

# 5) Descripción

La descripción del error ayuda al desarrollador a comprender el error. Describe el problema encontrado. La mala descripción creará confusión y hará perder el tiempo a los desarrolladores y probadores también.

Es necesario comunicar claramente sobre el efecto de la descripción. Siempre es útil usar oraciones completas. Es una buena práctica describir cada problema por separado en lugar de desmenuzarlos por completo. No utilice términos como 'yo pienso' o 'yo creo'.

# 6) Pasos para reproducir

Un buen informe de errores debe mencionar claramente los pasos para reproducir. Los pasos deben incluir acciones que causan el error. No haga declaraciones genéricas. Sea específico en los pasos a seguir.

A continuación se ofrece un buen ejemplo de un procedimiento bien redactado.

Pasos:

  • Seleccione el producto Abc01.
  • Haga clic en Agregar al carrito.
  • Haga clic en Eliminar para eliminar el producto del carrito.

# 7) Resultado esperado y real

La descripción de un error está incompleta sin los resultados esperados y reales. Es necesario delinear cuál es el resultado de la prueba y qué debe esperar el usuario. El lector debe saber cuál es el resultado correcto de la prueba. Claramente, mencione lo que sucedió durante la prueba y cuál fue el resultado.

# 8) Captura de pantalla

Una imagen vale mas que mil palabras. Tome una captura de pantalla de la instancia de falla con los subtítulos adecuados para resaltar el defecto. Resalte los mensajes de error inesperados con color rojo claro. Esto llama la atención sobre el área requerida.

Algunos consejos adicionales para escribir un buen informe de errores

A continuación se ofrecen algunos consejos adicionales para redactar un buen informe de errores:

# 1) Informe el problema inmediatamente

Preguntas de la entrevista de Oracle pl sql por 5 años de experiencia

Si encuentra algún error durante la prueba, no necesita esperar para escribir un informe de error detallado más tarde. En su lugar, escriba el informe de error de inmediato. Esto garantizará un informe de errores bueno y reproducible. Si decide escribir el informe de errores más adelante, es muy probable que se pierda los pasos importantes de su informe.

# 2) Reproduzca el error tres veces antes de escribir un informe de error

Tu error debería ser reproducible. Asegúrese de que sus pasos sean lo suficientemente sólidos como para reproducir el error sin ambigüedad. Si su error no es reproducible cada vez, aún puede presentar un error mencionando la naturaleza periódica del error.

# 3) Pruebe la misma ocurrencia de error en otros módulos similares

A veces, el desarrollador usa el mismo código para diferentes módulos similares. Por lo tanto, hay mayores posibilidades de que el error en un módulo ocurra también en otros módulos similares. Incluso puede intentar encontrar la versión más grave del error que encontró.

# 4) Escribe un buen resumen de errores

El resumen de errores ayudará a los desarrolladores a analizar rápidamente la naturaleza del error. Un informe de mala calidad aumentará innecesariamente el tiempo de desarrollo y prueba. Comuníquese bien con el resumen del informe de errores. Tenga en cuenta que el resumen de errores se utiliza como referencia para buscar el error en el inventario de errores.

# 5) Lea el informe de errores antes de presionar el botón Enviar

Lea todas las oraciones, redacciones y pasos que se utilizan en el informe de errores. Vea si alguna oración está creando ambigüedad que pueda llevar a una mala interpretación. Deben evitarse las palabras u oraciones engañosas para tener un informe de error claro.

# 6) No uses lenguaje abusivo

Es bueno que hayas hecho un buen trabajo y hayas encontrado un error, pero no uses este crédito para criticar al desarrollador o atacar a ninguna persona.

Conclusión

Sin duda, su informe de errores debe ser un documento de alta calidad.

Concéntrese en escribir buenos informes de errores y dedique algo de tiempo a esta tarea porque este es el principal punto de comunicación entre el evaluador, el desarrollador y el administrador. Los gerentes deben concienciar a su equipo de que redactar un buen informe de errores es la responsabilidad principal de cualquier evaluador.

Su esfuerzo por escribir un buen informe de errores no solo ahorrará los recursos de la empresa, sino que también creará una buena relación entre usted y los desarrolladores.

Para una mejor productividad, escriba un mejor informe de errores.

¿Eres un experto en redactar un informe de errores? No dude en compartir sus pensamientos en la sección de comentarios a continuación.

Lectura recomendada

^