Dokumentieren eines Datenprodukts

Es gibt zwei Typen von Dokumentation für jedes Ihrer Datenprodukte.

• Die allgemeine Dokumentation, die Informationen über Ihr Datenprodukt zusammenfasst, wie z. B. die Datensätze, die Datenaktualität, die Datenqualität usw.
• Der Abschnitt Read me, der alle Informationen enthält, die der Datenproduktmanager über das Datenprodukt teilen möchte.

Sie können Ihren Datenprodukten auch wichtige Kontakte hinzufügen und Unternehmensglossare anhängen, um standardisierte Geschäftsdefinitionen für Nutzer verfügbar zu machen.

Erstellen der allgemeinen Dokumentation eines Datenprodukts

Sie können die Dokumentation eines Datenprodukts erstellen, anzeigen und herunterladen, um alle Informationen darüber in einer Datei zu sammeln, z. B. die Datenqualität, die Anzahl der Datensätze, die Qualität jedes Datensatzes, die Felder jedes Datensatzes usw.

Das Erstellen der allgemeinen Dokumentation eines Datenprodukts kann auch über die entsprechende öffentliche Qlik API erfolgen.

Sie können die Dokumentation im Markdown-Format herunterladen (.md).

Wenn sich ein Datensatz im Datenprodukt in einem Bereich befindet, auf den Sie keinen Zugriff haben, können Sie die Dokumentation trotzdem erstellen und herunterladen, aber der Datensatz und seine Daten werden nicht in die Dokumentation aufgenommen.

1. Öffnen Sie das Datenprodukt über das Menü Katalog oder Datenprodukte.
2. Klicken Sie rechts auf > Dokumentation abrufen. Das Fenster Dokumentation wird geöffnet.
3. Zum Herunterladen im MD-Format klicken Sie auf Download.

   Sie können den Download auch im PDF-Format von Ihrem Browser aus durchführen. Klicken Sie mit der rechten Maustaste auf die Dokumentation > Drucken....

Bearbeiten des Abschnitts „Read me“

Als Datenproduktmanager können Sie den Abschnitt Read me beliebig oft bearbeiten. Das Rich-Text-Format ermöglicht es Ihnen, den Abschnitt so klar wie möglich zu strukturieren.

1. Stellen Sie sicher, dass Sie die folgenden Rollen oder Berechtigungen haben:
   • Die Rolle Datenproduktmanager oder die Berechtigung Datenprodukte verwalten.
   • Die Berechtigung, den Bereich zu bearbeiten.
2. Öffnen Sie das Datenprodukt über das Menü Katalog oder Datenprodukte.
3. Wählen Sie die Registerkarte Dokumentation.
4. Klicken Sie im Abschnitt Read me auf Bearbeiten.
5. Geben Sie die Informationen ein und klicken Sie auf Speichern.

Sie können auch den Read me Abschnitt bearbeiten, indem Sie klicken > Dokumentation auf der rechten Seite.

Hinzufügen wichtiger Kontakte

Fügen Sie wichtige Kontakte hinzu, um anzugeben, wen Nutzer bei Fragen oder Problemen mit dem Datenprodukt kontaktieren können.

1. Stellen Sie sicher, dass Sie die folgenden Rollen oder Berechtigungen haben:
   • Die Rolle Datenproduktmanager oder die Berechtigung Datenprodukte verwalten.
   • Die Berechtigung, den Bereich zu bearbeiten.
2. Öffnen Sie das Datenprodukt über das Menü Katalog oder Datenprodukte.
3. Wählen Sie die Registerkarte Dokumentation.
4. Klicken Sie im Abschnitt Kontakte auf Bearbeiten.
5. Geben Sie die wichtigen Kontakte ein und klicken Sie auf Speichern.

Sie können wichtige Kontakte auch bearbeiten, indem Sie auf > Dokumentation > Wichtige Kontakte rechts.

Anzeigen angehängter Unternehmensglossare

Datenprodukte können angehängte Unternehmensglossare enthalten, die standardisierte Geschäftsdefinitionen für die Inhalte des Datenprodukts bereitstellen. Glossare werden auf der Registerkarte Dokumentation neben dem Abschnitt Lies mich und den wichtigen Kontakten angezeigt.

Als Datenproduktmanager

Sie können angehängte Glossare anzeigen und verwalten:

1. Öffnen Sie das Datenprodukt über das Menü Katalog oder Datenprodukte.
2. Wählen Sie die Registerkarte Dokumentation.
3. Scrollen Sie zum Abschnitt Glossare, um angehängte Glossare anzuzeigen.
4. Klicken Sie auf Bearbeiten, um Glossare hinzuzufügen, zu ersetzen oder zu entfernen. Detaillierte Anweisungen hierzu finden Sie unter Hinzufügen von Unternehmensglossaren zu einem Datenprodukt.

Als Datenproduktnutzer

Sie können Unternehmensglossare anzeigen, die an Datenprodukte angehängt sind, auf die Sie Zugriff haben:

1. Öffnen Sie das Datenprodukt über den Katalog.
2. Wählen Sie die Registerkarte Dokumentation.
3. Zeigen Sie den Abschnitt Glossare an, um Geschäftsdefinitionen anzuzeigen, die für das Datenprodukt relevant sind.

Es werden nur Glossare angezeigt, auf die Sie Lesezugriff haben. Wenn Sie ein Glossar im Tab Dokumentation nicht sehen können, wenden Sie sich an Ihren Administrator oder den Datenproduktmanager, um Zugriff anzufordern.