Technische Dokumentation

Die Gliederung einer Technischen Dokumentation sollte sich an den Nutzergruppen orientieren. Dabei sollten zur besseren Überschaubarkeit von Informationen diese so aufgeteilt sein, dass nur die für die jeweilige Nutzergruppe benötigten Informationen in einem Abschnitt vorkommen. Das Schichtpersonal an der Anlage…

Die Technische Dokumentation einer Anlage unterscheidet sich zu einer normalen Dokumentation eigentlich nur in ihrem Umfang und der Komplexität. Da eine Anlage aus einem Verbund von Maschinen besteht, ist für jede der Maschinen eine Dokumentation notwendig. Häufig füllt eine Anlagendokumentation…

Der Benutzer blickt zuerst in das Inhaltsverzeichnis einer Technischen Dokumentation. Darin möchte er schnell seine gesuchte Information finden. Die richtigen Überschriften der einzelnen Kapitel sind daher wichtig, um dem Nutzer eine einfache Art der Navigation durch das Dokument zu ermöglichen…

Der Leser der Technischen Dokumentation soll sich angesprochen fühlen. Es ist daher nicht ratsam, sich beim Text verfassen hinter einer unpersönlichen Ausdrucksweise zu verschanzen. Eine Handlungsanweisung wie „Der Schalter ist zu drücken“ ist für den Leser nicht sonderlich ansprechend. Eine…

Um eine verständliche Technische Dokumentation zu schreiben, ist der Stil beim Erstellen des Textes ein wichtiges Kriterium. Ist die Satzkonstruktion beispielsweise sehr kompliziert, verstehen die Leser die Inhalte der Dokumentation nicht. Viele Nebensätze erschweren das Lesen des Inhaltes und können…

Eine Technische Dokumentation beinhaltet unterschiedliche Abbildungen wie Fotografien von Bauteilen oder von Maschinen, aber auch 3D-Abbildungen oder Schemazeichnungen. Schnittansichten und Explosionsdarstellungen eignen sich für die Darstellung von komplexen Sachverhalten. Schemazeichnungen oder auch Strichzeichnungen bieten sich an, da diese Informationen einfacher…

Es ist nicht möglich, die Lieferung der Technischen Dokumentation zu einer Maschine oder einem anderen Erzeugnis vertraglich zu umgehen. Das Produktsicherheitsgesetz macht bezüglich der Betriebsanleitung genaue Angaben. Der Paragraf 3 listet unterschiedliche Anforderungen an die Bereitstellung von Produkten auf dem…

Möchte man eine Technische Dokumentation erstellen, stellt sich die Frage mit welcher Software man diese erstellen soll. Ein offensichtlicher Vorteil für Word als Programm zur Erstellung einer Betriebsanleitung ist die Bekanntheit und die große Verbreitung dieses Programmes. Es ist gut…

Da Microsoft Word nicht speziell für das Schreiben einer Technischen Dokumentation entwickelt ist, bietet diese Software auch entsprechende Nachteile. Word hat im Gegensatz zu einem Redaktionssystem keine Funktion für die Archivierung und das Einfrieren von einzelnen Druckständen. Jeder Druckstand von…

Ein Redaktionssystem in der Technischen Dokumentation bietet den Redakteuren mehrere Vorteile beim Erstellen einer Betriebsanleitung. Das Nachvollziehen von einzelnen Ständen der Betriebsanleitung ist mit einem Redaktionssystem einfach möglich. Jeder Bearbeitungsstand ist im Nachhinein einsehbar. Dadurch ist einfach nachvollziehbar, was in…