Technische Dokumentation

Ein Redaktionssystem erleichtert in der Technischen Dokumentation die Verwaltung von vielen Betriebsanleitungen und deren einzelnen Entwicklungsstände. Eine eingebaute Versionierungsfunktion im Redaktionssystem erlaubt die Änderungen in den einzelnen Ständen leicht nachzuvollziehen. Dies ist dann hilfreich, wenn eine Betriebsanleitung häufig zu überarbeiten…

Um eine Maschine beim Transport sicher zu bewegen, muss in der Technischen Dokumentation auch Angaben zu dem Transport einer Maschine stehen. Dazu gehören Angaben zu den zulässigen Transportmitteln wie das die Maschine nur mit einem Gabelstapler zu bewegen ist. Die…

Die Technische Dokumentation muss auch Angaben zu der Verpackung einer Maschine enthalten. Dazu zählen beispielsweise die Angaben zum sicheren Auspacken der Maschine. Ebenso gilt es zu erläutern, wie die Maschine wieder zu verpacken ist. Sind mögliche (Rest-)Risiken beim Aus- bzw…

Die Technische Dokumentation von Zulieferer weißt mittels Sicherheitshinweise auf Gefahren hin. In wie weit es sinnig ist, in der eigenen Betriebsanleitung mit Sicherheitshinweise auf die Sicherheitshinweise der Zulieferer zu verweisen, hängt ganz von der Situation ab. Das Teil des Zulieferers…

In der Praxis hat sich ein gewisses Schema für den Aufbau einer Software Dokumentation etabliert. Zuerst beschreibt man die Grundlagen der Software. Die Anleitung beschreibt hierbei zuerst was für eine Funktion die Software hat und wie das Programm funktioniert. Danach…

Eine Software Dokumentation soll grundsätzlich drei Fragen rund um ein Programm erläutern. Wie funktioniert das Programm?Wie wird das Programm bedient?Wie wurde die Software entwickelt? Mit Beantwortung dieser Fragen deckt die Software Dokumentation auch alle unterschiedlichen Zielgruppen ab. Die Anleitung zu…

Das Schreiben einer Software Dokumentation unterscheidet sich von einer normalen Technischen Dokumentation. Wie die Anleitung für Software aufgebaut ist, hängt davon ab wie häufig man die Software verwendet. Bei einmaliger Nutzung möchte der Anwender schnell und ohne seitenlanges Lesen handeln…

Um eine Technische Dokumentation zielgruppengerecht aufzubereiten, gilt es auch im Bereich der textlichen Gestaltung einiges zu beachten. So sollte der Satzaufbau der Betriebsanleitung einfach gehalten sein. Handlungen beschreibt man in kurzen und verständlichen Sätzen. Der Schreibstil der Betriebsanleitung sollte von…

Die Technische Dokumentation enthält viele Informationen für den Benutzer einer Maschine. Dazu zählen auch Handlungsanweisungen für verschiedenen Bedienungsabläufe. Diese sollten klar und kurz formuliert sein. In jedem Satz sollte zudem nicht mehr als eine Handlung beschrieben sein, um die Informationsmenge…

Eine Technische Dokumentation enthält häufig Abbildungen auf verschiedenen Arten. Unter anderem Fotografien von Bauteilen, Werkzeugen oder der Maschine aber auch 3D-Abbildungen oder Schemazeichnungen. Doch wann sollte welche Art der Abbildung eingesetzt werden? 3D-Abbildungen können komplexe Sachverhalte darstellen und eigenen sich…