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.

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.

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 auf der rechten Seite 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 den Abschnitt Read me auch bearbeiten, indem Sie rechts auf > Dokumentation klicken.

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 rechts auf > Dokumentation > Wichtige Kontakte klicken.