A principal função dos modelos da Kondado é abstrair as regras de negócio e cruzamentos de dados numa única tabela já preparada e transformada e que possa ser consumida por usuários não técnicos, ferramentas de visualização e feature stores.
Nesse sentido, fornecer uma documentação do seu modelo é fundamental para que os seus “consumidores” possam ter ainda mais liberdade para se auto-servir e explorar os dados da empresa. Documentar modelos é uma das principais funções de qualquer analytics engineer.
Acessando a documentação de um modelo
Ao abrir o seu modelo da Kondado, você verá um ícone de um pequeno livro ao lado de “Configurações”. Ao clicar nele, você acessará a documentação do seu modelo:
Estrutura da documentação
A documentação de um modelo possui 4 (quatro) seções:
RESUMO
A seção “RESUMO” contém informações básicas e não diretamente editáveis sobre o modelo: URL, tabela, destino, acionadores e cadeia de execução:
SOBRE
A seção “SOBRE” é um texto livre criado pelos usuários. A sua edição é similar à do WORD (ou Google Docs).
Para editar essa seção, clique no lápis que fica ao lado do título da seção:
Neste editor, você poderá escrever o que quiser e utilizar as ações disponíveis para formatar o seu texto. Aqui, você pode incluir uma descrição do modelo, seu objetivo, publico-alvo, exemplos de uso, etc.
Uma vez que você esteja satisfeito com o texto escrito, basta clicar no disquete ao lado do título da seção e o seu texto será salvo.
CAMPOS
Após a execução de um modelo, a Kondado guarda os campos da tabela gerada. Nesta seção da documentação, você pode fornecer uma descrição para cada campo gerado na sua tabela:
Para editar a descrição de um campo, basta clicar no lápis que aparecerá em cada uma das linhas dentro da coluna “DESCRIÇÃO”:
Se estiver satisfeito com a descrição do campo, clique no disquete e a descrição será salva:
QUERY
Nesta seção, será exibida a query (SQL) do modelo, sem possibilidade de edição:
