2.Metodología de Solución de Problemas   2.Metodología de Solución de Problemas  Subsecretaría de Educación Superior

Santiago Ramirez Ameyali Alvarez Blas Roberto Lopez Limones Claudio   Dirección General de Educación Superior Tecnológica INSTITUTO TECNOLÓGICO DE SALINA CRUZ MATERIA: FUNDAMENTOS DE PROGRAMACION TEMA:   Documentación (manuales).  EQUIPO 6: Santiago Ramirez Ameyali Alvarez Blas Roberto Lopez Limones Claudio Garcia Terán Jonathan Carballo Soriano Elias SEMESTRE Y GRUPO: 1o E1 CARRERA: ING. TECNOLOGIAS DE INFORMACION Y COMUNICACIONES SALINA CRUZ, OAXACA A 16 DE SEPTIEMBRE DEL 2012. Subsecretaría de Educación Superior

Introducción Durante la etapa de nuestra vida cotidiana nos enfrentamos a diversos problemas. Algunos de esos problemas podemos solucionarlos fácilmente, ya que en otros se nos complican de tal forma que nos afecta de manera profunda. Para resolver problemas, estructurados utilizando la computadora es importante utilizar un método. Las 6D’ consta de una serie de pasos y una de ellas es la DOCUMENTACION para la solución de problemas.

Documentación La documentación consta de las descripciones de los pasos a dar en el proceso de un problema. La importancia de la documentación es por su decisiva influencia en el producto final. Los programas pobremente documentados son difíciles de leer, más difíciles de depurar y casi imposibles de mantener y modificar. Por ello la importancia de la documentación, sin la documentación es imposible corregir errores futuros o bien cambiar el programa.

También el mantenimiento se define como la modificación del programa por medio de actualizaciones, que mejoran al programa, corrigiendo errores o bien actualizándolos para un mejor funcionamiento. Por ello la documentación es sin duda muy importante para poder llevar a cabo el mantenimiento. Es esta etapa del mantenimiento la documentación la cual va a servir como base para la elaboración del manual técnico. dedicarle tiempo a esta etapa nos ayudara a desarrollar buenos hábitos, los cuales serán necesario cuando se desarrolle software en forma profesional.

Documentación  Es la guía o comunicación escrita que sirve como ayuda para usar un programa, o facilitar futuras modificaciones. A menudo un programa escrito por una persona es usado por muchas otras, por ello la documentación es muy importante; ésta debe presentarse en tres formas: EXTERNA, INTERNA y AL USUARIO FINAL. 

Documentación Interna: Consiste en los comentarios o mensajes que se agregan al código del programa, que explican las funciones que realizan ciertos procesos, cálculos o fórmulas para el entendimiento del mismo.  Documentación Externa: También conocida como Manual Técnico, está integrada por los siguientes elementos: Descripción del Problema, Nombre del Autor, Diagrama del Flujo y/o Pseudocódigo, Lista de variables y constantes, y Codificación del Programa, esto con la finalidad de permitir su posterior adecuación a los cambios. 

Manual del Usuario:  Es la documentación que se le proporciona al usuario final, es una guía que indica el usuario como navegar en el programa, presentando todas las pantallas y menús que se va a encontrar y una explicación de los mismos, no contiene información de tipo técnico. Describe paso a paso la manera como funciona el programa, Con el fin. De que el usuario obtenga el resultado deseado. Mantenimiento. Se lleva acabo después de terminado el programa, cuando se detecta que es necesario hacer algún cambio, ajuste o complementación al programa para que siga trabajando de manera correcta. Para poder realizar este trabajo se requiere que el programa este correctamente documentado.

El manual técnico debe incluir Descripción del problema. Resultados esperados y datos necesarios para generar dichos resultados. Diagramas UML,DF y Pseudocódigo. Pruebas desarrolladas Listado de programas con comentarios internos.

Partes importantes de la documentación: Es importante tener por escrito TODO el proceso desde el inicio. No dejar de lado los posibles cambios producto de la prueba y la ejecución Explicar cómo se usa el programa (Guía de Usuario) Sistema de ayuda Comentarios dentro del código

Conclusión Durante la fase de implementación, cuando se está programando. Esta documentación tiene como objeto hacer más comprensible el código fuente a otros programadores que tengan que trabajar con él, ya sea porque forman parte del grupo de desarrollo, el programa va a ser mantenido o modificado por otra persona distinta al programador inicial. También resulta muy útil durante la depuración y el mantenimiento del programa por el propio programador.