Cómo escribir informes efectivos de

defectos de software

Escribir informes de defectos de software fáciles de leer, detallados y

completos es una habilidad esencial para el aseguramiento de la calidad,
los desarrolladores y el personal de soporte. Todos los miembros del
equipo de desarrollo de software deben tomarse en serio sus informes de
defectos, proporcionando una investigación exhaustiva e informes
detallados para que el trabajo de desarrollo sea más fácil y más
productivo. Aquellos que escriben informes de defectos grandes
obtendrán credibilidad y respeto de sus compañeros de desarrollo de
software.

A continuación se detalla cómo ser un escritor excepcional de informes

de defectos . A continuación, he desglosado cada paso en direcciones
específicas y ejemplos que se asemejan a la complejidad de las
situaciones reales de trabajo de desarrollo de software.

Pruebas en la era ágil: mejores herramientas y procesos

OBTENER INFORMES

SIGUIENTE
El estado de la administración de entrega de aplicaciones: 4 puntos
de entrega
Linda Rosencrance
19 de junio de 2018
SIGUIENTE
Cómo tomar un enfoque de sistemas para las pruebas de
aplicaciones móviles
Jean Ann Harrison
18 de junio de 2018

La lista de verificación del informe de

defectos
Su lista de verificación del informe de defectos debe incluir estos cuatro
elementos:

Definir el defecto

 Indique la plataforma y la versión

  Inicie sesión y examine los datos
(cliente, paciente, programa
seleccionado)

 Enumerar cualquier configuración de

configuración no estándar con valores

 Indique la dirección del flujo de trabajo

a través de la aplicación

Investigue para reducir la causa raíz y superar el síntoma del

defecto

 Vuelva a probar hasta que tenga los

pasos exactos en el orden correcto para
reproducir el defecto

 Defina quién, qué, dónde, cuándo y

cómo encontró el defecto

 Ejecutar consultas de bases de datos

 Escanear registros de errores

 Si el defecto es intermitente, dígalo

Añadir documentación de soporte

 Capturas de pantalla

 Vídeo
  Paso grabando archivos

 Datos de registro de error

 Resultados de consulta de base

Formatee todo el texto para que sea legible y fácil de entender

 Mantener un formato conocido y

familiar cuando sea posible

 Lista usando listas numeradas o con

viñetas

 Mantenga descripciones textuales

sucintas y directas

 Hechos solamente; sin opinión, sin

sugerencias, sin acusaciones, sin culpa

Paso 1: defina el defecto

El primer paso es definir el defecto escribiendo un resumen en el título
del defecto y proporcionando una descripción general del problema. Al
escribir un resumen en el título del defecto, incluya el área y la función
donde ocurre el problema. ¿Por qué? Porque la mayoría de las
aplicaciones están altamente integradas y, por lo tanto, son
complejas. Además, no puede suponer que los desarrolladores u otros
revisores de defectos saben cómo funciona la aplicación en todas las
instancias.

Por ejemplo, he encontrado un defecto en una aplicación de

administración de medicamentos; un usuario puede ingresar un
medicamento que el registro del paciente mostró una alergia grave a. El
botón de alergia no se resalta en rojo para indicar visualmente la alergia
y, lo que es peor, permite al usuario ingresar la misma medicación en
cuestión, independientemente.

En mi título de resumen, entraré en el área y la función general:

El botón de alergia no está resaltado en rojo y el

usuario puede ingresar el medicamento.

Esta es una breve declaración del problema en una oración concisa y

comprensible. A continuación, debe agregar una breve descripción en el
cuerpo del informe de defectos:

El botón de alergia no se resalta en rojo cuando se

guarda una alergia en el registro del
paciente. Además, la entrada a la alergia está
configurada para impedir la entrada de
medicamentos de la medicación que interactúa. El
usuario puede ingresar y guardar el medicamento al
que el paciente es alérgico.
La descripción irá seguida de detalles adicionales, así que mantenla breve
y al grano. Puede ser lo único que muchos revisores leen, por lo que es
esencial describir el problema de manera efectiva.

Paso 2: investiga la causa raíz

La investigación significa asegurarse de que el defecto sea realmente un
defecto. Deberá verificar la configuración, la configuración del paciente,
la configuración del usuario, cualquier elemento de la aplicación que
afecte su funcionamiento. Haz tu mejor esfuerzo para asegurarte de haber
establecido una base precisa. Busque las instrucciones de registro de
errores, si es posible.

Asegúrese de agregar cualquier investigación realizada al final de su

informe de defectos en un formato de nota. Por ejemplo:

NOTA: Configuración configurada para bloquear la

entrada de medicamentos cuando existe una alergia
relacionada en el registro del paciente,
independientemente del valor de gravedad. El
usuario es un MD con acceso completo. La tabla de la
base de datos muestra el valor de alergia correcto en
el paciente. No se generaron errores en el registro de
errores.
Las "notas" son buenas formas de comunicar a los desarrolladores qué
investigaciones ha realizado para que puedan determinar dónde deben
comenzar.

Paso 3: agrega la documentación de

respaldo
Agregue o adjunte un archivo grabador de pasos o un video del defecto
siempre que sea posible. Si está utilizando productos de Microsoft, hay
una aplicación gratuita de Grabadora de pasos que puede usar para
solucionar el problema. Creará una captura de pantalla por captura de
pantalla de donde hizo clic y la ubicación del código. Esto ayuda a los
desarrolladores a resolver el problema de manera más eficiente. Además,
enumere cualquier resultado de consulta de base de datos o archivos de
registro de errores. De manera similar a agregar una nota, esto brinda
respaldo para que el defecto exista y no es solo un problema de UI. Los
cinco tipos de documentación de respaldo que se debe considerar son:

 Archivos de Microsoft Step Recorder

 Video grabado de los pasos que toma y

la reacción de la aplicación (elija entre
varios programas de video gratuitos
disponibles en línea o simplemente use
su teléfono inteligente)
  Consulta de la base de datos y captura
de pantalla de los resultados

 Capturas de pantalla o texto completo

de mensajes de error en la descripción
o como archivo adjunto

 Registros de errores, que existen para

la mayoría de las aplicaciones,
independientemente de si son móviles,
web o heredadas; adjunte una copia del
registro o copie y pegue el texto en su
descripción; asegúrese de identificar
qué archivo de registro, si hay más de
uno

Paso 4: formatee su informe para una

alta legibilidad
Proporcionar un formato comprensible hace que su defecto sea más fácil
de revisar y más probable que sea aceptado. Formatee el texto del defecto
separándolo en las siguientes secciones:

 Resumen (título)

 Descripción

 Build / plataforma
  pasos para reproducir

 Resultados previstos

 Resultados actuales

 Investigación

 Documentación de soporte

La sección "compilación / plataforma" es opcional, dependiendo de la

aplicación que se prueba. Incluya esta sección cada vez que la aplicación
se ejecute en más de una plataforma o navegador, y tenga en cuenta la
versión específica. En el siguiente ejemplo completo, agrego la versión
exacta del navegador y, si corresponde, la plataforma.

La sección "pasos para reproducir" debe ser precisa. Si no puede

reproducir el defecto todas las veces, inclúyalo en el informe. Repita los
pasos para reproducir varias veces y verifique que tenga los pasos y
acciones correctos en el orden correcto que sean necesarios para
reproducir el defecto. Al escribir los pasos para reproducir, tenga en
cuenta que los desarrolladores pueden no saber cómo funciona la
aplicación general. Bríndeles pasos detallados pero concisos para que
puedan reproducir el defecto. Por ejemplo:

S etup: Establecer la configuración de la alergia a

Bloquear siempre y guardar.

Inicie sesión como usuario de MD con acceso

completo.
 Seleccione un paciente con una alergia existente y
salvada a la penicilina.

Ver el botón de alerta de alergia en la esquina

superior derecha.

Ingrese un pedido de medicamento para la

penicilina, q4h por 30 días. Salvar.

Sé directo y al grano. Si son posibles varias formas de realizar una

acción, asegúrese de anotar cuál utilizó. Por ejemplo:

Haga clic en el botón Ingresar medicamento del

menú principal para agregar un medicamento. Use la
ventana Buscar / Seleccionar para elegir
penicilina. Haga clic en Aceptar en la ventana
emergente para confirmar la selección del
medicamento .

Ejemplo completo de informe de

defectos
El siguiente es un ejemplo de texto completo de un informe de defectos:

Resumen
El botón de alergia no está resaltado en rojo y el usuario puede ingresar
el medicamento.

Descripción
El botón de alergia no se resalta en rojo cuando se guarda una alergia en
el registro del paciente. Además, la entrada a la alergia está configurada
para impedir la entrada de medicamentos de la medicación que
interactúa. El usuario puede ingresar y guardar la medicación a la que el
paciente es alérgico.

Construir / Plataforma
Windows 10 / IE 11.5.1 / OS X Yosemite / Safari 10.0.3

pasos para reproducir

1. Configuración: configure la
configuración de alergia a SIEMPRE
BLOQUEAR y guardar.

2. Inicie sesión como usuario de MD con

acceso completo.

3. Seleccione un paciente con una alergia

existente y salvada a la penicilina.

4. Ver el botón de alerta de alergia en la

esquina superior derecha.
 5. Ingrese un pedido de medicamento
para la penicilina, q4h por 30
días. Salvar.

Resultados actuales
El botón de alergia no se actualiza y se pone rojo para alertar a los
usuarios sobre la presencia de una alergia y permite al usuario agregar el
medicamento aunque la alergia esté en el registro del paciente.

Resultados previstos
El botón de alergia se actualiza automáticamente cada vez que se ingresa
y guarda una nueva alergia. El botón se vuelve rojo para indicar que
existe una alergia para el paciente. El usuario de MD no puede guardar
un pedido de medicamento en el registro del paciente cuando la alergia
está presente. La configuración de ALWAYS BLOCK permite bloquear
el pedido de medicamentos independientemente de la gravedad de la
alergia.

Evidencia y documentación de respaldo

Vea la flecha roja en la captura de pantalla de muestra a continuación. El
botón de alergia debe mostrar dónde se dibuja el rectángulo rojo.

NOTA: Configuración configurada para bloquear la entrada de

medicamentos cuando existe una alergia relacionada en el registro del
paciente, independientemente del valor de gravedad. El usuario es un
MD con acceso completo. La tabla de la base de datos muestra el valor
de alergia correcto en el paciente. No se generaron errores en el
registro de errores.

Sea un escritor excepcional de

informes de defectos
Revise el informe de defectos completo antes de enviarlo. La
credibilidad de los miembros del equipo de desarrollo mejora cuando los
defectos son claros, concisos y reproducibles. Si menciona un archivo
adjunto, asegúrese de agregarlo. Tenga en cuenta en la descripción si
puede o no reproducir el error a voluntad, o solo en ciertas compilaciones
o plataformas. Sea conciso y directo, e incluya solo hechos relevantes
sobre defectos.

Obtenga más información sobre la

escritura de informes y el
descubrimiento de defectos
Ahora que ha aprendido cómo escribir un informe de defectos, consulte
la información en el sitio web de la Junta de calificaciones de pruebas de
software de Estados Unidos ( ASTQB ) , que proporciona certificaciones
de pruebas de software múltiples. ASTQB ofrece un programa detallado
que incluye una larga lista de libros, artículos y otros recursos.
Finalmente, una vez que esté al tanto de los principios básicos de la
notificación de defectos, aquí es donde puede obtener más información
sobre las técnicas de prueba exploratorias, que son las formas más
eficaces de detectar los defectos para informar en primer lugar.

 Pruebas exploratorias de software:

consejos, trucos, recorridos y técnicas
para guiar las pruebas , por James A.
Whittaker

 Escribir informes de defectos de

software que obtienen buenos
resultados, aumentar la credibilidad

 Los pros y los contras de compartir

pruebas de control de calidad con los
clientes

 ¿Pruebas de software para aplicaciones

complejas e integradas? Ir modular!

 Técnicas de prueba exploratorias:

encontrar defectos de software usando
creatividad y diligencia
 Encontrar más defectos con pruebas
exploratorias ágiles