Documentation fournit des pistes d'audit à des travaux qui a été complété

# 13: Tout document

L'importance de bien, solide documentation ne peuvent tout simplement pas être surestimé. Documentation offre des pistes d'audit à des travaux qui a été achevée. Il fournit des guides pour les administrateurs système à venir afin qu'ils puissent prendre en charge les systèmes qui existaient avant leur arrivée. Elle peut fournir à l'administrateur système et sa gestion avec les dossiers d'accomplissement. (Ceux-ci peuvent être très pratique au personnel le temps d'examen.) Bonne documentation peut également aider à la résolution de problèmes.

1. La première audience est l'auteur lui-même. Documentation visant à l'auteur du logiciel le rend beaucoup plus facile pour l'auteur de revenir en arrière et déboguer des problèmes dans son propre code qui mai se produire des années plus tard. Lorsque vous revenez sur vos propres à deux ou trois ans, ancien travail (système ou de conception de réseaux ou programmes, par exemple), il peut être presque impossible de se rappeler pourquoi vous avez fait quelque chose d'une manière particulière, et pas une autre façon, bien qu'ayant d'excellentes raisons à l'époque. Écrire des commentaires dans votre code. Rédiger des manuels, même si elles ne sont que quelques pages.

2. Le second public est parfois à l'avenir. Les gens qui soutiennent les systèmes et les applications d'aujourd'hui ne vont pas rester éternellement au pouvoir. Et vous ne pouvez pas supposer que tout le personnel expérimenté sera sur place pour les nouveaux arrivants mentor. Vous devez vous préparer à un exode massif de vos employés expérimentés. Un signe populaires sur les bureaux de nombreux administrateurs », indique:« Rappelez-vous, 100 ans à partir de maintenant, toutes les nouvelles personnes! "

3. La troisième audience est la gestion. Maintenir de bonnes notes et documenter votre travail contribue à prouver à la direction que vous avez fait preuve de diligence et montre ce que des mesures ont été prises pour conserver les systèmes en cours d'exécution et productive. Si un système ne répond pas aux exigences énoncées dans la documentation, il devrait être facile de comprendre pourquoi et de déterminer ce qui doit être fait pour rendre le système conforme. Même si votre direction ne comprend pas la valeur des services que vous fournissez à l'organisation, ils seront généralement comprendre la valeur quand elle est présentée comme une épaisse pile de documentation.

Assurez-vous que les documents sont stockés sur papier. Si le système est en panne lorsque vous devez les manuels, vous n'allez pas être en mesure de parvenir jusqu'à eux. Gardez-les dans des classeurs de sorte qu'ils puissent facilement être modifié et mis à jour. Après la documentation est écrite, n'oubliez pas de le réviser et mettre à jour sur une base régulière. Documentation Bad est pire que rien du tout. En cas de crise, surtout si les gens les plus compétents ne sont pas là, la documentation est susceptible d'être suivi mot pour mot. Si c'est faux, les choses peuvent aller de mal en pis. Une question courante sur la documentation de préparer est à quel niveau technique, il doit être écrit. Une école de pensée dit que la documentation doit être rédigée de sorte que quiconque dans l'organisation, à partir d'un concierge au PDG, peut-on suivre et, le cas échéant, apporter les systèmes en place après une catastrophe. Après tout, le système du personnel administratif mai ne pas être disponibles à l'époque, et quelqu'un doit le faire. Bien que cela soit un objectif noble, il est un peu réaliste un. L'état de l'évolution des systèmes informatiques critiques tout le temps. Le détail de plus qui est inclus dans cette documentation, plus il devient out-of-date. Afin d'écrire la documentation de sorte qu'une personne intelligente sans formation pourrait mettre les systèmes en place ou faire un travail critique sur les autres en temps de crise, il devra être détaillées au point d'être ingérable. Si la tâche à accomplir est d'éditer un fichier à changer une variable à l'autre, pour un administrateur système de formation appropriée, la documentation aurait seulement besoin de dire «changez ABC à XYZ dans le répertoire / / fichier.txt." Pour une personne à puce sans formation, la documentation aurait besoin de dire:

1. Passez au répertoire / répertoire en tapant "cd / répertoire".

2. Ouvrez l'éditeur de texte vi en tapant "vi fichier.txt".

3. Déplacez le curseur sur la ligne 300 en tapant "300G".

et ainsi de suite (quelle que soit l'environnement d'exploitation est approprié). Chaque fois que le numéro de ligne dans le fichier modifié, la documentation devrait être changé. Conditions d'erreur Nombreux sont ceux qui doivent être traitées pour la personne inexpérimentée ainsi, par exemple, si le type de terminal ou de nombre de lignes est mal réglé, l'éditeur vi mai ont du mal à y faire face. Dans ce cas, quelle devrait être la personne inexpérimentée faire? La bonne réponse est donc à écrire la documentation afin qu'un administrateur système expérimenté pouvait s'en servir. Ne vous attendez pas à l'administrateur d'avoir une grande expérience dans votre boutique, juste l'expérience générale. Dans un environnement Windows, cible un Microsoft Certified Engineer (MSCE). Dans les environnements Unix, système cible administrateurs expérimentés. Si quelque chose arrive au système actuel du personnel administratif, vous pouvez raisonnablement supposer qu'ils seront remplacés par des personnes expérimentées. La documentation est un peu comme un beau morceau de littérature. Tout le monde veut dire qu'ils ont lu Moby Dick, mais personne ne veut en fait en baisse de s'asseoir et lire Moby Dick.

# 12: Utiliser des Service Level Agreements

# 11: Prévoyez à l'avance

un article présenté par Ben Smeider

Disclaimer:Notre site n'est pas responsable du contenu de cet article. Webarticles est une ressource d'information gratuite.
Important: Cet article «documentation offre des pistes de vérification de travail qui a été accompli" a été traduit par un logiciel automatique. Nous nous sentons désolés pour les fautes d'orthographe que mai ont eu lieu. Nous vous remercions de votre compréhension.