Inhaltsverzeichnis
Wie macht man eine schriftliche Dokumentation?
· 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.
Wie schreibt man eine Code Dokumentation?
Praktische Regeln für eine gelungene Dokumentation
- Regel 1: Sofort dokumentieren. Jetzt muss man natürlich zugeben, dass sofortige Dokumentation tatsächlich auch den Arbeitsfluss stören kann.
- Regel 2: Fasse dich kurz und schreibe in Aufzählungspunkten.
- Regel 3: Gib gute Erklärungen und Beispiele.
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.
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.
Wie kann man eine umfangreiche Dokumentation erstellen?
Bei einer umfangreichen Dokumentation kann es sinnvoll sein, zunächst eine Inhaltsangabe anzufertigen. 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.