Documentar un proyecto con Tooluca

Los requerimientos de un sistema, son descripciones de las necesidades de un producto. La principal meta de la fase de requerimientos es identificar y documentar que es realmente lo que se necesita, esto permite clarificar la comunicación entre el cliente y el equipo de desarrollo. Tooluca implementa un modelo de documentación claro, que permite llevar sistemáticamente la definición de requerimientos de cualquier sistema.

Para ello se ha dividido la documentación del proyecto en tres artefactos claramente definidos como son: requerimientos funcionales. atributos del sistema y glosario de términos (vea fig 1).

Fig. 1 (modelo de documentación de Tooluca)

Los requerimientos funcionales, son aquellas operaciones que el sistema debe ser capaz de realizar. Estas funciones se identificarán y listarán de acuerdo a un grupo lógico (categoría) establecido. En Tooluca para crear un grupo (categoría) en el proyecto, se debe presionar click derecho sobre la carpeta requerimientos funcionales que está en el árbol jerárquico y luego escoger en el menú (vea fig 2) crear categoría. Se insertará un nuevo nodo que representa el grupo de requerimientos (vea fig 3).

La otra opción del menú: Imprimir requerimientos, permite enviar a la impresora todos las descripciones de los requerimientos funcionales creados.

Fig. 2 (menú de requerimientos funcionales)

fig6.gif (19228 bytes)

Fig. 3 (después de haber creado tres categorías de requerimientos funcionales)

En cada categoría creada, se podrá ingresar descripciones de requerimientos específicos.

Para ello se debe presionar click derecho sobre la categoria, luego en el menú presentado escoger la opción crear requerimiento. La opción Eliminar permite borrar totalmente una categoría con todos sus requerimientos contenidos de la vista documentación.
(vea fig 4 y fig 5)

Fig. 4 (menú para cada categoría de requerimientos funcionales)

Fig. 5 (después de haber ingresado requerimientos funcionales en una categoría

Para cada requerimiento en particular se puede tener una vista más amplia de su contenido. Para ello, si presionamos un click derecho sobre el requerimiento a detallar, se muestra un menú de opciones (vea fig 6): aquí debemos escoger la opción propiedades, que llamará a una acción que presente el detalle del requerimiento en una nueva ventana (vea fig. 7). La opción Eliminar, borra el -requerimiento en curso- del proyecto.

Fig. 6 (menú de opciones para cada requerimiento específico)

Fig. 7 (vista del contenido de un requerimiento funcional)

Los atributos del sistema, son características o dimensiones del producto a desarrollar.

En Tooluca para definir atributos de un sistema, tenemos que realizar el siguiente proceso: en primer lugar debemos ubicarnos en la carpeta atributos del sistema de vista documentación, luego presionar click derecho, aquí se presentará un menú (vea fig. 8), escoger la opción crear atributo, y finalmente proceder a su edición (vea fig. 9). La opción, Imprimir atributos permite enviar a la impresora todos las descripciones de los atributos definidos dentro del proyecto en curso.

duke.gif (2582 bytes)

Fig. 8 (menú de opciones para el grupo atributos del sistema)

Fig. 9 (después de haber ingresado atributos a nuestro proyecto)

Igualmente, para cada atributo en particular se puede tener una vista más amplia de su contenido. Para conseguir esto: si presionamos un click derecho sobre el atributo a detallar, se muestra un menú de opciones (vea fig 10): aquí debemos escoger la opción propiedades, que llamará a una acción que presente el detalle del atributo en una nueva ventana (vea fig. 11). La opción Eliminar, borra el -atributo en curso- del proyecto.

Fig. 10 (menú de opciones para cada atributo específico)

Fig. 11 (pantalla de detalle de un atributo)

Un glosario, es un simple documento que define términos.

En Tooluca tenemo una carpeta llamada Glosario, que se encuentra en al árbol jerárquico. En esta carpeta podemos crear y guardar los términos que se necesiten definir en un sistema.

El proceso para crear estos términos es el siguiente: en primer lugar debemos ubicarnos en la carpeta Glosario de vista documentación, luego presionar click derecho, se presentará un menú de opciones (vea fig 12), escoger el submenú crear término, finalmente editar el término ingresado. (vea fig 13)

La opción Imprimir glosario permite enviar a la impresora todos las descripciones de los términos del glosario.

Fig. 12 (menú de opciones para Glosario)

Fig. 13 (después de haber ingresado términos en el glosario del sistema)

Igualmente, para cada término del glosario en particular se puede tener una vista más amplia de su contenido. Para conseguir esto: si presionamos un click derecho sobre el término a detallar, se muestra un menú de opciones (vea fig 14): aquí debemos escoger la opción propiedades, que llamará a una acción que presente el detalle del término en una nueva ventana (vea fig. 15). La opción Eliminar, borra el -término en curso- del glosario.

Fig. 14 (menú de opciones para cada término del glosario)

Fig. 15 (pantalla de detalle de un término del glosario)

Opciones generales

Barra de herramientas

Al hacer click sobre este icono:

Se mostrará una ventana, que presente todos los requerimientos funcionales creados en el proyecto, organizados por categorías. Ocurrirá lo mismo, al escoger en la barra de menús
Trabajar con...->Requerimientos del sistema. (vea fig. 16)

Se mostrará una ventana, que presente todos los atributos creados en el proyecto. Ocurrirá lo mismo, al escoger en la barra de menús
Trabajar con...->Atributos del sistema. (vea fig 17)

Se mostrará una ventana, que presente todos los términos definidos en el glosario del proyecto. Ocurrirá lo mismo, al escoger en la barra de menús
Trabajar con...->Glosario de términos. (vea fig 18)