REPÚBLICA BOLIVARIANA DE VENEZUELA

MINISTERIO DE EDUCACIÓN SUPERIOR

UNIVERSIDAD NACIONAL EXPERIMENTAL “SIMÓN RODRÍGUEZ”
ASIGNATURA: SISTEMAS DE DOCUMENTACIÓN
FACILITADOR: LINO SIMOES

DOCUMENTACIÓN DE SISTEMAS

Equipo #01
Participantes:

Angulo, Gustavo C.I: 12.835.136

Gómez, Carlos C.I: 6.180.377
Morgado, Javier C.I: 10.629.467
Nadales, Juan Carlos C.I: 11.199.668
Osorio, Samuel C.I: 16.681.765
Rojas, Manuel C.I: 10.276.200

Caracas, Marzo de 2009

6
 INDICE

INTRODUCCIÓN...........................................................................................2
DOCUMENTACIÓN........................................................................................3
ANTECEDENTES................................................................................................................. ..4
DOCUMENTACIÓN DE SISTEMAS...................................................................5
ESTÁNDARES BÁSICOS DE DOCUMENTACIÓN.................................................6
NORMALIZACIÓN.........................................................................................6
IMPORTANCIA DE LA DOCUMENTACIÓN DE SISTEMAS....................................7
TIPOS DE DOCUMENTACIÓN.........................................................................8
VENTAJAS....................................................................................................... ..................8
DESVENTAJAS............................................................................................................ .........8
VENTAJAS....................................................................................................... ..................9
DESVENTAJAS............................................................................................................ .........9
ALGUNOS SOFTWARE USADOS EN LA DOCUMENTACIÓN DE SISTEMAS..........10
QUÉ DOCUMENTAR ...................................................................................10
EJEMPLO DE POSIBLE DOCUMENTACIÓN DE UN SISTEMA:................................................................ ....11
REQUERIMIENTOS GENERALES PARA DOCUMENTACIÓN................................12
CONCLUSIÓN.............................................................................................13
BIBLIOGRAFÍA...........................................................................................14

INTRODUCCIÓN

6
 El interés por conservar la creación humana originó la documentación,
aunque concretamente, la historia de la escritura será la que guiará la evolución
de la documentación como ciencia científica.

En la medida en que la documentación tiene que ver con el documento

como fuente potencial y efectiva para obtener nueva información, se convierte en
disciplina instrumental, al servicio del crecimiento y transmisión de todos los
saberes.

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 administradores como hacerlo funcionar.

Mediante este trabajo se expone de manera sucinta acerca de la

documentación de los sistemas, además de ciertas consideraciones a tener en el
proceso.

Documentación

6
 La documentación es una disciplina científica que trata de recopilar,
almacenar, analizar y difundir información contenida en documentos de distinto
tipo para hacerla accesible a cualquier persona que pueda necesitarla.

La Documentación es una disciplina instrumental, ya que sirve a todas las

demás ciencias para localizar información necesaria para el avance del
conocimiento.

Tiene que ver con la Gestión del conocimiento, que es como utilizar
cualquier clase de información y hacerla productiva o que dé el máximo beneficio,
como si se tratara de otro bien económico.

Antecedentes

El interés por conservar la creación humana, originó la documentación,

aunque será, concretamente, la historia de la escritura quien guiará la evolución
de la documentación como ciencia científica.

 Destacan como primer hallazgo los papiros procedentes del Alto y Medio
Egipto.
 Los documentos en tablillas de madera, estatuillas y seda de la antigua
China : Los primeros catálogos encontrados en Asia Menor, datan de 1900
a 1200 a.C. en los que se había un detalle de la cantidad de tablas de
arcilla.
 En el siglo III A.C. se crea la biblioteca más famosa de la antigüedad, la de
Alejandría: allí, el poeta Calímaco sería señalado como el primer
bibliotecario. Fue el autor de distintos catálogos y de algunos índices de
autores griegos.
 Hasta la llegada del Imperio Romano la lectura era una actividad reservada
a los “sabios”. Pero con la llegad de los romanos, sucede el primer cambio
significativo en la historia del libro: la aparición de las primeras bibliotecas
públicas.
6
 Si en las primeras etapas históricas el objetivo era la salvaguarda de los
documentos, el Imperio Romano trajo consigo la posibilidad de que esos
documentos fueran reconocidos y leídos por muchas personas.

Documentación de Sistemas

La Documentación de sistema consiste en un conjunto de información

relacionada a un sistema determinado que explica las características técnicas, la
funcionabilidad del sistema, la parte lógica, los diagramas de flujos, los programas,
la naturaleza, capacidades del sistema y cómo usarlo, en otras palabras, 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.

En la mayoría de los sistemas, la documentación siempre es expresada en

un carácter técnico por excelencia, indicando algoritmos de cómo realizar alguna
acción, registrar transacciones, imprimir reportes; dependiendo de la naturaleza
del sistema o su función.

También es necesario indicar que muchas veces no se le da el

protagonismo que se merece, puesto que en la mayoría de los casos esta
documentación es muy escasa o nula, debido a la construcción y modificación de
los sistemas de forma acelerada, consecuencias de la dinámica empresarial o
quizás, el problema se encuentre del lado de los desarrolladores, programadores y
administradores del proyecto de sistema, ya que como parte equipo de proyecto
conocen a fondo el sistema y obvian a los futuros operadores y/o administradores
del sistema.

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, entre otros.

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

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, estructuradas en carpetas e incluir un í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

Muchas organizaciones siguen sus propios estándares y normativas de

documentación: formato de los documentos fuentes, márgenes, cabeceras y pies,
nomenclatura, etc. Es importante tener la seguridad de que los estándares sean
completos, actualizados, documentados y legibles. Obviamente el estándar debe
ser apropiado y no una losa que nos implique más pérdidas que ventajas.

Durante el desarrollo de un sistema, desde su concepción hasta su puesta

en marcha, se genera una 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

6
con el sistema 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.
 Preciso, definiendo los términos utilizados (añadir un glosario).
 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

Importancia de la Documentación de Sistemas

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.

La documentación es esencial para proporcionar entendimiento de un

sistema a quien lo vaya a usar para mantenerlo, para permitir auditorias del mismo
y para enseñar a los usuarios como interactuar con él y a los operadores y
administradores como hacerlo funcionar.

La documentación tiene una gran importancia dentro de una empresa, ya

que esta ayuda a eliminar la posible dependencia que se pueda formar entre el
proyecto realizado, y el ejecutor de éste. 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

6
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. La oposición que entregan los técnicos a la realización del proceso de
documentación, se basa principalmente en los costos en que se incurre para su
construcción y en el mayor plazo de entrega. Pero estas justificaciones no son
posibles de sustentar en la realidad, ya que el mayor costo en que se incurre para
documentar se recupera con creces en el futuro, especialmente cuando se ve
enfrentado a un error del sistema o tener que efectuarle mantenciones.

Tipos de Documentación

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 adecúa 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.

6
  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:
 Cubicar o dimensionar (definir plazo y costo) de trabajos de mantención 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.
 Apoyar labores de auditoria y control.

Ventajas

 Es inmediata y está siempre actualizada.

 Justo a lo requerido.
 No se encuentra sujeta a la disposición del personal.

Desventajas

 Consume recursos de Hardware.

 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 son incompatibles entre sí, por lo que se
puede lograr un equilibrio entre ambas para lograr una buena documentación a un
buen costo.

6
Algunos Software usados en la Documentación de Sistemas

Javadoc, phpDocumentor, Smart Draw

Qué Documentar

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

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

Diagramas de Red Para la documentación de los diagramas de red, es necesario

contar con planos y dibujos, además de un software de apoyo llamado autocad (es
un programa de dibujo técnico de Diseño Asistido por Computador).
Adicionalmente existen software administradores de red, el cual mantiene la
documentación de la red que administra y va registrando todas las modificaciones
que cambian la configuración, adicionalmente, entrega alertas y aviso de algún
funcionamiento anormal, a no ser que exista un corte en las comunicaciones que
no permita que llegue dicho mensaje, aunque lo probabilidad de ocurrencia de
esto último es muy baja.

Ejemplo de posible documentación de un Sistema:

1. Archivo del proyecto: es el lugar donde deberían existir las distintas

versiones de planes del proyecto, análisis de alternativas y sus
antecedentes o criterios de formación de decisiones, intervenciones de las
oficinas de legales e impositivas con sus requerimientos y alertas
tempranas de cuidados a considerar, cambios de alcances al proyecto,
pedidos de cotización u órdenes de compra involucradas en el proyecto,
planes de construcción, "saltos" autorizados de estándares de construcción
de programas, análisis de capacidad de disco, canales de comunicación,
casos de prueba, resultados esperados, plan de implementación, etc. etc.
2. Archivo del sistema: con su correspondiente lista de eventos, diagrama de
contexto, modelo de usuarios, diagramas de entidad - relación, modelo de
implementación, modelo y diccionario de datos, diagrama de flujo, diálogos
de pantallas, diseños de archivos, pantallas y reportes, nómina de
controles.

6
 3. Manual del usuario: donde claramente quien opera el sistema, ya sea
como ingresante de datos, autorizante o lector de reportes, sabrá cómo
manejarse frente a su máquina y reportes.
4. Archivo de carga de máquina: indicando específicamente la ventana de
procesamiento donde debe ser incluido el proceso, tiempos estimados de
duración, acciones en caso de fallas, bibliotecas intervinientes, ..etc...
5. Manual del Usuario: donde el operador del computador recibe claramente
la identificación de qué soportes magnéticos debe usar, qué debe contestar
ante eventuales mensajes del sistema aplicativo o del sistema operativo,
usuarios a consultar o equipos de emergencia para casos de fallas, es decir
todo aquello que le permita manejar al sistema.
6. Instrucciones de distribución de salidas: para saber cuántas copias imprimir,
qué tipo de papel o formulario debe utilizarse, cómo debe setearse la
impresora, a quién debe dirigirse cada copia, qué controles deben
realizársele antes de distribuir, cuál es la característica de confidencialidad
o no de la información contenida en los reportes, tamaños promedio de los
mismos para evitar impresiones innecesarias, controles de calidad previos a
su impresión total final, etc.

Requerimientos Generales para Documentación

 Nunca desviarse de lo indicado en el dossier.

 Los documentos deben estar aprobados, firmados y fechados por personas
autorizadas.
 Los documentos deben ser revisados y actualizados regularmente.
 Debe haber un sistema funcionando para prevenir el uso inadvertido de
documentos vencidos/obsoletos.
 Escribir para el lector, corto, con sentencias claras.
 El almacenaje de documentos críticos debe ser seguro con acceso solo
para personas autorizadas.

6
 Conclusión

La Documentación de sistema consiste en un conjunto de información

relacionada a un sistema determinado que explica las características técnicas, la
funcionabilidad, la parte lógica, los diagramas de flujos, los programas, la
6
naturaleza , capacidades y cómo usarlo, en otras palabras, 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 en el proceso del desarrollo es la componente de la

configuración de los sistemas que permite garantizar su operación, y en el caso
que aplique asegurar su mantenimiento y permanencia operativa. Por este motivo,
es de gran importancia contar con la documentación completa, correcta y
actualizada para cada sistema.

La documentación tiene una gran importancia dentro de las organizaciones,

ya que esta ayuda a eliminar la posible dependencia que se pueda formar entre el
proyecto realizado, y el ejecutor de éste. 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.

Bibliografía

http://www.auditores-externos.com.ar/documentacion-de-sistemas.php

http://es.wikipedia.org/wiki/Documentaci%C3%B3n

6
http://www.scribd.com/doc/531939/la-documentacion-DEFINICION-Y-ANTECEDENTES?

http://www.monografias.com/trabajos6/dosi/dosi.shtml

http://www.kriptopolis.org/como-estructurar-la-documentacion

"Muéstreme su código y escóndame sus estructuras de datos, y no seré capaz de

averiguar siquiera para qué sirve su programa. Muéstreme sus estructuras de datos, y
no necesitaré ver su código para entenderlo".