Objetivos de la documentación de sistemas, plan de desarrollo y plan de implementación.
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.
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.
Existen dos tipos de documentaciones, que son:
Documentación Manual
Este tipo de documentación se efectúa manualmente. Puede documentarse en papel o en algún medio magnético como disquete o CD. Se cuenta con apoyo de Software para su confección, como un procesador de texto, planilla electrónica y programas graficadores.
Ventajas:
- Refleja historia.
- Muestra la evolución de la documentación en el tiempo.
- Más explicativa.
- Se adecua a la cultura de la organización.
- No consume capacidad de procesamiento.
Desventajas:
- Consume mucho esfuerzo en construirla.
- Documentación incompleta.
- Poca disposición para entregar información.
- Más lenta y sin actualizar.
- Errores de escritura
Documentación Automática
Para este tipo de documentación, existen software que documentan. Pero estos software no están disponibles para todas las plataformas, por lo que hay que revisar bien el ambiente en que se trabaja para ver si existe algún software de documentación compatible.
Este tipo de documentación es muy útil para:
a) Ubicar o dimensionar (definir plazo y costo) de trabajos de mantenimiento de software. Su utilización requiere de que el software a analizar haya sido desarrollado en base a alguna norma y que esta norma haya sido respetada.
b) Apoyar labores de auditoria y control.
Ventajas:
- Es inmediata y está siempre actualizada.
- Más rápida.
- Justo a lo requerido.
- No se encuentra sujeta a la disposición del personal.
Desventajas:
- Consume recursos de Hardware.
- No guarda historia, no obstante es posible ir guardando en medios magnéticos las diferentes documentaciones obtenidas en el tiempo y de esta forma ir conservando historia.
- No siempre disponible, pues no hay disponibilidad para todas las plataformas.
- No es explicativa
- Costo, es un software que debe adquirirse
Los dos tipos de documentación no son incompatibles entre sí, por lo que se puede lograr un equilibrio entre ambas para lograr una buena documentación a un buen costo.
Existen elementos que son necesarios de mantener documentados, como:
Manuales. Pueden estar en cualquier medio, ya sea en papel, CD, diskette, etc. Existen varios tipos de manuales, como:
- Usuario
Este manual explica a los usuarios o clientes, como es la utilización del Software, sus posibles errores, que funciones cumple, como se instala el Software, sus requerimientos, etc. En las aplicaciones se incluye este manual en línea al cual el usuario puede acceder a él normalmente apretando la tecla de Help en cualquier opción en que se encuentre trabajando dentro de la aplicación, adicionalmente está el manual de FAQ (frequent asked questions) que es un resumen con las respuestas a las preguntas mas frecuentes que se hacen los usuarios.
- Técnico
Destinado para uso operacional, este manual señala como se manejan los respaldos, la conexión de equipos periféricos, etc. Según las características de las aplicaciones, este manual puede existir o no.
- Errores
Indica que hacer ante la posible ocurrencia de errores y como solucionarlos. Estos errores no son del sistema, sino que son errores que el usuario puede cometer.
- Sistemas
Explica qué hace la aplicación, pero se los explica a los técnicos utilizando un lenguaje técnico, ya que está orientada a informática.
- Interna
Es documentación que se encuentra dentro de cada uno de los programas, indicando como funcionan éstos. Permite que el programador entienda cómo se ejecuta el programa y también deben registrar todos los cambios efectuados al programa a manera de documentación
Toda esta documentación está dentro del programa fuente, ya que si éste no viene no es posible realizar ningún tipo de modificación a la aplicación.
La documentación básica necesaria de un sistema de información deberá contar con:
- Carpeta de papeles de trabajo (análisis):
- Síntesis del documento de generación
- Presupuesto o plan de fijación de tareas
- Documentación del relevamiento detallado
- Formularios o comprobantes analizados
- Papeles de trabajo del análisis
- Estudio de factibilidad y diagnóstico
- Carpeta de sistemas (diseño global):
- Fijación de los objetivos del sistema
- Descripción global del sistema
- Modelo lógico del sistema (DFD, diccionario de datos, especificación de la lógica)
- Diseño de entradas y salidas
- Normas y procedimientos para los usuarios (en operaciones de rutina, de respaldo, de emergencia, de recupero, de uso de back-up)
- Recursos materiales y humanos necesarios
- Estudio técnico-económico acerca de la posibilidad de procesar el sistema mediante el uso de un computador
- Carpeta de programas (diseño detallado):
- Descripción detallista del programa
- Diagrama de lógica
- Descripción de entradas
- Descripción de salidas
- Descripción de archivos
- Tablas, cuadros de control de consistencia y parámetros utilizados
- Controles del programa sobre archivos y datos
- Carpeta de operaciones:
- Normas de control de entradas, salidas y de procesamientos
- Normas de operación, de recupero, de back-up, de seguridad de archivos
- Cronograma de procesos
- Descripción de usuarios
Los elementos que conforman la documentación de los sistemas, pueden ser categorizados como imprescindibles (aquellos que no pueden ser omitidos) y convencionales (aquellos que enriquecen los antecedentes documentales del sistema, pero su omisión no tendrá consecuencias irremediables).
Costo de la documentación: Solo se justifica documentar cuando los beneficios de esa documentación superan los costos de la misma.
Si bien es difícil establecer el costo de la documentación, es posible realizar su cálculo considerando:
- El costo directo de los elementos materiales insumidos para documentar los sistemas.
- El costo de los recursos humanos (horas/hombre) afectados a su preparación y posterior mantenimiento o actualización
La mayor dificultad surge con relación a la determinación del otro parámetro de la relación, es decir, el “beneficio” de la documentación, siendo en algunas ocasiones casi imposible cuantificar dicho elemento.
Si bien es difícil establecer la relación costo-beneficio, es indispensable señalar la necesidad de su economicidad.
Programas documentadores: Se puede documentar con procesadores de texto, como por ejemplo Word. Un programa que se puede utilizar para diseñar y/o documentar es el Erwin.
Un programa exclusivo para hacer o documentar manuales de usuarios es el Help Workshop (archivo de ayuda con extensión HLP).
Otra manera de documentar la instalación y manejo de una aplicación es generando archivos en formato HTML (como una página Web). Se puede crear con Front page, Drean Weaver.
En la etapa de diseño de sistemas, se puede utilizar Microsoft Visio (es utilizado para realizar diagramas como los de flujo de datos, de bloque, organigramas, etc. y a su vez documentar).
Hay programas, que documentan a partir del código. Por ejemplo, podría ser el Visual Fox, es un lenguaje de programación, el cual puede ser utilizado para documentar.
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.
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.
Existen dos tipos de documentaciones, que son:
Documentación Manual
Este tipo de documentación se efectúa manualmente. Puede documentarse en papel o en algún medio magnético como disquete o CD. Se cuenta con apoyo de Software para su confección, como un procesador de texto, planilla electrónica y programas graficadores.
Ventajas:
- Refleja historia.
- Muestra la evolución de la documentación en el tiempo.
- Más explicativa.
- Se adecua a la cultura de la organización.
- No consume capacidad de procesamiento.
Desventajas:
- Consume mucho esfuerzo en construirla.
- Documentación incompleta.
- Poca disposición para entregar información.
- Más lenta y sin actualizar.
- Errores de escritura
Documentación Automática
Para este tipo de documentación, existen software que documentan. Pero estos software no están disponibles para todas las plataformas, por lo que hay que revisar bien el ambiente en que se trabaja para ver si existe algún software de documentación compatible.
Este tipo de documentación es muy útil para:
a) Ubicar o dimensionar (definir plazo y costo) de trabajos de mantenimiento de software. Su utilización requiere de que el software a analizar haya sido desarrollado en base a alguna norma y que esta norma haya sido respetada.
b) Apoyar labores de auditoria y control.
Ventajas:
- Es inmediata y está siempre actualizada.
- Más rápida.
- Justo a lo requerido.
- No se encuentra sujeta a la disposición del personal.
Desventajas:
- Consume recursos de Hardware.
- No guarda historia, no obstante es posible ir guardando en medios magnéticos las diferentes documentaciones obtenidas en el tiempo y de esta forma ir conservando historia.
- No siempre disponible, pues no hay disponibilidad para todas las plataformas.
- No es explicativa
- Costo, es un software que debe adquirirse
Los dos tipos de documentación no son incompatibles entre sí, por lo que se puede lograr un equilibrio entre ambas para lograr una buena documentación a un buen costo.
Existen elementos que son necesarios de mantener documentados, como:
Manuales. Pueden estar en cualquier medio, ya sea en papel, CD, diskette, etc. Existen varios tipos de manuales, como:
- Usuario
Este manual explica a los usuarios o clientes, como es la utilización del Software, sus posibles errores, que funciones cumple, como se instala el Software, sus requerimientos, etc. En las aplicaciones se incluye este manual en línea al cual el usuario puede acceder a él normalmente apretando la tecla de Help en cualquier opción en que se encuentre trabajando dentro de la aplicación, adicionalmente está el manual de FAQ (frequent asked questions) que es un resumen con las respuestas a las preguntas mas frecuentes que se hacen los usuarios.
- Técnico
Destinado para uso operacional, este manual señala como se manejan los respaldos, la conexión de equipos periféricos, etc. Según las características de las aplicaciones, este manual puede existir o no.
- Errores
Indica que hacer ante la posible ocurrencia de errores y como solucionarlos. Estos errores no son del sistema, sino que son errores que el usuario puede cometer.
- Sistemas
Explica qué hace la aplicación, pero se los explica a los técnicos utilizando un lenguaje técnico, ya que está orientada a informática.
- Interna
Es documentación que se encuentra dentro de cada uno de los programas, indicando como funcionan éstos. Permite que el programador entienda cómo se ejecuta el programa y también deben registrar todos los cambios efectuados al programa a manera de documentación
Toda esta documentación está dentro del programa fuente, ya que si éste no viene no es posible realizar ningún tipo de modificación a la aplicación.
La documentación básica necesaria de un sistema de información deberá contar con:
- Carpeta de papeles de trabajo (análisis):
- Síntesis del documento de generación
- Presupuesto o plan de fijación de tareas
- Documentación del relevamiento detallado
- Formularios o comprobantes analizados
- Papeles de trabajo del análisis
- Estudio de factibilidad y diagnóstico
- Carpeta de sistemas (diseño global):
- Fijación de los objetivos del sistema
- Descripción global del sistema
- Modelo lógico del sistema (DFD, diccionario de datos, especificación de la lógica)
- Diseño de entradas y salidas
- Normas y procedimientos para los usuarios (en operaciones de rutina, de respaldo, de emergencia, de recupero, de uso de back-up)
- Recursos materiales y humanos necesarios
- Estudio técnico-económico acerca de la posibilidad de procesar el sistema mediante el uso de un computador
- Carpeta de programas (diseño detallado):
- Descripción detallista del programa
- Diagrama de lógica
- Descripción de entradas
- Descripción de salidas
- Descripción de archivos
- Tablas, cuadros de control de consistencia y parámetros utilizados
- Controles del programa sobre archivos y datos
- Carpeta de operaciones:
- Normas de control de entradas, salidas y de procesamientos
- Normas de operación, de recupero, de back-up, de seguridad de archivos
- Cronograma de procesos
- Descripción de usuarios
Los elementos que conforman la documentación de los sistemas, pueden ser categorizados como imprescindibles (aquellos que no pueden ser omitidos) y convencionales (aquellos que enriquecen los antecedentes documentales del sistema, pero su omisión no tendrá consecuencias irremediables).
Costo de la documentación: Solo se justifica documentar cuando los beneficios de esa documentación superan los costos de la misma.
Si bien es difícil establecer el costo de la documentación, es posible realizar su cálculo considerando:
- El costo directo de los elementos materiales insumidos para documentar los sistemas.
- El costo de los recursos humanos (horas/hombre) afectados a su preparación y posterior mantenimiento o actualización
La mayor dificultad surge con relación a la determinación del otro parámetro de la relación, es decir, el “beneficio” de la documentación, siendo en algunas ocasiones casi imposible cuantificar dicho elemento.
Si bien es difícil establecer la relación costo-beneficio, es indispensable señalar la necesidad de su economicidad.
Programas documentadores: Se puede documentar con procesadores de texto, como por ejemplo Word. Un programa que se puede utilizar para diseñar y/o documentar es el Erwin.
Un programa exclusivo para hacer o documentar manuales de usuarios es el Help Workshop (archivo de ayuda con extensión HLP).
Otra manera de documentar la instalación y manejo de una aplicación es generando archivos en formato HTML (como una página Web). Se puede crear con Front page, Drean Weaver.
En la etapa de diseño de sistemas, se puede utilizar Microsoft Visio (es utilizado para realizar diagramas como los de flujo de datos, de bloque, organigramas, etc. y a su vez documentar).
Hay programas, que documentan a partir del código. Por ejemplo, podría ser el Visual Fox, es un lenguaje de programación, el cual puede ser utilizado para documentar.
No hay comentarios:
Publicar un comentario
JUSTIN