Quel type d’informations entrerait dans une bonne documentation de déploiement? [fermé]

Question

Je suis constamment aux prises avec mes collègues en ce qui concerne 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 à inclure dans cette distinction, en particulier entre les versions volumineuses, les corrections de bugs et les améliorations.

Qu'est-ce que vous avez trouvé qui vous convient le mieux?

Answer 1

Si le but de la documentation est de garantir que le code est déployé de manière reproductible, voici la pratique minimale recommandée:

1. Résumé de la version, des modifications, de la version, du fichier de solution, etc.
2. Liste des dépendances possibles
3. Procédures de déploiement détaillées
4. Modifications de la base de données ou scripts requis pour l'installation
5. Résumé 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 restauration - si nécessaire.

Answer 2

J'ai constaté que la création d'un outil permettant un déploiement en un clic était bien meilleure qu'une documentation complète sur le déploiement.

Answer 3

Quel est le but de votre documentation? Commencez à partir de là et déterminez ce qui répond à cet objectif.

Pour nous, notre objectif était de permettre à une personne entièrement nouvelle du groupe d’être en mesure d’exécuter un déploiement nouveau ou mis à jour pour quelques systèmes différents. Nous gérons des opérations simples: 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 les besoins d'un nouveau membre de l'équipe pour exécuter les mises à jour et les nouveaux déploiements.