Dokumentation bietet Audit Trails zu Arbeiten, die abgeschlossen ist

# 13: Document Everything

Die Bedeutung der guten, soliden Dokumentation kann einfach nicht genug betont werden. Dokumentation bietet Audit Trails zu Arbeiten, die abgeschlossen ist. Es stellt Leitlinien für künftige System-Administratoren, damit sie über Systeme, die existierten, bevor sie ankamen. Dabei steht Ihnen die System-Administrator und sein Management mit Vollendung Datensätze. (Diese kann sehr praktisch sein Personal auf Zeit für die Prüfung.) Gute Dokumentation kann auch mit Hilfe Problem zu lösen.

1. Die erste Zielgruppe ist der Autor selber. Dokumentation der Software-Autor soll macht es viel einfacher für den Autor gehen hin und Debug-Probleme in seinem eigenen Code, der Jahre später auftreten können. Wenn Sie zurückblicken auf Ihre eigene zwei-oder drei-jährige Arbeit (System-oder Netzwerk-Design oder Programme, zum Beispiel), kann es fast unmöglich, sich daran zu erinnern, warum Sie etwas nicht einer bestimmten Weise und nicht anders, obwohl sie gute Gründe zu der Zeit. Schreiben Sie Kommentare in Ihrem Code. Schreiben Sie Handbücher, auch wenn sie nur ein paar Seiten lang.

2. Die zweite Zielgruppe sind irgendwann in der Zukunft. Die Leute, die Systeme und die Anwendungen von heute werden nicht für immer und ewig aufrechterhalten werden. Und Sie können nicht davon ausgehen, dass jeder erfahrene Personal in der Nähe sein, Mentor Neulinge werden. Sie müssen die Vorbereitungen für eine massive Abwanderung von Ihrem erfahrenen Leuten. Ein beliebtes Zeichen auf den Schreibtischen vieler Systemadministratoren ", heißt es:" Denken Sie daran, in 100 Jahren alle neuen Menschen! "

3. Die dritte Zielgruppe ist das Management. Stets in guter Noten und dokumentieren Sie Ihre Arbeit hilft nachzuweisen, Verwaltung, dass Sie fleißig sind und zeigt, welche Maßnahmen wurden getroffen werden, um die Systeme laufen und produktiv. Wenn ein System nicht über die festgelegten Anforderungen in der Dokumentation zu erfüllen, sollte es einfach sein, um herauszufinden, warum und zu entscheiden, was getan werden muss, damit das System kompatibel sein. Selbst wenn Ihr Management nicht den Wert der Dienstleistungen, die Sie für die Organisation zu verstehen, wird sie in der Regel den Wert zu verstehen, wenn es als einen dicken Stapel von Unterlagen vorgelegt.

Stellen Sie sicher, dass die Dokumentation auf Papier ist nicht gespeichert. Wenn das System heruntergefahren ist, wenn Sie die Handbücher, du bist nicht in der Lage sein, um sie zu bekommen. Halten Sie diese in Ordnern, so dass sie leicht verändert und aktualisiert werden. Nach der Dokumentation geschrieben ist, vergessen Sie nicht, sie zu überprüfen und aktualisiert es regelmäßig. Bad Dokumentation ist schlimmer als gar keine. In einer Krise, besonders wenn die klügsten Leute nicht da sind, ist die Dokumentation wahrscheinlich wörtlich befolgt werden. Wenn es falsch ist, kann es vom Regen in die Traufe kommen. Eine häufige Frage nach der Erstellung der Dokumentation wird auf technischer Ebene, was sie geschrieben werden sollen. Eine Schule des Denkens, sagt, dass die Dokumentation sollte so geschrieben sein, dass jeder in der Organisation, von einem Pförtner an den CEO, kann es zu verfolgen und, falls erforderlich, bringen die Systeme nach einer Katastrophe. Schließlich kann das System Verwaltungspersonal nicht auf die zur Verfügung stehenden Zeit, und jemand hat es zu tun. Obwohl dies ein hehres Ziel ist, ist es eine unpraktische ein. Der Zustand der kritischen Systemen ändert sich die ganze Zeit. Je mehr Details, die in dieser Dokumentation enthalten ist, desto schneller wird es "out-of-date. Um die Dokumentation zu schreiben, so dass einem ungeschulten kluge Person Systeme bringen konnte nicht nach oben oder andere kritische Arbeit, die ihnen in Zeiten der Krise, es wäre so detailliert sein, dass nicht zu bewältigen. Wenn die Aufgabe darin, eine Datei zu bearbeiten Änderung einer Variablen zu einer anderen, für einen entsprechend ausgebildeten Systemadministrator, würde die Dokumentation nur noch zu sagen: "Change ABC in XYZ / directory / file.txt." Für einen ungeübten kluge Person, würde der Dokumentation müssen, zu sagen:

1. Ändern Sie das Verzeichnis / Verzeichnis, indem Sie "cd / Verzeichnis".

2. Öffnen Sie den Texteditor vi, indem Sie "vi file.txt".

3. Bewegen Sie den Cursor nach unten auf Linie 300, indem Sie "300G".

und so weiter (in jeder Betriebsumgebung angemessen ist). Jedes Mal, wenn die Nummer der Zeile in der Datei änderten, wäre die Dokumentation geändert werden müssen. Viele Fehler Voraussetzungen müssten für den unerfahrenen Person als auch behandelt werden, zum Beispiel, wenn der Typ des Terminals oder Zeilenzahl gesetzt ist falsch, den vi-Editor können Probleme beim Umgang mit ihr. In diesem Fall ist, was den unerfahrenen Person zu tun? Die richtige Antwort ist daher in der Dokumentation zu schreiben, damit ein erfahrener Systemadministrator es verwenden könnte. Erwarten Sie nicht, dass der Administrator ein hohes Maß an Erfahrung in Ihrem Geschäft haben, so die allgemeine Erfahrung. In einer Windows-Umgebung, Ziel ein Microsoft Certified Engineer (MCSE). In Unix-Umgebungen, Ziel erfahrene Systemadministratoren. Wenn etwas passiert, das derzeitige System Verwaltungspersonal, können Sie davon ausgehen, dass sie von erfahrenen Leuten ersetzt werden. Dokumentation ist eine viel wie ein feines Stück Literatur. Jeder will sagen, dass sie Moby Dick gelesen haben, aber niemand will wirklich hinsetzen und Moby Dick lesen.

# 12: Beschäf Service Level Agreements

# 11: Plan Ahead

Ein Artikel eingereicht von Ben Smeider

Disclaimer:Unsere Website ist nicht verantwortlich für den Inhalt dieses Artikels. Webarticles ist eine kostenlose Informationsquelle.
Wichtig: Dieser Artikel "Dokumentation bietet Audit Trails zu Arbeiten, die abgeschlossen wurde" wurde durch ein automatisches Software übersetzt. Wir fühlen uns leid für alle Rechtschreibfehler, die möglicherweise aufgetreten sind. Vielen Dank für Ihr Verständnis.