IT-Dokumentation: Ein wichtiger Aspekt für den IT-Support
Lars Behrens, Dipl.-Paed
Lars Behrens ist Geschäftsführer der Firma MaLiWi IT. Staatlich geprüfter Netzwerkadministrator, Microsoft MCP/Linux LCP. Er hat langjährige Erfahrung in der Beratung bei Planung und Einrichtung von IT-Systemen und Netzwerken und dem Support heterogener Systeme (Apple Macintosh, Microsoft Windows, Linux). Universitätsstudium der Pädagogik, mehrere Jahre Tätigkeit im Ausland. Seminar- und Kursleiter, Referent und Fachbuchautor. Weiterhin ist er Herausgeber von dem Online-Fachportal «InformatikPraxis» bei der WEKA Business Media AG.
Wussten Sie schon, dass jeder zehnte Ausfall in der IT auf mangelnde IT-Dokumentation zurückzuführen ist? «Doch nicht nur für ein schnelles Störungsmanagement sind lückenlose Dokumentationen wichtig. Sie bilden auch die Basis für Entscheidungen, die sicherheitsbewusste Netzplanung und die Erfüllung von verschiedenen Regularien wie der ISO 9001:2000, Euro-SOX und Basel II» heisst es auf unternehmen.chip.de/it-dokumentation-software.html
Nun sind IT-Dokumentationen irgendwie die ungeliebten Stiefkinder der IT-Administration, das bestätigen immer wieder die Erfahrungen aus der Praxis. Das ist nicht nur fahrlässig und sorgt beispielsweise beim Wechsel des IT-Personals oder -Dienstleisters immer wieder für (vermeidbaren) Mehraufwand und Redundanzen. Dabei hilft eine gute Doku nicht nur bei der Einarbeitung neuer Kollegen oder bei der Störungssuche. Auch, wer Wert auf prozessorientiertes Arbeiten legt, kommt um eine gute IT-Doku nicht herum. Das gilt erst recht für alle diejenigen, die sich an ITIL orientieren. ITIL (IT Infrastructure Library), dieses Best Practice Framework für die Planung, Einrichtung, Durchführung, Auswertung, fortlaufende Entwicklung und Verbesserung von IT-Prozessen, empfinden viele Administratoren und IT-Verantwortliche immer noch ein wenig als exotisch. Gleichwohl ist dessen Bedeutung nicht zu unterschätzen. So lehnen viele IT-Supportunternehmen ihre Tätigkeiten an den Kriterien und Begrifflichkeiten von ITIL an.
Ein wichtiger Punkt könnte eine Vorgabe durch ISO-Normen sein. Ist Ihr Unternehmen zertifiziert nach ISO 27001, stellt eine IT-Dokumentation eine Pflichtübung dar und nicht mehr nur eine Kür!
Fazit: Einer der wichtigen Aspekte in prozessorientiertem, professionellem und auf Qualität bedachtem IT-Support ist die IT-Dokumentation – und dies gilt nicht nur für grosse Betriebe mit eigener IT-Abteilung. Auch Einzelkämpfer, IT-Administratoren und externe Dienstleister erweisen sich einen Bärendienst, wenn Sie meinen, Zeit und Aufwand sparen und auf die IT-Dokumentation auch scheinbar selbstverständlicher oder belangloser Details verzichten zu können. Und einmal ganz ehrlich beantwortet: Dokumentieren Sie immer sorgfältig Ihre IT-Projekte oder einfach nur die kleinen Kniffe, Wege und Arbeitsschritte, die bei der Umsetzung eines Projekts konkret notwendig waren?
Gepflegte IT-Dokumentation
Bereits bei der Wiedereinrichtung eines ausgefallenen Systems, bei der Einarbeitung neuer Mitarbeiter oder bei der forensischen Analyse eines gehackten Systems stellt es sich immer wieder heraus, dass gute IT-Dokumentation nicht nur Not, sondern auch gut tut. Eine eigene Knowledgebase ist dann die Kür einer gepflegten IT-Dokumentation. Hier erfährt die gern herangezogene Beschreibung von ITIL als Best practice einen wahren Wortsinn. Es sind eben Aufzeichnungen über die geübte IT-Praxis in einem Unternehmen.
«Das Wissen darüber, was man an IT-Infrastruktur hat, wie man es betreibt, und wie man es schützt, wird laut Erhebungen des IT Service Management Forum (itSMF) bei 50 Prozent aller IT-Abteilungen (…) ohne vernünftige Methodik angepackt. Betroffene Unternehmen gehen damit erhebliche Risiken bezüglich Sicherheit, Compliance oder Kreditvergabe ein», heisst es dazu auf https://www.computerwoche.de/a/in-drei-schritten-zur-perfekten-it-dokumentation,3330585.
Beugen Sie also nicht nur dem Chaos im Falle eines Ausfalls Ihrer IT vor, sondern sparen Sie Zeit und somit Kosten, indem Sie Ihre IT-Infrastruktur erfassen, dokumentieren und idealer Weise mittels How-Tos und Best Practices erklären. Dies dient nicht nur der Übersicht des IT-Verantwortlichen oder der flinkeren Einarbeitung neuer KollegInnen. Auch Sie selbst werden sich im Zweifelsfall nicht mehr daran erinnern, an welcher Stelle eine Lizenz abgelegt war oder wie Sie die VLANs in einem bestimmten Switch angelegt haben, wenn erst einmal ein paar Wochen, Monate oder Jahre verstrichen sind. Mit einer guten IT-Dokumentation haben Sie solche Informationen jederzeit im Zugriff. Aber Achtung: Halten Sie ein solches System aktuell, ansonsten wird es natürlich über kurz oder lang wertlos.
Passende Produkt-Empfehlungen
Grunderfordernisse einer IT-Dokumentation
- Allgemeine Zugänglichkeit der IT-Dokumentation: Es nutzt wenig, wenn die Dokumentation lokal auf dem Laptop des IT-Administrators oder des Abteilungsleiters der EDV abgelegt ist. Ein solches Vorgehen sichert weder eine ständige Erreichbarkeit – und diese wird üblicherweise im Notfall wichtig, wenn das Medium gerade nicht zugänglich ist – noch entspricht es den Anforderungen an Sicherheit und Hochverfügbarkeit. Bestenfalls eine schnelle Wiederherstellbarkeit mag gewährleistet sein, wenn der Besitzer des Laptops eine Sicherung seiner Daten oder idealer Weise seines gesamten Systems verfügbar hat.
- Absicherung gegen unbefugten Zugriff: Der Autor hat in seiner langjährigen IT-Praxis manch haarsträubendes Szenario erlebt, was die Sicherheit nicht nur eines Dokumentations-Systems angeht. Nicht wenige unserer Kunden bedienen sich eines Dokumentations-Systems sogar zur Verwahrung der Passwörter. Um hochsensible Daten wie Passwörter in einem solchen System aufzubewahren, bedarf es schon einer ganzen Reihe vorgeschalteter Sicherungsmechanismen. Verschlüsselte Übertragung der Zugänge beim Login und der Nutzdaten sollten ebenso selbstverständlich sein wie ein Zugriffskontrollmechanismus etwa über Mehrfaktorauthentifizierung (2FA / MFA).
- Leichte und betriebssystemunabhängige Zugänglichkeit: In den 90er Jahren des vergangenen Jahrhunderts (oder sollten wir besser Jahrtausend sagen?) gab es ein beliebtes System namens CueCards, mit dem seinerzeit gerne IT-Dokumentation in einer Art Karteikartensystem erfasst wurden – und CueCards gibt es tatsächlich immer noch. Was aber, wenn inzwischen niemand mehr das inzwischen vielleicht nicht mehr erhältliche Dokumentationsprogramm abgespeichert hat, oder wenn kein PC-System aus jener Zeit mehr zur Verfügung steht? Wenn eine Konvertierung der alten Dokumentationsdaten nicht mehr möglich ist? Hier ist es auf jeden Fall ratsam, sich an offene und bewährte Standards zu halten wie etwa HTML-Seiten und einfache Textdateien. Im Gegensatz zur Vorhaltung der Dokumentation in einem Datenbankformat ist auch nicht gleich die gesamte Dokumentation unbrauchbar, falls ein gewisser Teil der Daten nicht mehr zugänglich ist. Bereits wenige defekte Blöcke auf der Festplatte oder sogar dem Sicherungsband einer komprimierten Datenbank können das gesamte System unbrauchbar machen. Hat man die Daten in mehreren HTML-Seiten oder in Textdateien abgelegt, ist man eher auf der sicheren Seite.
- Einfache und transparente Einrichtung und ebensolcher Betrieb: Das Prinzip Keep It Simple and Stupid (KISS) könnte hier als Maxime gelten – ein einfaches, selbst gebautes und gut dokumentiertes Dokumentations-System sollte unnötige Komplexität vermeiden und auch von dem hinzugekommenen Administrator oder externen Dienstleister verstanden und bedient werden können.
- Wer auf eine proprietäre Lösung – im Klartext also ein zugekauftes oder zumindest von Dritten entwickeltes und unterstütztes System zugreifen möchte, sollte auf gute Erreichbarkeit des Anbieters und laufende Produktpflege achten.
- Eine Volltextsuche sollte in einem Dokumentations-System selbstverständlich sein, ebenso wie eine klare Hierarchisierung und Gliederung.
Ziehen wir die Quintessenz aus diesem Forderungskatalog. Ein Dokumentations-System sollte auf einem bestehenden, zentralen System im Unternehmen betrieben werden, auf offenen Standards beruhen, ausbaubar und erweiterbar sein und einen sicheren Zugriff gewähren – letzterer Punkt schliesst auch die Regelung unterschiedlicher Zugriffsrechte ein.
Eine gute IT-Dokumentations-Lösung ist Server- und (idealer Weise) Webbasiert. Sie können darauf dann unabhängig vom Client zugreifen, ganz gleich, ob es sich um eine System mit Windows 10 oder 11, Mac OS X, Linux oder iPhone und Android handelt.
Zuguterletzt sollten Sie bei der Auswahl eines solchen Systems entscheiden, ob es sich um eine manuell gepflegte Dokumentation handeln soll oder um ein automatisiert erstelltes.
Einige Beispiele für IT-Dokumentations-Systeme:
- Wikis / Dokuwiki: Sie kennen es mit einiger Wahrscheinlichkeit aus der täglichen oder auch nur angelegentlichen Recherche im Internet – dabei sind Sie nämlich bestimmt schon auf Wikipedia gestossen – das sicher Bekannteste der so genannten Wiki-Systeme. Der Begriff Wiki stammt übrigens mitnichten von dort – wenngleich dies durch die heutige Dominanz des Wikipedias so scheinen könnte. Der hawaiianische Begriff Wiki steht nicht nur für den Begriff schnell (von einem WikiWiki ist gelegentlich ebenfalls zu hören und lesen). Ein Wiki ist «ein Hypertext-System für Webseiten, dessen Inhalte von den Benutzern nicht nur gelesen, sondern auch online direkt im Browser geändert werden können. Diese Eigenschaft wird durch ein vereinfachtes Content-Management-System, die sogenannte Wiki-Software oder Wiki-Engine, bereitgestellt. Zum Bearbeiten der Inhalte wird meist eine einfach zu erlernende Auszeichnungssprache verwendet. Eine bekannte Anwendung ist die Online-Enzyklopädie Wikipedia, welche die Wiki-Software MediaWiki einsetzt.» (zit. n. www.de.wikipedia.org).
Da es sich bei Wikisystemen in der Regel um offene (im Sinne des Software-Lizenz-Modells), serverbasierte und per Webbrowser erreichbare Systeme handelt, können Sie einfach Ihr eigenes Wiki für Ihre IT-Dokumentationen aufsetzen.
Nachteile sind in der manuellen Pflege und fehlenden Automatismen für die Erfassung Ihrer Systeme zu sehe. Hier müsste also auf weitere Werkzeuge zurückgegriffen werden - DocuSnap ist ein leistungsfähiges IT-Dokumentations-System. Es inventarisiert nicht nur die IT-Infrastruktur einschliesslich Servern, Routern, Switches und so weiter, sondern erstellt daraus Übersichten und Quasi-Dokumentationen. Auch der Status von Lizenzen kann abgefragt werden. Dieser Vorteil der Automatisierung ist zugleich der grösste Nachteil: Eine Art «HowTo» für neue Kollegen oder Best Practices als Praxisanleitungen für den IT-Alltag müssen nach wie vor selbst erstellt werden.
DocuSnap ist kostenpflichtig, der Preis richtet sich nach der Anzahl der zu erfassenden Systeme. Es gibt eine zeitlich begrenzte Testversion. - LOGINventory bietet ebenfalls – neben der Hardware- und Software-Inventarisierung eine Lizenzverwaltung. Die kostenlose Testversion ist zeitlich unbegrenzt und mit vollem Funktionsumfang nutzbar, erfasst allerdings nur 20 Geräte.
- JDisc Discovery bietet ebenfalls eine Inventarisierung des Netzwerks und ist zudem in der Grundversion kostenlos zu nutzen. Erst für erweiterte Funktionalitäten wie eine Erfassung der Netzwerktopologie und so fort ist die kostenpflichtige Professional-Version nötig.
- Einige HelpDesk-, Ticketing- und teilweise auch ERP- oder CMS-Systeme bieten eine Inventarisierung und Dokumentation als Teil des Gesamtpakets an. Als Beispiele seien hier ManageEngine oder Zammad genannt.
Diese Auswahl ist selbstverständlich weder als Wertung noch als vollständige Auflistung anzusehen. Es sollte aber deutlich geworden sein, dass eine automatisierte Erfassung Ihrer IT Sie nicht von der Aufgabe entbindet, Informationen «zwischen den Zeilen», Anleitungen und Best Practices manuell zu pflegen. Ebenso ist aber auch erkennbar, dass vor der Dokumentation die Inventarisierung und somit Visualisierung ansteht.
Netzwerk visualisieren
Die «halbe Miete» bei der IT-Dokumentation ist die Erfassung der vorhandenen Systeme. Schöner klingt es noch, wenn man von Visualisierung des Netzwerks redet.
Nun müssen Sie sich nicht mit Kamera, Notizblock und Bleistift auf den Weg durch Ihr Firmennetzwerk begeben, um dieses zu visualisieren - dafür gibt es natürlich entsprechende Programme. Diese fragen in der Regel mit einfachen Netzwerktools wie Ping, Traceroute und Portscans die Systeme und Knotenpunkte in einem LAN ab und erstellen daraus entweder Datenlisten zur Weiterverarbeitung (beispielsweise CSV für den Import in Excel; Grafiken, Textdateien usw.) oder gleich eigene Berichte und Übersichten. Sie finden so etwas, wenn Sie nach Werkzeugen für “Netzwerkvisualisierung”, “IT-Dokumentationen” oder “Netzwerk Mapping” suchen.
Dabei müssen Sie unterscheiden zwischen:
- Einer reinen Auflistung Ihrer Assets (Geräte), eventuell auch Lizenzen
- Einem Netzwerkplan
Idealer Weise bietet ein gutes IT-Dokumentations-System beides.
Einige Beispiele:
- Das erwähnte DocuSnap inventarisiert das gesamte Netzwerk einschliesslich Mac-Systemen und kann sogar die Informationen aus einem Microsoft Active Directory abfragen
- Fing bietet eine automatische Erfassung von Netzwerk-Konfigurationen und Betriebssystemen und erstellt eine ansprechende Grafik. Das kleine Helferlein läuft übrigens auch auf iPhone und iPad als App.
- Mit dem OpenSource-Tool Netdisco lässt sich nicht nur das gesamte Netzwerk scannen und dokumentieren, sondern sogar anzeigen, welches Endgerät an welchem Switchport in welchem VLAN angeschlossen ist. VLANs sind übrigens virtuelle LANs - siehe dazu an der entsprechenden Stelle in diesem Portal.
- WhatsupGold von IpSwitch bietet neben einer Inventarisierung und Visualisierung des Netzwerks auch die Möglichkeit zu dessen Überwachung.
- NagVis visualisiert umgekehrt Daten, die die Netzwerkmonitoringprogramme Nagios und Icinga gesammelt haben.
Wie Sie sehen, gibt es viele Überschneidungen zwischen den Gebieten «Dokumentation», «Inventarisierung», «Visualisierung» und «Monitoring».
IT-Dokumentation auch in Cloudlösungen!
Apropos Monitoring: Falls Sie meinen, dass das gesamte Themenfeld «IT-Dokumentation» samt Inventarisierung und Erfassung Sie nicht zu kümmern braucht, weil Sie mit Ihrer IT inzwischen ja in die (Microsoft / Amazon / Google usw.) Cloud gewechselt sind, sollten Sie einmal einen Blick auf Azure Monitor werfen. Dieses Werkzeug von Microsoft erfasst und visualisiert die virtuellen Systeme in Ihrem Azure/Entra, Sharepoint, virtuellem Switching und so fort. Dabei bietet es ebenfalls ein Monitoring, anhand dessen Sie etwaige Probleme und Schwachstellen aufdecken und eingrenzen (und am besten beheben) können. Denn der Cloudanbieter nimmt Ihnen zwar die Sorgen über Hardware, Stromversorgung, Kühlung, gegebenenfalls Updates und so fort ab – aber eine fertige Dokumentation dürfen Sie vom Cloudanbieter nicht erwarten. Ebenso wie die Ausgestaltung der virtuellen Ressourcen und je nach IaaS, SaaS- oder PaaS-Modell die Lizenzierung obliegt eine solche Aufgabe Ihnen. Ein adäquates Tool zur Erfassung, Dokumentation und dem Monitoring Ihrer Clouddienste ist hier ebenso wichtig wie beim Betrieb «OnPremise», also auf eigener Hardware lokal in Ihrem Unternehmen.
Und weshalb nicht ein «Bordmittel» wie Azure Monitor mit einer Cloudmonitoring wie DataDog und einem DokuWiki für die verständliche Aufbereitung der Informationen kombinieren?
Fazit
Das Thema IT-Dokumentation umfasst die Erfassung und Beschreibung möglichst sämtlicher physikalischer und logischer Systeme, Leitungswege und Lizenzen in einem Netzwerk. So wie ein guter Kapitän laufend Überblick über sein Schiff und seine Mannschaft und den eingehaltenen Kurs haben muss, sollten auch Sie als Administrator und IT-Verantwortliche/r dieses Thema obenan stellen – auch wenn es vielleicht nicht so aufregend und «in» ist. Spätestens im Falle eines Ausfalls zeigt sich der Wert einer guten und aktuell gehaltenen IT-Dokumentation.
