Technische Dokumentationen erstellen

Technische DokumentationDank technischer Dokumentationen können Kunden die Funktionen und die Anwendung neuer Produkte und Geräte einfach nachvollziehen. Was alles in eine technische Dokumentation gehört und wie Sie sie am besten erstellen, erfahren Sie in diesem Artikel.

Für fast jedes Produkt gibt es sie, und doch fragen sich die meisten Menschen nicht, wieso und wie sie eigentlich erstellt wird – die technische Dokumentation. Sie werden diesen Begriff in der Regel als Betriebsanleitung oder Betriebshandbuch kennen. Doch dahinter steckt viel mehr. Als technische Dokumentation wird jegliches Material verstanden, welches ein Produkt dokumentiert. Dabei muss es sich nicht zwangsweise um ein technisches Produkt handeln, auch wenn der Name dies vermuten lässt. Das vorrangige Ziel ist es dabei, dem Monteur oder Kunden das entsprechende Know-how an die Hand zu geben, damit das Produkt erfolgreich installiert, eingebaut oder verwendet werden kann.

Neben den Funktionen und dem Erlernen der Bedienbarkeit müssen aber auch weitere Punkte kommuniziert werden. Zum Beispiel befinden sich Tipps für die Instandhaltung oder die Behebung möglicher auftretender Fehler in einer technischen Dokumentation. Mit solch einer Dokumentation wird dem Anwender geholfen, sich selbstständig mit dem Produkt auseinandersetzen zu können. Die Kommunikation zur Behebung möglicher Fehler umfasst ggf. eine Servicerufnummer für den Notfall. Denn nicht immer können die Anwender auftretende Probleme selbst beheben.

Anwendungsgebiete

Die folgende Liste zeigt die möglichen Anwendungsgebiete für die verschiedenen Zwecke einer technischen Dokumentation auf:

1. Bedienungsanleitung
2. Betriebsanleitung
3. Montageanleitung
4. Installationshandbuch
5. Softwarehandbuch
6. Reparaturanleitung
7. Serviceanleitung
8. Datenblatt
9. Tutorial
10. Onlinehilfe

Die Form der technischen Dokumentation kann dabei unterschiedlich sein. Im Zuge der Digitalisierung und unter Berücksichtigung des Umweltschutzes wird jüngst vermehrt dazu übergegangen, technische Dokumentationen dem Produkt lediglich als Kurzfassung beizulegen. Eine ausführliche Variante kann dann auf einer mitgelieferten CD abgerufen werden. Auch die Nutzung einer Onlinehilfe, die während der Verwendung einer Software aufgerufen werden kann, wird immer beliebter.

Bedienungsanleitungen, die eine Form der externen technischen Dokumentation sind, geben dem Anwender alle Informationen, die er zur Einrichtung, Installation, Aufbau, Wartung, Benutzung und Pflege eines Produkts benötigt. Dabei ist es für den Produkthersteller wichtig, dem Kunden im Rahmen der technischen Dokumentation auch Warnhinweise und mögliche Fehlerquellen bei der Benutzung des Produkts zu kommunizieren.

Mehr Informationen speziell zu nutzerfreundlichen Bedienungsanleitungen, haben wir in diesem Blogartikel zusammengefasst.

Warnhinweise sind wichtig, um Fehler bei der Bedienung eines Produkts zu verhindern

In erster Linie soll damit verhindert werden, dass Kunden sich bei der Anwendung des Produkts verletzen. Gleichzeitig sichern sich Unternehmen durch das Aufführen von Warn- und Benutzungshinweisen aber auch rechtlich vor Schadenersatzforderungen ab.

Nutzerfreundliche Bedienungsanleitungen

Sie kennen sicherlich auch Menschen, die den Blick in die Betriebsanleitung für überflüssig halten, da sich die Funktionalität eines Produkts mit der Zeit schon von ganz allein erschließe. Doch nicht immer geht Probieren über Studieren. Eine technische Dokumentation spart dem Anwender in der Regel viel Zeit und Frustration.

Illustrieren statt beschreiben

Während technische Dokumentationen in der Vergangenheit eher durch viel Text gekennzeichnet waren, sind es heute vermehrt technische Illustrationen, mit denen die Inhalte der Anleitung veranschaulicht werden. Die Verwendung von Bildern wirkt weniger abschreckend auf die Anwender als Textwüsten. Und gerade Laien werden so mit den in Anleitungen häufig verwendeten Fachbegriffen nicht überfordert.

Zudem werden technische Illustrationen weltweit verstanden und können in jedem beliebigen Land wiederverwendet werden. Und auch die Zeichnungen an sich lassen sich bei verschiedenen Produkten des gleichen Unternehmens mehrfach einsetzen. Dadurch entsteht eine Einheitlichkeit in den technischen Dokumentationen, und der Anwender kann vom Wiedererkennungswert profitieren. Darüber hinaus erspart es dem Hersteller viel Zeit, nicht für jedes Produkt komplett neue Zeichnungen erstellen zu müssen. Arbeitsabläufe bei der Erstellung einer technischen Dokumentation können somit verkürzt werden.

Universell verständlich

Eine technische Dokumentation sollte möglichst so gestaltet werden, dass auch ein Laie in der Lage ist, den vollen Funktionsumfang eines ihm unbekannten Produkts zu verstehen. Deshalb ist es besser, möglichst wenig Details auf den technischen Illustrationen abzubilden und nur die jeweils relevanten Elemente deutlich darzustellen.

Mit technischen Illustrationen lassen sich auch komplizierte Sachverhalte klar und deutlich darstellen

Damit wird die Kundenzufriedenheit gefördert, denn der Anwender gewinnt schneller einen Eindruck von der Funktion des Produkts. Frustration und negative Assoziationen mit dem Produkt, der Marke und dem Hersteller werden so vermieden. Die leichte Anwendbarkeit und Verständlichkeit können im Wettbewerb mit anderen Konkurrenten ausschlaggebende Punkte für eine Kaufentscheidung sein.

Gesetzliche Anforderungen

Selbst wenn es für Kunden manchmal nicht den Anschein hat, aber auch bei einer technischen Dokumentation sind technische Redakteure an bestimmte Vorschriften gebunden. Dies dient vor allem der Einheitlichkeit und dem damit verbundenen Umstand, dass jeder Mensch in der Lage sein muss, den jeweiligen Inhalt zu verstehen. Hierfür relevante Vorschriften sind in der Richtlinie VDI 4500 festgehalten. Wichtig ist dabei, dass in einer technischen Dokumentation der gesamte Produktlebenszyklus dokumentiert werden muss. Kommt ein Kunde durch eine Produktfehlfunktion zu Schaden und in der Dokumentation wurde nicht ausdrücklich vor solchen möglichen Fehlern gewarnt, kann der Geschädigte das Unternehmen dafür belangen.

Die Richtlinie VDI 4500 besteht aus sechs Teilen, wobei der erste Teil relevante Begriffsdefinitionen und Erläuterungen enthält, die beim Erstellen technischer Dokumentationen wichtig sind. Weiterhin setzt sich die Richtlinie mit der Organisation für die Erstellung einer Dokumentation und Aspekten wie der Formatierung auseinander. Die Normen und Richtlinien sind in erster Linie für technische Redakteure relevant, welche die Dokumentation erstellen. Aber auch Geschäftsführer und Verkäufer sollten sich zumindest grob mit dem Inhalt der Richtlinie auskennen. Die hohen Anforderungen an eine technische Dokumentation sind wichtig, da Ungenauigkeiten in den Formulierungen und Hinweisen rechtliche Konsequenzen haben können.

Fazit

Technische Dokumentationen ermöglichen es Anwendern, ein Produkt, dessen Benutzung und mögliche Funktionalitäten ohne Vorkenntnisse zu verstehen und umzusetzen. Das ausschlaggebende Kriterium für den Nutzen einer technischen Dokumentation ist deren Verständlichkeit. Dies bedeutet in diesem Zusammenhang auch, wie viel Text der Anwender aufnehmen und abspeichern muss, um das Produkt ordnungsgemäß zu benutzen. Verständlichkeit ist auch dann nicht mehr gegeben, wenn Anwender sich durch Hunderte Seiten technischer Dokumentation lesen müssen, um Antworten auf relativ simple Fragen zu erhalten. Der Trend bei der Erstellung technischer Dokumentationen geht daher dahin, vermehrt auf technische Illustrationen, Bilder und Grafiken zu setzen.

BIlder sagen oft mehr als 1.000 Worte

Durch die universelle Verständlichkeit von Bildmotiven können Informationen in den Produktanleitungen wesentlich leichter aufgenommen werden. Die Kundenzufriedenheit steigt, Fehler bei Bedienung, Aufbau und Installation nehmen ab.