16:47
Elaine Cristina Cordeiro
Existem diversas formas, recursos e ferramentas que auxiliam no momento de documentar, o que nos deixa indecisos no que escolher e o que é relevante documentar.
Algumas pessoas consideram documentar um procedimento correto para qualquer alteração no sistema, já outras pessoas acreditam que possa ser perda de tempo que ninguém irá precisar disso depois e que somente fazem algum tipo de documentação quando são obrigadas.
Eu particularmente já vi documentação de difícil compreensão, detalhada demais, com insuficiência de informações ou ainda nenhuma documentação!
Em minha opinião, devemos sim documentar, iremos perder um tempo agora, mas ganharemos depois. A seguir cito duas grandes vantagens:
1- Proporciona um melhor entendimento por parte do cliente, podendo ele entender exatamente o que foi feito e os procedimentos de instalação se houver, sem precisar entrar em contato com a empresa para questionar sobre o que foi alterado. Isto gera confiança na empresa por parte do cliente;
2- Internamente, outra pessoa que não fez parte do processo de desenvolvimento, consegue com mais facilidade entender o que foi feito, sem precisar abrir códigos, questionar quem desenvolveu (que pode não estar na empresa naquele momento).
Com isso a empresa ganha e os funcionários também, por não depender de determinadas pessoas chaves, qualquer um pode entender claramente como determinado software ou processo funciona.
Com isso a empresa ganha e os funcionários também, por não depender de determinadas pessoas chaves, qualquer um pode entender claramente como determinado software ou processo funciona.
Independente da metodologia, tecnologia ou ferramenta utilizada para documentar, documente.
Um simples texto no Word, uma simples planilha no Excel pode ser uma documentação do projeto!
Até mesmo comentários dentro de um código fonte pode ser uma forma de descrever a lógica que foi aplicada, para mais detalhes deste tópico visualizar: http://elainecristinacordeiro.blogspot.com.br/2012/01/comentarios-em-fontes.html
Mas não basta apenas documentar, lembre-se de deixar a documentação acessível para todas as pessoas envolvidas.
Um simples texto no Word, uma simples planilha no Excel pode ser uma documentação do projeto!
Até mesmo comentários dentro de um código fonte pode ser uma forma de descrever a lógica que foi aplicada, para mais detalhes deste tópico visualizar: http://elainecristinacordeiro.blogspot.com.br/2012/01/comentarios-em-fontes.html
Mas não basta apenas documentar, lembre-se de deixar a documentação acessível para todas as pessoas envolvidas.
2 comentários:
Muito interessante seu Texto!
Documentar é realmente importante, em qualquer caso. Mas documentar somente o necessário, sem burocracia e com uma linguagem fácil de entender.
Mas o que acho ainda mais importante(e mais difícil) é de deixar esta documentação atualizada. Eu já tive a experiência em um projeto, onde no desenvolvimento, todas as regras de negócios e demais informações importantes foram documentadas, porém não houve a preocupação em atualizar esta documentação no decorrer das customizações. Neste caso 6 meses após o projeto a documentação já não trazia confiança e ninguém a usava como parâmetro para qualquer decisão, tornando-a obsoleta.
Jonas Vieira
http://jonasvpereira.blogspot.com/
@jonasvpereira
Show, internamente usamos a ferramenta TFS da Microsoft, além de fontes, abertura de chamados via Story e tantas outras coisas possivéis dentro desta, o que mais enche os olhos é a criçao da documentaçao destes desenvolvimentos, pois é possivel otimizar a ferramenta para criação de relátorios e desta forma, além da padronizaçao do desenvolvimento, também oferecer um documento simples, claro e objetivo do processo. Obrigado por compartilhar.
Postar um comentário