Como você está documentando seu trabalho, processos e ambiente?

48

Você está usando um formato wiki? Se sim, qual produto? (MediaWiki, Confluence, Sharepoint etc.)

Você criou uma base de conhecimento? (Documentos curtos orientados para problemas / soluções.)

Quais desafios você encontra ao criar a documentação que funciona, para que você não receba a ligação quando estiver de férias?

Para mim, acho que muitas vezes há uma certa "inércia" organizacional envolvida na obtenção de documentação. Parece ser um tipo diferente de pessoa que pode fazer uma tarefa, depois pensar em como eles fizeram a tarefa e descrevê-la para que outra pessoa possa fazê-lo - um tipo de força para você "meta" nem todo mundo se sente confortável fazendo isso.

Atualizar

Respostas até agora incluem

  • Confluência
  • Flexwiki
  • Fogbugz
  • Mediawiki (com plugins como o fckeditor)
  • Sharepoint
  • TWiki
  • Documentos do Word / Excel / Visio
  • Scripts documentados

Editar: Você não está implicitamente documentando sua rede com seu sistema de monitoramento? O Nagios sempre incentivou o uso da diretiva parents para refletir a estrutura da sua rede, e a diretiva notes_url foi projetada para permitir o link para um wiki ou outra documentação baseada em navegador . Então aqui a "documentação" é dividida entre o "documento vivo" do sistema de monitoramento e a documentação offline mais detalhada em um wiki. Como eu passo muito tempo olhando para o Nagios, faz sentido esforçar-se para torná-lo o mais informativo possível.

    
por Andrew H 05.09.2010 / 02:33

0 respostas