Ouvindo Opiniões

A documentação de um projeto é um artefato de muita importância no desenvolvimento de um software. Seja a documentação hardcore (para o desenvolvedor), seja a documentação para o usuário final, ela deve estar inserida no contexto do desenvolvimento, fazendo parte de todo o processo.

Considero uma boa documentação tão importante quanto a análise, o projeto, a implementação, os testes unitários e os testes de integração contínua. Infelizmente, o que vemos por aí, é que muitas empresas brasileiras não dão tanta importância à documentação ou deixam essa tarefa para um segundo momento acarretando em uma documentação pobre e muitas vezes desalinhada com a funcionalidade do sistema.

Temos hoje em dia muitas ferramentas que podem mecanizar essa árdua tarefa, podendo gerar desde help's de sistema até manuais em formato de impressão e isso tudo integrado ao IDE. Meu "voto" é para a manutenção contínua da documentação e liberação das atualizações junto com os releases dos sistemas.