Workshop: IT-Dokumentation mit dem freien Werkzeug Docear

Besser durchs IT-Labyrinth

Jeder IT-Verantwortliche weiß: Eine maßgeschneiderte Dokumentation ist ein Muss für den sicheren Rechenzentrumsbetrieb. Dabei ist es wichtig, dass alle wesentlichen Komponenten und durchgeführten Aktionen beschrieben sind. Das gilt natürlich insbesondere für Änderungen und Aktualisierungen. Nur so ist im Falle eines Falles auch für Dritte nachvollziehbar, wie eine Umgebung strukturiert ist. Und bei einer Auditierung gilt die erste Frage immer der Dokumentation, denn ohne entsprechende Unterlagen ist kein sicherer und kontinuierlicher Betrieb zu gewährleisten. Admins haben im Alltag allerdings wenig Vergnügen an derlei Aufgaben. Dabei lässt sich all das mit wenig Aufwand erledigen, wenn der richtige Helfer zum Einsatz kommt. Die freie Software Docear ist für das Abbilden komplexer Zusammenhänge und somit der IT-Dokumentation bestens geeignet.
In der Juni-Ausgabe des IT-Administrator dreht sich alles um den Schwerpunkt 'Monitoring & Dokumentation'. So zeigen wir Ihnen, wie die Netzwerküberwachung in ... (mehr)

Den Grundstock einer soliden Dokumentation bildet die Beschreibung des Sicherheits- und Verfügbarkeitskonzepts. Diese sollte spätestens bei der Inbetriebnahme um relevante Schemen, Zeichnungen und Funktionsbeschreibungen ergänzt werden. Unternehmen tun gut daran, ein Betriebshandbuch mit Regeln für den täglichen Betrieb, eine Zugangsregelung und ein Notfallhandbuch mit Anweisungen für Störfälle anzulegen. Diese Basisdokumentation sollte um Wartungs- und Instandhaltungshandbücher ergänzt werden – ähnlich dem Scheckheft für Autos.

Mit Docear dokumentieren

Doch wie geht der IT-Verantwortliche diese Problematik am besten an? Oftmals kommen Tabellen oder Datenbanken für die Dokumentation zum Einsatz. Andere Administratoren setzen auf Diagrammwerkzeuge wie Visio, die ihre Stärken in der Visualisierung von Strukturen haben. Inventarwerkzeuge stellen oftmals simple Dokumentationsfunktionen zur Verfügung, scheitern aber meist an der Ergänzung und Verknüpfung mit Drittdaten.

Docear [1] basiert auf dem FreeMind-Fork Freeplane und wird aktuell durch Mittel des Bundesministeriums für Wirtschaft und Technologie gefördert. Als Mindmapping-Programm ist es hervorragend geeignet, um die verschiedensten Informationen in eine sinnvolle Struktur zu bringen. Docear verwendet dabei Knoten, um eine hierarchische Struktur zu erstellen – ähnlich einem Baumdiagramm. Doch im Unterschied zu nackten Diagrammen können Sie in Docear beliebige Inhalte mit einem Knoten verknüpfen. Sie können bestehende Dokumente, Skizzen, Abbildungen et cetera mit diesen Strukturelementen verbinden. Besondere Stärken zeigt Docear bei der Verwendung von PDF-Dokumenten. Sie können in Docear sogar Ordner anlegen, die auf neue Dokumente hin überwacht werden.

Dokumentationen entstehen ja nicht zum Selbstzweck, sondern müssen durchsuchbar sein. Auch hierfür stellt Ihnen Docear umfangreiche Recherche- und

...

Der komplette Artikel ist nur für Abonnenten des ADMIN Archiv-Abos verfügbar.

comments powered by Disqus

Artikel der Woche

Eigene Registry für Docker-Images

Wer selber Docker-Images herstellt, braucht auch eine eigene Registry. Diese gibt es ebenfalls als Docker-Image, aber nur mit eingeschränkter Funktionalität. Mit einem Auth-Server wird daraus ein brauchbares Repository für Images. (mehr)
Einmal pro Woche aktuelle News, kostenlose Artikel und nützliche ADMIN-Tipps.
Ich habe die Datenschutzerklärung gelesen und bin einverstanden.

Konfigurationsmanagement

Ich konfiguriere meine Server

  • von Hand
  • mit eigenen Skripts
  • mit Puppet
  • mit Ansible
  • mit Saltstack
  • mit Chef
  • mit CFengine
  • mit dem Nix-System
  • mit Containern
  • mit anderer Konfigurationsmanagement-Software

Ausgabe /2020