Wissenswertes

WISSEN KOMPAKT

IT-Dokumentation – Was ist das?

IT-Dokumentaion - Was ist das?

Auf unserer Website dreht sich alles um das Thema IT-Dokumentation. Doch was ist eigentlich eine IT-Dokumentation? Welche Themen und welche Dokumente können bzw. sollten ihr zugeordnet werden – und welche nicht? Und worin unterscheidet sich die IT-Dokumentation von anderen Dokumentationen?

Auch wenn die IT-Dokumentation sich als Management-Baustein längst etabliert hat, wird diese Frage, wie das Google-Ranking zeigt, immer noch häufig aufgerufen. Und da sich die Welt IT-Welt ständig weiterdreht, ist es wieder einmal Zeit für ein Update. Zum einen sind die Anforderungen an die IT-Organisationen und damit auch an die Dokumentation in allen Bereichen in den letzten Jahren immens gewachsen. Hierzu tragen insbesondere die neuen Datenschutzanforderungen, aber auch die ständig steigende Bedrohungslage bei. Zum anderen ist die IT in immer stärkerem Maße in die Geschäftsprozesse integriert, wodurch auch die Fachbereiche zunehmend in IT-technische Themen eingebunden sind. Aber müssen diese Themenbereiche bei der IT-Dokumentation berücksichtigt werden und wer legt das fest? Und da weder der Duden, noch Wikipedia oder andere Lexika eine Definition liefern, wundert es nicht, dass fast jeder im IT-Umfeld bei diesem Thema ein anderes Bild im Kopf hat. 

Unterschiedliche Anforderungen der Nutzergruppen 

Wenn mich ein Unternehmen zu einem Beratungsgespräch einlädt, bei dem es um die Optimierung „der IT-Dokumentation“ geht, ist es mir immer wichtig, dass Vertreter aus möglichst vielen IT-Bereichen und mit unterschiedlichen Funktionen dabei sind. Denn nur so ist es möglich ein gemeinsames Verständnis für die IT-Dokumentation zu entwickeln. Naturgemäß hat jeder Bereich eigene Dokumentationsanforderungen. Während für die mit dem Systembetrieb betrauten Administratoren möglichst individuell zusammenstellbare, detaillierte Informationen wichtig sind, benötigen Mitarbeiter im Supportbereich vorgangsbezogene Informationen und Anleitungen. Derartige Informationen wiederum sind für die IT-Leitung, Service Manager oder Revisoren sowie Wirtschaftsprüfer zu granular und damit kaum hilfreich. Letztere müssen sich insbesondere schnell einen Überblick über die vorgegebenen Abläufe und deren korrekte Einhaltung machen können. Dies erfordert eine angemessene Prozess- und Nachweisdokumentation. Und für die Unternehmensleitung müssen die notwendigen Informationen in Reports zusammengefasst werden.

Die in der folgenden Abbildung gezeigten Abhängigkeiten zwischen Detaillierungsgrad und Nutzergruppe machen deutlich, wie wichtig es ist, die Anforderungen der verschiedenen Nutzer der Dokumentation zu berücksichtigen. Und sie zeigt auch, dass die häufig gestellte Frage „Wie detailliert muss man eigentlich dokumentieren“ nicht generell beantwortet werden kann.

Quelle: Manuela Reiss. Dokumentationsmanagement – Basis für IT-Governance – 11 Schritte zur IT-Dokumentation, 2018

Was gehört inhaltlich zur IT-Dokumentation?

Bevor aber über notwendige Dokumente und deren Detaillierungsgrad, Dokumentenablagen oder gar die Anschaffung von Tools nachgedacht wird, ist es wichtig den Scope der Dokumentation festzulegen und zu beschreiben. Denn die verschiedenen Nutzergruppen haben auch inhaltlich völlig unterschiedliche Anforderungen. In der Praxis wird die IT-Dokumentation vielfach noch immer mit der Dokumentation der IT-Systeme und der Infrastruktur gleichgesetzt und auf diese beschränkt. Eine solche Systemdokumentation ist zwar ein wesentlicher Teil, daneben gibt es aber eine Reihe von IT-bezogenen Aufgabenbereichen, die ebenfalls eine anforderungsgerechte Dokumentation erfordern. Störungsmanagement, Changemanagement, Anwendungsbetrieb, Informationssicherheitsmanagement, IT-Risikomanagement und IT-Notfallmanagement sind dabei nur einige Aufgabenfelder und die ebenfalls einbezogen werden müssen.

Die Schwierigkeit vieler IT-Organisationen mit der Dokumentation ist aber genau darin begründet, dass eine ganzheitliche Betrachtung fehlt. Zwar stellen sich heute viele IT-Bereiche organisatorisch neu auf oder haben dies bereits getan, die Dokumentation aber entspricht immer noch den historisch gewachsenen Strukturen und häufig sind nur Insellösungen vorhanden. Bei einer Reorganisation der Dokumentation kommt erschwerend hinzu, dass es keine allgemeingültigen Regelungen oder gar Standards für die IT-Dokumentation gibt. Mit dem nachstehenden Struktierungsansatz, möchten wir dazu eine Hilfestellung geben,

Referenzstruktur für die IT-Dokumentation

Welche Bereiche sind bei uns im Scope und wer ist für die Dokumentation der jeweiligen Bereiche verantwortlich? Gerade bei der IT-Dokumentation ist die Frage der Verantwortlichkeiten nicht leicht zu beantworten, da es eine Reihe von Schnittstellen gibt, unter anderem zu den Fachbereichen, zum Informationssicherheitsmanagement, zum Datenschutz und zum Notfallmanagement.

Anwendungen etwas müssen während des gesamten Lebenszyklus entsprechend dokumentiert werden. Aus Sicht der Dokumentation stellen hier insbesondere die Schnittstellen eine Herausforderung dar. Denn während die IT-Organisation für den technischen Betrieb der Anwendungen zuständig ist, fallen die Bereiche Design, Entwicklung und Test meist in den Verantwortungsbereich der Entwicklung, die häufig außerhalb der IT angesiedelt ist. Die Anforderungen für die Entwicklung müssen zudem zuvor von den Fachbereichen definiert und beschrieben werden.

In dem von mir entwickelten Strukturierungsmodell, das in dem im Januar 2018 erschienenen Fachbuch ‚Dokumentationsmanagement – Basis für IT-Governance‚ vorgestellt wird, nimmt die Beantwortung der o.g. Fragen viel Raum ein. Denn erst, wenn diese geklärt sind, kann eine ganzheitliche Struktur entwickelt, die erforderlichen Dokumente ermittelt und die notwendigen Dokumentationsverfahren festgelegt werden. Bewährt hat sich dabei eine Unterscheidung der Dokumentation in zwei IT-bezogene Bereiche:

  • Dokumentation für das IT-Management: Das Management ist für die Steuerung des operativen IT-Betriebs verantwortlich und definiert für diesen die Vorgaben. Typische IT-Managementbereiche sind IT-Strategie, Architekturmanagement, Sicherheitsmanagement, IT-Servicemanagement, Risikomanagement und andere.
  • Dokumentation für den operativen IT-Betrieb: Hierzu zählen gemäß unserem Modell – abhängig von der unternehmensspezifischen Ausprägung – die Bereiche Infrastruktur- und Systemtrieb, Infrastrukturprojekte, Service- und Anwendungsbetrieb und ggf. auch die Anwendungsentwicklung.
Referenstrukur für die IT-Dokumentation – Dokumentationsfelder aus Sicht der IT-Organisation

Sind alle Aufgaben- und damit Dokumentationsbereiche einschließlich der Schnittstellen identifiziert, können Themen wie Strukturierung und Klassifizierung der IT-Dokumentation angegangen werden. Erläuterungen hierzu finden Sie im Beitrag IT-Dokumentation im Griff – eine Dokumentenmatrix hilft dabei. Hilfreich ist es, die identifizierten Aufgabenbereiche grafisch oder tabellarisch darzustellen und den aktuellen und ggf. zukünftigen Dokumentenablagen und Tools zuzuordnen. Derartige Ist- / Sollpläne sind auch ein gutes Werkzeug für die Evaluierung von neuen Dokumentationstools und können die Schaffung von Insellösungen verhindern.

Bleibt die Frage: Was ist eine IT-Dokumentation?

Gemäß unserem Glossar ist eine Dokumentation eine Zusammenstellung von Dokumenten bzw. dokumentierten Informationen zu einem definierten Sachverhalt in beliebiger Art und auf jeglichem Medium als Ergebnis von Dokumentationstätigkeiten. Das klingt zuzugeben sehr theoretisch. Einfach ausgedrückt umfasst die IT-Dokumentation alle Dokumente, die mit Bezug zur IT erstellt werden. Schwieriger ist es jedoch, wie auch der Beitrag zeigt, den Scope der IT-Dokumentation festzulegen. Denn die alleinige Beschränkung auf die Organisationseinheit IT ist nicht immer praxistauglich und muss daher unternehmensspezifisch festgelegt werden.

Die Analyse der Dokumentation und die Entwicklung eines Konzepts zur Strukturierung der Dokumentation und Klassifizierung von Dokumenten gehört deshalb zu meinen wichtigsten Beratungsaufgaben. Dies schließt auch die eingesetzten Tools und Werkzeuge für den IT-Betrieb und die Dokumentation mit ein. Denn auch wenn bei einer Reorganisation der Dokumentation die Frage nach Tools nicht an erster Stelle stehen sollte, sind diese zwingend in die Analyse mit einzubeziehen. Im Beitrag Das richtige Dokumentationstool finden gehen wir darauf ausführlicher ein.

Auf Basis dieses Konzepts können dann Maßnahmen identifiziert und Aufgabenpakete geplant werden.

Gut zu wissen: Im Bereich Services auf dieser Website finden Sie ausführliche Informationen zu unserer Vorgehensweise – von der Analyse und Konzeption über die Umsetzung bis hin zur langfristigen Unterstützung).


Manuela Reiss dokuit®

Scroll to Top