Quando um novo membro se integra a uma organização, é crucial fornecer informações abrangentes, como políticas, diretrizes e um guia geral sobre como tudo funciona, independentemente da tecnologia empregada, seja informática ou em formato físico. Essas informações devem ser transparentes e facilmente acessíveis, para garantir que todos estejam alinhados quando se trata de assuntos relacionados à organização.
Porém, vale ressaltar que a existência da cultura da documentação não garante em nenhuma hipótese de que as informações sejam transmitidas, por ser necessário, além de estabelecer boas práticas de documentação, modificar a cultura organizacional, sendo esta última, a parte mais crucial deste processo.
Neste artigo, compartilharei a experiência de construir uma documentação do zero que abrange o projeto.
O que é o projeto NÓS?
Nosso Olhar Solidário (NÓS) é um projeto sem fins lucrativos que visa ajudar o próximo. Para facilitar a conexão entre quem precisa de ajuda e quem deseja ajudar, foi desenvolvido primeiramente um aplicativo móvel que permite localizar facilmente oportunidades de doação e voluntários próximos. Seja para ajudar instituições ou pessoas, o objetivo do projeto é simplificar essa conexão.
Quer saber mais sobre o projeto? Veja o artigo escrito detalhando a minha experiência dos primeiros meses dentro do projeto:
Identificando o problema
Nos primeiros meses no projeto, notei que as informações sobre o projeto estavam em sua maioria na forma mais verbal e centralizadas em certos membros, e só sanava as dúvidas em reuniões após fazer perguntas para uma pessoa mais veterano do projeto. No pior das hipóteses, não estaria presente nenhum membro veterano na reunião, que sanasse a minha dúvida, o que acaba atrasando qualquer tarefa ou atividade que poderia ser adiantado.
Ou seja, não havia quase nada escrito sobre o projeto em si, sobre seus valores, objetivos, suas políticas de férias, políticas de horas trabalhadas, e entre outros. Não só sobre o projeto em si, mas sobre o ciclo de desenvolvimento relacionadas ao meu cargo como desenvolvedor, como sobre as cerimônias, pontuações nas tarefas, cargos, e entre outros.
Tudo isso acabou me dificultando um pouco no começo, principalmente para entender as regras do projeto em geral, e como deveria agir dentro das “normas” estabelecidas. Assim, após várias perguntas e vasculhamento entre arquivos perdidos, decidi que era melhor começar a traçar sobre o problema, e identificar o que estava faltando para evitar tais dores aos futuros membros.
Esboçando soluções
Primeiramente, verifiquei quais eram os problemas que encontrava quando estava na busca das informações. E depois, pesquisei e estudei quais eram as boas práticas para construir uma redação técnica, sucinta e informativa. Com tudo isso anotado, parti para esboçar a primeira solução na qual iria propor, utilizando o Google Docs como ferramenta.
A primeira solução, que criei, tinha como objetivo, além de padronizar o formato da estrutura do documento, documentar projetos e suas variantes, utilizando algumas seções como “contexto”, “situação” e “autores”. Tais seções procuravam descrever em que contexto o projeto se encontra, em que situação e autores, a fim de permitir que futuros membros pudessem entrar em contato. Tais seções que acrescentei foram informações na qual, acreditava que, mesmo sendo pouco texto, ajudava em interpretar decisões realizadas no decorrer do andamento do projeto.
Porém, ainda não abordava um dos problemas que eu considerava bastante incômodo, que era a navegação entre os documentos e informações. Tendo em vista que todos os arquivos do Google Docs estavam armazenados em diversas pastas da ferramenta Google Drive. Isso acarretava, talvez, uma demora em buscar informações entre arquivos, e no pior das hipóteses, em não achar as informações.
Então, iniciei novamente a minha busca em encontrar outra solução, e a solução que encontrei já estava familiarizado há um tempo, e era a ferramenta Notion.
Notion é uma aplicação que fornece componentes tais como notas, bases de dados, quadros, wikis, calendários e lembretes. Os usuários podem ligar estes componentes para criar os seus próprios sistemas de gerenciamento do conhecimento, tomada de notas, gerenciamento de dados, gerenciamento de projetos, entre outros.
Em primeiro lugar, realizei uma consulta com os stakeholders ou usuários que serão afetados pela mudança, neste caso, os membros do projeto, para determinar se essa alteração seria benéfica ou não.
Assim sendo, o expus durante a cerimônia interna conhecida como “Touch semanal”, na qual todas as equipes exibem todos os feitos realizados durante a semana. E, para minha surpresa, todos aceitaram bem a ideia de criar uma base gerenciadora de conhecimentos do projeto na ferramenta Notion.
Bem-vindo, Notion
Ao analisar diversos documentos existentes, percebi que a primeira solução de padronização, utilizando o Google Docs, não se encaixava em alguns cenários, como descrever dados sobre o projeto, uma vez que essas informações não são de um projeto específico, mas sim de uma organização.
Com o Notion, decidi abandonar a padronização da estrutura dos documentos, a fim de permitir maior flexibilidade e simplicidade na busca por informações de maneira mais agradável, elegante e clara.
Adicionalmente, os problemas de navegação foram solucionados por meio da navegação lateral esquerda proporcionada pela ferramenta, o que facilitaria um panorama sobre todas as informações disponíveis em páginas maiores, servindo como categorias ou etiquetas informativos.
Outra coisa que é notável é a documentação técnica muito mais fluida, principalmente na área de programação, pois dentro do Google Docs era necessário fazer uma gambiarra para atingir o mesmo resultado na plataforma Notion. Por exemplo, para inserir um bloco de código dentro do Google Docs, era necessário utilizar um plugin ou extensão, enquanto o Notion há um bloco nativo para inserir o código e, ainda, se comportar e caracterizá-lo com a linguagem de programação da sua escolha.
Melhorando a experiência dos desenvolvedores
Agora, especificamente no time de desenvolvimento na qual faço parte, a documentação se mostrou como uma grande ajuda para os desenvolvedores, principalmente para partes mais complicadas como o back-end do projeto. Mas tudo isso depende de como é estruturado e a abordagem utilizada para construir os textos.
Acredito que, a forma na qual estruturei misturando o máximo possível de textos, ilustrações e exemplos em qualquer área na qual estava trabalhando se mostrou eficaz em transmitir as informações mais cruciais de um determinado assunto. Isso além de enriquecer as informações, permite que pessoas que aprendem mais com exemplos, consiga estar no mesmo patamar com as pessoas que aprendem mais com os textos.
Outras formas de trazer interatividade, além de ilustrações e imagens, é por meio de vídeos. Acredito eu que, vídeos melhorem a transmissão de informações por simular como seria replicar um determinado processo, porém, ainda assim, é necessária uma cautela em relação ao tamanho do vídeo, pois isso influência diretamente na disposição de qualquer um. (Ninguém quer ver um vídeo de duas horas).
Conclusão
A cultura da documentação, quando praticado e implementado de forma correta e gradual, oferece inúmeros benefícios como contextualização, transparência e compartilhamento de informações. Isso é particularmente relevante em organizações com uma alta taxa de rotatividade (como o projeto NÓS), uma vez que é crucial transmitir o conhecimento dos membros que estão deixando para os que estão entrando, a fim de assegurar que a organização permaneça na mesma direção.
No pior dos casos, quando uma equipe muda todos os membros, a equipe não se alinha com os objetivos da organização e será uma tarefa difícil e desgastante tanto para os novos membros, quanto para a organização todo, de alinhar novamente todos os conhecimentos necessários para começar a engatinhar novamente.
