Documentação de Software

Ediana Souza, Kelly R. Marcolino

Documentar o software faz parte do desenvolvimento do produto, mesmo em metodologias ágeis, que trazem no seu manifesto. O que tem que ser feito é avaliar e balancear o peso da importância dessa documentação.

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, ainda que não seja prioridade, essa pode se tornar uma fonte de economia (de tempo e dinheiro) e qualidade do produto final.

Neste caso, é interessante focar em mostrar os efeitos colaterais que podem acontecer caso não tenha uma documentação, o que pode gerar problemas em termos de orçamento, prazo e qualidade. No fim, documentar o software sempre é válido.

Fonte de informação sobre o software

Essa documentação serve como uma fonte de informação do software, pelo fato de conter todas as operações e informações necessárias do software, podendo conter trechos de código, diagramas, definições de requisitos, bugs, especificações do sistema, componentes, plano de testes, enfim, tudo o que julgar necessário.

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.

Às vezes pegamos um software que não tem o nível de detalhamento suficiente. No fim, se acaba perdendo tempo tentando entender o suficiente do software e em certos momentos, acabamos refazendo algo já feito, acabando em retrabalhos que poderiam ter sido evitados.

Se chega um desenvolvedor novo em uma empresa, ter o histórico de desenvolvimento é uma base para que ele possa se situar, ver o que já foi feito e evoluir a partir disso. Como a qualidade e agilidade é tão valorizada pelos clientes, essa é uma forma de evitar retrabalho e conseguir fazer mais em menos tempo. Além disso, além da evolução do software, caso seja necessário reproduzir ou realizar manutenções, esse tipo de informação vale muito para a empresa, informações essas que não podem ser perdidas, ainda mais se for em uma empresa com alta rotatividade.

Referência:

www.treinaweb.com.br/blog