Que tipo de informação seria entrar em uma boa documentação de implantação? [fechadas]

Question

Eu tenho essas batalhas constantes com os meus colegas sobre a composição da documentação de implantação.

Todos concordam que a documentação é necessária. Nem todos podem encontrar um terreno comum em que nível de detalhe deve ir para isso, especialmente a diferenciação entre grandes lançamentos, correções de bugs e melhorias.

O que você encontrou funciona melhor para você?

Answer 1

Se o seu objetivo da documentação é assegurar o código é implantado de uma forma repetível, em seguida, o seguinte seria o mínimo prática recomendada:

1. Um resumo do que a liberação é aproximadamente, o que mudou, versão, onde o arquivo solução pode ser encontrada etc.
2. Lista possíveis dependências
3. procedimentos de implantação detalhadas
4. Banco de Dados alterações ou scripts necessários para a instalação
5. resumo de configuração de como o aplicativo está configurado.
6. teste funcional chave que pode ser executado para verificar a instalação como operacional.
7. Procedimento de anulação -., Se necessário

Answer 2

Eu descobri que a construção de uma ferramenta que permite uma implantação de um clique é muito melhor do que a documentação implantação completa.

Answer 3

O que é o propósito da sua documentação? Iniciar a partir de lá e figura que atende esse objetivo.

Para nós, o nosso objectivo era permitir que alguém inteiramente nova para o grupo a ser capaz de executar uma implantação nova ou atualizada por alguns sistemas diferentes. Nós estamos operando uma sopa de nozes tipo de operação -. Janelas de serviços, tarefas agendadas, backups de banco de dados, atualizações do site web, etc

Em cada caso, o nível de detalhe foi baseado no sistema e que um novo membro da equipe seria necessário para executar atualizações e implantações frescos.