INTEGRANTES DEL EQUIPO

BIENVENIDOS A NUESTRO BLOG DE SISTEMAS DE DOCUMENTACION

En este blog encontraras contenido de los siguientes temas:

TEMA 1: Documentación de sistemas, importancia, ventajas de la estandarización, organización requerida para el establecimiento de estandares.

TEMA 2: Objetivos de la documentación de sistemas, plan de desarrollo y plan de implementación.

TEMA 3: Estándares para la documentación de sistemas mecanizados, símbolos para documentar programas y sistemas, estándares para documentar archivos y diseños de registros.

TEMA 4: Manual de diseños

Manual de análisis

Manual de programación

Manual de operaciones








PROF: MARIELA DIAZ - SECCIÓN "C"

INTEGRANTES DEL EQUIPO: Gabriela Monsalve - Jorge Nuñez - Mayra Gonzalez - Marly Maurera - Maryurys Astudillo -

jueves, 11 de febrero de 2010

TEMA 2

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.

TEMA 1

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 operarios como hacerlo funcionar.
Para que toda aplicación tecnológica y todo servicio informático quede adecuadamente documentado, es necesario exigirle a quien lo diseñe y/o desarrolle (puede ser personal interno o un proveedor) que entregue dicha documentación obtenida a través del desarrollo del proyecto, de manera que otras personas relacionadas o autorizadas por la empresa accedan a los conocimientos necesarios para corregir errores, hacer ajustes, etc.
Existen elementos que son necesarios 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 (Sw), sus posibles errores, que funciones cumple, como se instala el Sw, 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, dirigido a los técnicos utilizando un lenguaje técnico, ya que está orientada a informática.
Interna: Esta documentación 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.
Importancia.
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 el menor tiempo y se le presta menos atención.
Es importante contar con un buen sistema de administración de documentos para poder almacenar y recuperar la información. Los documentos son un recurso y activo organizacional. Como recurso, proveen información y como activo, proveen documentación. Si utilizamos sistemas automatizados para archivar la información, éstos nos ayudan a localizar el documento en una forma más rápida en caso de fallas, desconocimiento o algún otro inconveniente que se presente a la hora de poner en funcionamiento una software.
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.
Organización requerida para el establecimiento de estándares.
PROCESO ADMINISTRATIVO
DEFINICIONES:
Un proceso es una forma sistemática de hacer las cosas.
La administración es el proceso por el cual se lleva acabo la planeación, organización, dirección y control y busca el logro de los objetivos organizacionales establecidos.
Se ha dado en llamar a la administración el arte de hacer las cosas a través de la gente. Esta definición de Mary Parker Follett destaca el hecho de que los administradores logran objetivos organizacionales a través de otros.
El proceso de administración se refiere a planear y organizar la estructura de las empresas, en la cual se ejecutan dirección y control para darle seguimiento a los procesos administrativos.
ETAPAS
Mecánica:
Por lo cual podemos decir que es la fase donde realiza la estructura principal de la misma empresa
-Planeación
-Organizacional
-Dinámica
Por lo cual podemos definir que es la fase donde se realiza ejecución con eficiencia y eficacia de la misma empresa.
-Integración.
-Dirección.
-Control.
FASES
PLANEACION:
Implica que los administradores piensen, a través de sus objetivos y acciones, y con anticipación, que sus acciones se basan en algún método, plan o lógica, mas que una mera suposición. Los planes dan a la organización sus objetivos y fijan el mejor procedimiento para obtenerlos. El primer paso en la planeación es la selección de las metas de la organización.
Consiste en seleccionar misiones y objetivos, así como las acciones necesarias para cumplirlos, y requiere por lo tanto de la toma de decisiones; esto es de la elección de cursos de acción futuros apartir de diversas alternativas. Existen varios tipos de planes, los cuales van desde los propósitos y objetivos generales, hasta las acciones mas detalladas por emprender.
ORGANIZACIÓN: Es el proceso de disponer y destinar el trabajo, la autoridad y los recursos entre los miembros de una organización en una forma tal que pueda logra los objetivos de la organización de manera eficiente. Los administradores deben adecuar la estructura de la organización con sus objetivos y recursos, un proceso que se denomina DISEÑO ORGANIZACIONAL.
Es la parte de la administración que supone el establecimiento de una estructura intencionada de los papeles que los individuos deberán desempeñar en una empresa. La estructura es intencionada en el sentido de que debe garantizar la asignación de todas las tareas necesarias para el cumplimiento de las metas, asignación que debe hacerse a las personas mejor capacitadas para realizar estas tareas.
INTEGRACIÓN: Consiste en los procedimientos para dotar al organismo social de todos aquellos elementos, tanto humanos como materiales, que la mecánica administrativa señala como necesarios para su más eficaz funcionamiento, escogiéndolos, introduciéndolos, articulándolos, y buscando su mejor desarrollo. Aunque la INTEGRACIÓN comprende cosas y personas lógicamente es más importante lo de las personas y, sobre todo, la de los elementos administrativos o de mando.
Consiste en ocupara y mantener así los puestos de la estructura organizacional. Esto se realiza mediante de la identificación de los requerimientos de fuerza de trabajo, el inventario de las personas disponibles y el reclutamiento, selección, contratación, ascenso, evaluación, planeación de carrera, compensación y capacitación o desarrollo, tanto de candidatos como de empleados en funciones a fin de que puedan cumplir eficaz y eficientemente sus tareas.
DIRECCIÓN: Es impulsar, coordinar y vigilar las acciones de cada miembro y grupo de un organismo social, con el fin de que el conjunto de todas ellas realice del modo más eficaz los planes señalados.
Es el hecho de influir en los individuos para que contribuyan a favor del cumplimiento de las metas organizacionales y grupales; por lo tanto, tiene que ver fundamentalmente con el aspecto interpersonal de la administración.
CONTROL: Consiste en el establecimiento de sistemas que permitan medir los resultados actuales y pasados, en relación con los esperados con el fin de saber si se ha obtenido lo que se esperaba, a fin de corregir y mejorar y además para formular nuevos planes.El administrador debe cerciorarse de que las acciones de los miembros de la organización la lleven a la obtención de sus metas.
Consiste en medir y corregir el desempeño individual y organizacional para garantizar que los hechos se apeguen a los planes. Implica la medición del desempeño con base en metas y planes, la detección de desviaciones respecto a las normas y la contribución de la corrección de estas. En pocas palabra el control facilita el cumplimiento de los planes; Las actividades del control suelen relacionarse con la medición de los logros.
ELEMENTOS:
1. PLANEACION.
PROPÓSITOS O MISIONES:
Se identifica la función o tarea básica de una empresa o institución o de una parte de esta.
OBJETIVOS O METAS:
Los objetivos o metas son los fines que se persiguen por medio de una actividad de una u otra índole.
ESTRATEGIAS:
Es la determinación de los objetivos básicos a largo plazo de una empresa y la adopción de los recursos de acción y la asignación de recursos necesarios para su cumplimiento.
POLÍTICAS:
Son enunciados o criterios generales que orientan o encausan el pensamiento en la toma de decisiones.
PROCEDIMIENTOS:
Son planes por medio de los cuales se establece un método para el manejo de actividades futuras.
REGLAS:
Se exponen acciones o prohibiciones especificas, no sujetas a discrecionalidad de cada persona.
PROGRAMAS:
Son un conjunto de metas, políticas, procedimientos, reglas, asignaciones de tareas, pasos a seguir, recursos por emplear y otros elementos necesarios para llevar a cabo un curso de acción dado.
PRESUPUESTOS:
Es la formulación de resultados esperados expresada en términos numéricos.
2. ORGANIZACIÓN:
FUNCIONES:
La identificación y la clasificación de las actividades requeridas.
La agrupación de las actividades necesarias para el cumplimiento de los objetivos.
La asignación de cada grupo de actividades a un administrador dotado de la autoridad (delegación) necesaria para supervisarlo y,
La estipulación de coordinación horizontal ( en un mismo o similar nivel organizacional) y vertical ( entre las oficinas generales, una división y un departamento) en la estructura organizacional.
JERARQUIAS:
Fijar la autoridad y la responsabilidad correspondiente a cada nivel existe dentro de una organización.
PUESTOS:
Las obligaciones y requisitos que tienen en concreto cada unidad de trabajo susceptible de ser desempeñada por una persona.
3. INTEGRACIÓN:
Selección, es proceso para elegir entre varios candidatos, dentro o fuera de la organización a la persona mas indicada para ocupar un puesto en ese mismo momento o en el futuro.
Introducción, la mejor manera para lograr que los nuevos elementos se articulen lo mas optima y rápidamente que sea posible al organismo social.
Desarrollo, es un método sistemático integrado y planeado que se realiza a través de la capacitación, el adiestramiento y la formación del personal para elevar la eficacia de grupos de personas y de la organización o de una unidad organizacional importante.
4. DIRECCIÓN:
Autoridad y mando, es el principio del que deriva toda la
Administración y, por lo mismo, su elemento principal, que es la dirección o liderazgo arte o proceso de influir en las personas.
Comunicación, es la transferencia de información de un emisor a un receptor, el cual debe estar en condiciones de comprenderla.
Delegación, es la forma técnica para comunicar a los subordinados la facultad de decidir sin perder el control de lo que se ejecuta.
Supervisión, es revisar si las cosas se están haciendo tal y como se habían planeado y ordenado.
5. CONTROL:
Establecimiento de normas, es sencillamente criterio de desempeño, son los puntos seleccionados de un programa de planeación para que los administradores puedan recibir señales de cómo marchan las cosas.
Medición del desempeño, debe realizarse idealmente con fundamento en la previsión a fin de que las desviaciones puedan detectarse antes de que ocurran y evitarse mediante las acciones apropiadas.
Corrección de las variaciones respecto de normas y planes, es el punto de control puede concebirse como parte del sistema total de administración y ponerse en relación con las demás funciones administrativas.
Glosario
Remuneración
Aquello que se da o sirve para numerar
Articulación
Pronunciación clara y distinta de las palabras
Adiestramiento
Hacer diestro enseñar instruir
Discrecionalidad
Cualidad de ser discreto
Previsión
Visión o conocimientos anticipados
Compensación
Sistema de ejecución de planes que asumen dicha ejecución.
ESTABLECIMIENTO DE ESTÁNDARES.
Es cuando se establecen los criterios de -evaluación o comparación. Existen cuatro tipos de estándares estos son:
· ESTÁNDAR DE CANTIDAD: Como volumen de producción, cantidad de existencias, cantidad de materia prima, número de horas, etc.
· ESTÁNDAR DE CALIDAD: Como control de calidad de materia prima, control de calidad de producción, especificaciones del producto, etc.
· ESTÁNDAR DE TIEMPO: Como tiempo estándar para producir un determinado producto tiempo medido de existencias de un determinado producto, etc.
· ESTÁNDAR DE COSTOS: Como costos de producción, costos de administración, costo estándar, costos de ventas, etc.
Un estándar puede ser definido como una unidad de medida que sirve como modelo, guía o patrón con base en la cual se efectúa el control.
Los estándares representan el estado de ejecución deseado, de hecho, no son más que los objetivos definidos de la organización.
Funciones básicas y áreas claves del resultado:
1.- Rendimiento de beneficios: Es la expresión le los beneficios obtenidos por la empresa,
2. Posición en el mercado: Estándares utilizados para determinar la aceptación de algún producto en el mercado, y la efectividad de las técnicas mercadológicas.
3. Productividad: Este tipo de modelo debe establecerse no sólo para el área de producción, sino para todas las áreas de la empresa
4. calidad del producto: Este estándar se establece para determinar la primacía en cuanto a calidad del producto, en relación con la competencia.
5. Desarrollo del personal: Su objeto es medir los programas de des arrollo de la gerencia, y su efectividad.
6. Evaluación de la actuación: Establece las condiciones que deben existir para que el trabajo se desempeñe satisfactoriamente; sirve para determinar, objetivamente, los límites de productividad del personal de la empresa.

domingo, 7 de febrero de 2010

TEMA 4

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
1. 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 permitir a la alta gerencia tener 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
Nombre del sistema
Describir el nombre del sistema a implantar en la empresa.
Equipo encargado del Sistema
Nombre del personal encargado del análisis y diseño del sistema.
Resumen Administrativo
Un compendio de lo puntos que se describen en el manual, el cual tiene como propósito permitir a los altos ejecutivos enterarse en forma somera de la propuesta del sistema. En este punto aparece por primera vez el nombre del sistema, el cual debe ser único, este deberá conservarse invariable en todos los documentos referentes a ese sistema.
Planteamiento
Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del analisis del sistema. Se debe mencionar:
Dependencia que requirió el trabajo.
Personas o puestos ocupados por éstas al momento de requerirse el trabajo (acuerdos, disposiciones legales, memorandos, y otros).
Condiciones y criterios que normaron el desarrollo del trabajo.Fechas correspondientes.
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.
Ejemplo:


Salidas Del Sistema (Resultados a Obtener)
En este punto, solamente se describien los resultados de mayor importancia obtenidos a través de todo el proceso. En esta sección se da mayor énfasis a la información que el sistema proporciona cuidando de no hacer tan sólo mención de los resultados a obtener. Ejemplo:

Diagramación General del Sistema
Es la representación gráfica de las fases del Sistema y su flujo a través de las dependencias que intervienen en el mismo, aunque en forma generalizada. La técnica a utilizar y la simbología debe ser seleccionada por los interesados.
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 pricesos en las cuáles se obtengan resultados de importancia así como aquellas que requieran una supervisiòn especial.
Requerimientos Del Sistema
Se establecen los recursos, tanto humanos como materiales que son necesarios para poder llevar a cabo el sistema. Se Presen costos y descripciòn, además de las cantidades que se requieran.
Estimación de la Fecha Probable de Implementacion 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 Grantt o de Pert para establecer el período de las actividades requeridas para el desarrollo del sistema.
Ejemplo:
Escala del tiempo en semanas


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 segurida, disminución de costo, ahorro de tiempo, flexibilidad, confiabilidad y otros. Además, desarrollar en cualquier aspecto de la propuesta del sistema que no file considerado en el desarrollo de los puntos antes mencionados.
2. Manual De Usuario
Expone los procesos0 que el usuario puede realizar con el sistema implantado. Para lograr esto, es necesario que se detallen todas y cada una de las caracteristicas 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 la aplicación desarrollada.
Objetivos
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.Informar al usuario de la respuesta a cada mensaje de error.
Pasos a seguir para definir como 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
El Manual de Usuario facilita el conocimiento de:
Los documentos a los que se pueden dar entrada por computadora. Los formatos de los documentos.
Las operaciones que utiliza de entrada y salida de los datos.
El orden del tratamiento de la computadora con los datos introducidos.
El momento en que se debe solicitar una operación deseada.
Los resultados de las operaciones realizadas a partir de los datos introducidos.
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.
Contenido
Diagrama general del sistema
Muestra en forma condensada el flujo general de la información y de las actividades que se realizan en el sistema. Proporciona una visión general del sistema. Representar los diagramas utilizando para ello diagramas de bloques.
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.
Explicación Genérica de las Fases del Sistema
En este punto se explica en forma específica y detallada todas las operaciones que aparecen representadas en forma gráfica en el diagrama particular. Se analizan cada una de las fases señalando:
-El proceso principal que se desarrolla.
-La entrada de la información.
-La obtención de un resultado parcial.
-El envío de información a otra dependencia.
Instalación Del Sistema
La instalación del sistema proporciona detalles completos sobre la forma de instalar el sistema en un ambiente particular.
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.
Pasos a seguir para la elaboración del manual del usuario:
1. Portada: De que se trata el documento y quién lo elaboro
2. Introducción: Describe el uso del documento (para qué sirve) y de qué habla.
3. Análisis y requerimientos del sistema.
3. Explicación del funcionamiento: Se debe poner paso a paso y con pantallas bien explicadas como funciona el programa
4. Glosario
• Debe ser escrito de tal manera, que cualquier persona pueda entenderlo con la menor dificultad posible.
• Es recomendable, detallar todos aquellos pasos que se llevan a cabo para usar el programa.
• Especificar los alcances y las limitaciones que tiene el programa.
• Un buen punto de partida para un manual de usuario, es hacer de cuenta que las personas que lo van a leer no tienen el mas mínimo conocimiento sobre computadores.
3. 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.
Caducidad de Documento Fuente y Destino Final
Como el usuario trabajará con documentos fuentes, éstos podrán tener un período de retención y un destino especificado.
4. Manual De Captacion
Permite tener una clara visión del proceso de Captación de los datos fuentes previo al procesamiento electrónico de los mismos.
Objetivos
Documentar al usuario a cerca del recorrido a través de las pantallas del sistema.
Conocer la forma cómo el usuario puede utilizar el equipo necesario para la ejecución del sistema.
Contenido
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).
Diagramas De Pantalla
Presentar 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 para llegar a la pantalla.
Formato de los datos a captar.
Formato en que son captados los datos.
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.
Equipo utilizado para la Captación.
Se debe crear un instructivo que permita al usuario el entrenamiento del sistema.
Debe contener los siguientes puntos:
Uso del equipo:
Describir detalladamente el uso correcto del equipo utilizado para la captación de la información, dando una explicación del encendido, manejo, control y del material que se usa como medio de captación de los datos.
Entrenamiento del Software de la aplicación:
Explicación del software utilizado en complemento al sistema.
Ejemplo: como entrar y salir del sistema.
Situaciones Anormales
Se presentan mensajes que se emiten al momento de la captura de los datos o cualquier condición fuera de lo normal. Ejemplo:
Situación anormal
Mensaje
Causas
Soluciones
Entregas al Computador
Establecer un calendario con fechas de entrega al computador, al igual que un horario para la obtención de resultados.
El calendario determina cuándo las actividades deben llevarse a cabo de manera que la gestión del sistema no se vea afectado. Si es un sistema en línea no se requiere. Ejemplo:
Operación
Frecuencia
Objetivo
Hora de Entrada
Hora de salida
Solicitud de reporte
Semanal
Mensual
Actualizar informe del departamento X
Antes de las 2:00 p.m.
3:00 p.m.
Caducidad De Documentos Fuentes
Establecer por escrito la fecha de caducidad de los documentos fuentes, el fin a que han de destinarse ya sea para su destrucción, devolución o conservación en un archivo.
5. Manual de operación
Objetivo
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
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.
Formato en que son captados los datos.
Instructivo de operación por Programa.
Se debe desarrollar por cada programa del sistema. Incluye:
Diagrama electrónico del programa.
6. Manual Técnico

Este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento. Por ejemplo: características de procesadores, velocidad, dimensiones del equipo, garantías, soporte, proveedores y equipo adicional.

Su extensión depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en forma de fichas técnicas en donde se describe en cada una las características de cada recurso.

CONSIDERACIONES GENERALES PARA LA DOCUMENTACIÓN DE EL DESARROLLO DE APLICACIONES INFORMÁTICAS:

1. Toda documentación que se genere para un proyecto específico, que haya sido revisada y aprobada, debe poseer lo siguiente:

A) Identificación del documento
Este documento debe incorporar la siguiente información:
• Logotipo de la organización.
• Nombre oficial de la organización.
• Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.
• Lugar y fecha de elaboración.
• Número de revisión (si aplica).
• Unidades responsables de su elaboración, revisión o autorización.
• Clave de la forma. En primer término, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por último, el número de la forma. Entre las siglas y el número debe colocarse un guión o diagonal. (si aplica)
B) Estructura del documento.
2. Por cada documento final deberá entregarse copias al personal involucrado en el proyecto.
3. Una vez concluido el desarrollo de un sistema, considerando para esto los posibles cambios que se efectúen durante la etapa de garantía de que lo cubre (si así fuera el caso), el usuario final del sistema debe recibir una versión actualizada final del documento.
Estructura del documento MANUAL TÉCNICO
1. Índice
Relación de los capítulos y páginas correspondientes que forman parte del documento
2. Introducción.
Se debe presentar una breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cual es su función principal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la máxima autoridad de las áreas comprendidas en el manual.
2.1. Objetivo general del sistema
Se debe de describir el objetivo general del sistema.
2.2. Objetivos específicos
Se deben describir brevemente los objetivos específicos que se cumplieron con el desarrollo del sistema.
3. Contenido técnico
3.1. Definición de reglas del negocio implementadas en el sistema desarrollado.
3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos.
3.3. Controles de auditoria implementados en el sistema.
3.4. Descripción de campos requeridos por pantalla con presentación de pantallas.
3.5. Diagrama de navegación del sistema.
3.6. Requerimientos de interfase con otros sistemas.
3.7. Modelo lógico de datos, diagrama entidad-relación.
3.8. Modelo de datos físico, junto con su respectivo diccionario de datos.
3.9. Matriz de procesos versus organización.
3.10. Matriz de programas versus entidades.
3.11. Plataforma de usuario. Aquí se describen los requerimientos mínimos que se deben tener tanto de hardware como de software para que el sistema se pueda instalar y ejecutar correctamente (en caso de que se considere necesario).
3.12. Áreas de aplicación o alcance de los procedimientos. Esfera de acción que cubren los procedimientos
4. Responsables.
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable prever que no queda diluida la responsabilidad de la conducción de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo técnico, al que se le debe encomendar la conducción del proyecto en sus fases de diseño, implantación y actualización.
De esta manera se logra homogeneidad en el contenido y presentación de la información. Por lo que respecta a las características del equipo técnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organización en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organización puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular del área específica. Asimismo, puede contratar los servicios de consultores externos.
4.1. Mapa de navegación. Muestra de forma gráfica la interconexión entre cada una de las pantallas del sistema, lo que serviría para saber como llegar a determinada parte de la aplicación. En este se muestran los menús, submenús y pantallas a las que nos lleva cada uno de ellos
4.2. Descripción gráfica del mapa de navegación. En el anterior aparece de forma de diagrama de flujo y en esta sección deberá aparecer ya con las respectivas pantallas.
4.3. Describe paso a paso los procesos, así como pantallas, botones, cuadros de texto, etc., pero también se muestra el código de cada rutina, pantalla, botón, etc. es decir, se muestra lo que hay detrás de la interfaz del usuario y la elaboración del Manual Técnico