Cómo escribir un buen reporte de un error de software

1. Localice y adjunte registros

Los registros proporcionan información invaluable sobre los eventos y las relaciones de causa y efecto que afectan el comportamiento del software. Los registros documentan eventos durante la operación de software y hardware.

Cuando falla una carga de trabajo, los registros generalmente pueden arrojar luz sobre lo que estaba haciendo la carga de trabajo antes de que fallara. Por ejemplo, el software intentó una determinada operación de almacenamiento en el entorno y los registros muestran que el recurso de almacenamiento deseado no estaba disponible. Estos datos de registro ofrecen una pista sólida de que los desarrolladores deben implementar mejores rutinas de manejo de errores. Del mismo modo, los archivos de registro contienen detalles sobre los errores de excepción del procesador que provocan caídas de software y otra información del entorno de operaciones.

El personal de soporte y control de calidad debe adjuntar todos los archivos de registro disponibles al ticket de seguimiento de problemas del informe de errores del software. Los marcos de gestión de sistemas, que incluyen software de gestión del rendimiento de aplicaciones y otras herramientas, ofrecen una fuente común para varios archivos de registro.

El software en desarrollo también puede generar registros directamente. Los desarrolladores pueden agregar instrumentación y funciones de registro directamente en las compilaciones de software. El registro interno produce registros granulares sobre comportamientos críticos, como la red sensible a la latencia o la actividad de procesamiento. Estos registros también pueden activar registros de cualquier error, como la entrada del usuario, el almacenamiento, el procesador y otras áreas de fallas comunes.

2. Entre en los detalles necesarios

Antes de que un desarrollador pueda remediar cualquier error de software, debe reproducir con éxito el problema informado. Esta tarea puede ser más difícil de lo que parece, y los desarrolladores pueden pasar por alto o ignorar problemas que no pueden reproducir con éxito.

Si bien muchos defectos son obvios, como la falta de ortografía del menú, otros solo aparecen en procesos específicos o bajo ciertas circunstancias. Para esta situación, un informe de error de software eficaz debe incluir una serie de detalles que pueden ayudar a los desarrolladores a comprender con precisión lo que estaba ocurriendo en el momento del incidente.

Para escribir un buen informe de error de software, comience con un resumen ejecutivo que resalte el problema y su impacto. Luego, describa el evento en detalle y evalúe la gravedad del defecto. Incluya pasos detallados necesarios para reproducir el problema. Además, el informe puede presentar resultados reales versus resultados esperados: lo que hizo el software y lo que debería haber hecho.

Un buen informe de errores de software también debe incluir detalles de configuración, como la versión del software que se está probando e información sobre la plataforma que ejecuta el software, como se detalla en la sección 5. Las diferencias en la plataforma pueden ayudar a explicar o identificar problemas relacionados con hardware incompatible o un firmware no deseado o una versión de controlador.

3. Incluya capturas de pantalla

Una imagen vale más que mil palabras. Cuando un desarrollador realmente puede ver el manifiesto del problema, proporciona un recurso invaluable y mejora la credibilidad del probador. Adjunte cualquier archivo de imagen relevante al informe de defectos junto con otra información.

Las capturas de pantalla son más valiosas para errores en la interfaz de usuario, diálogos de error incorrectos o inesperados, problemas gráficos y otros problemas visuales. Por otro lado, no todos los defectos se benefician de una imagen, y una captura de pantalla puede no mostrar la existencia de problemas profundos o internos. Por ejemplo, los elementos de entrada de datos en una interfaz de usuario deben proporcionar la seguridad adecuada en términos de manejo de errores y protección contra actos maliciosos, cosas que una imagen podría no mostrar.

Muchas herramientas pueden tomar capturas de pantalla, incluso la sencilla utilidad Microsoft Paint ayuda a capturar una imagen. Algunas plataformas, como teléfonos inteligentes y tabletas, pueden requerir utilidades de terceros.

4. Comprenda el impacto del defecto

Al igual que sus contrapartes en el mundo natural, no todos los errores son igualmente aterradores. Un error ortográfico en un diálogo de texto tiene una prioridad radicalmente diferente a un error de excepción que bloquea el software o pierde datos valiosos. Es probable que los errores en las versiones de producción tengan mayor prioridad que los descubiertos en versiones anteriores o experimentales. Los desarrolladores y los equipos de respuesta a incidentes de TI se ocupan de muchos tickets de problemas, por lo que no esperen que aborden igualmente todos los defectos informados.

Un informe de error de software debe incluir una clasificación prudente y pragmática del defecto. Un sistema de clasificación de defectos ayuda en la organización y priorización del flujo de trabajo del desarrollador y el soporte de TI. Por ejemplo, un defecto de software que detiene el espectáculo irá directamente a la parte superior de la cola de un equipo de desarrollo, donde varios desarrolladores colaboran en una solución rápida. Los errores menos severos llamarán la atención una vez que los defectos de alta prioridad estén contenidos. Meras molestias, o problemas que tienen soluciones fáciles, podrían pasar a futuros lanzamientos de parches de rutina.