Was gehört in eine IT-Dokumentation?
Eine Möglichkeit wäre: Bei der IT-Dokumentation geht es darum, die Informationen aller wichtigen Bestandteile der genutzten Informationstechnologie zentral und strukturiert zu erfassen. Dies betrifft die Netzwerke, die daran angeschlossenen Geräte sowie die zu einem erfassten Gerät gehörenden Informationen.
Wie schreibt man eine Arbeitsdokumentation?
Anleitung und Tipps zum Schreiben 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.
Welche rechtliche Bedeutung hat die Dokumentation?
Sie ist zum einen ein Arbeitsmittel, sie dient unter anderem als Gedächtnisstütze. Weiter stellt Dokumentation in einem System die Kommunikation und Information her und verbessert diese auch, zum Beispiel in der Form einer Rechenschaftspflicht gegenüber dem Patienten.
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.
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?
Anleitung und Tipps zum Schreiben einer Dokumentation. Verfasst wird eine Dokumentation im Präsens, auch wenn über Vorgänge geschrieben wird, die in der Vergangenheit liegen. Außerdem sollte der Verfasser versuchen, möglichst viele aktive Formulierungen zu finden und sehr darauf achten, die Ich-Form zu vermeiden.
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.