Was ist ein Dokument?

„Ich dokumentiere nicht gerne“ ist ein Satz, den ich häufig höre. Dahinter versteckt sich meist die Aussage „Ich schreibe nicht gerne“. Doch müssen Dokumente immer geschrieben werden oder was ist eigentlich ein Dokument?

Gibt man den Begriff „Dokument“ in Wikipedia ein, findet sich hier eine ganze Liste verschiedener Definitionen. So steht er u.a. für ein Schriftstück im Allgemeinen, aber auch für Urkunde bzw. amtliches Dokument, als Beleg zu einer öffentlichen oder behördlichen Angelegenheit. Und als elektronisches Dokument bezeichnet Wikipedia Text-, Bild- und/oder Audioinformationen, die durch Digitalisieren in Dateiform angelegt oder überführt wurden.

Eine andere Quelle für Dokumentationsbegriffe stellt die ISO Norm 9000 dar. Diese definiert für den Bereich Qualitätsmanagement alle relevanten Begriffe, was auch den Bereich der Dokumentation einschließt. Und hier heißt es: Dokumente sind Informationen und ihr Trägermedium, wobei gemäß Anmerkung 1 das Trägermedium Papier, ein magnetisches, elektronisches oder optisches Speichermedium, eine Fotografie, ein Bezugsmuster oder eine Kombination daraus sein kann. Als Informationen wiederum bezeichnet die ISO 9000:2005 „Daten mit Bedeutung„.

Das klingt zwar alles sehr abstrakt, bietet aber trotzdem einen hilfreichen Ansatz. Ein Dokument besteht demzufolge aus relevanten Daten, d.h. Informationen auf einem beliebigen Trägermedium.  Ein wichtiger Aspekt wird bei dieser Definition aber nicht ausreichend deutlich: Die zu einem Dokument zusammengefassten Informationen müssen als Gesamtheit erkennbar, zugreifbar und verwendbar sein.  Die in einer CMDB gesammelten Daten sind also erst einmal kein Dokument. Die in einer weiterverwendbaren Sicht aggregierten Daten sind aber durchaus als Dokument zu begreifen. In unserem Glossar definieren wir daher ein Dokument als eine

Zusammenfassung von Informationen auf einem Trägermedium (Papier, sonstige Speicherung), das als Gesamtheit identifizierbar und zugänglich ist. Mit Ausnahme des speziellen Dokumententyps „Aufzeichnungen“ sind Dokumente veränderbar und können in verschiedenen Revisionsständen existieren.

Aber inwieweit hilft diese Definition nun in der Praxis weiter? Ist man in der IT tätig, wird man sicherlich nicht immer um das Schreiben von Textdokumenten herumkommen. Und bei Dokumenten, die beispielsweise Compliance-Anforderungen erfüllen müssen, muss man sich auch an die definierten formalen Vorgaben halten. Bei einer Installationsanleitung aber besteht nur selten die Notwendigkeit, dass diese zwingend als Textdokument vorliegt. Also warum nicht einfach die Installation per Video aufzeichnen? Denn auch eine Videodatei ist ein Dokument. Und die Annahme, dass für ein System alle relevanten Informationen aus dem Inventarisierungstool zwingend in ein Worddokument exportiert werden müssen, ist ebenfalls nicht zutreffend. Die Informationen müssen als Einheit gefunden und verwendet werden können, egal auf welchem Medium. Die im Inventarisierungstool gespeicherten Berichte oder Datenblätter erfüllen diese Anforderung durchaus.

Teilen
Facebooktwittergoogle_plusredditpinterestlinkedinmailFacebooktwittergoogle_plusredditpinterestlinkedinmail

4 Kommentare:

  1. Die Anforderung, dass ein Dokument auf einem Trägermedium speicherbar sein muss, suggeriert in den meisten Fällen, dass das Trägermedium portabel ist wie ein Blatt Papier oder ein USB-Stick. Das gilt für ein Inventarisierungstool, das an ein Rack im Serverraum gebunden ist, per se nicht. Wenn man nicht zusätzlich ein VPN bemüht, erfüllt ein Tool nicht die gleichen Anforderungen wie ein PDF. In ähnlicher Weise kann man gegen Videos argumentieren. Einem Video haftet auf Grund seiner Größe eine gewisse Immobilität an, die durchaus hinderlich sein kann, weswegen ich es gut verstehen könnte, wenn Videos nicht als vollwertige Dokumentation sondern nur als Ergänzung akzeptiert werden.

  2. Der Punkt mit der Portabilität ist wichtig, da Dokumentation z.B. auch im Falle einer Desaster Recovery verfügbar sein und daher getrennt von den produktiven Servern aufbewahrt werden muss.
    Das kann im heutigen Zeitalter aber durchaus auch eine gespiegelte Kopie des virtuellen Servers mit dem Inventarisierungs-Tool sein.

    Problematisch ist so eine systembasierte Dokumentation trotzdem:

    Einerseits bedeutet „portabel“ nicht nur „räumlich mobil“, sondern die Dokumente sollen auch in sich funktionsfähig sein, was nur bei Standard-Formaten wie Papier oder PDF, TXT, CSV und mit Einschränkungen HTML oder XML gegeben ist. Alles andere macht Probleme, wenn die Dokumente von Dritten (ohne Lizenz für benötigte Software) oder in der Zukunft (wenn passende Software, z.B. der antike Video-Codec, oder ein passendes Bandlaufwerk nicht mehr verfügbar ist) gelesen werden sollen.

    Andererseits sollen Dokumente auch eine gewisse Stabilität aufweisen. Wenn das Inventarisierungstool nicht eine sehr gute Versionsverwaltung eingebaut hat, könnte die darin enthaltene Dokumentation in Sekundenschnelle auf dem System und allen gespiegelten Kopien gelöscht/manipuliert werden, was in der Praxis selten absichtlich, aber oft durch einen dummen Fehler passiert.

  3. Die Portabilität der Dokumentation und vor allem auch die Verfügbarkeit der Dokumentation sind natürlich wichtige Punkte. Trotzdem sind gerade Inventarisierungstools ein gutes Beispiel dafür, dass eine IT-Dokumentation aus mehr besteht, als aus “Worddokumenten“. Allerdings kommt es in der Tat auf den Einsatzzweck der Dokumentation an. Viele Informationen in einem solchen Tool werden vom IT-Betrieb z.B. zur Störungsbehebung oder bei Änderungen benötigt. Und im laufenden Betrieb kann die Verfügbarkeit auf vom Tool bereitgestellte Datenblätter oder Auswertungen als gesichert angenommen werden. Das gilt im übrigen für jede Art der Bereitstellung von Dokumenten, d.h. auch für die auf einem Fileshare liegenden PDF-Dokumente. Der laufende Betrieb ist also nach meiner Einschätzung nicht das Problem.

    Dann gibt es aber natürlich noch das Thema Nachweisbarkeit. Um beispielsweise nachweisen zu können, dass die Systeme zu einem bestimmten Zeitpunkt gepatcht waren. Auch wenn es im Tool entsprechende Versionierungsmöglichkeiten gibt, würde ich hier entsprechende Reports bevorzugen, die beispielsweise automatisiert erzeugt werden und in entsprechenden Formaten langfristig verfügbar archiviert werden.

    Und letztendlich bleibt dann noch die Frage der Verfügbarkeit der Dokumentation in Notfällen. Hier gilt es sehr genau zu betrachten, welche Informationen in welchen Fällen von wem benötigt werden. Denn im Notfall benötige ich andere Informationen, als im Betrieb. Diese aber müssen natürlich gesichert im Notfall verfügbar sein, z.B. in Form von PDF-Dokumenten. Hier geht es nach meiner Überzeugung auch nicht ohne Papierdokumente (Wiederherstellungspläne, Kontaktlisten, u.a..).

    Wie gesagt, will ich keineswegs anregen, die gesamte IT-Dokumentation nur noch in Inventarisierungstools oder als Video abzubilden. Diese können aber durchaus Bestandteil der Dokumentation sein. Interessant finde ich übrigens den Hinweis auf die Fehleranfälligkeit bzw. der Angreifbarkeit der im Inventarisierungstools gehaltenen Dokumente. Mittels entsprechender Sicherungen lässt sich das Problem zwar lösen, man muss diesen Aspekt aber natürlich erst einmal beachten.

Schreibe einen Kommentar

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