Praxisbuch IT-Dokumentation - Vom Betriebshandbuch bis zum Dokumentationsmanagement - die Dokumentation im Griff

Manuela Reiss, Georg Reiss

Praxisbuch IT-Dokumentation

Vom Betriebshandbuch bis zum Dokumentationsmanagement - die Dokumentation im Griff

2018

472 Seiten

Format: PDF, ePUB

E-Book: €  49,99

E-Book kaufen

E-Book kaufen

ISBN: 9783446457362

 

1 IT-Dokumentation – was ist das?
1.1 Zusammenfassung

Der Begriff IT-Dokumentation klingt zunächst recht einfach, wird aber immer komplizierter, je näher man sich damit beschäftigt. So stellen die verschiedenen Nutzergruppen vom Systembetreuer oder Softwareentwickler bis zum IT-Management oder Auditor mit ihren unterschiedlichen Sichtweisen auf die Dokumentation auch sehr unterschiedliche Anforderungen. Daraus leiten sich dann auch unterschiedliche Strukturierungsansätze für die IT-Dokumentation ab, von der themenbezogenen über die aufbauorganisationsbezogene bis zur managementbezogenen Strukturierung.

Die im Buch verwendete Dokumentationsstruktur aus Sicht des Managements hat sich aus der jahrelangen Praxiserfahrung in den verschiedenen IT-Organisationen aus vielen Unternehmensbranchen ergeben. Danach wird die IT-Dokumentation in einen Managementteil und in einen operativen Teil (IT-Betrieb) gefasst. Gemäß der Ausrichtung des Buchs liegt der Fokus auf dem IT-Betrieb, wenn auch dem Managementteil ein eigenes Kapitel gewidmet wird. Der operative Teil wird dann in drei Teile weiter strukturiert; den für den System-/Infrastrukturbetrieb, den Anwendungsbetrieb und -entwicklung sowie Querschnittsaufgaben, die vom Management bis in den operativen IT-Betrieb reichen. Das sind Sicherheitsthemen sowie das Notfallmanagement.

1.2 Nutzergruppen und deren Anforderungen an die Dokumentation

Die Anforderungen an die Dokumentation sind in allen Bereichen in den letzten Jahren stark angewachsen. So ist es immer wichtiger, nicht nur die Vorgaben zu dokumentieren, sondern insbesondere auch eine angemessene Nachweisdokumentation zu pflegen. Dies wirft unweigerlich auch Fragen nach den Verantwortlichkeiten und Zuständigkeiten für die Dokumentation auf.

Zusätzlich ist die IT in immer stärkerem Maße in die Geschäftsprozesse integriert, wodurch die Schnittstellen zu den Fachbereichen zunehmen. Auch das macht die Abgrenzung der IT-Dokumentation nicht leichter. Und da weder 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. Aber gibt es überhaupt „die IT-Dokumentation“?

Befragt man Vertreter aus unterschiedlichen IT-Bereichen bzw. mit unterschiedlichen Funktionen, werden schnell die verschiedenen Anforderungen an die Dokumentation deutlich. Während IT-Administratoren möglichst individuell zusammenstellbare, detaillierte Informationen bevorzugen, 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 beispielsweise schnell einen Überblick über die vorgegebenen Abläufe und deren korrekte Einhaltung machen können. Hierfür benötigen sie auf der einen Seite Prozess- und Ablaufdokumente und auf der anderen Seite eine angemessene Nachweisdokumentation.

Definition Funktion

Unter einer Funktion wird im Buch eine logische Zusammenfassung von einem Team oder eine Gruppe von Personen, einschließlich der eingesetzten Hilfsmittel, verstanden, die benötigt werden, um einen oder mehrere Prozesse oder Aktivitäten durchzuführen. Funktionen bilden nicht zwangsläufig organisatorische Strukturen ab. Sie können vielmehr aus einer beliebigen Anzahl von Organisationseinheiten und in beliebiger Konstellation organisiert werden.

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

Bild 1.1 Anforderungen der Nutzergruppen hinsichtlich Detaillierungsgrad. Quelle: Reiss [2018]

1.3 Scoping der IT-Dokumentation

Zusätzlich zu den in Abschnitt 1.2 betrachteten Anforderungen u. a. an den Detaillierungsgrad der Dokumente haben die verschiedenen Nutzergruppen auch inhaltlich völlig unterschiedliche Anforderungen und Zielsetzungen. In der Praxis wird die IT-Dokumentation inhaltlich häufig mit der Dokumentation der IT-Systeme und der Infrastruktur gleichgesetzt und auf diese beschränkt. Eine solche Systemdokumentation ist zwar ein wesentlicher Teil der IT-Dokumentation, die Beschränkung darauf lässt aber eine ganze Reihe von Aufgabenbereichen und deren Dokumentation unberücksichtigt. Schließlich werden beispielsweise für das Störungsmanagement, das Changemanagement, den Anwendungsbetrieb, das Informationssicherheitsmanagement, das IT-Risikomanagement und das IT-Notfallmanagement nicht nur Vorgabedokumente, sondern auch Dokumente für die Umsetzung und Nachweisdokumente benötigt. Und die Einbindung der im Ticketsystem erfassten FAQs und Problemlösungen in die übrige IT-Dokumentation fehlt vielfach, was oftmals zu Redundanzen oder widersprüchlichen Informationen führt und damit letztendlich für keine Nutzergruppe einen Mehrwert bringt.

1.3.1 Mögliche Strukturierungsansätze für die IT-Dokumentation

Die Schwierigkeit beim Aufbau bzw. bei der Strukturierung der IT-Dokumentation besteht darin, dass sie die unterschiedlichen Sichten von verschiedenen Benutzern und damit unterschiedlichen Anforderungen Rechnung tragen muss. In der Praxis bewährt hat es sich deshalb, zunächst die folgenden Fragen zu beantworten: Welche Aufgabenfelder sind der IT-Dokumentation zuzuordnen und wer ist für welchen Bereich der Dokumentation 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 Informationssicherheitsbeauftragten und zum Qualitätsmanagement. Die Frage betrifft außerdem nicht nur den IT-Betrieb, sondern auch IT-Projekte. Immer häufiger werden nämlich IT-Projekte unter gleichzeitiger Mitwirkung von IT-Entwicklung, IT-Betrieb und Fachbereichen durchgeführt.

Das Scoping der IT-Dokumentation ist daher eine wichtige Aufgabe. Scoping beschreibt hier die Definition von Aufgaben- und Verantwortungsumfängen. Das Wort leitet sich aus dem englischen scope ab, was die Bedeutungen Umfang, Abgrenzung, Raum, Aufgabenbereich, Spielraum u. Ä. haben kann. Bei klassischen IT-Aufgabenbereichen wie dem operativen Betrieb der Systeme ist die Zuordnung dabei in der Regel einfach. Bei Querschnittsthemen wie der Anwendungsdokumentation oder dem Notfallmanagement fällt die Beantwortung der o. g. Fragen häufig bereits schwerer. Das nachstehende Beispiel soll dies verdeutlichen:

Beispiel: SAP-Dokumentation

Ein in der Praxis häufig anzutreffender Problembereich ist die Dokumentation von Geschäftsanwendungen, wie beispielsweise des SAP-Systems. Dieses wird zwar von der IT-Organisation auf deren Systemen betrieben und gewartet, die fachliche Verantwortung liegt jedoch bei den Fachbereichen. Im Fall von SAP gibt es zudem meist unterschiedliche fachliche Zuständigkeiten für die verschiedenen Module. Zudem wird die SAP-Anwendung häufig im Rahmen des Customizings angepasst und weiterentwickelt. Neben der Dokumentation für die Systembetreuer wird also eine Dokumentation der fachlichen Anforderungen, eine Entwicklungsdokumentation und natürlich auch eine Anwenderdokumentation benötigt.

Die in der Praxis häufig fehlenden Festlegungen von Verantwortlichkeiten und Schnittstellen führen hier regelmäßig zu Reibungsverlusten und verhindern die Pflege einer nachhaltigen Anwendungsdokumentation, insbesondere wenn Teile dieser Aufgaben an Dienstleister ausgelagert sind. Aus Sicht der IT-Organisation ist daher zwingend eine Abgrenzung der Dokumentation (für welche Bereiche ist die IT verantwortlich) erforderlich. Außerdem müssen Übergabeschnittstellen definiert werden. Schließt die IT-Organisation beispielsweise in eigener Zuständigkeit Verträge mit Dienstleistern ab, so gehören die Dienstleistungsverträge ebenfalls zur IT-Dokumentation.

1.3.2 Festlegung der Strukturierungssicht

Zur Umsetzung von IT-Governance haben sich eine Reihe von Frameworks (Referenzmodellen) etabliert, die den Rahmen sowie die Anforderungen und Ergebnisse einer IT-Steuerung definieren. Die Frameworks bieten als Best-Practice-Methoden zur prozessorientierten IT-Steuerung eine Vorstrukturierung von Aufgaben und Arbeitsschritten. Hierzu zählen u. a. COBIT, ITIL®, TOGAF und das Microsoft Operations Framework (MOF). COBIT ist ein übergeordnetes Framework für die (IT-)Governance und das (IT-)Management. Es kann dabei helfen, die Verbindung zwischen der Governance des Unternehmens und der IT herzustellen. Die IT Infrastructure Library (ITIL®) bietet Best-Practice-Ansätze zum Aufbau eines ganzheitlichen IT-Servicemanagements. Das The Open Group Architecture Framework (TOGAF) bietet hingegen einen Ansatz für Entwurf, Planung, Implementierung und Wartung von Unternehmensarchitekturen.

Sind im Unternehmen derartige Frameworks oder Standards bereits etabliert, leiten sich daraus sinnvollerweise auch der Aufbau der Dokumentationsstruktur für die IT sowie die Verantwortungsbereiche ab. Fehlen hingegen interne Vorgaben, können die folgenden...

 

© 2009-2024 ciando GmbH