viernes, 15 de abril de 2011

(C) 6.- Documentacion tecnica

La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones
La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación.
Una vez concluido el programa, los documentos que se deben entregar son una guía técnica, una guía de uso y de instalación.

HERRAMIENTA

pydoc genera automáticamente la documentación de los módulos de Python. La
documentación puede ser presentada como páginas de teto en la consola, que se sirve a un navegador Web, o guardarse en archivos HTML.

para mi proyecto no pude generar la documentancion tendra que ser manualmente

No hay comentarios:

Publicar un comentario