(10 Tips For A Successful Wiki, do blog Brain of James)

1 -Crie um checklist para suas necessidades de documentação.
Como qualquer ferramenta, avalie no sistema existente o que deixa o grupo insatisfeito. Quais as áreas óbvias para melhoria de seu sistema de documentação? Gere uma lista de critérios que criaria a ferramenta perfeita para edição, armazenamento, acesso e busca de documentação de projeto.

2 -Escolha o wiki certo.
Há dezenas de wikis diferentes, de modelos de busca aberta livre a pacotes de empresa comercial. Use a sua lista de critérios para buscar opções viáveis e avaliar cada uma para ver como ela se encaixa ao seu time. Seu grupo precisa hospedar dezenas de milhares de páginas ou centenas de milhares? Quantos usuários acessarão simultaneamente? O servidor será local ou remoto? Todos esses fatores afetarão a velocidade na qual os usuários trabalharão. E mais rápido é sempre melhor. Wikimatrix é uma excelente ferramenta de comparação.

3 -Invista em seu wiki.
Nada é perfeito fora da estante e com seu wiki não será diferente. Muitos pacotes de wiki são desenhados para serem customizados e expandidos, então pesquise por alguns dias e modifique-os de acordo com suas necessidades. Algumas horas ou dias gastos retornarão multiplicados por dez em tempo economizado pelos usuários.

4 -Crie links para arquivos externos somente quando necessário.
Muitos novos usuários do wiki criarão uma página e disponibilizarão apenas links para arquivos .doc ou .txt. armazenados no sistema de controle da fonte. Certifique-se de que os usuários estão conscientes de que documentação de textos e imagem é melhor armazenado no wiki, então aquele conteúdo pode ser facilmente localizado por estranhos. Links para planilhas com fórmulas complexas são inevitáveis, então documente o propósito do arquivo e quaisquer notas sobre ele na página principal do wiki como atalho.

5 – Crie uma estrutura
Enquanto o Wikipédia pode parecer anárquico, ele tem uma estrutura bem definida que é moderada por milhares de voluntários. Seu wiki precisará da sua própria estrutura, baseada em suas necessidades identificadas na dica 1. Assegure-se de que na primeira página os usuários possam visualizar as informações mais pertinentes. Wikis frequentemente suportam uma variedade de estruturas, incluindo hierarquias, que são mais fáceis de seguir para documentos relativos a um único projeto. Usuários constroem hábitos rapidamente; com uma estrutura bem definida, as melhores práticas serão desenvolvidas organicamente. Wikipatterns tem feito um bom trabalho nesta área.

6- Dê a cada projeto um nome ou uma área.
Quando armazenar documentos de múltiplos projetos (ou departamentos) no mesmo wiki, use a funcionalidade do “namespace” para delinear claramente a área de cada. Isto tornará mais fácil fazer pesquisas e escolher entre múltiplos projetos futuros mais efetivamente. Enquanto muitos wikis suportam “namespaces”, alguns também tem áreas de projeto com as páginas relevantes para o grupo.

7 – Faça-o publicável.
Dependendo do seu modelo de projeto/editor/estúdio, provavelmente você terá de publicar documentação para revisão externa. Com um pouco de planejamento, um documentos com um design mais tradicional pode ser automaticamente gerado do wiki. Identifique as páginas que contém a informação crucial para sua audência e assinale-os com um aviso padrão (“Página para revisão externa!”). Os membros do grupo saberão manter aquelas páginas atualizadas e limpar notas grosseiras. Use a transclusão de págína para gerar uma única página contendo toda a documentação do design principal e exporte-a em PDF ou em formato similar.

8 -Treine usuários em estágios.
Comece com um tutorial de 5 minutos sobre como criar uma conta, encontrar uma página e editar uma página. Isto permitirá aos usuários tornarem-se familiares com o uso do wiki para encontrar a informação que eles querem e ajudá-los a começar a contribuir. Introduza as páginas de discussão/conversa (se seu grupo decidiu usá-los) e então avance para outros aspectos, como histórico e revisões. A barreira para entrar num wiki é marcadamente mais baixa, e com apenas uma conta e edição básica, os usuários podem contribuir com o projeto. O treinamento em estágios torna isso simples para os usuários crescerem nos vários aspectos do wiki enquanto contribuem.

9 – Use caracteres e buscas
Uma boa estrutura faz com que buscar uma página torne-se algo fácil, mas um grande número de páginas pode ainda levar tempo para fazer buscas. Boa pesquisa poupa-nos uma grande quantidade de tempo; usando páginas com caracteres faz com que elas fiquem mais flexíveis com a sua estrutura. Um designer pode caracterizar uma página com termos relevantes, como “design”, “sistema” e “combate”. Isso permite ao usuário filtrar conteúdos para caracteres, ajudando-os a encontrar as páginas que eles estão procurando mais rapidamente.

10 -Implemente RSS e outros sistemas de alerta.
Muitos wikis suportam RSS e outras notificações por atualização de página que transmitem avisos quando mudanças são feitas. Estes alertas são como um estalo para informar os usuários quando uma atividade importante para eles acontece. Um alerta de e-mail assinado para as páginas para publicação externa mantém o designer e o produtor a par de quaisquer mudanças de informação regularmente difundidas fora do grupo. Membros do grupo cadastrados num nível particular sabem quando o design é atualizado, programadores podem facilmente localizar atualizações.

Wanderlucy Czeszak

Share/Save