Inhaltsverzeichnis
Was sollte eine Dokumentation beinhalten?
Unter Dokumentation versteht man die Nutzbarmachung von Informationen zur weiteren Verwendung. Ziel der Dokumentation ist es, schriftlich oder auf andere Weise dauerhaft niedergelegte Informationen (Dokumente) gezielt auffindbar zu machen.
Wie schreibt man eine Zusammenfassung einer Dokumentation?
Text in Sinnabschnitte einteilen. Einleitung der Zusammenfassung schreiben: Titel des Textes, Autor, den Erscheinungsort, das Datum und die Textsorte. Hauptteil der Zusammenfassung schreiben: W-Fragen beantworten. Schluss der Zusammenfassung schreiben: Wirkung beschreiben, eigene Meinung zum Text einbringen.
Wie schreibt man ein resumen?
Direkte Rede kommt beim Resumen schreiben nicht vor. Das Resume sollte nur ein Drittel bis ein Fünftel des Originaltextes betragen, das heißt es muss deutlich kürzer sein und sollte nur die wichtigsten Informationen enthalten, alle Details sind unwichtig.
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.
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.
Welche Unterlagen sollten bei der Dokumentation beigelegt werden?
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. Beim Schreiben sollte der Verfasser immer im Hinterkopf behalten, für wen er die Dokumentation schreibt.