¿Como documentar aplicaciones?

[kafok]

Hola, soy estudiante en ingeniería de software y acaban de empezar mis vacaciones :)
Ahora que tengo tiempo libre me gustaria dedicarme a desarrollar algunas aplicaciones que tenia en mente y planificandolo todo me di cuenta de que documentarlas luego iba a ser un problema. Me gusta mucho el formato web, no un documento como un PDF, y crear un doumento en HTML es algo laborioso. Mi pregunta es, ¿Existe algo que genere HTML automaticamente, como doxygen para el codigo, pero para una aplicacion final? O en su defecto, recomiendenme algo que me pueda servir

[AlvaroG]

Todo depende de qué tipo de documentación estés intentando crear.

Si querés un "manual de usuario", creo que lo ideal es un formato web, lo cual no quiere decir que tengas que lidiar con HTML. Podés perfectamente usar reST, o Markdown, que son formatos de texto plano, y luego convertirlo a mútiples formatos finales (HTML, PDF, etc).

Si querés una documentación de la API, cada lenguaje tiene su forma favorita, por ejemplo Javadoc para Java, o Pydoc en Python. Todos estos sistemas permiten también generar la documentación en varios formatos.

[kafok]

Eso me refiero, a un manual de usuario, porque para codigo doxygen va de maravilla. Y quisiera algo que facilitara las cosas tal como hace doxygen.

[Carlangueitor]

Pues Markdown es de lo que más se suele usar para eso.

Saludos