República Bolivariana de Venezuela

Universidad Nacional Experimental “Simón Rodríguez”

Convenio CODA-Escuela de Enfermería
Licenciatura mención Informática
Cátedra: Sistemas de Documentación

SISTEMAS DE DOCUMENTACIÓN

Profesora: Participante:
Lic. Ibeth Parra TSU Marllory Guevara
C.I. No. 16.474.225
TSU Joyfrans Bellorin
C.I. No. 12.290.606
TSU José Fajardo
C.I. No. 9.674.602
 Caracas, 23 de Diciembre 2008
Introducción

Mediante el desarrollo de la investigación se obtendrá la información necesaria

para la documentación de sistemas, temas relacionados con la estandarización de
sistemas, y las técnicas básicas, ventajas, conceptos de normalización, la teoría
general de la documentación de sistemas, los manuales administrativos las técnicas y
normas para redactar las guías que servirán de apoyo a los usuarios. La importancia
de los sistemas de documentación de sistemas se basa en la posibilidad de informar a
cualquier usuario a fin de que este preparado para trabajar con el sistema que se le
presente.

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

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

Es importante asegurarse de que los estándares sean completos, actualizados,

documentados y legibles.
Auditar permanentemente para que se cumplan los estándares.
Evaluar si los estándares establecidos son los requeridos y hacer los cambios
necesarios para que dichos estándares sean los apropiados.

3
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 dc acuerdo a sus necesidades.

El estilo de redacción de los manuales de documentación debe ser:

a) Concreto.
b) Ser preciso y definir los términos utilizados.
c) Utilizar párrafos cortos.
d) Utilizar títulos y subtítulos.
e) Utilizar formas activas en lugar de pasivas.
f) No emplear frases largas que presenten hechos distintos.
g) No hacer referencia a una información solamente con el número de
referencia

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 silo 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.
a) Contenido
b) Nombre del sistema
c) Describir el nombre del sistema a implantar en la empresa.
d) Equipo Encargado Del Sistema
e) Nombre del personal encargado del análisis y diseño del sistema.

Resumen Administrativo

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

4
sistema.

Planteamiento

Este punto tiene como finalidad registrar los antecedentes que servirán de
partida al desarrollo del análisis del sistema. Se debe mencionar:
a) Dependencia que requirió el trabajo.
b) Personas y / o puestos ocupados por estas al momento de requerirse el trabajo
(acuerdos, disposiciones legales, memorandos, y otros)
c) Condiciones y criterios que normaron el desarrollo del trabajo.
d) 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:

Módulo o Usuarios que

Nombre del Origen del
Procedimiento donde manejan el
Documento Fuente documento
entra el documento documento

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. Ejemplo:

Periodicidad en que Usuarios que lo

Nombre de la salida Destino
se genera requieren

Diagramación General Del Sistema

Es la representación gráfica de las fases del Sistema y su flujo a través de las

5
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 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 recursos, tanto humanos como materiales que son necesarios
para poder llevar a cabo el sistema. Presentar 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

Actividades a
realizar 1 2 3 4
Presentación de la *****
Propuesta
Análisis *****
Costo / Beneficio
Adquisición del *****
Equipo
Entrenamiento *****

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

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

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 la
aplicación desarrollada.

Objetivos
a) Que el usuario conozca cómo preparar los datos de entrada.
b) Que el usuario aprenda a obtener los resultados y los datos de salida.
c) Servir como manual de aprendizaje.
d) Servir como manual de referencia.
e) Definir las funciones que debe realizar el usuario.
f) 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 tipo 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 puede 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.

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

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.

Manual De Captación

8
 Permite tener una clara visión del proceso de Captación de los latos 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.

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

a) Presentar en este punto el flujo del sistema en las pantallas utilizadas por cada
módulo.
b) Puntos a documentar en una pantalla:
c) Explicación del recorrido para llegar a la pantalla.
d) Formato de los datos a captar.
e) Formato en que son captados los datos.

f) 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.

9
 Situaciones Anormales

Se presentan mensajes que se emiten al momento de la captura de los datos o

cualquier condición fuera dc 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 marca cuándo las actividades deben llevarse a cabo dc
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 Semanal Actualizar Antes de las 2:00 p.m. 3:00 p.m.
reporte Mensual informe del
departamento X

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.

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.

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.

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

a) Puntos a documentar en una pantalla:

b) Explicación del recorrido en pantalla.
c) 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.

Herramientas para Documentar Procedimientos y Decisiones

Seguir procedimientos y tomar decisiones son aspectos importantes de cualquier

empresa. De hecho, la administración misma es, esencialmente, toma de decisiones.

11
 Conclusión

Los sistemas de documentación es la guía para que un usuario pueda identificar,

la misión, objetivos, características del sistema, es el que proporciona información,
según sea el caso, del desarrollo del mismo, de la utilización, a través de estos
manuales el usuario inexperto puede comenzar a trabajar con el sistema, sin que este
presente una persona que lo instruya paso a paso.
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.

12
 Bibliografía

Diéguez H., Rodolfo A. Documentación de Sistemas. [Trabajo descargado de

internet Diciembre2008,
http://www.monografias.com/trabajos6/dosi/dosi.shtml]

Senn, James A. Sistemas de Información. (2000) D.F.- Mexico. McGrawHill, Pp.

147-152.

13