Quelle sorte d'information irait dans la bonne documentation de déploiement?

Question

J'ai ces batailles constantes avec mes collègues concernant la composition de la documentation de déploiement.

Tout le monde convient que la documentation est nécessaire. Tout le monde ne peut pas trouver un terrain d'entente sur le niveau de détail que cela implique, en particulier en ce qui concerne les grandes versions, les corrections de bogues et les améliorations.

Qu'avez-vous trouvé de mieux pour vous?

Answer 1

Si votre but de la documentation est d'assurer que le code est déployé de manière répétitive, alors ce qui suit serait la pratique minimale recommandée:

1. Un résumé de ce que la libération est sur le point, ce qui a changé, Version, où le fichier de solution peut être trouvée, etc.
2. Liste des dépendances possibles
3. procédures de déploiement détaillées
4. des modifications ou des scripts de base de données nécessaires à l'installation
5. Résumé de la configuration de la configuration de l'application.
6. Test fonctionnel clé pouvant être exécuté pour vérifier que l'installation est opérationnelle.
7. Procédure de retour en arrière - si nécessaire.

Answer 2

J'ai découvert que la création d'un outil permettant un déploiement en un clic est bien meilleure qu'une documentation de déploiement complète.

Answer 3

Quel est le but de votre documentation? Commencez à partir de là et imaginez ce qui répond à cet objectif. Pour nous, notre objectif était de permettre à une personne entièrement nouvelle d'exécuter un déploiement nouveau ou mis à jour pour quelques systèmes différents. Nous opérons une sorte d'opération «soupe-à-noix»: services Windows, tâches cron, sauvegardes de bases de données, mises à jour de sites Web, etc.

Dans chaque cas, le niveau de détail était basé sur le système et sur un nouveau membre de l'équipe devra exécuter des mises à jour et de nouveaux déploiements.