Technische Dokumentation
Inhalt in diesem Artikel
- Technische Dokumentation
- Was ist eine Technische Dokumentation?
- Wo liegt der Unterschied zwischen Externer und Interner Technischer Dokumentation?
- Welche Ziele verfolgen Hersteller mit der Technischen Dokumentation?
- Haftungsrisiko minimieren
- Funktionsweise erklären
- Customer Experience
- Welche formalen Anforderungen muss eine Technische Dokumentation erfüllen?
- Gesetzliche Anforderungen
- Produktsicherheitsgesetz (ProdSG)
- Gesetze und Richtlinien für bestimmte Produktgruppen
- Normative Anforderungen
- Usability
- Welche inhaltlichen Anforderungen gibt es in der Technischen Dokumentation?
- Maschinen und Anlagen
- Elektrogeräte
- Medizintechnik
- Software
- Welche Anforderungen sollte der Ersteller einer Technischen Dokumentation erfüllen?
- Welche Ausbildungsmöglichkeiten gibt es?
- Kompetenzen eines Technischen Redakteurs
- Wie erfolgt die Informationsbeschaffung?
- Was sind Konformitätserklärung und CE-Kennzeichnung?
- Konformitätserklärung
- CE-Kennzeichnung
- Was muss der Redakteur bei der Übersetzung beachten?
- Dateiformate und Struktur der Ausgangsdokumente
- Terminologie
- Formatierung innerhalb der Ausgangsdokumente
- Dateiverwaltung und ‑austausch
- Wozu dient eine Risikobeurteilung und welche Bedeutung hat sie für die Technische Dokumentation?
- Welche Vorteile bieten Illustrationen in der Technischen Dokumentation?
- Wozu dienen Sicherheits- und Warnhinweise und was gibt es hier zu beachten?
- Sicherheitshinweise
- Warnhinweise
- Wie sieht eine gute Informationsverwaltung aus?
- Welche Plattformen eignen sich für das Erstellen einer Technischen Dokumentation?
- Der Klassiker: Microsoft Word
- Der Ästhet: Adobe InDesign
- Der Profi: Adobe FrameMaker
- Die Alleskönner: Content Management Systeme (CMS)
- Welche neuen Technologien sind für die Technische Dokumentation relevant?
- Digitale Dokumentation
- Die Vorteile der digitalen Dokumentation auf einen Blick:
- Augmented und Virtual Reality
- Sie haben noch Fragen?
Was ist eine Technische Dokumentation?
Der Begriff Technische Dokumentation fasst alle Informationen und Dokumente zusammen, die ein Produkt (wie Gerät, Maschine, Anlage, Software) beschreiben und seine Verwendung und Funktionsweise erläutern. Die Technische Dokumentation wird als ein essenzieller Bestandteil des Produkts verstanden. Deshalb wird sie auch häufig als Produktdokumentation bezeichnet. Sie enthält sowohl die Anteile, die für den Kunden oder andere Dienstleister einsehbar sind (Externe Technische Dokumentation), als auch eine Vielzahl weiterer Bestandteile, die innerhalb des produzierenden Unternehmens verbleiben (Interne Technische Dokumentation).
Mit der externen Dokumentation gewährleisten Sie, dass Ihr Produkt bestimmungsgemäß und sicher verwendet wird. Die Inhalte setzen sich unter anderem aus den folgenden Teilbereichen zusammen: Betriebsanleitung, Bedienungsanleitung, Wartungsanleitung, Transportanleitung, Sicherheit, Montageanleitung, Konformitätserklärung, Demontage und Entsorgung.
In diesem Artikel erfahren Sie, was Sie zum Erstellen einer verständlichen Produktdokumentation wissen müssen und wie Sie mit Ihren Inhalten den größten Nutzen für Ihr Unternehmen und Ihre Kunden erzielen können.
Wo liegt der Unterschied zwischen Externer und Interner Technischer Dokumentation?
Die Interne Technische Dokumentation dient dazu, das Produkt über seinen Lebenszyklus hinweg zu dokumentieren. Der Hersteller kommt damit seinen Nachweispflichten gegenüber Organisationen und gesetzlichen Anforderungen nach. Sie bildet die Grundlage für die Externe Technischen Dokumentation und beinhaltet darüber hinaus Informationen zu einer Vielzahl verschiedener Themenbereiche. Die Interne Dokumentation bietet das Potenzial, Wissen und Know-how eines Unternehmens zu sammeln, zu verteilen und zu speichern. Sie ist also mehr als eine reine Pflichtübung.
Die Externe Technische Dokumentation (auch Anwenderdokumentation oder Nutzerinformation) ist ein Ausschnitt der Internen Dokumentation und richtet sich an den Anwender bzw. Endbenutzer, Reparaturdienstleister oder an Transportunternehmen. Sie enthält die Informationen, die für den Umgang mit dem Produkt relevant sind. Gesetze und Richtlinien definieren den Umfang der bereitzustellenden Informationen näher. Die externe Produktdokumentation soll in erster Linie gewährleisten, dass der Nutzer das Produkt gemäß seiner Bestimmungsgemäßen Verwendung benutzt. Alle Anwender wie Installateure, Reparaturdienstleister und Transportunternehmen können ihre Arbeiten mithilfe dieser Informationen sicher und mit dem gewünschten Ergebnis durchführen.
Welche Ziele verfolgen Hersteller mit der Technischen Dokumentation?
Haftungsrisiko minimieren
Verwendet ein Nutzer das Produkt falsch oder führt durch sein Handeln eine Fehlfunktion herbei, können Personen und Sachgüter zu Schaden kommen. Der Hersteller muss dieses Risiko durch entsprechende konstruktive Maßnahmen auf ein vertretbares Maß reduzieren. Oft lassen sich dadurch jedoch nicht alle Risiken beseitigen und es bleibt ein Restrisiko für den Nutzer bestehen. Die Externe Dokumentation muss dazu geeignet sein, etwaige Restrisiken für den Nutzer ersichtlich zu machen und ihm den sicheren Umgang mit dem Produkt zu erläutern. Die Betriebsanleitung zeigt dem Anwender beispielsweise über Sicherheits- und Warnhinweise Situationen auf, die eine Gefährdung darstellen. Weiter soll die Dokumentation Maßnahmen beschreiben, die dazu dienen, eine Gefährdungssituation sicher zu bewältigen. Die Informationen in der Betriebsanleitung sowie der interne Nachweis zu den Produkteigenschaften minimieren die Gefahr für den Hersteller, für Schäden an Personen oder Sachgütern haften zu müssen.
Funktionsweise erklären
Der wichtigste Aspekt für den Nutzer der externen Dokumentation besteht darin, alle Informationen zu erhalten, die er für das Verwenden eines Produkts benötigt. Insbesondere bei komplexen Produkten, deren Funktionsweise sich nicht auf den ersten Blick erschließt, ist es von entscheidender Bedeutung, dass die bereitgestellten Informationen umfassend und vollständig sind. Dadurch stellen Sie sicher, dass der Anwender zu jeder Zeit in der Lage ist, sicher und zweckbestimmt mit dem Gerät, der Software oder der Maschine/Anlage umzugehen.
Customer Experience
Die Nutzererfahrung ist bei der Kundenbindung an ein Produkt oder eine Marke von hohem Interesse für den Hersteller. Nach dem Kauf eines Produkts ist die externe Dokumentation häufig das erste Instrument, das der Nutzer heranziehen wird, um Unterstützung bei der Bedienung und Handhabung zu erhalten. Unklare Instruktionen und unvollständige Informationen zerstören das Vertrauen beim Kunden. Eine strukturierte und vollständige Produktdokumentation hingegen verschafft Sicherheit und spielt eine wichtige Rolle bei der Bewertung der eigenen Kaufentscheidung. Leiten Sie den Nutzer in der Betriebsanleitung zielführend an und achten darauf, dass Sie seine Bedürfnisse durch die Informationen erfüllen, schafft das die Basis für eine hohe Kundenzufriedenheit und somit den langfristigen Erfolg Ihres Unternehmens.
Welche formalen Anforderungen muss eine Technische Dokumentation erfüllen?
Gesetzliche Anforderungen
Für die Interne und Externe Dokumentation sind verschiedenste Richtlinien und Gesetze relevant, die Sie beim Erstellen und Bereitstellen der Informationen einhalten müssen.
Produktsicherheitsgesetz (ProdSG)
Das in Deutschland wichtigste Regelwerk für das Bereitstellen von Produkten ist das Produktsicherheitsgesetz. Als Umsetzung der Europäischen Richtlinie 2001/95/EG in nationales Recht dient das Produktsicherheitsgesetz dazu, die Anforderungen für das Inverkehrbringen und Bereitstellen von Geräten, Maschinen/Analgen und Software in Deutschland grundlegend zu definieren.
Gesetze und Richtlinien für bestimmte Produktgruppen
Die weiteren gesetzlichen Anforderungen richten sich maßgeblich danach, unter welcher Gruppe das Produkt einzuordnen ist und welche Merkmale es aufweist. Als typische Rechtsquellen sind hier beispielsweise das Medizinproduktegesetz (MPG), die Niederspannungsrichtlinie (2006/95/EG) und die Maschinenrichtlinie (2006/42/EG) zu nennen.
Normative Anforderungen
Normen dienen dazu, einheitliche Regeln und Empfehlungen für Abläufe und Prozesse zu definieren. Im Gegensatz zu gesetzlichen Anforderungen, sind diese in der Regel nicht bindend, können jedoch einen rechtlich bindenden Charakter erlangen, indem geltende Richtlinien und Gesetze dies vorschreiben.
Für das Erstellen von Gebrauchsanleitungen ist die Europäische Norm EN 82079–1 zu nennen, die wichtige Grundlagen zu Gliederung, Inhalt und Darstellung von Anleitungen liefert. Beim Erstellen von Dokumentationen müssen zum Teil viele Normen auf ihre Relevanz geprüft und umgesetzt werden.
Führen Sie hierzu vorab eine ausführliche Normenrecherche durch, um sich über den Umfang der notwendigen Informationen im Klaren zu sein.
Wir unterstützen Sie bei der Recherche einschlägiger Normen. Kontaktieren Sie uns.
Usability
Die Usability oder auch Gebrauchstauglichkeit ist in der DIN EN ISO 9241 als „(…) Eignung eines Produktes bei der Nutzung durch bestimmte Benutzer in einem bestimmten Benutzungskontext die vorgegebenen Ziele effektiv, effizient und zufriedenstellend zu erreichen.“ definiert. Die Nutzerinformationen nehmen in diesem Zusammenhang, insbesondere bei komplexeren und sicherheitstechnisch bedenklichen Produkten (zum Beispiel Lasergeräte), eine zentrale Rolle ein.
In der Technischen Dokumentation gewinnt die Usability seit einiger Zeit stark an Bedeutung, was nicht zuletzt durch die Neuerungen im Bereich der regulatorischen Anforderungen an Medizinprodukte in Form der EU‑Medizinprodukte-Verordnung zum Ausdruck kommt.
Die Usability Ihrer Nutzerinformationen sollte hinsichtlich Schreibstil, Terminologie, Zielgruppe und Form der Bereitstellung in einem mehrstufigen Prozess von erfahrenen Redakteuren geprüft und optimiert werden, um Schäden durch Bedienfehler auf ein Minimum zu reduzieren.
Welche inhaltlichen Anforderungen gibt es in der Technischen Dokumentation?
Die Technische Dokumentation besteht aus einer Vielzahl eigenständiger oder sich gegenseitig ergänzender Informationen, die in ihrer Gesamtheit das Produkt vollständig abbilden und beschreiben sollen.
Die Anforderungen an den Inhalt der Dokumentation sind abhängig davon, welche Gesetze, Richtlinien und Normen für die entsprechende Produktgruppe anzuwenden sind. Nachfolgend werden die zentralen Richtlinien für die jeweiligen Produktarten umrissen.
Maschinen und Anlagen
Für Maschinen und Anlagen, die unter den Anwendungsbereich der Maschinenrichtlinie (2006/42/EG) fallen, sind die allgemeinen Grundsätze und die Mindestanforderungen an den Inhalt der Betriebsanleitung dort definiert. Sie fordert beispielsweise eine klare Festlegung, in welcher Sprache die Originalbetriebsanleitung zu erstellen ist und was Sie bei der Definition der Bestimmungsgemäßen Verwendung beachten müssen.
Weiter listet die Maschinenrichtlinie detailliert auf, welche inhaltlichen Bestandteile in der Betriebsanleitung aufzuführen sind und wie diese zu ermitteln sind.
Elektrogeräte
Für viele Geräte und Betriebsmittel aus dem Bereich Elektronik ist die Niederspannungsrichtlinie (2014/35/EU) rechtlich bindend. Sie greift bei einem bestimmten Spannungsbereich (50 – 1000 V AC / 75 – 1500 V DC) und legt die grundlegenden Anforderungen an die Sicherheit von elektrisch betriebenen Geräten fest.
Medizintechnik
Die regulatorischen Anforderungen im Bereich der Medizintechnik unterliegen aktuell einem Übergang zwischen zwei Regelwerken. Maßgeblich ist bislang die seit 1993 bestehende Richtlinie 93/42/EWG über Medizinprodukte (Medical Device Directive – MDD), die durch die Verordnung (EU) 2017/745 (Medical Device Regulation – MDR) abgelöst wird. Hersteller von Medizinprodukten müssen bis zum endgültigen Geltungsbeginn der MDR (voraussichtlich 26. Mai 2021) ihre Technische Dokumentation auf die Anforderungen der MDR anheben, um ihre Produkte ab diesem Zeitpunkt in Verkehr bringen zu dürfen.
Beiden Regelwerken ist gemein, dass sie die Inhalte der Benutzerinformationen definieren, die MDR konkretisiert und ergänzt jedoch an vielen Stellen die Anforderungen, die es zu erfüllen gilt. Zusätzlich stellt die MDR weitere Anforderungen an formale Kriterien wie Medium, Format, Inhalt und Lesbarkeit sowie Anpassung der Informationen für die adressierte(n) Zielgruppe(n).
Software
Bei einer Produktdokumentation in dem Bereich Software ist eine Abgrenzung der einschlägigen Richtlinien im entscheidenden Maße davon abhängig, zu welchem Verwendungszweck sie zum Einsatz kommt. Aus rechtlicher Sicht ist Software ein eigenständiges Produkt und unterliegt dementsprechend der Produkthaftungs- und Produktsicherheitsrichtlinie.
Neben den allgemeinen datenschutzrechtlichen Vorgaben auf nationaler Ebene in Form des Bundesdatenschutzgesetzes (BDSG) kommen hier auch weitere Anforderungen in Frage, die sich auf das System, mit dem die Software interagiert, beziehen. Diese müssen dann gegebenenfalls auch bei der Technischen Dokumentation der Software berücksichtigt werden.
Welche Anforderungen sollte der Ersteller einer Technischen Dokumentation erfüllen?
Technische Redakteure sind in der Regel dafür zuständig, die Technische Dokumentation zu erstellen. Sie müssen in der Lage sein, komplexe Sachverhalte und Funktionsweisen einfach und in zielgruppengerechter Form zu erklären. Hierfür müssen sie alle benötigten Inhalte zusammentragen und für den Leser aufbereiten.
Welche Ausbildungsmöglichkeiten gibt es?
Der Weg zum Beruf als Technischer Redakteur kann auf unterschiedlichen Wegen erfolgen. In der Regel ist ein abgeschlossenes Hochschulstudium Voraussetzung.
- Hochschulstudium der Technischen Kommunikation oder fachverwandten Bereichen
- Quereinstieg mit einem abgeschlossenen Studium in einem technischen oder geisteswissenschaftlichen Bereich
- Weiterbildung in Vollzeit oder berufsbegleitend zum Beispiel über die tekom
Kompetenzen eines Technischen Redakteurs
Technischen Redakteure benötigen die folgenden Kernkompetenzen:
- Sehr gute Kenntnisse in der Erstellungssprache
- Ausgeprägte Kommunikationsfähigkeit
- Eigenverantwortliche und sehr sorgfältige Arbeitsweise
- Technisches Verständnis
- Organisationsfähigkeit
Wie erfolgt die Informationsbeschaffung?
Die Informationsbeschaffung und der Austausch von Informationen bilden die Grundlage für eine effiziente Zusammenarbeit zwischen Hersteller und dem Technischen Redakteur bzw. Dienstleister. Idealerweise definieren Sie den Prozess der Informationsbeschaffung bereits in einer frühen Phase der Projektplanung. Wichtige Fragen, die Sie hierbei klären sollten, sind zum Beispiel:
- Welche Informationen kann der Hersteller als Grundlage für das Erstellen der Technischen Dokumentation bereitstellen?
- Welche Ansprechpartner stehen auf Seiten des Herstellers und des Dienstleisters für den Informationsaustausch zur Verfügung?
- Über welche Kanäle findet der Datenaustausch statt?
- Welche Sicherheitsstandards müssen die Beteiligten beim Datenaustausch einhalten?
- Welche Fristen sind gegebenenfalls bei Anfragen einzuhalten?
- Wie können kurzfristige Änderungsanforderungen und Reviewprozesse optimal gestaltet werden?
- Wie kann der Dienstleister Vor-Ort-Besuche, beispielsweise zur Anfertigung von Produktfotos, so durchführen, dass er den laufenden Betrieb nicht oder nur in geringem Umfang stört?
- Welche Anforderungen bestehen beim Datenaustausch an Eingangs- und Ausgangsformate?
Was sind Konformitätserklärung und CE-Kennzeichnung?
Konformitätserklärung
Mit der EU- / EG-Konformitätserklärung (abhängig vom Veröffentlichungsdatum der einschlägigen Richtlinie) erklärt der Hersteller oder derjenige, der das Produkt in Verkehr bringt, dass es allen sicherheits- und gesundheitstechnischen Anforderungen entspricht.
Die Konformitätserklärung stellt eine Voraussetzung für die CE‑Kennzeichnung dar. Der Hersteller muss die Konformitätserklärung je nach anzuwendender Richtlinie zusammen mit dem Produkt bereitstellen oder zumindest zur Vorlage bereithalten. Er gibt darin alle verbindlichen Richtlinien und harmonisierten Normen an, denen das Produkt genügen muss und bestätigt deren Einhaltung in alleiniger Verantwortung.
Das Konformitätsbewertungsverfahren, in dem das Produkt auf die Einhaltung der einschlägigen Richtlinien und Normen geprüft wird, geht dem Erstellen einer gültigen Konformitätserklärung voraus. Der Hersteller führt die Konformitätsbewertung, je nach vorliegender Produktart, eigenverantwortlich durch oder schaltet eine zugelassene Benannte Stelle ein.
Für den Fall, dass mehrere Konformitätserklärungen auszustellen sind, kann der Aussteller die Angaben in Übereinstimmung mit dem New Legislative Framework (NLF) in einer Erklärung zusammenfassen.
Erfahren Sie mehr über Konformitätserklärung und CE-Kennzeichnung
CE-Kennzeichnung
Die CE-Kennzeichnung ist für viele Produkte zwingend notwendig, die auf dem europäischen Markt in Verkehr gebracht werden sollen. Mit der CE-Kennzeichnung erklärt der Hersteller des Produkts, dass es den einschlägigen europäischen Vorschriften genügt und die erforderliche Konformitätsbewertung erfolgt ist.
Die Kennzeichnung muss der Hersteller gut sichtbar und dauerhaft auf der Oberfläche des Produkts selbst oder, falls die Produkteigenschaften dies nicht zulassen, auf der Verpackung oder den Begleitinformationen anbringen.
Erfahren Sie mehr über Konformitätserklärung und CE-Kennzeichnung
Was muss der Redakteur bei der Übersetzung beachten?
Für multinationale Unternehmen spielt die Anfertigung von qualitativ hochwertigen fachgerechten Übersetzungen der Dokumente eine große Rolle. Die Übersetzungsarbeit beginnt allerdings nicht erst, wenn alle Inhalte in der Ausgangssprache erstellt worden sind, sondern in der Planungsphase des Projekts. Für eine Überführung der Inhalte in die Zielsprache müssen Sie schon im Vorfeld einiges beachten, um ein optimales Ergebnis zu erhalten.
Legen Sie besonderes Augenmerk auf:
Dateiformate und Struktur der Ausgangsdokumente
Programme zur computergestützten Übersetzung (CAT-Tools) können nahezu alle Dateiformate verarbeiten. Die jeweiligen Ausgangsformate bringen jedoch ihre individuellen Stärken und Schwächen mit in den Übersetzungsworkflow ein, die Sie berücksichtigen müssen.
Terminologie
Am Anfang der Inhaltserstellung sollten Sie die verwendete Terminologie (Fachausdrücke, Produktbezeichnung, Schreibstil) so klar wie möglich definieren, um ein hohes Maß an Konsistenz in der Dokumentation zu erreichen. Die festgelegte Terminologie können Sie dann beispielsweise in tabellarischer Form an den Übersetzungsdienstleister übergeben und damit für gleichbleibend hohe Qualität der Ergebnisse sorgen.
Formatierung innerhalb der Ausgangsdokumente
Leere Absätze, erzwungene Umbrüche und manuelle Formatierungen sorgen für Probleme bei der Verarbeitung der Daten durch ein CAT-Tool. Bereinigen Sie die zu übersetzenden Texte vor der Übergabe und gestalten Sie sie idealerweise mit eindeutigen Formatvorlagen.
Dateiverwaltung und ‑austausch
Insbesondere bei modular aufgebauten Technischen Dokumentationen bildet eine gut durchdachte Datei- und Ablagestruktur die Basis für einen reibungslosen und fehlerfreien Ablauf bei der Übersetzung von Dokumenten und deren Inhalten.
Sie möchten Ihre Technische Dokumentation übersetzen lassen und brauchen einen verlässlichen Partner? Kontaktieren Sie uns.
Wozu dient eine Risikobeurteilung und welche Bedeutung hat sie für die Technische Dokumentation?
Der Begriff der Risikobeurteilung wird nach der Norm EN ISO 12100 als „Gesamtheit des Verfahrens, das eine Risikoanalyse und Risikobewertung umfasst“ definiert. Die Risikobeurteilung selbst ist Bestandteil der Internen Dokumentation und muss im Normalfall nicht an den Kunden oder Anwender herausgegeben werden. Sie ist ein entscheidender Faktor bei der Frage, ob ein Produkt für eine Zulassung geeignet ist und bildet die Grundlage für die sicherheitsbezogenen Informationen, die der Hersteller in einer Externen Dokumentation an den Nutzer weitergeben muss.
Die Risikobeurteilung liefert anhand verschiedener Kriterien wie Eintrittswahrscheinlichkeit, Schwere der beim Eintreten zu erwartenden Schädigungen und Möglichkeiten zur Vermeidung der Gefährdung sicherheitsrelevante Informationen für den Hersteller und Nutzer.
Restrisiken, die der Hersteller weder konstruktiv noch durch zusätzliche Sicherheitseinrichtungen beseitigen kann, fließen in Form von Sicherheits- und Warnhinweisen in die Technische Dokumentation mit ein.
Welche Vorteile bieten Illustrationen in der Technischen Dokumentation?
Grafiken und Abbildungen können in der Technischen Dokumentation ein sehr mächtiges Mittel sein, um Informationen zu vermitteln. Auch unter Beachtung didaktischer Gesichtspunkte ist es sinnvoll, informative Inhalte auf unterschiedlichen Kanälen für Nutzer und Kunden bereitzustellen.
Illustrationen ergänzen Texte um ein sprachneutrales Mittel, das richtig platziert ein sehr hohes Potenzial beim Erstellen einer Technischen Dokumentation entfalten kann. Achten Sie beim Anfertigen von Illustrationen darauf, dass Sie den Fokus des Nutzers mit geeigneten Mitteln (zum Beispiel farblichen Hervorhebungen oder geschickt gewählten Ausschnitten) auf die wesentlichen Merkmale lenken. Trennen Sie die Texte innerhalb einer Illustration von den rein grafischen Elementen, um eine einfache Bearbeitung zu gewährleisten.
Wozu dienen Sicherheits- und Warnhinweise und was gibt es hier zu beachten?
Sicherheits- und Warnhinweise dienen dazu, den Nutzer vor einer potenziell gefährlichen Situation für Leib und Leben oder vor Schäden an Sachgegenständen zu warnen. Außerdem zeigen sie dem Anwender Möglichkeiten auf, wie er diese Gefährdungen sicher bewältigen kann. Auch wenn die beiden Begriffe oftmals synonym verwendet werden, besteht ein klarer Unterschied:
Sicherheitshinweise
dienen dazu, das Bewusstsein für eine Gefährdungssituation zu erzeugen oder zu stärken, und sind die Basis für Sicherheitsunterweisungen im Unternehmenskontext. Sie stehen häufig ohne Signalwort oder ‑farbe in einem gesonderten Kapitel und sind didaktisch aufgebaut und aufbereitet. Auch Beispiele und Erläuterungen zu Hintergrundwissen sind hier geeignete Mittel, um dem Nutzer den sicheren Umgang mit dem Produkt zu erklären.
Warnhinweise
sind hingegen dafür vorgesehen, vor einzelnen Gefährdungssituationen zu warnen und stehen im direkten Bezug zu den nachgelagerten Informationen. Die zu verwendenden Warnstufen (Signalwort und Signalfarbe) korrelieren mit der Risikobeurteilung. Ihr grundlegender Aufbau und die Art der Gestaltung sind in diversen Empfehlungen und Normen konkretisiert. Für den europäischen Raum zeigt hierzu die Norm EN 82079–1 Möglichkeiten auf, wie Warnhinweise in die Technische Dokumentation eingebunden werden können. Für Unternehmen, die auch außerhalb des Europäischen Wirtschaftsraums agieren, ist insbesondere die ANSI Z535 von hoher Relevanz.
Sie wollen auf Nummer sicher gehen? Kontaktieren Sie uns.
Wie sieht eine gute Informationsverwaltung aus?
Die Dokumentverwaltung stellt gerade bei komplexen Produkten (wie Maschinen, Anlagen und Software) mit unter Umständen einer Vielzahl verschiedener Varianten und Ausführungen eine Herausforderung dar. Der Erstellungsprozess einer Technischen Dokumentation muss so gestaltet sein, dass er diese Herausforderungen zu bewältigen vermag.
Vielfach organisieren insbesondere kleinere Unternehmen, deren Variantenreichtum an Produkten in keinem Fall den Schwergewichten auf dem Markt nachstehen muss, die Dokumentverwaltung noch ohne den Einsatz von Management-Systemen. Entscheidend hierbei ist eine eiserne Disziplin bei der Verwaltung von Produktdokumentationen sowie deren Varianten, Versionen und unterschiedlichen Arbeitsständen. Auch sollte die Kollaboration und der Kontakt innerhalb des Unternehmens darauf ausgelegt sein, bei mehreren Bearbeitern ein und desselben Dokuments Datenverluste oder Dateiüberschreibungen auszuschließen.
Aufgrund der steigenden Nachfrage nach individualisierten Produkten nimmt der Einsatz von Content Management Systemen seit langer Zeit stetig zu. Sie erleichtern bei fachgerechtem Einsatz und einer sorgfältigen Abwägung der erforderlichen Aufwände das Erstellen, Pflegen und Publizieren von Technischen Dokumentationen in die verschiedensten Zielformate.
Welche Plattformen eignen sich für das Erstellen einer Technischen Dokumentation?
Die Frage nach der besten Plattform für das Erstellen Technischer Dokumentationen ist sehr komplex und richtet sich maßgeblich nach den unternehmensinternen Anforderungen an Benutzerfreundlichkeit, Skalierbarkeit und Publikationskanäle.
Nachfolgend ein Überblick gängiger Plattformen:
Der Klassiker: Microsoft Word
Das Textverarbeitungsprogram des Office-Pakets stellt noch immer eines der am häufigsten verwendeten Tools zum Erstellen von Dokumenten aller Art dar.
Integrierte Designs und Vorlagen ermöglichen einen schnellen und effizienten Einsatz. Gerade für kleinere Redaktionen mit wenigen und nicht allzu variantenreichen Produkten ist Microsoft Word ein kostengünstiges Tool zum Erstellen von Technischen Dokumentationen.
Der Ästhet: Adobe InDesign
Der Desktop-Publisher von Adobe ist ein beliebtes Tool zum Erstellen optisch ansprechender Dokumente, das vor allem im Bereich von Marketingabteilungen und Werbeagenturen weit verbreitet ist.
Mit einem großen Umfang von Werkzeugen und Textbearbeitungsoptionen eignet es sich in erster Linie für Dokumente mit einem hohen Individualisierungsgrad und ermöglicht vor allem in Kombination mit weiteren Redaktionsprogrammen ein professionelles Erstellen von Magazinen, Broschüren und Flyern.
Der Profi: Adobe FrameMaker
Das Autorenwerkzeug von Adobe ist stark auf die Anforderungen von Technischen Redakteuren ausgerichtet und kann problemlos auch mehrere hundert oder tausend Seiten Dokumentinhalt handeln.
Mit eigenen Skripten und Plugins können Technische Redakteure nahezu jede Anforderung an den redaktionellen Prozess in Eigenregie umsetzen, um die Software weiter an die individuellen Bedürfnisse anzupassen und hochwertige Druckproduktionen zu erzeugen.
Die Alleskönner: Content Management Systeme (CMS)
Content Management Systeme dienen als Single‑Source Publishing Systeme dazu, eine nahezu unbegrenzte Anzahl einzelner Module automatisiert und nach eigenen Vorgaben zu einem Dokument zusammenzufügen. Sie bieten in der Regel On‑Board‑Funktionen zur Dateiverwaltung, Versionierung und gemeinsamer Dokumentbearbeitung.
Content Management Systeme können in die unterschiedlichsten Zielformate publizieren und sind prädestiniert für das Erstellen von hochprofessionellen Technischen Dokumentationen in mittelgroßen bis großen Unternehmen mit vielen Produktvarianten und Publikationskanälen.
Welche neuen Technologien sind für die Technische Dokumentation relevant?
Digitale Dokumentation
Das Bereitstellen der Produktdokumentation in digitaler Form durchbricht Grenzen, an die die klassische Papierform nach wie vor gebunden ist. Die Inhalte der Dokumentation sind auf digitalem Weg schneller und einfacher zugänglich und die Notwendigkeit, die zum Teil sehr umfangreichen Dokumente aufwendig nach den benötigten Informationen zu durchsuchen entfällt.
Die Vorteile der digitalen Dokumentation auf einen Blick:
- Hohe Verfügbarkeit über Smartphone, Tablet und PC
- Ggf. direktes Bereitstellen der Produktdokumentation über das Nutzer-Interface des Produkts (z. B. auf der Maschinensteuerung)
- Schnelles Auffinden der benötigten Informationen (durch Suchfunktion, Links, etc.)
- Einbinden interaktiver Inhalte (3D-Modelle, Hover-Effekte und Animationen)
- Agiles Änderungsmanagement
Augmented und Virtual Reality
Auch vor der Technischen Dokumentation macht der Fortschritt nicht halt. Während komplexe und immer benutzerfreundlicher werdende Content Management Systeme und Authoring Tools schon fast zum alten Eisen zählen, hat in den letzten Jahren das Thema der erweiterten (Augmented Reality) und virtuellen Realität (Virtual Reality) einen starken Einfluss auf die Branche genommen. Mit Hochdruck arbeiten Technische Redakteure in Zusammenarbeit mit Software-Entwicklern an der Umsetzung neuer Technologien für die immersive Vermittlung von Informationen.
Während sich die Technik immer weiter verbessert und die Anzeigegeräte leichter und leistungsstärker werden, sind schon jetzt diverse Einsatzszenarien entstanden, in denen diese Mittel gewinnbringend zum Einsatz kommen. Augmented und Virtual Reality stimmen Informationen gezielt auf den Anwender ab (zum Beispiel Maschinenbediener, Servicetechniker, etc.) und stellen sie direkt am Produkt bereit. In Form von Schulungen trägt die Technologie zu einer effizienten und lebensnahen Einweisung am Produkt bei. Die Entwicklungen werden hier in der nahen Zukunft voranschreiten und die Einsatzmöglichkeiten und den aktuell noch recht aufwändigen Erstellungsprozess immer weiter verbessern.
Mit dem Laden des Videos akzeptieren Sie die Datenschutzerklärung von YouTube.
Mehr erfahren
Sie haben noch Fragen?
Daniel Keil, Geschäftsführer
Unser Expertenteam steht Ihnen mit Rat und Tat zur Seite.
Telefon
E‑Mail