Technische Dokumentation

Technische Dokumentation erstellen für eine Maschine oder Anlage heißt auch, sich mit den in der Anleitung vorkommenden Symbolen auseinanderzusetzten. Beispielsweise welches Symbol man für die Kennzeichnung von Bedienerinformationen verwendet. Das allgemeine Gefahrenzeichen (Ausrufezeichen im gelben Warndreieck) dient zur Kennzeichnung von…

Die Betriebsanweisung einer Maschine soll dem Benutzer wichtige Verhaltensregeln im Umgang mit der Maschine vermitteln und benötigte Schutzvorkehrungen erläutern. Bei relevanten Änderung des Arbeitsmittels oder seiner Benutzung, wie durch Umbau der Maschine, muss der Betreiber seine technischen Unterlagen überarbeiten. Dazu…

Die für eine unvollständige Maschine notwendige Montageanleitung erstellen wir Ihnen gerne auf Wunsch. Dieses von der Maschinenrichtlinie geforderte Dokument, damit eine unvollständige Maschine überhaupt in Verkehr gehen darf, und auch weitere Dokumente im Bereich der Technischen Dokumentation gehören zu unserem…

Sie benötigen für Ihr Software Projekt Unterstützung um Ihr Handbuch erstellen zu können? Eine komplizierte Software benötigt ebenfalls eine Dokumentation für den Endanwender. Solch eine Dokumentation ist ähnlich aufgebaut wie eine Betriebsanleitung für eine Maschine. Das Handbuch soll den Benutzer…

In Bezug auf die Zielgruppe einer Maschine fordert die Maschinenrichtlinie, dass die Informationen für den Benutzer auch dem Kenntnisstand der jeweiligen Zielgruppen entsprechen müssen. Diese Forderung der Maschinenrichtlinie unterstreicht die Wichtigkeit der Durchführung einer Zielgruppenanalyse. Unter den Anwendern einer Maschine…

Im Januar 2018 veröffentlichten die Normengremien einen neuen Entwurf für eine Norm zur Technischen Dokumentation. Die Norm DIN EN ISO 20607 ergänzt die Norm zur Erstellung von Betriebsanleitungen DIN EN 82079 in Richtung der Maschinensicherheit. Der Entwurf stellt eine Typ-B-Norm…

Eine Dokumentation schreiben bedeutet auch sich mit der Leserlichkeit seines Dokumentes auseinanderzusetzen. Hierfür gibt es drei verschiedenen Gestaltungsmöglichkeiten, um eine Dokumentation leserlich zu gestalten. Zum einem die Schriftgröße. Wählt man beispielsweise für eine Betriebsanleitung eine Schriftgröße von nur 8 Punkten,…

Bei einer Dokumentation ist der Fachwortschatz oder auch Terminologie genannt für die Verständlichkeit und Eindeutigkeit der Anleitung sehr wichtig. Die Dokumentation muss über eine einheitliche Benennung von Fachausdrücken verfügen. Die wichtigsten Faktoren bei der Terminologie sind das Festlegen auf eine…

Wenn an einer alten Maschine weitgehende Veränderungen vorgenommen werden, gilt es auch in der Technischen Dokumentation einiges zu beachten. Falls beispielsweise eine Maschine neue Schutzeinrichtungen erhält oder einen leistungsfähigeren Antrieb, muss man die Maschine nach seiner Veränderung wieder überprüfen. Ist…

Der Aufbau einer Technischen Dokumentation gliedert sich in eine interne und eine externe Dokumentation. Die Interne Technische Dokumentation wie Risikobeurteilung, Prozessdokumentation, Konstruktionszeichnungen usw. verbleiben im Unternehmen des Herstellers. Die Externe Technische Dokumentation ist dafür vorgesehen, an Dritte Personen zu gehen…