A importância da boa documentação de software

Documentação de Software

/* Quando falamos da importância da boa documentação de software, em projetos desta natureza, a imagem acima é talvez a melhor ilustração. É uma imagem “batida”, mas é sempre bom revisitá-la. */

Em projetos de software, quando ha especificação antes da construção, é muito comum o nível da documentação não estar bom, e isso gerar efeitos muito ruins no projeto.

Alguns profissionais entendem que documentação de software (especificação, análise e projeto) é algo apenas para “encher linguiça”, outros fazem com entusiasmo mas esbarram nas “travas culturais” da equipe ou do cliente.

Mas fato é: se for fazer, tem que fazer bem feito. Do contrário, não gera nenhum benefício, apenas prejuízos (não há neutralidade neste contexto).

E muitas das vezes é o cliente, interno ou externo, quem produz parte desta documentação. E em alguns casos, este cliente entrega um material que deixa a desejar, e depois quando o problema estoura passa a responsabilidade para que “aceitou” tal documentação e construiu algo errado.

Neste vídeo há uma breve reflexão sobre a importância de se ter uma boa documentação no projeto de software, e como lidar com isso perante o cliente. É um trecho de um Hangout que fizemos com nossos alunos do curso Engenharia de Requisitos na Real.

Todavia, é uma reflexão fundamental para os profissionais da área da nossa área!

Deixe comentários, sugestões, críticas, curtidas etc.! :) Vamos debater!

Engenharia de Software