Documentando um produto de dados

Você pode encontrar dois tipos de documentação para cada um dos seus produtos de dados.

• A documentação geral que resume seu produto de dados, como os conjuntos de dados, a atualização dos dados, a qualidade dos dados, etc.
• A seção Leia-me que contém todas as informações que o gerente do produto de dados deseja compartilhar sobre o produto de dados.

Você também pode adicionar contatos principais aos seus produtos de dados e anexar glossários de negócios para disponibilizar definições de negócios padronizadas aos consumidores.

Gerando a documentação geral de um produto de dados

Você pode gerar, visualizar e baixar a documentação de um produto de dados para coletar todas as informações sobre ele em um arquivo, como a qualidade dos dados, o número de conjuntos de dados, a qualidade de cada conjunto de dados, os campos de cada conjunto de dados, etc.

Gerando a documentação geral de um produto de dados também pode ser realizada por meio da correspondente Qlik Public API.

Você pode baixar a documentação em formato de marcação (.md).

Quando um conjunto de dados no produto de dados estiver em um espaço ao qual você não tem acesso, você ainda poderá gerar e baixar a documentação, mas o conjunto de dados e seus dados não serão incluídos na documentação.

1. Abra o produto de dados no menu Catálogo ou Produtos de dados.
2. À direita, clique em > Obter documentação. A janela Documentação é aberta.
3. Para baixar no formato MD, clique em Fazer download.

   Você também pode baixar em formato PDF no seu navegador. Clique com o botão direito do mouse na documentação > Imprimir....

Editando a seção leia-me

Como um gerente de produto de dados, você pode editar a seção Leia-me conforme necessário. O formato de rich text permite que você estruture a seção para torná-la o mais clara possível.

1. Certifique-se de ter as seguintes funções ou permissões:
   • A função de Gerente de Produto de Dados ou a permissão de Gerenciar produtos de dados.
   • A permissão para editar o espaço.
2. Abra o produto de dados no menu Catálogo ou Produtos de dados.
3. Selecione a guia Documentação.
4. Clique em Editar na seção Leia-me.
5. Insira as informações e clique em Salvar.

Você também pode editar a seção Leia-me clicando em > Documentação à direita.

Adicionando contatos principais

Adicione contatos principais para especificar quem os consumidores podem contatar caso tenham perguntas ou problemas com o produto de dados.

1. Certifique-se de ter as seguintes funções ou permissões:
   • A função de Gerente de Produto de Dados ou a permissão de Gerenciar produtos de dados.
   • A permissão para editar o espaço.
2. Abra o produto de dados no menu Catálogo ou Produtos de dados.
3. Selecione a guia Documentação.
4. Clique em Editar na seção Contatos.
5. Insira os contatos principais e clique em Salvar.

Você também pode editar os contatos principais clicando em > Documentação > Contatos principais à direita.

Visualizando glossários de negócios anexados

Os produtos de dados podem incluir glossários de negócios anexados que fornecem definições de negócios padronizadas para o conteúdo do produto de dados. Os glossários são exibidos na guia Documentação junto com a seção Leia-me e os contatos principais.

Como um gerente de produtos de dados

Você pode visualizar e gerenciar glossários anexados:

1. Abra o produto de dados no menu Catálogo ou Produtos de dados.
2. Selecione a guia Documentação.
3. Role até a seção Glossários para ver os glossários anexados.
4. Clique em Editar para adicionar, substituir ou remover glossários. Para obter instruções detalhadas, consulte: Adicionando glossários de negócios a um produto de dados.

Como um consumidor de produtos de dados

Você pode visualizar os glossários de negócios anexados aos produtos de dados aos quais você tem acesso:

1. Abra o produto de dados no Catálogo.
2. Selecione a guia Documentação.
3. Visualize a seção Glossários para ver definições de negócios relevantes para o produto de dados.

Somente os glossários aos quais você tem acesso de leitura são exibidos. Se você não conseguir ver um glossário na guia Documentação, entre em contato com seu administrador ou com o gerente do produto de dados para solicitar acesso.