[PDF] Hinweise und Beispiel(e) für die „Schriftliche Dokumentation“

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.

Wie schreibt man eine 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 schreibt man eine gelungene Dokumentation?

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.

Was ist eine technische Dokumentation?

Die technische Dokumentation sollte möglichst verständlich und leicht zugänglich sein und dem Leser alle notwendigen Informationen zur Verfügung stellen, um das Produkt oder die Anlage sicher und effektiv zu nutzen. Einleitung: Die ___-Anlage ist eine automatisierte Fertigungseinrichtung, die zur Herstellung von Kunststoffteilen eingesetzt wird.