Sie haben ein Produkt entwickelt und brauchen nun eine professionelle technische Dokumentation? Unsere technischen Redakteure können Ihnen dabei helfen, eine nutzerfreundliche Bedienungsanleitung zu erstellen, die sowohl den gesetzlichen als auch Ihren individuellen Anforderungen entspricht. Welche Schritte wir auf dem Weg zu Ihrer perfekten Bedienungsanleitung gehen, erfahren Sie in diesem Artikel.
Technische Dokumentation erstellen: Vorgehensweise im Detail
Nachfolgend die 5 wichtigsten Schritte bei der Erstellung einer technischen Dokumentation:
1. Die Zielgruppe bestimmen
Die Definition der Zielgruppe ist der erste und wichtigste Schritt bei der Erstellung einer passgenauen technischen Dokumentation. Die Bedienungsanleitung soll der Zielgruppe helfen, das Produkt richtig anzuwenden und Lösungsvorschläge bei Fehlermeldungen oder Funktionsfehlern zu erhalten. So muss, bevor überhaupt eine technische Dokumentation erstellt werden kann, festgelegt werden, wer die Produkte verwenden wird. Richtet sich das Produkt zum Beispiel vor allem an Fachmenschen und Branchenexperten, ist es also für ein Nischenpublikum bestimmt, müssen die Beschreibungen und Erklärungen in der Anleitung wesentlich detaillierter ausfallen, als wenn das Produkt von Laien angewandt wird.
Auch für Bedienungsanleitungen ist die Bestimmung der richtigen Zielgruppe entscheidend
2. Eine Stoffsammlung über das Produkt erstellen
Bevor wir eine technische Dokumentation erstellen, sammeln wir erst mal alle relevanten Informationen zum Produkt. Dazu gehören neben der Produktbedienung auch Möglichkeiten zur Fehlerbehebung. Darüber hinaus existieren gesetzliche Anforderungen an technische Dokumentationen für unterschiedliche Produkte, die ebenso in die Stoffsammlung aufgenommen werden.
Gerade von gesetzlicher Seite gibt es einiges zu beachten. Zum einen gibt es europaweit gültige Normen für den Entwurf sowie das Erstellen technischer Dokumentationen, die EN 82079-1, welche im Kontext der deutschen Gesetzgebung als DIN EN 82079-1 festgelegt ist. Zudem existieren spezifische Normen, die es für verschiedene Produktkategorien einzuhalten gilt. Diese Normen können sich von Land zu Land unterschieden. Durch eine professionelle Stoffsammlung kann festgehalten werden, welche Normen die technische Dokumentation befolgen muss. Werden die gesetzlichen Anforderungen an die technische Dokumentation nicht beachtet, können im schlimmsten Fall kostenintensive Gerichtsprozesse mit hohen Strafen und Entschädigungszahlungen folgen. Allein deswegen lohnt es sich für Sie und Ihr Unternehmen, eine technische Dokumentation von einer professionellen Redaktion erstellen zu lassen.
3. Storyboard und Gliederung der Stoffsammlung
Nachdem alle wichtigen Daten und Informationen zum Produkt in einer Stoffsammlung zusammengestellt wurden, erfolgt ein erster inhaltlicher Entwurf. Hierbei wird nicht sofort eine fertige Bedienungsanleitung verfasst, sondern vielmehr die Stoffsammlung gegliedert und ein Storyboard entworfen.
Ein Storyboard bietet einen guten ersten Überblick
Das Storyboard wie auch die erste Gliederung dienen dabei nicht nur der Übersicht beim eigentlichen Erstellungsprozess. Sie geben auch eine erste Überprüfungsmöglichkeit, ob alle wesentlichen Aspekte der technischen Dokumentation beachtet wurden. Stellen sich Lücken im Storyboard dar, ist klar, dass zusätzliche Produktinformationen recherchiert werden müssen.
4. Ausarbeitung und Komprimierung
Mithilfe der Gliederung, des Storyboards sowie der Informationssammlung geht es an die eigentliche textliche und grafische Ausarbeitung der technischen Dokumentation. Im ersten Schritt wird eine Rohfassung erstellt, die dann auf das Nötigste komprimiert wird. In Bedienungsanleitungen versuchen wir üblicherweise, mit möglichst wenig Text zu arbeiten. Alle Produktaspekte der Montage, Installation, Bedienung oder Funktionalität müssen klar und deutlich kommuniziert werden, ohne viel Fachchinesisch und umständliche Beschreibungen. Zur leichteren Verständlichkeit werden technische Illustrationen verwendet, damit der Nutzer des Produkts alle Informationen sowie Problemlösungen zum Produkt übersichtlich präsentiert bekommt. Wenn es möglich ist, sollte eine Bedienungsanleitung komplett ohne Fließtext auskommen und die Arbeitsabläufe und Anwendungsschritte nur mittels bildlicher Elemente erklären.
Im Idealfall kommt eine Bedienungsanleitung komplett ohne Text aus: Das macht sie universell verständlich
Die Illustrationen und Zeichnungen werden für jede technische Dokumentation einzeln entworfen, damit diese auch den individuellen Gegebenheiten des Produkts entsprechen. Diese grafischen Elemente sollten selbsterklärend sein, sodass keine langen Beschreibungen mehr nötig sind. Alle einzelnen Schritte sollen über die technischen Illustrationen leicht nachvollziehbar sein, so wie Sie dies vielleicht aus Möbelaufbauanleitungen kennen. Unsere Redakteure und Illustratoren sind darauf spezialisiert und besitzen das Know-how in technischer Kommunikation, sodass sie genau wissen, worauf es bei den technischen Zeichnungen ankommt und an welcher Stelle textliche Elemente für die technische Dokumentation nötig sind. Zudem beachten wir bei der grafischen und textlichen Ausarbeitung die Corporate Identity Ihres Unternehmens. Dazu entwickeln wir Templates und Stylesheets, damit die technische Dokumentation auch optisch dem Bild Ihres Unternehmens entspricht.
5. Übersetzung und Lokalisierung
Ist die Bedienungsanleitung erstellt und von Ihnen abgenommen, kümmern wir uns auch um die gegebenenfalls notwendige Anpassung für den internationalen Markt. Denn für jedes Land, in dem Ihr Produkt angeboten wird, muss eine Fassung der technischen Dokumentation in Landessprache existieren.
Produkte werden heute meist weltweit verkauft: Entsprechend müssen Bedienungsanleitungen auch lokalisiert werden
Dabei müssen zum einen alle textlichen Erklärungen sowie länderspezifisch geforderte Hinweise übersetzt und integriert werden. Zum anderen muss aber auch das Produkt selbst entsprechend der landestypischen Gegebenheiten lokalisiert werden. Wollen Sie Ihr elektrisches Gerät auch außerhalb der EU zum Verkauf anbieten, muss Ihr Produkt an die unterschiedlichen Spannungen der öffentlichen Stromnetze des jeweiligen Landes angepasst werden. Auch die Art des Stromsteckers muss beispielsweise angepasst werden, denn europäisch genormte Stecker passen nicht in japanische Steckdosen.
Hier hilft es wieder enorm, wenn Ihre technische Dokumentation von Anfang an möglichst sprachneutral erstellt wurde. Denn technische Illustrationen sind, im Gegensatz zu Texten, universell verständlich. So sparen Sie sich Zeit und Kosten für Übersetzungen und haben eine nutzerfreundliche Bedienungsanleitung, die Kunden weltweit zufriedenstellen.
