Inicio Acerca de ScienSe Documentación Capturas de Pantalla Licencia Descargas Soporte Desarrollo

Lenguajes
Español
Ingles
Página del Proyecto
AnteriorArribaSiguiente

La documentaci´n

Es una de las políticas de desarrollo de ScienSe documentar todo el código fuente para facilitar la revisión y modificación del mismo. Está documentación se debe hacer siguiendo el estándar de documentación de Javadoc tanto para el código en el lenguaje Java como en el lenguaje C++ pues el uso de esta herramienta permite la generación automática de documentación en línea para las diversas APIs.

Además de la documentación del código fuente es importante contar con toda la documentación del proceso de desarrollo utilizando el lenguaje UML Asimismo el diseño de las bases de datos debe documentarse con las tablas y los diagramas entidad-relación para permitir el diseño de consultas con mayor facilidad.

Sobre la documentación de usuario esta debe separarse en dos, por un lado, la documentación que contiene la aplicación no debe contener información demasiado especifica que tienda a cambiar con facilidad. Este tipo de información debe añadirse a la sección de ayuda y soporte del sitio web de ScienSe.

Noticias

Recursos

Buscar en Google