Image for post
Image for post
Photo by Kaleidico on Unsplash

Por que a documentação em TI ainda é deixada de lado?

Anos e tecnologias evoluiram mas nossa documentação não

Danilo Ferreira
Sep 17 · 3 min read

Embora todo mundo saiba o quanto a vida foi digitalizada nos últimos anos, nem todas as pessoas entendam quantas tarefas e projetos as equipes de TI têm que executar e tirar do papel para que a tecnologia esteja cada vez mais presente, fazendo seu papel de facilitadora.

Em todos os meus anos trabalhando no mercado de TI, tenho notado um padrão. É muito fácil entrar no modo de execução e despriorizar algumas boas práticas que têm o objetivo de organizar e aumentar o sucesso das nossas tarefas — tarefas essas que impulsionam o papel da tecnologia na sociedade. Uma dessas boas práticas é a documentação, que fica despriorizada em nome da entrega.

Por que digo isso?

Porque entender como as coisas funcionam em um time é um requisito básico em qualquer empresa. Independente do modelo de gestão, ter documentos organizados que ajudam novos colaboradores a compreender quais processos e ferramentas são importantes é algo que maximiza o potencial de qualquer time.

Porém, não é só uma questão de onboarding e de curva de aprendizado. A documentação de TI é criada a partir de uma análise de negócio, ou seja, ela responde à pergunta do que precisa ser realizado pelo time de tecnologia para que os resultados da empresa sejam alcançados.

Mais além, uma documentação bem feita ajuda gestores a entender como o time pode se organizar e produzir em sua maior capacidade.

Tenho pensado muito sobre isso porque, em todos os lugares por que passei, tive experiências não muito boas com documentação. Infelizmente, nunca cheguei a trabalhar em um time com uma boa documentação que servisse como base e nos ajudasse a ter uma visão geral do setor e como ele afetava outras áreas e projetos.

Na maior parte dos lugares, a informação está sempre na cabeça de alguém que já tem experiência dentro do time. Por exemplo, alguém que esteve imerso em um time por cinco longos anos consegue entender muito bem como certas aplicações se comunicam. Mas o que acontece se essa pessoa deixa a empresa e seu conhecimento não está documentado em nenhum lugar?

Na minha visão, deixar de documentar processos não apenas reforça a dependência em certas pessoas, mas significa perda de tempo e de dinheiro.

Imagine quantas horas um time inteiro perde tentando descobrir, por exemplo, como a infraestrutura funciona — sendo que já existe alguém com a informação fresca na cabeça, que poderia ter desenhado essa explicação de maneira fácil e intuitiva.

Outro cenário: imagine colocar no papel todas as perdas causadas pela rotatividade de um time que trabalha sem documentação nenhuma. A somatória pode ser absurda.

Penso na documentação de TI como algo que todo mundo sabe ser importante — mas que poucas empresas, sejam elas grandes ou pequenas, fazem com propriedade. E isso vale para tudo: regras de negócio, arquitetura, testes de qualidade, política de segurança, tabela de IPs, códigos-fonte, scripts, informações sobre backup, hardware e outros — muitos outros.

Documentar, no final do dia, é uma vantagem competitiva, especialmente em um mercado tão acirrado quanto o de tecnologia. Ela permite um ambiente mais organizado, dinâmico, proativo e fácil de entender — por isso acredito que investir nessa ação traz inúmeras vantagens não apenas à TI, mas à empresa como um todo. Facilita o onboard de novos funcionários, diminui o risco nos eventuais turnovers. Mas mais que isso, no final se temos um processo de negócio minimamente documentado, um desenho de arquitetura minimamente estruturado, um desenho de como o ecossistema das aplicações se relaciona, qual máquina, qual porta, qual dado em qual endereço, o quão mais rápido vamos resolver um bug ou implantar uma feature nova?

Assim, mesmo que seu time de TI esteja focado na execução e na entrega de resultados, é recomendável pensar em alternativas que possibilitem a documentação. Contratar alguém específico para desenhar e documentar pode ser uma escolha, assim como separar um momento do time — dentro ou fora da sprint — para que todos colaborem e compartilhem conhecimento. Novamente, nesse tema tenho mais perguntas do que respostas.

Qual é a sua experiência com esse tema? Seu time tem tempo de montar e manter a documentação atualizada? Me conta aqui nos comentários.

Originally published at https://www.linkedin.com.

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store