By Dilmar-amador on 23rd agosto
Acredito que muitos de nós que trabalhos no desenvolvimento de sistemas, por muitas vezes nos deparamos com situações onde não existe qualquer tipo de documentação a respeito de um determinado sistema. Penso que essa situação seja mais costumas do que se possa imaginar.

Sempre ouço o seguinte: gastar tempo e dinheiro com documentação é jogar dinheiro fora. Será? Eu penso que não. O maior problema é que muitas empresas tem processos de desenvolvimento muito morosos e possuem documentação em demasia ou mesmo a falta (para não dizer inexistência). O processo de desenvolvimento de software, assim como qualquer outro processo tem que ser continuamente evoluído. Como saber que algumas atividades que estão sendo executadas não necessárias? Bem, a resposta é simples, mas raramente se vê colocá-la em prática: pergunte as pessoas que participam do processo o que pode ser feito para melhorar o processo.

Muitas empresas se preocupam em criar processos complexos, com documentações, sejam a documentação de negócio ou técnica, e esquecem em perguntar as pessoas que utilizam aquilo no dia a dia o que elas acham. Se algo é útil ou não ou mesmo o que poderia ser melhorado. Ouvir sempre foi uma prática chave para o sucesso e nesse aspecto não é diferente.

Existe um nível de documentação mínimo? Puxa, a resposta dessa pergunta, com certeza, vale alguns milhões de dólares. Mas vou expressar aqui alguns cases que vivi e que acho que podem ser um ponto de partida para se chegar próximo dessa resposta, ou seja, um nível ótimo.

Acho que existem três documentos que na minha visão seriam o alicerce do projeto: especificação funcional, diagrama de sequência em nível físico e modelo de dados. A especificação funcional tem por função mapear os fluxos dos casos de uso e as regras de negócio e subsidiar a construção dos testes funcionais. O diagrama de sequência em nível físico é criado pelo arquiteto do projeto de forma que os desenvolvedores possam realizar os casos de uso seguindo a arquitetura do projeto. Por final o modelo de dados que contém a definição do modelo físico de dados.

Algumas pessoas poderiam dizer que ainda é necessário documentação para testes, visão, gerenciamento do projeto, enfim, a media que a organização se torna mais madura no desenvolvimento de software, entendo que mais artefatos vão ser necessários. Obviamente, cada projeto tem uma particularidade específica. Quanto maior o nível de formalidade, mais documentação será produzida. O ponto importante é produzir a documentação necessária para o projeto, documentação que será útil no desenvolvimento e principalmente para manter o sistema após sua implantação em produção.

Não existe uma fórmula mágica, algo que se aplica em todas as corporações. Cada corporação tem que identificar suas necessidades e qual documentação é necessária ao seu processo de desenvolvimento. Se optar por não documentar nada, assumir o riscos disso quando as pessoas que tem conhecimento do negócio e/ou técnico não mais estiverem na empresa.

There are no comments yet.

Leave a Comment

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