Betriebsanleitung erstellen: Der neue Praxis-Guide ist da!
Sebastian Schiller, Software-Trainer bei Quanos, teilt im neuen Praxis-Guide von Quanos seine Expertise rund ums Erstellen von nutzerfreundlichen Betriebsanleitungen. Im Interview gibt er erste Tipps, wie das gelingt, und verrät, was Leser vom downloadbaren Praxis-Guide erwarten dürfen.
Was macht für dich eine nutzerfreundliche Betriebsanleitung aus?
Sebastian Schiller: Im Wesentlichen sind das Einheitlichkeit und Struktur. Beides führt dazu, dass eine Betriebsanleitung verständlicher wird und Leser Informationen leichter finden. Das Hauptproblem bei Technischer Doku ist meiner Meinung nach, dass Nutzern das oft nicht schnell genug gelingt. Ihre Frustrationsgrenze ist, wenn sie ein Problem mit einem Produkt haben, meistens recht gering.
Wie lässt sich denn eine Betriebsanleitung erstellen, die einheitlich und strukturiert ist?
Auf Dokumentenebene sollte der Leser direkt wissen, was er eigentlich in den Händen hält. Ist es eine Betriebs-, Bedienungs- oder Installationsanleitung? Auf Kapitelebene braucht es eine Struktur, die den Produktlebenszyklus nachbildet. Das heißt: Der Leser sollte erkennen, dass er unter „Bedienung“ nachschaut, wenn er die Maschine startet und auf dem Bildschirm Optionen erscheinen, die er nicht versteht. Oder unter „Troubleshooting“, wenn die Maschine nicht funktioniert. Innerhalb eines Kapitels sind bestimmte Sequenzmuster hilfreich, sodass Leser Handlungen, die sie tätigen müssen, sofort von Beschreibungen unterscheiden können. Bei den Sätzen ist es ratsam, auf Passivkonstruktionen und Nebensätze möglichst zu verzichten. Und auf Wortebene geht es schließlich um eine einheitliche Terminologie, das heißt, dass ich als Technischer Redakteur definierte Begriffe verwende.
Eine Reihe von Normen geben vor, wie eine Betriebsanleitung gestaltet sein sollte. Schränken solche Regelwerke ein oder sind sie ein nützliches Hilfsmittel für eine Technische Redaktion?
Ich sehe sie als Richtschnur. Das Knifflige ist: Bei vielen Alltagsfragen der Technischen Doku sind die Normen nicht konkret genug. Sie bieten Interpretationsspielraum. Gerade zu den grundsätzlichen philosophischen Fragen der Technischen Doku sagen die Normen nichts aus. Also zum Beispiel: Spreche ich jemanden direkt mit „Sie“ an oder nicht? Oder aber auch: Wie soll ich Handlungsabfolgen grundsätzlich strukturieren? Es gibt zwar Leitfäden zu den Normen, die Empfehlungen abgeben, aber es ist dennoch notwendig, einige Dinge selbst zu definieren. Dafür bietet sich dann ein unternehmensinterner Redaktionsleitfaden an.
Warum ist es wichtig, eine Betriebsanleitung zu erstellen, die den Normen entspricht?
Das sagen die Normen und Richtlinien selbst: Wenn die Betriebsanleitung fehlerhaft ist, ist das Produkt fehlerhaft, da das Dokument Teil des Produktes ist. Zum einen kann das zur Folge haben, dass der Kunde das zum Anlass nimmt, um Nachbesserung und schließlich Wandlung zu verlangen, also eine Rückgabe des Produkts. Zum anderen ist die Betriebsanleitung ein greifbares Ziel, wenn es zu einem Unfall kommt. Nach dem Motto: Der Geschädigte hat sich einen elektrischen Schlag zugezogen. Wird in der Betriebsanleitung ausreichend davor gewarnt? Eine fehlerhafte Betriebsanleitung bietet eine Angriffsfläche. Daher ist es so wichtig, dass man auf die Einhaltung der Normen achtet.
Welchen Fehlern begegnest du häufig in Betriebsanleitungen?
Was ich häufiger sehe, sind unterschiedliche Nutzeransprachen, uneinheitliche Strukturen – also dass Handlungsschritte mal so, mal so aussehen – und nicht normenkonforme Warnhinweise. Der Fehler dahinter ist eigentlich immer derselbe: Es hat sich niemand zu irgendeinem Zeitpunkt Gedanken darüber gemacht, wie man eine Betriebsanleitung einheitlich gestaltet. Es wurde einfach losgelegt. Dabei würde ich wirklich dazu raten, die Normen zu beachten und auch intern Regeln festzulegen. Dann fällt das Schreiben umso leichter.
Wie stark unterstützt ein Redaktionssystem wie SCHEMA ST4 beim Erstellen einer nutzerfreundlichen Betriebsanleitung?
Es hält Technischen Redakteuren viele leichte Tätigkeiten vom Leib, sodass sie sich aufs Wesentliche fokussieren können. Copy-Paste und Ähnliches fällt weg. Dafür können sie sich auf die Inhaltsgenerierung konzentrieren. Es unterstützt dabei, eine einheitliche Inhaltsstruktur zu erstellen, die Terminologie festzulegen und anzuwenden. Inhalte lassen sich wiederverwenden und wenn sich etwas ändert, muss ich es nur an einer Stelle anpassen. Gerade ab dem Zeitpunkt, ab dem ich zig Produktvarianten habe oder die Technische Dokumentation in verschiedenen Sprachen anbieten muss, hilft ein Redaktionssystem enorm weiter.
Lass uns über den neuen Praxis-Guide „Wie Sie eine nutzerfreundliche Betriebsanleitung erstellen“ sprechen. Was bietet er aus deiner Sicht?
Es ist ein idealer Einstieg in die Thematik, gerade für diejenigen, die nach dem Studium neu in den Beruf kommen, oder auch für Quereinsteiger. Wir zeigen die wichtigsten Normen auf und gehen auf die Inhalte, die eine Betriebsanleitung enthalten muss, ein. Der Praxis-Guide enthält viele nützliche Hinweise zu einer verständlichen Sprache in der Technik und zur visuellen Gestaltung. Er ist auch sehr praktisch ausgerichtet. Bevor ich bei Quanos als Trainer angefangen habe, war ich selbst viele Jahre in der Technischen Doku tätig. Daher weiß ich, wo manchmal der Schuh drückt und es war mir wichtig, viele leicht umsetzbare Tipps mitzugeben. Also eine absolute Empfehlung von mir, sich den Praxis-Guide herunterzuladen!
Das Interview führte Kerstin Smirr.
Mit diesen Praxistipps wird Ihre Betriebsanleitung zum Erfolg!
Wie lässt sich eine nutzerfreundliche Betriebsanleitung erstellen, die nicht nur rechtlichen Anforderungen genügt? Ein Dokument, das Kunden und Technikern in jeder Situation wertvolle Inhalte zu Ihrem Produkt liefert, verständlich aufbereitet und visuell ansprechend? Dies beantworten wir in diesem Praxis-Guide.
Andere Artikel von Quanos
Das könnte Sie auch interessieren
Docs-as-Code – Redaktionsverfahren aus der Softwarebranche
Seit einigen Jahren fällt in der Softwaredokumentation immer wieder das Stichwort Docs-as-Code. Vor allem in agilen S…
Frohe Weihnachten
Frohe Weihnachten und einen guten Rutsch ins Jahr 2024!
Technische Doku von überall: SCHEMA ST4 ist ab sofort webbasiert verfügbar
Unser Redaktionssystem SCHEMA ST4 steht ab sofort webbasiert zur Verfügung – als ST4 Web Author. Technische Doku kann…