Die IT-Dokumentation im Griff – eine Dokumentationslandkarte hilft dabei

Die „IT-Dokumentation im Griff“, so lautet der Titel meines aktuellen Seminars. Dahinter steckt die Erkenntnis, dass es in  vielen IT-Organisationen nicht an Dokumenten mangelt. Da gibt es „bergeweise“ Excel-Listen, automatisch erzeugte Berichte und Auswertungen, mühsam erstellte Handbücher, von externen Beratern verfasste Dokumente und gesammelte Informationen in diversen Formaten. Es fehlen jedoch Strukturen und Vorgaben, wie mit der Flut der Dokumente zu umzugehen ist. Wie erste Schritte in Richtung einer strukturierten IT-Dokumentation aussehen können, erfahren meine Teilnehmer ausführlich im Seminar und Sie komprimiert im nachstehenden Beitrag.

Die Server vieler Unternehmen beherbergen gigabyteweise Dokumente. Steht jedoch ein Audit an oder hat sich ein Mitarbeiter der Revision angekündigt, lautet häufig die erste Frage: Haben wir das dokumentiert und wenn ja wo finden wir das bzw. die entsprechenden Dokumente? und Wie heißt das Dokument und welche Version ist die aktuelle?

Unterzieht man dann die vorhandenen Dokumente einer Analyse, stellt man fest, dass nicht nur eine Vielzahl an Dokumenten existiert, sondern auch dass diese vielfach ohne Bezug nebeneinander stehen und die Bezeichnungen der Dokumente wenig bis gar nichts über deren Inhalte aussagen. Da gibt es

  • Richtlinien,
  • Installationsanweisungen,
  • Betriebshandbücher,
  • Konzepte,
  • DV-Konzepte,
  • Fachkonzepte,
  • Handbücher und
  • Betriebshandbücher.

Was aber unterscheidet diese Dokumententypen überhaupt voneinander? In vielen Unternehmen gibt es keine Regelungen zur Standardisierung der Dokumente und es liegt damit im Ermessen des jeweiligen Autors liegt, ob es sich bei einem Dokument um ein Betriebshandbuch, ein Konzept oder aber um eine Anleitung handelt bzw. welche Inhalte zum Beispiel das Betriebshandbuch enthält.

Erste Schritte in Richtung Strukturierung

Auch wenn die folgenden Ausführungen etwas akademisch anmuten, bietet doch die vorgestellte Vorgehensweise eine gute Hilfe zur Strukturierung der eigenen Dokumentation. Die Basis hierfür bildet die Definition von  Dokumentenklassen und Dokumententypen und die anschließende Klassifizierung der Dokumente. Als Werkzeug hierfür können grafische Tools (beispielsweise Tools zur Erstellung von MindMaps), aber auch beispielsweise Excel-Listen verwendet werden.

Als Ergebnis erhält man ein Übersichtsdokument, für das sich bei meinen Projekten der Begriff „Dokumentationslandkarte“ oder „Dokumentenlandkarte“ herauskristallisiert hat. Geographische Landkarten stellen Gegenstände, Sachverhalte oder Prozesse grafisch in ihren Raumbeziehungen dar, mit dem Ziel ansonsten nur schwer formulierbare Zusammenhänge für den Betrachter leicht verständlich zu machen. In Analogie dazu dient die Dokumentationslandkarte dazu durch Zuordnung von Klassen und Typen die Zusammenhänge zwischen den verschiedenen Dokumenten  verständlich zu machen.

Grundsätzlich sind zur Erstellung einer solchen Dokumentationslandkarte die folgenden Schritte sinnvoll:

  • Identifizierung und Definition der benötigten Dokumentenklassen:  Dokumentenklassen dienen der Unterscheidung von Dokumenten nach definierten Kriterien (Compliance-Anforderungen, organisatorische Zuordnung u. a.). IT-Systembetrieb, Systementwicklung, und IT-Management beispielsweise sind typische Dokumentenklassen für die Strukturierung der IT-Dokumentation aus organisatorischer Sicht. Dokumentenklassen können in Unterklassen unterteilt werden. Einer Dokumentenklasse werden verschiedene Dokumententypen zugeordnet.
  • Identifizierung und Definition der erforderlichen Dokumententypen: Die Zuordnung zu einem Dokumententyp definiert ein Dokument im Hinblick auf seinen Informationsinhalt, seine Anforderungen an die Dokumentenlenkung und die Darstellungsform. Typische allgemeingültige Dokumententypen sind u. a. Richtlinien, Prozessbeschreibungen, Anleitungen, Konzepte und Verträge. Die Klassifizierung kann bis zu einem konkreten Dokumententyp, z. B. DV-Konzept verfeinert werden und ist dann durch einen gleichen inhaltlichen Aufbau gekennzeichnet. Dokumententypen können grundsätzlich in jeder Dokumentenklasse vorkommen. So kann es beispielsweise in jeder Dokumentenklasse Dokumente vom Typ Richtlinie geben.
  • Identifizierung der erforderlichen Dokumente: Im dritten Schritt müssen zunächst alle vorhandenen Dokumente einer Klasse zugeordnet werden bzw. noch fehlende Dokumente pro Klasse identifiziert werden. Anschließend ist allen Dokumenten einer der identifizierten Dokumententypen zuzuordnen. Während der Zuordnung wird auch sehr schnell deutlich, ob noch weitere Dokumententypen benötigt werden. Das Ergebnis ist eine Dokumentationslandkarte, in der alle Dokumente einer Klasse und einem Dokumententyp zugeordnet sind.

Welche Vorteile ergeben sich aus dieser Vorgehensweise:

  • Die Dokumentenklassen ermöglichen eine organisatorische Zuordnung. Damit können auch Verantwortlichkeiten für die einzelnen Dokumente festgelegt werden. Verwendet man die Klasse als Metadatum können in einem DMS beispielsweise schnell alle Dokumente eines Bereichs schnell gefunden werden.
  • Mit der Zuordnung zu einem Dokumententyp werden für ein Dokument automatisch definierte Eigenschaften festgelegt. So kann beispielsweise festgelegt werden, dass Richtliniendokumente immer einen Freigebeprozess durchlaufen müssen, ein entsprechendes Template erfordern und regelmäßig zu überprüfen sind. Für Anleitungen hingegen wird es beispielsweise mehr Freiheitsgrade geben.
  • Die Festlegung von Klassen und Typen führt automatisch zu einer Standardisierung der IT-Dokumentation. Gibt es Leitlinien und Richtlinien? Wenn ja, was unterscheidet beide Typen von einander? Gibt es den Dokumententyp Betriebshandbücher und wenn ja, wie ist dieser definiert? Das Glossar entsteht bei dieser Vorgehensweise notwendigerweise fast automatisch.
  • Die Festlegung von Attributen für die verschiedenen Dokumententypen bildet eine sehr gute Basis für die Festlegung von Dokumentationsverfahren. Was hierbei zu beachten ist, werde ich in einem gesonderten Beitrag erläutern.

Fazit

Die Erarbeitung einer Dokumentations- bzw. Dokumentenlandkarte ist ein zentraler Baustein eines anforderungsgerechten und effizienten Dokumentationsmanagement. Sie bildet außerdem die Basis für die zusätzlich erforderliche Dokumentenmatrix.

Teilen
Facebooktwittergoogle_plusredditpinterestlinkedinmailFacebooktwittergoogle_plusredditpinterestlinkedinmail

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.