Technische Dokumentation

Die Aufteilung der Technischen Dokumentation und auch der Betriebsanleitung in einzelne Dokumente ist durchaus sinnvoll und auch häufig gängige Praxis. Falls verschiedene Inhalte für unterschiedliche Zielgruppe vorgesehen sind, ist es übersichtlicher diese jeweiligen Inhalte in getrennten Dokumenten aufzuführen. Die Aufteilung…

Fachbegriffe in der Technischen Dokumentation einheitlich zu benennen sorgt für Verständlichkeit und Eindeutigkeit in einer Betriebsanleitung. Das Festlegen auf eine vorrangige Benennung von einem Fachausdruck ist auch als Terminologie bekannt. Das ist die Basis für Wiederverwendung, Konsistenz und Verständlichkeit der…

Im Juni 2019 erschien die ISO Norm 20607, welche für die Technische Dokumentation von Maschinen einige nützliche Gestaltungsgrundsätze für Betriebsanleitungen enthält. Die Norm gibt Inhalte und Struktur einer Betriebsanleitung vor. Zu jedem Kapitel einer Anleitung finden sich dazu detaillierte Aufstellungen…

Die Technische Dokumentation einer Maschine oder Anlage musste bisher immer in Papierform vorliegen. Die Dokumentationsnorm ISO 20607 schließt diese Lücke nun und passt dazu den Sachverhalt an den Stand der Technik an. Es ist nun möglich unterschiedliche Publikationsmedien zu wählen,…

Im Gegensatz zur Technischen Dokumentation einer Maschine benötigen Medizinprodukte eine Gebrauchsanweisung. Dies fordert die Medizinprodukteverordnung für Medizinprodukte. Die Verordnung macht genaue Angaben zu den Inhalten der Gebrauchsanweisung. Daneben kommen von der IEC 62366-1, der IEC 60601-1, der DIN EN 1041,…

Die Fehler, die beim Erstellen einer Gebrauchsanleitung für Medizinprodukte auftreten, unterscheiden sich nicht merklich von einer Technischen Dokumentation im Maschinenbau. Auch bei Medizinprodukte treten die üblichen Fehler auf, die bei der Erstellung einer Betriebsanleitung vorkommen. Zu den häufigsten Fehlern bei…

Der Umfang der Warnhinweise in der Technischen Dokumentation hängt von der Risikobeurteilung ab. Diese beschreibt Tätigkeiten und legt für diese Tätigkeiten auch die entsprechenden Personalqualifikationen fest. Bei den Beschreibungen der Tätigkeiten ermittelt man dann die Risiken bei den Tätigkeiten. Eine…

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…