A essência do teste: qual a importância da documentação?

O que seria dos desenvolvedores sem as documentações oficiais (libraries) das linguagens de programação? Ou sem as documentações informais de um indivíduo que, por um bom tempo, resolveu, por tentativa e erro, aprender a linguagem por si só? 

Uma boa documentação é o principal componente para nos guiar em etapas e que permite melhorar nosso entendimento em determinado assunto. Sem uma documentação tudo fica no campo do “achismo”.  

Quando falamos de registros de evidência dos processos de um sistema, a falta dela pode promover dúvidas relacionadas ao funcionamento desse processo, gerando suposições e até mesmo agendamentos de reuniões demoradas para obter informações que poderiam ser adquiridas por meio da leitura de uma boa evidenciação. 

Assim como um código aberto, o documento de um processo de melhoria ou de implementação de uma nova funcionalidade no sistema será usado por outra pessoa que, no caso, não detém o conhecimento. Codificação, teste e documentação podem e devem andar sempre de mãos dadas. 

Em média, um bom registro informativo utiliza cerca de 30% a 50% do esforço do projeto. Todavia, temos muitas vantagens originadas de uma boa documentação e, por experiência própria, posso citar algumas que foram perceptíveis no tempo que atuei e estou atuando como Tester, sendo: 

• Redução ou remoção das incertezas sobre a atividade que foi desenvolvida ou testada 
• Economia de tempo e, consequentemente, uma economia de custo 
• Boa abordagem sistemática 
• Pode ser utilizada como base para material de treinamento (interno e/ou externo) 
• Pode ser utilizada como ferramenta de Marketing e estratégia de vendas para mostrar um processo maduro e de alta qualidade nas entregas realizadas 

Portanto, é importante manter as informações sempre documentadas quando possível, por mais que haja comunicação verbal (também muito importante). 

A documentação auxiliará a empresa a longo prazo, gerando economia de forma geral, tanto em treinamentos como também na correção de problemas. 

Sendo assim, não crie documentos apenas para evitar que apontem o dedo para você. Uma boa documentação trará benefícios e uma boa abordagem sistemática em relação ao processo que está sendo evidenciado. 

Gostou deste conteúdo? Então acesse a página do Grupo DB1 e confira mais materiais gratuitos feitos para você! Clique na imagem e acesse. 

Sobre o autor

Felipe tem 24 anos, mora em Cianorte, no Paraná, e puxa o “R” caipira do interior. É formado em Análise e Desenvolvimento de Sistemas pela UNIPAR, descobriu que encontrar bugs faz parte da vida, decidiu apropriar-se desse detalhe e levá-lo como profissão desde 2016. Prova viva que é possível ser maromba e viciado em tecnologia.

Fale com o Felipe no LinkedIn!