Technische Dokumentation

Es gibt hinsichtlich der Erläuterungen von Störungsmeldungen in der Technischen Dokumentation keine speziellen Vorgaben. Die Angaben aus Richtlinien und Normen sind dort eher allgemein gehalten. Daher genügt es Erläuterungen von Störungsmeldungen auch nur auf dem Bedienbildschirm anzeigen zu lassen. Anders…

Einer Erläuterung der Ingangsetzung bzw. Starten einer Maschine muss in der Technischen Dokumentation vorkommen. Die Maschinenrichtlinie fordert, dass eine Ingangsetzung der Maschine nur durch das absichtliche Betätigen einer vorgesehenen Befehlseinrichtung (z.B. Hauptschalter) erfolgen darf. Daher ist es auch nur sinnvoll,…

Die Übernahme der Technischen Dokumentation einschließlich der Betriebsanleitung ist ohne Absprache mit dem ehemaligen Hersteller nicht möglich. Das geistige Eigentum bzw. die Urheberrechte der erstellten Unterlagen verbleiben beim Ersteller. Durch die Veränderungen an der Maschine müssen Sie auch die Unterlagen…

Eine Technische Dokumentation nach der ATEX-Richtlinie muss folgende Mindestangaben erfüllen: Angaben zur (sicheren)InbetriebnahmeVerwendungMontage und DemontageWartung und Störungsbeseitigung (Instandhaltung)InstallationRüstenerforderlichenfalls die Markierung von gefährdeten Bereichen vor Druckentlastungseinrichtungen;erforderlichenfalls Angaben zur Einarbeitung;Angaben, die zweifelsfrei die Entscheidung ermöglichen, ob die Verwendung eines Geräts (entsprechend seiner…

Es ist sinnvoll, die Technische Dokumentation in Bereiche und Abschnitte zu gliedern. Dann muss der Anwender sich nicht jede einzelne Seite der Betriebsanleitung durchschauen. Mit Orientierungshilfen wie Inhalts-, Abkürzungs-, Tabellenverzeichnis, Index oder einem Glossar kann der Benutzer sinnvoll durch die…

Die Technische Dokumentation enthält auch Angaben zur Entsorgung einer Maschine. Hat die Maschine ausgedient, ist diese fachgerecht zu entsorgen. Dabei müssen Informationen hinsichtlich Außerbetriebnahme, Demontage, Recycling und Entsorgung dem Benutzer in der Betriebsanleitung zur Verfügung stehen. Da gesetzliche Vorgaben zur…

Wie der Benutzer mit gefährlichen Stoffen im Betrieb umzugehen hat, muss über die Technische Dokumentation beschrieben sein. Die in Kühlschmierstoffe enthaltenen Stoffe, sind gesundheitlich nicht unbedenklich. Bei Hautkontakt können diese allergische Gesundheitsschäden verursachen. Durch das Einatmen der aus dem Kühlschmierstoff…

Nominalisierung in der Technischen Dokumentation ist, wenn die Texte der Anleitungen mehr Substantive als Verben enthält. Ein Beispiel für solch einen Nominalisierung ist folgender Satz: Durch Drücken der Taste „Start“, kann die Maschine gestartet werden Der Einsatz von mehr Substantiven…

Eine aktive Ansprache in einer Technischen Dokumentation klingt ansprechender als eine Passiv formulierte. Formaler und unpersönlicher Satzbau sind keine interessanten Inhalte für den Leser. Passiv eignet sich nur für Beschreibungen und Erklärungen, in denen die Benutzer nicht wichtig sind. Der…

Es gibt mehrere Möglichkeiten, die Verständlichkeit in den Sätzen einer Technischen Dokumentation zu erhöhen. Zum einen gilt es, die Bildung von Schachtelsätzen zu vermeiden. Eine gute Technische Redaktion spaltet unverständliche Bandwurmsätze in kleine Informationshappen auf. Eine verständliche Satzlänge beträgt durchschnittlich…