Inhaltsverzeichnis
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.
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.
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.
Warum sollte der Verfasser die Dokumentation behalten?
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.
Wie sollte die Dokumentation beschreiben werden?
Insgesamt sollte die Dokumentation also den gesamten Weg von der Vorbereitung bis zum Endergebnis nachvollziehbar beschreiben. Quellen dürfen dabei gerne verwendet werden, denn sie werten die Dokumentation zusätzlich auf. Wichtig ist dann aber, die Quellen richtig zu zitieren und in einem Verzeichnis aufzulisten.
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.
Warum sollten sie eine technische Dokumentation erstellen?
Der wichtigste Grundsatz, wenn Sie technische Dokumentation erstellen, lautet: Sie schreiben für den Anwender, nicht für sich selbst. Daher müssen Sie sich im Klaren sein, an wen sich Ihre Produkt- bzw.
Was ist hilfreich in einem Handbuch?
Am hilfreichsten ist das Handbuch als Informationssammlung in Form eines Textdokuments (zum Beispiel in Word). Beschreiben Sie die einzelnen Schritte für eine Aufgabe und ergänzen Sie sie mit Screenshots (per „Druck“-Taste oder mit dem „SnippingTool“ von Windows), Grafiken, Textbausteinen, Formularen und Checklisten.