domingo, 10 de julio de 2011

Documentación tecnica

La documentacion tecnica en sistemas es cuando se recopila toda la informacion que nos dice que es lo que hace el sistema, como lo hace y para quien.
Esta documentacion explica las caracteristicas tecnicas y la operacion de un sistema, es escencial para quien vaya a usar o enseniar a utilizar el sistema.

Existen varios tipos de documentacion
1.- la de programas que explican la logica de un programa e incluye descripciones, diagramas de flujo, listados de programas y otros documentos.
2.-La de usuarios en forma general la naturaleza y capacidades del sistema y como usarlo.
3.- Otro tipo de documentacion es el registro fisica, generalmente por escritoque contiene lo siguiente:

-Politicas y normas referente al desarrollo del sistema, operacion y mantenimiento.
-Disenio del sistema de informacion administrativo.
-Procedimientos para instalar, operar y mantener el sistema de informacion administratio.

La importancia de la documentacion de sistemas
La mayoria de las veces la documentacion es la parte a la que se le dedica menos tiempo y no se le presta la atencion adecuada; Sin embargo, Una documentacion adecuada y completa es escencial en cualquier sistema de informacion, para cuando se desea implantar, mantener y actualizar en forma satisfactoria dicho sistema.
Esta documentacion debe ser realizada ya que, es una manera de asegurar que el sistema funciona correctamente ademas del apoyo que puede brindar las personas responsables del mantenimiento de estos.

Existen herramientas que facilitan la documentacion, una de ellas es JavaDoc que genera documentacion de APIs en formato HTML a partir de codigo fuente Java. Javadoc tambien proporciona una API para crear doclets y taglets, que le permiten analizar la estructura de una aplicacion Java.

Otra herramienta util es Doxygen que genera documentacion para C++, C, Java, Objective-C, Python, IDL, PHP, dado que es facilmente adaptable, funciona en la mayoria de los Sistemas Operativos.

*******
http://www.stack.nl/~dimitri/doxygen/
http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
******

referencias:
http://www.monografias.com/trabajos6/dosi/dosi.shtml
http://es.wikipedia.org/wiki/Javadoc

http://es.wikipedia.org/wiki/Doxygen

No hay comentarios:

Publicar un comentario