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]
.
Guilherme Schneider
Guilherme Schneider (@guilhermebarcha) é executivo na área de consultoria e tecnologia da informação e mantém um blog pessoal.
5 respostas
Olá Guilherme boa noite eu estou fazendo um trabalho sobre a documentação de um website será que você teria um modelo de documentação para estar me enviando pois não sei por onde começar obrigado.
gostaria se possivel, ou melhor, por favor quem tiver um exemplo de como documentar um site me envie, eu agradeço desde agora. Tenho que fazer, preciso saber se há um padrão para isso. Gostaria de ter um modelo como base….valeu….
Ótima matéria.
Sou iniciante na área de web.
Concordo com a necessidade de planejamento. Desenvolver websites é como abrir uma empresa, deve-se seguir os mesmos passos para que tudo aconteça da maneira esperada.
Apesar de saber disso,confesso que preciso fazer a documentação do site que desenvolvo.
Também estudei bastante sobre planejamento, mas não estou conseguindo conciliar trabalho com a administração do site.
O site está começando a crescer e estou tendo os primeiros problemas com organização.
Mas estou melhorando.
Esse é um assunto atemporal e que precisa ser mais discutido, explorado.
Quem tiver links relevantes ao assunto, por favor, post aqui.
Ola, eu sei que esse texto é muito antigo, vai fazer três anos mais eu agradeço por manter ele no ar esse tempo todo, pois muitos como eu estão a procura de uma coisa dessas para sanar algumas dúvidas a respeito desse assunto Documentar site ou History Board assim que se diz?
bom.. eu particularmente nunca usei tal metodologia nos sites dos meus clientes, quer dizer, nunca usava, até então venho tentando montar uma metodologia de um documento muito viável para a empresa em que trabalho e assim deixando de explicar milhões, ou até trilhões de linhas aos futuros programadores ou projetistas.
Vim atrás de um texto banal mais acabei encontrando esse que me tirou algumas dúvidas existentes. Na faculdade eu sou líder de projeto e reparei agora que estava criando meus documentos erroneamente por falta de informação mais agora eis que me deparo com esse lindo e simples texto.
Guilherme Schneider muito obrigado ae pelo texto e continue assim, sei que é passado e isso foi completamente esquecido por muitos dessa comunidade, Web insider é muito loco e não percam isso jamais ..
Me da umas dicas sobre projetos e liderança pode ser? se não for pedir muito envie para meu email dessa lista de discussão, pois preciso bastante, ainda mais que tenho um projeto a apresentar em grupo e sou lider no dia 20/04 e qualquer dica é bem vinda, tais como solucionar problemas em grupo documentando o mesmo ..
Obrigado