Introducción al Testing: La importancia de documentar

Buena parte de nuestro trabajo se basa en leer documentación y entenderla para luego poder desarrollar nuestro trabajo con total garantía. Al igual que tenemos que realizar este trabajo, nosotros mismos tenemos que guardar un tiempo en documentar lo que hacemos.


A la hora de trabajar en equipo, tenemos que tener claro que el mismo trabajo que estamos haciendo nosotros lo tienen que poder hacer nuestros compañeros en nuestra ausencia, por lo tanto es muy importante documentar los pasos ha realizar para, por ejemplo, montarse una serie de datos para realizar unas pruebas.

Uno de los primero documentos que tenemos que tener en cuenta es el montaje del entorno en nuestro ordenador (sobremesa o portatil), ya que si entra gente nueva en el equipo, podrá, rapidamente, instalarse todo lo necesario para poder probar. De esta manera las pruebas se realizarán en igualdad de condiciones y utilizando las mismas herramientas.

Este tipo de documentos, que deberían de ser tutoriales con capturas de pantalla y pasos detallados nos ayudarán a que nuestros compañeros realicen su trabajo más rápido o en el caso de ser nuevo, puedan agilizar esos primeros dias que son realmente pesados.

Despues del principal manual, tenemos que prestar atención a documentos de como montar los datos para realizar ciertas pruebas. En mi caso, para un simple módulo, hay que realizar unos complejos pasos antes que nos darán la solución y los datos necesarios para pasar las pruebas.

Este documento es muy importante ya que, en el caso de que no estemos por cualquier motivo, nuestros compañeros siguiendo unos sencillos pasos, mejorarán y agilizarán las pruebas, entregando más rapido los resultados y abordando más trabajo que si tienen que pensar como llevar a cabo el montaje.

Tenemos que prestar atención también a documentos genéricos que nos digan, por ejemplo, que cadenas de conexión necesitamos para una determinada BBDD, que usuarios son los que acceden a determinados entornos, que URL's de prueba tenemos o que herramientas o navegadores utilizamos. Muchas veces estas cosas no están documentadas y hay que estar preguntando constantemente a los demás hasta que nos montamos un entorno estable y completo.

Para que un documento sea verdaderamente util, como he dicho anteriormente, tiene que tener unos pasos claros y bien detallados y sobre todo capturas de pantalla en donde podremos comparar si estamos pulsando el botón correcto o rellenando la linea de código que debe de ser.
 
Actualmente, una de las herramientas estrellas para documentar es Confluence, que nos permite dinamizar la información y que todas las personas se sientan partícipes de la misma. Con ello, realizaremos un acercamiento importante para que el equipo pueda realizar este tipo de acciones.
 
La documentación, es uno de los puntos fuertes de cualquier proyecto y en Testing es una piedra angular en nuestro método y forma de trabajo ya que dependemos de ella para que nuestras pruebas se realicen con total garantía y excelencia.

Actualmente, una de las herramientas más utilizadas para documentar con un acercamiento hacía BDD y desarrollo, es el uso de gherkin, que como lenguaje natural, nos ayuda a realizar una serie de líneas documentadas donde se basarán las pruebas unitarias que garantizarán los desarrollos, previamente a que lleguen a nosotros.

Desde aquí, os animamos a buscar la mejor manera de documentar toda la información de los proyectos y que ayude a las personas que trabajan en él o las que lleguen nuevas y tengan una base de consulta para que la curva de aprendizaje descienda drásticamente.Toda documentación es poca y los beneficios que nos aporta es impresionante, ¡no la dejes de lado!