Dokumentation und Administration: Eine Versöhnung

Eine Dokumentation ist im IT-Bereich lebenswichtig. Zu vielfältig sind die Konfigurationen der einzelnen Systeme und Anwendungen, um sich dies alles merken zu können. Vor allem für den Fall eines Totalausfalls (Stichwort: Desaster Recovery) sollte eine vollständige Erfassung zur Hand sein, um die ursprüngliche Konfiguration auf den neu gelieferten Systemen wieder vornehmen zu können.

Administration und Dokumentation sind aber gegenteilige Pole, wenn es um den IT-Alltag geht. Ist ja auch verständlich. Meist ist Zeit knapp und der Auftraggeber oder Vorgesetzte drängt zur nächsten Problemlösung. Aus diesem Grund wollen wir an dieser Stelle einen Blick auf die kleinen Helfer werfen, die zumindest die Erfassung enorm erleichtern.

Mit der Dokumentation auf Kriegsfuß

Administratoren sind Techniker – und letztere stehen meist mit schön formatierten Dokumentationen auf Kriegsfuß. Zumindest, wenn diese selbst erstellt werden wollen. Dokumentationen haben die unangenehme Eigenschaft, dass sie schön sein sollten. Dies erleichtert das Lesen und Finden der gesuchten Informationen. Dazu gehören ein Inhaltsverzeichnis (ab einem gewissen Umfang) und ein Index. Und spätestens jetzt grenzt dies an – ungewohnte – Arbeit.

Notieren und sammeln

Ist diese letztliche Schriftform jeder Dokumentation zwar das Ziel, so steht die eigentliche Arbeit davor: jedes wichtige Detail einer Installation ist zu notieren. Jede wichtige Änderung an einer Konfiguration muss notiert und abgelegt werden. Und dies am besten zum Zeitpunkt der Ausführung der Arbeiten. Jede Zeitverzögerung bringt auch einen Verlust an Informationen. Das menschliche Gedächtnis vergisst zu schnell (und das ist gut so).

Die richtigen Tools

Im ersten Schritt vor Ort geht es also um die einfache und schnelle Erfassung – die »Quick-and-Dirty«-Methode. Der Vorteil: hier wird nicht auf die Form geachtet. Effizienz und Vollständigkeit sind die einzigen Kriterien. Da es sich dabei vor allem um kleine technische Helferlein handelt, fühlt sich auch der Admin wieder wie Zuhause.

Screenshots in Massen

Was liegt näher, als einfach den Bildschirm bei der Arbeit abzulichten und damit die eigenen Eingaben festzuhalten. Screenshots haben darüber hinaus den Vorteil, dass die bildhafte Darstellung das Verständnis vereinfacht und die Dokumentation sogar noch aufpeppt.

Der Einsatz eines professionellen Screenshot-Tools wie Snagit bietet dabei Möglichkeiten, die über das einfache Einfrieren von Bildschirminhalten weit hinausgehen. Zum ersten kann der Admin mithilfe vielfältiger „Captures“ wie Pfeilen, Sprechblasen und anderer Formen erklärende Anmerkungen zum Screenshot hinzufügen. Zum anderen ermöglichen spezielle Formen des Screenshots sogar eine automatische Konvertierung in Text. Fazit: ohne Snagit keine Dokumentation.

Die Rückkehr des Fotos

Fotos für Dokumentationszwecke – dieser Gedanke ist immer noch falsch besetzt. An dieser Stelle steht die Ablichtung nur als vereinfachtes Mittel zur Wahl. Das Jederzeit-bereit-Smartphone ermöglicht auch auf engstem Raum und bei kleinsten Einheiten das sofortige Festhalten von Informationen, dient aber letztlich nur der Vorbereitung der Schriftform. Beispiel: der schnelle Shot des Serverracks bietet eine saubere Grundlage für die abschließende Beschreibung der Serverinstallation. Beispiel 2: Verkabelungen auf Chip gebannt, können eine wertvolle „Erinnerungshilfe“ darstellen.

Der Fotomarker

Noch viel besser wird die bebilderte Sammlung aber mit entsprechenden Anmerkungen auf den Bildern. Schnittstellen von Servern, spezielle Ports auf Switches und Routern oder auch die einzelnen Slots einer Tape-Library – mit den passenden Hinweisen versehen, wird aus einem Bild eine gesamte Umgebungsbeschreibung.

Praxisbuch IT-Dokumentation: Vom Betriebshandbuch bis zum Dokumentationsmanagement – die Dokumentation im Griff
  • Reiss, Manuela (Autor)
  • 478 Seiten - 18.01.2016 (Veröffentlichungsdatum) - Carl Hanser Verlag GmbH & Co. KG (Herausgeber)

Letzte Aktualisierung am 28.10.2020 / Affiliate Links / Bilder von der Amazon Product Advertising API


Diverse Apps für Tablets oder Smartphones können dies in einem Schritt verknüpfen. „Skitch“ ist eine Anwendung dieser Art. Das soeben erst aufgenommene Foto wird mithilfe von Kreisen, Pfeilen und Textanmerkungen zum sprechenden Dokumentationsbestandteil.

Die Alternative zum Notizblock

Manchmal ist Zeichnen angesagt. Sei es, um Zusammenhänge oder Abhängigkeiten darzustellen, oder auch um Verbindungen zu symbolisieren. Um Schemata dieser Art festzuhalten, hat der gute Notizblock noch lange nicht ausgedient.

Die digitale Alternative ist heute das Tablet mit passendem Eingabestift. Dazu noch (wieder) eine passende App wie Penultimate und schon gelangen auch handschriftliche Notizen und Strichzeichnungen in unsere Ablage zur Dokumentation. Die Kombination mit anderen digitalen Formaten machen aus dieser Variante ein sehr effizientes Werkzeug – direkt im Serverraum.

Der digitale Stift

Umfassendere Notizen per Hand sind auf einem Tablet aber umständlich zu erledigen. Wer dennoch auf die sofortige Digitalisierung nicht verzichten will, der greift zu einem Stift mit automatischer Speicherfunktion. „Livescribe“ gibt dem Anwender einen Stift mit integrierter Kamera. Dieser zeichnet – auf speziellen Notizblöcken angewandt – jegliches Gekritzel auf und überträgt dies über die USB-Schnittstelle später als PDF oder Bild auf den PC. Selbst Audio kann der Kugelschreiber der neuen Generation aufzeichnen. Dies ist wohl bei anderen Anwendungsgebieten besser aufgehoben.

Sprich mit mir

Apropos Audio. Natürlich wären Sprachnotizen auch ein probates Mittel, um keine Details für die Dokumentation zu vergessen. Egal ob Smartphone oder Diktiergerät, beide Varianten ermöglichen eine digitale Weiterverarbeitung.

Die Audio-Aufnahme zu einem späteren Zeitpunkt wieder auf dem PC abzutippen, kann aber nicht die letzte Weisheit sein. Schließlich soll das gesamte Setup Zeit sparen. Wer aber ohnehin ein Anwender von Sprachsoftware wie „Dragon Naturally Speaking“ ist, der findet damit ein sehr wertvolles Hilfsmittel. Ansonsten ist der eigene Digi-Rekorder nur das Mittel im Ausnahmefall.

Für alles andere gibt es E-Mail

Für Informationen, die über die zuvor genannten Möglichkeiten nicht gesammelt werden können, bleibt noch immer die gute, alte E-Mail. So ist es meist nicht zulässig, auf Kundensystemen Software wie Snagit zu installieren. Auch ist dort selten ein PDF-Printer zu finden. Da hilft nur der traditionelle Weg: Screenshots über die Druck-Taste, Copy-und-Paste in Textdateien und – raus per E-Mail. Für diesen Zweck ist Blat, das ultimative Mailprogramm für die Kommandozeile, auf dem USB-Stick immer dabei.

Die Cloud für den Schnellabgleich

Sind sämtliche Informationen vor Ort erfasst, besteht meist das Problem, diese zur Weiterverarbeitung auf einem System zusammenzuführen. Durch die Aufteilung auf unterschiedlichsten Geräten (Ursprungssystem / Server, PC des Administrators, PCs weiterer Mitarbeiter, Tablets, Smartphones, etc.) wird der Sammelvorgang meist zu einem Aufwand. Hier bietet die Cloud eine effiziente Alternative.

Mit einem Dienst wie Evernote sind alle Dokumente, unabhängig vom Medienformat, schnell in einer speziellen Ablage zusammengeführt. Kein umständliches Hantieren mit USB-Sticks oder anderen Speichermedien. Die erfassten Informationen sind nahezu in Echtzeit zentral verfügbar. Und über die eigene Evernote-Mailadresse funktioniert jeder Input auch per E-Mail.

Datenschutz – auch für den Kunden

Zum Abschluss noch ein Wort zur Cloud-Nutzung. Eigentlich versteht es sich von selbst, dass beim Einsatz von Public-Cloud-Applikationen (Evernote, Dropbox, u.ä.) keine sensiblen Daten – und sei es auch nur kurzfristig – abgelegt werden dürfen. Kennwörter und Zugangsdaten sind Tabu. Dafür sind andere, sichere Container – siehe Keepass – vorgesehen.

Zumeist geht es bei der Sammlung zur Dokumentation aber um unkritische Daten. Ein Augenmerk ist aber stets angebracht.

Jenseits der Digitalisierung

Nicht selten fallen bei Installationen wichtige (und ich meine wirklich wichtige) Dokumente an. Hardware-Support-Verträge mit definierter Reaktionszeit des Herstellers sind so ein Beispiel. Auch der 24*7-Support für die Software fällt in diesen Bereich. Und auch diese Dokumente sind Bestandteil der Dokumentation. Die digitale Archivierung ist selbstverständlich.

Denken Sie in diesen Fällen aber auch an den möglichen Totalausfall des EDV-Systems. Dokumente dieser Art müssen – jederzeit verfügbar – auch in Papierform greifbar bleiben. Desaster sind selten, aber heftig.

 


Anzeige



Teile diesen Artikel

Das könnte dich auch interessieren …

Eine Antwort

  1. 10. Juli 2014

    […] Informationsquelle. Auch auf diesem Gebiet sind manuell geführte Listen viel zu fehleranfällig (Admins und Dokumentationen sind ein ewiges […]

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

*