jueves, 25 de octubre de 2012

El problema de la documentacion

Cuando se esta desarrollando un proyecto aparece la informácion mas importante de todas: como se ha afrontado un problema, detalles sobre tareas especificas (por ejemplo, este expediente es valido si es de tipo A y B y la fecha de expiracion es menor que la fecha actual + el parametro ... a que te suena?), etc.. Esta informacion es la mas importante pero no queda reflejada en ningun sitio ya que, en la inmensa mayoria de los casos, no queda reflejada en ningun sitio. Solo queda reflejado en el "conocimiento popular" de los miembros del proyecto que estan todo el dia con el desarrollo. Esto plantea una serie de problemas:


  • No hay axima fijo para todos. La informacion queda recogida por cada miembro del equipo y su libre interpretacion por lo que al final tenemos varias verdades muy parecidas sobre el mismo asunto.
  • Si un miembro del equipo se va entonces la informacion se pierde.
  • Con el tiempo las cosas se olvidan y se degrada la informacion.
¿Entonces la solucion seria dejar reflejada la informacion en documentos? Esta seria la opción mas logica pero tambien plantea una serie de problemas de peso:

  • El sistema de informacion varia de forma y de tamaño con mucha rapido por lo que mantener actualizada la documentacion resulta dificil. Y no solo el problema es mantenerlo "rapido" es que encima todos los miembros del equipo tendrian que volver a leerlo TODO "rapido" y con mucha frecuencia.
  • Es una tarea dificil documentar ya que hay que expresarse de una manera que no sea demasiado tediosa (ya que si no el lector se cansara de leer) y que no sea demasiado abreviada (ya que si no el lector no se enterara).
Al final, la opcion que se toma es ¿Por que documentar si le puedo preguntar a alguien o lo puedo mirar en el codigo?