Documentacion De Sistemas

Documentación de sistemas

1. Introducción

La documentación de sistemas es el conjunto de información que nos dice qué hacen los sistemas, cómo lo hacen y para quién lo hacen.

La documentación consiste en material que explica las características técnicas y la operación de un sistema. Es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar con el sistema y a los operadores como hacerlo funcionar.

Existen varios tipos de documentación. La de programas, que explica la lógica de un programa e incluye descripciones, diagramas de flujo, listados de programas y otros documentos; la del usuarios en forma general la naturaleza y capacidades del sistema y cómo usarlo.

Muchas organizaciones tienen lo que se conoce como un "programa de documentación", el cual consiste en una política formal cuya documentación se muestra como algo que debe prepararse en forma rutinaria para cada programa de cómputo, archivo y nuevos sistemas.

Otra definición sería la de registro físico, generalmente por escrito que contiene los siguientes elementos:

• Políticas y normas referentes al desarrollo del sistema, su implantación, operación y mantenimiento.

• El diseño del sistema de información administrativo.

• Procedimientos para instalar el sistema de información administrativo.

Procedimientos para operar el sistema de información administrativo.

Procedimientos para mantener el sistema de información administrativo.

Importancia de la Documentación de Sistemas

La importancia de la documentación bien podría ser comparada con la importancia de la existencia de una Póliza de Seguro; mientras todo va bien no existe la precaución de confirmar si nuestra Póliza de Seguros está o no vigente.

La documentación adecuada y completa, de una aplicación que se desea implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema de Información, sin embargo, frecuentemente es la parte a la cual se dedica un menor tiempo y se le presta menos atención.

Siempre se debe documentar un sistema como si estuviera a punto de irse a Siberia el siguiente mes, para nunca volver. Si la documentación del sistema es incompleta el diseñador continuamente estará involucrado y no podrá moverse a otra asignación.

Existen diversos documentos que nos dan una vista diferente del sistema. El manual administrativo nos da una vista global del sistema, beneficios y usos del mismo enfocado a la administración de la organización, el manual del usuario nos dice como usar el sistema para las diferentes actividades que fue desarrollado, el manual técnico nos dice como está construido el sistema, el manual de instalación y mantenimiento nos dice como poner el sistema en marcha y como mantenerlo durante su funcionamiento, el manual de captación nos dice como capturar la información de entrada al sistema.

2. Estandarización y normalización

Estandarización

Significa que los símbolos convencionales se usan en todos los diagramas de flujo para describir el sistema y que en la documentación se usen formas estandarizadas.

Aún cuando las normas de documentación varían de una instalación a otra, es esencial que dentro de una organización, se utilice un solo método. El uso de procedimientos y documentación estandarizada proporciona la base de una comunicación clara y rápida, adiestramiento menos costoso del personal de sistemas, reducción de costos de almacenamiento, y otros.

Ventajas de la Estandarización

• Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.

• Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.

• Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.

• Asegura que el sistema opere correctamente.

• Se utilizan eficientemente los recursos que se dispongan.

Estándares Básicos de Documentación

Toda documentación que se relacione con un sistema, ya sea manual o por computadora, sencillo o complejo debe reunir los siguientes requisitos básicos:

• Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, almacenarlas en carpetas e índice.

• Los diagramas deberán ser claros, no aglomerados y la escritura manuscrita deberá ser legible.

• La documentación deberá ser completa.

• Se incluirá una leyenda o explicación de los términos utilizados.

• La documentación siempre se conserva actualizada.

Como parte de la estandarización se deben de establecer la forma en que se escribirán los documentos incluyendo tipos de letras para cada parte del documento (títulos, encabezados, descripción de figuras, etc.), estándar de numeración utilizado, formato de las páginas, acomodo de la información en la página, etc.

Normalización

• Asegúrese de que los estándares sean completos, actualizados, documentados y legibles.

• Auditar permanentemente para que se cumplan los estándares.

• Evaluar si los estándares establecidos son los requeridos y hacer los cambios necesarios para que dichos estándares sean los apropiados.

Teoría General de los Manuales de Documentación

Durante el desarrollo de un sistema, desde su concepción hasta su puesta en marcha se ha generado gran cantidad de documentos, que en muchas ocasiones se han visto modificados por documentos posteriores debido a cambios en el sistema.

Para evitar confusiones en las revisiones de la documentación se desarrollan diferentes tipos de documentos dirigidos a las personas que trabajarán con el sistema y para facilitar el mantenimiento del mismo. La documentación de un sistema debe ser marcada adecuadamente, bien organizada, actualizada y completa; todos los términos utilizados deben explicarse. La documentación se hará disponible a todos los usuarios de acuerdo a sus necesidades.

El estilo de redacción de los manuales de documentación debe ser:

• Concreto.

• Ser preciso y definir los términos utilizados.

• Utilizar párrafos cortos.

• Utilizar títulos y subtítulos.

• Utilizar formas activas en lugar de pasivas.

• No emplear frases largas que presenten hechos distintos.

• No hacer referencia a una información solamente con el número de referencia

...