Documentación

Con el fin de estandarizar el alcance de la documentación referente a un sistema, se sugiere tener la siguiente documentación antes de poner en producción cualquier producto.

Análisis conceptual

Identificación inicial de las necesidades y los principales requerimientos. Justificación del desarrollo de un sistema automatizado. Diagrama de flujo de datos a primer nivel. Áreas involucradas. Funciones principales.

Diseño conceptual

Módulos que forman el sistema. Funciones por cada módulo. Responsables del diseño. Información general de cada función. Índice detallado de cada función autorizada. Estrategia a seguir para la entrega de productos, prioridades y autorizaciones de usuario.

Diseño funcional

Descripción detallada de toda función involucrada con su respectiva documentación de: Responsable, periodicidad, reportes, pantallas, principales entradas/salidas y sobre todo una narrativa autorizada de cada función con el Vo.Bo. del usuario responsable. La narrativa no deberá contemplar lógica difícil de entender y mucho menos tener tendencias procedurales de lenguaje de programación.

Diseño detallado

Especificación detallada de todo programa, indicando la función a la que corresponde. Deberá tener una autorización por programa del "gerente de informática" responsable del proyecto. Esta etapa por ningún motivo deberá evitarse.

Programas y salidas de los mismos

Menúes de donde se llamarán los programas. Índice de programas, indicando función que realizan. Listado ejemplo de reportes obtenidos. Proporción mínima de una línea de comentarios por cada 10 de código. Narrativa clara que mencione al (los) programador(es), objetivos del programa, detalle de las actualizaciones que realiza y relación de las modificaciones.

Diagramas entidad - relación por cada módulo

Descripción de la infraestructura de desarrollo

Rutinas comunes

Entradas/salidas, nombre, ubicación, lenguaje, parámetros, indicando programas que los llaman o que están insertadas en los programas.

Parámetros del módulo

Indicar que parámetros son cambiables fácilmente, tablas de parámetros, características de usuarios, posibles valores y que aplicaciones o programas utilizan ese parámetro.

Arquitectura

Diagrama de todo módulo en cuestión, que indique las llamadas que hace cada programa, indicando función, rutinas comunes, objetivo del programa y lenguaje, y el ambiente en que es ejecutado.

Documentación de procesos especiales

Submitidores y cualquier procedimiento que saliera de lo convencional, indicando donde es ejecutado, parámetros que recibe o entrega, lenguaje de programación y la arquitectura clara y actualizada en que se diseñó.

Relación de errores

Índice de errores que se monitorean con su número, causa y solución posible.

Bitácoras

Manuales de usuarios

Información de la base de datos

Diagramas entidad-relación de cada sistema, indicando la integridad referencial. Objetivo de cada entidad. Descripción de cada columna y posibles valores y validaciones.

Matriz de requerimientos para la liberación de un sistema

Descripción de un sistema

Estructura del sistema

Instructivo de operación

Reportes

Tablas del sistema

Programas

Procedimientos

Archivos

Normas de ejecución

Procedimientos de backup, restore, depuración y reorganización de información

Plan de contingencia

Información adicional

Carta de liberación