REPBLICA BOLIVARIANA DE VENEZUELA MINISTERIO DE EDUCACIN SUPERIOR UNIVERSIDAD NACIONAL EXPERIMENTAL SIMN RODRGUEZ ASIGNATURA: SISTEMAS DE DOCUMENTACIN FACILITADOR:

LINO SIMOES

DOCUMENTACIN DE SISTEMAS

Equipo #01 Participantes: Angulo, Gustavo Gmez, Carlos Morgado, Javier Nadales, Juan Carlos Osorio, Samuel Rojas, Manuel C.I: C.I: C.I: C.I: C.I: C.I: 12.835.136 6.180.377 10.629.467 11.199.668 16.681.765 10.276.200

Caracas, Marzo de 2009 6

INDICE

INTRODUCCIN...........................................................................................2 DOCUMENTACIN........................................................................................3 ANTECEDENTES................................................................................................................. ..4 DOCUMENTACIN DE SISTEMAS...................................................................5 ESTNDARES BSICOS DE DOCUMENTACIN.................................................6 NORMALIZACIN.........................................................................................6 IMPORTANCIA DE LA DOCUMENTACIN DE SISTEMAS....................................7 TIPOS DE DOCUMENTACIN.........................................................................8 VENTAJAS....................................................................................................... ..................8 DESVENTAJAS............................................................................................................ .........8 VENTAJAS....................................................................................................... ..................9 DESVENTAJAS............................................................................................................ .........9 ALGUNOS SOFTWARE USADOS EN LA DOCUMENTACIN DE SISTEMAS..........10 QU DOCUMENTAR ...................................................................................10 EJEMPLO
DE POSIBLE DOCUMENTACIN DE UN

SISTEMA:................................................................ ....11

REQUERIMIENTOS GENERALES PARA DOCUMENTACIN................................12 CONCLUSIN.............................................................................................13 BIBLIOGRAFA...........................................................................................14

INTRODUCCIN
6

El inters por conservar la creacin humana origin la documentacin, aunque concretamente, la historia de la escritura ser la que guiar la evolucin de la documentacin como ciencia cientfica. En la medida en que la documentacin tiene que ver con el documento como fuente potencial y efectiva para obtener nueva informacin, se convierte en disciplina instrumental, al servicio del crecimiento y transmisin de todos los saberes. La documentacin consiste en material que explica las caractersticas tcnicas y la operacin 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 ensear a los usuarios como interactuar con el sistema y a los administradores como hacerlo funcionar. Mediante este trabajo se expone de manera sucinta proceso. acerca de la

documentacin de los sistemas, adems de ciertas consideraciones a tener en el

Documentacin
6

La documentacin es una disciplina cientfica que trata de recopilar, almacenar, analizar y difundir informacin contenida en documentos de distinto tipo para hacerla accesible a cualquier persona que pueda necesitarla. La Documentacin es una disciplina instrumental, ya que sirve a todas las dems ciencias para localizar informacin conocimiento. Tiene que ver con la Gestin del conocimiento, que es como utilizar cualquier clase de informacin y hacerla productiva o que d el mximo beneficio, como si se tratara de otro bien econmico. necesaria para el avance del

Antecedentes
El inters por conservar la creacin humana, origin la documentacin, aunque ser, concretamente, la historia de la escritura quien guiar la evolucin de la documentacin como ciencia cientfica. 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 catlogos encontrados en Asia Menor, datan de 1900 a 1200 a.C. en los que se haba un detalle de la cantidad de tablas de arcilla. En el siglo III A.C. se crea la biblioteca ms famosa de la antigedad, la de Alejandra: all, el poeta Calmaco sera sealado como el primer bibliotecario. Fue el autor de distintos catlogos 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 aparicin de las primeras bibliotecas pblicas. 6

Si en las primeras etapas histricas el objetivo era la salvaguarda de los documentos, el Imperio Romano trajo consigo la posibilidad de que esos documentos fueran reconocidos y ledos por muchas personas.

Documentacin de Sistemas
La Documentacin de sistema consiste en un conjunto de informacin relacionada a un sistema determinado que explica las caractersticas tcnicas, la funcionabilidad del sistema, la parte lgica, los diagramas de flujos, los programas, la naturaleza, capacidades del sistema y cmo usarlo, en otras palabras, la documentacin de sistemas es el conjunto de informacin que nos dice qu hacen los sistemas, cmo lo hacen y para quin lo hacen. En la mayora de los sistemas, la documentacin siempre es expresada en un carcter tcnico por excelencia, indicando algoritmos de cmo realizar alguna accin, registrar transacciones, imprimir reportes; dependiendo de la naturaleza del sistema o su funcin. Tambin es necesario indicar que muchas veces no se le da el protagonismo que se merece, puesto que en la mayora de los casos esta documentacin es muy escasa o nula, debido a la construccin y modificacin de los sistemas de forma acelerada, consecuencias de la dinmica empresarial o quizs, 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 aplicacin tecnolgica y todo servicio informtico quede adecuadamente documentado, es necesario exigirle a quien lo disee y/o desarrolle (puede ser personal interno o un proveedor) que entregue dicha documentacin obtenida a travs 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 documentacin", el cual consiste en una poltica formal cuya documentacin se muestra como algo que debe prepararse en forma rutinaria para cada programa de cmputo, archivo y nuevos sistemas.

Estndares Bsicos de Documentacin

Toda documentacin que se relacione con un sistema, ya sea manual o por computadora, sencillo o complejo debe reunir los siguientes requisitos bsicos: Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, estructuradas en carpetas e incluir un ndice. Los diagramas debern ser claros, no aglomerados y la escritura manuscrita deber ser legible. La documentacin deber ser completa. Se incluir una leyenda o explicacin de los trminos utilizados. La documentacin siempre se conserva actualizada.

Normalizacin
Muchas organizaciones siguen sus propios estndares y normativas de documentacin: formato de los documentos fuentes, mrgenes, cabeceras y pies, nomenclatura, etc. Es importante tener la seguridad de que los estndares sean completos, actualizados, documentados y legibles. Obviamente el estndar debe ser apropiado y no una losa que nos implique ms prdidas que ventajas. Durante el desarrollo de un sistema, desde su concepcin 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 documentacin, se desarrollan diferentes tipos de documentos dirigidos a las personas que trabajarn 6

con el sistema para facilitar el mantenimiento del mismo. La documentacin de un sistema debe ser marcada adecuadamente, bien organizada actualizada y completa; todos los trminos utilizados deben explicarse. La documentacin se har disponible a todos los usuarios de acuerdo a sus necesidades. El estilo de redaccin de los manuales de documentacin debe ser: Concreto. Preciso, definiendo los trminos utilizados (aadir un glosario). Utilizar prrafos cortos. Utilizar ttulos y subttulos. Utilizar formas activas en lugar de pasivas. No emplear frases largas que presenten hechos distintos. No hacer referencia a una informacin solamente con el nmero de referencia

Importancia de la Documentacin de Sistemas

La documentacin adecuada y completa, de una aplicacin que se desea implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema de Informacin, sin embargo, frecuentemente es la parte a la cual se dedica el menor tiempo y se le presta menos atencin. La documentacin es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditorias del mismo y para ensear a los usuarios como interactuar con l y a los operadores y administradores como hacerlo funcionar. La documentacin 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 aplicacin tecnolgica y todo servicio informtico quede adecuadamente documentado, es necesario exigirle a quien lo disee y/o desarrolle (puede ser personal interno o un 6

proveedor) que entregue dicha documentacin obtenida a travs 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 oposicin que entregan los tcnicos a la realizacin del proceso de documentacin, se basa principalmente en los costos en que se incurre para su construccin 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 Documentacin Documentacin Manual: este tipo de documentacin se efecta

manualmente. Puede documentarse en papel o en algn medio magntico como disquete o CD. Se cuenta con apoyo de software para su confeccin, como un procesador de texto, planilla electrnica y programas graficadores. Ventajas Refleja historia. Muestra la evolucin de la documentacin en el tiempo. Ms explicativa. Se adeca a la cultura de la organizacin. No consume capacidad de procesamiento.

Desventajas Consume mucho esfuerzo en construirla. Documentacin incompleta. Poca disposicin para entregar informacin. 6

 Ms lenta y sin actualizar. Errores de escritura

Documentacin Automtica: Para este tipo de documentacin, existen

software que documentan. Pero estos software no estn disponibles para todas las plataformas, por lo que hay que revisar bien el ambiente en que se trabaja para ver si existe algn software de documentacin compatible. Este tipo de documentacin es muy til para: Cubicar o dimensionar (definir plazo y costo) de trabajos de mantencin de software. Su utilizacin 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 disposicin 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 documentacin son incompatibles entre s, por lo que se puede lograr un equilibrio entre ambas para lograr una buena documentacin a un buen costo. 6

Algunos Software usados en la Documentacin 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 utilizacin del software, sus posibles errores, que funciones cumple, como se instala, sus requerimientos, etc. En las aplicaciones se incluye este manual en lnea al cual el usuario puede acceder a l normalmente apretando la tecla de Help en cualquier opcin en que se encuentre trabajando dentro de la aplicacin. 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. Tcnico: destinado para uso operacional, este manual seala como se manejan los respaldos, la conexin de equipos perifricos, etc. Segn las caractersticas 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 aplicacin, utilizando un lenguaje tcnico, ya que est orientada a informtica. Interna: es documentacin que se encuentra dentro de cada uno de los programas, indicando como funcionan stos. Permite que el programador entienda 6

cmo se ejecuta el programa y tambin deben registrar todos los cambios efectuados al programa a manera de documentacin. Toda esta documentacin est dentro del programa fuente, ya que si ste no viene no es posible realizar ningn tipo de modificacin a la aplicacin. Diagramas de Red Para la documentacin de los diagramas de red, es necesario contar con planos y dibujos, adems de un software de apoyo llamado autocad (es un programa de dibujo tcnico de Diseo Asistido por Computador). Adicionalmente existen software administradores de red, el cual mantiene la documentacin de la red que administra y va registrando todas las modificaciones que cambian la configuracin, adicionalmente, entrega alertas y aviso de algn 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 documentacin de un Sistema: 1. Archivo del proyecto: es el lugar donde deberan existir las distintas versiones de planes del proyecto, anlisis de alternativas y sus antecedentes o criterios de formacin 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 cotizacin u rdenes de compra involucradas en el proyecto, planes de construccin, "saltos" autorizados de estndares de construccin de programas, anlisis de capacidad de disco, canales de comunicacin, casos de prueba, resultados esperados, plan de implementacin, etc. etc. 2. Archivo del sistema: con su correspondiente lista de eventos, diagrama de contexto, modelo de usuarios, diagramas de entidad - relacin, modelo de implementacin, modelo y diccionario de datos, diagrama de flujo, dilogos de pantallas, diseos de archivos, pantallas y reportes, nmina de controles.

3.

Manual del usuario: donde claramente quien opera el sistema, ya sea como ingresante de datos, autorizante o lector de reportes, sabr cmo manejarse frente a su mquina y reportes.

4.

Archivo de carga de mquina: indicando especficamente la ventana de procesamiento donde debe ser incluido el proceso, tiempos estimados de duracin, acciones en caso de fallas, bibliotecas intervinientes, ..etc...

5. Manual del Usuario: donde el operador del computador recibe claramente la identificacin de qu soportes magnticos 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 distribucin de salidas: para saber cuntas copias imprimir, qu tipo de papel o formulario debe utilizarse, cmo debe setearse la impresora, a quin debe dirigirse cada copia, qu controles deben realizrsele antes de distribuir, cul es la caracterstica de confidencialidad o no de la informacin contenida en los reportes, tamaos promedio de los mismos para evitar impresiones innecesarias, controles de calidad previos a su impresin total final, etc.

Requerimientos Generales para Documentacin

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 crticos debe ser seguro con acceso solo para personas autorizadas.

Conclusin
La Documentacin de sistema consiste en un conjunto de informacin relacionada a un sistema determinado que explica las caractersticas tcnicas, la funcionabilidad, la parte lgica, los diagramas de flujos, los programas, la 6

naturaleza , capacidades y cmo usarlo, en otras palabras, la documentacin de sistemas es el conjunto de informacin que nos dice qu hacen los sistemas, cmo lo hacen y para quin lo hacen La documentacin en el proceso del desarrollo es la componente de la configuracin de los sistemas que permite garantizar su operacin, y en el caso que aplique asegurar su mantenimiento y permanencia operativa. Por este motivo, es de gran importancia contar con la documentacin completa, correcta y actualizada para cada sistema. La documentacin 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 aplicacin tecnolgica y todo servicio informtico quede adecuadamente documentado, es necesario exigirle a quien lo disee y/o desarrolle (puede ser personal interno o un proveedor) que entregue dicha documentacin obtenida a travs 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.

Bibliografa
http://www.auditores-externos.com.ar/documentacion-de-sistemas.php http://es.wikipedia.org/wiki/Documentaci%C3%B3n

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

"Mustreme su cdigo y escndame sus estructuras de datos, y no ser capaz de averiguar siquiera para qu sirve su programa. Mustreme sus estructuras de datos, y no necesitar ver su cdigo para entenderlo".