Construindo uma cultura de documentação no Itaú Unibanco
Por Gisele Rosati Lourenço e Fernanda Barros Pimenta Preda, Tech Writers e Doc Advocates da Tecnologia do Itaú Unibanco, em parceria com Daniel Barros Oliveira
Tornar a documentação parte da cultura das pessoas envolvidas no processo de desenvolvimento é uma etapa essencial para que a colaboração e o reuso de aplicações aconteça na prática.
No entanto, fazer com que ela faça parte do dia a dia de pessoas desenvolvedoras pode parecer uma missão impossível, não é mesmo? Neste artigo, vamos te mostrar que não é — e também te contar algumas das ações que desenvolvemos aqui no Itaú Unibanco que têm garantido resultados positivos!
No ano passado, ficou clara a necessidade de falarmos mais sobre a importância da documentação no processo de desenvolvimento.
Em uma pesquisa que rodamos para entender melhor como acontecia a documentação nos times, entendemos que a vontade de documentar estava lá e que o valor da documentação já era reconhecido. Faltava só um empurrãozinho: aquele apoio e direcionamento de tech writers para que os times pudessem criar seus próprios fluxos de documentação e começar o processo.
Felizmente, o Itaú Unibanco é uma das empresas brasileiras pioneiras em ter uma estrutura de Developer Relations. O nosso time conta com pessoas dedicadas a atuar a favor de profissionais de desenvolvimento, visando facilitar suas jornadas e viabilizar a inovação tecnológica em suas comunidades e no banco. Ou seja, não havia um time mais bem posicionado do que esse para dar o pontapé inicial para essa jornada.
O nosso primeiro passo foi a estruturação de um time de tech writers, que chamamos de Doc Advocacy: uma equipe que tem objetivo de oferecer apoio na construção de documentações — sejam elas robustas ou ainda em estágio inicial.
A sua primeira entrega foi a criação de um template de documentação técnica, o Tech Doc, que serve de base para que os times possam organizar seu conteúdo e incluir a etapa de documentação no processo de desenvolvimento de uma forma mais próxima do código, trazendo o engajamento para a documentação.
A partir daí, embarcarmos com tudo em uma jornada para mudar o pensamento sobre documentação no Itaú. E para encararmos essa missão, definimos algumas alavancas.
1 — Formação de profissionais e documentação em escala
Para ganharmos escala, decidimos formar Doc Advocates. Com um maior número de profissionais com foco em documentação, conseguimos incentivar a cultura dentro da organização, além de defender, incentivar e colaborar para que os projetos sejam bem escritos e estruturados.
Com base na participação dessas pessoas, conseguimos reforçar a importância do papel de tech writers dentro dos times, e encorajamos a contratação de profissionais que possam atuar diretamente na documentação de forma ativa, cuidando também do seu ciclo de vida.
2 — Novas ferramentas para facilitar a vida de devs
Quando falamos com os times, a primeira dúvida que ouvimos é sobre onde criar uma documentação. Já quando falamos com pessoas que consomem essas informações, a pergunta costuma ser por onde começar a consultar uma documentação.
O template de documentação tem a função de eliminar essas duas dores. A ideia é deixar a documentação padronizada, acessível e eliminar tempos de discussões sobre os melhores formatos e modelos, por exemplo.
3 — Ponto de partida definido e apoio em toda a jornada
Elaboramos um guia de estilo e um manual de boas práticas para ajudar na construção da documentação. Então, mesmo quem não tem familiaridade com a redação técnica consegue ter uma direção sobre onde e como começar.
Também apoiamos os times através de mentorias na criação e evolução de documentações, ajudando na estruturação e identificação de pontos de melhorias.
4 — Incentivo à mão na massa (ou melhor, mão no texto!)
Promovemos hackathons para a contribuição no desenvolvimento de features e na contribuição em documentações.
Em breve, também queremos testar um modelo de Hack Day exclusivo para documentação, para que as pessoas passem um tempo imersas na criação, atualização e revisão das docs, de uma forma colaborativa e com total apoio de Doc Advocates e tech writers experientes.
No final dessa jornada, entendemos que a documentação precisa entrar na vida das pessoas desenvolvedoras — e para que isso aconteça, ela precisa fazer sentido em sua cultura e rotina. Por isso, quando pensamos em estratégias e ações para que ela aconteça, o foco deve ser esse. Não é simples, mas é totalmente possível!
