Objetivo
Con esta funcionalidad pretendemos apoyar en el trabajo de documentar un sistema construido sobre plataforma. A través del propio Control Panel de plataforma podré generar tanto en formato web como en pdf/word la documentación sobre todos los elementos de plataforma.
La documentación genera también un diagrama de arquitectura por capas (Ingesta, Conocimiennto, Publicación,...) incluyendo los elementos:
Ingesta: DataFlow (pipelines), Digital Clients, Kafka Topics, Digital Twins
Processing: FlowEngine, BPM,
Persistencia: Entidades
Knowledge: Notebooks
Publicación: APIs, Dashboards
¿Cómo funciona?
Como puede verse en la imagen,
la funcionalidad puede usarse de 2 formas:
Documentación asociada a un proyecto/aplicación: En este caso de documentan todos los elementos de plataforma (Entidades, Clientes, Apis, Dashboards, Notebooks, Flujos…) asociados a una aplicación/proyecto desarrollado sobre la 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 se genera un resumen:
Almacenamiento
Al generar la documentación, esta queda almacenada en la plataforma, de manera que es posible consultarla, descargarla en formato PDF/Word o compararla con otra documentación sobre el mismo proyecto para ver avances del proyecto entre dos fechas diferentes.
