Desenvolver sem documentar é muito arriscado
15/07/2004 0:00Por:
Durante o processo de construção de um site, a tarefa de montar uma documentação completa do início ao fim é raramente atendida. No entanto o registro pode salvar um projeto.
Já falamos aqui sobre a função essencial do planejamento no processo de desenvolvimento de sites (veja ao lado).
Agora vamos falar sobre a necessidade de documentação, aspecto geralmente esquecido pelos desenvolvedores..
Apesar de muitas empresas e até mesmo gerentes e líderes de projeto desprezarem esta etapa, a documentação é cada vez mais importante e deve acompanhar todo o processo. O responsável por essa atividade, que deve iniciar no briefing e prosseguir até o final do projeto, é justamente o líder ou gerente do projeto. Devem ser documentadas mesmo as informações que pareçam irrelevantes.
Devem constar da documentação de um projeto o briefing do projeto, a equipe do projeto e suas atribuições, os wireframes do website, a documentação de conformidade técnica, TODA e qualquer solicitação que o cliente faça (eduque o cliente a sempre mandar suas solicitações por e–mail, pois isto é prova documental) e, por final, a documentação dos testes realizados.
Alguns documentos podem melhorar bastante a resolução de problemas que costumam ocorrer durante o processo:
Documentação de incidentes: o gerente de cada projeto tem uma planilha onde anota problemas que podem surgir durante o processo de criação do site, com as devidas datas. Exemplos: um designer do projeto adoeceu e por isso o resultado final atrasou três dias; o servidor de testes ficou fora do ar por problemas técnicos por oito horas.
Este documento não é mostrado ao cliente, a não ser quando há problemas causados pelo próprio cliente. Exemplo: o cliente prometeu fotos e textos para uma determinada data e não as entregou. Esse tipo de documentação é importante para justificar eventuais atrasos na entrega de um site.
Documentação de conformidade técnica: o líder do projeto (ou preferencialmente um analista de sistemas) levanta todas as necessidades que norteiam os sistemas de um site e faz um documento onde detalhadamente descreve desde as tecnologias que serão utilizadas (e porque foram escolhidas), até a modelagem dos bancos de dados e o fluxograma do sistema. Bem como qualquer outra funcionalidade ou particularidade especial dos sistemas do site.
Documentação de testes: os testes de usabilidade do site (se ocorrerem) e os testes dos sistemas devem ser bem documentados. Se a equipe não contar com um testador de usabilidade ou de sistemas, é recomendável que terceirize esta parte. Por mais banal que possa parecer a princípio, é muito importante e não deixa de ser mais uma validação da qualidade do website desenvolvido. Como muitos programadores costumam dizer, quem desenvolve não é a pessoa mais apropriada para testar, pois instintivamente ela sabe onde estão os furos, e passa batido por eles. Mas vale lembrar que um bom analista de sistemas também está capacitado para fazer estes testes.
Uma boa prática é evitar papéis. Então, ao final do projeto, transforme todos os documentos do projeto em PDFs e grave um CD para cada projeto. Deixe isso guardado pelo tempo que julgar importante. Vale lembrar que essa documentação é um registro importante, para acompanhar a evolução de metodologias e até mesmo da equipe. Quaisquer dúvidas, podem me contatar. [Webinsider]
.