Pergunta

  • Faça usamos um wiki empresa?
  • como sobre você salvar os documentos técnicos, como parte de controle de origem e, em seguida, tem links para eles a partir de vários arquivos de origem (para entender como isso funciona ver artigo ... no diretório ...)

quais são os prós e contras destes e de outros métodos? quaisquer ferramentas boas para este fim?

Se você recomendar um wiki, o que Wikis que você recomendaria para usar? interno? hospedado? livre? pago?

Foi útil?

Solução

Eu recomendo usar um wiki. Ele funciona muito bem como uma fonte de documentação central e foi construído com controle de revisão. Também é possível fazer referência a documentação no código via URLs.

Outras dicas

As pessoas são o recipiente conhecimento efectivo mais na sua empresa. E a maneira mais eficaz de transferência de conhecimento é de pessoa para pessoa. Wiki e documentação são úteis também, mas a menos que seus funcionários são documentação grandes escritores técnicos escrita é uma péssima maneira de transferir todos, mas o conhecimento mais trivial. Escritores levar anos para escrever um livro que você não pode esperar que os desenvolvedores a documentação de qualidade de gravação em um par de horas.

A melhor maneira de manter o conhecimento em sua organização é ter as pessoas trabalham juntas. Certifique-se que ninguém trabalha sozinho. Ter pessoas pair-programa e rever cada código de outros. Organizar sessões técnicas etc.

Se você realmente deseja armazenar o conhecimento em algum lugar tentar enriquecer os dados. Torná-lo fácil de adicionar imagens de quadros, etc, para o wiki. Outro problema com a documentação escrita é que as pessoas parecem pensar prolixo texto do resumo é 'profissional'. Certifique-se de manter uma documentação curta, claro e direto ao ponto que as pessoas vão realmente lê-lo.

Se você pode reunir o apoio, um meio social que tem a reputação (como este site muito) pode trabalhar extremamente bem em uma intranet. As pessoas precisam de um pouco de incentivo para alimentar a base de conhecimento.

Eu recomendaria o MindTouch Deki . É muito mais do que um wiki, com integrações em uma série de outras fontes, incluindo a capacidade de integrá-lo em fontes de dados personalizadas em sua organização.

O trabalho de Wiki bem, mas complementar a Wiki com Ignite e Camtasia screencasts. Estes configuração poupar tempo ao retratando, etc. Screencasts são fáceis de fazer, rápido, e você não precisa se preocupar se você capturou o detalhe certo para seu público na medida em que rebobinar / reproduzir as seções que precisam de revisão.

Nós tentamos artigos da base de conhecimento e isso faz as pessoas preguiçoso - "Eu não entendo esta seção" significa que você vai reescrever um monte. Dar a uma pessoa um screencast e eles podem fazer suas próprias notas.

A única coisa mais importante sobre a retenção de conhecimento em uma empresa, independentemente da solução, é fazer cumprir as pessoas usam o sistema. Wikis são o meu favorito, mas sem a aplicação de líderes de gestão ou equipe, é difícil manter esse nível de conhecimento útil -. Pessoas odeiam documentar que parece, especialmente quando se torna facilmente substituído

Wikis são bons, mas uma de suas maiores vantagens ainda não foi mencionado. Muitas vezes as falhas na documentação não são encontrados pela pessoa que o escreveu, porque o autor não precisa ou leia a documentação. Falhas são encontradas quando o autor está de férias ou fora doente, e alguém tenta outra pessoa para seguir a documentação e parte dela não funciona. Usando um Wiki, quaisquer que sejam pobres extremidades companheiros por descobrir a falha na documentação pode corrigi-lo imediatamente, em vez de ter que enviar e-mail do autor, onde ele fica enterrado nas outras mil e-mails o autor obteve durante as férias, ou tentando lembrar de dizer o autor depois que o autor recebe de volta.

Além disso, certifique-se que pelo menos duas pessoas sabem como fazer tudo, e os níveis de mantêm de pessoal . Quando alguém deixa, ele pode ser muito tentador não substituí-los se você já tem outras pessoas que podem fazer tudo o que eles fizeram, mas se você já tem várias peças de infra-estrutura ou de código que são cada compreendido somente por uma pessoa, então você está vulnerável . transferência de conhecimento de uma pessoa para outra, leva tempo e as mãos no trabalho. Não é fácil, mas é infinitamente mais fácil do que tentar aprender uma infra-estrutura ou base de código a partir de docs sozinho.

Eu usei ambos os métodos no passado, e encontrou o formato wiki para ser o mais prontamente aceito. Armazenar documentos no controle de origem pode ter impactos em torno de fusão versões (obviamente dependentes do software de controle de origem em uso e metodologias aplicadas). O mesmo é verdadeiro de soluções baseados em wiki, mas por alguma razão ele nunca pareceu apresentar um enorme problema nas implementações que eu usei.

O searchability de grandes wikis é outro fator importante para o seu sucesso. É muito mais fácil para procurar um termo de pesquisa em um wiki do que é encontrar uma referência a um documento em um pedaço potencialmente independentes de código.

<2c />

Eu gosto de wikis. Eu até usá-los para meus próprios projetos de hobby, documentando como eu tenho problemas em torno desagradáveis ??que eu não quero ter que lidar com outra vez, ou manter uma lista de referências a recursos relavant.

Ter muitas pessoas contribuem para tal wiki um é ainda mais poderoso, no entanto, uma possibilidade de discussão também é muito importante.

Eu realmente começado um projeto paralelo que endereços ele. É ainda nas fases de planeamento, mas eu já identificou algumas áreas onde o conhecimento técnico é mantido nas organizações. Agora, isso não se aplica a todas as organizações, mas cada organização utiliza pelo menos um deles.

  • Pessoas
  • Estática Web (Internet e Intranet) Sites
  • Livros (uma biblioteca de empresa)
  • Books (livros de um indivíduo)
  • Dinâmica Web (Internet e Intranet) Sites
  • Bases de dados e repositórios

Exatamente como você utiliza cada um deles é diferente, mas a chave é fazer com que as pessoas a usar estático e / ou Web Sites Dinâmicos com informações de captura, ou pelo menos identificar onde ele está em livros e repositórios. Se as pessoas não estão alimentando as casas de conhecimento, então não importa o que a tecnologia que você usa. O conhecimento deve ser atual, precisas e em profundidade ou é inútil, pelo que tenho sido capaz de reunir.

Outro conceito-chave que é importante, como Vinko Vrsalovic apontou, é a capacidade de ligar a parte de trás de dados / informação / conhecimento a ele de raciocínio. Uma prática comum em análise de requisitos é a capacidade de rastrear a exigência de sua fonte. O mesmo deve ser dito para o conhecimento. Todos na organização pode saber tudo no mundo. No entanto, se ninguém sabe por que o conhecimento é útil ou onde / quando usar esse conhecimento, é desperdiçado.

Se eu estou faltando qualquer, sinta-se livre para editar este post ou responder como um comentário. Eu acho que esta questão vai ajudar meus esforços do projeto.

EDIT 1:. Adicionado Vinko Vrsalovic que não é apenas sobre o conhecimento, mas que liga a parte de trás de dados para os problemas de produção que pertence o conhecimento para

Eu vi que um monte de discussões conhecimento acontecer dentro de e-mail dentro de uma organização. Este conhecimento permanece dentro do e-mail por muito tempo e, eventualmente, se perder e não é acessível a outras pessoas que não faziam parte da discussão original.

Usando ferramentas como http://grexit.com pode ajudá-lo a mover-se estes conhecimentos fora de você caixa de entrada para um coomon compartilhada repositório dentro de sua organização. Atualmente esta funciona apenas para Gooogle Apps, mas o que vale a tentativa.

Definitivamente um wiki. Usamos TWiki e fazer uso de alguns excelentes plugins.

Edit: eu esqueci de acrescentar que você pode gostar de consultar as respostas para este pergunta sobre documentos e controle de versão.

Use um wiki, mas garantir que alguém tem a propriedade editorial do que se passa no essa pessoa precisa para garantir padrões de nomenclatura e herarchy documento são respeitados -.. Que é muito fácil para um wiki empresa para se tornar uma bagunça alastrando

Vou dar-lhe alguns inconvenientes de Wiki de, ou em que algum extra pensei que talvez necessário:

  1. Se o conhecimento / documentação técnica é compartilhada com os clientes ou organizações que não têm acesso ao seu Wiki
  2. Documentação associada a uma determinada versão de software muitas vezes vive melhor com a fonte associada com a liberação. Muitas vezes do Wiki contêm o mais actualizada a informação, mas pode ser difícil (dependendo do cuidado de editores) para mapear a documentação para versões mais antigas

Eu acho que, a ferramenta que você usa não é tão importante. A coisa realmente importante é que todos os membros de sua equipe aggree em cima de uma forma e um lugar para a documentação.

Você pode usar um wiki ou um banco de dados notas ou um aplicativo de auto-bebida.

Eu pessoalmente prefiro que todas as coisas estão em um só lugar. Assim, para documentação técnica, o sistema de controle de origem será o lugar certo. Para documentação, que é usado por não desenvolvedores, controle de origem é definitivamente o lugar errado. Para docs accross-the-board, talvez um servidor SharePoint é a ferramenta que você deve usar. Tem algum tipo de controle de versão e é acessível sem-clientes aplicações especiais.

Nós usamos uma combinação de blog do projeto e wiki.

Eu acho que as pessoas sentiram um pouco colocar um wiki - que eles sentiram que precisavam para entrar alguns parágrafos, pelo menos para justificar a entrada - então começamos um blog que é útil para capturar pequenas coisas ou coisas que acontecem em em tempo real, por exemplo, 'eu mudei comprimento do campo coluna 40-50' ou 'os dados da tabela de auditoria purgado mais velhos que na semana passada'.

Espero que (espero) que algumas entradas do blog vai se tornar a fonte de material para entradas wiki mais longos como os avanços do projeto.

Como uma alternativa a um wiki, considere o uso do SharePoint. Ele permite que você para lidar com eventos (como reuniões), tarefas e documentos. Ele funciona muito vontade com a multidão não técnica, o que pode permitir que escritores técnicos e gestores a tomar uma olhada no que está acontecendo. É também parte do Windows 2003, então você pode não precisar de uma licença adicional por isso.

Em contrapartida, eu quase posso garantir que haverá um ludita quem você culpa por cada menor esquivo UI. Os superiores provavelmente vai adorar embora.

Você provavelmente pode dar uma olhada Associativy . Ele armazena partes de conhecimento como os nós de um gráfico onde bordas representam associativo (num sentido humano) ligação. O gráfico é pesquisável e explorável de várias maneiras, dado um conjunto de termos de pesquisa do software é capaz de "pensar" sobre uma associação adequada.

I é de código aberto e executado no Orchard CMS , um projeto open source também.

Este foi um plug descarado (Associativy é meu projeto), me desculpe.

Editar: apenas reconhecido quantos anos esta pergunta é ....

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top