Documentación

En próximos post explicaré de que trata mi proyecto final. Mientras tanto comentaré que la documentación del mismo es un problema muy grande para mi, supongo que para la mayoría el tema de la documentación es algo simple, pero para alguien tan desordenado como yo no lo es.

Mi objetivo es clasificar los documentos dependiendo de: a que etapa del desarrollo corresponde y que aspecto del sistema describe. También me interesa indicar que modificaciones sufrió el documento y cuando fue presentado a la cátedra.
Podría incluir todo en un único libro, el problema es que cuando se actualiza una sección, no quiero volver a imprimir todo para presentarlo.

He intentado un sistema de documentos rtf individuales por cada "artefacto" que debía presentar, pero la carpeta donde los almaceno ya esta tan desordenada como mi escritorio.

Ahora intentare utilizar DocBook para construir la documentación. Cito del Tutorial de DocBook de Jaime Irving Dávila:
DocBook es un dialecto de SGML que permite la escritura de documentación técnica y que día a día gana más adeptos dentro de la comunidad del software libre y de fuente abierta. Prueba de ello es que la documentación de Gnome, KDE, FreeBSD y LinuxDoc esté realizada con dicho formato. De igual forma existen empresas que usan dicho para formato para generar su documentación, cómo son los caso de Cogent y Mitel NSSG.
y de la Wikipedia:
Norman Walsh y el equipo de desarrollo del DocBook Open Repository mantienen un conjunto de hojas de estilo DSSSL y XSL para generar versiones PDF y HTML de documentos DocBook (así como para desarrollar otros formatos, incluyendo páginas de referencia man y de ayuda en HTML).
Las ventajas mas obvias, en mi caso, serían que puedo olvidarme de formatear los documentos y que fácilmente voy a poder crear versiones de los mismos para publicar en este blog.

El problema mas grave es que tengo que aprender demasiadas cosas, no solo la sintaxis de DocBook, sino muchas otras, por ejemplo a usar emacs que me parece la mejor opción para la edición de los fuentes.

Ya les diré como me fue: el lunes 10/9 tengo una auditoria donde debo presentar los avances en el desarrollo.