Caso de Sucesso da Visionnaire é um exemplo da importância de ter, além de um Manual de Usuário, a documentação técnica de um sistema
Projetos de software devem ser bem documentados sempre, desde o início de uma empreitada. Um sistema bem registrado traz benefícios a todos os envolvidos: clientes, programadores, usuários, prestadores de manutenção etc. Enfim, qualquer pessoa que mantém ou faz uso de um software precisa de uma boa documentação para entender com facilidade e fazer o melhor uso possível desse software em questão.
Pelas leis brasileiras, a documentação técnica de um sistema não é obrigatória (apenas a documentação referente ao seu uso é mandatória). Porém, isso não quer dizer que empresas podem renunciar a ela sem sofrer consequências. E temos um Caso de Sucesso que serve como um bom exemplo disso.
A Peróxidos do Brasil já contava com o Manual de Usuário com instruções de utilização do sistema GCEF – Gestão de Carregamento, Estoque e Faturamento, porém não havia uma documentação técnica, o que dificultava sua compreensão em detalhes. Já imaginou precisar fazer manutenções em um software sem conhecê-lo a fundo? As dificuldades são imensas.
Por isso, a Visionnaire propôs uma consultoria, analisou todo o código-fonte do sistema e elaborou a respectiva documentação técnica, sempre mantendo o diálogo com a equipe técnica da Peróxidos do Brasil para alinhamento dos trabalhos.
O documento foi redigido seguindo os estudos realizados e descreve os principais fluxos do sistema e suas principais funções (métodos). Consta nele, também, um diagrama macro da arquitetura, incluindo a arquitetura de integrações com outros sistemas.
Hoje, a Peróxidos do Brasil passa a ter, além do Manual de Usuário, um documento que detalha os aspectos técnicos de uma ferramenta tão importante para os fluxos da empresa. Uma pessoa, seja programador ou administrador de sistemas, pode confiar em uma documentação detalhada para compreender com facilidade o GCEF.
Esse Caso de Sucesso da Visionnaire é um bom exemplo de que o desenvolvimento de software precisa ir além do que é obrigatório por lei. É preciso conhecer as necessidades e os benefícios de ter um projeto extensamente documentado em todas as esferas. Saiba mais sobre esse Caso de Sucesso no link abaixo.