A principal função dos modelos da Kondado é abstrair as regras de negócio e cruzamentos de dados em uma única tabela já preparada e transformada que possa ser consumida por usuários não técnicos, ferramentas de visualização e como feature stores.
Nesse sentido, fornecer uma documentação do seu modelo é fundamental para 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 pequeno livro ao lado de “Configurações”. Ao clicar neste livro, você acessará a documentação do seu modelo.
Estrutura da documentação
A documentação de um modelo possui 4 seções:
RESUMO
Contém informações básicas e não diretamente editáveis sobre o modelo: URL, Status, Tabela, Destino, Acionadores e cadeia de execução
SOBRE
A seção “Sobre” é o um texto livre a ser criado pelos usuários. A sua edição é similar a escrever um documento word (ou google docs).
Para editar a seção sobre, basta clicar 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 cada 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 linha, na coluna “DESCRIÇÃO”
Uma vez que você esteja satisfeito com a descrição daquele campo, basta clicar no disquete e a descrição será salva
QUERY
Nesta seção, será exibida a query (SQL) do modelo, sem possibilidade de edição
