Fazendo com que os desenvolvedores usem um wiki [fechado]

Question

Eu trabalho em um aplicativo complexo onde diferentes equipes trabalham em seus próprios módulos com certo grau de sobreposição.Há algum tempo, configuramos uma instância do Mediawiki, em parte por solicitação minha.É difícil fazer com que as pessoas realmente o usem, quanto mais contribuam.

Posso ver muitos benefícios em compartilhar informações.Pode pelo menos reduzir o tempo em que reinventamos a roda.

O wiki não é muito estruturado, mas não tenho certeza se isso é um problema, desde que você possa pesquisar o que precisa.

Alguma dica?

Answer 1

Como mencionei antes, um Wiki é muito desorganizado.

No entanto, se esse for o único argumento de seus desenvolvedores, invista algum esforço para criar uma página de índice simples e mantê-la atualizada (faça você mesmo ou peça às pessoas que vinculem suas contribuições ao índice).Dessa forma, o Wiki pode se transformar em uma coleção de documentação muito boa e bastante abrangente para todo o seu trabalho.

Answer 2

Algumas dicas:

Sempre que alguém enviar por e-mail informações que realmente deveriam estar em um wiki, crie uma página para esse tópico e adicione o que colocou no e-mail.Em seguida, responda "Obrigado por essa informação, coloquei-a aqui no wiki para que seja mais fácil encontrá-la no futuro."

Da mesma forma, se você tiver informações que precisa compartilhar e que deveriam estar no wiki, coloque-as lá e apenas envie um e-mail com um link para elas, em vez de enviar e-mails para as pessoas.

Quando você pedir informações às pessoas, expresse-as de forma que colocar tal documentação no wiki seja considerado o padrão:"Pesquisei no wiki, mas não consegui encontrar.Você já colocou essa informação aí?"

Se você é o "campeão do wiki", certifique-se de que outras pessoas saibam como usá-lo, por exemplo."Já aprendi como criar uma nova página com você?"

Edite a barra lateral para garantir que seja relevante para o seu trabalho.

Use modelos de estilo "caixa de navegação" em páginas relacionadas para facilitar a navegação.

Coloque algo como {{Special:NewPages/5}} na primeira página, ou alterações recentes, para que as pessoas possam ver a atividade.

Dê uma olhada nas mudanças recentes a cada poucos dias ou semanas e, se notar alguém adicionando informações sem ser estimulado, envie um e-mail ou passe por aqui e faça um pequeno elogio.

Answer 3

Já há algum tempo que usamos um wiki de uma forma ou de outra, mas demora um pouco para as pessoas aderirem.Você pode descobrir que será o único a escrever artigos por algum tempo, mas tenha paciência, outras pessoas eventualmente irão aderir.

Se alguém enviar um e-mail contendo informações relacionadas ao projeto, indique-o na direção do wiki - e continue fazendo isso - ele deve entender a dica.

Temos um portal SharePoint e usamos o wiki a partir dele - nós o personalizamos com nossa própria marca para que "pareça bem" - eu realmente sinto que isso ajudou a melhorar a aceitação dele.

Certifique-se de que todos estejam cientes de que o wiki é ainda mais informal que o e-mail....porque haverá um "fator de medo" de que as pessoas possam pensar que qualquer coisa que adicionarem ao wiki será analisada demais.

Answer 4

Acho que a maioria das respostas até agora estão corretas - quanto mais você se dedica a isso, maior se tornará o corpo de informações úteis, de modo lento, mas seguro, as pessoas começarão naturalmente a usá-lo.

A outra abordagem que você pode usar é esta:Sugira que toda vez que alguém fizer uma pergunta sobre o projeto a outro membro da equipe, ele responda normalmente, mas também adicione a resposta a uma seção do Wiki.Isso pode levar alguns minutos a mais, mas significará que da próxima vez que alguém fizer a mesma pergunta (o que inevitavelmente fará), você poderá economizar tempo apontando-o para o Wiki.Isto, por sua vez, deverá ajudar as pessoas a começarem a usar a Wiki como primeira fonte de informação e ajudar na aceitação geral.

Answer 5

Você não pode forçar os desenvolvedores a fazer algo para o qual não têm incentivo;infelizmente wikis, como documentação (bem, na verdade wikis são documentação) raramente têm qualquer valor "legal" para os desenvolvedores.Além disso, eles já estão profundamente envolvidos no trabalho de desenvolvimento. Você poderia realmente incomodá-los com um wiki?

Dito isto, as pessoas que promoveram o wiki (por exemplo, você) deveriam ser as principais responsáveis ​​por atualizá-lo, e você realmente teria muito trabalho pela frente se levar isso a sério.

Você também pode tentar o ff:

• Você diz que não é muito estruturado - muitas pessoas se afastam de wikis mal estruturados (difíceis de pesquisar/navegar).Então talvez você possa consertar isso primeiro
• Talvez você possa pedir aos principais desenvolvedores/gerentes de projeto que o preencham com coisas que são problemas para eles:coisas como convenções de código e design de API para seu projeto específico
• Lidere pelo exemplo:documento religioso seu parte do sistema.Estabelecer um precedente pode encorajar outros a fazer o mesmo

Answer 6

Venda a ideia de usar o wiki para os desenvolvedores.Você identificou alguns benefícios, compartilhe-os com os desenvolvedores.Se eles perceberem que obterão algo de valor com isso, começarão a usá-lo.

Exemplos de vantagens de O que é um wiki

• Bom para escrever ideias rápidas ou mais longas, proporcionando mais tempo para redação e edição formal.
• Colaboração instantânea sem envio de documentos por e-mail, mantendo o grupo sincronizado.
• Acessível de qualquer lugar com conexão à web (se você não se importar em escrever em formulários de texto no navegador da web).
• Seu arquivo, pois cada revisão de página é mantida.
• Emocionante, imediato e fortalecedor – todos têm uma palavra a dizer.

Answer 7

Já fiz algumas vendas e até realizei alguns treinamentos.Acho que algumas pessoas ficam desanimadas com a falta de edição WYSIWYG e a capacidade de colar texto formatado do Word ou Outlook.Eu sei que existem algumas ferramentas para contornar isso, mas ainda são barreiras.

Existem algumas áreas onde o wiki está sendo usado para registrar certas áreas, mas as pessoas que as atualizam não estão fazendo mais nada com ele.

Usarei o wiki para documentar minha área especializada, pois ele atua como uma extensão cerebral conveniente.Ao iniciar um novo desenvolvimento, eu o uso como um bloco de notas para ideias que posso expandir à medida que avança.

Ajudaria se a administração lhe desse algum apoio vocal, mesmo que não seja obrigatório.

Answer 8

É difícil fazer com que as pessoas realmente o usem, quanto mais contribuam.

Uma das maneiras mais fáceis de fazer com que as pessoas contribuam para um wiki é fazer com que forneçam conteúdos de uma forma adequada ao wiki, ou seja,para que tudo o que eles postarem usando seus canais habituais de comunicação (grupos de notícias, listas de discussão, fóruns, rastreadores de problemas, bate-papo) seja basicamente adequado para inclusão no wiki.

Para que outros (usuários/voluntários) possam simplesmente pegar tais conteúdos e colocá-los no wiki.

Isto parece mais complicado do que realmente é, trata-se principalmente de generalizar perguntas e respostas, para que não sejam necessariamente parte de uma conversa, mas possam ser compreensíveis, significativas e úteis de forma independente.

Por exemplo, uma pergunta como a seguinte:

como faço para o git clonar um repositório remoto???

Pode ser respondido assim:

Olá, basta usar o git clone git: // ...

Mas as perguntas também podem ser respondidas de forma menos pessoal:

Para clonar um repositório git, você desejará usar o parâmetro clone para git:git clone git://....

O que estou tentando dizer é que a maioria das discussões em um projeto podem e devem ser facilmente usadas para eventualmente se tornarem documentação.Com esse tipo de mentalidade, sua documentação pode crescer rapidamente.Você só precisa fazer com que as pessoas tenham em mente que informações úteis devem ser fornecidas de maneira ideal para inclusão no wiki.

Eu testemunhei vários casos em que projetos de código aberto começaram a usar essa abordagem até certo ponto e, embora algumas pessoas (principalmente novos usuários) reclamassem que as respostas não eram muito pessoais, o corpo de documentação aumentava constantemente, porque outras pessoas simplesmente monitoravam essas discussões e comecei a copiar/colar essas respostas no wiki.

Basicamente, esta é uma das maneiras mais fáceis de fazer com que as pessoas contribuam para um wiki, sem exigir que elas próprias o utilizem. A única coisa que é exigida delas é uma mudança de pensamento.

Answer 9

Se os desenvolvedores ainda precisarem manter documentação 'real' (s.a.Documentos Word), não vejo nenhuma maneira de duplicar isso de forma significativa em um Wiki.

• Não faz sentido as pessoas escreverem duas vezes
• Quaisquer dados duplicados tendem a ficar fora de sincronia em breve.

O que meu cliente atual fez foi mover tudo isso para o Wiki.Então eu documento apenas uma vez, e faço isso sobre a Wiki.

Esta certo.Trabalhar com o Wiki é mais tedioso do que com o Word, mas pelo menos o documento está online e outras pessoas podem misturá-lo e combiná-lo.

Outra solução funcional (imho) seria armazenar documentos junto com a fonte, no Subversion.Mas então o sistema de mesclagem precisa ser capaz de lidar com rich text, etc.também.Não sei se existe alguma solução para isso (além de usar HTML ou LaTex, o que na verdade não seria uma escolha ruim).

Answer 10

Encontre itens "pegajosos" (sub-3 pág.docs/diagramas/etc) algo que a equipe parece estar criando repetidamente e publicando no wiki.Certifique-se de que todos tenham acesso ao wiki e saibam que ele está lá - configure um mecanismo de notificação, se possível.Com alguma sorte, da próxima vez que eles precisarem acessar, em vez de retirá-lo do controle de versão ou de suas máquinas - eles deverão acessar o wiki.Se ainda assim não o fizerem, tente ver se a equipe tem folga suficiente para realmente usar o wiki - questões mais sutis podem estar por trás de sua relutância.

Answer 11

Confira as dicas em http://www.ikiw.org/ Aumente seu Wiki

Answer 12

Só para acrescentar alguns dos excelentes conselhos oferecidos aqui...

Como desenvolvedor em uma pequena empresa que realiza em grande parte trabalhos com contratos governamentais no intervalo de 6 a 24 meses, descobri que meu tempo é frequentemente dividido entre o desenvolvimento e a redação de relatórios de status (junto com a redação de documentação, só que pior!) Tendo um wiki para eliminar pensamentos e anotações desorganizados à medida que avançamos tornou a redação de relatórios muito menos dolorosa (não MENOS dor, mas melhor do mesmo jeito).

Além disso, se você já está no mundo Mediawiki, você pode querer dar uma olhada em SemanticMediawiki.Ele permite que você leve a organização de seus dados a outro nível, marcando-os semanticamente.Isso não significa muito por si só, eu sei, mas posso dizer (por exemplo) que pode melhorar drasticamente a relevância dos dados retornados das pesquisas.Definitivamente vale a pena dar uma olhada.

Answer 13

Geralmente bons conselhos aqui.Eu gostaria de adicionar:

1. Você realmente precisar a campeão - alguém empurrando isso para desenvolvedores e gerenciamento (sem ser agressivo - isso é um desafio!) e fornecer suporte e tutoriais sempre que possível.Essa pessoa também precisa ser um colega (ou seja, um colega desenvolvedor, não alguém de um departamento de TI remoto) e realmente focado no cliente, ou seja,pronto para fazer alterações quando solicitado.
2. Falando em mudanças, algumas pessoas aqui dizem wikis não são estruturados.Discordo.Nossa instalação MediaWiki é estruturada por meio de categorias, principalmente com duas extensões:WarnNoCategorias (para exigir que os usuários adicionem uma categoria ao salvar uma página) e CategoriaÁrvore para mostrar como todas as categorias se encaixam (isso pode ser vinculado na barra lateral).Tenho mais dicas sobre como manter esse limite baixo, se você estiver interessado.