Estou criando isso em ms word, para criar um fichário de 3 argolas com abas, cheio de documentação de tudo sobre nosso servidor web.
Quais são as principais categorias que devo incluir?
Temos 2 servidores, ambos windows, 1 para web, 1 para sql server, o web 1, roda iis7 e coldfusion.
Não tenho treinamento como administrador de sistema, apenas coisas que aprendi. Por exemplo, prefiro ter mais informações do que nenhuma informação, como quando acabamos de migrar nossos servidores e perdemos muitas coisas porque não havia documentação.
Então eu quero fazer um trabalho completo? Eu não me importaria se isso fosse um wiki, mas meu chefe e colegas de trabalho não estão muito familiarizados com wikis e como usá-los. Costumo ser o anal do nosso grupo, querendo pontuar todos os i's e documentar tudo.
Alguma sugestão?
Responder1
Até certo ponto, o que você incluir dependerá muito deQuemvocê está documentando. Você está documentando para administradores? Para usuários? Para programadores? Tudo o que precede? Assim como quando você está projetando um site, você precisa analisar 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 do zero (software necessário, processo de instalação, configuração, etc.)
- lista de dependências (precisa de CF, SQL Server, necessária para x)
- documentação de qualquer API em uso
- documentos de requisitos originais, documentos de alteração (se existirem)
- informações sobre como criar/usar administração
- processo para alterar o acesso quando um usuário sai (revogar o acesso do usuário, alterar senhas compartilhadas, etc.)
- quaisquer personalizações específicas de usuário/cliente/processo
- qualquer cenário de "pegadinha"
- qualquer documentação existente para usuários
- tarefas agendadas e seus cronogramas
- 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 estes:
- composições e maquetes originais
- fontes de imagem
- arquivos flash .fla
- links do site existente para requisitos/documentos de alteração
- uma cópia atual do código de lançamento, com a data/versão/etc. atualizado a cada lançamento principal ou em uma programação cronometrada (como mensalmente).
Responder2
Use o OneNote para sua documentação em vez do Word
- Vários usuários podem usá-lo simultaneamente
- Exporte para pdf se desejar
- A funcionalidade "enviar para onenote" com o botão direito aumentou o valor de nossa documentação.
- edições de rastreamento
Esses são apenas alguns dos recursos. Para nós, na verdade, existem muitos benefícios para listar.