Où puis-je trouver un modèle de documentation sur l'installation de logiciels côté serveur? [fermé]

StackOverflow https://stackoverflow.com/questions/125107

  •  02-07-2019
  •  | 
  •  

Question

Je recherche un bon modèle d'installation de logiciels côté serveur pour un projet sur lequel je travaille.

Le côté client est assez simple. L'installation côté serveur est un peu plus délicate. Il est composé de plusieurs éléments (services, connexions à une base de données, dépendances, ports à débloquer, etc.). Lors d'un test récent, plusieurs pièces non documentées ont été découvertes. Maintenant, je dois créer une documentation d'installation pour nos plans de reprise après sinistre et des moyens de tester l'installation sans nécessairement disposer d'un "Complet". système à tester.

Je voudrais vraiment une suggestion de l'endroit où je peux obtenir un modèle ou un très bon exemple d'un tel document. J'aimerais que ce soit quelque chose qu'un opérateur puisse lire et comprendre dans la chaleur d'une reprise.

[EDIT] Notre documentation actuelle provient principalement des questions posées par nos administrateurs lors de tests hors site. Au fur et à mesure que le nouveau code est écrit, j'aimerais m'assurer que la documentation est écrite à l'avance. Je collectionne des images VMWare pour commencer les tests, mais je cherchais de bons exemples. C'est un magasin Windows Server (2000 & 2003). Les modèles Word seraient bien, mais si je pouvais voir une bonne documentation, je pourrais créer les modèles. Toute suggestion sur ce qui devrait être testé serait également très utile.

[2nd EDIT] J'ai eu plusieurs bonnes idées à partir des réponses postées. Après avoir modifié ma recherche sur Google, j'ai trouvé de bons points de départ. Ils ne sont pas parfaits, mais ils sont un bon début.

Microsoft Exchange - http://technet.microsoft .com / fr-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 / instructions-d'installation-étape-par-étape / exchange-2003 /

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

La planification est bien en phase de conception - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

[Edit 10/29/2008]
CECI est le type d’échantillon que je cherchais. Il ne présente pas beaucoup de déchets, mais semble expliquer assez pourquoi et comment http: //wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Était-ce utile?

La solution

Que faut-il tester? Dans le cas d'un site Web, "pouvez-vous accéder à la page?" Incluez une URL comme point de départ et laissez l’administrateur cliquer jusqu’à un certain point. Il n’est pas nécessaire que l’administrateur réponde à l’ensemble du cycle d’assurance qualité, il vous suffit de vous confirmer que vous vouliez être déployé, c’est vraiment ce qui a été déployé.

Autres idées De plus, nous (mon équipe lors de mon dernier emploi) avons testé le déploiement du contrôle qualité. En tant que responsable AQ, il n’était pas au courant des détails et, lorsqu’il a été déployé dans le service d’Assurance qualité, nous avons pu obtenir des informations sur les problèmes survenus.

Une autre chose utile est de vous asseoir avec les administrateurs avant le déploiement. Passez en revue les instructions et assurez-vous qu'elles les comprennent de la même manière que vous.

Modèle? créez simplement des sections contenant des champs pour les données, telles que les URL vers DEV, QA et PROD. Lorsque vous écrivez les instructions, vous pouvez vous référer à celles-ci. Expliquez simplement ce qui est en train d'être déployé.

Autres conseils

La méthode la plus complète que nous ayons mise au point pour créer notre documentation DR consiste à effectuer un cycle complet d'installation (ou deux) et à documenter chaque étape du processus.

Je réalise que cela peut être un peu difficile si vous n'avez pas de système de test (ou de remplacement) à utiliser pour créer votre documentation - mais il est utile de faire pression pour exécuter ce cycle au moins une fois.

(Je le recommande deux fois, le second étant effectué par une personne non impliquée dans le projet. C’est ainsi que vous testez la documentation pour les futurs administrateurs, qui peuvent ne pas être aussi expérimentés avec le processus.)

L'un des effets secondaires de ce qui précède est que votre documentation devient assez volumineuse. Enfin, je dois le faire. Je pense que le manuel d'installation complet de nos serveurs de base de données comptait plus de 30 pages.

Selon les administrateurs, l’automatisation est utile. J'ai eu des administrateurs Windows qui voulaient un document Word avec des instructions pas à pas et d'autres administrateurs qui voulaient un script.

Cependant, certaines choses utiles à inclure, probablement sous forme de sections

  • Modifications de la base de données
    • Scripts à exécuter
    • Vérification qu'ils ont travaillé
  • Modifications de la configuration
    • quels sont les changements
    • où est une version du nouveau fichier (dans mon cas, ils différaient les deux, ce qui a permis de réduire les erreurs concernant les valeurs spécifiques à la production)
  • Vérification générale
    • ce qui devrait être différent du point de vue de l'utilisateur (modifications de fonctionnalités)
  • Pour les déploiements de batterie de serveurs Web, il peut être utile de disposer d'un document de coordination indiquant comment les serveurs doivent être entrés et sortis du pool.
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top