Zum Inhalt

Wie beginne ich zu dokumentieren?#

Häufig erreichen uns diese oder ähnliche Fragen:

  • Wenn ich noch gar keine IT Dokumentation habe: Wie starte ich am besten?
  • Wie kleinteilig soll ich beginnen?
  • Welchen Bereich bilde ich als erstes ab: Clients und Server? Gebäude und Räume? Das Netzwerk?
  • Wie viele Kategorien muss ich befüllen, damit ich einen guten Überblick habe?
  • …

Wer sich intensiv mit dem Thema IT-Dokumentation beschäftigt, wird schnell erkennen, dass hier wie fast überall gilt: Aller Anfang ist schwer. In diesem Artikel möchten wir herausarbeiten, was die Ursachen für diese Fragen sind und wie wir diese im Optimalfall beantworten können.

Schauen Sie sich auch unsere Whitepaper an.

Kenne Deine Anforderungen#

Sich mit dem Thema IT-Dokumentation zu beschäftigen, kommt nicht von ungefähr und ist auch kein Selbstläufer ("dokumentieren um zu dokumentieren"): Entweder stammt die Anforderung, eine IT-Dokumentation in der IT-Organisation zu etablieren, aus der IT selbst, sie stammt von höherer Instanz oder von außen (Neudeutsch: Compliance). Bevor man sich mit Tools wie i-doit beschäftigt, sollte klar kommuniziert sein, was denn die Ziele sind, die mit einer IT-Dokumentation erreicht oder unterstützt werden sollen. Haben die Administratoren den Überblick über die Infrastruktur verloren? Möchte das höhere Management (IT-)Services definieren, die intern den Fachbereichen und/oder extern den Kunden angeboten werden? Gibt es Gesetze/Normen/Richtlinien, die eine IT-Dokumentation vorschreiben?

Dabei spricht man von unterschiedlichen Ansätzen: Top Down beschreibt, dass die Anforderungen von oben herab gestellt werden. Dem folgt dann auch die Dokumentation: Bevor es ins Detail von einzelnen IT-Komponenten geht, wird erst einmal das große Ganze skizziert. Bottom Up ist das Gegenstück: Auf der Basis einer detaillierten Infrastruktur lassen sich Services modellieren, Wartungsverträge zuordnen oder Notfallpläne erstellen. Doch teilweise strömen die Anforderungen von allen Seiten gleichzeitig. Bevor also auch nur eine IP-Adresse dokumentiert oder eine Server-Spezifikation ausgelesen wird, sollten diese Strömungen kanalisiert und in wohlbedachte Formen gebracht werden.

Kenne Deine Anwender#

Eine der wichtigsten Fragen lautet: Wer arbeitet mit der IT-Dokumentation? Wer zieht einen Nutzen daraus? Bei kleinen wie größeren IT-Organisationen ist es sinnvoll, ein Dokumentations-Team zusammenzustellen, welches alle Dinge rund um das Thema gemeinschaftlich behandelt. Häufig gehört zu diesem Team ein Dokumentations-Manager sprich eine Person, die alle Prozesse rund um die IT-Dokumentation koordiniert. Zudem gibt es meist aus den Reihen der leitenden Positionen eine Person, die als Sponsor agiert. Sie sorgt dafür, dass genügend Ressourcen (Zeit und Geld) zur Verfügung stehen, um das Projekt zur Einführung einer IT-Dokumentation zum Erfolg zu führen. Zudem wird es verschiedene Akteure geben, die die IT-Dokumentation aktiv mitgestalten oder passiv für eigene Zwecke verwenden.

Kenne Deine bisherige Dokumentation#

Der Beginn auf der grünen (Dokumentations-)Wiese tritt in den seltesten Fällen auf. Ca. 100 Prozent unserer Kunden (grobe Schätzung) benutzen das Konkurrenzprodukt zu i-doit namens Excel. Listen von IP-Adressen, Liste von Räumen und Kontakten, Rack-Pläne … wir haben alles schon in zweidimensionaler Form dokumentiert gesehen. Zudem gibt es eventuell andere spezialisierte Tools, die die bisherige ITSM-Landschaft bilden. Sollen diese von i-doit abgelöst werden? Können dort gesammelte Daten wiederverwendet werden? Gibt es Exporte oder Schnittstellen? Daten-Integration ist ein wichtiges Stichwort.

Eine Entscheidung ist dabei immer zu treffen: Werden die Daten manuell erfasst oder kann dieser Prozess automatisiert werden?

Kenne Deine IT#

Beginnen wir mit einem Zitat:

Man sieht nur, was man weiß.

Erkannt? Richtig, es stammt von Johann Wolfgang von Goethe. Konkret auf diesen Artikel bedeutet dies, dass es der Administration und dem Management schwer fallen wird, ohne aktuelle und ausreichend detaillierte Dokumentation den Gesamtüberblick über die IT-Infrastruktur zu bewahren.

Hierbei gilt es, den Bogen zwischen Detailreichtum und Abstraktion zu spannen. Wenn es um ein neue Information geht, die in die IT-Dokumentation einfließen könnte, stelle Dir folgende Frage: Welchen Nutzen ziehst Du daraus, dass diese Information festgehalten und gepflegt wird sowie anderen zur Verfügung steht? Eine zu detailierte Dokumentation birgt die Gefahr, dass die Dokumentation "erschlagend" wirkt und unbenutzbar erscheint. Muss jedes Kabel im Rechenzentrum inklusive Länge und Farbe erfasst werden? Oder reicht es, die Port-Verbindungen zwischen aktiven Netzwerk-Komponenten zu erfassen?

Viele unserer Kunden beginnen damit, Standorte (Gebäude, Räume, Racks) zu erfassen, um daraufhin Server- und Netzwerk-Infrastrukturen abzubilden. Danach geht es schnell in unterschiedliches Wege: Software und Services, Clients und Arbeitsplätze, passive Komponenten (Patchpanels und Kabel).

Ergo: Jedes Projekt hat einen definierten Anfang und ein definiertes Ende. Innerhalb dessen kann und sollte es Meilensteine geben, die in realistischer Form erreichbar sind. Dies gilt selbstverständlich auch für die Einführung einer IT-Dokumentation: Was erhält eine hohe Priorität, was eine eher niedrigere?

Kenne Deine Prozesse#

Eine IT-Dokumentation ist nur dann nachhaltig, wenn sie stets aktuell gehalten wird und tief in die Arbeitsprozesse der Mitarbeiter verankert ist. Nur was aktuell ist, ist auch nützlich. Veraltete oder falsche Informationen sind tunlichst zu vermeiden. Bevor der "Schalter umgelegt" und eine IT-Dokumentation "live" in den Produktivbetrieb geht, sollten alle relevanten Prozesse identifiziert werden, in denen die IT-Dokumentation eine Rolle spielt. Ein Beispiel: Wird i-doit in den kompletten Lebenszyklus einer IT-Komponente von der Planung, über Anschaffung, Inbetriebnahme bis hin zur Ausmusterung einbezogen, so hat das für viele Prozesse (und andere Tools) wesentliche Auswirkungen. Hierbei sprechen wir von einem "führenden" System.

Nimm Dir Zeit#

Eine IT-Dokumentation beginnt man nicht morgen und ist übermorgen fertig. Es braucht Zeit, die Fragen zu beantworten, wer wann was wie dokumentiert. Bis die IT-Dokumentation in den Regelbetrieb überführt wird, kann es bei kleinen Organisationen schneller gehen, bei größeren länger dauern. Einige Wochen und Monate sind keine Seltenheit. Zu beachten und vielfach bekannt ist das magische Dreieck aus dem Projektmanagement: Kosten, Qualität und Zeit sind die Eckpunkte. Innerhalb des Dreicks befindet sich das Projekt. Nun darf der Projektmanager entscheiden, welche beiden Ecken erreicht werden sollen. Alle drei gleichzeitig zu erreichen, ist oftmals schwer bis unmöglich. Unser Vorschlag: am Anfang nicht die 100-Prozent-Marke anstreben, sondern vielleicht nur 80 Prozent, dafür aber qualitativ hochwertig.

Dokumentiere Deine Dokumentation#

Es führt kein Weg daran vorbei, die Dinge festzuhalten, die für eine IT-Dokumentation wichtig sind: Wie ist die IT-Dokumentation designt? Welche Prozesse sind definiert? Hierfür bietet es sich an, neben i-doit ein Wiki mit ebendiesen Informationen zu pflegen. Glücklicherweise ist ein Wiki oder ein Dokumentenmanagementsystem in der Regel bereits vorhanden und kann hierfür genutzt werden.

Schaue über den Tellerrand#

Wer Inspiration sucht oder auf bestehende Erfahrungen zurückgreifen möchte, muss nicht lange suchen. Wir bieten neben regionalen Anwendertreffen und überregionaler Anwenderkonferenz viele Anlaufstellen, um sich rund um i-doit und IT-Dokumentation auszutauschen.

Oder wenn ein starker (Dienstleistungs-)Partner gefordert ist, bieten wir und unsere Partner unter anderem Workshops und Pakete an, die für die Anfangsphase mit i-doit ideal geeignet sind.

Fazit#

"Und wo fange ich nun an?" Die Beantwortung dieser Frage ist gar nicht so leicht. Ansonsten hätten wir uns die Länge dieses Artikels sparen können.

Vielmehr hängt es von vielen, vielen Faktoren ab, die hier mit reinspielen. Jede IT-Organisation und -Infrastruktur sieht anders aus und unterliegt einer gehörigen Dynamik. Eine pauschale Antwort ist somit schlicht nicht möglich. Es ist und bleibt eine individuelle Angelegenheit, eine IT-Dokumentation einzuführen. Sprich uns an. Wir helfen gerne weiter!