Actualización de la herramienta de documentación
- Francisco Javier López Acevedo
Disponible desde la versión 6.1.0-Warcraft
Introducción
A partir de la versión 5.0 de Onesait Platform integramos una primera versión de la herramienta de documentación.
En la versión 6.1 se ha reestructurado y mejorado la herramienta para que resulte de más utilidad para el usuario.
¿Cómo funciona?
Una vez que el usuario ha iniciado su sesión, desde Control Panel tendrá acceso a la sección de documentación desde el menú de Herramientas > Documentación.
Accediendo, se mostrará el listado de documentaciones creadas por parte del usuario.
En la tabla, para cada registro se incluirá:
La identificación de la documentación.
El propietario.
La Aplicación asociada desde la que se generó la documentación (si se asoció).
El título.
Una descripción corta.
La fecha de creación.
La fecha de modificación.
Para crear una nueva documentación, se pulsará en el botón «+» que se encuentra en la parte superior derecha de la pantalla.
Se accederá entonces al asistente de creación de la documentación:
En esta pantalla se incluye, en la parte izquierda, un componente que permite seleccionar los recursos de la Plataforma que se quieren añadir a la documentación. Permite selección por grupos, selección múltiple o simple, y filtrado.
En la parte derecha se incluyen los datos referidos a la configuración de la documentación. Si se selecciona la opción «Associate Application», se mostrará un componente que permitirá seleccionar una de las Aplicaciones a las que tiene acceso el usuario. Tras seleccionar la deseada, se filtrarán los recursos asociados en la aplicación en el componente árbol de la izquierda, resultando más simple su selección:
El resto de campos se utilizarán para identificar la Aplicación y para incluir información en el documento que se generará asociado a la documentación.
Tras seleccionar el resto de campos y pulsar sobre el botón de «Crear», se almacenará la documentación y se mostrará en el listado de documentaciones.
Si se pulsa sobre visualizar en el registro de la tabla, se podrá acceder al resumen de la documentación generada.
En la primera pestaña se muestra un diagrama con el resumen de recursos agrupados por capa. En el resto de pestañas se incluirá información sobre cada tipo de recurso.
En una primera sección se recopilarán distintos KPIs de los recursos incluidos.
Seguidamente, el detalle de cada uno de ellos.
Desde el listado también es posible modificar la documentación, por si se desea incluir nuevos recursos, eliminar alguno existente o ampliar la información asociada. Al guardar las modificaciones, se regenerará la documentación incluyendo la información actualizada asociada a los recursos (incluso recalculando los distintos KPIs).
Una vez configurada la documentación, se podrá generar un fichero en formato Microsoft Word con un resumen con toda la información asociada. Para ello, desde el listado se pulsa sobre «Generar Word» y se descargará el fichero.
Generar nueva versión de la documentación
El objetivo de generar una nueva versión es obtener todas las actualizaciones de todos sus recursos, ya que es posible que se hayan modificado los recursos que se seleccionaron al crear la documentación.
La forma de generar una nueva versión de la documentación se encuentra en la tabla del listado de la documentación.
Al hacer clic en este botón, se abre un modal con un campo de identificación, que por defecto se asigna automáticamente el nombre existente seguido de -V1. Si existen versiones previas, el campo se actualizará con el siguiente número de versión disponible.
Al pulsar el botón de «Confirmar», se creará automáticamente la nueva versión y aparecerá un mensaje en la parte derecha mostrando que se ha generado con éxito, para acto seguido recargarse la pantalla.
También es posible cambiar el nombre al generar la nueva versión, editando el nombre que genera automáticamente.