Technische Dokumentation

Für Geräte, die unter die EMV-Richtlinie fallen, müssen Informationen zur Nutzung des Gerätes in einer Betriebsanleitung enthalten sein. Dazu zählen unter anderem Angaben über Vorkehrungen, die bei Montage, Installation, Betrieb oder Wartung des Gerätes zu treffen sind.

Sinnvollerweise erscheinen in der Technischen Dokumentation die Inhaltspunkte in der Reihenfolge entsprechend dem Lebenszyklus der Maschine. Demnach beginnt eine Betriebsanleitung nach den allgemeinen Hinweisen mit Installation und Inbetriebnahme, geht dann vom Normalbetrieb über andere Lebensphasen wie Wartung, Reparatur, Störungsbehebung und…

Die digitale Technische Dokumentation bietet einige Vorteile in der Navigation. So ist das Auffinden von Informationen im digitalen Dokument durch Suchfunktionen viel einfacher als auf der Papierfassung. Relevante Informationen wie Sicherheitshinweise lassen sich schnell in einer pdf-Datei mit entsprechenden Stichworten…

Gibt es beim Kauf einer Maschine zwischen dem Hersteller und dem Käufer keine vertragliche Vereinbarung über die Erstellung der Technische Dokumentation, so zählt die üblich zu erwartende Beschaffenheit. Dieser Begriff aus dem Produktrecht besagt, dass ein Produkt über solche Eigenschaften…

In der Technischen Dokumentation müssen nur relevante Informationen vorkommen. Die Nutzugsinformationen müssen für den gesamten Produktlebenszyklus alle durchzuführenden und erlaubten Tätigkeiten abdecken. Ebenfalls müssen sicherheitsrelevante Informationen zu den jeweiligen Lebensphasen vorliegen. Deckt ein Produkt aufgrund seiner Eigenschaften bestimmte Lebensphasen nicht…

Rudimentäre Vorgaben für die Technische Dokumentation finden sich in der IEC/IEEE 82079-1. Diese Horizontalnorm gilt für alle Arten von Produkten. Daneben gibt es noch weitere produkt- oder branchenspezifische Normen. Bei Medizinprodukten liefert die EN ISO 20417 detaillierte Anforderungen für die…

Warnungen vor Restrisiken in der Technischen Dokumentation beginnen nach dem SAFE-Prinzip mit einem Signalwort. Die Norm IEC/IEEE 82079-1 schlägt dabei eine Vorgehensweise aus der ANSI Z535.6 vor, um das richtige Signalwort auszuwählen:

Die IEC/IEEE 82079-1 fordert für Warnhinweise in Technische Dokumentationen eine entsprechende Gestaltung, damit diese entsprechend auffallen. Durch eine Kopfzeile kann das einleitende Signalwort in einer anderen Schriftgröße oder Schriftart hervorgehoben werden. Sind Warnhinweise zwischen Handlungsschritten eingebettet, sollte die Formatierung des…

Die Technische Dokumentation ist Teil des Produktes, daher gilt es die Kosten für die Erstellung in die Produktentwicklung mit einzurechnen. Umso komplexer ein Produkt, desto umfangreicher ist natürlich auch die Technische Dokumentation. Gewisse Mindestinhalte müssen in jeder Dokumentation vorhanden sein…

Für Lastaufnahmemittel schreibt die Maschinenrichtlinie in Bezug auf die Technische Dokumentation bzw. Betriebsanleitung im Anhang I folgendes vor: “4.4.1 Lastaufnahmemittel Jedem Lastaufnahmemittel und jeder nur als Ganzes erhältlichen Gesamtheit von Lastaufnahmemitteln muss eine Betriebsanleitung beiliegen, die mindestens folgende Angaben enthält:a)…