~Documentación Técnica

Materia: Programación Orientada a Objetos


Hora: Jueves m1 - m3 




* Importancia de la Documentación Técnica


Un aspecto muy importante en el desarrollo de los programas es su documentación, pero muchos programadores no hacen eta parte del desarrollo y con esto no se da cuenta que pierde la posibilidad de la re utilización de parte del programa en otras aplicaciones.


La documentación de un programa comienza al momento de estarlo desarrollando y finaliza antes de la entrega del programa ya que todo lo que vayas desarrollando del programa tienes que mencionarlo en tu documentación. 


La documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación y una vez finalizado 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: en ella se encuentran el diseño del proyecto, la codificación de la aplicación y las pruebas realizadas para su correcto funcionamiento, su principal objetivo es facilitar el desarrollo, corrección y futuro mantenimiento del programa de una forma rápida y fácil.


* Guía de Uso: es llamado el manual de usuario y contiene la información necesaria para que los usuarios utilicen correctamente la aplicación, se expresa de forma que sea entendible para el usuario.


* Guía de Instalación: contiene la información necesaria para implementar el programa, dentro de este documento se encuentran las instrucciones para hacer funcionar el programa y las normas de utilización del mismo. En las normas de utilización se incluyen las normas de seguridad, tanto físicas como las referentes al acceso a la información.


Existen diferentes tipos de documentación que se le entrega al cliente y se divide en : 


* Documentación Interna: es la que se crea en el mismo código y puede ser en forma de comentarios o de archivos de información dentro de la aplicación.


* Documentación Externa: es la que se escribe en cuadernos o libros, es totalmente ajena a la aplicación en si, la ayuda electrónica forma parte de éste tipo de documentación. 






~Referencias:
* http://www.desarrolloweb.com/articulos/importancia-documentacion.html