Muito se discute e existem várias controvérsias sobre a necessidade da documentação de sistemas. Por exemplo, em metodologias tradicionais geralmente ela é exigida. Já em metodologias ágeis essa formalidade possui pouca ênfase pois um dos valores do chamado Manifesto Ágil para Desenvolvimento de Software diz que “software funcionando vem antes de documentação abrangente”. No entanto, isso não quer dizer que documentação não seja importante mesmo em projetos ágeis.

Na verdade, acontece que muitos profissionais não veem a necessidade de desenvolver documentação tanto em alto nível (especificação de sistemas) quanto em baixo nível (relacionados ao código fonte), por exemplo. Por esse motivo, em muitas empresas a documentação dos produtos de software é comumente incompleta e desatualizada, isso quando existe.

Em situações mais críticas, ela está somente na cabeça de algumas poucas pessoas sendo elas as únicas fontes de informações. O que irá acontecer quando por ventura estes profissionais não estiverem mais na equipe?

Levando-se em consideração esse cenário, esta aversão quanto à documentação ocorre devido a alguns aspectos conhecidos, tais como:

• Dificuldade em desenvolver e manter a documentação atualizada;
• Grande volume de informações a serem gerenciadas;
• Mudanças constantes nos projetos;
• Custos operacionais e financeiros envolvidos.

Apesar dos desafios existentes, há de se convir que algum nível de registro das informações se faz necessário. Ademais, existem também bons motivos para empregar esforços nessa empreitada.

Continue lendo e conheça alguns deles a seguir.