Documentação de Software

Lucas de Paulo

Vanessa Novais Lycurgo

Se você já pegou um software com zero documentação para realizar alguma manutenção por exemplo, sabe como faz falta esse tipo de documentação. Mas, sabemos que no meio de todos os processos que devemos fazer como elaborar, executar e entregar o projeto, a última coisa que pensamos é a documentação, mas ele pode ser um detalhe muito importante lá na frente.

A documentação de um software realmente muitas vezes acaba não sendo uma prioridade, ainda mais que o pessoal prefere muito mais colocar a mão na prática e desenvolver códigos, do que pensar na documentação desse software. Mas, ainda que não seja prioridade, essa pode se tornar uma fonte de economia (de tempo e dinheiro) e qualidade do produto final.

Facilita em futuras evoluções

A documentação de um software serve para auxiliar programadores, facilitando o uso e entendimento do software, principalmente quando esse software precisa de evoluções. A documentação (especificação, análise e projeto) deve ser bem-feita e de fácil entendimento.

O que define uma boa documentação de software

• ·         Contextualização de problema: informa cada obstáculo durante o desenvolvimento e em que situação ele ocorreu;
• ·         Contextualização de solução: explica as modificações feitas em processos ou no código que corrigiram o problema;
• ·         Detalhes técnicos: familiarizam o responsável por aquela parte do desenvolvimento sobre como, quando e por que aquela intervenção foi realizada.
  
• Referencias: https://blog.cronapp.io/6-boas-praticas-para-documentacao-com-desenvolvimento-agil-de-softwares/