Documentar un producto de datos

Hay dos tipos de documentación para cada uno de sus productos de datos.

• La documentación general, que resume su producto de datos: los conjuntos de datos que tiene, la actualidad y calidad de los datos, etc.
• La sección Léame que contiene toda la información que el administrador del producto de datos desea compartir sobre el producto de datos.

También puede añadir contactos clave a sus productos de datos y adjuntar glosarios empresariales para que las definiciones empresariales estandarizadas estén disponibles para los consumidores.

Generar la documentación general de un producto de datos

Puede generar, visualizar y descargar la documentación de un producto de datos para recopilar toda la información relativa al mismo en un mismo archivo, como la calidad de los datos, el número de conjuntos de datos, la calidad de cada conjunto de datos, los campos de cada conjunto de datos, etc.

Puede descargar la documentación en formato markdown (.md).

Cuando un conjunto de datos del producto de datos se encuentre en un espacio al que no tenga acceso, podrá seguir generando y descargando la documentación, pero el conjunto de datos y sus datos no se incluirán en la documentación.

1. Abra el producto de datos desde el menú Catálogo o Productos de datos.
2. A la derecha, haga clic en > Obtener documentación. Se abre la ventana de Documentación.
3. Para descargarlo en formato MD, haga clic en Descargar.

   También puede descargarlo en formato PDF desde su navegador. Haga clic con el botón derecho en la documentación > Imprimir....

Editar la sección Léame

Como administrador de un producto de datos, puede editar la sección Léame tanto como sea necesario. El formato de texto enriquecido le permite estructurar la sección para que sea lo más clara posible.

1. Asegúrese de tener los siguientes roles o permisos:
   • El rol de Administrador de productos de datos o el permiso de Administrar productos de datos.
   • El permiso para editar el espacio.
2. Abra el producto de datos desde el menú Catálogo o Productos de datos.
3. Seleccione la pestaña Documentación.
4. Haga clic en Editar en la sección Léame.
5. Introduzca la información y haga clic en Guardar.

También puede editar la sección Léame haciendo clic en > Documentación a la derecha.

Agregar contactos clave

Añada contactos clave para especificar con quién pueden ponerse en contacto los consumidores si tienen alguna pregunta o problema con el producto de datos.

1. Asegúrese de tener los siguientes roles o permisos:
   • El rol de Administrador de productos de datos o el permiso de Administrar productos de datos.
   • El permiso para editar el espacio.
2. Abra el producto de datos desde el menú Catálogo o Productos de datos.
3. Seleccione la pestaña Documentación.
4. Haga clic en Editar en la sección Contactos.
5. Indique los contactos clave y haga clic en Guardar.

También puede editar los contactos clave haciendo clic en > Documentación > Contactos clave a la derecha.

Visualización de glosarios empresariales adjuntos

Los productos de datos pueden incluir glosarios empresariales adjuntos que proporcionan definiciones empresariales estandarizadas para el contenido del producto de datos. Los glosarios se muestran en la pestaña Documentación junto con la sección Léame y los contactos clave.

Como administrador de productos de datos

Puede ver y gestionar los glosarios adjuntos:

1. Abra el producto de datos desde el menú Catálogo o Productos de datos.
2. Seleccione la pestaña Documentación.
3. Desplácese hasta la sección Glosarios para ver los glosarios adjuntos.
4. Haga clic en Editar para añadir, reemplazar o eliminar glosarios. Para obtener instrucciones detalladas, consulte Añadir glosarios empresariales a un producto de datos.

Como consumidor de productos de datos

Puede ver los glosarios empresariales adjuntos a los productos de datos a los que tiene acceso:

1. Abra el producto de datos desde el Catálogo.
2. Seleccione la pestaña Documentación.
3. Vea la sección Glosarios para ver las definiciones de negocio relevantes para el producto de datos.

Solo se muestran los glosarios a los que tiene acceso de lectura. Si no puede ver un glosario en la pestaña Documentación, póngase en contacto con su administrador o con el gestor del producto de datos para solicitar acceso.