Documentación ágil: usar un wiki

23-01-2006 Luis Artola

Si definimos la agilidad, dentro del desarrollo de software, como la rapidez al responder a un cambio (en los requisitos, por ejemplo) estaremos de acuerdo en que, en multitud de ocasiones, tardamos en responder a un cambio en el software porque tenemos que estar modificando toneladas de documentación. La documentación, cuyo objetivo debería ser facilitar el desarrollo del software aportando información importante sobre el mismo, se convierte en un engorro que cuesta mantener actualizada, sin contar con que seguramente deba ser una información accesible por todo el mundo, con control de versiones y de concurrencia (para que dos personas no modifiquen un documento a la vez).

Los wikis son una herramienta de documentación colaborativa excelente. En general permiten control de versiones, control de concurrencia sobre un mismo documento y ponen toda la información accesible a través de la web. Además, te permite crear documentación con cierto estilo (negritas, cursivas, listas …) para que ésta sea legible.
¿desventajas? Quizás ciertos problemillas a la hora de imprimir o crear un documento “off-line” (que desees, por ejemplo, enviar por mail a un cliente). Aún y todo se están trabajando en diferentes proyectos que tratar de permitir la conversión de wikis a pdf con cierta calidad y opciones de configuración.

De todas formas una cosa es clara: un wiki es una herramienta sencilla que te hará más ágil. Si te sirve una solución fácil de desplegar y en PHP yo recomiendo DokuWiki que ni siquiera usa base de datos. Sencillez y potencia.