La documentación de sistemas

En el mundo globalizado de hoy es necesario que las empresas, instituciones públicas, entre otros, cuenten con un sistema documental de sus procedimientos, servicios y funciones; ya que la documentación es el soporte del sistema de gestión de la calidad y planificación, pues en ella se plasman no sólo las formas de operar de la organización sino toda la información que permite el desarrollo de todos los procesos, la toma de decisiones y permitir las auditorías. Existen diversas técnicas, elementos y metodologías con los cuales se puede elaborar la documentación que nos permita atacar las necesidades que tenga cualquier tipo de organización o cliente; de manera tal que la documentación a implementar cumpla con los requisitos, permita el desarrollo y la permanencia en el mercado. Con la documentación se puede mantener y actualizar los sistemas de información de una empresa frecuentemente, con el fin de brindar efectividad en el diseño de las estrategias; un buen sistema de documentación debe desarrollarse utilizando un método único, estandarizado que proporcione una comunicación clara y rápida, ya que pueden reducir costos en el almacenamiento, adiestramiento de personal, adquisición de tecnologías y otros.

La documentación de sistemas

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 operandos 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.

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.

Objetivos de la documentación de sistemas

Definir detalladamente el sistema

Explicar las características técnicas y la operación de un sistema.

Mejorar la comunicación

Proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo y para enseñar a los usuarios como interactuar con el sistema y a los operandos como hacerlo funcionar.

Vinculo para la capacitación

Ayudar al entrenamiento del nuevo personal dentro y fuera de la organización de sistemas.

Optimizar la gestión de mantenimiento

Ser de utilidad para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.

Fomentar la integración

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

Proporcionar estabilidad al sistema

Asegurar que el sistema opere correctamente.

Minimizar el consumo de recursos

Utilizar eficientemente los recursos que se dispongan.

Manual administrativo

Sirve como punto de partida al sistema propuesto, ya que será función de la gerencia, de acuerdo con los usuarios de dicho sistema, determinar si lo expuesto en él satisface los requerimientos del propio sistema. Una vez lograda la aprobación, se estará en condiciones de iniciar el desarrollo del sistema propuesto e ir integrando el resto de la documentación. El manual tiene como finalidad el permitir a la alta gerencia tener la información necesaria y suficiente sobre un sistema en particular y servir como fuente de consulta una vez que el sistema ha sido implantado.

Contenido del manual administrativo.

 Nombre del sistema.

Una descripción breve del nombre del sistema.

 Equipo encargado del sistema.

Se describe a las personas que están involucradas en la creación del sistema.

 Planteamiento.

Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del análisis del sistema.

 Objetivos del sistema.

Aquí se dejarán establecidos los objetivos que debe cubrir el sistema, en forma clara y precisa para evitar errores de interpretación.

 Entradas del sistema (información a captar).

Debe quedar especificado en este punto, los documentos fuentes que inician las operaciones del sistema así como la información detallada de aquellos conceptos que serán los datos a captar por el sistema. Se deberán mencionar todos los datos que en forma secundaria originan una entrada importante al sistema.

 Salidas del sistema (resultados a obtener).

En este punto, solamente se describirán los resultados de mayor importancia obtenidos a través de todo el proceso. En esta sección se debe dar mayor énfasis a la información que el sistema proporciona cuidando de no hacer tan sólo mención de los resultados a obtener.

 Diagramación general del sistema.

Representaciones graficas del sistema (diagramas UML, para la explicación de los procesos de la empresa).

 Explicaciones de las fases del sistema.

Este punto se encuentra relacionado con el anterior ya que lo que se muestra gráficamente, ahora se describe en forma genérica, explicando los

...