Documentación de Sistemas

De WikiUDO

BooksJohannesdrescher.jpg
       Unidad I (071-4612)

La documentación de los sistemas debe incluirse como un ítem de importancia en el plan de implementación. La misma debería incorporar como mínimo: definición de los objetivos del sistema, análisis de impacto en la organización (respecto a los procesos de negocio) y sus beneficios, justificación técnica, económica y financiera del proyecto, análisis de impacto en los recursos humanos, documentación de todos los programas que integran el sistema, documentación de datos, archivos y bases de datos, medidas de seguridad físicas y lógicas a adoptarse.

Contenido

Introducción

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.

Aspectos fundamentales de la documentación

  • Debe ser rotulada con claridad y bien organizada.
  • 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.
  • Asegúrese de que los estándares sean completos, actualizados, documentados y legibles.

Tipos de documentación

Durante el desarrollo de un sistema, desde su concepción hasta su puesta en marcha se ha de generar una 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. 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
  • Generalmente existen solo dos tipos de manuales, el administrativo y el de usuario.

Lao diferentes tipos de documentacion de sistemas son los siguientes:

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 procesos que se llevan a cabo en cada dependencia sin profundizar en detalles técnicos o específicos. Se deberá resaltar aquellas fases del proceso en las cuáles se obtengan resultados de importancia así como aquellas que requieran una supervisión especial.

  • Requerimientos del sistema.

Se establecen los costos de los requerimientos tanto humanos como tecnológicos que va a necesitar el sistema.

  • Estimación de la fecha probable de implementación del sistema.

Es necesario que exista una fecha probable de implantación cuya base será la terminación de todas las actividades para la creación del sistema, tales como: análisis, programación, elaboración de formas, y otros. Se recomienda utilizar diagrama de Gantt o de PERT para establecer el período de las actividades requeridas para el desarrollo del sistema.

  • Consideraciones generales del nuevo sistema.

En este punto se deberá señalar las ventajas, desventajas, y principales diferencias del nuevo sistema con el anterior, tales cómo seguridad, disminución de costo, ahorro de tiempo, flexibilidad, confiabilidad y otros.

Manual de usuario.

Expone los procesos que el usuario puede realizar con el sistema implantado. Para lograr esto, es necesario que se detallen todas y cada una de las características que tienen los programas y la forma de acceder e introducir información. Permite a los usuarios conocer el detalle de qué actividades ellos deberán desarrollar para la consecución de los objetivos del sistema. Reúne la información, normas y documentación necesaria para que el usuario conozca y utilice adecuadamente el sistema.

Objetivos de los manuales de usuarios.

  • Que el usuario conozca cómo preparar los datos de entrada.
  • Que el usuario aprenda a obtener los resultados y los datos de salida.
  • Servir como manual de aprendizaje.
  • Servir como manual de referencia.
  • Definir las funciones que debe realizar el usuario.

Pasos para desarrollar el manual de usuario.

  • Identificar los usuarios del sistema.

Personal que se relacionará con el sistema.

  • Definir los diferentes tipos de usuarios.

Se presentan los diferentes tipos de usuarios que usarían el sistema. Ejemplo: usuarios directos, indirectos.

  • Definir los módulos en que cada usuario participará.

Se describen los módulos o procesos que se ejecutarán por cada usuario en forma narrativa breve y clara.

  • Importancia del manual de usuario.

Características del manual de usuario.

Al elaborar el manual de usuario, hay que tener en cuenta a quién va dirigido es decir, el manual puede ser manejado desde el director de la empresa hasta el introductor de datos. Por consiguiente, debe redactarse de forma clara y sencilla para que lo entienda cualquier tipo de usuario.

  • Diagrama general del sistema.

Como está construido el sistema en una visión mucho mas general.

  • Diagrama particular detallado.

Presentar gráficamente todos los pasos que se efectúen dentro del departamento usuario a quien está dirigido este manual. Deben especificarse los archivos de entrada, salida, los resultados, revisiones y procesos manuales.

  • Instalación del sistema.

Explicación detallada de como se tiene que instalar el sistema incluyendo módulos, bases de datos, documentación y ayuda en pantalla.

  • Iniciación al uso del sistema.

En este punto se explica cómo iniciarse en el sistema y cómo se pueden utilizar sus cualidades comunes. Esta documentación debe decir al usuario cómo salir de un problema cuando las cosas funcionan mal.

  • Manual de referencia.

Es el documento definitivo de cara al usuario y debe ser completo. Describe con detalle las cualidades del sistema y su uso, los informes de error generados y las situaciones en que surgen esos errores. Dependiendo del sistema, los documentos al usuario se pueden proporcionar por separado o reunidos en varios volúmenes. Los sistemas de ayuda en línea evitan que el usuario pierda tiempo en consultas manuales.

Manual de operación.

Contiene la información que permite al personal de operación utilizar en forma eficiente la operación de los sistemas de procesamiento electrónico.

Contenido del manual de operación.

  • Diagrama general del sistema

Este diagrama debe ser presentado gráficamente y en forma sencilla. Representar los diagramas utilizando para ello diagramas de bloques (es el mismo diagrama que se presenta en el manual administrativo).

  • Diagrama general del flujo del proceso electrónico.

Se representa en este diagrama todo el ambiente periférico que interactúa en el sistema en cuanto a: entradas manuales, medios magnéticos y dispositivos de salida. La simbología a utilizar debe ser establecida como estándar. (ejemplos: cintas, discos, disquetes).

  • Explicación genérica de las fases del sistema

Es una explicación clara, breve de todos los módulos que se presentan en el diagrama general descrito anteriormente.

  • Diagrama de pantallas del sistema

Se presenta en este punto el flujo del sistema en las pantallas utilizadas por cada módulo.

  • Puntos a documentar en una pantalla.

Explicación del recorrido en pantalla.

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.

La documentación en el ciclo de vida de los sistemas de información.

El ciclo de vida de un sistema de información comprende las siguientes etapas:

Planificación

  • Ámbito del proyecto
  • Estudio de viabilidad
  • Análisis de riesgos
  • Estimación
  • Planificación temporal
  • Asignación de recursos.

Análisis

Elicitación de requerimientos:

  • Requerimientos funcionales
  • Requerimientos no funcionales

Modelado:

  • Modelado de datos
  • Modelado de procesos

Diseño

  • Estudio de alternativas y diseño arquitectónico
  • Diseño de la base de datos
  • Diseño de las aplicaciones

Implementación

  • Adquisición de componentes.
  • Creación e integración de los recursos necesarios para que el sistema funcione.

Pruebas

  • Pruebas de unidad.
  • Pruebas de integración.
  • Pruebas alfa.
  • Pruebas beta.
  • Test de aceptación.

Instalación / despliegue

Uso / mantenimiento

  • Mantenimiento adaptativo.
  • Mantenimiento correctivo.
  • Mantenimiento perfectivo.

Referencias Bibliograficas

Laudon K. Y Laudon J. 1996. Administración de los Sistemas de Información. 3era. Edición. Pág: 426

Senn J. 1992. Análisis y Diseño de Sistemas de Información. 2da. Edición. Pág: 33

Sage A. Y Palmer. J. 199_. Software Systems Engineering. Pág: 48

Whitten J., Bentley L., Barlow V. 1996. Análisis y Diseño de Sistemas de Información. 3era. Edición. Pág: 95

Yourdon E. 1993. Análisis Estructurado Moderno. Pág: 86

Omar Díaz Rivera. (2007). Manual de Programacion. [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://www.uprb.edu/politicas/Manual-Programacion.pdf

Sin nombre. (2010). Conceptos básicos de programación. [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://www.monografias.com/trabajos38/programacion/programacion.shtml

Sin nombre. (2011). El ciclo de vida de un sistema de información [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://elvex.ugr.es/idbis/db/docs/design/1-process.pdf

Sin nombre. (2007). Ciclo de Vida de los Sistemas. [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://babotejada.wordpress.com/2007/05/18/ciclo-de-vida-de-los-sistemas/

Sin nombre. (2011). Ciclo de Vida de los Sistemas. [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://www.slideshare.net/mmiutirla/ciclo-de-vida-de-los-sistemas-1397304

Sin nombre, (2010). Documentación de sistemas. [Articulo en Linea]. Consultado el 22 de enero del 2012 en: http://www.monografias.com/trabajos6/dosi/dosi.shtml

Véase También

Auditoria informatica

Planeación de la Auditoría en Informática

Evaluación de sistemas

Evaluación de Procesos de Datos y Equipos de Computo

Evaluación de seguridad de los sistemas
Herramientas personales