Onde posso encontrar um modelo para a documentação sobre a instalação do lado do servidor de software? [fechadas]

Question

Eu estou procurando um bom modelo de instalação do lado do servidor de software para um projeto que estou trabalhando.

A do lado do cliente é bem simples. A instalação do lado do servidor é um pouco mais complicado. É feito de várias peças (serviços, ligações de base de dados, dependências, portas que precisam ser desbloqueado, etc). Durante um teste recente, várias peças sem documentos foram descobertos. Agora eu preciso para criar documentação de instalação para os nossos planos de recuperação de desastres e maneiras de testar a instalação, sem necessariamente ter um sistema de "full-up" para testar.

Eu realmente gostaria de uma sugestão de onde eu posso obter um modelo ou um bom exemplo deste tipo de documento a. Eu gostaria que fosse algo que um operador pode ler e compreender no calor de uma recuperação.

---

[EDIT] Nossa documentação atual trata principalmente das questões nossos administradores tiveram durante os testes off-site. Como novo código é escrito, eu gostaria de fazer frente certeza de que a documentação está escrito de tempo. Eu tenho vindo a recolher imagens VMware para iniciar os testes, mas estava à procura de alguns exemplos bons. É uma loja Windows Server (2000 e 2003). modelos do Word seria ótimo, mas se eu pudesse ver a documentação boa, eu poderia criar os modelos. Todas as sugestões sobre o que deve ser testado seria tão grande assim.

---

[2º EDIT] Eu recebi várias boas idéias das respostas postadas. Depois de mudar a minha pesquisa no Google, eu vim com alguns pontos boa partida. Eles não são perfeitos, mas eles são um bom começo.

Microsoft Exchange - http://technet.microsoft .com / en-us / library / bb125074 (EXCHG.65) .aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http: //cregan.wordpress .com / 2006/06/22 / troca-2003-passo-a-passo de instalação-instruções /

http://technet.microsoft.com/en-us/magazine /cc160942.aspx

aborda o planejamento na fase de projeto bem - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

---

[Edit 2008/10/29]
Esta é a amostra do tipo I estava procurando. Ele não tem um monte de lixo, mas parece explicar o suficiente do porquê juntamente com a forma como http: //wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Answer 1

O que deve ser testado? Bem, no caso de um site web "você pode ir para a página?" Incluir uma URL como um ponto de partida e deixe o administrador clicar para um determinado ponto. Não é necessário que o administrador para passar por todo o ciclo de QA, apenas uma confirmação de que o que você quis ser implantado é realmente o que foi implantado.

---

Outras idéias Além disso, nós (minha equipe no meu último emprego) tiveram teste de QA a implantação. Como uma pessoa QA deve ser, ele não era íntimo com os detalhes e como ele implantado para QA, fomos capazes de obter feedback sobre o que deu errado.

Outra coisa que é útil é sentar-se com o administrador (s) antes da implantação. Ir sobre as instruções e fazer com que eles entendam-los da mesma maneira que você faz.

---

modelo? Apenas certifique seções que têm campos de dados como URL para DEV, QA, e PROD. Quando você escreve a instrução pode se referir àqueles. Apenas torná-lo claro o que está sendo implantado.

Answer 2

O método mais completo que nós viemos acima com para a criação de nossa documentação DR, envolve passando por um ciclo completo (ou dois) de instalação, e documentar cada passo ao longo do caminho.

Sei que isso pode ser um pouco difícil se você não tem um teste (ou substituição) do sistema para uso para criar sua documentação - mas vale a pena fazer lobby para que atravessa este ciclo pelo menos uma vez

.

(eu recomendo duas vezes, o segundo ser feito por alguém que não estão envolvidos com o projeto -. Isto é como você testar a documentação para administradores futuros, que pode não ser tão experientes com o processo)

Um efeito colateral do acima é que a documentação cresce bastante grande -. Passada eu tinha que fazer isso, acredito que o manual de instalação concluída para os nossos servidores de banco de dados foi 30 + páginas

Answer 3

Dependendo dos administradores, a automação é útil. Eu tive janelas administradores que querem um documento do Word com instruções passo a passo e outros administradores que queriam um script.

No entanto, algumas coisas úteis para incluir, provavelmente como seções

• mudanças de banco de dados
  • Scripts para executar
  • A verificação de que eles trabalharam
• Configuração muda
  • Quais são as mudanças
  • , onde é uma versão do novo arquivo (No meu caso eles diffed os dois, o que ajudou a reduzir erros relativos valores específicos-produção)
• verificação geral
  • O que deve ser diferente a partir da perspectiva do usuário (alterações de recursos)
• Para implantações de farm web, pode ser útil ter um documento coordenação a respeito de como os servidores precisam ser puxado para dentro e para fora da piscina.