---
title: "Documentación de elementos de Plataforma"
canonical: "https://onesaitplatform-es.refined.site/space/DOC/3730112536/Documentaci%C3%B3n%20de%20elementos%20de%20Plataforma"
format: markdown
---
> Macro (toc)

> ℹ️ Disponible desde Release 5.0.0 (Renegade)

# 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:

![image](media://900f2d32-5df5-496c-8fa1-d5fc95b79030)

- **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, 

![image](media://2104ef92-6ba6-4f20-8c5e-db982aad88de)

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: 

![image](media://e75d4a4c-ebaa-4fbb-bfd9-0823b723df42)

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. 

![image](media://7021bde3-3c33-4eb2-a79b-b4f9bfe57c67)

## 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: 

![image](media://900f2d32-5df5-496c-8fa1-d5fc95b79030)

## Resumen

También se genera un **resumen:**

![image](media://274ae37c-1be9-49cf-9d4c-d9a26f7c65fa)

## 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. 

![image](media://535914df-aec1-494b-8528-ae4817fef579)