Tanto si tienes que documentar a posteriori como si lo haces a priori (que es lo ideal), te recomiendo MagicDraw [magicdraw.com]. No es software libre, y no se si eso realmente te importa, pero merece la pena, y la licencia no es demasiado cara.
Es muy productivo, te recomiendo que al menos pruebes la versión community (es gratuita) y tu mismo verás lo rápido que se trabaja.
Y si lo usas a priori, además tiene la ventaja de soportar generación de código y round-trip, es decir: una vez que tienes diagrama y código, si actualizas el diagrama te sincroniza el código, y si modificas el código, te actualiza el diagrama.
Incluso tiene ingeniería inversa de diagramas de secuencia (es decir, se generan a partir del código tambien), que es una funcionalidad poco habitual y ahorra mucho trabajo.
Para escribir manual de usuario yo trabajo con latex [latex-project.org]. Escribo toda la documentación con kile [sourceforge.net] (editor de latex) e incluyo los diagramas de magicdraw en formato vectorial. Inkscape [inkscape.org] ayuda bastante cuando hay que hacer diagramas que no son UML. Y con latex2html [latex2html.org] mantengo una versión navegable online del manual, para utilizar más en plan referencia mientras trabajas.
Para el manual de referencia con la documentación de los API, utilizo doxygen [stack.nl].
Esta es mi forma de trabajar, y resulta bastante bien incluso trabajando en equipo.
--
Los libros son las abejas que llevan el polen de una inteligencia a otra. James Lowell
Yo recomiendo
(Puntos:2)( http://pinguino.dyndns.org/ )
Es muy productivo, te recomiendo que al menos pruebes la versión community (es gratuita) y tu mismo verás lo rápido que se trabaja.
Y si lo usas a priori, además tiene la ventaja de soportar generación de código y round-trip, es decir: una vez que tienes diagrama y código, si actualizas el diagrama te sincroniza el código, y si modificas el código, te actualiza el diagrama.
Incluso tiene ingeniería inversa de diagramas de secuencia (es decir, se generan a partir del código tambien), que es una funcionalidad poco habitual y ahorra mucho trabajo.
Para escribir manual de usuario yo trabajo con latex [latex-project.org]. Escribo toda la documentación con kile [sourceforge.net] (editor de latex) e incluyo los diagramas de magicdraw en formato vectorial. Inkscape [inkscape.org] ayuda bastante cuando hay que hacer diagramas que no son UML. Y con latex2html [latex2html.org] mantengo una versión navegable online del manual, para utilizar más en plan referencia mientras trabajas.
Para el manual de referencia con la documentación de los API, utilizo doxygen [stack.nl].
Esta es mi forma de trabajar, y resulta bastante bien incluso trabajando en equipo.
Los libros son las abejas que llevan el polen de una inteligencia a otra. James Lowell