FAQs

Zum Beispiel

• Saubere Erarbeitung der Zielgruppe schon in der Risikobeurteilung
• Ein anwenderorientiertes Dokumentationskonzept, wie beispielsweise ARAKonzept
• Terminologiearbeit, um die Sprache des Anwenders zu verwenden.
• Auszeichnung der verschiedenen Inhalte
• Was fällt Ihnen ein, schreiben sie uns?

Lange Jahre lag der Hauptfokus einer Betriebsanleitung auf der Rechtssicherheit, ausgelöst durch steigende rechtlichen Anforderungen,
Rechtssicherheit war auch für Laien ein fassbarer Begriff und dadurch ein schlagendes Argument. Die Praxistauglichkeit geriet dadurch teilweise in den Hintergrund. Bei Anwenderdokumentation steht dagegen der tatsächliche Anwender vor Ort im Mittelpunkt, nicht der Jurist.

Ziel effizienter Anwenderdokumentation ist es, die Anwender in die Lage zu versetzen, mit dem Produkt umzugehen.

Daher ist eine Komponente der Anwenderdokumentation die ergebnisorientierte Kommunikation (Befähigungskommunikation nach Klaus C. Hofer oder auch Sofort-Anleitung nach Dietrich Juhl). Die Anwender können die Anweisungen der ergebnisorientierten Kommunikation unmittelbar in Handlungen umsetzen. Ergebnisorientierte Kommunikation beschränkt sich auf dieses eine Ziel. Sie ist daher vom Umfang her kürzer als herkömmliche Produktdokumentation. Sie besteht im Kern aus Handlungsanleitungen. Weitere Informationen über das Produkt sind nur enthalten, wenn die Anwender sie bei ihren Aktionen mit dem Produkt benötigen.

Bei komplexen Produkten genügt es aber meist nicht, den Anwender in die Lage zu versetzen, bestimmte Handlungen unmittelbar durchzuführen. Dies gilt insbesondere deshalb, weil bei komplexen Produkten zu viele unterschiedliche, anwendungsspezifische Handlungen möglich sind.

Bei komplexen Produkten kommt es daher darauf an, den Anwendern das systematische Übertragen von Prinzipien von einer Handlung auf die nächste zu ermöglichen. Daher werden hier Konzepte des Produkts vermittelt.

Verständnisorientierte Anwenderdokumentation ermöglicht den Anwendern, an vorhandenes Fachwissen anzuknüpfen und neue Kenntnisse aufzubauen. Die verständnisorientierte Anwenderdokumentation baut daher auf bereits erlerntem Wissen auf und rekapituliert dieses auch teilweise, ohne jedoch den Lernschritt (z. B. das Training) ersetzen zu wollen. Bei einfachen Produkten mit nur wenigen Handlungsmöglichkeiten bzw. sehr einfach eingängigen Handlungen kann die verständnisorientierte Anwenderdokumentation entfallen.

Ausgangspunkt für die Erstellung von effizienter Anwenderdokumentation ist die Zweck- und Zielgruppenanalyse.

Erst nach einer Zweck- und Zielgruppenanalyse weiß der Autor genau, was er wirklich dokumentieren muss.

Bei der Zielgruppenanalyse für die Anwenderdokumentation werden folgende Fragen beantwortet:

• Wer sind meine Anwender?
• Welche Aus-/Vorbildung haben sie?
• Was können/wissen sie schon im Hinblick auf den Umgang mit meinem Produkt?
• Was wollen sie mit meinem Produkt tun und was nicht?
• Welche Probleme haben sie damit und welche nicht?

Bei der Zweckanalyse werden folgende Fragen beantwortet:

Welchem Zweck dient die Dokumentation und welchem nicht?

Ist es notwendig, dass die Anwender die Konzepte des Produkts verstehen, oder genügt es, wenn sie einige Handlungen unmittelbar durchführen können?

Als Ergebnis der Zweck- und Zielgruppenanalyse werden die Antworten auf die Fragen so festgehalten, dass die entstehende Dokumentation daran gemessen werden kann.

Nützliche Anwenderdokumentation besteht aus zwei unterschiedlichen Ansätzen:

Der zielorientierte Ansatz stellt die ergebnisgerichtete Durchführung der Aktivitäten in den Mittelpunkt; Beispiel: Um das zu erreichen, machen sie dies.

Der verständnisorientierte Ansatz vermittelt Konzepte und ermöglichen das einfache Übertragen von Aktivitäten; Beispiel: Der Einbau erfolgt in umgekehrter Richtung wie der Ausbau. Gemeinsam ist beiden Ansätzen nutzenorientierter Anwenderdokumentation, dass die Anwender können die Antworten auf ihre Fragen schnell und sicher finden.

ARAKonzept berücksichtigt beide Komponenten optimal.

Für die Erstellung einer Betriebsanleitung ist es zunächst notwendig eine Zielgruppe und Zweckbeschreibung zu erstellen. Je nach Wissensstand der Zielgruppe kann der Inhalt der Betriebsanleitung umfangreich oder weniger umfangreich sein.

Die Erstellung von Betriebsanleitungen ist immer dann notwendig, wenn ein Hersteller ein Produkt auf den Markt bringt. Das bedeutet immer dann, wenn Menschen mit dem Produkt in Kontakt kommen. Dazu gehören auch Messe Ausstellungen. Sinnvollerweise ist die Erstellung einer Betriebsanleitung entwicklungsbegleitend.

Wie hoch der Aufwand für eine Betriebsanleitung ist, hängt vom Leistungsumfang ab und lässt sich nicht pauschal beantworten. Handelt es sich um eine Neuentwicklung oder um eine Erweiterung einer Maschine? Oftmals lassen sich im zweiten Fall, viele Inhalte wiederverwenden und es sind nur Maschinenspezifische Anpassungen notwendig. In solch einem Fall ist der Aufwand selbstverständlich niedriger als bei einer Neuentwicklung. Wie der Name „Neuentwicklung“ schon sagt, müssen Inhalte neu geschrieben werden, was in der Regel länger dauert.

Umso genauer der Leistungsumfang definiert ist, desto genauer lassen sich davon Aufwandsabschätzungen ableiten. Darüber hinaus ist es sinnvoll, wenn zum vereinbarten Leistungsumfang auch benötigte Informationen vorliegen, wie zum Beispiel (Betriebsanleitung von vergleichbaren Maschinen), um genauere Aufwandsabschätzungen machen zu können.

Neben der Betriebsanleitung gibt es weitere Dokumente die zur Betriebsanleitung gehören. Hierbei handelt es sich vor allem um Dokumente, auf die in der Betriebsanleitung verwiesen wird. Oftmals wird in der Betriebsanleitung auf die folgenden Dokumente verwiesen:

• Schaltpläne
• Teilelisten
• Zulieferdokumentation
• Zeichnungen
• Datenblätter
• Erklärungen

Angaben über eine mögliche vorhersehbare Fehlanwendung muss jede Technische Dokumentation bzw. Betriebsanleitung einer Maschine oder eines Produktes enthalten.

Ein Produkt darf nur dann auf den Markt bereitgestellt werden, wenn sowohl bestimmungsgemäße als auch vorhersehbare Verwendung des Produktes sicher ist. Das bedeutet, dass Fehlanwendungen, die sich aus leicht absehbarem menschlichem Verhalten ergeben können, nicht auszuschließen sind. Somit gilt es vor Gefahren dieser vernünftigerweise vorhersehbaren Fehlanwendung in der Technischen Dokumentation zu warnen.

Screenshots sind besonders sinnvoll bei Betriebsanleitungen von Software-Produkten, da Sie die Benutzeroberfläche abbilden. Der Nutzer kann sich somit hervorragend orientieren und jeden Schritt besser nachvollziehen als mit reinem Text.

Achten Sie darauf, dass die Inhalte Ihrer Betriebsanleitung leicht lesbar und auf Ihre Zielgruppe angepasst sind. Nur welche Zielgruppen werden in der Technischen Dokumentation angesprochen?

Eins ist klar. Die Zielgruppe Ihres Produktes ist vorwiegend der Endnutzer bzw. Anwender. Aber auch andere Zielgruppen werden in Ihrer Betriebsanleitung angesprochen. Beispielsweise das Montagepersonal, Wartungspersonal oder der Inbetriebnehmer.

Es müssen zuerst einige Dinge geklärt werden, bevor Sie eine Bedienungsanleitung erstellen:

• Definition des Produktes
• Bestimmungsgemäßer Gebrauch
• Unsachgemäßer Gebrauch
• Risikobeurteilung
• Welche Richtlinien und Normen gelten für mein Produkt?
• Alle Technischen Daten, Messprotokolle, Spezifikationen, Zuliefererkomponenten, Zertifikate usw. müssen gesammelt und in einem Technischen Ordner verwahrt werden

Die Betriebsanleitung muss alle Phasen des Produktlebenszyklus abbilden. Von der Beschreibung des Produktes über den Transport, Montage, Inbetriebnahme, Bedienung, Wartung, Reparaturarbeiten bis hin zur Entsorgung. Dies muss allerdings nicht alles einer einzigen Betriebsanleitung stehen. Sie können die Betriebsanleitung auch in mehrere Dokumente aufteilen.

Eine gute Textverständlichkeit in einer Betriebsanleitung ist eine der wichtigsten Aspekte für uns Technische Redakteure. Aber wie erreiche ich das? Hier ein paar Tipps:

• Haben Sie Ihre Zielgruppe im Blick! Passen Sie Ihre Texte Ihrer Zielgruppe an. Schreiben Sie für einen unerfahrenen Nutzer oder für eine gelernte Fachkraft? Müssen Fachwörter erklärt werden oder nicht?
• Schreiben Sie möglichst einfach! Prüfen Sie, ob Ihre Sätze zu lang sind. Enthält Ihr Text Fremdwörter, die erklärt werden müssen? Schreiben Sie konkret und anschaulich.
• Achten Sie auf eine sinnvolle Gliederung und Ordnung! Bauen Sie den Inhalt Ihres Textes sinnvoll auf und nutzen Sie Aufzählungen, Formatierungen und Gliederungen. Das hält die Aufmerksamkeit hoch.
• Benutzen Sie eine aktive Schreibweise mit Kürze und Prägnanz! Dies ist in der technischen Dokumentation ein Muss. Beschreiben Sie alles Notwendige, aber achten Sie darauf, dass es nicht zu knapp beschrieben wird. Die Verständlichkeit darf nicht darunter leiden.

Können Gefahren bei einer bestimmten Handlung auftreten, ist es wichtig vor diesen Gefahren zu warnen. Beispielsweise bei einer Wartungsarbeit. Es reicht nämlich nicht nur die Warnhinweise im Sicherheitskapitel aufzuführen. Der Ersteller der Betriebsanleitung darf nämlich nicht annehmen, dass der Leser jedes Mal das Sicherheitskapitel vorher aufschlägt.

Nein, viele wichtige und sicherheitsrelevante Informationen finden sich in Anleitungen oder auch Erklärungen. In Wikipedia ist z. B. eine genaue Beschreibung der Absturzursachen der Boing 737 Max zu finden. Hier gibt es drei Stellen, die die Bedeutung von Dokumentation und Schulung verdeutlichen:

• MCAS (ein automatisches Fluglageregelsystem) und seine möglichen Fehlfunktionen wurden den Piloten jedoch nie erklärt, was eine Fehlreaktion der Besatzung wahrscheinlich machte.
  • Fehlende Schulung, wahrscheinlich auch fehlende Dokumentation. Verständnis von Konzepten und Zusammenhängen sind die Voraussetzung für kompetentes Handeln
• Der Captain litt unter einer Grippe; der Erste Offizier erhielt schlechte Beurteilungen während seiner Ausbildung. Er brauchte vier Minuten, um in der Checkliste die relevanten Seiten zu finden.
  • Hier könnten der Aufbau und die Gestaltung der Checklisten ein Teil des Problems gewesen sein. Zeit verstrich – ein Baustein auf dem Weg zur Katastrophe.
• Der Verkäufer des Anstellwinkel-Sensors hatte diesen nicht korrekt kalibriert. Es fehlte eine schriftliche Prozedur, um den Sensor korrekt und fehlerfrei kalibrieren zu können.
  • Bei der Kalibrierung des Sensors hätte es sicher keine Warnung gegeben. Aber das Fehlen der Anleitung war tödlich.

Das ist sehr unterschiedlich, abhängig von den Fähigkeiten der verwendeten Programme und der Anforderungen. Generell müssen folgende Arbeiten abgedeckt werden:

• Textbearbeitung
• Grafikbearbeitung
• Dateiverwaltung
• Druckverwaltung

Welche Sicherheits- und Warnhinweise in die Betriebsanleitung gehören, ist in der Risikobeurteilung festgelegt. Die Risikobeurteilung identifiziert potentielle Gefahren und legt fest, wie diese zu beseitigen sind. Lassen sich potentielle Gefahren über Sicherheitsmaßnahmen nicht komplett ausschließen, spricht man von einem „Restrisiko“. Diese Restrisiken gehören in die Betriebsanleitung. Zum einen als Sicherheitshinweis, wenn das Restrisiko immer besteht und zum anderen als Warnhinweis, wenn es um konkrete Handlungsanweisungen geht.

Ein Warnhinweis ist eine Kombination aus Grafik und Text, die vor einer Handlung oder einer Situation warnt und einen definierten Aufbau hat. Der Aufbau sollte im SAFE-Prinzip erfolgen. Es ist folgendermaßen aufgebaut:

• S = Signalwort z. B. Gefahr, Warnung, Vorsicht.
• A = Art und Quelle der Gefahr z. B. Verbrennungsgefahr durch heiße Oberflächen.
• F= Folgen bei Nichtbeachtung des Warnhinweises z. B. Schwere Verbrennungen/Verletzungen.
• E = Entkommen z. B. Tragen Sie geeignete Handschuhe.

Die Erstellung von Anleitungen ist immer dann notwendig, wenn ein Hersteller ein Produkt auf den Markt bringt. Es ist also gesetzlich vorgeschrieben, dass eine Anleitung mitgeliefert werden muss. Allerdings kann Technische Dokumentation viel mehr sein als nur Normkonformität und Rechtssicherheit. Sie kann zu einer Aufwertung des Produktes führen. Eine gute Anleitung kann dem Nutzer, sei es dem Servicetechniker oder dem Bedienpersonal, helfen, gut oder noch besser mit dem Produkt umzugehen. Dieses besser zu verstehen und eventuell die Arbeit des Benutzers zu erleichtern.

Eine Betriebsanleitung sollte generell an den Produktlebenszyklus des Produktes angepasst werden. Auch sollten die einzelnen Kapitel an die Zielgruppe angepasst werden. Eine mögliche Struktur könnte so aussehen:

·        Allgemeines

·        Sicherheitskapitel

·        Transport, Montage und Inbetriebnahme

·        Bedienung

·        Wartung und Instandsetzung

·        Außerbetriebnahme, Demontage und Entsorgung

Einen besseren Überblick gibt euch unsere Musterdokumentation zum Download. Siehe hier: Branchenspezifische Dokumentation · ARAKANGA GmbH

Wer kennt es nicht? Dokumente, die nur aus Fließtext bestehen. Das mag nicht nur keiner lesen, es ist unglaublich mühsam die richtigen Informationen aus dem Text zu suchen. Solche Dokumente verschwenden Geld, egal ob sie kurz oder lang sind. Mit einem richtigen Strukturierungskonzept ist es möglich systematische, einheitliche und erweiterbare Muster für Inhalt, Struktur und Gestaltung von Dokumenten zu erstellen.

Martin Holzmann von ARAKANGA hat eine eigene, sehr effiziente Strukturierungsmethode namens „ARAKonzept“ entwickelt. Mehr zur Strukturierungsmethode ARAKonzept findet Ihr hier: ARAKonzept als Strukturierungsmethode · ARAKANGA GmbH

Die Strukturierung einer Betriebsanleitung ist maßgeblich dafür verantwortlich, ob Inhalte wahrgenommen werden oder nicht. Eine gute Strukturierung sorgt für eine bessere Übersicht, die dem Anwender dabei unterstützt, genau die Inhalte zu finden, nach denen er sucht. In der Regel schaut ein Anwender in eine Anleitung, weil er eine Frage zum Produkt hat. Mithilfe einer guten Strukturierung kann er diese in einer Betriebsanleitung schnell finden.

Die Zielgruppenanalyse ist für die Erstellung einer Betriebsanleitung wichtig, weil die Zielgruppenanalyse darüber entscheidet, welche Inhalte zu beschreiben sind und welche nicht notwendig sind. Die Zielgruppenanalyse gibt darüber Auskunft, welche Tätigkeiten von welchen Personal auszuführen sind und welche Qualifikation dafür notwendig sind.

Grundsätzlich beginnt jede Betriebsanleitung mit einer umfangreichen Recherche zu dem Produkt. Hierfür werden verschiedenste Quellen herangezogen. Danach wird festgelegt, welche Zielgruppen man hat und welche Informationen diese benötigen. Welche Informationsbausteine liegen vor und welche müssen neu erstellt werden? Soll die Betriebsanleitung in einem Redaktionssystem erstellt werden? Erst wenn all diese Fragen geklärt sind, beginnt das eigentliche Schreiben. Nachdem die Texte erfasst sind, durchlaufen diese mindestens zwei Freigabeprozesse.

Um eine Betriebsanleitung zu erstellen, wird grundsätzlich eine umfangreiche Recherche zum Produkt betrieben. Technische Redakteure bedienen sich hierfür an verschiedenen Informationsquellen:

• Dokumentationen der Vorgängermodelle
• Interviews mit Ansprechpartner und Produktkenner
• CAD-Modelle, Videos, 3D-Animationen
• Entwicklungsunterlagen

Das ist kurz und knapp zu beantworten. Ja, Ihre Betriebsanleitung braucht eine Beschreibung des Produktes. Auch die bestimmungsgemäße Verwendung des Produktes muss beschrieben werden.

Ein Lektorat bei der Erstellung einer Betriebsanleitung ist unabdingbar und ein wichtiges Qualitätskriterium. Lassen Sie Ihre Betriebsanleitung von einem zweiten Technischen Redakteur oder einem Ansprechpartner für das Produkt prüfen. Beim Lektorat sollte dieser sich an den folgenden Kriterien halten:

• Ist die Betriebsanleitung übersichtlich und verständlich?
• Fehlen notwendige Informationen?
• Sind alle Informationen fachlich korrekt?
• Gibt es Wiederholungen?
• Ist der Informationsgehalt nachvollziehbar?

Die interne Dokumentation eines Herstellers ist ursprünglich nicht die Aufgabe der Technischen Redaktion. Sie ist grundsätzlich von anderen Fachabteilungen des Herstellers zu erledigen. Die Technische Redaktion kann jedoch wertvolle Unterstützungsarbeit leisten.

Es kann in der Praxis durchaus vorkommen, dass es sinnvoll ist, eine Betriebsanleitung in einzelne Handbücher aufzuteilen. Somit bleibt eine komplexe und umfangreiche Dokumentation übersichtlich.

Teilen Sie die Inhalte der Handbücher zielgruppengerecht auf. Beispielsweise enthält ein Montagehandbuch nur die Inhalte der Montage und das Wartungshandbuch die Inhalte zur Wartung und Instandsetzung.

Achten Sie darauf, dass die Inhalte leicht lesbar und Ihrer Zielgruppe entsprechend angepasst sind. Lernen Sie Ihre Zielgruppe kennen und definieren Sie diese. Recherchieren Sie die Wortwahl und den Kenntnisstand. Ein unerfahrener Produktbenutzer möchte lieber weniger Fachwörter, während ein Experte des Produktes mit mehr Fachwörtern umgehen kann.

Wichtig ist auch, vorhandene Inhalte, die in mehreren Handbüchern anwendbar sind, nicht doppelt aufzuführen. Sinnvoller und besser ist es, auf die Inhalte zu verweisen.

Ein einheitliches Konzept mit Inhalt, Struktur und Gestaltung sowie einem Vorgehen von der Informationsrecherche bis zur Übersetzung der Betriebsanleitung macht definitiv Sinn und ist wichtig, um den Anforderungen in der Betriebsanleitung gerecht zu werden. Wir von Arakanga haben deshalb das ARAKonzept entwickelt. Was das ARAKonzept ist und welchen Nutzen es mit sich bringt, erfahrt Ihr hier: https://arakanga.de/beratung/arakonzept/was-ist-arakonzept/ .

Eine gute Betriebsanleitung für Software hilft dem Endbenutzer, der mit der Software arbeitet, die Funktionen und Eigenschaften zu verstehen und bietet dem Endbenutzer alle wichtigen Informationen an, um die Software zu benutzen. Ihre Betriebsanleitung erklärt, wie Ihre Software funktioniert, wie der Endbenutzer die Software bedient und wie sie entwickelt wurde.

Normen und Gesetze sind äußerst wichtig in der Technischen Dokumentation. Sicherheit ist kein einfaches Thema. Daher ist es gut so, dass es Normen und Gesetze gibt, die uns helfen, Risiken zu vermeiden (beispielsweise Pflicht zur Risikobeurteilung). Allerdings entsteht eine gute Dokumentation nicht nur mit der Einhaltung von Normen. Ein guter Redakteur weiß: Es ist notwendig, zielgruppengerecht zu schreiben. Der Anwender bzw. Leser soll alle Informationen erhalten, die er benötigt. Und das in verständlicher Sprache!

Vor allem die Kapitel „Wartung“ und „Instandsetzung“ sind oftmals mit Verweisen auf die Herstellerdokumentation versehen. Das muss auch so sein, denn der Maschinenhersteller ist nach der Maschinenrichtlinie für die „Gesamtheit“ der ausgelieferten Maschine verantwortlich. Doch ist ein Verweis auf eine auszuführende Tätigkeit dafür ausreichend?

Gemäß der DIN EN ISO 20607 ist das richtig, aber es muss dementsprechend auch die Herstellerdokumentation mitgeliefert werden. Die Aufgabe des Redakteurs besteht darin, zu prüfen, ob der Verweis auf die auszuführende Tätigkeit tatsächlich in der Herstellerdokumentation nachzuschlagen ist.

Wenn das nicht der Fall ist, darf der Verweis nicht verwendet werden. Es ist erforderlich den Hersteller darauf aufmerksam zu machen.

Für das Anbringen einer CE-Kennzeichnung muss zunächst ein Verfahren zur Konformitätsbewertung vorliegen, bei dem nachgewiesen wird, dass alle Anforderungen zur Sicherheit erfüllt wurden. Dabei erfolgt eine sogenannte „Anwendungsprüfung“ von Rechtsvorschriften, wie bspw. die Maschinenrichtlinie 2006/42/EG. Die Anwendungsprüfung stellt sicher, dass alle geltenden Rechtsvorschriften identifiziert und eingehalten wurden. Als Nachweis zur Einhaltung der Rechtsvorschriften eignen sich Normen, deren Anwendung im Konformitätsverfahren aufgelistet werden. Erst nachdem, die Konformität über das Bewertungsverfahren nachgewiesen wurde, darf die CE-Kennzeichnung am Produkt angebracht werden.

Ein Content Delivery Portal ist ein Zugang bspw. eine Internetseite, über die Informationen bereitgestellt werden. Diese sind funktional aufgebaut und bieten dem Nutzer den Vorteil, nur die Information zu erlangen, die für sein Vorhaben benötigt werden. Damit die Suche die passenden Informationen zu einer Frage ausgibt ist es notwendig Metadaten zu hinterlegen. Wie ein CDP aufgebaut ist und funktioniert können Sie hier nachlesen: Content Delivery Portal · ARAKANGA GmbH.

IiRDS steht für „International Standard for intelligent information Request and Delivery“ und ist ein Standard, der für die Bereitstellung intelligenter Informationen entwickelt wurde. Das Ziel mit dieser Methode ist es, die benötigten Informationen im spezifischen Kontext, zur gewünschten Zeit, individualisiert und auf bestimmen Endgeräten bereitzustellen. Genau das, was ein Content-Delivery-Portal leisten sollte. Im Grunde ist iiRDS ein Austauschformat, welches für die Nutzung von Content-Delivery-Portalen genutzt wird. Mit iiRDS können gängige Formate wie beispielsweise PDF oder XML mit iiRDS-Metadaten klassifiziert werden. Anschließend können alle Inhalte, samt Metadaten als iiRDS-Paket exportiert und in ein Content-Delivery-Portal importiert werden.

Damit Informationen über ein Content Delivery Protal gefunden werden können müssen diese zunächst mit Metadaten versehen sein. Über die Metadaten werden die passenden Suchergebnisse realisiert. Aber nicht nur die Metadaten sind wichtig, sondern auch die Art und Weise, wie Inhalte aufbereitet sind. Im Idealfall sind die Inhalte für ein Content Delivery Portal so aufbereitet, dass Sie auf mögliche Fragen der Nutzer antworten, sogenannte „Frage-Antwort-Sequencen“.

Eine Frage-Antwortsequenz ist ein in sich geschlossener Informationsbaustein,  als Fließtext, Liste,  Tabelle oder Grafik.

Mehr Informationen darüber, wie Sie Inhalte optimal für ein Content Delivery Portal aufbereiten erhalten Sie hier: Das Vorgehensmodell von ARAkonzept · ARAKANGA GmbH

Bei der DIN EN IEC/IEEE 82079 handelt sich dabei um eine internationale Norm, die die Anforderungen an die Erstellung von Gebrauchsanleitungen für verschiedene Produkte festlegt.

Die Norm wurde von mehreren internationalen Organisationen gemeinsam entwickelt, darunter das Deutsche Institut für Normung (DIN), das Internationale Elektrotechnische Komitee (IEC) und das Institute of Electrical and Electronics Engineers (IEEE).

Die DIN EN IEC/IEEE 82079 beschreibt Richtlinien und Empfehlungen, wie technische Informationen und Gebrauchsanleitungen für Produkte verfasst und gestaltet werden sollten, um eine klare, verständliche und sichere Kommunikation zwischen Herstellern und Benutzern zu gewährleisten. Sie ist in erster Linie darauf ausgerichtet, dass die Informationen in den Anleitungen leicht verständlich und anwenderfreundlich sind, damit die Produkte sicher und effizient genutzt werden können.

Die Norm behandelt verschiedene Aspekte der Erstellung von Gebrauchsanleitungen, einschließlich der Strukturierung der Informationen, der Gestaltung, der Verwendung von Symbolen und Piktogrammen, der sprachlichen Formulierungen und der Verwendung von Sicherheitshinweisen.

Die DIN EN IEC/IEEE 82079 “Erstellung von Gebrauchsanleitungen für Produkte” bietet eine Reihe von positiven Aspekten, die dazu beitragen können, dass Gebrauchsanleitungen für Produkte effektiver und benutzerfreundlicher gestaltet werden. Hier sind einige der positiven Aspekte der Norm:

• Klare und verständliche Kommunikation
  Die IN EN IEC/IEEE 82079 stellt sicher, dass die Informationen in den Gebrauchsanleitungen klar und verständlich formuliert werden. Dadurch wird die Kommunikation zwischen Herstellern und Benutzern verbessert, was zu einem besseren Verständnis der Produkte und deren ordnungsgemäßer Nutzung führt.
• Benutzerfreundlichkeit
  Durch Einhalten der IN EN IEC/IEEE 82079 können Gebrauchsanleitungen benutzerfreundlicher gestaltet werden. Die Strukturierung der Informationen, die Verwendung von verständlichen Symbolen und Piktogrammen sowie klare sprachliche Formulierungen tragen dazu bei, dass Benutzer die Anleitungen leichter durchlesen und die gewünschten Informationen schneller finden können.
• Sicherheit
  Die IN EN IEC/IEEE 82079 legt besonderen Wert auf die Integration von Sicherheitshinweisen in die Gebrauchsanleitungen. Dadurch können potenzielle Risiken und Gefahren im Umgang mit dem Produkt deutlich gemacht und Unfälle vermieden werden.
• Internationale Harmonisierung
  Die IN EN IEC/IEEE 82079 wurde von mehreren internationalen Organisationen entwickelt, was zu einer weltweit einheitlichen Herangehensweise an die Erstellung von Gebrauchsanleitungen führt. Dies erleichtert den Herstellern den Zugang zu globalen Märkten, da sie ihre Produkte gemäß den internationalen Standards dokumentieren können.
• Verbesserte Produktwahrnehmung
  Gut gestaltete Gebrauchsanleitungen tragen auch zur positiven Wahrnehmung des Produkts bei. Benutzer fühlen sich oft besser unterstützt und haben mehr Vertrauen in ein Produkt, wenn sie eine gut strukturierte und verständliche Anleitung zur Verfügung haben.

• Rechtliche Konformität
  Die Einhaltung der IN EN IEC/IEEE 82079 kann dazu beitragen, dass Produkte den gesetzlichen Anforderungen und Vorschriften für Gebrauchsanleitungen entsprechen. Dies kann Haftungsrisiken für Hersteller reduzieren und eine solide rechtliche Grundlage für die Produkte bieten.

Es ist wichtig zu beachten, dass die positiven Auswirkungen der Norm stark von der Umsetzung durch die Hersteller abhängen. Die effektive Anwendung der Richtlinien und Empfehlungen in der DIN EN IEC/IEEE 82079 kann dazu beitragen, dass Gebrauchsanleitungen zu einem wertvollen Instrument für eine bessere Produktnutzung und -sicherheit werden.

Sowohl die DIN EN ISO 20607 als auch die DIN EN 82079 beschäftigen sich mit der Erstellung von Betriebsanleitungen, aber sie haben unterschiedliche Anwendungsbereiche und Schwerpunkte.

Anwendungsbereich der DIN EN ISO 20607:
Die DIN EN ISO 20607 richtet sich speziell an den Maschinenbau und behandelt die allgemeinen Gestaltungsgrundsätze von Betriebsanleitungen für Maschinen. Sie legt die Anforderungen an den Inhalt, die Struktur und die Darstellung von Betriebsanleitungen fest, um die Sicherheit der professionellen Benutzer zu gewährleisten.

Anwendungsbereich DIN EN IEC/IEEE 82079
Die DIN EN IEC/IEEE 82079 ist eine allgemeinere Norm für Bedienungsanleitungen. Sie kann auf verschiedene Arten von Produkten angewendet werden, einschließlich Maschinen, Geräten, elektronischen Produkten usw. Die Norm definiert die Anforderungen an die Erstellung von Bedienungsanleitungen, einschließlich der Inhalte, der Struktur, der sprachlichen Gestaltung und der visuellen Darstellung.

Die DIN EN ISO 20607 gehört zur ISO 12100-Normenreihe, die sich speziell mit der Sicherheit von Maschinen befasst. Sie ist international anerkannt und wird von der Internationalen Organisation für Normung (ISO) entwickelt.

Die DIN EN IEC/IEEE 82079 hingegen ist eine eigenständige Norm, die von der Europäischen Normungsorganisation CEN (European Committee for Standardization) entwickelt wurde. Sie hat ebenfalls internationale Anerkennung als IEC/IEEE Norm, wird aber nicht direkt von der ISO herausgegeben.

Während die DIN EN ISO 20607 den Schwerpunkt auf die Sicherheit von Maschinen legt und spezifische Anforderungen an die Betriebsanleitungen in diesem Bereich festlegt, legt die DIN EN 82079 den Schwerpunkt auf die Benutzerfreundlichkeit und die Kommunikation von Informationen in Gebrauchsanleitungen.

Die DIN EN 82079 enthält ausführlichere Anleitungen zur sprachlichen Gestaltung, zur Verwendung von Symbolen und Piktogrammen, zur Einbeziehung von Risikobeurteilungen und zur Benutzergruppenanalyse. Sie bietet einen breiteren Ansatz für die Erstellung von Gebrauchsanleitungen, der über die Sicherheitsaspekte hinausgeht.

Obwohl es Unterschiede zwischen den beiden Normen gibt, gibt es auch einige gemeinsame Anforderungen und Prinzipien, da beide letztendlich dazu dienen, benutzerfreundliche und informative Anleitungen zu erstellen, die die Sicherheit und den Gebrauch von Produkten unterstützen. Es ist wichtig, die jeweiligen Anforderungen der relevanten Norm im Kontext der spezifischen Produkte oder Maschinen zu berücksichtigen.

Obwohl die DIN EN IEC/IEEE 82079 “Erstellung von Gebrauchsanleitungen für Produkte” viele positive Aspekte hat, gibt es auch einige potenzielle negative Aspekte oder Kritikpunkte:

• Strenge Einhaltung
  Die DIN EN IEC/IEEE 82079 enthält bestimmte Anforderungen und Vorgaben, die von den Herstellern umgesetzt werden müssen. Einige Kritiker argumentieren, dass diese strengen Vorgaben möglicherweise nicht in allen Fällen angemessen sind oder zu einer “Überregulierung” führen könnten, die den kreativen Freiraum der Hersteller bei der Erstellung von Anleitungen einschränkt.
• Eingeschränkte Flexibilität
  Die DIN EN IEC/IEEE 82079 kann möglicherweise nicht in der Lage sein, alle Besonderheiten und unterschiedlichen Bedürfnisse verschiedener Produkte oder Branchen angemessen zu berücksichtigen. Manche Produkte erfordern möglicherweise spezifische Formate oder Stile, die nicht vollständig mit den Normvorgaben übereinstimmen.
• Sprachliche Herausforderungen
  Bei der Übersetzung der Anleitungen in verschiedene Sprachen können sprachliche Nuancen und kulturelle Unterschiede nicht immer perfekt berücksichtigt werden. Dies könnte zu Missverständnissen oder Unklarheiten führen, insbesondere wenn spezialisierte Fachterminologie verwendet wird.
• Kostenaufwand
  Die Implementierung der DIN EN IEC/IEEE 82079 kann für Hersteller zusätzliche Kosten bedeuten, sowohl in Bezug auf die Anpassung der Anleitungen als auch auf die Schulung der Mitarbeiter, die die Richtlinien umsetzen müssen. Dies kann für kleinere Unternehmen eine finanzielle Belastung darstellen.
• Zeitlicher Aufwand
  Die Umsetzung der DIN EN IEC/IEEE 82079 erfordert Zeit und Ressourcen, insbesondere bei Produkten mit komplexen Funktionen und Merkmalen. Dadurch könnte sich die Markteinführungszeit verlängern, was für einige Hersteller ein Nachteil sein kann.
• Begrenzte Nutzerbeteiligung
  Obwohl die DIN EN IEC/IEEE 82079 darauf abzielt, die Benutzerfreundlichkeit der Anleitungen zu verbessern, wird die tatsächliche Beteiligung der Benutzer möglicherweise nicht immer ausreichend berücksichtigt. Benutzerfeedback und Benutzertests könnten eine wertvolle Ergänzung sein, um die Anleitungen kontinuierlich zu optimieren.
• Potenzielle Abhängigkeit von der DIN EN IEC/IEEE 82079
  Es besteht die Möglichkeit, dass einige Hersteller die Norm als alleinige Referenz für die Erstellung von Anleitungen verwenden, ohne kritisch zu prüfen, ob spezifische Anforderungen oder Branchenstandards zusätzlich berücksichtigt werden sollten. Dies könnte dazu führen, dass einige wichtige Aspekte nicht angemessen abgedeckt werden.

Trotz dieser negativen Aspekte sollte angemerkt werden, dass die DIN EN IEC/IEEE 82079 als Leitfaden dienen kann und soll. Es liegt in der Verantwortung der Hersteller, die Anforderungen der Norm kritisch zu bewerten und sie entsprechend den spezifischen Anforderungen ihrer Produkte und Zielgruppen anzupassen.

In welcher Veröffentlichungsform die Betriebsanleitung dem Betreiber zur Verfügung gestellt wird ist in der Regel vertraglich festgehalten.

Nach der Maschinenrichtlinie 2006/42/EG sind Betriebsanleitungen in Papierform mitzuliefern. Der Grund dafür ist, dass es keine bestimmten Bedingungen für das „zur Verfügung stellen“ von Betriebsanleitungen gibt. Das bedeutet, es ist davon auszugehen, dass der Betreiber nicht über die Möglichkeiten verfügt, die Betriebsanleitung in elektronischer Form oder über eine Website aufzurufen.

Anders ist es bei der DIN EN ISO 20607. Diese listet Möglichkeiten von Veröffentlichungsformen, die für die Auslieferung von Betriebsanleitung zulässig sind. Unter Punkt 7 “Veröffentlichungsformen” wird klargestellt, das Papier nicht mehr die einzig zulässige Form ist.

Die neue Norm fokussiert auf die Sicherheit im Umgang mit Maschinen. Sie richtet sich primär an die bei der Bereitstellung von Maschinen beteiligten Personenkreise, also die Maschinenhersteller, die dafür sorgen müssen, dass ihre Maschinen Sicherheitsstandards erfüllen.

Die DIN EN ISO 20607 ermöglicht den Organen des Arbeits- und Gesundheitsschutzes (extern wie intern), die prüfen müssen, ob die Betriebsanleitung den normativen Anforderungen entspricht, den Nachweis der Übereinstimmung mit diesen Anforderungen erleichtern.

Die DIN EN ISO 20607, die sich mit den allgemeinen Gestaltungsgrundsätzen von Betriebsanleitungen für Maschinen befasst, bietet eine Reihe von positiven Aspekten:

Sicherheit der Benutzer
Die Norm zielt darauf ab, die Sicherheit der Benutzer von Maschinen zu gewährleisten. Durch die Festlegung von Gestaltungsgrundsätzen für Betriebsanleitungen werden potenzielle Gefahren und Risiken deutlich gekennzeichnet, Sicherheitsmaßnahmen erläutert und Anweisungen für den sicheren Betrieb bereitgestellt.

Einheitliche Standards
Die Norm bietet einheitliche Standards und Leitlinien für die Erstellung von Betriebsanleitungen. Dies erleichtert es Herstellern, die Anforderungen zu verstehen und entsprechende Anleitungen zu erstellen, die den gesetzlichen Vorschriften und den Erwartungen der Benutzer gerecht werden.

Klare und verständliche Informationen
Die Norm legt Wert auf die Klarheit und Verständlichkeit der Informationen in Betriebsanleitungen. Dies ermöglicht es den Benutzern, die Anleitungen leicht zu verstehen und die Maschinen sicher zu bedienen. Durch klare Strukturierung, gut lesbare Texte und grafische Darstellungen wird die Benutzerfreundlichkeit verbessert.

Risikominimierung
Durch die Einhaltung der Norm können potenzielle Risiken bei der Verwendung von Maschinen minimiert werden. Gefahrenhinweise, Sicherheitsmaßnahmen und Warnhinweise werden angemessen gekennzeichnet und kommuniziert, um Unfälle und Verletzungen zu vermeiden.

Internationale Anerkennung
Die DIN EN ISO 20607 ist Teil der ISO 12100-Normenreihe und hat somit internationale Anerkennung erlangt. Dies bedeutet, dass Hersteller, die diese Norm befolgen, ihre Produkte auf dem globalen Markt leichter verkaufen können, da sie den internationalen Standards entsprechen.

Insgesamt trägt die DIN EN ISO 20607 dazu bei, die Sicherheit, Verständlichkeit und Benutzerfreundlichkeit von Betriebsanleitungen für Maschinen zu verbessern und damit die Sicherheit der Benutzer zu gewährleisten.

Die Norm beschäftigt sich primär mit Betriebsanleitungen für eine fachlich höher qualifizierte Zielgruppe, weniger für Verbraucher.

Sowohl die DIN EN ISO 20607 als auch die DIN EN 82079 beschäftigen sich mit der Erstellung von Betriebsanleitungen, aber sie haben unterschiedliche Anwendungsbereiche und Schwerpunkte.

Anwendungsbereich der DIN EN ISO 20607:
Die DIN EN ISO 20607 richtet sich speziell an den Maschinenbau und behandelt die allgemeinen Gestaltungsgrundsätze von Betriebsanleitungen für Maschinen. Sie legt die Anforderungen an den Inhalt, die Struktur und die Darstellung von Betriebsanleitungen fest, um die Sicherheit der professionellen Benutzer zu gewährleisten.

Anwendungsbereich DIN EN IEC/IEEE 82079
Die DIN EN IEC/IEEE 82079 ist eine allgemeinere Norm für Bedienungsanleitungen. Sie kann auf verschiedene Arten von Produkten angewendet werden, einschließlich Maschinen, Geräten, elektronischen Produkten usw. Die Norm definiert die Anforderungen an die Erstellung von Bedienungsanleitungen, einschließlich der Inhalte, der Struktur, der sprachlichen Gestaltung und der visuellen Darstellung.

Die DIN EN ISO 20607 gehört zur ISO 12100-Normenreihe, die sich speziell mit der Sicherheit von Maschinen befasst. Sie ist international anerkannt und wird von der Internationalen Organisation für Normung (ISO) entwickelt.

Die DIN EN IEC/IEEE 82079 hingegen ist eine eigenständige Norm, die von der Europäischen Normungsorganisation CEN (European Committee for Standardization) entwickelt wurde. Sie hat ebenfalls internationale Anerkennung als IEC/IEEE Norm, wird aber nicht direkt von der ISO herausgegeben.

Während die DIN EN ISO 20607 den Schwerpunkt auf die Sicherheit von Maschinen legt und spezifische Anforderungen an die Betriebsanleitungen in diesem Bereich festlegt, legt die DIN EN 82079 den Schwerpunkt auf die Benutzerfreundlichkeit und die Kommunikation von Informationen in Gebrauchsanleitungen.

Die DIN EN 82079 enthält ausführlichere Anleitungen zur sprachlichen Gestaltung, zur Verwendung von Symbolen und Piktogrammen, zur Einbeziehung von Risikobeurteilungen und zur Benutzergruppenanalyse. Sie bietet einen breiteren Ansatz für die Erstellung von Gebrauchsanleitungen, der über die Sicherheitsaspekte hinausgeht.

Obwohl es Unterschiede zwischen den beiden Normen gibt, gibt es auch einige gemeinsame Anforderungen und Prinzipien, da beide letztendlich dazu dienen, benutzerfreundliche und informative Anleitungen zu erstellen, die die Sicherheit und den Gebrauch von Produkten unterstützen. Es ist wichtig, die jeweiligen Anforderungen der relevanten Norm im Kontext der spezifischen Produkte oder Maschinen zu berücksichtigen.

Die DIN EN ISO 20607 legt allgemeine Gestaltungsgrundsätze für Betriebsanleitungen von Maschinen fest, um die Sicherheit der Benutzer zu gewährleisten.

• Die DIN EN ISO 20607 definiert Anforderungen und Empfehlungen für den Inhalt, die Struktur und die Darstellung von Betriebsanleitungen.
• Die DIN EN ISO 20607 enthält Leitlinien zur Erstellung von klaren, verständlichen und benutzerfreundlichen Betriebsanleitungen, die die Risiken bei der Verwendung von Maschinen minimieren sollen.
• Die DIN EN ISO 20607 befasst sich mit Aspekten wie der Informationsstruktur, den Anweisungen für den sicheren Betrieb, den Gefahrenhinweisen, den Sicherheitsmaßnahmen, den Warnhinweisen und der Kennzeichnung.

Die DIN EN ISO 20607 ist Teil der ISO 12100-Normenreihe, die sich mit der Sicherheit von Maschinen befasst. Sie ist ein international anerkannter Standard und dient als Leitfaden für Hersteller bei der Erstellung von Betriebsanleitungen, um sicherzustellen, dass die Benutzer angemessen über die sichere Verwendung von Maschinen informiert sind.

Sie entstand durch Kooperation des Technischen Komitees ISO/TC 199 “Safety of machinery” mit dem Technischen Komitee CEN/TC 114 “Sicherheit von Maschinen und Geräten”.

Ich gebe zu, am Anfang habe ich auch gedacht, diese Norm braucht kein Mensch. Es gab ja schon die DIN EN ISO  82079-1 und nun auch deutlich verbessert die IEC/IEEE 82079-1 Second Edition. Wozu also die DIN EN ISO 20607?

Hierfür gibt es viele gute Gründe:

• Die 20607 heißt im Langtext “Sicherheit von Maschinen – Betriebsanleitung – Allgemeine Gestaltungsgrundsätze”. Sie bezieht sich also nur auf Maschinen während die 82079-1 sich generell für das Erstellen von Nutzungsinformationen bezieht – für alle Produktarten.
• Die 20607 ist mit einem Gesamtumfang von 38 Seiten sehr überschaubar und kann (und sollte) von jedem Maschinenbauer angewendet werden.
• Als harmonisierte Norm löst die 20607 die Vermutungswirkung aus. Wer sich als Maschinenbauer an diese Norm hält, ist im ersten Anlauf auf der sicheren Seite. Auf Seite 5 der Norm steht in Bezug  auf die MRL (Richtlinie 2006/42/EG):  „Im Rahmen des Anwendungsbereich ist die grundlegende Anforderung 1.7.4.2 mit Ausnahme von Punkt u) abgedeckt
• Unter Punkt 7 “Veröffentlichungsformen” wird klargestellt, das Papier nicht mehr die einzig zulässige Form ist – endlich!

Fazit: Die DIN EN ISO 20607 ist eine echte Hilfe für die Unternehmen aus dem Bereich Maschinenbau. Damit man aber wirklich auf der sicheren Seite ist, muss die Dokumentation auch von einer Fachkraft (Technischen Redakteur*in) erstellt werden.

Siehe

https://arakanga.de/technische-dokumentation/technische-dokumentation/technische-redaktion/

https://arakanga.de/technische-dokumentation/branchenspezifische-technische-doku/

https://arakanga.de/arawiki/normen-richtlinien/

Grundsätzlich sind Normen nicht rechtsverbindlich. Es besteht allerdings die Möglichkeit über das Vertragsrecht zwischen Hersteller und Betreiber die Anwendung bestimmter Normen festzulegen.

Mit der Einhaltung von harmonisierten Normen erfüllen Sie die Mindestanforderungen an die Sicherheit von Produkten und lösen die sogenannte Vermutungswirkung aus. Das Bedeutet, sollte es mit Ihrem Produkt zu einem Schadensfall kommen, geht das Gericht davon aus, dass die gesetzlichen Anforderungen (EU/EG-Richtlinie) erfüllt sind. Die Nachweispflicht liegt in diesem Fall beim Kläger, der den Nachweis erbringen muss, dass nicht alles in der Verantwortung des Herstellers getan wurde.

Harmonisierte Normen stehen im Zusammenhang einer EU-Richtlinie und gelten für alle EU-Mitgliedsstaaten. Sie haben die Aufgabe bestimmte Regelungen europaweit gültig zu machen.

Neben strukturellen und inhaltlichen Anforderungen müssen Technische Dokumentationen auch formale Anforderungen erfüllen. Hier sind verschiedenste Richtlinien, Normen und Gesetze wichtig, die bei der Erstellung und Bereitstellung der Dokumentationen eingehalten werden müssen.

Das sind z. B. Richtlinien/Gesetze für bestimmte Produktgruppen:

• Maschinenrichtlinie (2006/42/EG)
• Niederspannungsrichtlinie (2014/35/EU)
• Produktsicherheitsgesetz (ProdSG)

Oder Normative Anforderungen:

• Europäische Norm EN 82079–1 (DIN-Norm für das Anfertigen von Anleitungen)

Weitere Normen und Richtlinien haben wir für euch hier zusammengefasst: https://arakanga.de/arawiki/normen-richtlinien/.

Auch für den Bereich der „Software“ gibt es Normen, die bei der Erstellung der Dokumentation einzuhalten sind.

Anders als beim Maschinenbau geht es bei diesen Normen nicht darum, die Sicherheit von Personen zu gewährleisten, sondern den Informationsbedarf für den Endanwender festzulegen.

Bei den Normen zur Softwaredokumentation handelt es sich um die Normenreihe ISO/IEC/IEEE 26511 – 26515. Für die Technische Dokumentation ist vor allem die Norm „ISO/IEC 26514:2022-01 System- und Software-Engineering – Design und Entwicklung von Informationen für Anwender“.

Die Maschinenrichtlinie 2006/42/EG bzw. die neue Maschinenverordnung stellt einheitliche Anforderungen an die Sicherheit und den Gesundheitsschutz in der Europäischen Union dar. Eine direkt vergleichbare Vorschrift mit der Maschinenrichtlinie und CE-Kennzeichnung gibt es im nordamerikanischen Markt nicht.

Bei der Integration der Lieferantendokumentationen kann durchaus Chaos entstehen: Falsche Sprachen, Wartungsarbeiten im Fließtext beschrieben, nicht editierbare Formate… Die Schuld liegt allerdings nicht nur beim Lieferanten. Oftmals werden die Anforderungen an die Dokumentation dem Lieferanten nur vage mitgeteilt.

Hier ein paar Tipps mit denen die Zusammenarbeit spürbar besser wird:

1.        Definieren Sie die Anforderungen und Standards und kommunizieren Sie diese frühzeitig

2.        Nutzen Sie eine Checkliste als Prüfprotokoll

3.        Schulen Sie Ihre Mitarbeiter mit einem Leitfaden

Lieferantendokumentation, Herstellerdokumentation oder auch Zuliefererdokumentation. Es gibt unterschiedliche Begriffe. Jedoch ist mit allen das Gleiche gemeint. Besonders im Maschinen- und Anlagenbau gehört die Integration der Dokumentationen von Lieferanten dazu.

Wer eine Anlage als Komplettleistung liefert, ist für die gesamte Anlage verantwortlich, auch für die Lieferantendokumentation. Gerade im Maschinen- und Anlagenbau besteht die Gesamtdokumentation aus einem erheblichen Teil von Dokumentationen, die vom Lieferanten geliefert werden. Diese Dokumentationen gilt es zu sichten, zu prüfen und in die Gesamtdokumentationen zu integrieren.

• Alle Verbraucherprodukte, die unter die Maschinenverordnung (EU) 2023/1230 fallen.
• Alle Maschinen, die auch von Verbrauchern gekauft werden könnten (danke Onlinehandel).
• Alle Maschinen, die von unbezahlten Nutzern bedient werden könnten.

Den Rest werden die Gerichte im Laufe der Zeit oder die EU mit einem Guide regeln.

Wesentlich sind z. B.

• Transport
• Beschreibung
• Sicherheitshinweise
• Bedienung
• Einrichtung
• Einstellung
• …

Eher nicht wesentlich sind

• Wartungs- und Instandhaltungsinformationen
• Schaltplänen und technischen Zeichnungen
• Lagerung
• Entsorgung

Den Rest werden die Gerichte im Laufe der Zeit oder die EU mit einem Guide regeln.

Zugänglichkeit bedeutet:

• Deutliche Ansage, wo die Dokumentation zu haben ist. Möglichst maschinennah angegeben!
• Neutrales Format. Zum Beispiel Druck- und speicherbares PDF.
• Unabhängig vom Zustand der Maschine! Nicht nur in der Steuerung der Maschine hinterlegt!
• Nicht nur als Onlinehilfe in der Steuerung!
• Stabile, sichere Onlineverfügbarkeit über mindestens 10 Jahre

Den Rest werden die Gerichte im Laufe der Zeit oder die EU mit einem Guide regeln.

Ab Inkrafttreten der Maschinenverordnung (EU) 2023/1230 darf die Verordnung angewendet werden und eine entsprechende Konformitätserklärung ausgestellt werden.

Die neue Maschinenverordnung (EU) 2023/1230 sieht einen allgemeinen Übergangszeitraum von 42 Monaten, bis zum 20.01.2027, vor. Ab diesem Zeitpunkt muss die neue Maschinenverordnung verwendet werden. Allerdings treten einige Punkte bereits früher in Kraft:

19.07.2023:
Beginn der Aktualisierung und Aufnahme neuer Produkte in Anhang I Teil A der Maschinenverordnung (EU) 2023/1230
Bildung eines EU-Ausschusses zur Maschinenverordnung (EU) 2023/1230

20. 10. 2023:
Erlass von Vorschriften über Sanktionen durch die EU-Mitgliedsstaaten

20.01.2024:
Notifizierung von nationalen Konformitätsbewertungsstellen

20.07.2024:
Beginn der Aktualisierung und Aufnahme neuer Produkte in Anhang I
Erlass delegierter Rechtsakte
Bewertungsberichte der EU-Kommission

Folgende Vorgaben müssen erfüllt werden:

• Die Betriebsanleitung muss in einer vom betreffenden Mitgliedstaat festgelegten, für die Nutzer leicht verständliche Sprache geliefert werden.

• Die Betriebsanleitung muss in einer Sprache vorliegen, die von der zuständigen nationalen Behörde leicht verstanden werden kann.

• Die Wartungsanleitung, die nur zur Verwendung durch vom Hersteller oder von seinem Bevollmächtigten beauftragtes Fachpersonal bestimmt ist, kann in einer Amtssprache der Union abgefasst werden, die von diesem Fachpersonal verstanden wird.

Die Antwort ist ein klares “Jein”.

Unter folgenden Bedingungen ist die Papierdokumentation verpflichtend:

1. Wenn die Maschine für nichtprofessionelle Nutzer bestimmt ist oder
   unter vernünftigerweise vorhersehbaren Umständen von nichtprofessionellen Nutzern verwendet werden könnte, auch wenn sie nicht für sie bestimmt sind. Die Dokumentation muss Sicherheitsinformationen, die für die sichere Inbetriebnahme der Maschine und für deren sichere Verwendung wesentlich sind, enthalten.
2. Wenn der Nutzer zum Zeitpunkt des Kaufs die Betriebsanleitung in Papierform verlangt, muss die Betriebsanleitung innerhalb eines Monats in Papierform zur Verfügung gestellt werden.

Um auf die Papierform verzichten zu können, müssen folgende Bedingungen erfüllt sein:

• Es muss angegeben sein, wie auf die digitalen Betriebsanleitungen zugegriffen werden kann.
  Die Angabe erfolgt auf der Maschine oder dem dazugehörigen Produkt oder, falls dies nicht möglich ist, auf ihrer Verpackung oder in einem Begleitdokument.
• Die Betriebsanleitung muss in einem Format bereitgestellt werden, das es dem Nutzer ermöglicht, die Betriebsanleitung auszudrucken, herunterzuladen und auf einem elektronischen Gerät zu speichern, sodass der Nutzer jederzeit, insbesondere bei einem Ausfall der Maschine oder des dazugehörigen Produkts, auf die Betriebsanleitung zugreifen kann. Diese Anforderung gilt auch, wenn die Betriebsanleitung in die Software der Maschine oder des zugehörigen Produkts eingebettet ist.
• Die Betriebsanleitung muss online zugänglich sein, zumindest während der voraussichtlichen Lebensdauer der Maschine oder des dazugehörigen Produkts und mindestens zehn Jahre lang nach dem Inverkehrbringen der Maschine oder des dazugehörigen Produkts.

Und für Montageanleitungen von unvollständigen Maschinen gelten die Punkte 2 bis 5 natürlich ebenfalls.

Was definitiv digital zur Verfügung gestellt werden kann, sind die Konformitätserklärung bzw. die Einbauerklärung.

Die neue Maschinenverordnung (EU) 2023/1230 wurde am 29.06.2023 im Amtsblatt der Europäischen Union veröffentlicht. Die Verordnung tritt am 20. Tag nach Bekanntgabe direkt in allen Mitgliedsländern in Kraft, also am 19.07.2023.
Alle Maschinen, die vor dem 20.1.2027 ausgeliefert werden, können noch eine Konformitätserklärung nach Maschinenrichtlinie 2006/42/EG ausgestellt bekommen, alle Produkte danach müssen eine Konformitätserklärung nach Maschinenverordnung (EU) 2023/1230 erhalten.

Der Redaktionsleitfaden schreibt Regeln fest:

• Wie sieht der Erstellungsprozess aus?
• Wie ist die Ablage organisiert
• Welche Tools werden mit welchen Vorgaben verwendet?
• etc.

Sind diese Regeln nicht im Redaktionsleitfaden hinterlegt, kann der Ausfall eines einzigen Mitarbeiters dazu führen, dass keine neuen Dokumentationen mehr erstellt werden können, niemand mehr weis, wie die Ablage organisiert ist, etc. Das kann zu Lieferverzögerungen, unzufriedenen Kunden führen und für das Unternehmen richtig teuer werden.

Dienstleister in der Technischen Redaktion werden immer dann benötigt, wenn sehr viel zu tun ist oder jemand ausgefallen ist. Damit ein Dienstleister seine Arbeit zügig beginnen kann, muss er alle Regeln und Prozesse kennen lernen.
Fehlt der Redaktionsleitfaden, muss der Dienstleister mühselig alle Details erklärt bekommen (Mund zu Mund Beatmung).
Statt zu einer Entlastung kommt es dann zu einer Zusatzbelastung, die Hilfe startet erst mit erheblicher Verzögerung.

Ein Redaktionsleidfaden in der Technischen Dokumentation ist ein wertvolles Hilfsmittel. Er ist ein „Gesetzbuch“ für Technische Redakteure und stellt sicher, dass Inhalte redaktionell und einheitlich aufbereitet werden. Somit trägt er wesentlich zur Qualität der technischen Dokumente bei. Weitere Informationen zum Redaktionsleitfaden in der Technischen Dokumentation und welche Themen ein Redaktionsleitfaden unbedingt beinhalten sollte, erfahrt Ihr hier: https://arakanga.de/arawiki/technische-dokumentation/redaktionsleitfaden/ .

Der Redaktionsleitfaden ist eine Art „Gesetzbuch“ für den Ersteller einer Technischen Dokumentation. Er definiert die Gestaltung und das Layout, beschreibt Zielgruppen, legt Dokumententypen und Ausgabemedien fest. Er ist somit von großer Bedeutung für jede Redaktionsabteilung. Weitere Informationen zum Redaktionsleitfaden findet Ihr hier: https://arakanga.de/arawiki/technische-dokumentation/redaktionsleitfaden/.

Im Redaktionsleitfaden werden Angaben darüber gemacht, welche Tools bei der Dokumentationserstellung zum Einsatz kommen und wie mit diesen Tools gearbeitet werden soll. Es werden bspw. Regeln zum Editieren von Texten getroffen oder zur Grafikbearbeitung.

Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: Redaktionsleitfaden ‘b7 ARAKANGA GmbH einsehen.

Im Redaktionsleitfaden ist definiert, wie Dokumente zu Benennen sind und wie deren Inhalt aufgebaut sein soll. Darüber hinaus macht der Redaktionsleitfaden Vorgaben über die Strukturierung der Dokumente sowie zum Layout. Weiterhin ist auch definiert, wie die die Dokumente zu verwalten sind.

Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: Redaktionsleitfaden ‘b7 ARAKANGA GmbH einsehen.

Der Erstellungsprozess in einem Redaktionsleitfaden gibt Auskunft darüber, wie eine Dokumentationserstellung gestartet wird und welche Arbeiten notwendig sind bis hin zur Auslieferung der Dokumente. Im Erstellungsprozess ist definiert, wer der Auftraggeber ist und welche Prozess ein Dokument durchlaufen muss, bevor es ausgeliefert werden kann.

Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: Redaktionsleitfaden ‘b7 ARAKANGA GmbH einsehen.

Ein Redaktionsleitfaden ist unternehmenspezifisch. Das Bedeutet, jeder Redaktionsleitfaden ist anders. Im Wesentlichen sollten aber die folgenden Punkte in einem Redaktionsleitfaden abgedeckt sein:

–        Angaben zum Erstellungsprozess

–        Angaben über die Dokumente

–        Angaben über die Tools mit denen gearbeitet wird

Mehr Informationen darüber, wie ein Redaktionsleitfaden aufgebaut ist können Sie in unserer Checkliste erfahren: Redaktionsleitfaden ‘b7 ARAKANGA GmbH einsehen.

Die Zielgruppe des Redaktionsleitfadens sind in erster Linie Personen, die Dokumente erstellen also Technische Redakteure. Aber nicht nur Technische Redakteure sind am Erstellungsprozess von Dokumenten beteiligt. Darüber hinaus gehören auch Lektoren und Übersetzungsmanager zur Zielgruppe des Redaktionsleitfadens. Es ist also wichtig, auch für diese Zielgruppen in dem Redaktionsleitfaden anzusprechen.

Für die Erstellung eines Redaktionsleitfadens ist vor allem der Fachbereich für die Technische Dokumentation verantwortlich. Aber komplett eigenständig kann er diesen auch nicht erstellen. In dem Redaktionsleitfaden werden Prozesse angesprochen bzw. festgelegt, für die nicht nur „Technische Redakteure“ verantwortlich sind. Diese Prozesse müssen mit den jeweiligen Fachbereichen gemeinsam festgelegt werden.

Der Redaktionsleitfaden ist das “Gesetzbuch” für die Technische Redaktion. Der Redaktionsleitfaden soll dem Ersteller einer Dokumentation eine wirkliche Hilfestellung geben er zeigt ihm, wie er in einem realen Projekt vorgehen muss,

• um die Inhalte zu definieren, die in die Dokumentation gehören,
• um die so definierten Inhalte in ein Dokument umzusetzen.

In der Theorie ist der geeignete Zeitpunkt einen Redaktionsleitfaden zu erstellen, wenn Sie bspw. ein Redaktionssystem einführen.

Bevor Sie ein Redaktionssystem einführen, ist es wichtig zu wissen, welche Anforderungen es erfüllen soll. Insofern haben Sie im Vorfeld Entscheidungen getroffen, die den „Sollzustand“ der zu erstellenden Technischen Dokumentation entsprechen soll. Dieser „Sollzustand“ wird in einer sogenannten „Musterdokumentation oder Pilotenprojekt“ im Redaktionssystem hinterlegt und sollte die Basis für den Redaktionsleitfaden darstellen.

Deshalb sollte ein Redaktionsleitfaden parallel zur Musterdokumentation erstellt werden und immer wieder nach neuen Erkenntnissen angepasst werden. Falls kein Redaktionssystem bei der Erstellung von Technischen Dokumenten genutzt wird, sollte zuerst der Redaktionsleitfaden erstellt werden und danach die Technischen Dokumente.

Redaktionssysteme sind Softwaresysteme zur Verwaltung von strukturierte Inhalten, wie z.B. Technischer Dokumentation. Wesentliches Merkmal ist die Trennung von Inhalten (Content), Datenstruktur und Design (Layout) sowie die Möglichkeit der Zugriffssteuerung bzw. Workflow.
Varianten, Terminologie, übersetzungoptimiertes Schreiben, Übersetzung, Verwaltung von Dateien wie Grafiken, Photos, Zeichnungen und Faksimiles werden vom System unterstützt und überwacht. Vergleichbar mit einem 3D.CAD/CAM-System in der Konstruktion.

Eine Möglichkeit Inhalte mit iiRDS-Metadaten zu versehen ist über die Nutzung des iiRDS Open Toolkits möglich. Das iiRDS Open Toolkit ist kostenfrei über die Website www.iirds.org aufrufbar. Dort können Inhalte (Dateien) wie zum Beispiel HTML-, PDF- und XML-Dateien hochgeladen werden.Im Anschluss können zu den hochgeladenen Inhalten iiRDS-Metadaten über eine Drop-Down-Liste mit definierten Werten vergeben werden. Es gibt auch die Möglichkeit eigene iiRDS-Metadaten anzulegen. Wenn alle iiRDS-Metadaten hinterlegt wurden, kann anschließend über den Download-Button ein iiRDS-Paket heruntergeladen werden.

Gehen wir davon aus, dass die Entscheidung auf ein Redaktionssystem getroffen wurde. Welche Überlegungen hierbei eine Rolle spielen können Sie hier nachlesen: „Redaktionssysteme – Wie finde ich das richtige System?“ Die ersten Schritte, die nach der Einführung eines Redaktionssystem erledigt werden, sind vor allem administrative Arbeiten. Hierbei geht es in erster Linie um die Erstellung eines Template. Das Template ist entscheidend dafür, wie am Ende die Dokumente aussehen, wenn Sie aus dem Redaktionssystem bspw. nach Word publiziert werden. Hierbei spielen Corporate Identity und die Layout-Gestaltung einer wesentlichen Rolle.

Das Redakteurssystem ist das traditionelle System zur Erstellung von Betriebsanleitungen. Hochqualifizierte, konzentriert arbeitende, gut ausgebildete, dauernd weitergebildete, motivierte Redakteure erstellen manuell ordnerorientierte Topics und fügen diese zu den passenden Bedienungsanleitungen zusammen. Dabei werden Varianten, Terminologie, übersetzungoptimiertes Schreiben nur aufgrund der Kenntnisse und Fähigkeiten der Redakteure berücksichtigt. Vergleichbar mit den Konstrukteuren und ihren Zeichenbrettern, Blaupausen und Schreibmaschinen.

Das hängt sicherlich davon ab, wie Sie das Redaktionssystem nutzen. Arbeiten Sie rein redaktionell mit dem System, ist es nicht sehr aufwendig. Viele gute Redaktionssysteme sind intuitiv bedienbar. Die meisten guten Redaktionssysteme haben hilfreiche Helptools integriert, die viele offene Fragen beantworten. Zusätzlich bieten die Hersteller Webinare, Seminare oder Workshops an, um Sie bestmöglich auf den Einsatz mit dem Redaktionssystem vorzubereiten. Auch wir, von ARAKANGA unterstützen euch gerne bei der Systemeinführung sowie mit der täglichen Arbeit im Redaktionssystem. Weitere Infos findet Ihr hier: Systemeinführung & Hosting · ARAKANGA GmbH

Single-Source-Publishing bietet den Vorteil, dass aus einer Quelle verschiedene Formate ausgegeben werden können. Die meisten Redaktionssysteme unterstützen Single-Source-Publishing und machen somit die Dokumentation „medienneutral“. Beliebige Ausgabeformate können über den Publikationsprozess ausgegeben werden:

• HTML
• Word
• PDF
• Diverse Online-Hilfe-Formate
• iiRDS Pakete

etc.

Eine zentrale Verwaltung von Varianten, Versionen und Sprachen ist ein wesentlicher Bestandteil eines guten Redaktionssystems. Ein Redaktionssystem kann Ihnen ungemein helfen, wenn Sie ihre Produkte in unterschiedlichen Varianten und Versionen in mehrere Länder ausliefern. Darüber hinaus gibt es noch mehrere wichtige Merkmale eines guten Redaktionssystem, siehe hier: Funktionen von Redaktionssystemen · ARAKANGA GmbH

Betriebsanleitungen sind in der Praxis Nachschlagewerke. Niemand liest sich eine Betriebsanleitung von vorne bis Hinten durch. Deshalb bauen heutzutage viele Redaktionssysteme auf Content Delivery Portale. Im Idealfall ermöglichen Content Delivery Portale eine facettierte Suche, wie bei Amazon. Damit dies möglich ist, müssen die Datenbestände mit Metadaten versehen werden.

Ein Callout Editor bietet die Möglichkeit, Grafiken mit Callouts direkt im Redaktionssystem zu überlagern. Diese Callouts können sowohl Texte als auch Nummerierungen sein. Sie werden beim Übersetzungsprozess mitberücksichtigt und können von einer Variantensteuerung mit beeinflusst werden.

Die Anforderungen an Technische Redakteure sind in den letzten Jahren gewachsen. Für jede Produktvariante und Version müssen Dokumente erstellt werden und darüber hinaus auch in mehreren Sprachen. Mit der Einführung eines Redaktionssystems ändert sich die Arbeitsweise eines Technischen Redakteurs. Ein Redakteur arbeitet nicht mehr an einzelnen Betriebsanleitungen, sondern erstellt sogenannte Informationsmodule, die in verschiedenen Betriebsanleitungen (Publikationen) verwendet werden. Dies bedeutet, dass die Dokumente systematisch modularisiert werden müssen, um eine hohe Wiederverwendung zu erzeugen. Das Arbeiten mit Informationsmodulen beinhaltet auch die Vergabe von Metadaten. Mit der Vergabe von Metadaten lassen sich Informationsmodule beispielsweise nur für bestimmte Produktvarianten geltend machen, sodass die Betriebsanleitung genau die vom Kunden bestellte Produktvariante beschreibt.

Eine Voraussetzung ist eine systematische Behandlung der Inhalt. Eine weitere ist die Entscheidung darüber wie und in welcher Tiefe Inhalte wieder verwendet sollen. Grundsätzlich gibt es zwei Systeme:

• Das Redakteurssystem
• Das Redaktionssystem

Ein Redaktionssystem ist in der Regel dann besonders sinnvoll, wenn Sie viele Betriebsanleitungen in mehreren Sprachen ausliefern müssen. Mit einem Redaktionssystem behalten Sie den Überblick. Mit Hilfe eines Redaktionssystems bauen Sie Ihre Betriebsanleitung modular auf, Sie erzeugen eine sogenannte Wiederverwendung.

Weitere Funktionen eines Redaktionssystem können Sie hier nachlesen: https://arakanga.de/arawiki/redaktionssysteme-dms/funktionen-von-redaktionssystemen

Redaktionssysteme sind in den letzten Jahren immer leistungsfähiger geworden. Standardmäßig decken praktisch alle Systeme die grundlegenden Anforderungen für die Technischen Redaktion ab. Trotzdem gibt es noch große Unterschiede zwischen den Systemen.
Die Redaktionssysteme lassen sich auf verschiedene Arten unterteilen, wir haben drei Gruppen gebildet:

• einfache Redaktionssysteme
• XML-Redaktionssysteme
• spezialisierte Redaktionssysteme

die einzelnen Arten der Redaktionssysteme aufgebaut sind und welchen Nutzen diese für die Technische Dokumentation haben erfahren Sie hier https://arakanga.de/arawiki/redaktionssysteme-dms/arten-von-redaktionssystemen/

Häufig wird damit begonnen, einfach die Funktionen der verschiedenen Redaktionssysteme zu vergleichen. Hierzu eignet sich die tekom-Studie Redaktionssysteme hervorragend. Allerdings stellt man schnell fest, dass sich die Redaktionssysteme scheinbar kaum unterscheiden. Eine Entscheidung alleine auf dieser Basis zu fällen, ist sehr schwierig bis unmöglich. Was also tun?

Das Wichtigste bei der Auswahl eines Redaktionssystems ist, sich über die Ziele im Klaren zu werden, die mit der Einführung des Redaktionssystems erreicht werden sollen. Sie sollten sich also nicht zuerst die Funktionen eines Redaktionssystems anschauen, sondern ihre Bedürfnisse, Erwartungen und Ziele, die sie mit der Einführung eines Systems erreichen wollen. Das können ganz unterschiedliche Ziele sein, z. B.

• Zusammenarbeit über mehrere Standorte stärken, also gemeinsam an einer Dokumentation arbeiten.
• Dokumentstrukturen mit Hilfe fester Strukturvorgaben vereinheitlichen.
• Einen Datenpool schaffen, aus dem sich Kataloge, Preislisten, Handbücher und auch die Website speisen.
• Serviceinformationssysteme mit den notwendigen Informationen befüllen.
• Variantenmanagement ermöglichen, um aus einer Quelle die jeweils passende Dokumentation für eine Maschine zu generieren.
• Ein Content Delivery Portal befallen, dass es dem Anwender einfach macht, die richtige Information für sein(e) Produkt(variante) zu finden, für die Aufgabe, die er gerade lösen will, in der richtigen Sprache, …
• Übersetzungsmanagement optimieren, so dass nur das zu einem Übersetzungsdienstleister geschickt werden muss, was auch neu oder geändert ist.
• …

Hinter diesen Zielen verbergen sich verschiedene Anforderungen. So kann für die Zusammenarbeit über mehrere Standorte ein webbasiertes Redaktionssystem genau das Richtige sein wohingegen für das Content Delivery Portal die einfache Zusammenführung unterschiedlicher Datenquellen der ausschlaggebende Faktor ist.

Der erste Schritt ist also, ein Zukunftsszenario zu entwerfen, wie die Informationsstrategie des Unternehmens aussehen soll. Dieses Zukunftsszenario muss von verschiedenen Abteilungen und Gruppen gemeinsam erarbeitet werden, um alle wesentlichen Interessen zu berücksichtigen. Hierbei kann ein externer Berater sehr hilfreich sein.

Der Begriff Topic taucht bei Redaktionssystemen immer wieder auf. Eine einheitliche Definition ist aber nicht vorhanden.
Topic heißt wörtlich übersetzt Thema. Ein Topic ist in diesem Sinne eine Informationseinheit, die ein Thema behandelt. Topic ist demnach eine inhaltlich definierte Einheit.
Topic wird aber auch oft als wiederverwendbare Einheit definiert. Wiederverwendbar muss aber nicht gleichzeitig ein komplettes Thema sein. Typische Beispiele sind die Gefahrenhinweise nach dem SAFE-Prinzip. Sie behandeln kein Thema sondern sind nur im Kontext eines Themas sinnvoll. Da sie aber für mehrere Themen gelten können ist es sinnvoll, diese als wiederverwendbare Einheiten in einem Redaktionssystem zu verwalten.

Redaktionssysteme sind teuer und rechnen sich doch nie – ist eine Meinung, die uns immer wieder begegnet ist. Tatsächlich ist das Gegenteil der Fall! Ohne Redaktionssystem, mit Word, FrameMaker oder InDesign, wird die Dokumentation so richtig teuer – nur der Einstieg ist billig.
Redaktionssysteme sind auf Modularisierung, Wiederverwendung, Variantensteuerung, Übersetzungen und automatisches Publizieren ausgelegt. Das sind Funktionen, die eigentlich jeder Hersteller erklärungsbedürftiger Produkte zwingend benötigt. Ohne Redaktionssystem werden immer wieder Hilfsmittel wie Excel genutzt, um die Verwaltung halbwegs zu realisieren. Effizient ist dies zumeist nicht, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.

Dem Redakteur bietet ein Redaktionssystem beim Erstellen einer Betriebsanleitung mehrere Vorteile.

• Die Wiederverwendbarkeit von erstellten Informationen ist eines der größten Vorteile beim Arbeiten mit einem Redaktionssystem. Einmal erstellte Informationen können in mehrere Anleitungen übernommen werden. Änderungen und Korrekturen werden nur an einer Stelle vorgenommen. Übersetzungskosten sinken, da die Information nur einmal übersetzt werden muss.
• Die Verwaltung und Übersichtlichkeit von Inhalten ist durch die Modularisierung viel einfacher als mit einem herkömmlichen Textprogramm.
• Durch eine Versionsverwaltung ist es ganz einfach, einzelne Stände der Betriebsanleitung nachzuvollziehen. Im Nachhinein ist somit jeder Bearbeitungsstand einsehbar und es ist problemlos möglich frühere Versionen zu reaktivieren.
• Smarte Autorenunterstützungen im Redaktionssystem gewährleisten eine gleichbleibende Terminologie und die Wiederverwendung von ganzen Sätzen.

Weitere Vorteile und hilfreiche Informationen zum Thema Redaktionssysteme findet Ihr hier: https://arakanga.de/arawiki/redaktionssysteme-dms/

Der Vorteil der Modularisierung in einem Redaktionssystem liegt darin, dass Technische Dokumente wiederverwendet werden können. Sie sparen somit bares Geld bei der Erstellung und Übersetzung von Dokumenten. Einmal erstellte Informationen können in mehrere Anleitungen übernommen werden. Änderungen und Korrekturen werden nur an einer Stelle vorgenommen. Auch die Verwaltung und Übersichtlichkeit von Inhalten ist durch die Modularisierung deutlich einfacher als mit einem herkömmlichen Textprogramm.

Viele Unternehmen haben verschiedene Anforderungen an ein Redaktionssystem. Ein vollständig webbasiertes Redaktionssystem kann einige Vorteile mit sich bringen:

• Sofern Zugriff auf Ihre Server erlaubt sind – webbasierter Zugriff auch außerhalb des Unternehmensnetzwerkes
• Nur ein gängiger Browser muss auf dem Computer installiert sein
• Sehr einfache Zusammenarbeit mit Übersetzern, Dienstleistern und Kollegen von anderen Standorten
• Keine Einzelplatzinstallation mehr nötig
• Bedienung auch auf Tablets möglich
• Kein Schleppen der Notebooks, wenn Ihre Redakteure im Homeoffice arbeiten

Es heißt: Pro Produkt eine Anleitung. Allerdings ist das in der Realität zu einfach. Meist haben Hersteller unterschiedliche Produktvarianten. Und diese müssen in der Technischen Dokumentation berücksichtigt werden. Hier ist ein gutes Variantenmanagement in einem Redaktionssystem ein hilfreiches Tool für uns Technische Redakteure

Mit einer Funktion zum Versionieren in einem Redaktionssystem lassen sich Inhalte „Einfrieren“. Möchte man den Inhalt bearbeiten, muss eine neue Version der Informationseinheit erstellt werden. Das hat den Vorteil, dass man weiterhin ältere Stände der Inhalte in Anleitungen nutzen kann. Ein gutes Redaktionssystem bietet zusätzlich eine übersichtliche Oberfläche, die alle Versionen eines Inhalts zeigt.

Die sinnvolle Verwaltung von vielen Betriebsanleitungen erfolgt am besten mit einem Redaktionssystem.

Eine integrierte Versionsfunktion im Redaktionssystem zeigt die einzelnen Entwicklungsstände der Betriebsanleitungen auf und erlaubt jede Änderung an den einzelnen Ständen nachzuvollziehen. Zudem hilft die Wiederverwendung von einzelnen Textbausteinen und eine leistungsfähige Variantensteuerung in anderen Betriebsanleitungen Arbeit und Kosten zu sparen.

Weitere Informationen finden Sie hier: https://arakanga.de/arawiki/redaktionssysteme-dms/

Eine zentrale Verwaltung von Varianten, Versionen und Sprachen ist ein wesentlicher Bestandteil eines guten Redaktionssystems. Ein Redaktionssystem kann Ihnen ungemein helfen, wenn Sie ihre Produkte in unterschiedlichen Varianten und Versionen in mehrere Länder ausliefern. Darüber hinaus gibt es noch mehrere wichtige Merkmale eines guten Redaktionssystem, siehe hier: Funktionen von Redaktionssystemen · ARAKANGA GmbH

Das hängt sicherlich davon ab, wie Sie das Redaktionssystem nutzen. Arbeiten Sie rein redaktionell mit dem System, ist es nicht sehr aufwendig. Viele gute Redaktionssysteme sind intuitiv bedienbar. Die meisten guten Redaktionssysteme haben hilfreiche Helptools integriert, die viele offene Fragen beantworten. Zusätzlich bieten die Hersteller Webinare, Seminare oder Workshops an, um Sie bestmöglich auf den Einsatz mit dem Redaktionssystem vorzubereiten. Auch wir, von ARAKANGA unterstützen euch gerne bei der Systemeinführung sowie mit der täglichen Arbeit im Redaktionssystem. Weitere Infos findet Ihr hier: Systemeinführung & Hosting · ARAKANGA GmbH

Ein Redaktionssystem wird Ihnen bei richtiger Nutzung ganz sicher Kosten sparen. Zwar muss man für die Anschaffung eines Redaktionssystem erst Geld investieren, jedoch spart man z. B. erhebliche Übersetzungskosten. Beispiel: Einmal erstellte Informationen können durch die Wiederverwendbarkeit in mehrere Anleitungen übernommen werden. Das heißt: Änderungen und Korrekturen werden nur an einer Stelle vorgenommen. Dadurch sinken Übersetzungs- und Erstellungskosten, da die Information nur einmal übersetzt und erstellt werden muss.

Generell wird das Layout von XML-Dokumenten immer durch eine eigenständige Programmierung erzeugt. Es handelt sich hierbei zumeist um eine sogenannte deklarative Programmierung. Das Programm wird anschließend von der entsprechenden Software interpretiert und so das endgültige Dokument erzeugt.

Die Formatierung von XML-Dokumenten geschieht auf ganz unterschiedliche Weisen. Einige davon sind standardisiert, andere herstellerspezifisch. Hier eine kleine Liste gängiger Formatierungsmethoden:

XSL/XSLT = XSL Transformation

• erlaubt die strukturelle Transformation eines Dokuments (Ändern der Reihenfolge, Anreichern mit zusätzlichen Informationen z. B. Formatierungsinformationen, Ausfiltern von Informationen, Generieren von Verzeichnissen wie Index oder In-haltsverzeichnis, etc.)

XSL-FO = XSL Formatting Objects

• Inzwischen veralteter Standard (durch CSS3 abgelöst.)

CSS3 = Cascading Style Sheets

• einfachste Form des Layouts für XML
• definiert das Aussehen von Elementen in HTML und seit CSS3 auch für Papier

Formatierungssprachen erzeugen noch nicht wirklich ein formatiertes Dokument. Hier-zu ist noch ein weiteres Stück Software erforderlich, welches das Stylesheet in Verbindung mit dem eigentlichen XML-Dokument interpretiert und das Ergebnis produziert, z. B. als HTML- oder PDF-Dokument. Hierbei handelt es sich um die sogenannten Rendering Engines. Die bekanntesten Rendering Engines sind:

• Antenna House Formatter
• Apache FOP

Der Redakteur hat nur noch sehr begrenzt Einfluss auf das Layout (teilweise über Attribute der XML-Elementen). Das Layout wird vollautomatisch generiert. Nachträgliche Änderungen an der Formatierung durch den Redakteur sind bei diesem Weg nicht mehr möglich.

Querverweise sind im auf den ersten Blick eine einfache Sache. Von einem Anker – Text oder Grafik – geht ein Verweis auf eine andere Stelle. Jeder kennt Querverweise und nutzt sie dauernd, wenn man im Internet unterwegs ist. Auch in gedruckten Dokumenten kennt jeder Querverweise in Form von „siehe Seite 25“ oder so ähnlich. Schwierig werden Querverweise, wenn es sich um modulare Dokumente handelt.

Das Angebot an Redaktionssystemen für die Technische Dokumentation ist groß. Doch worauf muss ich besonders achten?

• Einfache Benutzeroberfläche
  Ein gutes Redaktionssystem für die Technische Dokumentation hat eine benutzerfreundliche Benutzeroberfläche. Sie sollte strukturiert und intuitiv bedienbar sein. Texte, Grafiken, Tabellen usw. sollten in einem integrierten Editor bearbeitet werden können.
• Verbessertes Arbeiten im Team
  Insbesondere für ein Team in der Technischen Dokumentation kann ein Redaktionssystem die Teamarbeit verbessern. Eine integrierte Versionsfunktion im Redaktionssystem zeigt die einzelnen Entwicklungsstände der Betriebsanleitungen auf und erlaubt jede Änderung an den einzelnen Ständen nachzuvollziehen.
• Variantensteuerung und Sprachen
  Die zentrale Verwaltung von Varianten, Versionen und Sprachen ist ein wesentlicher Bestandteil eines guten Redaktionssystems. Wenn Sie Ihre Produkte in unterschiedlichen Varianten und Versionen herstellen und diese in mehrere Länder ausliefern, hilft Ihnen ein gutes Redaktionssystem für die Technische Dokumentation ungemein.
• Publikation in verschiedenen Ausgabeformaten
  Sie haben die Möglichkeit Ihre Technischen Unterlagen angepasst an Ihre Kunden als Handbuch, Online Dokumentation oder integriert in einem Gerät bereitzustellen. Mit einem guten Redaktionssystem haben Sie die Möglichkeit Ihre Dokumentation in den verschiedensten Formaten (PDF, HTML usw.) zu erzeugen.
• Smarte Autorenunterstützung
  Besonders für uns als Technische Redakteure ist eine smarte Autorenunterstützung ein hilfreiches Tool im Arbeitsalltag. Smarte Autorenunterstützungen im Redaktionssystem gewährleisten eine gleichbleibende Terminologie und die Wiederverwendung von ganzen Sätzen.

Ein webbasiertes Redaktionssystem für die Zusammenarbeit über mehrere Standorte kann für Sie genau das Richtige sein. Gut, dass es Redaktionssysteme gibt, die ein webbasiertes Arbeiten anbieten. Allerdings sind das derzeit nur sehr wenige. Jedoch haben schon einige namhafte Hersteller der Redaktionssysteme angekündigt, zukünftig einen Web-Client anbieten zu wollen. Mehr Informationen zum Thema Redaktionssysteme findet Ihr hier: https://arakanga.de/arawiki/redaktionssysteme-dms/

Ein Redaktionssystem wird Ihnen bei richtiger Nutzung ganz sicher Kosten sparen. Zwar muss man für die Anschaffung eines Redaktionssystems erst Geld investieren, jedoch spart man z. B. erhebliche Übersetzungskosten. Beispiel: Einmal erstellte Informationen können durch die Wiederverwendbarkeit in mehrere Anleitungen übernommen werden. Das heißt: Änderungen und Korrekturen werden nur an einer Stelle vorgenommen. Dadurch sinken Übersetzungs- und Erstellungskosten, da die Information nur einmal übersetzt und erstellt werden muss.

Nicht ganz. Jede Neukonstruktion oder Umkonstruktion einer Maschine erfordert ebenfalls eine neue oder geänderte Risikobeurteilung. Und wenn das nicht anliegt, ist es sehr unwahrscheinlich, dass durch ausgewertete Kundenrückmeldungen, Marktbeobachtungen und Servicemeldungen keine Änderungen an der Risikobeurteilung notwendig werden.

Das ist leider nur im Rückblick möglich. Da die Risikobeurteilung parallel zur Maschine entsteht, können erst ganz am Ende eigentlich Photos entstehen. Auch ein 3D-Modell steht erst gegen Ende fest. Deshalb sollte das nur dort eingesetzt werden, wo unumgänglich notwendig. Skizzen etc dokumentieren die Entwicklung wesentlich pointierter.

So genau wie nötig, dabei kann es dazu führen, dass z.B. detaillierte Schnittstellenbeschreibungen notwendig sind. Oder auch Werkstoffe. Die Leitfrage ist dabei immer: „Welche Informationen benötigt der Betreiber und Bediener?“

Weil nichts ewig funktionieren wird. Jedes Teil einer Maschine hat nur eine begrenzte Funktionsdauer und damit die gesamte Maschine. Und jeder Betreiber einer Maschine muss den fortgesetzten Einsatz planen können, um die Sicherheit der Maschine zu gewährleisten. Es ist wichtig zu wissen, wann welche Teile einer Maschine ersetzt werden müssen; wann die gesamte Maschine überholt werden muss.
Nur so kann die Sicherheit der Maschine erhalten werden.

Um zu beurteilen, ob es möglich ist, die Gefahr zu erkennen bzw. ihr auszuweichen oder die Folgen zu mindern kann man viele Faktoren zu betrachten:
Qualifikation/praktische Erfahrungen der Bediener
Manuelle oder automatische Bedienung?
Wie schnell tritt die Gefährdung ein?
…
Es gibt nur zwei Ergebnisse:
• unter bestimmten Bedingungen möglich
• unmöglich
Dadurch ist die Beantwortung dieser Fragen relativ einfach und kann nach der ersten negativ beantworteten Frage abgebrochen werden.

Gemäß der EN ISO 12100 „Sicherheit von Maschinen“ gibt es drei Stufen zur Risikominderung:

1. Inhärente Sicherheit
2. Technische Schutzmaßnahmen und -einrichtungen
3. Benutzerinformation
   Eine inhärent sichere Konstruktion ist „der erste und wichtigste Schritt im Prozess der Risikominderung. So steht es in der DIN EN ISO 12100 im Abschnitt 6.2.1 fest.
   Konkret bedeutet das:
   Maßnahmen zur inhärenten Sicherheit haben den Vorrang vor anderen Schutzmaßnahmen wie z.B. trennenden Schutzeinrichtungen (Lichtschranken oder Zweihandschaltungen, Sicherheitskennzeichnungen,…) und diese wiederum vor Warnhinweisen in der Bedienungsanleitung.

Warnschilder an und um die Maschine herum nehmen eine duale Stellung ein, sie sind Sicherheitseinrichtungen und gleichzeitig Instruktion. Damit mindern sie das Risiko natürlich.
Damit müssen sie als Sicherheitseinrichtung in regelmäßigen Abständen geprüft werden aber auch den Vorgaben einer Instruktion an Sprache, Form und Verständlichkeit genügen.

Eigentlich nicht, die Verpflichtung sichere Produkte herzustellen ist nichts Neues! Neue ist lediglich, dass die sorgfältige und sichere Konstruktion dokumentiert werden muss und Hilfen zu Beurteilung und zur Durchführung gegeben werden.
Insofern kein wirklich erhöhter Aufwand und ganz sicher nichts neues.

Ein Verstoß gegen das Produktsicherheitsgesetz kann zu folgenden Konsequenzen führen:

• Anordnungen einer Behörde, z.B.
• die Untersagung des Inverkehrbringens und des weiteren Vertriebs, Verpflichtung zu Nachbesserungen und Rückrufaktionen
• Bußgelder bis zu einer Höhe von 100.000 Euro
• Gewährleistung/Sachmängelhaftung: Der Käufer kann z.B.:
• Nachbesserungen/Preisminderung verlangen
• Schadensersatz fordern
• vom Kaufvertrag zurücktreten
• Produkthaftung: Jedes Produkt mit einem sicherheitstechnischen Mangel ist fehlerhaft.
• wettbewerbsrechtliche Konsequenzen:
• Abmahnungen
• Schadensersatz
• Strafrechtliche, persönliche Verantwortung:
• kann Geschäftsführende und Vorstände betreffen, aber auch nachgeordnete Mitarbeiter

Zuerst dient die Risikobeurteilung zur Herstellung und Bereitstellung einer bediensicheren Maschine. Dazu gehört auch eine einwandfreie Instruktion. Dazu werden in der Bedienungsanleitung verschieden Aspekte der Risikobeurteilung öffentlich gemacht, die Zielgruppe, die bestimmungsgemäße Verwendung, die Grenzen der Maschine, die Warnhinweise bei gefährlichen Tätigkeiten, die Restgefahren uvm.

Sämtliche Phasen im Leben einer Maschine! Das kann vom Transport über die Montage und den Betrieb bis zur Außerbetriebsetzung, Demontage und Entsorgung sein.

Ein Kranhaken ist ein Lastaufnahmemittel und fällt deshalb explizit unter die Maschinenrichtlinie. Deshalb benötigt er ebenfalls eine Risikobeurteilung.

Die Normenrecherche für eine Risikobeurteilung ist im Grunde ganz einfach. Alle Normen die bei der Konstruktion verwendet werden und selbstverständlich beim Konstrukteur im Original im Schrank stehen, helfen genauso bei der Risikobeurteilung. Dazu kommen einige wenige grundlegende Normen, die sich mit Sicherheit beschäftigen.

Wir betrachten das mal am Beispiel von Lärm, übermäßiger Schallemission.
Zuerst sollte eine Überprüfung während der Konstruktion stattfinden. Es ist häufig am einfachsten Lärm direkt an der Wurzel zu bekämpfen. Ein alternativer Antrieb, schwingende Flächen oder Hohlräume, Schwingungsdämpfer – alles konstruktive Maßnahmen die sehr effizient, unaufwendig und automatisch wirken.
Habe ich diese Möglichkeiten erschöpft sollte ich über Sicherheitseinrichtungen nachdenken, Schallschutzwände, gedämmte Bedienplätze etc.
Erst wenn der Lärm immer noch zu hoch ist, erfolgt über die Instruktion und Warnsymbole der Rückgriff auf die PSA, Kapselgehörschutz z.B.
All diese Maßnahmen werden detailliert in der Risikobeurteilung dokumentiert und bewertet.

Auch eine unvollständige Maschine ist ein Produkt und benötigt eine Risikobeurteilung um eine Marktzulassung zu haben.
Gerade unvollständige Maschinen benötigen in besonderem Maße eine Risikobeurteilung.
Zum einen haben unvollständige Maschinen aufgrund ihrer Eigenart häufig höhere Risiken, die erst durch einen Einbau in eine Maschine minimiert werden,
zum Zweiten entstehen durch den Einbau im Zusammenspiel der entstandenen Maschine ggf. neue Risiken
und nicht zuletzt muss ich dem Verwender, als demjenigen, der die unvollständige Maschine in seine Maschine integriert, die Hinweise an die Hand geben, die zur Verwendung und einer Risikobeurteilung der entstehenden Maschine notwendig sind.

1. Zuerst müssen die Rahmenbedingungen des Produkts festgelegt werden, d.h. wer soll was mit diesem Produkt machen oder können.
2. Danach werden während der Entwicklung die Gefahren, die sich aus diesen Rahmenbedingungen und den darauf beruhenden Konstruktionen ergeben, erkannt.
3. Jede Gefährdung muss dann in ihrer Schwere beurteilt werden.
4. Übersteigt die Gefahr ein unbedingt notwendiges und akzeptierbares Risiko, werden Gegenmaßnahmen getroffen.
5. Die Auswirkungen der Gegenmaßnahmen auf die Gefahren werden erneut beurteilt.
6. Die Schritte 4 und 5 solange durchführen, bis das Risiko angemessen vermindert wurde.
7. Alle Schritte dokumentieren.

Solide Konstruktion und eine gründliche Risikobeurteilung sind die Grundlage dafür, dass nur so wenige Unfälle passieren. Ganz vermeiden lassen sie sich nie.
Das liegt an vielen Ursachen. Eine davon ist, das Verhalten von Nutzern möglichst effizient zu arbeiten. Dabei werden oft Sicherheitshinweise missachtet oder Sicherheitseinrichtungen umgangen, weil sie stören.
Manchmal ist es auch eine fehlerhafte Konstruktion oder Bedienungsanleitung.
Und schlussendlich besteht immer ein Restrisiko des Lebens, dass niemand ausschließen kann.

Jedes Produkt benötigt eine Risikobeurteilung, unabhängig von der Maschinenrichtlinie. Wie sonst soll der Verwender, der dieses Produkt nutzt, also einbaut, wissen
welche Risiken bedacht und vermieden wurden,
welche Sicherheitseinrichtungen vorhanden sind oder noch fehlen und
welche Risiken neu entstehen können durch das Einbauen des Produkts.
Eine unvollständige Maschine ist im Allgemeinen risikoreicher als eine vollständige Maschine.

Nur der Konstrukteur weiß welche Entscheidungen er auf welcher Grundlage getroffen hat. Nur der Konstrukteur weiß wo er inhärent sicher konstruiert hat oder wo er sich warum für welche Sicherheitseinrichtungen entschieden hat.
Nur der Konstrukteur kennt seine Normen in- und auswendig.
Und genau diese Informationen müssen in der Risikobeurteilung dokumentiert werden, damit das jederzeit nachvollziehbar ist.

Ohne Risikobeurteilung fällt dem Technischen Redakteur die Erstellung einer Bedienungsanleitung, Montageanleitung oder der Sicherheitshinweise schwer. Angaben zum Produkt, die sich in beiden Schriftstücken finden, sind z.B. Bezeichnung und Einstufung des Produkts, Zielgruppe, Bestimmungsgemäßer Gebrauch, Grenzen des Produkts, Hersteller, handlungsbezogene Warnhinweise, Sicherheitshinweise, Warnschilder, Sicherheitseinrichtungen und vieles weiteres. Die Quelle für diese Informationen ist die Risikobeurteilung.
Risikobeurteilung und Produktanleitung dürfen sich in diesen Punkten nicht widersprechen.

Eine entwicklungsbegleitenden Risikobeurteilung beinhaltet folgendes:

• Sicherheit durch Konstruktion: die konstruktiv inhärente Sicherheit,
• Sicherheit durch zusätzliche Bauteile: die Sicherheitseinrichtungen,
• Sicherheit durch sicheres Handeln: die Sicherheitsinstruktionen in einer Bedienungsanleitung.

Diese Anteile sind ganz klar priorisiert. Nur wenn ich keine konstruktive Sicherheit erreichen kann, kommt eine Sicherheitseinrichtung in Frage. Nur wenn ich keine Sicherheitseinrichtung einsetzen kann, dann muss ich vor den Restgefahren warnen.

Wenn Sie ein neues Produkt entwickeln oder ein bestehendes Produkt weiterentwickeln, also entwicklungsbegleitend! Implizit machen Sie die Risikobeurteilung sicher schon. Sie machen sich Gedanken

• zur Standfestigkeit,
• zur elektrischen Verkabelung,
• zur Steuerung, etc?

Dabei berücksichtigen Sie sicher schon heute vielfach die normativen Anforderungen an diese Risiken. Dann dokumentieren sie einfach was sie wann warum entschieden haben, damit ihr Produkt das tut was es soll, nachhaltig und sicher. Damit haben sie schon bis zu 80% ihrer Risikobeurteilung erledigt!
Diese Dokumentation zu erstellen, wenn schon alles fertig ist, ist wie Reverse-Engineering: aufwändig und fehlerbehaftet.

Ihre Erfahrung war bisher:

• „Wollte noch nie jemand sehen.“
• „Es ist noch nie was passiert!“
• „Unser Produkt ist sicher!“

Gut, aber wie beweisen Sie das? Wie beweisen Sie, dass Sie alle Normen, Richtlinien und Gesetze befolgt haben? Die Antwort ist einfach – indem sie die die gesetzlichen Anforderungen des ProdSG erfüllen. Mit einer entwicklungsbegleitenden Risikobeurteilung, die folgendes beinhaltet:

• die konstruktiv inhärente Sicherheit,
• die Sicherheitseinrichtungen,
• die Sicherheitsinstruktionen.

Fast alle Staaten dieser Welt haben Arbeitsschutzgesetze, die genau dies fordern.

Es ist absolut sinnvoll einen Technischen Redakteur in den Prozess der Erstellung einer Risikobeurteilung miteinzubinden. Das hat den Vorteil, dass wenn der Redakteur am Prozess beteiligt ist, er genau weiß welche besonderen Themen es bei einer Maschine gibt. Es gibt meist weniger Rückfragen und der Redakteur ist bestens informiert.

Auch Denkrunde oder Ideensammlung genannt.
Eine Gruppe aus Experten/Mitarbeitern, Laien oder Experten anderer Fachgebiete geht nach folgenden Regeln vor:
• Kombinieren und Aufgreifen von bereits geäußerten Ideen ist erwünscht.
• Kommentare, Korrekturen und Kritik sind verboten.
• Viele Ideen in kürzester Zeit (Zeitrahmen ca. 5–30 min)
• Freies Assoziieren und Phantasieren ist erlaubt.
Der Prozess läuft zweiphasig ab
Phase Eins: Ideen finden
Die Gruppe sollte in eine möglichst produktive und erfindungsreiche Stimmung versetzt werden.
Phase Zwei: Ergebnisse sortieren und bewerten
Nach einer Pause werden nun sämtliche Ideen (von der Gruppenleitung) vorgelesen und von den Teilnehmern bewertet und sortiert.

Das Brainstorming dient häufig zum Einstieg in eines der bisher genannten Verfahren zur Risikobeurteilung.

Richtig. Auch wenn für Kraftfahrzeuge die Maschinenrichtlinie ausdrücklich nicht gilt, ist es doch ein Produkt, das unter das Produktsicherheitsgesetz fällt. Und deshalb eine Risikobeurteilung benötigt.

Die aufgabenbezogene Risikobeurteilung ist definiert und empfohlen von EN ISO 12100 und ISO TR 14121-2.

Die aufgabenbezogene Risikobeurteilung eignet sich vor allem für Maschinen, Geräte und Apparate. Weniger geeignet ist diese Methode für Anlagen mit automatischer Steuerung.
Dabei wird der Fokus auf die Lebensphasen und die darauf bezogenen Aufgaben gelegt. Die entsprechenden Gefahren werden ermittelt, bewertet und gemindert. Die Lösung wird dokumentiert.

Die Risikobeurteilung ergibt eine zu hohen Schallemission.
Die Normen beschreiben drei Möglichkeiten, um die Maschine leiser oder ungefährlicher zu machen.
Die erste Möglichkeit ist die Maschine so zu konstruieren, dass sie weniger Lärm verursacht.
Die nächste Möglichkeit sind Sicherheitseinrichtungen, z.B. eine Lärmschutzhaube über der Emissionsquelle.
Als letzte Möglichkeit bleibt noch den Benutzer vor der Gefahr durch Lärm zu warnen. In der Betriebsanleitung davor zu warnen, mit der Anweisung eine persönliche Schutzausrüstung zu tragen. Auch Piktogramme rund um den Gefahrenbereich können die Anweisung einen Gehörschutz bei den Arbeiten zu tragen verstärken.

Da die Risikobeurteilung den Konstruktionsprozess von den Anfängen an begleitet und die Überlegungen, Berechnungen, Entscheidungen der Konstrukteure von Mechanik, Elektrik, Hydraulik, Software, etc. festhält, ist dort auch die Kompetenz, das Wissen und die Verantwortung. Der Technische Redakteur kann und darf Teil des Teams sein um frühzeitig in Entscheidungen zur Methodik, dem Werkzeug und den relevanten Teilen der Risikobeurteilung eingebunden zu sein. Die Gesamtverantwortung sollte jedoch bei einer generischen Führungsposition liegen.

Das wäre schön, es verbleiben aber drei Arten von Risiken übrig.

1. Gefahren, die nicht konstruktiv oder über sicherheitstechnische Maßnahmen, minimiert werden können. Vor diesen muss gewarnt werden, in der Bedienungsanleitung oder über Warnschilder z.B.
2. Das Teil des allgemeine Lebensrisikos, dass Bezug zum Produkt hat.
3. Zweckinhärente Gefahren eines Produkts, wie Schneidgefahren, die von einem Messer ausgehen.

Die gefahrenbezogene Risikobeurteilung ist ähnlich der aufgabenbezogenen Risikobeurteilung.
Sie stützt sich auf die Gefahrenliste der EN ISO 12100.
Dabei wird von den Gefahren ausgegangen. Die Lebensphasen und die darauf bezogenen Aufgaben werden ermittelt. Die individuellen Gefahren werden bewertet und gemindert. Die Lösung wird dokumentiert.

Die Risikobeurteilung kann die CE-Erklärung nicht enthalten. Die Risikobeurteilung steht ganz am Anfang des CE-Prozesses, die CE-Erklärung ganz am Ende.

Für die Wahrscheinlichkeit des Auftretens einer Gefährdung gibt es grundsätzlich drei Möglichkeiten, die in der Risikobewertung Eingang finden:
• gering: bewährte, robuste Technologie,
• mittel: technische Fehler in den vergangenen 2 Jahren beobachtet
• hoch: regelmäßige technische Fehler beobachtet (häufiger als alle 6 Monate).
Je höher die Wahrscheinlichkeit ist, desto höher ist das Risiko.

Um die Häufigkeit und Dauer der Exposition zu bestimmen, sind folgende Fragen zu berücksichtigen:
• Wann/Wie oft ist der Zugang zum Gefahrenbereich notwendig?
• Wie lange muss sich eine Person im Gefahrenbereich aufhalten?
• Wie viele Personen haben Zugang zum Gefahrenbereich bzw. halten sich gleichzeitig im Gefahrenbereich auf?
• Wie oft ist ein Zugang zum Gefahrenbereich erforderlich (bezogen auf eine Arbeitsschicht)?
Die Grenze liegt bei 2-mal oder seltener pro Arbeitsschicht oder weniger als insgesamt 15 min. pro Arbeitsschicht.

Die Risikobeurteilung gehört zur internen Dokumentation, weil sie den Konstruktionsfortschritt dokumentiert, also Lösungen sicherheitstechnischer Probleme.
Die benötigt der Anwender draußen an der Maschine nicht, er benötigt Anweisungen. Und die findet er in der Bedienungsanleitung. Zusammen mit den Angaben der Risikobeurteilung, die seine Sicherheit betreffen.

Nachdem die Risikobeurteilung überwiegend dazu dient Gefahren für den Benutzer/Bediener zu minimieren, ist es unumgänglich sich damit zu beschäftigen wer wann was wie an dem Produkt tut. Nur dann kann ich die dann dort auftretenden Risiken sauber erfassen und möglichst minimieren.

Sie entwickeln ein neues Produkt oder entwickeln es weiter? Sie machen sich Überlegungen zu Standfestigkeit, elektrischen Verkabelungen, Software zur Steuerung, etc? Dann dokumentieren sie einfach was sie wann warum entschieden haben, damit ihr Produkt das tut was es soll, nachhaltig und sicher. Damit haben sie schon bis zu 80% ihrer Risikobeurteilung erledigt!
Das in den Wochen vor der Markteinführung zu erledigen ist wie Reverse-Engineering: aufwändig und fehlerbehaftet.

Nur, wenn der TÜV auch die Konstruktion macht. Die Risikobeurteilung entsteht integrativ mit der Konstruktion oder Umkonstruktion. Und kann schlecht davon getrennt werden.

Doch, natürlich. Es gibt unterschiedliche Ansätze aus vielen Bereichen, die geeignet sind. Dazu gehören:
• Gefahrenbezogene Risikobeurteilung
• Aufgabenbezogene Risikobeurteilung
• Auswirkungsbeurteilung (FMEA)
• HAZOP (Hazard and Operability) oder PAAG
• Fehlerbaumanalyse
• Brainstorming

Nur wenn der CE-Beauftragte auch das Produkt konstruiert und die Anleitung dazu schreibt.
Da die Risikobeurteilung konstruktionsbegleitend entsteht und tiefgehende Kenntnisse des Fachgebiets und des Produkts erfordert, tragen alle Konstrukteure, Ingenieure und Redakteure, die an diesem Produkt beteiligt sind, dazu bei. Nur so ist eine gute und hilfreiche Risikobeurteilung möglich.
Die abteilungsübergreifende Koordination einer Stabsstelle zu übertragen, ist natürlich möglich und ggf. sinnvoll.

Das kommt darauf an. Primär ist die Risikobeurteilung Bestandteil der internen Dokumentation. Insbesondere wenn sie, wie häufig, innovative originäre Konstruktionslösungen enthält, ist die Verbreitung kontraproduktiv.
Einzig Behörden haben einen vorgesehenen Anspruch auf Einsicht.
Von Zeit zu Zeit taucht dieses Thema aber in den Kaufverhandlungen auf und kann unbemerkt Teil eines Vertrags werden. Dadurch kann sich ebenfalls ein Recht auf Übergabe der Risikobeurteilung ergeben.

Alle möglichen Lebensphasen. Auch die, die unwahrscheinlich sind. Oft wird z.B. der Transport bei einer Relokalisierung der Maschine übersehen, bei einem Umzug oder einem Wechsel des Betreibers. Dagegen können Einrichten oder Teachen wegfallen, wenn diese Maschine diese Lebensphasen nicht durchläuft. Auch der bestimmungsgemäße Gebrauch und der vernünftigerweise vorhersehbare Fehlgebrauch Lebensphasen der Maschine beschränken.

Natürlich. Und zwar nicht nur die vorgesehenen Produktions- und Produktionshilfstoffe, sondern auch die Materialien der Maschinenkonstruktion selbst. Das geht von Bruchfestigkeit über Toxizität bis hin zu gefährlichen Emissionen bei Betrieb, Wartung und Entsorgung.
Materialnormen und Sicherheitsdatenblätter sind dabei wichtige Quellen.

Risikobeurteilungen sind für alle Produkte zu erstellen, die unter eine EU-Richtlinie fallen und somit CE-Kennzeichnungspflichtig, aber auch für Produkte, die unter das Produktsicherheitsgesetz fallen. Die EU schreibt vor, dass nur sichere Produkte auf den Markt gelangen dürfen. Im Falle einer Maschine, die CE-Kennzeichnungspflichtig ist die Risikobeurteilung Teil des Konformitätsbewertungsprozesses. Im Fall eines Produktes, dass unter das Produktsicherheitsgesetz fällt, müssen die Risiken bekannt sein, um den sicheren Gebrauch zu gewährleisten. Um die Risiken zu identifizieren und analysieren ist ebenso eine Risikobeurteilung notwendig. 

Nein, nur so sicher wie möglich. Verschiedene Risiken bleiben und können nicht durch die Maschinenkonstruktion vermieden werden. Restrisiken (unglückliche Zufälle), bestimmungsgemäße Risiken (Messer müssen scharf sein z.B.), Fehlbedienungen und Fehlverwendungen können dadurch nicht vermindert werden.
Aber die Maschine ist nach einer guten Risikobeurteilung rechts- und verwendungssicher.

Die Risikobeurteilung ist unbedingt, notwendig, um Benutzerinformationen und Betriebsanleitungen zu erstellen. Unter anderem führen Technische Redakteur im Einzelnen auch die Tätigkeiten aus, die in der Risikobeurteilung als gefährlich betrachtet wurden.
Ganz zu schweigen von der Zielgruppe, dem Bestimmungsgemäßen Gebrauch, den Grenzen der Maschine, den Lebensphasen

Die Gefährdungsbeurteilung eines Arbeitsplatzes sorgt dafür, dass an diesem Arbeitsplatz sicher gearbeitet werden kann, z.B. um eine Maschine zu produzieren. Dafür ist der Arbeitgeber verantwortlich.
Die Risikobeurteilung bezieht sich auf ein Produkt und dessen Hersteller ist dafür verantwortlich.
Aus der Risikobeurteilung entsteht die Bedienungsanleitung und diese ist Grundlage der Gefährdungsbeurteilung.

Eine Risikobeurteilung soll Unfälle in der Bedienung von Produkten und Maschinen vermeiden helfen. Dabei ist es notwendig die möglichen Schutzmaßnahmen sorgfältig gegeneinander abzuwägen und zu bewerten. Manch gut gemeinte Schutzmaßnahme führt gerade zum Gegenteil, einem gefährlicheren Produkt. Beispiele dafür sind Instruktionen, die

• mit Sicherheitshinweisen überladen sind
• nicht zielgruppengerecht formuliert sind
• Missbrauch nicht erkennen, benennen und untersagen.
• uvm.

Genauso kann eine Maschine durch mehr und falsche Sicherheitsmaßnahmen gefährlicher werden.

Durch Sicherheitseinrichtungen, die

• umgehbar sind,
• übermäßig hinderlich scheinen
• mangelnder Akzeptanz unterliegen.

Deshalb ist eine sorgfältige und professionelle Risikobeurteilung unerlässlich, ebenso wie eine darauf aufbauende Bedienungsanleitung.

Diese sehr große Gefahr ist häufig ein wichtiger Punkt in der Risikobeurteilung.
Die Norm DIN EN ISO 14118 „Sicherheit von Maschinen – Vermeidung von unerwartetem Anlauf“ ist eine gute Hilfe bei der sicheren Konstruktion. Selbstrückstellende Schaltelemente sind hier eine wichtige Sicherheitseinrichtung.
Flankierend und nicht weniger wichtig sind einfache und unkomplizierte Möglichkeiten für den Bediener, die Sicherheitsanweisungen zum Sichern der Maschine vor unbeabsichtigtem Einschalten zu befolgen.

Bei einer Risikobeurteilung nach FMEA werden potenzielle Risiken analysiert, indem der Gefahrenort lokalisiert wird, die Gefahrenart bestimmt, die Folge beschrieben und anschließend die Ursache ermittelt wird.
Die Werte B, A und E (jeweils 1-10):
– Bedeutung/Schwere
– Auftretenswahrscheinlichkeit
– Entdeckungswahrscheinlichkeit
werden unter Zuhilfenahme von Bewertungskatalogen vergeben und multipliziert.
Risikominimierende Maßnahmen führen zu einer Neubewertung und zu einer Verminderung der Bewertungszahl und zu einem Maß für die Reduzierung des Risikos.

In Deutschland ist die Fehlerbaumanalyse in der DIN 25424 beschrieben.
Die Fehlerbaumanalyse bedient sich der Booleschen Algebra.
Ausgehend von einem Gesamtsystemausfall wird der Fehlerbaum in einer Top-down Analyse bis zu den einzelnen Ausfallzuständen der Komponenten erstellt.
Die Anzahl der Minimalschnitte kann je nach Anwendung bis zu einige Millionen Ereigniskombinationen umfassen, die Erstellung komplexer Fehlerbäume und deren Auswertung erfolgt mit speziellen Softwarepaketen.

HAZOP ist auch als PAAG bekannt. PAAG steht dabei für die vier Schritte, die durchzuführen sind:

• Prognose (Suche potentieller Gefahren),
• Auffinden der Quellen
• Abschätzen der Auswirkungen
• Gegenmaßnahmen

Charakteristisch für das Verfahren ist ein methodisches, gelenktes Brainstorming von Experten verschiedener Fachrichtungen.

In Risikobeurteilungen wird häufig der Begriff „leicht verletzt“ verwendet. Im täglichen Leben hingegen immer wieder „Leichtverletzte“. Das geht auf unterschiedliche Definitionen zurück.

• „Leicht verletzt“ ist jemand, dessen Verletzung komplett ausheilt.
• Ein „Leichtverletzter“ muss nur ambulant versorgt werden.

Dieser Unterschied kann sehr entscheidend sein und bei der Erstellung der Risikobeurteilung sollte man sich dessen bewusst sein.

Viele Maschinen enthalten ebenfalls druckbeaufschlagte Bauteile. Und dann tut sich die Frage auf, nach welcher Richtlinie die Konformität geprüft wird. Die Aussage ist dabei klar – zumeist beides.

Die wenigsten Maschinen fallen nur unter die Druckgeräterichtlinie. Und die Maschinenrichtlinie/Maschinenverordnung ist umfassender. Deshalb ist die Antwort fast immer: Gesamtkonformität nach der Maschinenrichtlinie und individuelle Konformität der druckbeaufschlagten Bauteile nach Druckgeräterichtlinie.

SCHEMA ST4 hat einige wichtige Funktionen, die für die Erstellung und Verwaltung von technischen Dokumenten nötig sind:

• Effizientes Variantenmanagement
• Einfache Benutzeroberfläche mit Trennung von Inhalt, Struktur und Layout
• Publikationen in verschiedenen Ausgaben
• Unterstützung bei Übersetzungen

Weitere Informationen zu den wichtigen Funktionen von Redaktionssystemen findet Ihr hier: Funktionen von Redaktionssystemen · ARAKANGA GmbH

Ein Fragment ist in Schema ein sogenannter „Knoten“. Alle Inhalte sind als Knoten im Informationspool hinterlegt. Üblicherweise nutzt man Fragmente dafür, um einzelne Textabschnitte oder Tabellen innerhalb eines Textknotens nur für bestimmte Varianten geltend zu machen. Über die Eigenschaften erhält ein Fragment bestimmte Kriterien, die für den Publikationsprozess relevant sind. Mit dem Anlegen von Fragmenten bauen Sie Ihre Knoten modular auf.

SCHEMA ST4 ist ein XML-basiertes Redaktionssystem, welches die Erstellung und Verwaltung von technischen Dokumenten ermöglicht.

Der Fokus liegt hier nicht mehr auf den einzelnen Dokumenten, sondern auf Informationen. Diese versucht man modular abzulegen. Wenn die Informationen (im Informationspool) benötigt werden, werden diese in den verschiedenen Strukturen (im Projektbaum) wiederverwendet. Dieses Konzept bringt einige Vorteile mit sich. Man löst sich von dem Gedanken einzelne Dokumente zu bearbeiten, zu übersetzen und freizugeben. Sie arbeiten nur noch mit einzelnen Informationen, die auch nur einmal bearbeitet werden müssen. Das spart Zeit und Kosten!

Weitere Informationen zum Aufbau von Redaktionssystemen findet Ihr hier: Aufbau von Redaktionssystemen · ARAKANGA GmbH

Meiner Meinung nach ist das Redaktionssystem SCHEMA ST4 ein sehr hilfreiches System für die Verwaltung und Erstellung von technischen Dokumenten. Jedoch muss man klar sagen, dass das Redaktionssystem nicht das kostengünstigste ist und viele Unternehmen nicht alle oder nur unzureichend die Funktionen von SCHEMA ST4 nutzen. Daher ist eine vorherige Beratung äußerst wichtig. Unternehmen sollten sich fragen:

• Wie soll unsere Technische Dokumentation aussehen?
• Welchen Anforderungen muss unsere Technische Dokumentation gerecht werden?
• Welche Funktionen muss das Redaktionssystem haben, um dies zu ermöglichen?

Für diese Fragen und für die Auswahl und Einführung eines passenden Redaktionssystems unterstützen wir euch gerne: Systemeinführung & Hosting · ARAKANGA GmbH

Das Redaktionssystem SCHEMA ST4 bietet unterschiedliche Viewlets an, damit Sie Ihre Informationen besser strukturieren können. Das gelingt mithilfe der Viewlets Informationspool und Projektbaum.

Im Informationspool strukturieren und erstellen Sie Ihre Informationen, die Sie in mehreren Handbüchern wiederverwenden können.

Im Projektbaum erzeugen Sie die Struktur der Handbücher. Sie ziehen einfach die Informationen aus dem Informationspool in Ihr jeweiliges Projekt. Die Projekte können Sie als Dokumente produzieren.

Sie können im Redaktionssystem SCHEMA ST4 Metainformationen an folgenden Objekten setzen:

• Schema (als übergreifendes Objekt)
• Knoten
• Links
• Knotenklassen
• Linkklassen

Wenn Sie häufig mit Freigaben und Änderungen arbeiten, Sie umfangreiche Informationen bereitstellen möchten, dann macht es absolut Sinn mit Versionierungen zu arbeiten. Mit einem Redaktionssystem wie SCHEMA ST4 können Sie Versionen auf verschiedenen Ebenen anlegen:

• Für die Inhalte der Knoten
• Für Knoten und Strukturen selbst

Mit dem integrierten Versionsbrowser sehen Sie alle Versionen eines Knotens und können die verschiedenen Versionsstände für Ihre unterschiedlichen Dokumente nutzen.

Damit Sie bereits erstellte Inhalte in SCHEMA ST4 finden und wiederverwenden können, bietet SCHEMA ST4 hilfreiche Suchfunktionen an:

• Metadatensuche
• Schnellsuchbereich
• Volltextsuchbereich
• Suche in WORD- und PDF-Dateien
• uvm.

Nicht ganz unwichtig für uns Technische Redakteure ist zu wissen, welche Editoren und Formate vom Redaktionssystem SCHEMA ST4 unterstützt werden:

Als Editoren dienen:

• MS Word
• Adobe FrameMaker
• XMetaL

Publikationen können für die Printausgabe in folgenden Formaten generiert werden:

• MS Word
• Adobe FrameMaker
• Adobe InDesign
• PDF

Publikationen können für die Ausgabe als Hilfe in folgenden Formaten generiert werden:

• HTMLHelp
• MS Help Viewer
• JavaHelp
• EclipseHelp

Für die Webausgabe stehen folgende Formate zur Verfügung:

• HTML5
• HTML
• XML

ST4 unterstützt direkt die folgenden Translation Memory Tools

• SDL Trados
• Across

Beliebige weitere TMS Tools können über die folgenden Möglichkeiten eingebunden werden

• COTI Level 1 und 2
• XML-TMS

Ein Knoten steht für eine Informationseinheit in SCHEMA ST4. Sie können jeden Knoten mit einem Text, Bild oder auch nur mit einem Metadatum verknüpfen. Jeder Knoten gehört einer Knotenklasse an, welche das Aussehen und das Verhalten eines Knotens bestimmen.

Für das Übersetzungsmanagement hat SCHEMA ST4 einen Übersetzungsreport. Dort können Sie verschiedene Knoten hineinziehen. Der Übersetzungsreport gibt Ihnen Auskunft in welche Sprachen der Knoten bereits übersetzt wurde, ob er zur Übersetzung bereits exportiert wurde und ob der Stand der Übersetzung aktuell oder veraltet ist.

Sie können aus ST4 heraus nahezu beliebige Zielformate produzieren. Sei es für Online Hilfen, Print-Dokumente oder das Generieren von statischen oder dynamischen Webpages.

Online-Hilfen:

• HTMLHelp,
• Microsoft Help Viewer
• SCHEMA Viewer
• SCHEMA Reader

Print-Dokumente:

• Nach MS Word
• Nach FrameMaker
• Nach PDF
• Nach Adobe InDesign

Es kann durchaus sinnvoll sein, mehrere Knoten oder Teilbäume als XML zu exportieren. Beispielsweise um Daten zu sichern oder in eine andere Datenbank zu exportieren. Mit dem Redaktionssystem SCHEMA ST4 können Sie Knoten oder mehrere Knoten und Teilbäume als XML exportieren. Dies gelingt mithilfe des Assistenten XML-Export.

SMC ist ein Redaktionssystem, dass browserbasiert XML-Technologie verwendet, um überwiegend Anwenderdokumentation zu erstellen. Die Extensible Markup Language, abgekürzt XML, ist eine standardisierte Auszeichnungssprache zur plattform- und implementationsunabhängigen Darstellung hierarchisch strukturierter Daten. Dabei werden Inhalte und Attribute dieser Inhalte getrennt behandelt. So lassen sich auf der gleichen Datenbasis die unterschiedlichsten Dokumente erzeugen.

Das Frontend von SMC wird innerhalb jedes handelsüblichen Browsers bedient. Das führt zu Unabhängigkeit von einer bestimmten IT-Umgebung oder einer lokalen Installation von spezieller Software. Lediglich ein Internetanschluss ist notwendig.

Als modernes Redaktionssystem kann man mit SMC natürlich auch alle anderen Arten von Dokumenten und Medien erstellen. Dazu gehören insbesondere Marketingunterlagen. Gleichzeitig ermöglicht SMC Cross-Media-Publishing.

Der erste Anlaufpunkt ist eine Webadresse auf einem Server auf dem die Anwendung läuft. Nach einem LogIn baut sich die Bedienoberfläche auf. Der Umfang der Anzeige und der Bedienmöglichkeiten hängt von den Berechtigungen des verwendeten LogIns ab.

Der Editor ist nach Bearbeitungsebenen gestaffelt und bietet alle notwendigen Möglichkeiten, teilweise in Menüs und Untermenüs, für Verwaltung, Redaktion bzw. Redaktion.

Redaktionssysteme benötigen Funktionen für die Verwaltung von Modulen, Büchern, Grafiken, Variablen, Übersetzungen, Varianten und einiges mehr. SMC bietet alle diese Möglichkeiten.

Zusätzlich zu den Basisfunktionen für das reine Erstellen von Texten und anderen Elementen einer Anwenderdokumentation bietet SMC auch noch erweiterte Funktionen für eine Variantensteuerung, für die Grafikverwaltung und für das Nutzen von Automatismen, wie Inhaltsverzeichnisse, Glossare, Verweise, Nummerierungen etc.

Der Reviewer hat die Möglichkeit in jedem Modul Notizen zu hinterlassen und Dateien dazu hochzuladen

Die HMI stellt den Microsoft-Nutzer vor Umstellungsprobleme, intuitiv gewordene Features wie Doppelklicks zu Navigation oder Drag&Drop funktionieren nicht oder nicht immer wie erwartet.

Auch die gestaffelten Menüleisten mit gleichen oder ähnlichen Menüpunkten, die sich dann auf den unterschiedlichen Ebenen in überraschender Weise auswirken können, sind gewöhnungsbedürftig und können schnell zu Fehlbedienungen führen. Da ist Vorsicht geboten.

Durch die Verwendung eines handelsüblichen Browsers als Interface stehen auch nur die Möglichkeiten, die der Browser bietet zur Verfügung, z.B. unter Windows nicht alle gewohnten Shortcuts, die man von MS-Produkten gewöhnt ist.

Das Interface, die Reaktionen und die Shortcuts können auch von Browser zu Browser differieren. Im Grunde bieten alle Browser aber ähnliche Bedienmöglichkeiten.

Technische Redakteure sind speziell ausgebildete und qualifizierte Fachkräfte, die technische Daten/Informationen in verständlicher Sprache vermitteln. Der Technische Redakteur erstellt beispielsweise folgende technische Dokumente:

• Montage- und Wartungsanleitungen
• Bedienungsanleitungen
• Gebrauchsanweisungen
• Onlinehilfen für Softwareprodukte
• Nutzungsinformationen
• Usw.

Kosten entstehen in der Dokumentation an verschiedenen Stellen:

• Kosten sparen bei der Informationsrecherche
• Kosten sparen beim Texten und Grafikerstellen
• Kosten sparen bei der Verwaltung
• Kosten sparen beim Publizieren, Layouten
• Kosten sparen beim Übersetzen

In jedem Bereich lassen sich Kosten sparen. Wenn die Bereiche optimal aufeinander abgestimmt sind, ist der Sparerfolg am größten

Bei der Informationsrecherche geht viel Zeit verloren, wenn bei der Produktentwicklung nicht an die Informationsbedürfnisse der Redakteure gedacht wird. Die Dokumentation muss in den Entwicklungsprozess integriert werden und alle notwendigen Informationen automatisch erhalten. Stellen Sie hierzu eine Liste auf, welche Informationen die Redaktion benötigt. Definieren Sie, wer für die Lieferung der jeweiligen Info verantwortlich ist und legen Sie fest, bis wann im Entwicklungsprozess diese Informationen geliefert werden müssen. Hilfe für solche Festlegungen finden Sie zumeist in der QM-Abteilung.

Beim Texten muss systematisch gearbeitet werden. Technische Dokumentation muss modular aufgebaut sein, d. h. aus Modulen bestehen, die in unterschiedlichen Dokumentationen wieder verwendet werden können. Dabei darf nicht jeder Redakteur seinen eigenen Stil und seine eigene Modularisierungsweise entwickeln. Einheitlichkeit ist hier notwendig. Dies geht am besten methodisch, siehe https://arakanga.de/arawiki/strukturierungsmethoden/.

Bei der Grafikerstellung kann vielfach auf 3d_Daten aus der Konstruktion zurückgegriffen werden. Mit der richtigen Software lassen sich aus diesen Daten alle Grafiken schnell erstellen, die in der Technischen Dokumentation benötigt werden, siehe https://arakanga.de/technische-dokumentation/technische-dokumentation/toolumgebungen/

Die Verwaltung von Dokumentationen erfolgt vielfach auf dem Dateisystem, teilweise ergänzt mit einer Excel-Tabelle. Dies ist aufwendig, umständlich und fehlerträchtig. Stand der Technik ist für die Technische Dokumentation ein spezialisiertes Redaktionssystem zu nutzen, sogenannte CMS oder CCMS System, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.

Publizieren und Layouten sind die letzten Schritte im Erstellungsprozess. Hier kommen die Module zusammen und werden zu einer kompletten Dokumentation aufbereitet. Sind das z. B. Word Dokumente, kommt es oft zu unerwünschten Effekten, wenn Dokumente zusammenkopiert werden. Beim Maschinenbau müssen oft für die Zulieferdokumente Inhaltsverzeichnisse erstellt werden, zumeist manuell. Für diese Schritte ist Zeit erforderlich, die mit den richtigen Werkzeugen gar nicht oder nur in sehr geringem Maß notwendig sind. Redaktionssystem können diese Aufgaben automatisieren und „auf Knopfdruck“ das gewünschte Ergebnis erstellen, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.

Sicherheitshinweise, Warnhinweise, Gefahrenhinweise – Häufig tauchen diese Begriffe in der Technischen Dokumentation als Synonyme auf. Dabei haben sie unterschiedliche Bedeutungen. Doch wo liegt jetzt der Unterschied?

• Sicherheitshinweise beschreiben dem Nutzer alle wesentlichen Aspekte zum sicheren Umgang mit dem Produkt und stehen häufig in einem eigenen Sicherheitskapitel. Sie dienen als Grundlage für eine Einweisung oder Schulung von Nutzern in Hinblick auf sicherheitsbewusstes Arbeiten.
• Warnhinweise beziehen sich auf spezifische Tätigkeiten und konkrete Handlungen. Sie sollen Sicherheitsrisiken für die jeweilige Handlung aufzeigen und dem Nutzer erlauben, sich vor den Gefahren zu schützen.

Weitere Informationen findet Ihr hier: https://arakanga.de/arawiki/normen-richtlinien/

Bevor ein Produkt verkauft bzw. zum Einsatz kommen kann, müssen viele Informationen und Daten gesammelt und zusammengetragen werden. Interne Dokumente können z. B. sein:

• Technische Zeichnungen
• Risikobeurteilung
• Pflichtenheft
• Zertifikate und Prüfberichte
• Material- und Stücklisten

Im Grunde genommen bedeutet das: Illustrieren statt Beschreiben. Alle wichtigen Informationen werden über Bilder vermittelt. Oftmals sind sie aussagekräftiger als reiner Text. Sie senken Übersetzungskosten oder sie entfallen ganz. Noch interessanter kann die Informationsübermittlung in Form von bewegten Grafiken, Animationen oder Filmen erfolgen. Diese könnten bei Wartungs- und Instandsetzungsarbeiten am Interface einer Maschine abgerufen werden.

Besondern für Unternehmen mit mehreren Technischen Redakteuren sind sprachliche Standards besonders relevant. Die Konsistenz in Wortwahl und Stil steigert die Textverständlichkeit, reduziert Übersetzungskosten und steigert somit die Qualität Ihrer Dokumentation. Die Regeln Ihrer Standardisierung halten Sie in einem Redaktionsleitfaden fest.

Mehr Infos zum Redaktionsleitfaden findet Ihr hier: Redaktionsleitfaden · ARAKANGA GmbH

Natürlich kann man einfach drauflos schreiben, es führt aber schnell zum Chaos! Strukturierungsmethoden sind sozusagen die Anleitung für die Anleitung und besonders wichtig für jeden Technischen Redakteur. Ziel einer Strukturierungsmethode ist es, Technische Dokumentation systematisch und strukturiert zu erstellen. Man gliedert Informationen in sinnvolle Einheiten. Somit können Benutzer die gewünschte Information leichter finden und diese besser verstehen!

Mehr Infos zu Strukturierungsmethoden in der Technischen Dokumentation findet Ihr hier: Strukturierungsmethoden · ARAKANGA GmbH

Typischerweise werden von uns erstellte Dokumente nicht nur gedruckt, sondern in verschiedenen Online-Medien zur Verfügung gestellt. Beispiele dafür sind:

• Verlinkte PDFs auf DVD
• Integrierte Software-Hilfe
• Hilfe auf der Maschinensteuerung, über Touchscreen bedienbar
• Content Delivery System (CDS)

Besonders im Bereich einer Anlagendokumentation, wenn eine gelieferte Dokumentation in die gesamte Technische Dokumentation eingebunden werden muss, kann es zu Problemen kommen. Oft sind Dokumentationen vom Lieferanten unbrauchbar, haben keine Handlungsaufforderungen, keinen Wartungsplan oder ungeeignete Ausgabeformate. Auch die Lieferung in der falschen Sprache ist kein seltenes Phänomen.

Im Internet findet man zahlreiche Beispiele von schlechten Anleitungen. Oft sind es Übersetzungsfehler, die uns zum Schmunzeln bringen. Auch kann es vorkommen, dass die gelieferte Anleitung nicht zum Produkt passt. Manche Anleitungen sind reine Funktionsbeschreibungen und haben keinerlei Handlungsanforderungen oder es fehlen komplette Kapitel auf die eigentlich verwiesen werden soll.

Um eine gute Lieferantendokumentation zu erhalten, ist es wichtig, dass die Technische Redaktion mit dem Einkauf eine gute Zusammenarbeit sucht und diese aktiv unterstützt. Der Einkauf eines Unternehmens kennt oftmals die Problematik der Technischen Redaktion und Konstruktion nicht. Hier ist es angebracht, dass die Redaktion ihre Anforderungen an Lieferantendokumentationen erklärt und vermittelt. Dies kann sinnvollerweise anhand einer Checkliste erfolgen, mit der sich schnell prüfen lässt, ob eine Lieferantendokumentation ihren Zweck erfüllt oder nicht.

Mittlerweile gibt es schon bestimmte use cases in denen Künstliche Intelligenz die Technische Redaktion unterstützt. Beispielsweise können modulare Inhalte mithilfe einer KI automatisch Metadaten zugeordnet werden. Auch das Finden von Dubletten, kann eine sinnvolle Unterstützung für uns Technische Redakteure sein.

OCR (Optical Character Recognition) ist eine Technologie, die es ermöglicht, unterschiedliche Dokumente, wie eingescannte PDFs in bearbeitbare, digitale Dateien umzuwandeln. Für die Technische Dokumentation bedeutet das, dass eingescannte Betriebsanleitungen digitalisiert werden können. Und das ohne langes Abtippen. Innerhalb weniger Minuten können Dokumente mittels OCR-Technologie (Texterkennung) in digitale Formate umgewandelt werden. Eine abschließende Rechtschreibprüfung sollte auf alle Fäll erfolgen, denn es kommt immer wieder vor, dass nicht alle Zeichen richtig erkannt werden.

Die Technische Dokumentation muss im digitalen Zeitalter beachten, dass immer weniger Leser sich eine komplette Anleitung durchlesen. Wir sind es aus unserem Alltag gewöhnt, Inhalte sofort und passend zu erhalten. Daher sind zielgruppengerechte und intelligent verknüpfte Informationen für die Technische Dokumentation essentiell.

In Zeiten der Digitalisierung finden 3D-Animationen auch in der Technischen Dokumentation ihren Einsatz. In der Regel liegen CAD-Konstruktionsdaten zu fast allen Produkten (Geräte / Maschinen) vor, sodass solche Animationen entwicklungsbegleitend erstellt werden können. 3D-Animationen sind vor allem bei Montage- und Instandsetzungsarbeiten sinnvoll, denn mittels der Visualisierung können komplexe Sachverhalte einfach dargestellt werden. Mehr über 3D-Animationen können Sie hier nachlesen: https://arakanga.de/3d-animation/

Oft gibt es Schwierigkeiten bei der Struktur und Gestaltung von Warnhinweisen. Oft beschreiben Ingenieure sehr komplexe Hinweise, ohne Struktur und verschachteln Hinweise im Text, sodass der Leser die Handlungen nur schwer verstehen kann. Hierfür wurde das SAFE-Prinzip entwickelt.

Das SAFE-Prinzip beschreibt den Aufbau und die Gestaltung von Warnhinweisen. Es ist folgendermaßen aufgebaut:

• S = Signalwort z. B. Gefahr, Warnung, Vorsicht.
• A = Art und Quelle der Gefahr z. B. Verbrennungsgefahr durch heiße Oberflächen.
• F = Folgen bei Nichtbeachtung des Warnhinweises z. B. Schwere Verbrennungen/Verletzungen.
• E = Entkommen z. B. Tragen Sie geeignete Handschuhe.

Eine Anlagendokumentation unterscheidet sich von einer normalen Dokumentation im Grunde nur in ihrem Umfang und der Komplexität. Eine Anlage ist ein Verbund von mehreren Maschinen. Es ist somit für jede Maschine eine Dokumentation notwendig. Der Hersteller muss sich überlegen, wie er die Dokumentation organisiert und bereitstellt. Auch hier gilt: Die Dokumente müssen den Zielgruppen angepasst werden.

Die Zukunft der Technischen Dokumentation ist digital. So oder so ähnlich hört man es oft, wenn man über die Zukunft der Technischen Dokumentation spricht. Tatsächlich durchzieht die Digitalisierung inzwischen alle Branchen. Auch die Technische Dokumentation durchlebt diesen Umbruch. Doch welche Vorteile kann uns die Digitalisierung bringen? Hier ein paar Vorteile:

• Weniger Ausdrucke der Dokumentationsvorlagen
• Weniger bürokratischer Papierverwaltungsaufwand
• Inhalte und Informationen sind mühelos zu finden
• Inhalte und Informationen können viel zielgerichteter und praktikabler aufgebaut werden
• Steigerung der Dokumentationsqualität
• Senkung der Dokumentationskosten

Grundsätzlich unterscheidet man zwischen „externer“ und „interner“ Dokumentation. In der Technischen Dokumentation liegt der Fokus der Arbeit auf der Erstellung und Publikation von Nutzerinformationen (externer Dokumentation). Der Begriff der internen Dokumentation ist gesetzlich nicht festgelegt, es geht aber im Prinzip darum, die Entwicklung und den Herstellungsprozess eines Produktes zu dokumentieren sowie den Vertrieb, die Nutzung und die Entsorgung des Produktes.

Mit der Digitalisierung ergeben sich auch neue Chancen für die Technische Kommunikation. Beispielsweise können QR-Codes an bestimmten Stellen am Produkt den Nutzer in wenigen Sekunden zur Anleitung führen, sodass kein Techniker kommen muss. Es genügt, den QR-Code abzufotografieren und schon erhält der Nutzer alle wichtigen Informationen zur Tätigkeit auf seinem mobile device.

Betriebsanleitungen werden in den meisten Fällen neben Papier auch digital zur Verfügung gestellt. Doch Augmented Reality geht noch einen Schritt weiter. Mit dieser Technologie lässt sich die Realität mit virtuellen Daten erweitern. Über mobile Endgeräte wie Tablets, Smartphones oder AR-Brillen lassen sich dann die hinterlegten Informationen anzeigen. Der Aufruf kann z. B. über einen QR-Code aufrufen.

Das Klassifizieren von Warnhinweisen erfolgt typischerweise im Rahmen einer Risikoanalyse. Diese wird von Konstrukteuren und Entwicklern erstellt. Oftmals neigen Mitarbeiter aus der Konstruktion und Entwicklung dazu, eher eine sehr hohe Gefahrenstufe auszuwählen. Dies birgt jedoch die Gefahr einer Überwarnung durch zu viele Warnhinweise. Es empfiehlt sich bei der Erstellung und Formulierung von Warnhinweisen sich an der ANSI Z535.6 zu orientieren. Wenden Sie das SAFE-Prinzip bei der Erstellung des Warnhinweises an.

Weitere Infos zur ANSI Z535.6 findet Ihr hier: ANSI Z535.6 · ARAKANGA GmbH

Produktsicherheitslabel sollen laut EN82079-1 nicht mit Sicherheits- und Warnhinweisen verwechselt werden. Sie sind direkt auf dem Produkt bzw. an der Maschine selbst aufgebracht und sollen den Nutzer vor Gefahren und Schäden bewahren.

Eine Maschine oder Anlage besteht oftmals aus Zukaufteilen von Lieferanten. Die Lieferanten müssen für ihr Bauteil eine Technische Dokumentation mitliefern. Somit ist eine Lieferantendokumentation nichts anderes als die Technische Dokumentation des Lieferanten.

Künstliche Intelligenz (KI) hat auch in der Technischen Dokumentation ihren Einsatz gefunden. KI bietet die Möglichkeit Informationsmodule automatisch mit Metadaten zu versehen. Metadaten sind in Redaktionssystemen von großer Bedeutung und müssen jedem Informationsmodul von Hand zu geordnet werden. Besonders Anwendungen wie „Content Delivery Portale“ sind auf die Zuweisung von Metadaten angewiesen, um Anwendern eine facettierte Suche zu ermöglichen.

Aus Sicht der Technischen Redaktion ist eine gute Betriebsanleitung zielgruppen- und zweckorientiert. In der Regel schaut sich der Anwender die Betriebsanleitung an, weil er eine Frage hat. Deshalb antworten gute Betriebsanleitungen auf Anwenderfragen. Weitere Kriterien, die eine gute Betriebsanleitung erfüllen sollte, sind die folgenden:

• Verständlichkeit
• Vollständigkeit
• Übersichtlichkeit
• Gestaltung
• Normenkonformität

Mehr über gute Betriebsanleitungen können Sie hier nachlesen:
Qualitätskriterien für Dokumente · ARAKANGA GmbH

Welche Anleitungen es gibt hängt davon ab, welchen Zweck Sie erfüllen soll. Eins haben alle Anleitungen gemeinsam, Sie geben Anweisungen zum Handeln. Je nach Zielgruppe handelt es sich bei Anleitungen gewöhnlich um produktbegleitende Dokumente, die damit Teil des Produktes sind. Hier ein paar Beispiele für Arten von Anleitungen:

• Bedienungsanleitung
• Montageanleitung
• Installationsanleitung
• Wartungsanleitung
• Demontageanleitung

Die aufgelisteten Arten von Anleitungen beziehen sich auf einzelne Lebensphasen. Es besteht auch die Möglichkeit, eine Anleitung für alle Lebensphasen zu erstellen – die „Betriebsanleitung“.

Ob es sich um eine Betriebsanleitung oder Gebrauchsanweisung handelt hängt davon ab, nach welcher Richtlinie oder Norm die Anleitung erstellt wurde. In beiden Fällen handelt es sich um Anleitungen, die Teil des Produktes sind und den sachgemäßen Gebrauch gewährleisten sollen, sodass kein Mensch zu Schaden kommt. Die Maschinenrichtlinie bezeichnet die Anleitung als „Betriebsanleitung“, während in der DIN EN 82079-1 von „Gebrauchsanweisungen“ gesprochen wird.

Nach der ANZI Z535.6 ist die Gestaltung von Sicherheits- und Warnhinweisen ohne Piktogramme vorgesehen. Verboten ist die Verwendung von Piktogrammen allerdings nicht. Anders ist das bei der Gestaltung von Aufklebern, die an der Maschine angebracht werden. In diesem Fall sind Piktogramme zu verwenden.

Eine gute Anleitung muss:

·        Verstanden werden

·        Vor allen möglichen Gefahren warnen

·        Inhaltlich korrekt und vollständig sein

·        Mit der Auslieferung des Produktes fertiggestellt sein

Eine Produktinformation ist ein Dokument, dass ein Produkt beschreibt. Das können z. B. Produktkataloge, Technische Datenblätter etc. sein. Der Kunde hat durch diese Dokumente die Möglichkeit, das Produkt zu beurteilen und die richtige Variante auszuwählen.

Man bekommt es in den verschiedensten Branchen mit. Es fehlen immer mehr Fachkräfte. Eine gute Technische Dokumentation kann dem Nutzer oder dem Servicetechniker genau die benötigte Information zur Verfügung stellen, die er zum jetzigen Zeitpunkt benötigt. Und das am besten nicht nur auf Papier, sondern in den verschiedensten Ausgabemedien (App, QR-Code, Videoanleitungen). Das spart Zeit und im Endeffekt Kosten.  

Oftmals werden die Begriffe Betriebsanleitung und Bedienungsanleitung synonym verwendet. Eine Betriebsanleitung muss alle notwendigen Informationen und Hinweise für den sicheren und bestimmungsgemäßen Gebrauch bzw. Betrieb mit dem Produkt enthalten. Die Bedienungsanleitung enthält zusätzlich alle Informationen wie Schritt für Schritt Anweisungen, die den richtigen Umgang mit dem Produkt beschreiben.

Metadaten können als eine der wichtigsten Werkzeuge für die Technische Dokumentation in Content Management und Content Delivery fungieren. Mit Metadaten lassen sich Produkte automatisiert zu bestimmten Gruppen zuordnen, Zielgruppen festlegen oder Geräteeigenschaften managen.

An eine moderne Technische Redaktion werden heute einige Anforderungen gestellt, die es zu bewältigen gibt. Anleitungen, Übersetzungen oder Web-Informationen müssen dem Nutzer jederzeit zur Verfügung stehen und auf Knopfdruck produziert werden. Viele Unternehmen erfüllen immer individuellere Kundenanforderungen (z. B. wird ein Auto aufwendig konfiguriert). Das erhört die Anforderungen an die Dokumentation zusätzlich.

Auch 3D-Animationen können für die Technische Dokumentation hilfreich sein. Einsatzmöglichkeiten finden sich in:

• Betriebsanleitungen
• Montageanleitungen
• Instandhaltungshandbuch

3D-Animationen eignen sich hervorragend, um bestimmte Abläufe oder Funktionen eines Produktes visuell darzustellen. Beispielsweise können so einzelne Montageschritte im Montagehandbuch dargestellt werden. Auch für den Technischen Redakteur sind 3D-Animationen wichtige Informationen, um das Produkt besser zu verstehen.

Technische Dokumentationen im digitalen Format gewinnen immer mehr an Bedeutung. Prinzipiell lassen sich digitale Dokumentationen in nahezu jedem elektronischen Format erstellen. Häufig werden sie als Online-Hilfen oder in PDF publiziert.

Als Hersteller meines Produktes bzw. meiner Maschine muss ich darauf achten, dass meine Technische Dokumentation dem aktuellen Stand der Technik entspricht. Verbesserte Methoden und Weiterentwicklungen zur Produktsicherheit müssen in der Betriebsanleitung aktualisiert werden.

Bei „Stand der Technik“ handelt es sich um einen unbestimmten Rechtsbegriff. Er ist einer der wichtigsten Technikklauseln für Maschinensicherheit, Produktsicherheit und Arbeitssicherheit. Mit der Klausel „Stand der Technik“ soll sichergestellt werden, dass die beste verfügbare Technik zum aktuellen Zeitpunkt zum Einsatz kommt.

Liefern Sie als Hersteller Ihre Produkte in unterschiedlichen Varianten in mehrere Länder? Falls ja, dann ist ein Redaktionssystem mit einem effizienten Variantenmanagement sicher sinnvoll für Ihre Dokumentation! Warum? Sie haben mit Sicherheit etliche redundante Inhalte, die ziemlich ähnlich oder fast identisch sind. Diese müssen bei einer Aktualisierung alle einzeln angefasst werden. Das kostet Zeit und Geld. Mit einem effizienten Variantenmanagement werden Inhalte nur einmal erstellt und in mehreren Anleitungen wiederverwendet. Diese müssen bei Änderungen oder Korrekturen nur einmal angefasst werden.

In der Technischen Dokumentation müssen nicht alle Informationen in einem Dokument enthalten sein. Es macht durchaus Sinn, die Informationen in mehrere Dokumente aufzuteilen (z. B. Wartungshandbuch, Instandsetzungshandbuch, Entsorgungsanleitung).

Um mit einem Redaktionssystem sinnvoll zu arbeiten, gibt es bestimmte Anforderungen, die Dokumente erfüllen sollten. Ein Modularisierungskonzept legt fest wie Dokumente modularisiert werden sollen, um sinnvoll wiederverwendet werden zu können.

Dokumente einfach klein zu schneiden, um sie im Redaktionssystem besser wiederverwenden zu können ist nicht die Lösung. Ein sinnvolles Modularisierungskonzept schöpft das volle Optimierungspotenzial der Modularisierung aus.

Die Modularisierung von Dokumenten sollte folgende Anforderungen erfüllen:

• Die Dokumente benötigen einen hohen Wiederverwendungsgrad mit möglichst kleinen Modulen.
• Produktvarianten müssen abgedeckt werden können.
• Dokumente müssen weiterhin lesbar sein.
• Dokumente sollten navigierbar sein.
• Dokumente sollten trotz Modularisierung noch in einem sinnvollen Kontext erstellt und übersetzt werden können.

Damit Anwender schnell und einfach das finden, was sie suchen, müssen die Objekte modular aufgebaut sein und immer einen Zweck erfüllen. Der Zweck besteht darin, genau eine Anwenderfrage zu beantworten, die inhaltlich zu einem Thema gehört. Ein Thema entspricht einem Objekt. Daher sind die Objekte in funktionale Einheiten gegliedert, sogenannte Frage-Antwort-Muster.

Die Informationsplattform Sherlock ist die Content Delivery Lösung von Fischer.

Sherlock greift aus Informationen aus unterschiedlichen Systemen zurück. Der Nutzer stellt eine Suchanfrage, die er über Facetten präzisieren kann, und erhält eine entsprechende Antwort. Mit Sherlock sind auch die Redaktionsobjekte aus TIM über ein Portal abrufbar und können auf dem Smartphone, Tablet, Laptop oder auf dem Display der Maschine dargestellt werden.

Das Redaktionssystem TIM bietet Suchfunktionen über den Objektmanager und über die Document Control List (DCL), also das Dokumentationsprojekt an.

Eine DCL ist eine Document Control List und stellt das Dokumentationsprojekt dar. In anderen Worten – eine DCL stellt die Struktur des Handbuchs dar. Die DCL besteht aus drei Arten von Knoten:

1. Chapter
2. Section
3. Para

Das Redaktionssystem TIM bietet Suchfunktionen über den Objektmanager und über die Document Control List (DCL), also das Dokumentationsprojekt an.

Bei der Suche innerhalb des Objektmanagers handelt es sich um eine Suche aller verfügbaren Redaktionsobjekte, die als „Informationspool“ hinterlegt sind. Über eine Filteransicht bietet der Objektmanager Felder zur Eingabe von Suchkriterien an. Gesucht wird über die Metadaten aller Objekte. Bei der Suche innerhalb des Dokumentationsprojektes (DCL) handelt es sich um eine Suche nach verwendeten Objekten innerhalb des Dokumentationsprojektes. Die gefundenen Objekte werden im Dokumentationsprojekt blau hinterlegt.

Der Objektmanager ist der Kern des Redaktionssystems TIM. Mit dem Objektmanager wird die Verwaltung aller redaktionellen Objekten realisiert. Über den Objektmanager lassen sich alle redaktionellen suchen, finden und aufrufen, sodass diese zum Erstellen von neuen Dokumenten zur Verfügung stehen. Mit Hilfe von Suchfeldern, bietet der Objektmanager auch eine metadatengestützte Suchfunktion an.

Um eine Version im Redaktionssystem TIM zu erzeugen, muss zunächst der Baustein freigegeben sein. Die Freigabe des Bausteins können Sie über den Status erteilen. Wenn diese Voraussetzung gegeben ist, lässt sich eine neue Version ganz leicht über einen Rechtsklick auf der Maus anlegen. Wenn Sie eine neue Version erzeugt haben (Version 1.1) können Sie die Version (1.0) nicht mehr editieren. Wenn Sie die Version (1.1) bspw. freigeben, aber hinterher Anpassungen vornehmen möchten, die sich auf den gleichen Versionsstand beziehen, müssen Sie zunächst den Status in „Zur Prüfung freigeben“ ändern. Daraufhin können Sie Ihre Anpassungen durchführen und anschließend den Status wieder in „Freigeben“ ändern. Das bedeutet, es muss nicht zwangsweise für jede Änderung eine neue Version erzeugt werden.

Mit Hilfe der Funktion zum Versionieren sichern Sie sich einen bestimmten Arbeits- oder Auslieferungstand. Vor allem bei Auslieferungen ist es vorteilhaft, wenn man jederzeit auf diesen zurückgreifen kann. Ohne Versionierung ist es oftmals so, dass verwendete Bausteine überschrieben werden und somit den Stand der Auslieferung verändern. Über die Eigenschaften können Sie einsehen, ob Ihre Dokumentation auf dem aktuellen Stand ist bzw. die aktuellsten Bausteine (Textinhalte und Grafiken) verwendet.

Die Suche nach Bausteinen ist beim Redaktionssystem TIM über den Objektmanager ganz einfach auszuführen. Beim Erstellen von Bausteinen vergeben Sie Eigenschaften. Über diese Eigenschaften können Sie im Objektmanager Ihre Suche starten. Der Objektmanager zeigt Ihnen alle vorhandenen Bausteine an, die Ihren Suchkriterien entsprechen. Darüber hinaus können Sie über den Objektmanager auch einsehen, wo überall diese Bausteine verwendet werden und welche weiteren Bausteine darin enthalten sind. Das ist vor allem dann zu berücksichtigen, wenn Sie Änderungen an Bausteinen vornehmen möchten

Verschachtelte Module sind innerhalb vom Redaktionssystem TIM Bausteine, die zur Wiederverwendung gespeichert werden und in anderen Bausteinen verwendet werden, z. B. Maschinenübergreifend. Das Arbeiten mit verschachtelten Modulen bringt den Vorteil mit sich, dass inhaltliche Änderungen nur einmal ausgeführt werden müssen. Denn überall dort, wo ein verschachteltes Modul verwendet wird, wird die Änderung übernommen. Sinnvoll ist es dann verschachtelte Module zu erstellen, wenn der gleiche Inhalt innerhalb einer Betriebsanleitung mehrfach verwendet wird. Aber nicht nur um Wiederverwendungen zu erzeugen bieten sich verschachtelte Module an. Sie sind zwingend erforderlich für die Variantensteuerung. Beim Erstellen verschachtelter Module werden Eigenschaften hinterlegt, die für den Publikationsprozess relevant sind. Siehe Wie funktioniert eine Variantensteuerung mit TIM RS.

Die Variantensteuerung beim Redaktionssystem TIM ermöglicht es z. B. , die Betriebsanleitung auftragsspezifisch zu publizieren. Das bedeutet, die Betriebsanleitung beschreibt exakt die Ausstattung, die der Kunde gekauft hat. Damit dies möglich ist müssen Module mit Eigenschaften (Metadaten) versehen sein. Die Auftragsdatei bestimmt beim Publizieren, welche Inhalte tatsächlich publiziert werden. Mit Hilfe der Eigenschaften kann man also eine Art Filter definieren.
Besonders hervorzuheben ist, dass diese Art von Filterung nicht nur nach dem Entweder-oder -Verfahren stattfindet, sondern beliebig ausgeweitet werden kann. Sie haben also die Möglichkeit mittels der Eigenschaften Module so zu bearbeiten, dass diese beim Publizieren berücksichtigt aber auch ausgeschlossen werden.

Um ein Modul im Redaktionssystem TIM-RS anzulegen gibt es mehrere Möglichkeiten.

1. Neues Modul erzeugen über eine Vorlage.
2. Bestehendes Modul kopieren.

Neuerstellung:

Bei der Neuerstellung eines Moduls über eine geeignete Vorlage, haben Sie quasi das Grundgerüst ohne Inhalt (struktureller Aufbau des Moduls) vorliegen, indem Sie Ihre Inhalte hinzufügen.

Kopieren:

Das Kopieren von Modulen hat darüber hinaus den Vorteil, dass Sie bestehende Inhalte bspw. Absätze (Paras), wiederverwenden können oder maschinenspezifische Anpassungen vornehmen können. Damit Sie Kopien erzeugen können, müssen Sie die sogenannte „TIM-ID“ des zu kopierenden Moduls kennen.

Die Erzeugung von Modulen funktioniert über den Objektmanager. Gehen Sie folgendermaßen vor, wenn Sie ein neues Modul anlegen möchten:

1. Öffnen Sie die Registerkarte „Module“ im Objektmanager.
2. Klicken Sie auf die rechte Maustaste.
3. Klicken Sie auf „Neu“. Es erscheint das Fenster „Vorlagenauswahl“
4. Wählen Sie eine Vorlage aus und klicken Sie auf übernehmen. Es erscheint ein Fenster zur Eingabe von Metadaten.
5. Vergeben Sie Metadaten (Titel, Bausteinart etc.). Das Modul wird nun im Editor geöffnet und kann bearbeitet werden.

Ein Chapter ist ein Modultyp, welches innerhalb der DCL benötigt wird, um eine Buchstruktur aufzubauen. Ein Chapter kann auch mehreren Paras oder Sections aufgebaut sein.

Eine Section ist ein Modultyp, welches zur Erfassung von mehreren „Paras“ benötigt wird. Man kann eine Section mit einem Topic vergleichen bzw. gleichsetzen. Innerhalb einer Section können mehrere Paras angelegt werden, wodurch auch mehrere Zwischenüberschriften möglich sind.

Ein Para ist ein Modultyp (XML-Element), welches zur Erfassung von Inhalten verwendet wird. Zum Beispiel für Fließtext, Handlungsanweisungen, Listen, Tabellen oder Grafiken. Die genannten Inhalte verfügen sind ebenfalls als XML-Element verfügbar und werden dem „Para“ hinzugefügt. Einen Para kann man als Block oder Absatz betrachten, der maximal eine Zwischenüberschrift ermöglicht.

Über eine DCL können mehrere Module als Buch zusammengefasst werden. Sie können DCLs (Bücher) folgendermaßen strukturell aufbauen:

• Chapter
  • Section (als Modul)
  • Section (als Modul)

Unterhalb des Knoten „Chapters“ können Sie mehrere Sections als Module anhängen. Die Sections als Module sind über den Objektmanager auffindbar und können per Drag and Drop in die DCL hinzugefügt werden.

• Chapter
  • Section (als Knoten)
    • Para (als Modul)
    • Para (als Modul)

Unterhalb des Knoten „Chapters“ kann die „Section“ ebenfalls als Knoten hinzugefügt. Hierbei handelt es sich um kein Modul, welches über den Objektmanager hinzugefügt werden kann. Solche „Knoten“ können Sie direkt in der DCL über einen Rechtsklick auf der Maus hinzufügen. Dem Knoten „Section“ können nun die Para als Module hinzugefügt werden. Auch die Para Module sind über den Objektmanager auffindbar und werden per Drag and Drop in die DCL geschoben.

Damit Sie ein bestehendes Modul kopieren können, müssen Sie die TIM-ID des zu kopierenden Moduls kennen. Gehen zum Kopieren eines bestehenden Moduls genauso vor, wie beim Anlegen eines neuen Moduls. Wählen Sie im Fenster „Vorlagenauswahl“ keine Vorlage aus, sondern tragen Sie die TIM-ID des zu kopierenden Moduls in dem Feld „TIM-ID“ ein. Anschließend klicken Sie auf „Übernehmen“ und tragen die Metadaten des neuen Moduls ein.

Damit Sie wissen, wo Module bereits eingesetzt werden, müssen Sie die „Details“ des jeweiligen Moduls öffnen. Dies ist über den Objektmanager möglich. Wenn Sie im Objektmanager ein Modul auswählen, bekommen Sie in einem separaten Fenster die „Details“ angezeigt. Innerhalb dieses Fensters müssen Sie auf „Referenzen“ klicken. Jetzt erhalten Sie Auskunft darüber, wo überall das ausgewählte Modul „verwendet wird“.

Im Redaktionssystem TIM-RS sind Module Redaktionsobjekte, die zur Erfassung von Dokumenten verwendet werden. Es gibt verschiedene Arten von Modulen, um einen modularen Aufbau der Betriebsanleitung zu ermöglichen.

Im Redaktionssystem TIM-RS gibt es mehrere Arten von Modulen, die als sogenannte „Bausteine“ angelegt werden. Die folgenden Bausteine werden zur Erstellung von Betriebsanleitungen am häufigsten genutzt:

• Block
• Map
• Innere Bausteine

Block:

Beim Block handelt es sich um eine Bausteinart, um sogenannte „Para“ zu erzeugen. Ein „Para“ ist mit einem Absatz zu vergleichen. Im Idealfall ist ein Para so aufgebaut, genau einen Zweck zu erfüllen. Der Zweck besteht darin, genau eine Anwenderfrage zu beantworten, die inhaltlich zu einem Thema gehört.

Map:

Bei einer Map handelt es sich um eine Bausteinart, um sogenannte „Section“ zu erzeugen. Eine „Section“ ist eine Informationseinheit, die ein Thema behandelt. Insofern sind innerhalb einer Section mehrere „Para“ möglich.

Innere Bausteine:

Bei inneren Bausteinen handelt es sich um eine Bausteinart, um XML-Elemente anzulegen, die zur Texterfassung geeignet sind. In der Regel sind innere Bausteine zur Texterfassung für die folgenden Punkte geeignet:

• Fließtext
• Einzelne Listenpunkte

Einzelne Tabellenzeilen

Im Redaktionssystem TIM-RS werden alle Redaktionsobjekte zunächst als Modul angelegt.

Gehen wir davon aus, dass wir ein Modul mit der Bausteinart „Map“ erzeugt haben, um eine Wartungsarbeit zu beschreiben. Der strukturelle Aufbau einer solchen Beschreibung sollte idealerweise immer gleich sein.

Hier ein Beispiel:

• Wartungsintervall
• Voraussetzungen
• Benötigte Ersatzteile
• Benötigte Werkzeuge
• Übersicht
• Vorgehensweise

Beim Editieren dieses Moduls, können Sie sogenannte „verschachtelte Module“ erzeugen oder einfügen. Gehen wir davon aus, dass es mehrere Wartungsarbeiten mit demselben Wartungsintervall gibt. In diesem Fall wäre es sinnvoll, diesen Absatz als „verschachteltes Modul“ abzuspeichern oder wenn schon vorhanden einzusetzen. Verschachtelte Module sind also „Module“, die zur Wiederverwendung gespeichert werden und in anderen Modulen verwendet werden können. Das Arbeiten mit verschachtelten Modulen bringt den Vorteil mit sich, dass inhaltliche Änderungen nur einmal ausgeführt werden müssen. Denn überall dort, wo ein verschachteltes Modul verwendet wird, wird die Änderung übernommen

Im Redaktionssystem TIM-RS können mehrere Redakteure zusammenarbeiten. Damit die Bearbeitung eines Moduls nicht zur selben Zeit von mehreren Benutzern möglich ist, gibt es eine sogenannte Objektsperre. Beim Öffnen eines Moduls wird dieses „ausgecheckt“ und kann von anderen Benutzern nur im „Lesemodus“ geöffnet werden. Wenn Sie das Modul schließen/verlassen fragt TIM-RS, ob Sie dieses Modul wieder „einchecken“ möchten, und somit die Objektsperre wieder aufheben.

Beim Erstellen von Betriebsanleitungen arbeiten in der Regel mehrere Fachabteilungen zusammen. Der Redakteur holt sich benötigte Informationen aus den Fachabteilungen und arbeitet diese normkonform und zielgruppengerecht ein. Für die Verwaltung des Redaktionssystems ist es wichtig, den Redaktionsobjekten einen „Status“ zu vergeben.

Die folgenden stehen dabei zur Auswahl:

• In Bearbeitung
• Zur Prüfung freigeben
• Korrekturen einarbeiten
• Freigeben

Bevor ein Redaktionsobjekt in TIM-RS freigegeben werden kann, muss ein Redaktionsobjekt zunächst den Status „Zur Prüfung freigegeben“ vorweisen. Damit wird gesichert, dass die Inhalte der Redaktionsobjekte von einer 2. Person gelesen und auf Richtigkeit geprüft werden. Erst nachdem der Redakteur die Rückmeldung erhalten hat, dass alles fachlich korrekt ist, kann das Redaktionsobjekt den Status „Freigegeben“ erhalten. Mit der Freigabe des Redaktionsobjektes, erhält der Redakteur auch die Information, dass dieses Modul in dieser Version nur 1:1 wiederverwendet werden darf. Sollten daran Änderungen vorgenommen werden gilt zu hinterfragen, ob diese auch für das „freigegebene Redaktionsobjekt“ gelten oder ob in diesem Fall ein neues Redaktionsobjekt erzeugt werden muss. Wenn die Änderungen auch für das „freigegebene Redaktionsobjekt“ gelten, kann man diesen in einen neuen Status einteilen – der Status „Korrekturen einarbeiten“.

Wenn im Redaktionssystem die DCL geöffnet ist kann man diese auf unaufgelöste Querverweise prüfen. Wählen Sie hierfür unter Ansicht „Querverweise prüfen“ aus. Die Module, die unaufgelöste Querverweise enthalten werden rot hervorgehoben. Diese unaufgelösten Querverweise müssen bearbeitet werden, andernfalls tauchen diese ohne Verlinkung in der Publikation auf. Klicken Sie auf mit der rechten Maustaste auf das rot hervorgehobene Modul und wählen Sie „Querverweise bearbeiten“ aus, um ein Querverweisziel zu setzen. Es öffnet sich ein neues Fenster, welches den Inhalt des Moduls als Vorschau anzeigt und den unaufgelösten Querverweis markiert. Ziehen Sie per Drag an Drop das Modul aus der geöffneten DCL, worauf verwiesen werden soll.      

Im Redaktionssystem TIM-RS werden externe Querverweise mit dem XML-Element „ExternalLink“ angelegt. Um einen externen Querverweis im Redaktionssystem TIM-RS anzulegen, muss an entsprechender Stelle in der Strukturansicht das XML-Element „ExternalLink“ angelegt werden.

Am XML-Element „ExternalLink“ ist das Attribut “fct:Format” definiert. An diesem Attribut muss das Querverweisformat ausgewählt werden.

Die folgenden Querverweisformate sind für „externe Querverweise“ möglich:

• “Num” = Absatznummer
• “Num_Text” = Absatznummer und -text (Default)
• “Page” = Seitenzahl

Wird nicht explizit ein Wert ausgewählt, wird das Querverweisformat “Num_Text” verwendet. Bei Bedarf kann dieser Wert nachträglich geändert werden. Damit Sie den externen Querverweis später zu ordnen können, sollten Sie ebenfalls das Attribut „fct-AltTitle“ ausfüllen, um zu wissen, auf welches Modul verwiesen werden soll.

Im Redaktionssystem TIM-RS werden interne Querverweise mit dem XML-Element „Link“ angelegt.  Als Querverweisziele können nur Überschriften verwendet werden. Um einen internen Querverweis im Redaktionssystem TIM-RS anzulegen, muss an entsprechender Stelle in der Strukturansicht das XML-Element „Link“ angelegt werden.

Am XML-Element „Link“ ist das Attribut “fct:Format” definiert. An diesem Attribut muss das Querverweisformat ausgewählt werden.

Die folgenden Querverweisformate sind für „interne Querverweise“ möglich:

• “Num” = Absatznummer
• “Num_Text” = Absatznummer und -text (Default)
• “Page” = Seitenzahl

Wird nicht explizit ein Wert ausgewählt, wird das Querverweisformat “Num_Text” verwendet. Bei Bedarf kann dieser Wert nachträglich geändert werden.

Im Redaktionssystem TIM-RS gibt es 2 Arten von Querverweisen. Interne und externe Querverweise.

Interner Querverweis:

Interne Querverweise sind Verweise, die innerhalb des Moduls verweisen. Ein interner Querverweis wird mit dem XML-Element „Link“ erzeugt.

Externer Querverweis:

Externe Querverweise sind Verweise, die auf ein Ziel in einem anderen Modul verweisen. Ein externer Querverweis wird mit dem XML-Element „ExternalLink“ erzeugt.

Damit ein Modul versioniert werden kann, muss das Modul zunächst freigegeben sein. Das bedeutet, dass der Inhalt des Moduls geprüft wurde. Die Version lässt sich im Redaktionssystem TIM-RS ganz einfach ausführen. Wählen Sie hierfür das Modul über den Objektmanager aus. Mit einem Rechtsklick können Sie dann eine „neue Version“ anlegen. Wenn Sie eine neue Version angelegt haben, wird der „freigegebene“ Zustand des Moduls gesichert und ist immer wieder abrufbar. 

Worauf Querverweise im Redaktionssystem TIM-RS verweisen, hängt davon ab, welches „Querverweisformat“ hinterlegt wurde. Das Querverweisformat ist im Attribut “fct:Format” definiert.

Die folgenden Querverweisformate stehen im Redaktionssystem TIM-RS zur Verfügung:

Num:

Im Querverweis wird die Nummerierung des Zielelements ausgegeben

NumText:

Im Querverweis wird die Nummerierung + Text des Zielelements ausgegeben.

Page:

Im Querverweis wird die Seitennummer des Zielelements ausgegeben. Wird nicht explizit ein Wert ausgewählt, wird das Querverweisformat “Num_Text” verwendet. Bei Bedarf kann dieser Wert nachträglich geändert werden.

Grafiken werden im Redaktionssystem TIM-RS auch über den Objektmanager angelegt und sind auch über den Objektmanager wiederzufinden. Grafiken erhalten wie auch Module eine sogenannte TIM-ID und weitere Metadaten. Um eine Grafik im Redaktionssystem TIM-RS anzulegen, wählen Sie im Objektmanager den Reiter „Grafiken“ aus. Hier können Sie über einen Rechtsklick eine Grafik importieren. Wenn Sie eine Grafik importiert haben, erscheint ein neues Fenster, indem Sie die Metadaten hinterlegen.

Um eine Grafik im Redaktionssystem TIM-RS in einem Modul einzusetzen, ist es sinnvoll, die TIM-ID oder den genauen Title der Grafik zu kennen. Mit dieser Information können Sie später bei der „Objektauswahl“ zielgerichtet die benötigte Grafik einfügen. Damit Sie eine Grafik im Modul einsetzen können, müssen Sie in der Strukturansicht an der jeweiligen Stelle, das XML-Element „Graphic“ oder „InlineGraphic“ hinzufügen. Wenn Sie das tun, öffnet sich die zuvor angesprochene „Objektauswahl“ in einem neuen Fenster. Wählen Sie hier die einzusetzende Grafik aus und klicken auf übernehmen. Es erscheint ein neues Fenster „Grafik einfügen“, indem Sie ein Grafikprofil auswählen können, andernfalls legen Sie die Größe des Rahmens fest, sowie die Ausrichtung in der die Grafik eingefügt werden soll. Klicken Sie abschließend auf OK.   

Das Redaktionssystem TIM-RS bietet viele Möglichkeiten an, wo Sie Grafiken einsetzen können. Sie können Grafiken beispielsweise in Fließtext als sogenannte „InlineGraphic“ erzeugen oder sogenannten GraphicContainer als „Graphic“. GraphicContainer eignen sich dafür, wenn Sie eine Grafiklegende benutzen möchten. Aber auch in Tabellen ist möglich Grafiken einzubinden. In diesem Fall werden in einzelnen Tabellenzellen (XML-Element „Entry“) die Grafik hinzugefügt.

Während der Bearbeitung haben Sie im Redaktionssystem TIM-RS die Grafiken über die Funktion „Ersetzen“ auszutauschen, ohne dabei unnötig Versionen zu erzeugen. Suchen Sie die Grafik im Objektmanager, die Sie ersetzen möchte. Mit einem Rechtsklick können „Ersetzen“ auswählen und eine neue Grafik importieren. In den Modulen, in denen die Grafik verwendet wird, wird diese automatisch aktualisiert.

Das Redaktionssystem TIM sollte eine umfangreiche Suchfunktion, Management der Varianten und verschiedene Sprachen enthalten. Dazu kommen z.B. automatische Übersetzungen von Inhalten, Autorenunterstützung und bedarfsgerechte Publikation über verschieden Kanäle aus einer Datenquelle. Diese Aufgaben erfüllt natürlich das Redaktionssystem TIM.

Ja, Sie können Grafiken im Redaktionssystem TIM-RS versionieren. Wie auch bei den Modulen, handelt es sich bei Grafiken ebenfalls um „Bausteine“, die mit Metadaten versehen sind und somit einen Status erhalten. Neue Versionen können nur für Grafiken erzeugt werden, die den Status „Freigegeben“ haben.

Ja, Publikationen können im Redaktionssystem TIM-RS gespeichert werden. Sinnvollerweise speichern Sie nur die Publikationen ab, die zusammen mit dem Produkt ausgeliefert werden. Über den Objektmanager haben Sie Zugriff auf alle gespeicherten Publikationen. Genauso, wie Sie nach Modulen suchen können, gibt es im Objektmanager den Reiter „Publikationen“ Zugriff auf Publikationen erhalten. Die in TIM-RS gespeicherten Publikationen können über den Editor geöffnet werden oder direkt aus dem Objektmanager exportiert werden

Um Kosten bei der Übersetzung zu sparen, ist es wichtig, übersetzungsgerecht zu schreiben. Das bedeutet Inhalte einheitlich zu erstellen. Hier kann eine smarte Autorenunterstützung ein hilfreiches Tool für den Technischen Redakteur sein. Achten Sie bei der Texterstellung auf bereits verwendete Formulierungen.

In Word gibt es die Möglichkeit, die Texte, die nicht übersetzt werden sollen, manuell auszublenden.
Diese Texte sind dann noch im Hintergrund vorhanden, aber nicht sichtbar. Die Analyse des Dokuments mit memoQ (das Übersetzungstool, mit dem wir arbeiten) erfasst nur die sichtbaren Texte und bereitet diese zur Übersetzung für den Übersetzer vor.
Nach Fertigstellen der Übersetzung werden alle Texte wieder eingeblendet und man erhält ein komplett übersetztes Dokument.