FAQs

Technische Dokumentation

Vor allem die Kapitel „Wartung“ und „Instandsetzung“ sind oftmals mit Verweisen auf die Herstellerdokumentation versehen. Das muss auch so sein, denn der Hersteller 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 ist das richtig. Dennoch muss geprüft werden, 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.

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

Beim Übersetzen gibt es verschiedene Stellschrauben, an denen gedreht werden kann:

  • Vereinheitlichter, standardisierter Text
  • Modularisierte Texte
  • Einheitliche Terminologie
  • Auswahl des richtigen Übersetzungspartners

Wenn die Texte standardisiert sind und eine einheitliche Terminologie genutzt werden, ist die optimale Voraussetzung geschaffen, um über den Einsatz der richtigen Tools die Übersetzungskosten zu reduzieren.

  • Translation Memory Tools (TM), damit einmal übersetzte Texte automatisch und ohne Kosten wiederverwendet werden.
  • MT (Machine Translation), angekoppelt an das TM, um die Übersetzer zu entlasten und den gesamten Prozess deutlich zu beschleunigen.

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/

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/

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/

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.

Übersetzungen und Terminologie

MT steht für Machine Translation (Maschinelle Übersetzung) also Computergestützte Übersetzung. Viele Jahre galt, das die Qualität von MT nur für interne Zwecke zu gebrauchen ist. Hier hat sich aber in den letzten Jahren durch den Einsatz neuronaler Netze viel getan. MT ist noch weit davon entfernt, perfekt zu sein. Für bestimmte Textsorten kann MT aber als Teil eines Prozesses mit Übersetzern sinnvoll und sehr kostensparend genutzt werden. Gut strukturierte Technische Dokumentation mit klarer Terminologie Vorgabe kann ein solcher Fall sein, siehe https://arakanga.de/arawiki/strukturierungsmethoden/

Sie wollen die Verständlichkeit Ihrer Dokumente in den notwendigen Sprachen erhöhen? Auch innerhalb ihres Unternehmens? Damit alle genau wissen von was Sie sprechen?

Das leistet eine konsistente, spezifische, festgelegte Terminologie. Wir können Sie dabei folgendermaßen unterstützen:

  • Argumente für die interne Überzeugungsarbeit liefern
  • den Prozess definieren und Sie bei der internen Umsetzung unterstützen
  • die passenden Tools einrichten und zur Verfügung stellen
  • im Rahmen von Übersetzungsprojekten Terminologiepflege übernehmen

Redaktionssysteme

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.

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/

Risikobeurteilung

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.

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.

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.

Redaktionsleitfaden

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.

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.