Te transcribo (ya que esta bien escrito ahi) de un libro de desarrollo, los fundamentos para una buena documentacion tecnica.
Cita: Un manual completo debería ser diseñado como un libro pequeño, con los siguientes temas:
· Introduccion
· Tabla de contenidos
· Guia del usuario
· Documentacion tecnica
· Guia del desarrollador
· Lista completa de las funciones
La guia del usuario debera describir detalladamente todas las caracteristicas de la interfaz de su aplicacion (si tiene alguna) para un usuario medio. No sea demasiado tecnico en esta seccion, ya que deberia ser una descripcion del tipo "como hacer". Asegurese de que se describe cada aspecto con detalle. La documentacion tecnica deberia escribirse para los usuarios y administradores interesados en los aspectos tecnicos y deberia contener los requisitos tecnicos de su aplicacion, normas utilizadas e introducidas, asi como informacion sobre el proceso interno de datos, si fuera de algun interes para el lector, y, por supuesto, su permiso de licencia. Si va a permitir a los clientes que vean y/o modifiquen el codigo fuente, incluya una guia del desarrollador para explicar la estructura del proyecto, el flujo de datos y las relaciones internas, asi como una lista de todas las funciones (incluidas las funciones internas) junto con una descripcion completa.
Espero que te sea util.
Saludos.
<div align="right">Guerrillero del ERF</div><div align="right" style="font-family:Verdana;font-size:10px">Sin utopía la vida sería un ensayo para la muerte.</div>