miércoles, 6 de julio de 2011

Documentación técnica

La documentación técnica es una explicación detallada de un diseño, en él se específica la manera en que se ha creado o modificado un sistema, si el sistema tiene algún error el técnico se puede basar en la documentación para corregir dicho error.
La documentación es también un conjunto de información que nos dice qué están haciendo los sistemas, la manera de hacerlo y para quien o para qué se está haciendo. Es muy sencillo para la persona que hace el sistema documentar la información.
La documentación puede facilitar la lectura del sistema mismo y puede contribuir a mejoras y modificaciones.


Existe la documentación que explica la lógica del programa e incluye diagramas, descripción, listados, etc. También existe la documentación para el usuario dónde se explica cómo usar dicho programa,  y también existe la Documentación con procedimientos para instalar y operar el sistema.

Las herramientas facilitan la documentación, por ejemplo el Doxygen es una herramienta que genera documentación para C++, C, Java, Objective-C, Python, IDL, en cierta cantidad para PHP, C# y D. Es un programa que es fácilmente instalable y adaptable funciona para las plataformas de Unix, Windows y Mac OSX. Varios documentos como KDE usan Doxigen para que la documentación sea generada de su API.



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

1 comentario: