Warning: fopen(logs/log_ouvindo_opinioes.txt) [function.fopen]: failed to open stream: No such file or directory in /home/storage/6/a1/fc/edudelphipage/public_html/includes/edp_log.php on line 6

Warning: fwrite(): supplied argument is not a valid stream resource in /home/storage/6/a1/fc/edudelphipage/public_html/includes/edp_log.php on line 8

Warning: fclose(): supplied argument is not a valid stream resource in /home/storage/6/a1/fc/edudelphipage/public_html/includes/edp_log.php on line 9
 EduDelphiPage - Ouvindo Opiniões | Documentação de sistema x Prazo de entrega

Ouvindo Opiniões

Documentação de sistema x Prazo de entrega

Opinião escrita por Eduardo Rocha

Sobre o autor: Bacharel em Sistemas de Informação e desenvolvedor Delphi desde 1999. É Coordenador editorial da Revista ActiveDelphi, criador e mantenedor do site EduDelphiPage e membro do grupo DUG-BR. Já ministrou cursos e palestras de ClientDataSet/DBExpress, Firebird e Reconhecimento de Impressão Digital com Delphi para mais de 1000 pessoas (FDD e DDD).

Contato: eduardo@edudelphipage.com.br

Documentação de sistema é um assunto que pode abranger muitos aspectos, tais como: análise de requisitos, diagramas de estados, fluxogramas, modelagem de dados, contratos, manuais, e o que é o nosso foco principal, a documentação do "funcionamento" do sistema.

Confesso que hoje eu não documento muito os sistemas que desenvolvo, justamente pelo pouco tempo que sobra e a urgência dos clientes, porém sei perfeitamente que este tempo economizado agora será gasto em dobro (ou mais) em futuras manutenções, por isso sou extremamente a favor de documentar sistemas e estou cada vez mais me policiando pra colocar isso em prática sempre.

Talvez os extremos das coisas não dê muito certo, ou seja, não documentar nada ou documentar muito (detalhes mínimos), pois imagine você a todo instante fazendo pequenas modificações e sempre documentando, quanto tempo você não gastaria?

Acho fundamental pelo menos ter uma boa documentação da modelagem de dados, isso sim é extremamente importante estar 100% atualizado para não termos que ficar olhando para o banco fisicamente pra descobrir as tabelas que existem, relacionamentos, campos, etc. Outras documentações que não tenho muito know-how (e gostaria muito de ganhar mais experiência e colocar em prática) são aquelas que explicam o funcionamento dos principais processos do sistema, pois com estes documentos + a modelagem da pra entender como funciona o sistema sem perder tempo em ficar analisando códigos e isso também facilitará futuras manutenções, já que ajudará a identificar os impactos de determinadas modificações no sistema.

Resumindo, acho que não devemos poupar esforços para estes tipos de documentos básicos, pois além de você poder usar como forma de profissionalismo perante o cliente, ajudará aos desenvolvedores em futuras manutenções.

Comentários

Nenhum comentário foi feito ainda
 

"Ouvindo" Opiniões (as mais lidas)

Em breve, aguarde!!!

Pharetra Sed Tempus

Morbi sit amet mauris Nam vitae nibh eu sapien dictum pharetra. Vestibulum elementum neque vel lacus. Lorem ipsum dolor sit dolore phasellus pede lorem proin auctor dolor loremmassa phasellus sit. More…

Outras edições da Revista Active Delphi