Vida

Unidad 5 Documentación
La documentación es el nexo entre las distintas actividades que se realizan y es la que permite ejercer el control efectivo del proyecto. Persigue objetivos interno y externos y en base a esto decimos que los:  OBJETIVOS INTERNOS: se refieren a la necesidad de transmitir información de un grupo a otro por ejemplo especialistas en base de datos a programadores. Sedocumenta con el propósito de: a) Comprender con claridad los compromisos que se asumen, las políticas que se definen y los riesgos que se corren. b) Comunicar información referida a los productos de un sector del área a otro. OBJETIVOS EXTERNOS: se persigue la comunicación con el usuario, por lo tanto se debe lograr que entienda la documentación para que pueda ejercer el control. En este grupo podemoscitar como objetivos a: a) Controlar las alternativas que sufre el proyecto y prevenir con anticipación situaciones indeseables. b) Comunicar a los usuarios las decisiones de diseño referidos a los productos.



En general se documenta todo, entonces se considera como Documentación del Programa al conjunto de descripciones escritas que explican al lector qué hace el programa y cómo lo hace.Existen tres grupos de personas que necesitan conocer la documentación y son: 1. Programadores: manual de mantenimiento del programa. 2. Operadores o Administradores de Red: manual de operación. 3. Usuario: manual del usuario. La documentación del programa debe ser de dos tipos: para el personal informático y para el usuario; en donde la primera debe incluir toda la documentación técnica delprograma o conjuntos de programas que conforman la aplicación.
Unidad 5: Documentación y Mantenimiento

Manual de Mantenimiento del Programa
Es la documentación requerida para mantener el programa durante su ciclo de vida. Este se divide en dos categorías y son: A. Documentación Interna. B. Documentación Externa. Documentación Interna Es material descriptivo escrito dentro del código fuente, lainformación está dirigida a quienes leen el código del programa. Esta se ubica al comienzo de cada módulo en un conjunto de comentarios que se denomina bloque de encabezado en el cual es necesario que contenga la siguiente información:

1

1. 2. 3. 4. 5. 6.

Que denominación tiene el módulo. Quien ha escrito el módulo. Donde va ubicado el módulo en el diseño general del sistema. Cuando fueescrito, revisado o modificado. Porque existe el módulo. Como utiliza sus estructuras de datos, algoritmos y control.

El nombre del módulo debe aparecer en un lugar destacado de la documentación. Luego se identificará al autor. Durante el ciclo de vida, los módulos se actualizan y revisan. Es muy importante hacer el seguimiento de cada revisión, de modo que se mantenga un registro de loscambios realizados y de quienes lo han efectuado. Debido a que un módulo es una parte de un sistema mayor, este bloque debe indicar como encaja en la jerarquía de componentes. Para explicar la forma en que el módulo cumple con su objetivo, se requiere información más detallada. El bloque deberá:      Indicar el nombre, tipo, propósito de cada una de las principales estructuras de datos yvariables. Contener breves descripciones del flujo lógico, algoritmos y tratamiento de errores. Listar la entrada esperada y la posible salida. Presentar las ayudas para la prueba y cómo usarlas. Enunciar las extensiones o revisiones esperadas.

Si la organización del código refleja un diseño bien estructurado, si las sentencias tienen un formato claro y si las etiquetas, nombres de variables y nombrede datos son descriptivos y fáciles de distinguir, entonces el número de comentarios adicionales será reducido. Es decir, al seguir directivas simples para la estructura y formato del código, se logra que el código sea una fuente de información acerca de si mismo. Los comentarios permiten fragmentar el código en fases que representan las actividades principales. Es importante comprobar que los...