Documentación Técnica
La documentacion tecnica es la informacion que nos describe que hacen los sistemas,
generalmente nuestra idea de documentacion tecnica son los diagramas de clases.
La documentación técnica es una gran herramienta puesto que con ella podemos una idea de el sistema y su funcionamiento, ademas de poder reutilizar una parte del programa sin la necesidad de saber el código.
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
Existen varios software que generan la documentación técnica tales como:
- Javadoc para Java
- Ddoc para D
- Doxygen para C/C++, Java,IDL
- PHPDoc para PHP.
En mi caso Utilizare Javadoc la cual es una herramienta de Oracle para la generación
de de documentación apartir del lenguaje java.Javadoc posee ciertas palabras reservadas como:
Consultas:
No hay comentarios:
Publicar un comentario