Technische Dokumentation - Der Podcast zu allen Themen der technischen Dokumentation

Edition 2 der IEC / IEEE 82079-1 wurde im Mai 2019 veröffentlicht. Sie ist somit nun der Stand der Technik und sie fordert unter anderem, dass Anleitungen minimal und prägnant formuliert sind. Eine Anleitung soll nur noch die nötigsten Informationen beinhalten, alle anderen Informationen fallen raus. Überfrachtete Anleitungen gelten dadurch vor Gericht als fehlerhaft, unverständlich oder als nicht...

In dieser Folge führe ich die Merkmale von Utility Filme auf. Was sind überhaupt Utility-Filme? Und wie helfen diese interaktive Instruktionsfilme dem Anwender bei Handlungsabläufen? Wie können Utility-Filme unterstützend in der Technischen Dokumentation angewendet werden?

Vielen Unternehmen sind die gesetzlichen Anforderungen an die Anleitung nicht bekannt. Die Anleitung wird mangelhaft erstellt. So entstehen Haftungsrisiken. Diese Folge betrachtet die Anforderungen des Produktsicherheitsgesetzes, der Maschinenrichtlinie, der EMV-Richtlinie und der Niederspannungsrichtlinie.

Die DIN EN 82079-1 kann für alle Arten von Produkten angewendet werden. Also auch für Medizinprodukte. Oder gibt es andere Normen die angewendet werden müssen? Diese Folge betrachtet die Anforderungen von verschiedenen Normen und Richtlinien aus dem medizinischen Bereich und gleicht diese mit den Inhalten der DIN EN 82079-1 ab. Werden die Anforderungen durch die DIN EN 82079-1 erfüllt oder gibt es...

Betriebsanleitungen können sehr umfangreich sein. Vor allem der Text in der Anleitung nimmt den größten Platz ein. Wäre es nicht besser eine Betriebsanleitung zu haben, die auf Text verzichtet? Kann das in der Technischen Dokumentation bei Maschinen und Anlagen genauso einfach gehen wie mit den Anleitungen für Möbel bei IKEA? In dieser Folge befassen wir uns mit der textlosen Betriebsanleitung.

Diese Folge betrachtet die Medizinprodukteverordnung 2017/745 und die Veränderungen im Vergleich zur alten Medizinprodukterichtlinie. Aktuell befinden wir uns in der Übergangszeit zur neuen Verordnung, ab 2020 muss diese eingehalten und umgesetzt werden. Die neue Verordnung hat viele Anforderungen, darunter auch viele die die technische Dokumentation betreffen. Diese Folge betrachtet die Änderunge...

Eine Anlagendokumentation ist weit komplexer wie eine normale Dokumentation für eine Maschine. Der Technische Redakteur muss sich beim Verfassen Gedanken machen, wie er die Struktur für die Betriebsanleitung aufbaut. Wie gliedert man am besten die Dokumentation, wenn diese mehrere tausend Seiten umfasst? Falls die Anleitung dann noch auf Papier ausgedruckt werden soll, wie legt man diese organisat...

Diese Reihe betrachtet die besonderen Anforderungen von Medizinprodukten an Gebrauchsanleitungen. Im Zuge der Reihe "MED" betrachten wir die wichtigsten Normen für Medizinprodukte, die Medizinprodukteverordnung 2017/745 und weitere besondere Merkmale von Gebrauchsanweisungen. Diese Folge ist eine Basisfolge die grundlegende Begriffe und Besonderheiten klärt.

Die Anlagendokumentation beschreibt mehrere Maschinen innerhalb eines Maschinenkomplexes, die zusammenarbeiten. Eine solche Anlage nimmt viel Platz ein, häufig die Größenordnung einer Halle. Auch die Dokumentation hierfür nimmt viel mehr Platz ein als eine herkömmliche Dokumentation. Ich erläutere in dieser Folge was eine Maschinen-Anlage an sich ausmacht. Wie grenzt die Maschinenrichtlinie diese...

Diese Sonderfolge der Reihe "US-Produkthaftung" betrachtet den Absturz der beiden Flugzeuge von Boeing genauer. Wie kann es zu einer Produkthaftungsklage kommen und warum könnte der Haftungsfall als größter Haftungsfall der Luftfahrtgeschichte bekannt werden? Daneben betrachten wir den aktuellen Stand der Ermittlungen und die Produktentwicklung von Boeing.

Die Technische Dokumentation soll nicht zu aufgebläht daher kommen aber doch alles notwendige Wissen vermitteln. Mit Hilfe einiger weniger Regeln gelingt Ihnen auch dieser Spagat zwischen Umfang und Verständlichkeit. In dieser Folge zeigen wir Ihnen worauf es ankommt.

Diese Sonderfolge der Reihe "US-Produkthaftung" betrachtet beiden Haftungsfälle in den USA im Bezug auf Glyphosat und den Hersteller Monsanto. Die Fälle erzeugen weltweites Interesse da Monsanto vor einiger Zeit vom großen Hersteller Bayer aufgekauft wurde. Diese Folge zeigt den Verlauf der Gerichtsverhandlungen, Argumente der beiden Parteien, die Urteilsfindung und die Bedeutung der Fälle auf.

Jede Anleitung enthält Abbildungen oder Zeichnungen und informiert den Benutzer zusätzlich neben den Informationen im Text. Es gibt unterschiedliche Darstellungsformen von Abbildungen und Zeichnungen, darunter Fotos, 3D-Modelle, Strichzeichnungen oder Explosionszeichnungen, um nur ein paar zu nennen. Die wichtigsten Punkte für die Technische Dokumentation, die bei Abbildungen oder Zeichnungen zu b...

Nachdem ich in der letzten Woche darauf eingegangen bin, was ein Redaktionsleitfaden ist, für wen dieser gedacht ist und welche Vor- und Nachteile dieser mit sich bringt, möchte ich in dieser Folge darauf eingehen, welche Regelungen beim Verfassen eines Redaktionsleitfaden beachtet werden sollten.

Der Redaktionsleitfaden dient als eine Art „Bedienungsanleitung“, um technische Inhalte redaktionell und einheitlich aufzubereiten. Er enthält Arbeitsanweisungen für Mitwirkende und Beschreibungen zu wichtigen Vorgängen sowie Prozessschritte.

Die letzte Folge der Reihe "Software für die technische Dokumentation" betrachtet die Vor- und Nachteile von Adobe Framemaker. Adobe Framemaker ist das älteste Programm zur Erstellung und Verwaltung von Dokumenten wie Betriebsanleitungen. Doch ist es den Anforderungen der heutigen Dokumentation noch gewachsen? Diese Folge zeigt neben den Vor- und Nachteilen den Ursprung ders Programms auf und zieh...

Die dritte Folge der Reihe "Software für die technische Dokumentation" betrachtet die Vor- und Nachteile von Content-Management-Systemen und Redaktionssystemen. Sie werden häufig in Unternehmen eingesetzt, sind jedoch teuer und aufwändig in der Anschaffung. Lohnt sich dies für Unternehmen? Diese Folge zeigt neben den Vor- und Nachteilen den Ursprung der Systeme auf und zieht ein Fazit. Daneben tei...

Hersteller sind verpflichtet für diverse Produkte eine CE-Kennzeichnung an Ihrem Erzeugnis anzubringen bevor dieses auf dem europäischen Warenverkehr in Umlauf gebracht werden darf. Mit der CE-Kennzeichnung bestätigen die Hersteller, dass Ihre Produkte allen Anforderungen aus den zutreffende EU-Richtlinien einhalten. Diese Konformität mit den Richtlinien bestätigen die Hersteller mittels der Konfo...

Nachdem wir uns bereits mit den Artikeln und einem Teil des Anhang I der Maschinenrichtlinie befasst haben, schauen wir uns nun die restlichen Anhänge an. Wir werfen einen Blick auf die letzten 11 Anhänge und erläutern welche Sicherheits- und Gesundheitsschutzanforderungen darin vorkommen.

Die zweite Folge der Reihe "Software für die technische Dokumentation" betrachtet Microsoft Word als Tool für die Erstellung von Betriebs- und Gebrauchsanleitungen. Neben den Vor- und Nachteilen des Tools werden auch die Schwierigkeiten und mögliche Lösungen im Umgang besprochen. Zusätzlich werden Praxistipps gegeben und ein mögliches Vorgehen für die Erstellung von Anleitungen in Word vorgestellt...

Wir befassen uns mit den restlichen 12 Artikeln und den Anhang I der Maschinenrichtlinie. Dieser erste von 12 Anhängen enthält wichtige Schutzmaßnahmen für die Konstruktion von Maschinen. Wir erläutern die wichtigsten darin vorkommenden Sicherheits- und Gesundheitsschutzanforderungen.

Die neue Reihe "Software für die technische Dokumentation" betrachtet die Softwarelösungen die für die Erstellung von technischer Dokumentation. Mit welchen Tools können Betriebs- und Gebrauchsanleitungen erstellt werden und welche Vor- und Nachteile haben die einzelnen Lösungen? In der ersten Folge betrachten wir Adobe InDesign. Welche Vorteile bietet Adobe InDesign bei der Erstellung von Betrieb...

In dieser und der nächsten Folge will ich mich mit dem Aufbau der Maschinenrichtlinie befassen. Diese ist in mehrere Teile untergliedert. Ich beleuchte das einführende Kapitel und spreche in dieser Folge über die ersten 17 Artikel, welche die rechtlichen Anforderungen an Maschinen enthält. In der nächsten Folge betrachte ich die restlichen 12 Artikel sowie die 12 Anhänge der Maschinenrichtlinie.

„Normenrecherche für die technische Dokumentation“ zeigt heute Anhand eines Praxisbeispiels wie Normen und Richtlinien recherchiert werden können. Diese Folge ist die Zusammenfassung der vorangegangenen Folgen und bildet den Abschluss der Podcastreihe. Die Normenrecherche ist ein wichtiger Bestandteil der technischen Dokumentation und bildet die Grundlage für diese. Nur wenn die zutreffenden Norme...

„Normenrecherche für die technische Dokumentation“ beschäftigt sich heute mit Quellen für eine Normenrecherche. Wo findet man Normen und wie kann man dabei vorgehen? Außerdem wird die Durchführung der Normenrecherche besprochen und erklärt. Die Normenrecherche ist dabei ein wichtiger Bestandteil der technischen Dokumentation und bildet die Grundlage für diese. Nur wenn die zutreffenden Normen und...