Häufige Fragen

Sie haben Fragen zu Themen der Technischen Dokumentation und Redaktionssystemen? Wir haben für Sie die wichtigsten Fragen und Antworten zu beiden Themenbereichen zusammengestellt.

Anwenderdokumentation

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?

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?

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.

Betriebsanleitung erstellen

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.

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.

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.

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

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.

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.

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.

CE-Kennzeichnung

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.

Content Delivery Portal

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.

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.

DIN EN IEC/IEEE 82079

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.

DIN EN ISO 20607

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 Norm beschäftigt sich primär mit Betriebsanleitungen für eine fachlich höher qualifizierte Zielgruppe, weniger für Verbraucher.

Da es bereits die DIN EN ISO  82079-1 und nun auch deutlich verbessert die IEC/IEEE 82079-1 Second Edition gibt, stellt sich die Frage, wozu die DIN EN ISO 20607 dient?

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.

Gesetze, Normen und 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.

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.

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.

Lieferantendokumentation

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

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.

Maschinenverordnung (EU) 2023/1230

  • 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.

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.

Redaktionsleitfaden

  • 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.

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.

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.

Redaktionssysteme

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.

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.

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

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.

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.

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.

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.

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.

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.

Risikobeurteilung

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?“

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Smart Media Creator Redaktionssystem

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.

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.

Technische Dokumentation

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.

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!

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.

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.

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.

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.

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.

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.

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.

Übersetzungen und Terminologie

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.