Estou prestes a criar uma documentação sobre o site da nossa biblioteca?

1

Estou criando isso em ms word, para criar um fichário de 3 toques com guias, cheio de documentação de tudo sobre o nosso servidor web.

Quais são as principais categorias que devo incluir?

Temos 2 servidores, ambos windows, 1 para web, 1 para sql server, web 1, iis7 e coldfusion.

Eu não tenho nenhum treinamento como administrador de sistemas, apenas coisas que aprendi. Tal como eu prefiro ter mais informações, então nenhuma informação, como quando acabamos de migrar nossos servidores, e perdemos uma tonelada de coisas, porque não havia documentação.

Então, eu quero fazer um trabalho completo? Eu não me importaria com isso como um wiki, mas meu chefe e colegas de trabalho não estão muito familiarizados com o wiki e como usá-los. Eu costumo ser o anal em nosso grupo, querendo pontuar todos os i's e ter tudo documentado.

Alguma sugestão?

    
por crosenblum 12.08.2010 / 17:31

2 respostas

5

Até certo ponto, o que você inclui dependerá bastante de quem você está documentando. Você está documentando para administradores? Para os usuários? Para programadores? Tudo acima? Assim como quando você está projetando um site, você precisa examinar os casos de uso e resolvê-los.

Coisas que eu consideraria críticas para a documentação fornecida a mim como programador e / ou administrador de sistema:

  • como os backups são criados
  • como os backups devem ser restaurados
  • como configurar o site a partir do zero (software necessário, processo de instalação, configuração, etc.)
  • lista de dependências (precisa de CF, SQL Server, necessária por x)
  • documentação de qualquer API em uso
  • documentos de requisitos originais, alterar documentos (se existirem)
  • informações sobre como criar / usar administração
  • processo para alterar o acesso quando um usuário sai (revoga o acesso do usuário, altera senhas compartilhadas, etc.)
  • qualquer personalização específica de usuário / cliente / processo
  • qualquer cenário de "pegadinha"
  • qualquer documentação existente para usuários
  • tarefas agendadas e seus agendamentos
  • processos que precisam ser executados regularmente (atualizações de índice, desfragmentação etc.) como parte da manutenção

Se você estiver criando uma fonte eletrônica, como um wiki, seria bom ter isso:

  • composições e maquetes originais
  • fontes de imagem
  • arquivos flash .fla
  • links do site existente para requisitos / alterar documentos
  • uma cópia atual do código de lançamento, com a data / versão / etc. atualizado com cada lançamento principal ou em um cronograma (como mensal).
por 12.08.2010 / 19:14
-1

Use o OneNote para sua documentação em vez do Word

  • Vários usuários podem usá-lo simultaneamente
  • Exportar para pdf, se desejado
  • clique com o botão direito do mouse na funcionalidade "enviar para onenote" aumentou o valor de nossa documentação.
  • acompanhamento de edições

Estes são apenas alguns dos recursos. Para nós, existem muitos benefícios para listar.

    
por 12.08.2010 / 17:35