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).