Introducción

En la versión 5 de Plataforma se incorpora a Plataforma esta utilidad:https://es.onesaitplatform.com/space/DOC/3730112536/Documentación+de+elementos+de+Plataformaintegramos en Plataforma una primera versión de la herramienta de documentación.

En esta versión se ha reestructurado y mejorado la herramienta para que resulte de más utilidad.

...

¿Cómo funciona?

Una vez logado un usuario, desde el control panel se tendrá acceso a la sección Documentation desde el menú Tools.

Se mostrará una pantalla en la que se listará las documentaciones creadas por el usuario.

...

En la tabla, para cada registro se incluirá:

• Identificación de la documentación

• Propietario

• Aplicación asociada desde la que se generó la documentación (si se asoció)

• Título

• Descripción corta

• Fecha de creación

• Fecha de modificación

Para generar una nueva documentación, se pulsará sobre el botón + que se encuentra situado en la parte superior derecha de la tabla. Se accederá a la pantalla de creación de la documentación:

...

En esta pantalla se incluye, en la parte derecha un componente que permite seleccionar los recursos de plataforma que se quieren añadir a la documentación. Permite selección por grupos, multiple, simple y filtrado.

En la parte derecha se incluyen los datos referidos a la configuración de la documentación. S

i se marca 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 (Identification y Short Description) 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 Create, 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

...

y después 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 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 version de la Documentación

El objetivo de generar una nueva version es obtener todas las actualizaciones de todos sus recursos, ya que es posible que se hayan modificado los recusos 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 pop-up con un campo de identificación, 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 confirmar, automáticamente se creara, aparecera un mensaje en la parte derecha mostrando que se ha generado con exito y se recargara la pantalla.

...

También es posible cambiar el nombre al generar la nueva versión, editando el nombre que genera automáticamente:

...