Technische Dokumentation besser mit dem Gesamtprozess verzahnen
Über den Nutzen einer Technischen Dokumentation und die Vorteile eines Redaktionssystems
Technische Dokumentation beschreibt jegliche Form der internen und externen Dokumentation über sämtliche Lebenszyklusphasen eines Produkts. Die in diesem Beitrag beschriebene Technische Dokumentation, im Sinne von produktbegleitender Dokumentation (externe Dokumentation), beinhaltet Informationen und Definitionen für den Nutzer eines Produktes, damit er dieses sicher und effizient verwenden, reparieren oder auch entsorgen kann. Dies kann zum Beispiel Bedienungs- und Betriebsanleitungen, Installations- und Softwarehandbücher oder eine Wartungsanleitung umfassen.
So die allgemeine Beschreibung, doch, was bedeutet das genau und wann wird eine solche externe Dokumentation notwendig?
Wer liest schon gerne Bedienungsanleitungen?
Im Idealfall ist ein Produkt intuitiv in Betrieb zu nehmen und zu bedienen, dem Nutzer erschließt sich bei bloßem Hinschauen, was zu tun ist. Er muss nicht lesen, nicht mühsam nach der richtigen Information suchen oder die Inhalte richtig interpretieren. Leider ist es meist aber nicht so einfach.
Sicher würden auch viele Hersteller auf die Erstellung und Pflege der entsprechenden Dokumente, von der Aufbaubeschreibung bis zur Wartungsanleitung, verzichten. Schließlich bedeutet dies in der Regel keinen unerheblichen Zeit- und Kostenaufwand. Das Problem: Ein unsachgemäßer Umgang mit einem Produkt kann viele unangenehme Konsequenzen haben, etwa indem das Produkt Schaden nimmt oder im schlimmsten Fall sogar der Nutzer.
Die Technische Dokumentation soll genau dies vermeiden. Sie soll helfen, Produkte und Geräte zu verstehen und alle nötigen Informationen zu erhalten, um diese nutzen zu können – und das ohne die Gefahr, etwas falsch zu machen oder sich gar zu verletzen. Laut der EU-Maschinenrichtlinie sind Technische Dokumentationen im Maschinen- und Anlagenbau sogar verpflichtend. Bringen Unternehmen Maschinen, die unter die Richtlinie fallen, ohne Betriebsanleitung auf den Markt, drohen Haftungsrisiken oder sogar der Verkaufsstopp. Meist wird eine Technische Dokumentation von Dienstleistern im Maschinen- und Anlagenbau zur Erklärung von Produkten verwendet, die nach der Produktion von Verkäufern, Systemintegratoren, Installateuren, Servicemitarbeitern usw. verwendet, verkauft oder eingebaut werden. Sie dient außerdem als Nachweis der Sorgfaltspflicht.
Wie unterstützen Redaktionssysteme bei der Technischen Dokumentation?
Redaktionssysteme helfen bei der Erstellung, Verwaltung, Änderung und Übersetzung von Technischen Dokumentationen. Sie bieten eine Reihe von Vorteilen: So erlauben sie beispielsweise das Anlegen von standardisierten, mehrsprachigen Sinneinheiten. Solche Textfragmente, Absätze oder auch ganze Kapitel können im System vorgehalten und für neue Dokumente erneut genutzt werden. Zudem kann ein Regelwerk aufgestellt und hinterlegt werden, dem alle Publikationen der Technischen Dokumentation folgen. Die Standardisierung ermöglicht die gleichwertige Auslieferung über alle gängigen Medienkanäle, vom Druckwerk bis zum Tablet. Diese Prozesse laufen heutzutage in der Regel mit einem hohen Automatisierungsgrad und softwaregestützt ab, was letztlich zu einer besseren Kosten-Nutzen-Relation führt. Für viele Unternehmen ist die Erstellung einer Technischen Dokumentation eine große Herausforderung, verbunden mit einem nicht unerheblichen Zeit- und Kostenaufwand. Durch Redaktionssysteme kann die Arbeit enorm vereinfacht werden. Der modulare Aufbau entsprechender Systeme sorgt für eine hohe Wiederverwendbarkeit von Informationseinheiten. Das wiederum bedeutet eine große Zeitersparnis für die Erstellung und Pflege der Technische Dokumentation sowohl bei Produktmodifikationen wie auch der Entwicklung von Nachfolgeprodukten.
Welche Vorteile bietet eine digitale Technische Dokumentation?
Die Vorteile einer digitalen Technischen Dokumentation liegen in der Aktualität, der Suchfunktion und der webbasierten Verfügbarkeit. Denn: Die Dokumente müssen nicht nur richtlinienkonform sein und Normen einhalten, sondern auch verständlich und gut strukturiert sein. Im Vergleich zur analogen Dokumentation müssen bei der digitalen Variante keine Handbücher mehr von vorne bis hinten durchgeblättert werden, wenn Produktspezifikationen, Konstruktionsanleitungen oder bestimmte Produktdarstellungen gesucht werden. Sie werden binnen Sekunden vom System gefunden – das kann Leben retten. Webbasiert kann sie sowohl online, als auch offline – etwa auf einem Tablet gespeichert – genutzt werden. Das ist dann besonders hilfreich, wenn Anwendern keine Internetverbindung zur Verfügung steht, zum Beispiel beim Kundentermin vor Ort oder bei Wartungsarbeiten an Orten mit geringer Netzabdeckung.
Wie funktioniert Technische Dokumentation in der Praxis?
Die Nutzungsszenarien von Technische Dokumentationen können stark variieren. Dabei rückt die Art, wie Inhalte "ausgeliefert" werden (Content Delivery) zunehmend in den Fokus. Auch Themen wie eine normgerechte Übersetzung und die dazugehörige Terminologiearbeit gewinnen in Zeiten der globalisierten Wirtschaft zunehmend an Bedeutung. Von der Rolle einer Technischen Dokumentation in Bezug auf die CE-Kennzeichnung eines Produktes einmal ganz zu schweigen.
Content Delivery
Im Zuge der fortschreitenden Digitalisierung des Informationsmanagements in vielen Unternehmen wächst branchen- und bereichsübergreifend die Bedeutung von Content Delivery. Ob Produktion, Vertrieb oder Vermarktung – Content gibt es in jedem Unternehmensbereich. Content Delivery heißt darauf aufbauend, dass Informationen anwendergerecht aufbereitet werden. Auf passenden Content Delivery Portalen werden Informationen:
- webbasiert für unterschiedliche Zielgruppen bereitgestellt
- kontextbezogen und zielgruppengerecht aufbereitet
- klassifiziert, um die Suche zu erleichtern
Wichtig ist folglich, dass die Informationen in den richtigen Kontext gesetzt werden. In der Technischen Dokumentation bedeutet das, dass die Informationen an der Stelle bereit stehen, an der jeder Nutzer sie auch erwartet und wo er sie individuell abrufen kann. Durch Funktionen wie Lesezeichen und Notizen kann sich der Anwender vorab die für ihn relevanten Stellen markieren und zu einem späteren Zeitpunkt auf eben diesen Content zurückgreifen.
Content Delivery Lösungen wie easybrowse helfen bei der Verwaltung und Verteilung elektronischer und mobiler Dokumentation. Die Online- und Offline-Lösung bietet Such- und Filtermöglichkeiten und kann zudem sowohl Daten verschlüsseln, als auch Fremdformate problemlos einbinden. Hier ist speziell die Kompatibilität zum neuen iiRDS-Standard hervorzuheben. Besonders beliebt ist dies bei elektronischen Handbüchern und Katalogsystemen mit Shop-Funktion sowie technischen Serviceportalen. Durch Content Delivery Lösungen können Inhalte dementsprechend nicht nur zielorientiert und strukturiert, sondern auch geräte- und standortunabhängig zur Verfügung gestellt werden.
Fachübersetzungen
CE-Zertifikation
Eine CE-Kennzeichnung ist die Voraussetzung für die Vermarktung eines Produktes im Europäischen Wirtschaftsraum. Ohne ein CE-Zertifikat darf ein Produkt nicht vertrieben und eine Anlage nicht betrieben werden. Richtlinienkonform erstellt werden müssen daher:
- Betriebsanleitungen
- Installationshandbücher
- Wartungsanleitungen
- usw.
Eine CE-konforme Risikobeurteilung ist ebenfalls Pflicht. Um sich nicht allein durch das "Paragraphen-Chaos" wühlen zu müssen, ist es von Vorteil, sich Hilfe von Spezialisten zu holen. Diese helfen bei einer richtlinienkonformen Erstellung und können des Weiteren vorgefertigte Inhalte und Prozesse im Redaktionssystem bereitstellen.
Sowohl für die richtlinienkonforme Erstellung der Betriebsanleitung als auch für die Umsetzung der Risikobeurteilung stellt gds vorgefertigte Inhalte und Prozesse im Redaktionssystem bereit. Das Tool CE - EXPERT liefert nicht nur vordefinierte Inhalte, sondern auch eine menügeführte Gefahrenbewertungen. Außerdem ermöglicht es als vorgefülltes System eine eigenständige und einfache Erzeugung richtlinien- und normenkonformer Betriebsanleitungen.
Fazit
Eine Technische Dokumentation hält alle nötigen Informationen zu einem Produkt fest und hilft dem Anwender, dieses zu verstehen, so dass er es ohne Risiko nutzen kann. Mit Hilfe von digitalen Redaktionssystemen kann die Erstellung wesentlich vereinfacht werden. Technische Redakteure sollten sich mit den Möglichkeiten professioneller Redaktionssysteme auseinandersetzen, die sie beim Dokumentieren, Gestalten und Formatieren unterstützen können.
Die gds GmbH bietet hierfür als Fullservice-Anbieter ein umfassendes Produktportfolio. Als einziger Anbieter auf dem deutschen Markt sind alle Anwendungen „hausgemacht“. Somit ist Ihre Technische Dokumentation bei gds in besten Händen. Unsere Experten stehen Ihnen bei der Optimierung Ihrer Technischen Dokumentation jederzeit zur Seite, egal an welchem Punkt des Produktlebenzyklus' Sie sich befinden.
Lesen Sie mehr über die Technische Dokumentation oder deren einfache Erstellung mit unseren Redaktionssystemen.
