Como documentamos os processos relacionados a dados no Edify?
Antes de tudo precisamos entender a importância da documentação:
“A importância da documentação de processos está relacionada à ideia de diretriz, cujo propósito é servir como uma espécie de roteiro para a organização, ajudando a mapear gargalos e anomalias nos procedimentos. Assim facilitando que seja possível apontar soluções às dificuldades encontradas ao longo das etapas de trabalho, de cada setor e atividade.”
Ref: https://conteudo.movidesk.com/o-que-e-documentacao-de-processos/
Como organizamos a documentação aqui no Edify:
Toda documentação começa no Notion, em uma página principal onde separamos em 3 grandes blocos: Processos, Catálogos, e Documentação Técnica.
Para guiar melhor a todos que acessam, temos uma página de onboarding onde damos um overview de toda a estrutura e documentação.
Processos: Fluxo de trabalho e como acessar os ambientes
Aqui temos um exemplo de uma página com o processo para acessar o nosso Data Lake
Catálogos: Relatórios
Na página de Relatórios temos uma listagem com todos os relatórios disponíveis na empresa para que todos tenham conhecimento das informações disponíveis e solicitem acesso quando necessário.
Documentação Técnica: Aqui vamos encontrar todo versionamento de scripts, dicionário de dados e análises de ferramentas/API’s.
Versionamento de scripts:
Todos os nosso scripts (que na sua maioria são de ingestão) ficam armazenados no Bitbucket com histórico de alterações e comentários da última versão.
Dicionário de dados:
Na página de dicionário de dados temos listadas todas as tabelas disponíveis no Data Lake.
E em cada tabela temos o detalhamento dos dados com o Nome do campo, tipo LGPD Warning e descrição, e em alguns casos também temos a query, que foi utilizada para criar a tabela.
Análises de ferramentas/API’s:
Aqui documentamos o nosso processo para ingestão dos dados para o Data Lake, análises de ferramentas e outras documentações técnicas.
Considerações finais:
Mais do que ter uma estrutura de dados robusta, as pessoas precisam conhecer os recursos disponíveis e utilizados.
Para que todo o processo de documentação funcione é necessário uma cultura organizacional que incentive a documentação e reforce constantemente a importância dela.
Como depoimento, posso ressaltar o quanto foi importante encontrar toda uma cultura de documentação aqui no Edify! A minha curva de aprendizado foi muito reduzida graças a toda documentação que encontrei quando cheguei.
