Documentação Dinâmica de Software

Requisitos, diagramas, protótipos, evidências, procedimentos, convenção de estilo de codificação e manuais, fazem parte da documentação presente no ciclo de vida de qualquer produto de software.

Esses e alguns outros artefatos produzidos durante e para o desenvolvimento de software, são gerados através de diversas ferramentas e geralmente armazenados de forma estática, em forma de documento texto ou arquivo PDF, para então serem compartilhados por e-mail ou em pasta de rede entre os membros da equipe de desenvolvimento.

Entretanto armazenar essa documentação de forma estática dificulta que a mesma seja mantida, atualizada e consultada, independente da etapa do ciclo de desenvolvimento em que o software se encontre.

Qual seria então a melhor forma de armazenar essa documentação? Simples, armazena-la de forma dinâmica, utilizando um Wiki.

Criar documentos em formato de artigos diretamente em um Wiki, faz com que a documentação se torne viva, sendo fácil de ser atualizada e consultada, permitindo que todos os membros da equipe possam colaborar na construção da documentação e se beneficiar de sua evolução, mas principalmente preservando e disseminando o conhecimento adquirido.

Os diagramas e outros tipos de artefatos que são exibidos graficamente, continuarão a serem produzidos nas ferramentas já utilizadas para essa finalidade, mas o resultado final, em formato de imagem, deverá ser incorporado ao Wiki.

Cada artigo Wiki poderá receber múltiplas tags para facilitar a organização e a pesquisa por conteúdo. Dessa forma, além de ser possível realizar pesquisas pelo conteúdo/palavras presentes na documentação, qualquer artefato será localizado facilmente através das tags.

Minha primeira experiência na utilização de Wiki para essa finalidade ocorreu em 2012, com o ScrewTurnWiki, que cumpriu sua função de forma eficaz, principalmente na facilidade de atribuir múltiplas tags aos artigos.

Devido a grande quantidade de produtos wiki disponíveis, não será difícil escolher um que se adapte as suas necessidades. Como referência, no final do artigo segue um link contendo uma comparação entre alguns produtos wiki.

Esteja você produzindo ou consumindo informação, é importante ter uma base de conhecimento que esteja acessível para sua equipe de trabalho e para sua empresa, para que seja possível ter um ambiente de trabalho mais colaborativo e sustentável. 

Quer saber quais empresas utilizam um Wiki para essa ou outra finalidade? Acesse o site do TWiki em http://twiki.org/ e veja que 50.000 pequenas empresas e muitas das 500 maiores do mundo utilizam este Wiki open source.

Referência: 

Matriz de Comparação entre Software Wiki
Disponível em: http://en.wikipedia.org/wiki/Comparison_of_wiki_software
Acesso em: 05/06/2015