Technische Pläne einer Dokumentation

Dokumentation

Der Begriff „Dokumentation“ ist ein sehr allgemeiner und ein sehr weitreichender Begriff, welcher aber im Alltag mit einer relativen Selbstverständlichkeit benutzt wird und eigentlich hat jeder eine klare Vorstellung davon was hiermit gemeint ist.

Was ist Dokumentation?

Im Allgemeinen stellt jegliche Dokumentation Informationen über ein Objekt, Zustand, Wesenheit bereit. Bei den Informationen handelt es sich dabei immer um nutzbare Informationen, welche einer weiteren Verwendung dienlich sind. Dabei bedient sich die Dokumentation verschiedener Medien, um die Informationen in schriftlicher Form oder aber auch in Ton- oder Videoform darzustellen. Somit dient Dokumentation auch der Speicherung und Aufbewahrung von Informationen. Dadurch ergibt sich auch die Möglichkeit diese Informationen zu verteilen und einem größeren Personenkreis zur Verfügung zu stellen. Durch die Speicherung der Informationen, erfolgt auch eine gewisse Archivierung. Darüber hinaus lassen sich bestimmte Dokumentationen, man denke nur an die Dokumentation von Wetterdaten, nachträglich auswerten und neue Informationen daraus gewinnen, wie z.B. die Regenwahrscheinlichkeit am nächsten Tag.

Um ein weiteres einfaches Beispiel zu skizzieren: Ein Sportler kann z.B. seine Zeiten von seinen Trainingsläufen auf einem Zettel oder zeitgemäß in einer passenden App dokumentieren. Die Rohinformationen sind die gelaufenen Zeiten. Nachträglich lassen sich dann Tendenzen zur Verbesserung oder Verschlechterung des Trainingszustands des Sportlers ermitteln.

Ein Softwareprogrammierer kann die Software-Architektur dokumentieren, so dass andere Mitarbeiter schneller und besser mit dem geschriebenen Quellcode umgehen können.

Ein Bauleiter wird den Bauablauf dokumentieren, um spätere Terminverschiebungen oder Regressansprüche rechtfertigen zu können.

Dokumentation im Projektmanagement

Das vorgenannte Beispiel gehört im Groben zur Dokumentation des Projektmanagements. Das heißt, im Rahmen eines Projektes werden alle Arbeitsschritte, Abhängigkeiten, beteiligte Personen und Firmen, Festlegungen und Beschlüsse inkl. zugehöriger Termine penibel dokumentiert. Ziel dieser Art der Dokumentation ist es den Projektablauf nachvollziehbar zu machen. Dabei kann es auch um eine gerichtsfeste Nachvollziehbarkeit gehen, wenn es während des Projektablaufs zu Streitigkeiten von Vertragspartnern kommt. Darüber hinaus will man mit der Projektdokumentation auch den Fortschritt darstellen zwischen den geplanten und erreichten Zielen (Soll-/Ist-Vergleich).

Dokumentation fĂĽr Software

Es gibt verschiedene Arten der Dokumentation fĂĽr Software:

  1. Dokumentation der Software-Architektur (siehe oben genanntes Beispiel)
  2. Dokumentation der Software-Entwicklung (siehe Projektmanagement)
  3. Dokumentation als Bedienungsanleitung (Hilfe-Datei)

Die Dokumentation von Software erfolgt meistens mit sogenannten Autorenwerkzeugen (Authoring-Tools). Ein Vertreter davon ist DA-HelpCreator. Die Softwaredokumentation ist so umfassend, dass die drei Arten jeweils ein eigenes Kapitel fĂĽr sich darstellen. Diese speziellen Arten, insbesondere Punkt 1) und Punkt 3) sind der “Technischen Dokumentation” zuzuordnen.

Strukturierung und Qualität von Dokumentation

Eine Dokumentation sollte hohen Qualitätsansprüchen gerecht werden und sollte objektiv und sachlich sein. Dabei sollte die Dokumentation vollständig sein ohne wesentliche Informationslücken. Die Dokumentation bedient sich einer einfachen Sprache und Satzbau, damit diese für den betreffenden Personenkreis verständlich ist. Das bedeutet aber nicht, dass keine Fremdwörter und Fachwörter verwendet werden dürfen. Inhaltlich ist die Dokumentation verständlich in einer logischen Abfolge zu strukturieren. Je nach Medium und Thema der Dokumentation bietet es sich an das Verständnis zu Zeichnungen, Bilder und Skizzen zu erhöhen. Die Korrektheit des Inhalts ist ein weiterer Punkt. Es dürfen also keine bewussten Falschinformationen enthalten sein. Die Informationen sollten durch Anlagen, Quellenangaben und ähnliches gestützt werden (Integrität). Die Dokumentation muss editierbar sein. Kommen neue Informationen hinzu, muss es möglich sein die Dokumentation zu erweitern durch Revisionierung oder Versionierung. Auch die Echtheit/Authentizität der Dokumentation sollte gegeben sein. Dies kann z.B. durch eine Unterschriftenordnung oder digitalen Signaturen erfolgen.

Dokumentation als Film und Video

Wer hat ihn noch nicht gesehen? …den allseits bekannten Dokumentarfilm, kurz Doku. Auch das ist eine Form der Dokumentation. Dem Zuschauer werden dabei zum Beispiel die neuesten Informationen zur Population der Löwen in der afrikanischen Savanne bereitgestellt. Aber auch die Präsentation von Technischen Lösungen, z.B. zu Computer-Problemen, über Video-Tutorials ist eine Art der Dokumentation.

2 Kommentare

Kommentar hinterlassen

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