Documentación en Testing: Claves para una buena práctica

Documentar en testing es crucial porque nos permite dejar constancia de lo que hemos probado y cómo lo hicimos. Una buena documentación asegura que cualquier persona, ya sea un miembro del equipo actual o alguien en el futuro, pueda entender fácilmente los pasos seguidos en un caso de prueba.

¿Cómo podemos crear una documentación clara y efectiva?

1. Escribe con Claridad y Precisión

Lo más importante al documentar un caso de prueba es pensar en que otra persona debe entender lo que escribiste. Además, podrías necesitar revisar esta documentación en el futuro, por lo que es esencial que sea clara y precisa.

• Uso de Tiempos Verbales: Generalmente, se recomienda escribir los casos de prueba en tiempo presente para describir los pasos a seguir. Sin embargo, para notas o comentarios sobre la ejecución del caso de prueba, utiliza el tiempo pasado. Para el resultado esperado, utiliza frases claras como "Resultado esperado: SI" o "Resultado esperado: NO", según corresponda.

• Primera Persona del Plural: Es adecuado usar la primera persona del plural ("nosotros") para reflejar que el proceso es un esfuerzo colaborativo. Por ejemplo: "Debemos ingresar 'X' información en el formulario".

2. Incorpora Capturas de Pantalla

Las capturas de pantalla son fundamentales para ilustrar los pasos y resultados de las pruebas. Como regla general, incluye al menos una captura por caso de prueba. Sin embargo, en proyectos con limitaciones de tiempo, omite capturas para pasos que sean intuitivos para el usuario. Por ejemplo, si el paso indica hacer clic en un botón, simplemente detalla el nombre del botón sin necesidad de una captura.

3. Simplicidad y Accesibilidad

Intento mantener la documentación lo más sencilla posible. Cuanto menos complicada sea, mejor. Recuerdo una expresión que decía un compañero de trabajo: "Tómalo con calma y hazlo fácil". Esta filosofía ayuda a mantener la documentación clara y útil.

4. Documentación como Manual del Sistema

La documentación de testing no solo sirve para registrar las pruebas realizadas, sino que también puede funcionar como un manual del sistema. Aunque pueda tomar un poco más de tiempo inicialmente, a largo plazo puede ahorrar tiempo y esfuerzo al proporcionar una referencia útil.

5. Aplicación en Desarrollo

Muchos de estos principios también son aplicables a la documentación realizada por desarrolladores. La claridad, la simplicidad y la inclusión de elementos visuales son prácticas recomendadas que benefician a todo el equipo.

¡Quiero escuchar tu opinión!

¿Quieres agregar algo más para mantener una buena documentación? ¡Los leo!