documentação software
gestão

Importância da documentação de software

Você já deve ter pego um software com zero documentação para trabalhar, e sabe que a falta de uma documentação é muito ruim. Mas sabemos que com todo o processo de desenvolvimento (elaborar, executar e entregar), a documentação acaba ficando para depois (e nunca feita).

Infelizmente vemos diversos cenários que a documentação acaba não sendo uma prioridade. Entretanto tratar a documentação como algo secundário pode ter um custo muito alto para sua equipe. Se você quer economizar tempo e dinheiro, comece a pensar em documentar seus softwares, no inicio pode ser mais trabalhoso mas no final compensará.

Abaixo vou listar alguns motivos nos quais devemos documentar:

  1. Fonte de informação sobre o software: Quando entramos em um projeto que não possui documentação, temos que frequentemente parar o desenvolvedor ou analista de negócio para fazer perguntas que se houvesse uma documentação não haveria necessidade. Claro que mesmo com documentação haverá duvidas, porém serão coisas mais complexas.
  2. Minimiza o retrabalho: Temos dois motivos para o retrabalho, código mal escrito e falta de entendimento dos requisitos. Quando possuímos uma documentação, consequentemente os requisitos serão mais detalhados, para que todas as pessoas que leiam entendam.
  3. Diminui perca da tempo: Quando entra um desenvolvedor novo em sua equipe, a documentação será uma fonte de informação para que ele entenda como funciona o negócio e o software.

O que eu fico indignado, é que quando se disponibiliza uma API para acesso externo, as empresas se preocupam com documentação. Isso não deveria ser assim, devemos se preocupar em documentar sempre, pois um desenvolvedor que vem de fora para trabalhar em seu time, é como um cliente que irá consumir suas API’s, se não tiver bem documentado ele não irá entender como funciona seu software.

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *