{"id":1706,"date":"2020-11-09T22:17:25","date_gmt":"2020-11-10T01:17:25","guid":{"rendered":"https:\/\/kondado.com.br\/blog\/wiki\/?p=1706"},"modified":"2025-08-07T15:03:11","modified_gmt":"2025-08-07T18:03:11","slug":"documentando-modelos","status":"publish","type":"post","link":"https:\/\/kondado.com.br\/blog\/wiki\/2020\/11\/09\/documentando-modelos\/","title":{"rendered":"02. Documentando modelos"},"content":{"rendered":"\n

A principal fun\u00e7\u00e3o dos modelos da Kondado \u00e9 abstrair as regras de neg\u00f3cio e cruzamentos de dados numa \u00fanica tabela j\u00e1 preparada e transformada<\/a> e que possa ser consumida por usu\u00e1rios n\u00e3o t\u00e9cnicos, ferramentas de visualiza\u00e7\u00e3o e feature stores.<\/p>\n\n\n\n

Nesse sentido, fornecer uma documenta\u00e7\u00e3o do seu modelo \u00e9 fundamental para que os seus “consumidores” possam ter ainda mais liberdade para se auto-servir e explorar os dados da empresa. Documentar modelos \u00e9 uma das principais fun\u00e7\u00f5es de qualquer analytics engineer<\/a>.<\/p>\n\n\n\n

Acessando a documenta\u00e7\u00e3o de um modelo<\/h4>\n\n\n\n

Ao abrir o seu modelo da Kondado, voc\u00ea ver\u00e1 um \u00edcone de um pequeno livro ao lado de “Configura\u00e7\u00f5es”<\/strong>. Ao clicar nele, voc\u00ea acessar\u00e1 a documenta\u00e7\u00e3o do seu modelo:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Estrutura da documenta\u00e7\u00e3o<\/h4>\n\n\n\n

A documenta\u00e7\u00e3o de um modelo possui 4 (quatro) se\u00e7\u00f5es:<\/p>\n\n\n\n

RESUMO<\/strong><\/p>\n\n\n\n

A se\u00e7\u00e3o “RESUMO”<\/strong> cont\u00e9m informa\u00e7\u00f5es b\u00e1sicas e n\u00e3o diretamente edit\u00e1veis sobre o modelo: URL, tabela, destino, acionadores e cadeia de execu\u00e7\u00e3o:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

SOBRE<\/strong><\/p>\n\n\n\n

A se\u00e7\u00e3o “SOBRE”<\/strong> \u00e9 um texto livre criado pelos usu\u00e1rios. A sua edi\u00e7\u00e3o \u00e9 similar \u00e0 do WORD (ou Google Docs).<\/p>\n\n\n\n

Para editar essa se\u00e7\u00e3o, clique no l\u00e1pis que fica ao lado do t\u00edtulo da se\u00e7\u00e3o:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Neste editor, voc\u00ea poder\u00e1 escrever o que quiser e utilizar as a\u00e7\u00f5es dispon\u00edveis para formatar o seu texto. Aqui, voc\u00ea pode incluir uma descri\u00e7\u00e3o do modelo, seu objetivo, publico-alvo, exemplos de uso, etc.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Uma vez que voc\u00ea esteja satisfeito com o texto escrito, basta clicar no disquete ao lado do t\u00edtulo da se\u00e7\u00e3o e o seu texto ser\u00e1 salvo.<\/p>\n\n\n\n

CAMPOS<\/strong><\/p>\n\n\n\n

Ap\u00f3s a execu\u00e7\u00e3o de um modelo, a Kondado guarda os campos da tabela gerada. Nesta se\u00e7\u00e3o da documenta\u00e7\u00e3o, voc\u00ea pode fornecer uma descri\u00e7\u00e3o para cada campo gerado na sua tabela:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Para editar a descri\u00e7\u00e3o de um campo, basta clicar no l\u00e1pis que aparecer\u00e1 em cada uma das linhas dentro da coluna “DESCRI\u00c7\u00c3O”<\/strong>:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Se estiver satisfeito com a descri\u00e7\u00e3o do campo, clique no disquete e a descri\u00e7\u00e3o ser\u00e1 salva:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

QUERY<\/strong><\/p>\n\n\n\n

Nesta se\u00e7\u00e3o, ser\u00e1 exibida a query (SQL) do modelo, sem possibilidade de edi\u00e7\u00e3o:<\/p>\n\n\n\n

\"\"<\/figure>\n","protected":false},"excerpt":{"rendered":"

Aprenda como documentar os seus modelos da Kondado!<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1,293],"tags":[37,357,361,360,358,359,7,6,8],"_links":{"self":[{"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/posts\/1706"}],"collection":[{"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/comments?post=1706"}],"version-history":[{"count":4,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/posts\/1706\/revisions"}],"predecessor-version":[{"id":10089,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/posts\/1706\/revisions\/10089"}],"wp:attachment":[{"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/media?parent=1706"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/categories?post=1706"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kondado.com.br\/blog\/wiki\/wp-json\/wp\/v2\/tags?post=1706"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}