martes, 11 de octubre de 2011

DOCUMENTACIÓN TÉCNICA

La documentación técnica se refiere ala descripcion de un programa para que pueda ser leido por cualquier persona. La documentación explica el propósito, y todo lo relacionado con la codificacion del programa, tambien incluye las instrucciones sobre el funcionamiento del programa para facilitar al usuario su uso.
La documentación técnica es de dos tipos:

  • De Usuario: es para facilitar el uso del sistema por parte del usuario , esto incluye referencias, manuales de operación y tutoriales.
  • De Sistema: que es mas enfocada para desarrolladores y toca puntos tales como los requerimientos, la arquitectura, diagramas de clase y secuencia ademas del la documentación del código creado

Como una conclusión se podría decir que la documentación es una parte esencial para el progreso del software de manera rápida y para su amplio mantenimiento.


En la programación los tipos de documentación son:

Diagrama de clases Se realiza en la fase de dise~no y se usa en la de implementacion.
Documentacion del c odigo Se realiza en la fase de implementaci ón y se usa tanto en esta como en la de mantenimiento.
Documentacion de uso (API) Se realiza en la fase de implementacion y se usa en la de mantenimiento.

Tambien Existen varios software que generan la documentación técnica como:
  • Javadoc para Java
  • Ddoc para D
  • Doxygen para C/C++, Java,IDL
  • PHPDoc para PHP.

No hay comentarios:

Publicar un comentario