[Institucional] Framework de Mentorias

endersonmenezes commented 1 month ago

DoD: Planilha + Tema + Descrição

nome
dia
ela/veio ou nao
assunto
- Framework - Treinar novos mentores.
- Controle Geral de Mentorias Realizadas
- Controle de cada mentorado

Google Drive (Banco de Dados) -> Sheets / Data -> Resumo Mensal

causticsudo commented 1 month ago

Contexto

Entrando em uma discussão mais técnica... Estive refletindo sobre a necessidade de uma API ou qualquer outro entrypoint complexo para isso. Tenho boas ideias, mas não quero usar um canhão para matar uma formiga... Portanto, vou apresentar algumas dúvidas que tenho, com o objetivo de esboçar a solução de forma simples (mas não simplista) e suficientemente manutenível para que outras pessoas possam contribuir. A ideia aqui também é compreender melhor qual é o problema e como desejamos resolvê-lo, afinal, para evitar criar uma solução que não atenda às necessidades reais ou que não seja fácil de manter. Com isso em mente, separei algumas dúvidas e ideias iniciais:

Dúvidas:

Por onde quem realizará o cadastro da mentoria deve acessar isso? Pelo site da Codaqui? Com um DNS próprio? Na nuvem? No desktop, etc...
Preciso de alguma interface gráfica?
É necessário ter algum tipo de controle para quem ingere os dados através do app?
Onde desejo emitir esse relatório? Em qual formato?
Preciso deste framework apenas para gerar métricas ou também para melhorar a qualidade de vida do fluxo de mentoria? Notificações, integrações, adaptações, controle...

Ideia maneira hipermegacomplexa:

Ter uma API, CRUD básico integrado com o Google Sheets.
É possível criar uma camada de repositório que lide com N fontes de dados, utilizando cache, banco lógico e outras soluções de planilhas em nuvem, etc. Aqui é fácil generalizar.
Ter um contêiner que funcione como um tipo de worker, escutando e disparando webhooks: notificando celular, e-mail (por exemplo: SendGrid), etc.
- Evoluir isso para uma observabilidade madura é fácil, basta emitir os eventos para uma interface genérica de APM que lida com qualquer provedor: Datadog, Prometheus, Grafana, etc.
Ter outro contêiner que também funcione como worker, desta vez lidando com jobs e agendamentos para: gerar relatórios na virada do mês e notificar canais de comunicação: Telegram, Slack, etc.; expor métricas, etc.

Vantagens da implementação:

Escalável, pode ser conectado a qualquer outra solução ou fornecer funcionalidades mais complexas.
Solução interna da organização, tende a se tornar um produto interno.
Fácil de manter, tudo em um só lugar.
Aumenta a maturidade dos processos internos.
Tende a gerar menos retrabalho no médio/longo prazo.
Pode evoluir gradualmente, começando com uma versão inicial mais simples e amadurecendo conforme a necessidade dos mentores.

Desafios da implementação:

Se hospedado em um cluster, haverá custos, mesmo que mínimos (servless, function, etc.), tanto na infraestrutura quanto no aplicativo.
Se hospedado localmente, exige esforço do usuário para cadastrar a connectionString para o Google Sheets, executar o aplicativo e depender de variáveis internas do ambiente (sistema operacional) local, por exemplo: internet, poder de processamento, etc.
O protocolo HTTP é delicado, então deve ser executado em uma rede/nuvem interna da Codaqui. No caso de um DNS público, é necessário se preocupar com DDoS e autenticação, entre outros.
Mais tempo necessário para desenvolver.

Ideia simplona

Google Apps Script gerando relatórios, provavelmente em formato de tabela (tipo datalake). Não tenho certeza sobre a parte visual, talvez seja algo mais objetivo. Ou talvez a própria planilha consiga fazer isso, bastando mudar o intervalo e aplicar a fórmula do gráfico.
Google Forms para popular o Google Sheets.
Boa e velha planilha.

Vantagens da implementação:

Menos tempo necessário para desenvolver.
Não requer frontend ou políticas restritivas complexas.
Qualquer pessoa pode realizar a manutenção.
Custo zero ou quase zero (creio que já deve estar incluído no pacote do Google).
Curva de aprendizado menor.

Desafios da implementação:

Qualquer pessoa pode realizar a manutenção 😆.
Não tende a escalar e é difícil manter um bom versionamento.
Operações mais básicas.
Altamente substituível por soluções mais genéricas, baratas ou gratuitas do mercado.
Não agrega valor a médio/longo prazo para a organização.
Grande esforço necessário para migrar para outra plataforma.

@endersonmenezes dá uma olhadinha aqui pra vê se eu tô viajando muito

endersonmenezes commented 1 month ago

Fala @causticsudo !

Acredito que você nos deu o caminho da perfeição.

Respondendo suas dúvidas

Por onde quem realizará o cadastro da mentoria deve acessar isso? Pelo site da Codaqui? Com um DNS próprio? Na nuvem? No desktop, etc...

O mentor e o mentadora vão continuar usando e-mail/calendário, acho que isso é um ponto legal que ensinamos. As mentorias podem ser realizadas via Meeting ou via Discord, conforme ambos preferirem.

Preciso de alguma interface gráfica?

Como vamos criar o processo imagino que não, eu pensei em um Sheets onde todos os mentores têm acesso e precisam colocar alguns dados de suas mentorias para que a gente que se reúne com mais frequência tenha noção do que está acontecendo, e quero voltar a termos acompanhamento de um(a) pedagogo.

É necessário ter algum tipo de controle para quem ingere os dados através do app?

Talvez no Sheets em abas, sendo a aba que tem informações confidenciais somente acessada pelo proprio mentor e o "conselho".

Onde desejo emitir esse relatório? Em qual formato?

Manualmente sendo feito buscas mesmo, conforme ficar padrão o relatório a gente coloca no nosso projeto de dados. Uma extração limpa de dados pessoais.

Preciso deste framework apenas para gerar métricas ou também para melhorar a qualidade de vida do fluxo de mentoria? Notificações, integrações, adaptações, controle... Por enquanto não, mas legal pensar nisso por que creio que vai surgir.

Será que o Google Apps Script é gratuito no plano Education?
A Ideia maneira hipermegacomplexa não se encaixaria no projeto do Tutor que estamos montando?
Como temos Desafios da implementação: o caso de Não tende a escalar e é difícil manter um bom versionamento., será que com um repositório privado, não conseguimos nos organizar?

causticsudo commented 1 week ago

Será que o Google Apps Script é gratuito no plano Education?

Deve ter algum ratelimit, mas é gratuito pra geral

A Ideia maneira hipermegacomplexa não se encaixaria no projeto do Tutor que estamos montando?

Batemos no sync, mas aqui eu acho eu não. Acho que o tutor tá num nível mais de acesso conjunto, pensei inicialmente em algo mais administrativo um worflow pra gente conseguir coletar métricas, fornecer funcionalidade pro processo em si. Mas assim, acho completamente plausível uma ferramenta plugar na outra, ou funcionarem do forma conjunta... Mas por segregação de responsabilidade, talvez faça mais sentido ser separado, pelo menos agora.

Como temos Desafios da implementação: o caso de Não tende a escalar e é difícil manter um bom versionamento., será que com um repositório privado, não conseguimos nos organizar?

Talvez isso seja uma complexidade a mais, tu garantir o versionamento "saudável" de algo que está espalhado pela plataforma do google dentro de um repo deve ser algo chatão de fazer, e com pouco ganho também. Agora, a ideia do que a gente quer fazer aqui sim, de fato conseguimos organizar no gh, dá até pra trabalha com merges reativos, que disparam functions e atualizam algum valor em algum lugar, por aí vaí (mas isso só sobre os cenários onde é feito pelo fluxo certinho, abrindo pr, aprovando, mergeando, changelog e zás).

Bom, pra gente sair do zero, eu criei uma planilha no sheets pra gente ter uma noção de informação e o que que a gente quer fazer com elas. @endersonmenezes Depois dá uma bizóiada lá e vai comentando/ajustando no que for necessário.

Quanto a PoC, fiz uma apizinha, simplona, recebendo um valor e jogando numa planilha qualquer do sheets, man molezinha. Hospedar n é um problema, tem uns raspberry em algum lugar por aqui :laughing:. Vou passar a PoC pra uma solution organizada, ou um repo e depois a gente vê onde vai deixar isso ai.

Enquanto a poc está em andamento, é tranquilão deixar uma v0 rodando no appScripts. só precisamos bater o que é necessário pra essa v0.

causticsudo commented 2 days ago

codaqui / institucional