You are on page 1of 17

Documentación de los Sistemas de

Información

Facilitadora: Ing. Sullin Santaella


Contenido

Documentación de los SI

Importancia de la Documentación de los SI

Tipos de Documentación de los SI

Contenido de los Manuales de Usuarios

Estandarización de la Documentación

Company Logo
Facilitadora: Ing. Sullin Santaella
Documentación

La documentación es un
conjunto de elementos
registrados sobre
cualquier soporte que
permita instruir o informar
acerca de algo, en
función de las
necesidades específicas
de aquellos que la
utilizan.

Company Logo
Facilitadora: Ing. Sullin Santaella
Documentación de los SI

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.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

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.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

La elaboración de la documentación es un proceso


esencial para poder garantizar la calidad del software, lo
cual requiere una adecuada asignación de recursos
financieros, materiales, humanos y de tiempo, o sea, la
calidad del proceso de elaboración de la documentación se
traduce en calidad del software. De la efectividad de la
documentación depende en gran medida el éxito de los
proyectos de sistemas o productos de software.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

•Constituye el respaldo •Facilita el conocimiento,


formal de la información interpretación, comprensión y
divulgación del sistema.

•Es el elemento integrador que


permite la apreciación unitaria
y conjunta del sistema.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

•Constituye un elemento imprescindible para el control


interno en general y del sistema en particular; provee los
antecedentes que permiten conocer como se ha diseñado
el sistema y como debería estar operando, o sea facilita el
parámetro de referencia contra el cual se analizará y/o
enjuiciará su comportamiento real.

•Sirve de base para auditar


los sistemas de información.
•Elimina los riesgos de dependencia
con respecto a determinados individuos
que conocen el sistema.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

•Es un elemento fundamental para la


adecuada capacitación de los usuarios del
sistema y facilita la comunicación con los
mismos.

•Provee antecedentes esenciales, concretos


y permanentes para evaluar eventuales
modificaciones a sistemas en su
funcionamiento y/o para decidir la sustitución
de los mismos.

•Constituye el único medio idóneo de consulta general


para poder tomar conocimiento actualizado de los
sistemas en funcionamiento en la organización.

Company Logo
Facilitadora: Ing. Sullin Santaella
Importancia de la documentación en los SI

•Aumenta la seguridad y •Resulta imprescindible como


eficiencia en el elemento de juicio para la
mantenimiento de los evaluación de sistemas
sistemas y reduce su costo. stándars o programas producto
susceptible de ser adquiridos.

•Para obtener resultados prácticos, la


documentación vigente debe mantener su utilidad en
el tiempo y no solo en un momento determinado. No
se concibe un sistema que no esté documentado.

Company Logo
Facilitadora: Ing. Sullin Santaella
Tipos de documentación de los SI

•La de programas, que


explica la lógica de un
programa e incluye
descripciones,
diagramas de flujo,
listados de programas
y otros documentos.

Company Logo
Facilitadora: Ing. Sullin Santaella
Tipos de documentación de los SI

•Para usuarios, en forma general


explica la naturaleza y
capacidades del sistema y cómo
usarlo.

Company Logo
Facilitadora: Ing. Sullin Santaella
Contenido de los Manuales de Usuarios

Políticas y normas referentes al desarrollo del sistema,


su implantación, operación y mantenimiento:

2. Procedimientos
1. Procedimientos
para operar el
para instalar el
sistema de
sistema de
información.
información.

3. Procedimientos para
mantener el sistema
de información.
Company Logo
Facilitadora: Ing. Sullin Santaella
Contenido de los Manuales de Usuarios

1. Portada: Nombre del documento y quién lo elaboro.

2. Introducción: Describe el uso del documento, para qué sirve y de


qué trata.

3. Análisis y requerimientos del sistema: Qué se necesita para


poder instalarlo y usarlo. (Requerimientos técnicos y
habilidades).

4. Explicación del funcionamiento: Mapa de navegación y


descripción de las pantallas bien explicadas. Se explican todas
las opciones que puede desarrollar el usuario del sistema.

5. Preguntas frecuentes (Opcional).

6. Glosario.

Company Logo
Facilitadora: Ing. Sullin Santaella
Estandarización de la Documentació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.

Company Logo
Facilitadora: Ing. Sullin Santaella
Estandarización de la Documentación

Consideraciones
Generales

•Especificar los alcances y


•Debe ser escrito de tal las limitaciones que tiene
manera, que cualquier el programa.
persona pueda entenderlo •Imaginarse que las
con la menor dificultad personas que lo van a leer
posible. no tienen el mas mínimo
•Es recomendable, detallar conocimiento sobre
todos aquellos pasos que computadores.
se llevan a cabo para usar •Usar una narrativa breve
el programa. y clara.

Company Logo
Facilitadora: Ing. Sullin Santaella
Facilitadora: Ing. Sullin Santaella

You might also like