Documentación de elementos de Onesait Platform
Hemos incluido una nueva funcionalidad en la versión 5.0.0-Renegade con la que pretendemos apoyar en el trabajo de documentar un sistema que se haya construido sobre Onesait Platform. A través del propio ControlPanel de la Plataforma, vas a poder generar una documentación sobre todos los elementos de la propia Plataforma tanto en formato web como en PDF o Word.
La documentación va a generar también un diagrama de arquitectura por capas (Ingesta, Conocimiento, Publicación, etc.), incluyendo los elementos de:
- Ingesta: DataFlow (pipelines), Digital Clients, Kafka Topics, Digital Twins.
- Processing: FlowEngine, BPM.
- Persistencia: Entidades.
- Knowledge: Notebooks.
- Publicación: APIs, Dashboards.
¿Cómo funciona?
La funcionalidad puede usarse de dos maneras:
- Documentación asociada a un proyecto/aplicación: en este caso, se documentan todos los elementos de la Plataforma (Entidades, Clientes, APIs, Dashboards, Notebooks, Flujos, etc.) asociados a una aplicación/proyecto desarrollado sobre la propia Plataforma.
- Documentación general por conceptos: adecuado para aquellos casos más generales donde los conceptos no están asociados a un proyecto concreto o donde se quieren documentar conceptos de una forma mas generalizada.
Documentación por aplicación
En caso de elegir la opción de generar documentación por aplicación, la siguiente pantalla permite elegir la aplicación a documentar:
A continuación, se pasa a un selector de conceptos organizado por categorías donde se pueden marcar/desmarcar aquellos sobre los que se quiere obtener la documentación:
Documentación online
Una vez seleccionados todos los conceptos a documentar, se genera la documentación en formato web, mostrando un diagrama general y organizando cada tipo de concepto en una pestaña:
Resumen
También puedes generar un resumen de la documentación:
Almacenamiento
Al generar la documentación, ésta queda almacenada en la Plataforma, de manera que es posible consultarla, descargarla en formato PDF o Word, o compararla con otra documentación sobre el mismo proyecto para ver avances del proyecto entre dos fechas diferentes.
Como podemos ver, esta funcionalidad resulta de mucha utilidad para ir gestionando la evolución del Producto o Proyecto en el que estés trabajando. Esta y muchas otras nuevas funcionalidades se encuentran disponibles en la versión 5.0.0-Renegade de Onesait Platform, así que no dejéis de actualizaros vuestro entorno.
Imagen de cabecera: vnwayne fan en Unsplash
✍🏻 Author(s)
