Documentare un data product

Ultimo aggiornamento: 2026-11-10

Puoi trovare due tipi di documentazione per ciascuno dei tuoi prodotti di dati.

• La documentazione generale che riepiloga il tuo data product, come i dataset, l'attualità dei dati, la qualità dei dati, i modelli semantici, ecc.
• La sezione Read me che contiene tutte le informazioni che il data product manager desidera condividere sul data product.

Se il tuo prodotto dati include un modello semantico, la documentazione generata include informazioni su tabelle, relazioni, misure e dimensioni definite nel modello semantico.

È inoltre possibile aggiungere contatti chiave ai propri prodotti dati e associare glossari aziendali per rendere disponibili definizioni aziendali standardizzate ai consumatori.

Generazione della documentazione generale di un prodotto dati

È possibile generare, visualizzare ed eseguire il download della documentazione di un data product per raccogliere tutte le informazioni correlate in un unico file, come la qualità dei dati, il numero di dataset, la qualità di ciascun dataset, i campi di ciascun dataset, ecc.

La generazione della documentazione generale di un data product può essere eseguita anche tramite la corrispondente API pubblica di Qlik.

È possibile effettuare il download della documentazione in formato markdown (.md).

Quando un dataset nel data product si trova in uno spazio a cui non hai accesso, puoi comunque generare ed eseguire il download della documentazione, ma il dataset e i relativi dati non saranno inclusi nella documentazione.

1. Apri il prodotto dati dal menu Catalogo o Prodotti dati.
2. A destra, fai clic su > Ottieni documentazione. Si apre la finestra Documentazione.
3. Per eseguire il download in formato MD, fare clic su Download.

   Puoi anche effettuare il download in formato PDF dal tuo browser. Fare clic con il pulsante destro del mouse sulla documentazione > Stampa....

Modifica della sezione leggimi

In qualità di data product manager, puoi modificare la sezione Leggimi ogni volta che è necessario. Il formato rich text consente di strutturare la sezione per renderla il più cancella possibile.

1. Assicurarsi di disporre dei seguenti ruoli o autorizzazioni:
   • Il ruolo Data Product Manager o l'autorizzazione Gestisci prodotti dati.
   • L'autorizzazione a modificare lo spazio.
2. Apri il prodotto dati dal menu Catalogo o Prodotti dati.
3. Selezionare la scheda Documentazione.
4. Fare clic su Modifica nella sezione Leggimi.
5. Inserire le informazioni e fare clic su Salva.

È inoltre possibile modificare la sezione Leggimi facendo clic su > Documentazione a destra.

Aggiunta di contatti chiave

Aggiungi contatti chiave per specificare chi possono contattare i consumatori per eventuali domande o problemi relativi al prodotto dati.

1. Assicurarsi di disporre dei seguenti ruoli o autorizzazioni:
   • Il ruolo Data Product Manager o l'autorizzazione Gestisci prodotti dati.
   • L'autorizzazione a modificare lo spazio.
2. Apri il prodotto dati dal menu Catalogo o Prodotti dati.
3. Selezionare la scheda Documentazione.
4. Fai clic su Modifica nella sezione Contatti.
5. Inserire i contatti principali e fare clic su Salva.

È inoltre possibile modificare i contatti principali facendo clic su > Documentazione > Contatti principali a destra.

Visualizzazione dei glossari aziendali allegati

I data product possono includere glossari aziendali allegati che forniscono definizioni aziendali standardizzate per i contenuti del data product. I glossari vengono visualizzati nella scheda Documentazione accanto alla sezione Leggimi e ai contatti principali.

In qualità di gestione prodotto dati

È possibile visualizzare e gestire i glossari allegati:

1. Apri il prodotto dati dal menu Catalogo o Prodotti dati.
2. Selezionare la scheda Documentazione.
3. Scorri fino alla sezione Glossari per visualizzare i glossari allegati.
4. Fai clic su Modifica per aggiungere, sostituire o rimuovere glossari. Per istruzioni dettagliate, vedere Aggiunta di glossari aziendali a un prodotto dati.

Come consumatore prodotti dati

È possibile visualizzare i glossari aziendali associati ai prodotti dati a cui si ha accesso:

1. Apri il prodotto dati dal Catalogo.
2. Selezionare la scheda Documentazione.
3. Visualizza la sezione Glossari per consultare le definizioni di business pertinenti al data product.

Vengono visualizzati solo i glossari per cui si dispone dell'accesso in lettura. Se non riesci a visualizzare un glossario nella scheda Documentazione, contatta l'amministratore o il data product manager per richiedere l'accesso.