Hospedagem Profissional

Hospedagem Profissional
Clique aqui e ganhe US$ 10,00 para testar durante 1 mês a melhor hospedagem: Digital Ocean!

sexta-feira, 27 de maio de 2011

Documentando projetos com ferramentas Wiki

 

Você provavelmente já ouviu falar na Wikipedia. Seu sucesso se deve às suas características: é uma enciclopédia gratuita e qualquer pessoa pode contribuir com novos verbetes ou com revisões de artigos existentes. A Wikipedia é executada em uma ferramenta chamadaWikiMedia, que é um software que gerencia e executa um site Wiki.

E quando ouvimos falar em colaboração, lembramos que mais e mais empresas estão investindo na colaboratividade, devido à descentralização de seus parques e empregados e às demandas por maior agilidade e produtividade. Ferramentas como MSN, Skype, programas de vídeo-conferência, etc. são cada vez mais utilizados para aumentar a comunicação e a colaboração entre empregados, departamentos e clientes.

Empresas de desenvolvimento de software não são diferentes. Desenvolvedores precisam cumprir prazos apertados, representante comerciais precisam aprovar requisitos e contratos com clientes remotamente distantes, empregados do suporte precisam realizar atendimentos remotamente, etc.

Da mesma forma diretores, gerentes, analistas e desenvolvedores precisam se comunicar com agilidade e colaborativamente sobre um determinado projeto. Porém não é o que ainda vemos na prática, mesmo com ferramentas wiki sendo disponilizadas desde o começo dos anos 2000.

A realidade da documentação de um projeto em grande parte das empresas de software é a utilização de diretórios ou repositórios onde são colocados todos os arquivos relacionados ao projeto. Quando bem organizadas, elas possuem uma rotina de backup para o repositório e promovem algum tipo de controle de versão no repositório.

Acredito que um site wiki tem grande potencial para documentar projetos de software (ou qualquer outro projeto), inclusive com potencial para substituir por completo as intranets das empresas. Dentre as vantagens de um site wiki como ferramenta para documentar software, posso enumerar:

  • a documentação fica online, garantindo sua disponibilidade para várias pessoas, além de permitir o acesso remoto aos funcionários envolvidos no projeto, desde que adequadamente configuradas as restrições de acesso
  • na maioria das ferramentas wiki disponíveis atualmente, suas páginas são escritas e formatadas da mesma maneira que nos editores de texto comuns
  • os sites Wiki possuem um mecanismo de referência bastante poderoso, que garante que páginas sejam “linkadas” a outras rapidamente
  • uma documentação de software baseada num site Wiki evolui gradativa e organicamente, seguindo as etapas do desenvolvimento do software
  • os sites Wiki permitem a edição e revisão de suas páginas colaborativa e concorrentemente por vários usuários
  • controlam as versões de cada página automaticamente e permitem o gerenciamento das versões, podendo voltar uma determinada versão ou mesmo compará-la com outras
  • promovem a convergência e a consistência de termos e idéias

Referências (em inglês):

Fonte: Desenvolvendo Idéias