Documentación de proyectos
lunes, mayo 12, 2008 at 11:54AM Hacer un proyecto puede ser divertido, entretenido o ameno para un programador. Pero documentarlo ya es harina de otro costal.
Muchas veces la documentación se hace tarde, mal y nunca.
Para ayudar un poco a hacer la documentación he encontrado un post en Linux.com que trata sobre usar un wiki para documentar un proyecto Open Source Using a wiki for FOSS application documentation.
En concreto se han decidido por dokuwiki y algún plugin que tiene.
Actualmente también estoy haciendo un proyecto open source, pero lo que me falta es documentación.
Así que hace unas semanas también me decidí por usar un wiki para documentarlo.
Lo de usar un wiki es fue porque:
- Lo tendré todo más organizado que usando ficheros de OpenOffice/Word
- También sirve como documentación para la web
- Es más facil que escribir html a pelo (Lo intenté y casi muero en el intento)
- Facilidad para escribir código fuente
- Quería aprender a usar un wiki
Y también me he decidido por dokuwiki.
La principal característica que yo le veo a dokuwiki es su sencillez de uso e instalación.
El proveedor de mi hosting usa apache+php y no puedo lanzar ningún script en su máquina. Así que necesitaba un wiki que fuera fácil de instalar y en php.
La instalación de dokuwiki es tan sencilla como copiar todos los archivos en un directorio de apache.
Otra de las opciones en las que pensé para documentar el proyecto fue usar OpenBook pero creo que es matar moscas a cañonazos. Y usar OpenOffice/Word me parecía demasiado rudimentario.
¿Que herramientas usáis vosotros para hacer la documentación?
Saludos
otro 
Reader Comments