« ¿Hacemos autocrítica? | Inicio | as2Api. Documentando proyectos 2 »

Dokuwiki. Documentando proyectos 1

Uno de los problemas que surgen cuando más de una persona trabaja en un proyecto, es el de la documentación. Sobre todo, si esta, o los briefings previos al proyecto, están sujetos a cambios constantes. Es frecuente entonces, que se produzcan situaciones como duplicidades de documentos, etc…

Cuando uno piensa en documentación, en documentación de proyectos, en listas de tareas a realizar etc… uno piensa en “centralizar”. Esto es, una documentación única, a la que todo el mundo tenga acceso y pueda modificar ( o al menos los implicados en el proyecto ), fácil de actualizar y de consultar. Que no de lugar a duplicidades de ficheros, ni a ficheros ( word, por ejemplo ) con nombres del tipo “documentación_v01” o “documentación_11_2_06 ) etc…

Con esto en mente, parece evidente que la mejor forma de llevar una documentación actualizada y actualizable es un wiki. Un “repositorio central de conocimientos”, accesible por todos vía la intranet, fácil por tanto de consultar, siempre actualizado en una misma url no importa cuantos cambios ( y realizados por quien ) haya, y fácil de modificar. Con las características habituales de un wiki, haciendo hincapié en un control de versiones, bloqueo mientras otro usuario edita, etc…

Decidida pues, la forma de documentar, toca la hora de decidir la herramienta. Cuando uno piensa en wiki, lo primero que le viene a la cabeza es MediaWiki , el wiki en el que está soportada la wikipedia

Sin embargo, y tras mirar y comparar ( no de un modo extremadamente exhaustivo, pero sí con ciertas pruebas, y buscando información, leyendo artículos etc.. ), la decisión fue por DokuWiki.


DokuWiki es un wiki sencillo de utilizar, pero con una serie interesante de características. Las que más nos gustaron son:

  • Puede trabajar ( esto se determina en un fichero de configuración ) contra una base de datos, o almacenando en archivos de texto
  • Control de versiones ( almacena las versiones anteriores de un documento )
  • Namespaces , permitiendo un almacenamiento ordenado y estructurado de los contenidos
  • Bloqueo para evitar cambios concurrentes
  • Upload de documentos e imágenes ( con posibilidad de reescalado de estas )
  • Administración sencilla. Varios posibles niveles de autentificación : sin identificar, mediante registro de usuario y contraseña, contra el LDAP
  • Perfiles de usuarios
  • Plantillas
  • Plugins numerosos, para bastantes cosas, como permitir todo tipo de archivos multimedia, RSS ( por defecto, dokuwiki viene con rss de las últimas modificaciones ), etc…
  • Lista de correo viva. Es decir, con bastante tráfico, y todos los meses, lo que indica que el proyecto está vivo, que contínuamente aparecen mejoras.

Para más información sobre DokuWiki, podéis acudir a la página del proyecto. También podéis acudir a alguna de las revisiones que hizo Juanjo Navarro cuando estudiaba qué wiki instalar en planeta código

instalar un wiki, mas sobre dokuwiki, Traducción de la sintaxis del wiki al castellano