Wie macht man eine gute Dokumentation?

By Bloggen

Wie macht man eine gute Dokumentation?

3 Regeln für gute Dokumentation

  1. Sie soll schnell und einfach zu erstellen und zu aktualisieren sein. Veraltete Informationen sind manchmal schlimmer als gar keine Informationen.
  2. Sie soll auf mögliche Fragen die richtige Antwort liefern.
  3. Sie soll auf keinen Fall menschliche Interaktionen ersetzen.

Was ist eine schriftliche Dokumentation?

Bei einer schriftlichen Dokumentation handelt es sich um eine Aufzeichnung, die einen bestimmten Vorgang oder Gegenstand dokumentiert, also schriftlich festhält.

Was braucht man für eine Dokumentation?

Eine Dokumentation kann – neben dem eigentlichen Inhalt – folgende Informationen enthalten:

  • eindeutige Zuordnung zu einem Prozess.
  • verantwortlicher Prozesseigner.
  • Datum und Unterschrift der Änderung.
  • Abnahmevermerk des Prozesseigners mit Datum und Unterschrift.
  • offizieller aktueller Stand des Dokumentes: Datum und Link.
LESEN:   Kann man 2 iPhones iTunes verwalten?

Warum ist es in einem Projekt sinnvoll eine Dokumentation zu erstellen?

Gute Dokumentation trägt zum Projekterfolg bei Informationen finden, Rechtssicherheit schaffen, Entscheidungen nachvollziehen und Missverständnisse vermeiden: All dies erreichen Sie mit einer guten Dokumentation Ihrer Unterlagen.

Welchem Zweck dient die Projektdokumentation?

Das Ziel einer Projektdokumentation ist es, den IST-Zustand sowie das SOLL-Konzept von Projekten festzuhalten und damit Aufschluss darüber zu geben, welches Problem gelöst und welche Lösung angewandt werden musste.

Was ist wichtig bei einer Dokumentation?

Der wichtigste Tipp ist, dass es sich bei einer Dokumentation um eine fachliche Arbeit mit wissenschaftlichem Charakter handelt. Das bedeutet, eine Dokumentation wird immer sachlich, neutral und präzise geschrieben, Fachausdrücke können und sollen verwendet werden. Zudem ist ratsam, in eher kurzen, aber dafür konkreten Sätzen zu schreiben.

Wie wird eine Dokumentation geschrieben?

· 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.

LESEN:   Wie starb Eva Cassidy?

Wie beginnst du mit einer Dokumentation?

Der Produktionsprozess für eine Dokumentation ist sehr komplex. Meist beginnst du mit der Idee, die du zeigen möchtest und einer Richtung, in die diese Idee sich entwickeln könnte. Es kann allerdings passieren, dass das Material, welches du nach dem Drehstart sammelst, nicht so gut ist, wie du gehofft hast.

Ist die Dokumentation noch verständlich?

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.

https://www.youtube.com/watch?v=5lJceh9cd8E