Документирование продукта данных

Последнее обновление: 2026-11-10

Вы можете найти два типа документации для каждого из ваших продуктов данных.

• Общая документация, содержащая сводную информацию о вашем продукте данных, такую как наборы данных, Свежесть данных, качество данных, семантические модели и т. д.
• Раздел Read me, содержащий всю информацию, которой менеджер продукта данных хочет поделиться о продукте данных.

Если ваш продукт данных содержит семантическую модель, сгенерированная документация включает сведения о таблицах, связях, мерах и измерениях, определенных в семантической модели.

Вы также можете добавить ключевые контакты в свои продукты данных и прикрепить бизнес-глоссарии, чтобы сделать стандартизированные бизнес-определения доступными для потребителей.

Генерация общей документации продукта данных

Вы можете сгенерировать, просмотреть и загрузить документацию продукта данных, чтобы собрать всю информацию о нем в одном файле, такую как качество данных, количество наборов данных, качество каждого набора данных, поля каждого набора данных и т. д.

Создание общей документации продукта данных также можно выполнять с помощью соответствующего общедоступного API Qlik.

Вы можете загрузить документацию в формате markdown (.md).

Если набор данных в продукте данных находится в пространстве, к которому у вас нет доступа, вы все равно можете сгенерировать и загрузить документацию, но этот набор данных и его данные не будут включены в документацию.

1. Откройте продукт данных из меню Каталог или Продукты данных.
2. Справа нажмите > Получить документацию. Открывается окно Документация.
3. Чтобы загрузить в формате MD, нажмите Загрузить.

   Вы также можете загрузить в формате PDF из браузера. Щелкните правой кнопкой мыши по документации > Печать....

Редактирование раздела read me

Как менеджер по продуктам данных, вы можете редактировать раздел Read me столько, сколько потребуется. Формат форматированного текста позволяет структурировать раздел, чтобы максимально очистить его.

1. Убедитесь, что у вас есть следующие роли или разрешения:
   • Роль Менеджер продуктов данных или разрешение Управление продуктами данных.
   • Разрешение на редактирование пространства.
2. Откройте продукт данных из меню Каталог или Продукты данных.
3. Выберите вкладку Документация.
4. Нажмите Изменить в разделе Read me.
5. Введите информацию и нажмите Сохранить.

Вы также можете отредактировать раздел Read me, нажав > Документация справа.

Добавление ключевых контактов

Добавьте ключевые контакты, чтобы указать, к кому потребители могут обратиться по любым вопросам или проблемам, связанным с продуктом данных.

1. Убедитесь, что у вас есть следующие роли или разрешения:
   • Роль Менеджер продуктов данных или разрешение Управление продуктами данных.
   • Разрешение на редактирование пространства.
2. Откройте продукт данных из меню Каталог или Продукты данных.
3. Выберите вкладку Документация.
4. Нажмите Изменить в разделе Контакты.
5. Введите ключевые контакты и нажмите Сохранить.

Вы также можете отредактировать ключевые контакты, нажав справа > Документация > Ключевые контакты.

Просмотр прикрепленных бизнес-глоссариев

Продукты данных могут содержать прикрепленные бизнес-глоссарии, которые предоставляют стандартизированные бизнес-определения для содержимого продукта данных. Глоссарии отображаются на вкладке Документация рядом с разделом Read me и ключевыми контактами.

Как менеджер продуктов данных

Вы можете просматривать прикрепленные глоссарии и управлять ими:

1. Откройте продукт данных из меню Каталог или Продукты данных.
2. Выберите вкладку Документация.
3. Прокрутите до раздела Глоссарии, чтобы просмотреть прикрепленные глоссарии.
4. Нажмите Изменить, чтобы добавить, заменить или удалить глоссарии. Подробные инструкции см. в Добавление бизнес-глоссариев в продукт данных.

Как потребитель продуктов данных

Вы можете просматривать бизнес-глоссарии, прикрепленные к продуктам данных, к которым у вас есть доступ:

1. Откройте продукт данных из Каталога.
2. Выберите вкладку Документация.
3. Откройте раздел Глоссарии, чтобы просмотреть бизнес-определения, относящиеся к продукту данных.

Отображаются только те глоссарии, к которым у вас есть доступ на чтение. Если вы не видите глоссарий на вкладке Документация, обратитесь к администратору или менеджеру продукта данных, чтобы запросить доступ.