El gran quebradero de cabeza de la documentación de un proyecto no es hacer la propia documentación ni que los miembros del proyecto la lean; el gran problema de la documentación es lo fácilmente que se queda desfasada. Es muy frustrante para los miembros de un equipo que se le pida que siga un documento y cuando lo ha hecho y empieza su trabajo basándose en ese documento que le digan:”Umm.. es que eso está mal..” ó “puff, pues di que eso no cambio hace tiempo…”.
La forma de evitar esto es:
1 º Hacer pruebas automáticas. Software que solo sirve para probar una casuística en concreto de la aplicación. Toda versión de la aplicación que está desarrollando el equipo debe pasar las pruebas para considerarse correcta.
2º Documentar esas pruebas en los propios ficheros fuente de la aplicación.
De esta manera, al estar siempre las pruebas actualizadas ya que si no lo están no se puede generar versión, la documentación de las pruebas también lo estará y además siempre es más ameno leer documentación siguiendo ejemplos (las propias pruebas).
Si se desea una documentación mas “presentable” (por ejemplo, un fichero word) siempre se puede generar a partir de los comentarios de las pruebas. Pero no hay que olvidar que la fuente de documentación son los fuentes de las pruebas y que el documento presentable es un producto generado a partir de los comentarios de las pruebas.
No hay comentarios:
Publicar un comentario