Caso práctico

Primer plano de una chica joven, de expresión seria, con el pelo largo y rizado, viste con una camisa de color gris.

Los chicos siguen estudiando características de la herramienta VP-UML...

—Sería estupendo que después de generar un diagrama, en el que verdaderamente te has esforzado, pudieras hacer anotaciones sobre la importancia de cada clase, atributo o relación, para que, posteriormente, pudieras compartir esa información o recordarlo rápidamente cuando estuvieras programando el sistema en caso de tener que consultar algo.

—No solo eso, además de generar documentación exhaustiva, la herramienta permite crear informes con ella, pasándola a un formato más cómodo de leer e interpretar en papel por el equipo de desarrollo.

Ventana para añadir documentación a un diagrama de clases. En la parte de arriba aparece la palabra Documentación, a continuación un selector con el lenguaje HTML y botones de formato de texto y debajo el texto de la documentación que dice: "Representa las clases que intervienen en el sistema de la Formación Profesional a Distancia, en la que los alumnos se matriculan de un conjunto de módulos que se imparten por vía telemática. Para completar un ciclo un alumno debe completar debe cursar y aprobar todos los módulos de ese ciclo. Cada módulo es impartido por un profesor, que podrá impartir varios de los módulos del ciclo.". Debajo aparece un cuadrado blanco junto al texto Play when selected, y debajo un círculo rojo junto a la palabra Record.

Como en todos los diagramas UML, podemos hacer las anotaciones que consideremos necesarias abriendo la especificación de cualquiera de los elementos, clases o relaciones, o bien del diagrama en si mismo en la pestaña "Specification".

La ventana del editor cuenta con herramientas para formatear el texto y darle un aspecto bastante profesional, pudiendo añadir elementos como imágenes o hiperenlaces.

También se puede grabar un archivo de voz con la documentación del elemento usando el icono Grabar.

Generar informes

Cuando los modelos están completos podemos generar un informe en varios formatos diferentes (HTML, PDF o Word) con la documentación que hemos escrito. Para generar un informe hacemos:

Desde VP-UML accedemos a Tools >> Reports >> Report writer y seleccionamos el tipo de informe que queremos.

Desde el SDE para NetBeans seleccionamos Modelin >> Reports >> Report writer.

En ambos casos, una vez que elegimos el tipo de informe, obtendremos la siguiente ventana en la que seleccionamos entre otros:

Ventana de Visual Paradigm de nombre "Generate HTML", dividida en una serie de pestañas de las que aparece Content. A continuación se ven el dato Tempalte: Default y un conjunto de botones. Debajo aparece el mensaje Output Path y un espacio para escribir vacío. Debajo se ven tres ventana enmarcadas por una linea gris con el nombre Diagramas. En la ventana de la izquierda aparece una estructura jerárquica con los diagramas que se pueden documentar, aparecen marcadas las opciones Diagramas UML, Diagramas de clases (1) y FPDist. En la ventana de en medio, que está en blanco, aparece el nombre FPDist. Y en la derecha, de color gris la palabra Preview.

Qué diagramas queremos que intervengan y donde se almacenará el informe.
La pestaña opciones (Options) permite configurar los elementos que se añadirán al informe, como tablas de contenidos, títulos, etc.
Las propiedades de la página.
Si se va a añadir una marca de agua.

El resultado es un archivo (.html, .pdf o .doc) en el directorio de salida que hayamos indicado con la documentación de los diagramas seleccionados.