Documentacion Tecnica.

La Documentacion es un proceso importante dentro de todo desarrollo de software porque permite conservar la historia, facilita la utilización por parte del usuario, garantiza la permanencia y disminuye los costos de operación y de ejecución del proyecto como tal. Tambien podria definirse como la informacion que nos dice qué hacen los sistemas, cómo lo hacen y para quién lo hacen. 

 La documentacion tecnica implica dos tipo de documentacion la interna y la externa, la documentacion Interna se refiere mas a los programas y la base de datos, y la Externa se refiere a los manuales de uso.

La documentación interna se encuentra dentro del código de la aplicación, especificando la descripción de cambios realizados, fecha, responsable, autorización y cualquier otro dato relevante. 

El software debe contener documentación interna. Los comentarios permiten al programador comunicarse con otros lectores do código fuente. Los comentarios pueden también resultar una clara guía de comprensión durante la última fase de la ingeniería de software –el mantenimiento -.

Importancia de la Documentacion.

La documentación adecuada y completa, de una aplicación que se desea implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema de Información, sin embargo, frecuentemente es la parte a la cual se dedica l menor tiempo y se le presta menos atención.

Nosotros como desarrolladores tenemos la obligación de proporcionar a nuestros clientes un documento claro y conciso donde explicamos al funcionamiento de nuestro software; esta será una futura referencia para todos aquellos que quieran ayudarnos a mejorar nuestro software y para guiarlos y que entiendan la visión que tuvimos al momento de construirlo; incluso será una referencia para nosotros mismos ya que en códigos extensos es imposible recordar para que funcionaba y que acción realizaba un segmento de nuestro código.

Referencias.  

Documentacion de Software

Documentacion Interna
Imagen