Documentação não é instrumento de conformidade
Documentação é uma coisa ótima. Projetos bem documentados são excelentes para se trabalhar, mais prazerosos, se gasta menos tempo em exploração e mais tempo produzindo algo útil.
O universo de ferramentas do Unix é um bom exemplo. A documentação extensiva da grande maioria de frameworks web que surgiram nos últimos anos — seja formal ou informal — também.
Mas documentação é, e deve ser, um instrumento de instrução, uma via para se compartilhar informações, conhecimento. Entretanto, é inacreditavelmente grande o número de projetos, e principalmente gestores, que acreditam e usam documentação como artefato de conformidade.
Você já viu isso em algum lugar, pode ter certeza. Um projeto de desenvolvimento onde se gasta muito esforço para se gerar uma documentação extensiva antes de se iniciar o desenvolvimento. E uma vez iniciado o processo de construção desse software pré-concebido, a documentação passa a ser a referência para o controle do projeto.
Qualquer um que já tenha gasto mais de cinco minutos lendo o manifesto ágil e mais um artigo qualquer (que seja bom, pelo menos) sobre o assunto sabe aonde eu quero chegar. Documentação não serve como instrumento de controle e acompanhamento de um processo de desenvolvimento de software.
Manter toda a documentação de um projeto enquanto se desenvolve toma tempo e é um esforço muitas vezes em vão, já que o projeto é — até seu encerramento — algo vivo. E se a documentação é o meu instrumento de acompanhamento e está fora de sintonia com o desenvolvimento propriamente dito, temos um problema grave.
Além disso, é algo estrangeiro ao trabalho de codificação, salvo testes unitários (se é que podem ser considerados documentação). Envolve fazer o desenvolvedor sair do seu fluxo normal de trabalho para elaborar algo que ele mesmo vai mudar um pouco mais para frente.
O próprio software seria o melhor instrumento.
Convencer gestores acostumados com o falho modelo tradicional, entretanto, é bem mais complexo e exaustivo do que escrever um texto curto de algo que você, caro leitor, já deve saber a muito tempo.
Feed com os comentários desse post.
