Documentación técnica.

La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones.
La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación.
Tipos de documentación.

La documentación se divide en dos categorias: interna y externa.

• Interna: Es aquella que se crea en el mismo código, en forma de comentarios o de archivos de información dentro de la misma aplicación.
• Externa: Es la que se escribe en cuadernillos o libros, totalmente ajena a la aplicación en sí.

Una vez concluido el programa, los documentos que se deben entregar son una guía técnica, una guía de uso y de instalación.

Guía técnica.
Tambiérn llamado manual técnico, aquí se reflejan el diseño del proyecto , la codificación de la aplicación y las prueba realizadas para su correcto funcionamiento. Por lo general este apartado está reservado para personas que tienen conocimiento en informatica como los programadores. Su principal objetivo es es facilitar el desarrollo, corrección y futuro mantenimiento  de la aplicación. Está compuesto por tres apartados:

• Cuaderno de carga: Se refleja la solución o diseño de la aplicación, está diseñado únicamente para programadores.
• Programa fuente: Es donde se incluye la codificación realizada por los programadores. Debe de ser claro para su comprensión así como para un futuro mantenimiento y desarrollo.
• Pruebas: Es donde se específican el tipo de pruebas que se realizarón durante todo el proyecto así como los resultados obtenidos.

Guía de uso.
Es a lo que comunmente se le llama manual de usuario, contiene información para que el usuario utilice correctamente la aplicación. Sale de la guía técnica, solo que se suprimen los tecnisismos para que el usuario (generalmente no experto en informática) pueda entender el documento. En el caso en el que sea necesario incluir algún tecnisismo, es necesario poner al final de dicha guía un glosario para su mejor compresión.

Guía de instalación.
Es la guía que contiene la información para la implementación de la aplicación. Dentro de este documento se encuentran las instrucciones para la puesta en marcha del sistema y las normas de utilización de éste. Dentro de las normas de utilización se encuentran las normas de seguridad, tantoa las físicas como las de acceso a la información.




Javadoc.
Javadoc es una herramienta de Sun para documentar el código mediante comentarios, pero a la vez provee una herramienta que permite extraer esa documentación de forma que sea útil para el usuario de la misma.
Básicamente javadoc es un programa, que toma lo comentarios que se colocan en el código con marcas especiales y construye un archivo HTML con clases, métodos y la documentación que corresponde. Este HTML tiene el formato de toda la documentación estándar de Java provista por Sun.
La documentación a ser utilizada por javadoc se escribe en comentarios que comienzan con /** (notar el doble *) y que terminan con */. A la vez, dentro de estos comentarios se puede escribir código HTML y operadores para que interprete javadoc (generalmente precedidos por @).

Para generar la documentación técnica de mi proyecto, utilizare javadoc, ya que el lenguaje de programación que estoy utilizando es java.

Referencias:
http://www.desarrolloweb.com/articulos/importancia-documentacion.html
http://luauf.com/2008/06/17/documentando-con-javadoc/
http://gpd.sip.ucm.es/rafa/docencia/programacion/tema1/javadoc.html