Cuarta práctica

Texto que explique la importancia de la documentación (técnica) y cómo para producirla

La documentación técnica es material (en este caso material electrónico aunque también puede ser físico) donde explicamos características técnicas y operaciones del sistema, para nuestro propósito de nuestro software.

 Sirve para conocer para que esta diseñado nuestro sistema, como es que funciona y para quien está diseñado. Es muy importante tener en cuenta una documentación para nuestro proyecto, tanto para nosotros mismos como para terceros que lo fueran a utilizar. Por ejemplo, para darle mantenimiento, saber exactamente donde es que necesitamos arreglar, modificar algo o actualizar, sin necesidad de desecharlo todo solo por no sabes que hace cada cosa.

Sobre como debe ser la documentación y que características debe tener, leyendo un poco me encontré con que debe ser:

Completa: es decir que se documente bien todo el sistema, y no solo algunas partes.

Legible: que sea fácil de entender (aun para quien no haya elaborado el sistema), bien organizado, lenguaje claro.

Actualizado: que se documente las últimas modificaciones que se hagan, y no dejar obsoleta la documentación.

Hay mas características pero estas me parecieron las más importantes.

Para la documentación técnica del software  utilizare la herramienta llamada Doxygen.

Instalación: 

Después de ejecutarlo creamos nuevo proyecto y cargamos nuestro código:

 Lo siguiente es seguir los pasos que nos indique, por ejemplo agregar nombre, versión , color, lenguaje a utilizar, etc. Finalizamos en la ventana Run y si todo esta bien se creara un archivo HTML (o inclusive puede crearse algún otro tipo si lo deseamos) donde se mostrara la documentación y de mas.

Resultado Final:

Bibliografía:

http://www.stack.nl/~dimitri/doxygen/manual.html