Aufbau Dokumentation

Aufbau Dokumentation 

Eine Dokumentation beschreibt einen bestimmten Vorgang oder einen Sachverhalt sachlich und präzise. Vom Grundprinzip her ist die Dokumentation mit einem Protokoll vergleichbar. Nur ist die Dokumentation sehr viel ausführlicher.

 

Das Wichtigste auf einen Blick:

  • ·         Eine Dokumentation hält einen Ablauf oder ein Thema schriftlich fest.
  • ·         Eine Dokumentation beschreibt sowohl den eigentlichen Vorgang als auch die Planung und die Hintergründe.
  • ·         Eine Dokumentation wird sachlich und möglichst präzise geschrieben. Auch Fachausdrücke sind gerne gesehen.
  • ·         Eine Dokumentation steht immer im Präsens. 
  • ·         Für die Struktur bietet sich die klassische Dreiteilung in die Einleitung, den Hauptteil und den Schlussteil an.

 

Was ist eine Dokumentation?

Eine schriftliche Dokumentation dokumentiert einen bestimmten Sachverhalt. Sie hält den Sachverhalt also schriftlich fest. Vom Prinzip her ähnelt die Dokumentation damit einem Protokoll. Allerdings ist eine Dokumentation deutlich umfangreicher. Denn eine Dokumentation beschreibt nicht nur den eigentlichen Sachverhalt, sondern alle Schritte, Maßnahmen und Hintergründe, die dazugehören.

 

Wo und wann werden Dokumentationen geschrieben?

Dokumentationen kommen in vielen verschiedenen Bereichen vor und verfolgen unterschiedliche Absichten. Im publizistischen Bereich sind Dokumentationen Berichte, die journalistisch aufbereitet sind und meist einen direkten Bezug zur Realität haben. Um zu belegen, dass das dokumentierte Ereignis wirklich ein reales Geschehen beschreibt und nicht nur reine Fiktion ist, wird dann auch gerne mit Quellen gearbeitet.

Solche Dokumentationen beinhalten sowohl erklärende als auch erzählende Elemente. Die Absicht dahinter ist, einen Sachverhalt zu erläutern, ohne dabei ein reines Lehrmaterial zu sein. Kommen auch fiktive Elemente dazu, können Dokumentationen einen unterhaltsamen Charakter haben. Ein gutes Beispiel dafür sind die Doku-Soaps im Fernsehen, die reale oder mögliche Situationen aus dem echten Leben dokumentieren.

Daneben sind Dokumentationen im Projektmanagement, in der Produktentwicklung und im beruflichen Bereich anzutreffen. Bei Pflegeberufen beispielsweise werden in Dokumentationen alle durchgeführten Pflegemaßnahmen und Arbeitsschritte festgehalten. Dadurch sollen die Abläufe auch später noch überprüft und nachvollzogen werden können. Gleichzeitig dienen die Dokumentationen dazu, Erfahrungen festzuhalten, um daraus Schlüsse für ähnliche Vorgänge ziehen zu können. In der Schule, nach einem Praktikum oder im Rahmen der Abschlussprüfung bei einer Berufsausbildung werden solche Dokumentationen manchmal auch verlangt.

 

Wie wird eine Dokumentation geschrieben?

Eine Dokumentation hat einen wissenschaftlichen Charakter. Deshalb wird eine Dokumentation grundsätzlich sachlich, neutral und möglichst präzise verfasst. Gibt es im Zusammenhang mit dem dokumentierten Thema bestimmte Fachausdrücke, können und sollten sie verwendet werden. Allerdings muss die Dokumentation trotz der Fachausdrücke noch verständlich bleiben. Ansonsten ist es ratsam, lieber in kurzen, dafür aber aussagekräftigen Sätzen zu schreiben.

Was die Zeitform angeht, so gilt, dass eine Dokumentation immer im Präsens (Gegenwart) verfasst wird. Das gilt auch dann, wenn der Vorgang, der dokumentiert wird, bereits in der Vergangenheit liegt. Die Ich-Form sollte bei einer Dokumentation möglichst vermieden werden. 

Tipp: Beim Schreiben kann der Verfasser an eine Bedienungsanleitung denken. Eine Bedienungsanleitung ist eine technische Dokumentation. Und wenn sich der Verfasser ins Gedächtnis ruft, wie eine Bedienungsanleitung üblicherweise geschrieben ist, hat er einen guten Anhaltspunkt für den Schreibstil.

 

Welche Inhalte sollte eine Dokumentation haben?

Inhaltlich sollte eine Dokumentation die wesentlichen Informationen rund um den dokumentierten Sachverhalt liefern. Konkret sollte die Dokumentation folgende Fragen beantworten:

  • ·         Welcher Vorgang wurde durchgeführt, welches Thema wurde behandelt oder welches Problem wurde gelöst?
  • ·         Welche Vorgehensweise wurde dafür gewählt?
  • ·         Warum wurde ausgerechnet diese Vorgehensweise gewählt und nicht eine andere, ebenfalls mögliche Methode?
  • ·         Welchen Maßnahmen und Schritte wurden konkret durchgeführt?
  • ·         Was ist das Ergebnis und welche Schlüsse lassen sich daraus ziehen?
  • ·         Welche Hintergrundinformationen sind wichtig und müssen beachtet werden?

Insgesamt sollte die Dokumentation also den gesamten Weg von der Vorbereitung bis zum Endergebnis nachvollziehbar beschreiben. Quellen dürfen dabei gerne verwendet werden, denn sie werten die Dokumentation zusätzlich auf. Wichtig ist dann aber, die Quellen richtig zu zitieren und in einem Verzeichnis aufzulisten.

 

Wie ist der Aufbau einer Dokumentation?

In der Schule und im Beruf gibt es meist Vorgaben dazu, wie die Dokumentation aufgebaut und wie umfangreich sie sein soll. Auch die Form ist oft vorgegeben. Ansonsten fährt der Verfasser am besten, wenn er sich am klassischen Aufbau aus Einleitung, Hauptteil und Schlussteil orientiert.

 

Einleitung

Die Einleitung liefert die grundlegenden Informationen. Hier sollte der Verfasser beschreiben, um welche Frage- oder Problemstellung es geht. Zudem sollte er erläutern, wie die konkrete Aufgabe lautete, welche Anforderungen es gab und welche Bedingungen herrschten. Anschließend sollte der Verfasser benennen, welche Lösung er angestrebt hat oder welche Ziele er erreichen wollte. In der Einleitung sollte der Verfasser also den Ist-Zustand mit dem Soll-Zustand vergleichen. Daneben kann er kurz skizzieren, welche Erwartungen er hatte.

 

Hauptteil

Im Hauptteil beschreibt der Verfasser ausführlich und präzise alle Maßnahmen und Schritte, die er durchgeführt hat. Er erklärt, wie er vorgegangen ist und warum er sich für diese Vorgehensweise entschieden hat. Er kann die Zwischenergebnisse aufführen und auf Probleme oder Schwierigkeiten eingehen, die sich im Verlauf der Arbeiten ergeben haben. Kurze Anekdoten und die persönlichen Eindrücke können den Inhalt etwas auflockern. Außerdem schildert der Verfasser, welche Ergebnisse er erzielt hat.

 

Schlussteil

Im Schlussteil zieht der Verfasser sein Fazit. Dazu kann er die Erwartungen, die er in der Einleitung formuliert hat, noch einmal aufgreifen und erläutern, ob und inwieweit sich seine Erwartungen erfüllt haben. Daneben kann er schildern, welche Erkenntnisse sich ziehen lassen und wie diese Erkenntnisse in Zukunft genutzt werden können. Genauso kann der Verfasser aber auch resümieren, dass die Problemstellung bestimmte Folgemaßnahmen erfordert, damit sie endgültig gelöst werden kann. 

Bei einer umfangreichen Dokumentation kann es sinnvoll sein, zunächst eine Inhaltsangabe anzufertigen. Als Anlagen können der Dokumentation dann ein Quellenverzeichnis, ein Glossar mit den verwendeten Fachbegriffen und weitere wichtige Unterlagen wie beispielsweise Skizzen, Tabellen und Fotos oder Rechnungen beigelegt werden.

 

Ein Tipp zum Schluss

Beim Schreiben sollte der Verfasser immer im Hinterkopf behalten, für wen er die Dokumentation schreibt. Eine gelungene Dokumentation ist dann gegeben, wenn der Leser ein umfassendes Bild erhält und alle Schritte, Maßnahmen und Ergebnisse nachvollziehen kann, obwohl er selbst an der Situation nicht beteiligt war.

Mehr Ratgeber, Tipps, Vorlagen und Anleitungen:

Thema: Aufbau Dokumentation

Teilen:

Kommentar verfassen