Documentation Tool Update
- Francisco Javier López Acevedo
Available since version 6.1.0-Warcraft
Introduction
From version 5.0 of Onesait Platform we integrated a first version of the documentation tool.
In version 6.1, the tool has been restructured and improved to make it more useful for the user.
How does it work?
Once the user has logged in, from the Control Panel they will have access to the documentation section from the Tools > Documentation menu.
By accessing it, the list of documentations created by the user will be displayed.
For each record, the table shall include:
The identification of the documentation.
The owner.
The associated Application from which the documentation was generated (if associated).
The title.
A short description.
The date of creation.
The modification date.
To create a new documentation, click on the ‘+’ button at the top right of the screen.
You will then access the documentation creation wizard:
This screen includes, on the left side, a component that allows you to select the Platform resources to be added to the documentation. It allows selection by groups, multiple or simple selection, and filtering.
The right-hand side includes the data relating to the documentation configuration. If the “Associate Application” option is selected, a component will be displayed to select one of the Applications to which the user has access. After selecting the desired one, the resources associated with the application will be filtered in the component tree on the left, making selection easier:
The rest of the fields will be used to identify the Application and to include information in the document that will be generated associated to the documentation.
After selecting the rest of the fields and clicking on the “Create” button, the documentation will be stored and displayed in the documentation list.
The first tab shows a diagram with the summary of resources grouped by layer. The other tabs will include information on each type of resource.
In a first section, different KPIs of the included resources will be compiled.
The following is a detail of each of them.
From the list it is also possible to modify the documentation, in case you wish to include new resources, delete an existing one or expand the associated information. When saving the modifications, the documentation will be regenerated including the updated information associated to the resources (even recalculating the different KPIs).
Once the documentation has been configured, a file can be generated in Microsoft Word format with a summary of all the associated information. To do so, from the list, click on “Generate Word” and the file will be downloaded.
Generate a new version of the documentation
The purpose of generating a new version is to obtain all the updates of all your resources, since it is possible that the resources that were selected when the documentation was created have been modified.
The way to generate a new version of the documentation can be found in the documentation listing table.
Clicking this button opens a modal with an identification field, which by default is automatically assigned the existing name followed by -V1. If previous versions exist, the field will be updated with the next available version number.
When the “Confirm” button is clicked, the new version will be automatically created and a message will appear on the right hand side showing that it has been successfully generated, and then the screen will reload.
It is also possible to change the name when generating the new version by editing the automatically generated name.
