MANTENIMIENTO. DOCUMENTACIÓN PARA MANTENIMIENTO

Portada con el nombre del programa, versión y autor o autores.

· Índice.

· Descripción muy breve de las funciones y posibilidades del programa.

· Descripción breve del método de cálculo principal.

· Explicación breve de cómo debe usarse el programa y de los datos de entrada, opciones y resultados.

· Ejemplos paso a paso de uso del programa en número suficiente para comprender las posibilidades que se brindan.

· Diagrama de flujo del programa de carácter sintético y descriptivo.

· Especificación detallada de todas las opciones contenidas en menús.

· Especificación detallada de todos los cálculos, principales y secundarios.

La extensión de la documentación para el usuario será variable en función de la complejidad y características del programa: puede ir desde un párrafo para programas muy sencillos y de fácil uso hasta centenares de páginas para programas comerciales complejos. Los puntos contenidos en la documentación también son variables, siendo los enumerados anteriormente una orientación. Para programas sencillos puede reducirse a un título, una explicación breve del funcionamiento, entradas y salidas y un ejemplo de uso.

MANTENIMIENTO. DOCUMENTACIÓN PARA MANTENIMIENTO.

La documentación para mantenimiento constituye el elemento de referencia para el programador que haya de realizar cambios o ampliaciones del programa en el futuro. La necesidad de mantenimiento deriva de:

· Defectos del programa no detectados y que es necesario corregir.

· Cambios externos de índole política, técnica, social, etc. que afectan al programa: normativa, moneda, novedades de un sistema operativo, etc.

· Solicitudes de los clientes o usuarios.

El mantenimiento de un programa puede afectar a su esqueleto o diseño básico, a funciones importantes pero desligadas del núcleo del programa o a cuestiones meramente estéticas. De cualquier forma, el mantenimiento debe considerarse como programación en todos sus sentidos, debiendo partir del conocimiento del problema y avanzar con detenimiento siguiendo las normas para una programación sólida. Es ideal un mantenimiento que respete la filosofía y el estilo del programa que se mantiene, de modo que un auditor no pudiera detectar qué parte del programa corresponde al código original y qué parte a la ampliación o corrección.

Por desgracia esto muchas veces no se cumple, por descuido o porque simplemente realizar un mantenimiento de calidad puede ser muy costoso frente a una opción rápida y que funciona. El problema surge cundo diversas operaciones de mantenimiento con distintas formas de construcción y filosofía

...