Ouvindo Opiniões

Este dilema das documentações nos sistemas de TI coloca frente a frente duas perspectivas de gerenciamento, os que defendem uma documentação exagerada e os que a julgam desnecessária. Independente da intensidade que estas posições são defendidas acredito que seja maior a parcela dos profissionais que reconhecem a necessidade de documentações apropriadas e atualizadas.

Nunca é demais lembrar, que em se tratando de documentação temos, a meu ver, dois pólos bem definidos. A documentação focada no desenvolvimento da aplicação e a documentação focada na utilização da aplicação. Estes dois tipos de documentos possuem cada um suas peculiaridades, visto que atendem públicos diferentes, com interesses distintos.

A documentação focada no usuário final deve considerar dois aspectos básicos: um deles é o que se refere à usabilidade da aplicação, sendo assim deve ser de fácil entendimento, objetiva e precisa. O outro aspecto está relacionado à precisão desta documentação, pois todos sabemos que softwares são dinâmicos, e suas atualizações constantes, portanto se for alterada uma rotina, um procedimento ou uma tela e deixarmos de atualizar a documentação do usuário final, a documentação perde sua precisão. Certamente teremos impacto no ambiente corporativo por conta disso. A questão que lidamos nesta situação é a necessidade de avaliarmos o impacto de tal atitude, calculando o stress que pode ser gerado em decorrência da não atualização da documentação. Vale lembrar que não existe uma fórmula mágica para esse cálculo, tudo isso depende de caso a caso, de software a software, até mesmo de rotinas específicas dentro de uma mesma aplicação.

Por outro lado, a documentação focada no desenvolvimento deve levar em consideração toda a cadeia de produção de softwares, e nesse sentido, além de produzir a documentação surge a necessidade de gerir este material todo. Sim, porque de nada adianta a um Analista ou Desenvolvedor, saber que existe dentro do projeto uma boa documentação e não ter acesso a ela. Parece meio estranho afirmar isso, porém não é nada incomum acontecer este tipo de situação, principalmente quando em projetos de escopo amplo e que a documentação encontra-se espalhada em inúmeros locais diferentes.

As documentações sem dúvida precisam ser aderentes a cada etapa do desenvolvimento. Do levantamento de requisitos, passando pela Análise, Desenvolvimento, Testes e Uso da aplicação. Mas certamente se um dia fizerem a pergunta derradeira "Desenvolvo ou documento?", devido as minhas origens do mundo técnico eu responderia sem pestanejar - "Desenvolve"!