Wie macht man eine gute dokumentation?

Gefragt von: Elvira Grimm  |  Letzte Aktualisierung: 16. April 2022
sternezahl: 5/5 (31 sternebewertungen)

So schreiben Sie eine Dokumentation
  1. Eine Dokumentation ist wie jeder andere Text auch in eine Einleitung, einen Hauptteil und einen Schluss aufgeteilt. ...
  2. Im Hauptteil teilen Sie dem Leser mit, was Sie zur Lösung des Problems getan haben. ...
  3. Der Schluss umfasst, wie bei anderen Textformen auch, das Fazit der Arbeit.

Wie schreibt man am besten eine Dokumentation?

Das Wichtigste auf einen Blick:

· 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 braucht man für eine Dokumentation?

Jede Dokumentation besteht aus einem oder mehreren der folgenden Elemente.
  • Bildmaterial.
  • Interviews.
  • Umfrage.
  • Archivmaterial.
  • Fakten (können in grafischer oder anderer Form präsentiert werden …)
  • Erzählung (Begleitkommentar)
  • Fiktion oder animierten Sequenzen, die reale Ereignisse nachempfinden oder erklären.

Was macht eine gute Dokumentation aus?

Ziel der Dokumentation ist es, schriftlich oder auf andere Weise dauerhaft niedergelegte Informationen (Dokumente) gezielt auffindbar zu machen. Dokumente in diesem Sinne können Fachbücher, Zeitschriftenartikel oder sonstige Druckschriften sein, aber auch Archivalien, Bilder, Filme, Tonaufzeichnungen und Ähnliches.

In welcher Zeit schreibt man eine Dokumentation?

Für eine Dokumentation ist die Gegenwartsform (Präsens) die geeignetere / verbreiterere / richtigere Zeitform.

Tipps für die technische Dokumentation // deutsch

37 verwandte Fragen gefunden

Wie beginnt man eine Dokumentation?

So schreiben Sie eine Dokumentation

Eine Dokumentation ist wie jeder andere Text auch in eine Einleitung, einen Hauptteil und einen Schluss aufgeteilt. In die Einleitung schreiben Sie, was genau die Problemstellung war. Sie geben dem Leser also eine Übersicht über die elementaren Informationen.

In welcher Zeitform schreibt man eine Präsentation?

Präsens – von vielen Richtlinien empfohlen.

Warum ist eine gute Dokumentation wichtig?

Folgen mangelhafter Dokumentation

Werden Projekttätigkeiten vom Team unzureichend oder gar nicht dokumentiert ist eine spätere Erweiterung und Wartung des Projekts oft mit unnötigen und vor allem hohen finanziellen und zeitlichen Aufwänden verbunden.

Was zeichnet eine Dokumentation aus?

Dokumentarfilmische Authentizität ist vor allem als Rezeptionseffekt und nicht als spezifischer Wirklichkeitseindruck zu begreifen. Es gibt eine große Bandbreite von verschiedenen Dokumentarfilmarten, die sich vom Versuch, ein möglichst reines Dokument zu erschaffen, über die Doku-Soap bis hin zum Doku-Drama erstreckt.

Warum ist die Dokumentation wichtig?

Nur durch Dokumentationen können Gerichte im Nachhinein in einem Prozess, der meist viele Jahre später stattfindet, nachvollziehen, wie der Behandlungsablauf tatsächlich war. Wenn ein Patient einen Behandlungsfehler vermutet, kommt es häufig vor, dass er auch eine Strafanzeige stellt.

Wie schreibe ich eine Dokumentation für eine Präsentation?

Erläutern Sie, welche Medien Sie einsetzen werden. Begründen Sie die Wahl des Mediums zunächst aus inhaltlicher Sicht. Die Wahl des Mediums muss zur Aufgabestellung, zum Fach und zu den eingesetzten Visualisierungen passen. Erläutern Sie dann, wie das Medium und der Vortrag in einen Zusammenhang gebracht werden.

Welche Formen der Dokumentation gibt es?

Dokumentationsarten in der Übersicht
  • Programmierdokumentation (Inline Source Documentation) Die grundlegendste Form der Dokumentation, die jeder Entwickler durchführen kann, ist die Programmierdokumentation. ...
  • Schnittstellendokumentation. ...
  • Technische Dokumentation. ...
  • Benutzerdokumentation („Handbuch“)

Wie lange geht eine Dokumentation?

Reportagen sind in der Regel zwischen fünfzehn und dreißig Minuten lang.

Was ist der Unterschied zwischen Dokumentarfilm und Dokumentation?

Klar unterscheiden lässt sich ein Dokumentarfilm, der in zumindest etwas längerer Form für das Kino gemacht ist, von einer kurzen Reportage für eine Nachrichtensendung oder ein Magazin, und von einer Dokumentation, die in der Regel viel wortlastiger und stark durch Schnitt und Musik gestaltet ist.

Wie muss eine Technische Dokumentation aussehen?

Typische Bestandteile sind Pflichtenhefte, Berechnungsunterlagen, Versuchsberichte, Risikobeurteilungen, technische Zeichnungen und Fertigungsunterlagen, Nachweise über Maßnahmen der Qualitätssicherung sowie die gesamte externe Technische Dokumentation des Produkts.

Welche Ziele verfolgt die Dokumentation?

Dokumentieren bedeutet, Informationen zu sammeln, zu ordnen, inhaltlich zu erschließen, aufzubewahren und wiederzufinden. Dabei kommt dem Wiederfinden eine besondere Bedeutung zu.

Welche Zeitform beim Zitieren?

Präsens – bei wissenschaftlichen Texten ein Muss

Wer jetzt aber denkt, dass er seine Arbeit in einer Vergangenheitsform schreibt, ist auf dem Holzweg: Für wissenschaftliche Arbeiten ist Präsens die passende Zeitform. Die Gegenwartsform hat sich in der Wissenschaft als übliches Tempus etabliert.

In welcher Zeitform schreibt man eine Bachelorarbeit?

Grundsätzlich sind im Deutschen Zeitformen möglich, die sich entweder auf die Gegenwart, auf die Vergangenheit oder auf die Zukunft beziehen. Einige Ratgeber empfehlen, die gesamte Bachelorarbeit im Präsens zu schreiben. Das ist die Zeitform, die die Gegenwart ausdrückt (Vgl. die Hinweise der Universität Gießen).

In welcher Zeitform schreibt man Ergebnisse?

Die Wahl der Zeitform hängt vom Kontext ab: Werden Theorien dargestellt, ist das Präsens (Gegenwart) zu verwenden. Bei der Darstellung der Ergebnisse ist hingegen die Vergangenheit (Präteritum oder Perfekt) die richtige Zeitform.

Wie dokumentiert man in der Betreuung Beispiele?

Sinnvoll ist, die Dokumentation zweizuteilen: (1) Verschriftlichen Sie einen Wochenplan vor den Betreuungsleistungen. Im Nachgang können Sie (2) Ihre Beobachtung während der Aktivitäten festhalten. Zugleich dient dieser Bericht als Nachweis, dass die Betreuungsleistungen auch wirklich stattgefunden haben.

Wie lang ist ein Dokumentarfilm?

Die deutsche Filmförderungsanstalt etwa definiert in ihren Förderrichtlinien eine Mindestlänge für Spiel- und Dokumentarfilme von 79 Minuten und für Kinderfilme von 59 Minuten. Als Kurzfilme gelten Filme bis 30 Minuten (bzw. 58 Minuten beim Kinderfilm).

Welche Pflegedokumentationssysteme gibt es?

Pflegedokumentation
  • Patientenstammblatt.
  • Pflegeanamnese.
  • Biografieblatt.
  • Sammlung ärztlicher Anordnungen bzw. Therapiemaßnahmen.
  • Medikamentenplan.
  • Pflegeplanung.
  • Pflegebericht mit Beurteilung der Ergebnisse der pflegerischen Maßnahmen.
  • Durchführungsnachweiß

Was gehört in eine systemdokumentation?

Die Systemdokumentation ist Teil der IT-Systembetriebsdokumentation und besteht u.a. aus den einzelnen Systemakten der eingesetzten Hardware- und Softwaresysteme sowie der Netzwerk- und Infrastrukturkomponenten und stellt hierfür einen Sammelbegriff dar.

Wie dokumentiere ich ein Projekt?

Grundsätzlich gilt: Die wesentlichen Einflussfaktoren eines Projektes sollten dokumentiert werden. Dazu gehören: Anforderungen und Änderungen an die Komponenten des magischen Dreiecks des Projektmanagements wie Inhalt und Umfang, Kosten, Zeit, Qualität und Risiko.

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.