Blogia

DOCUMENTACIÓN DE SISTEMAS

INTRODUCCIÓN

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.

 

TÉCNICAS DOCUMENTALES

   Existe una confusión de término y situación que impide la definición unívoca de la información documental. Los profesionales que realizan funciones o actividades diversas en fondos documentales reciben nombres distintos como: documentalistas, bibliotecarios, analistas, científicos de la información, archivistas, informáticos documentales, etc. También los diversos centros documentales se denominan indistintamente según sus objetivos propuestos: centros de documentación, bibliotecas, bancos de datos, servicios de documentación, unidades documentales, sistemas documentales, archivos, etc. Pero estos apelativos, fruto de necesidades siempre en evolución, no corresponden, aunque pueda perecerse, a actividades diversificadas. Por el contrario, todas quedan englobadas en una ciencia común: La Ciencia de la información.

Para simplificar ambigüedades, se limita el concepto de Ciencia de la Información que abarca el conjunto de Técnicas Documentales, al término generalizado de Documentación.

ELEMENTOS DE LA DOCUMENTACIÓN

 A) Plan de Gestión de Proyectos

Tiene como Propósito Describir el formato del Plan de Gestión de Proyectos para el desarrollo de sistemas de información automatizados. Documentar las actividades y recursos requeridos por cada tipo de proyecto a gestionar, es decir, documentar el Plan de Adquisiciones y Capacitación, establecer los Mecanismos de Comunicación con el Usuario y generar Alternativas de Realización de Proyectos, seleccionando la mejor opción. 

B) Plan de Proyecto

Tiene como Propósito Describir el formato del Plan de Proyecto para el desarrollo de sistemas de información automatizados. El plan de Proyecto es el documento de control para la administración de un proyecto de desarrollo que define los procesos técnicos y administrativos necesarios para comprender perfectamente el ámbito del trabajo a realizar, los riesgos en los que se puede incurrir, los recursos requeridos, las etapas a seguir, las metas parciales y finales a lograr y el esfuerzo y costo necesarios, para el desarrollo de sistemas de información automatizados que satisfagan los requerimientos establecidos. 

C) Acuerdo para el Desarrollo

Tiene como Propósito Describir el formato del Acuerdo para el Desarrollo que establece las responsabilidades de la unidad administrativa que operará el sistema de información automatizado y la unidad administrativa con función informática durante el desarrollo de un sistema de información automatizado. 

D) Plan de Desarrollo

Tiene como Propósito Describir de manera específica las actividades del proyecto correspondientes a cada etapa, las metas a lograr y el esfuerzo y costo necesarios, para el desarrollo de sistemas de información automatizados que satisfagan los requerimientos establecidos. 

E) Especificación de Requerimientos

Tiene como Propósito Describir el formato de la Especificación de Requerimientos para el desarrollo de sistemas de información automatizados. La Especificación de Requerimientos es el documento que incluye la identificación, organización, presentación y modificación de los requerimientos que un sistema de información automatizado debe satisfacer. Además señala las condiciones para incorporar conceptos operacionales, restricciones de diseño y requerimientos de configuración.

Para sistemas de información automatizados en producción este elemento de documentación puede ser utilizado para describir las características de funcionalidad actuales junto con aquellas planeadas para su incorporación en el futuro. 

F) Análisis y Diseño

Tiene como Propósito Describir la representación o modelo del sistema de información automatizado por desarrollar que satisface los requerimientos establecidos. Este documento debe proveer la información precisa para la construcción de los componentes del sistema de información automatizado, estructurándola en elementos de diseño, describiendo sus propiedades y relaciones. Estos elementos de diseño incluyen la estructura del sistema de información automatizado, sus componentes, interfaces y base de datos necesarios para su implementación.

Para sistemas de información en desarrollo este elemento de documentación puede ser utilizado como herramienta de trazabilidad entre los requerimientos especificados y los componentes del sistema de información automatizado construidos.

Para sistemas de información automatizados en producción este elemento de documentación puede ser utilizado para realizar actividades de mantenimiento. 

G) Componente del Sistema de Información Automatizado

Tiene como Propósito Describir el formato de un Componente del Sistema de Información Automatizado. Éste es un documento en el cual se describe cada componente. 

H) Registro de Rastreo

Tiene como Propósito Describir el formato de Registro de Rastreo en el desarrollo de sistemas de información automatizados. El Registro de Rastreo es el documento en el cual se asientan los requerimientos establecidos en la Especificación de Requerimientos y se da seguimiento a los elementos de configuración del sistema de información automatizado que se elaboran durante el análisis, diseño, construcción e integración para satisfacer esos requerimientos. 

I) Plan de pruebas

Tiene como Propósito Describir el formato del Plan de pruebas de componentes de sistema de información automatizado. El Plan de pruebas es el documento de control para realizar sistemáticamente las pruebas de los componentes de un sistema de información automatizado con el propósito de verificar el cumplimiento de los requisitos establecidos. 

J) Reporte de Pruebas

Tiene como Propósito Describir el formato del Reporte de pruebas de componentes de sistema de información automatizado. El Reporte de pruebas es el documento en el que se registran los resultados de las pruebas realizadas a los componentes desarrollados con el propósito de verificar el cumplimiento de los requisitos establecidos.

K) Manual de Usuario 

Tiene como Propósito Describir el formato del Manual de Usuario de un sistema de información automatizado en producción. El Manual de Usuario es el documento que describe el flujo de datos a través de la organización, las áreas que involucra, la entrada del sistema, el procesamiento que reciben los datos y los productos que genera el sistema de información automatizado.

L) Manual de Operación

Tiene como Propósito Describir el formato del Manual de Operación de un sistema de información automatizado. El Manual de Operación es el documento que detalla las actividades de instalación/desinstalación, arranque/apagado, respaldo/restauración, procesos especiales y de seguridad de un sistema de información automatizado. 

M) Manual Técnico

Tiene como Propósito Describir el formato del Manual Técnico de un sistema de información automatizado en producción. El Manual Técnico es el documento que detalla las características técnicas del sistema de información automatizado suficientes para realizar acciones de mantenimiento preventivo y adaptativo que no impliquen cambios significativos en su operación. 

ESTANDARIZACION Y NORMALIZACIÓN

Estandarización

Significa que los símbolos convencionales se usan en todos los diagramas de flujo para prescribir 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.

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.

Normalización

- Se debe segurar  que los estándares sean completos, actualizados, documentados y legibles.

- Es necesario Auditar permanentemente para que se cumplan los estándares.

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

 

DIAGRAMAS DE FLUJO

   Es una representación gráfica de un algoritmo. Se utiliza en disciplinas como la programación, la economía, los procesos industriales y la psicología cognitiva. Estos diagramas utilizan símbolos con significados bien definidos que representan los pasos del algoritmo, y representan el flujo de ejecución mediante flechas que conectan los puntos de inicio y de término.

Diagrama de flujo sencillo con los pasos a seguir si una lámpara no funciona. 

Características

Un diagrama de flujo siempre tiene un único punto de inicio y un único punto de término. Además, todo camino de ejecución debe permitir llegar desde el inicio hasta el término.

Las siguientes son acciones previas a la realización del diagrama de flujo:

  • Identificar las ideas principales a ser incluidas en el diagrama de flujo. Deben estar presentes el dueño o responsable del proceso, los dueños o responsables del proceso anterior y posterior y de otros procesos interrelacionados, otras partes interesadas.
  • Definir qué se espera obtener del diagrama de flujo.
  • Identificar quién lo empleará y cómo.
  • Establecer el nivel de detalle requerido.
  • Determinar los límites del proceso a describir.

Los pasos a seguir para construir el diagrama de flujo son:

  • Establecer el alcance del proceso a describir. De esta manera quedará fijado el comienzo y el final del diagrama. Frecuentemente el comienzo es la salida del proceso previo y el final la entrada al proceso siguiente.
  • Identificar y listar las principales actividades/subprocesos que están incluidos en el proceso a describir y su orden cronológico.
  • Si el nivel de detalle definido incluye actividades menores, listarlas también.
  • Identificar y listar los puntos de decisión.
  • Construir el diagrama respetando la secuencia cronológica y asignando los correspondientes símbolos.
  • Asignar un título al diagrama y verificar que esté completo y describa con exactitud el proceso elegido.

Ventajas de los diagrama de flujo

  • Favorecen la comprensión del proceso a través de mostrarlo como un dibujo. El cerebro humano reconoce fácilmente los dibujos. Un buen diagrama de flujo reemplaza varias páginas de texto.
  • Permiten identificar los problemas y las oportunidades de mejora del proceso. Se identifican los pasos redundantes, los flujos de los re-procesos , los conflictos de autoridad, las responsabilidades, los cuellos de botella, y los puntos de decisión.
  • Muestran las interfaces cliente-proveedor y las transacciones que en ellas se realizan, facilitando a los empleados el análisis de las mismas.
  • Son una excelente herramienta para capacitar a los nuevos empleados y también a los que desarrollan la tarea, cuando se realizan mejoras en el proceso.

Tipos de diagramas de flujos

  • Formato vertical: En él el flujo o la secuencia de las operaciones, va de arriba hacia abajo. Es una lista ordenada de las operaciones de un proceso con toda la información que se considere necesaria, según su propósito.
  • Formato horizontal: En él, el flujo o la secuencia de las operaciones, va de izquierda a derecha.
  • Formato panorámico: El proceso entero está representado en una sola carta y puede apreciarse de una sola mirada mucho más rápido que leyendo el texto, lo que facilita su comprensión, aun para personas no familiarizadas. Registra no solo en línea vertical, sino también horizontal, distintas acciones simultáneas y la participación de más de un puesto o departamento que el formato vertical no registra.
  • Formato Arquitectónico: Describe el itinerario de ruta de una forma o persona sobre el plano arquitectónico del área de trabajo. El primero de los flujogramas es eminentemente descriptivo, mientras que los utilizados son fundamentalmente representativos.  

DIAGRAMAS ENTIDAD- RELACION (E-R)

    Son una herramienta para el modelado de datos de un sistema de información. Estos modelos expresan entidades relevantes para un sistema de información, sus inter-relaciones y propiedades. El Modelo Entidad-Relación es un concepto de modelado para bases de datos, propuesto por Peter Chen, mediante el cual se pretende ‘visualizar’ los objetos que pertenecen a la Base de Datos como entidades (esto es similar al modelo de Programación Orientada a Objetos) las cuales tienen unos atributos y se vinculan mediante relaciones(Es una representación lógica de la información).

El modelado entidad-relación es una técnica para el modelado de datos utilizando diagramas entidad relación. No es la única técnica pero sí la más utilizada. Brevemente consiste en los siguientes pasos:

1. Se parte de una descripción textual del problema o sistema de información a automatizar (los requisitos).

2. Se hace una lista de los sustantivos y verbos que aparecen.

3. Los sustantivos son posibles entidades o atributos.

4. Los verbos son posibles relaciones.

5. Analizando las frases se determina la cardinalidad de las relaciones y otros detalles.

6. Se elabora el diagrama (o diagramas) entidad-relación.

7. Se completa el modelo con listas de atributos y una descripción de otras restricciones que no se pueden reflejar en el diagrama.

Dado lo rudimentario de esta técnica se necesita cierto entrenamiento y experiencia para lograr buenos modelos de datos.

Formalmente, los diagramas E-R son un lenguaje gráfico para describir conceptos. Informalmente, son simples dibujos o gráficos que describen la información que trata un sistema de información y el software que lo automatiza. Los elementos de dicho lenguaje se describen a continuación, por orden de importancia.

ENTIDADES

Una entidad es cualquier “objeto” discreto sobre el que se tiene información. Se representa mediante un rectángulo o “caja” etiquetada en su interior mediante un nombre. Ejemplos de entidades habituales en los sistemas de información son: factura, persona, empleado, etc.

Cada ejemplar de una entidad se denomina instancia.Por ejemplo,”carlos ch y doris ar” pueden ser dos instancias distintas de la entidad “persona”. Las instancias no se representan en el diagrama. No obstante, se pueden documentar aparte porque son útiles para inicializar la base de datos resultante. Por ejemplo, los departamentos existentes de una empresa pueden ser relevantes como datos iniciales de la entidad “departamento”.

RELACIONES

Una relación describe cierta interdependencia (de cualquier tipo) entre entidades. Se representa mediante un rombo etiquetado en su interior mediante un verbo. Además, dicho rombo debe unirse mediante líneas con las entidades que relaciona (es decir, los rectángulos).

Una relación no tiene sentido sin las entidades que relaciona. Por ejemplo: una persona(entidad) trabaja (relación) para un departamento (entidad).

ATRIBUTOS

Los atributos son propiedades relevantes propias de una entidad y/o relacion. Se representan mediante un círculo o elipse etiquetado mediante un nombre en su interior.Cuando un atributo es identificativo de la entidad se suele subrayar dicha etiqueta.

Por motivos de legibilidad, los atributos no suelen representarse en un diagrama entidad-relación, sino que se describen textualmente en otros documentos adjuntos. Los atributos describen información útil sobre las entidades.En particular, los atributos identificativos son aquellos que permiten diferenciar a una instancia de la entidad de otra distinta.

Por ejemplo, el atributo identificativo que distingue a un empleado de otro es su número de la Seguridad Social.

Ejemplos de atributos de la entidad “persona”:

•Documento Nacional de Identidad (identificativo).

•Nombre.

•Apellidos.

•Dirección.

•Código postal.

DIAGRAMA CAUSA Y EFECTO (ESPINA DE PESCADO)

    El Diagrama Causa-Efecto es una forma de organizar y representar las diferentes teorías propuestas sobre las causas de un problema. Se conoce también como diagrama de Ishikawa (por su creador, el Dr. Kaoru Ishikawa, 1943), ó diagrama de Espina de Pescado y se utiliza en las fases de Diagnóstico y Solución de la causa.

El Diagrama de Espina se utiliza para recoger de manera gráfica todas las posibles causas de un problema o identificar los aspectos necesarios para alcanzar un determinado objetivo (efecto). También se le denomina diagrama causa-efecto o diagrama de Ishikawa.

Los Diagramas Causa-Efecto ayudan a los estudiantes a pensar sobre todas las causas reales y potenciales de un suceso o problema, y no solamente en las más obvias o simples. Además, son idóneos para motivar el análisis y la discusión grupal, de manera que cada equipo de trabajo pueda ampliar su comprensión del problema, visualizar las razones, motivos o factores principales y secundarios, identificar posibles soluciones, tomar decisiones y, organizar planes de acción.

El Diagrama Causa-Efecto es llamado usualmente Diagrama de "Ishikawa" porque fue creado por Kaoru Ishikawa, experto en dirección de empresas interesado en mejorar el control de la calidad; también es llamado "Diagrama Espina de Pescado" por que su forma es similar al esqueleto de un pez: Está compuesto por un recuadro (cabeza), una línea principal (columna vertebral), y 4 o más líneas que apuntan a la línea principal formando un ángulo aproximado de 70º (espinas principales). Estas últimas poseen a su vez dos o tres líneas inclinadas (espinas), y así sucesivamente (espinas menores), según sea necesario.

Para desarrollar el diagrama de espina se deben seguir los siguientes pasos:

1.    Definir y determinar claramente el problema o efecto que va a ser analizado.

2.    Identificar los factores o causas que originan el efecto, mediante un brainstorming. Para clasificar las causas encontradas a menudo se utiliza como referencia las categorías de las cuatro M definidas por Ishikawa: mano de obra, maquinaria, materiales y métodos. Estas categorías son los rótulos de las espinas.

3.    Representación del diagrama. Una vez enumeradas todas las causas debemos ir colocándolas en el diagrama agrupando las de similar naturaleza.

4.    Análisis de las relaciones causa-efecto que derivan de la construcción del diagrama.

Entre otras aplicaciones, puede utilizarse para: conocer y afrontar las causas de los defectos, anomalías o reclamaciones; reducir costes; obtener mejoras en los procesos; mejorar la calidad de los productos, servicios e instalaciones; y establecer procedimientos normalizados, tanto operativos como de control.

A pesar de la aparente sencillez de esta herramienta, la aplicación de la misma presenta una serie de ventajas como:

  • Proporcionar una metodología racional para la resolución de problemas.
  • Permitir sistematizar las posibles causas de un problema.
  • Favorecer el trabajo en equipo permitiendo que los trabajadores planteen de forma creativa sus opiniones y que la comunicación sea clara y eficaz.

Diagrama de espina para “clientes insatisfechos”  

 CÓMO INTERPRETAR UN DIAGRAMA DE CAUSA-EFECTO?

El diagrama Causa-Efecto es un vehículo para ordenar, de forma muy concentrada, todas las causas que supuestamente pueden contribuir a un determinado efecto. Nos Permite, por tanto, lograr un conocimiento común de un problema complejo, sin ser nunca sustitutivo de los datos. Es importante ser conscientes de que los diagramas de causa-efecto presentan y organizan teorías. Sólo cuando estas teorías son contrastadas con datos podemos probar las causas de los fenómenos observables.

Errores comunes son construir el diagrama antes de analizar globalmente los síntomas, limitar las teorías propuestas enmascarando involuntariamente la causa raíz, o cometer errores tanto en la relación causal como en el orden de las teorías, suponiendo un gasto de tiempo importante.

DIAGRAMA DE GANTT

   El diagrama de Gantt, es una popular herramienta gráfica cuyo objetivo es mostrar el tiempo de dedicación previsto para diferentes tareas o actividades a lo largo de un tiempo total determinado. A pesar de que, en principio, el diagrama de Gantt no indica las relaciones existentes entre actividades, la posición de cada tarea a lo largo del tiempo hace que se puedan identificar dichas relaciones e interdependencias. Fue Henry Laurence Gantt quien, entre 1910 y 1915, desarrolló y popularizó este tipo de diagrama en Occidente.

Por esta razón, para la planificación del desarrollo de proyectos complejos (superiores a 25 actividades) se requiere además el uso de técnicas basadas en redes de precedencia como CPM o los grafos PERT. Estas redes relacionan las actividades de manera que se puede visualizar el camino crítico del proyecto y permiten reflejar una escala de tiempos para facilitar la asignación de recursos y la determinación del presupuesto. El diagrama de Gantt, sin embargo, resulta útil para la relación entre tiempo y carga de trabajo.

En gestión de proyectos, el diagrama de Gantt muestra el origen y el final de las diferentes unidades mínimas de trabajo y los grupos de tareas (llamados summary elements en la imagen) o las dependencias entre unidades mínimas de trabajo (no mostradas en la imagen).

Desde su introducción los diagramas de Gantt se han convertido en una herramienta básica en la gestión de proyectos de todo tipo, con la finalidad de representar las diferentes fases, tareas y actividades programadas como parte de un proyecto o para mostrar una línea de tiempo en las diferentes actividades haciendo el método más eficiente.

Básicamente el diagrama esta compuesto por un eje vertical donde se establecen las actividades que constituyen el trabajo que se va a ejecutar, y un eje horizontal que muestra en un calendario la duración de cada una de ellas.

Cómo crear un diagrama de GANTT

En un diagrama de GANTT, cada tarea es representada por una línea, mientras que las columnas representan los días, semanas, o meses del programa, dependiendo de la duración del proyecto. El tiempo estimado para cada tarea se muestra a través de una barra horizontal cuyo extremo izquierdo determina la fecha de inicio prevista y el extremo derecho determina la fecha de finalización estimada. Las tareas se pueden colocar en cadenas secuenciales o se pueden realizar simultáneamente.

Si las tareas son secuenciales, las prioridades se pueden confeccionar utilizando una flecha qué desciende de las tareas más importantes hacia las tareas menos importantes. La tarea menos importante no puede llevarse a cabo hasta que no se haya completado la más importante.

A medida que progresa una tarea, se completa proporcionalmente la barra que la representa hasta llegar al grado de finalización. Así, es posible obtener una visión general del progreso del proyecto rastreando una línea vertical a través de las tareas en el nivel de la fecha actual. Las tareas ya finalizadas se colocan a la izquierda de esta línea; las tareas que aún no se han iniciado se colocan a la derecha, mientras que las tareas que se están llevando a cabo atraviesan la línea. Si la línea está cubierta en la parte izquierda, ¡la tarea está demorada respecto de la planificación del proyecto!

Idealmente, un diagrama como este no debe incluir más de 15 ó 20 tareas para que pueda caber en una sola hoja con formato A4. Si el número de tareas es mayor, es posible crear diagramas adicionales en los que se detallan las planificaciones de las tareas principales.

Acontecimientos

Adicionalmente, es posible que los eventos más importantes, que no sean las tareas mismas, se muestren en la planificación como puntos de conexión del proyecto: estos se denominan acontecimientos.

Los acontecimientos permiten que el proyecto se realice en fases claramente indentificables, evitando que se prolongue la finalización del mismo. Un acontecimiento podría ser la producción de un documento, la realización de una reunión o el producto final de un proyecto. Los acontecimientos son tareas de duración cero, representadas en el diagrama por un símbolo específico, frecuentemente un triángulo invertido o un diamante.

Recursos

Generalmente es posible (y útil) mostrar referencias en el diagrama, humanas o materiales, para permitir calcular el tiempo restante y tener una idea del costo global.

Para ser más concisos, por lo general sólo serán necesarios las iniciales o los nombres de los responsables.