Propuesta Documentación

Necesidad de Documentación.

La documentación existente representa sólo una parte de los módulos que están en funcionamiento actualmente; esta documentación sólo abarca temas técnicos, y no de uso.

Tomando en cuenta las necesidades tanto de usuarios como de desarrolladores, se debería tener dos tipos de documentación:

• Documentación técnica y funcional.
• Manuales de usuario.

Sistemas involucrados.

• Sisgen
• Módulo Tasador
• Gisprop
• Mcheck (tanto WS como la API)

Status de documentación.

A pesar de que existe documentación, ésta no se fue actualizando en el tiempo por lo que termina siendo casi inutilizable. Se realizó una documentación del momento, no del inicio de los sistemas.

• Sisgen: Se tienen módelos de datos, sólo representando interacción de tablas sin mayor detalle.
• Módulo Tasador: Se generó documentación técnica con módelos de datos, y funcionamiento de las secciones (siempre a nivel técnico).
• Gisprop: No existe. Sólo documentos entregados por cliente para realizar la solución.
• Mcheck: No existe. Se puede obtener información de funcionamiento desde la API, pero es información básica.

Propuesta.

Se debe generar:

• Documentación funcional y técnica. En esta documentación se debe declarar:

• Versión de JDK
• Versión de Maven
• Versión de Spring Framework
• Versión de Spring Roo
• Versión de módulos que pudieran afectar a los sistemas en caso de actualización.
• Contenedor de aplicaciones utilizado.
• Extras que permitan el funcionamiento correcto (fuentes necesarias, librerías, etc.)
• Modelo de datos, tanto detallado como un resumen en el que se pueda ver la interacción de las tablas.
• Entidades y sus métodos.
• Catálogo de errores.

• Manuales de usuario. Se debe declarar el funcionamiento en distintas etapas para los usuarios, según perfil asociado:

• Ingreso/modificación de solicitudes
• Coordinación de visitas
• Desarrollo de tasación
• Visado de tasación
• Cierre de tasación
• Mantenimiento de usuarios
• Estadísticas
• Manejo de Incidencias
• etc.

Tiempos de documentación

La tarea en su inicio será de mediana/larga duración.

Luego, se debe establecer parte de los tiempos de desarrollo, la actualización de los documentos correspondientes, sino se volverá inutilizable.

...