# Dokumentowanie produktu danych

Możesz znaleźć dwa rodzaje dokumentacji dla każdego ze swoich produktów danych.

* Ogólna dokumentacja podsumowująca Twój produkt danych, na przykład zbiory danych, Świeżość danych, jakość danych itd.
* Sekcja Read me, która zawiera wszystkie informacje, jakie menedżer produktu danych chce udostępnić na temat produktu danych.

Możesz także dodać kluczowe osoby do kontaktu do swoich produktów danych i dołączyć słowniki biznesowe, aby udostępnić konsumentom ustandaryzowane definicje biznesowe.

InformacjaPotrzebujesz jednej z następujących subskrypcji:

* Qlik Talend Cloud Enterprise
* Qlik Talend Cloud Premium
* Qlik Cloud Analytics Premium
* Qlik Cloud Analytics Enterprise
* Qlik Sense Enterprise SaaS

InformacjaPotrzebujesz uprawnienia do zarządzania produktami danych.

## Generowanie ogólnej dokumentacji produktu danych

Możesz generować, wyświetlać i pobierać dokumentację produktu danych, aby zebrać wszystkie informacje na jego temat w jednym pliku, takie jak jakość danych, liczba zestawów danych, jakość każdego zestawu danych, pola każdego zestawu danych itp.

Generowanie ogólnej dokumentacji produktu danych można również wykonać za pośrednictwem odpowiedniego [publicznego API Qlik](https://qlik.dev/apis/rest/data-governance/data-products/#get-api-data-governance-data-products-dataProductId-actions-export-documentation).

Możesz pobierać dokumentację w formacie markdown (`.md`).

Gdy zestaw danych w produkcie danych znajduje się w przestrzeni, do której nie masz dostępu, nadal możesz generować i pobierać dokumentację, ale zestaw danych i jego dane nie zostaną uwzględnione w dokumentacji.

1. Otwórz produkt danych z menu Katalog lub Produkty danych.

2. Po prawej stronie kliknij the Ikona Działania icon > Pobierz dokumentację. Otwiera się okno Dokumentacja.

3. Aby pobierać w formacie MD, kliknij Pobierz.

   Możesz także pobierać w formacie PDF ze swojej przeglądarki. Kliknij dokumentację prawym przyciskiem myszy > Drukuj....

## Edycja sekcji read me

Jako menedżer produktu danych możesz edytować sekcję Read me tak często, jak to konieczne. Format tekstu sformatowanego pozwala ustrukturyzować sekcję tak, aby jak najbardziej ją czyścić.

1. Upewnij się, że masz następujące role lub uprawnienia:
   * Rola Menedżer produktów danych lub uprawnienie Zarządzanie produktami danych.
   * Uprawnienie do edycji przestrzeni.
2. Otwórz produkt danych z menu Katalog lub Produkty danych.
3. Wybierz kartę Dokumentacja.
4. Kliknij Edytuj w sekcji Przeczytaj mnie.
5. Wprowadź informacje i kliknij Zapisz.

Możesz również edytować sekcję Read me, klikając ![Przycisk Edytuj](https://help.qlik.com/pl-PL/cloud-services/Subsystems/Hub/Content/Resources/Images/Icons/di_edit_button.png) > Dokumentacja po prawej stronie.

## Dodawanie kluczowych kontaktów

Dodaj kluczowe kontakty, aby określić, z kim odbiorcy mogą się skontaktować w razie jakichkolwiek pytań lub problemów z produktem danych.

1. Upewnij się, że masz następujące role lub uprawnienia:
   * Rola Menedżer produktów danych lub uprawnienie Zarządzanie produktami danych.
   * Uprawnienie do edycji przestrzeni.
2. Otwórz produkt danych z menu Katalog lub Produkty danych.
3. Wybierz kartę Dokumentacja.
4. Kliknij Edytuj w sekcji Kontakty.
5. Wprowadź kluczowe kontakty i kliknij Zapisz.

Możesz również edytować kluczowe kontakty, klikając ![Przycisk Edytuj](https://help.qlik.com/pl-PL/cloud-services/Subsystems/Hub/Content/Resources/Images/Icons/di_edit_button.png) > Dokumentacja > Kluczowe kontakty po prawej stronie.

## Wyświetlanie dołączonych glosariuszy biznesowych

Produkty danych mogą zawierać dołączone słowniki biznesowe, które zapewniają ustandaryzowane definicje biznesowe dla zawartości produktu danych. Glosariusze są wyświetlane w zakładce Dokumentacja obok sekcji Read me oraz kluczowych kontaktów.

### Jako menedżer produktu danych

Możesz przeglądać dołączone glosariusze i zarządzać nimi:

1. Otwórz produkt danych z menu Katalog lub Produkty danych.
2. Wybierz kartę Dokumentacja.
3. Przewiń do sekcji Glosariusze, aby zobaczyć dołączone glosariusze.
4. Kliknij Edytuj, aby dodać, zastąpić lub usunąć glosariusze. Aby uzyskać szczegółowe instrukcje, zobacz [Dodawanie słowników biznesowych do produktu danych](https://help.qlik.com/pl-PL/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DataProducts/Adding-business-glossaries.htm).

### Jako użytkownik produktu danych

Możesz przeglądać glosariusze biznesowe dołączone do produktów danych, do których masz dostęp:

1. Otwórz produkt danych z Katalogu.
2. Wybierz kartę Dokumentacja.
3. Wyświetl sekcję Glosariusze, aby zobaczyć definicje biznesowe istotne dla produktu danych.

Wyświetlane są tylko te glosariusze, do których masz dostęp do odczytu. Jeśli nie widzisz glosariusza na karcie Dokumentacja, skontaktuj się z administratorem lub menedżerem produktu danych, aby poprosić o dostęp.