Skip to content

STD #005 Serviceanleitungen – eine kleine Betrachtung

Beitragsbild Podcast Serviceanleitung

Sie sehen gerade einen Platzhalterinhalt von Podigee. Um auf den eigentlichen Inhalt zuzugreifen, klicken Sie auf die Schaltfläche unten. Bitte beachten Sie, dass dabei Daten an Drittanbieter weitergegeben werden.

Mehr Informationen

Die Anwender von technischen Informationsprodukten lassen sich in eine Vielzahl von Kategorien einteilen. Neben den reinen Benutzern im privaten und geschäftlichen Umfeld gibt es eine Gruppe, die möglicherweise ganz eigene Anforderungen hinsichtlich der Qualität und Verfügbarkeit der technischen Dokumentation stellt: Die der Servicetechniker.

In meiner Tätigkeit als technischer Redakteur beschäftige ich mich überwiegend mit der Erstellung von Betriebsanleitungen. Diese enthalten oftmals auch Anleitungen zur Wartung und Fehlersuche bei Störungen in der beschriebenen Anlage oder dem Produkt. Damit handelt es sich im Grunde genommen auch um Serviceanleitungen, wenngleich auch stark abgespeckt, denn sie sind meist auf Handlungen beschränkt, die der Anwender selbst im Bereich seiner Zuständigkeit ausführt. Allenfalls weitere Zielgruppen wie beispielsweise eine elektrotechnische Fachkraft finden Erwähnung, etwa dann, wenn es um den elektrischen Anschluss einer Maschine geht.

Ich bin technischer Redakteur als Seiteneinsteiger geworden und komme ursprünglich aus dem elektrotechnischen Sektor des Handwerks. Hier war ich oftmals als Servicetechniker im Außendienst tätig und hatte dort naturgemäß mit dedizierten Serviceunterlagen zu tun. Diese sind aufgrund ihrer Komplexität meist von den Betriebsanleitungen abgespalten und enthalten überwiegend Informationen, die dem normalen Anwender – aus guten Gründen – nicht zugänglich sind. Aus guten Gründen deshalb, weil sie beispielsweise auch Systemeinstellungen beschreiben die – bei falscher Konfiguration durch den Anwender – ein Gerät schon mal funktionsuntüchtig machen oder sogar schwer beschädigen konnten.

Je nach Produkt können sich Serviceunterlagen durchaus über eine Reihe von Handbüchern erstrecken – was einem dann die Arbeit mit ihnen nicht unbedingt erleichtert.

Zur Zeit meiner Tätigkeit in diesem Sektor waren Serviceunterlagen nur in gedruckter Form erhältlich. Und so kam es schon mal vor, dass man den halben Kofferraum des Einsatzfahrzeuges nur für Serviceanleitungen benötigte, bevor man zu den Kundendiensttouren aufbrach, die über den Tag von Einsatzort zu Einsatzort führten. Die Möglichkeit, zwischendurch in die Firma zurückzukehren, ergab sich nur sehr selten. Wehe es stellte sich dann unterwegs heraus, dass man ein Handbuch vergessen hatte. Auch konnte es vorkommen, dass ein nicht geplanter Kundendiensteinsatz zusätzlich abzuarbeiten war und zu einem Gerät führte, dessen Unterlagen man gar nicht dabei hatte. Dazu später etwas mehr.

Die Qualität 

Wie wir alle wissen, schwankt die Qualität von Betriebsanleitungen oftmals in mancherlei Hinsicht. So sind unlesbare Texte, unbrauchbare Abbildungen, unlogische Dokumentstrukturen, fehlerhafte Übersetzungen und andere Punkte den Anwendern eines Produktes Grund zum Ärgernis. Treten solche und ähnliche Mängel in Serviceanleitungen auf, werden sie schnell zu einem richtigen Problem, denn die Reparatur lässt sich dann nicht mehr zügig durchführen. Hier kann es bereits ausreichen, dass die Abbildung einer Komponente im Servicehandbuch nicht mit der übereinstimmt, die im Gerät verbaut ist. Oder eine Komponente muss getauscht werden, aber aufgrund der komplexen Gerätebauweise müssen zuerst weitere Bestandteile in einer bestimmten Reihenfolge ausgebaut werden, bevor man an das defekte Teil gelangt. Das kommt vor und ist kein großes Problem – sofern hierzu eine sorgfältig erstellte Schritt-für-Schritt-Anleitung existiert. Falls nicht, muss sich der Servicetechniker wohl oder übel eine Strategie erarbeiten, um zum Ziel zu gelangen. Das kostet Zeit und führt schonmal zu Frust beim Techniker – und auch beim Kunden. Denn Stillstandzeiten kosten Geld, manchmal sogar viel Geld. Ich kann mich an einen Fall erinnern, bei dem der Ausfall eines wichtigen Servers in der Produktion mit rund 10.000 EUR pro Stunde zu Buche schlug.

Die Bedeutung eigener Aufzeichnungen

Geben Serviceunterlagen die benötigten Informationen nicht her, helfen oftmals eigene Aufzeichnungen weiter. Allerdings auch nur dann, wenn der Techniker bereits an einem gleichen Gerät Erfahrungen sammeln konnte. Ansonsten bietet sich nun die Gelegenheit, den Problemfall möglichst genau zu dokumentieren – womit wir wieder beim Faktor Zeit wären. Persönliche Notizen können aber auch sehr hilfreich sein, wenn der Techniker bei seiner Arbeit beispielsweise feststellt, dass sich eine im Servicehandbuch beschriebene Handlung doch viel effektiver durchführen lässt. Im besten Fall finden diese Erkenntnisse später ihren Weg nicht nur in den Kollegenkreis, sondern auch in die Entwicklungsabteilung des Produktherstellers. Nach ihrer Prüfung dann in die technische Redaktion und damit in eine überarbeitete Fassung der Serviceanleitung. Die nun hoffentlich umgehend den Servicetechnikern zur Verfügung steht, so dass auch diejenigen von dem Mehrwert profitieren, die hierzu bislang keine eigenen Erkenntnisse sammeln konnten.

Es wäre also sehr hilfreich, wenn einerseits derartige Erkenntnisse aus der Praxis zeitnah an den Hersteller weitergegeben würden, andererseits der Hersteller selbst im Rahmen seiner Produktbeobachtungspflicht regelmäßig entsprechende Umfragen im Kreis des Servicepersonals durchführt. Ein passendes Online-Formular dazu ist auf der herstellereigenen Website schnell implementiert. Und für den Anreiz dieses auch auszufüllen, findet sich ganz sicher auch eine Art Belohnungsschema. Manch einer erinnert sich in diesem Zusammenhang vielleicht an die innerbetrieblichen prämienbehafteten Verbesserungsvorschläge der Mitarbeiter.

Unser Shop!
Viele nützliche Produkte rund um die Themen der Technischen Dokumentation
  • Muster und Vorlagen
  • Schulungsmaterial zu zahlreichen Themen
  • Piktogramme nach ISO 7010 und ANSI Z535
  • Länderkennzeichen EU und EFTA
  • E-Books

Die Technische Redaktion und die Serviceanleitungen

Was können wir in der technischen Redaktion tun, um brauchbare Serviceanleitungen zu erstellen?

Die Zielgruppenanalyse

Beginnen wir mit der Zielgruppenanalyse. Die Was-macht-Wer?-Matrix ist hierfür wohl nicht tauglich, ermittelt sie ja nur, welcher Personenkreis welche Tätigkeiten im Produktlebenszyklus ausführt und welche Informationsprodukte jeweils erforderlich sind.

Und wie ist es mit der Persona-Methode? Hier werden die Zielgruppen ja über eine oder mehrere fiktive Personen in einer steckbriefartigen Form veranschaulicht. Dieser Steckbrief enthält also Informationen, die aus einer gewissen Menge Daten bestehen. Diese wiederum stammen – ja woher eigentlich? Nicht selten entstammen sie einem bestimmten Bild, dass Ersteller von Personas bereits von einer Zielgruppe haben. Vielfach muss ein solches Bild aber auch erst entwickelt werden und da hilft oftmals nur die Phantasie.

Im Ergebnis könnte der Steckbrief eines Servicetechnikers dann wie folgt aussehen: Peter, 40 Jahre, 21 Jahre Berufserfahrung im Maschinenbau. Peter ist verheiratet und hat zwei Kinder. Bereits als Kind beschäftigte er sich mit allem, was sich mechanisch bewegt und nachbauen lässt. Peter liest viel, so auch Fachliteratur zur eigenen Weiterbildung. Er hat ein breitbandiges technisches Verständnis und geht an Problemlösungen gerne auch mal unkonventionell heran. In seiner Freizeit ist Peter ein passionierter Autoschrauber und tüftelt auch sonst gerne in seiner Werkstatt an technischen Spielereien.

Da oftmals ein Steckbrief nicht ausreicht, wurde noch ein zweiter erstellt: Hier haben wir den Andreas, 20 Jahre alt, ledig. Vor zwei Jahren hat er die Gesellenprüfung im Maschinenbau abgelegt, seine Berufserfahrung ist dementsprechend gering. Andreas technisches Verständnis und Interesse beschränkt sich auf seinen Beruf. Privat ist er viel mit seinen Freunden zusammen oder spielt gerne am Computer.

Sind Personas ausreichend?

Somit haben wir nun zwei Personas, die unterschiedlicher kaum sein können. Wir haben zum einen einen berufserfahrenen Mitarbeiter, der scheinbar dem Motto folgt: Dem Inschenör ist nichts zu schwör, zum anderen einen Mitarbeiter, der noch verhältnismäßig neu in diesem Beruf ist und darüber hinaus auch keine weitere Affinität zu technisch-mechanischen Welt erkennen lässt. Welche Erkenntnisse gewinnen wir nun daraus um sie bei der Erstellung von Serviceanleitungen gewinnbringend nutzen zu können?

Vermutlich nur die, dass wir das Informationsprodukt so gestalten müssen, dass das schwächste Glied in der Kette – also unser Andreas – bestmöglich mit Informationen für seine Tätigkeiten versorgt wird. Wir dürfen nämlich nicht davon ausgehen, dass nur berufserfahrene Techniker mit unseren Anleitungen arbeiten die als Backup noch den Notizblock mit den eigenen Aufzeichnungen in der Tasche haben und nur in besonderen Fällen in die Anleitung schauen , sondern wir müssen auch das eher unerfahrene Servicepersonal im Blick haben. Darüberhinaus: Auch erfahrenste Techniker brauchen detaillierte Informationsprodukte, wenn sie an einem ihnen völlig fremden Produkt Arbeiten durchführen müssen. Und da wir im Vorfeld nie mit Sicherheit wissen welchen Informationsbedarf einzelne Servicetechniker wirklich haben, können wir hier eigentlich nur festlegen, dass die Serviceanleitung bestmöglich detailliert abgefasst sein muss. Von den normativen Vorgaben zur Erstellung der Informationsprodukte einmal ganz abgesehen.

Wie sehen also, dass die Personas uns hier nur eingeschränkt weiterhelfen werden.

Umfragen

Wie wäre es mit Umfragen?

Nun, Umfragen sind ein recht beliebtes Mittel zur Erhebung von Daten. Je nach Durchführung der Umfragen besitzen sie durchaus aber auch gewisse Unschärfen, denn getreu der Erkenntnis „drei Experten, vier Meinungen“ könnten sich unterschiedliche Sichtweisen und Anforderungen der einzelnen Personen im Servicesektor ergeben. Dennoch dürften Umfragen in unserem Fall deutlich bessere Datenquellen darstellen als Personas.

Serviceunterlagen setzen sich meist aus einer Vielzahl von Dokumenten zusammen. Neben den Anleitungen zur Handlung finden wir dort beispielsweise auch Checklisten, Schaltpläne, Konstruktionszeichnungen, Ablaufdiagramme, Prüflisten, Fehlercodelisten, Ersatzteillisten und viele mehr – je nachdem, was für den Service an einem Produkt wichtig ist.

Die Wunschliste

Würde man mich fragen, würde ich u. a. folgende Wünsche äußern:

  • Detaillierte und nachvollziehbare Schritt-für-Schritt-Anleitungen
  • Auch sollten relevante Details in Abbildungen deutlich hervorgehoben sein. Dies lässt sich bereits mit Photoshop in nahezu jeder Grafik realisieren.
  • Alle Abbildungen sollten stets die tatsächlichen Gegebenheiten wiedergeben. Es ist schließlich niemandem geholfen, wenn die abgebildete Komponente beispielsweise mehr identisch aussehende Anschlussbuchsen besitzt als die, die sich im Gerät befindet. Vor diesem Hintergrund denke ich immer an die gerne verwendete Formulierung „Die Abbildung kann von den tatsächlichen Gegebenheiten abweichen“.
  • Desweiteren wünsche ich mir eine anwendungsorientierte Strukturierung des Dokumentes. Dies gilt für mich in besonderem Maße bei gedruckten Anleitungen, da das Verfolgen von Querverweisen über hunderte von Seiten bzw. mehreren Handbüchern alles andere als praktisch ist.
  • Auch wünschte ich mir eine sinnvolle Erstellung von optisch deutlich hervorgehobenen Querverweisen und Links. Immer wieder sieht man in PDFs zwar funktionelle aber wie Fließtext ausgezeichnete Querverweise. Dass diese anklickbar sind, erschließt sich nicht jedem sofort.
  • Schaltpläne und ähnliche Dokumente müssen in bestmöglicher Qualität und skalierbar sein. Wer schon einmal den Scan eines ausgedruckten und von DIN A3 auf DIN A4-Größe herunterskalierten Schaltplanes in Graustufendarstellung gesehen hat weiß, was ich meine. Referenzwerte wie Spannungen oder Ströme lassen sich oftmals dann schon nicht mehr sicher erkennen. Warum also die Schaltpläne im benötigten Format nicht direkt aus dem CAD-System exportieren, wo sie ohnehin erzeugt werden?
  • Anstelle umfangreicher Handlungsanleitungen schlage ich Animationen/Utility- oder lineare Videos vor, ggfs. sogar vertont. Auch oder vielleicht gerade in Serviceanleitungen gilt: Ein Bild sagt mehr als tausend Worte.
  • Auch praxisbezogene und logisch strukturierte Kapitel zur Fehlersuche sollten selbstverständlich sein. Je nach Komplexität eines Produktes kann eine nach Gerätekomponenten angeordnete baumartige Struktur sehr hilfreich bei der Fehlerdiagnose sein. Dies gilt in besonderem Maße bei gedruckten Anleitungen. Bei digitalen Publikationen in HTML-Form kann eine datenbankbasierte Fehlersuche sinnvoll sein.
  • Auch wünschenswert wäre eine Schnellzugriffsmöglichkeit auf alle Geräteparameter zwecks Kontrolle oder Korrektur.
  • Mindestens den Geräteparametern, die für Funktion und Service wichtig sind, sollte meiner Meinung nach ein eigenes Kapitel gewidmet sein. Kommen diese Daten mehrfach in einem Informationsprodukt vor, sollten sie im CMS in Variablen abgelegt werden – das spart später auch Zeit bei Änderungen.
  • Die Integration der Berichtsmöglichkeit zu den einzelnen Servicepunkten mit Querverweisen auf dort genannte Ersatzteile, wäre ein zusätzliches Feature. Ich bin der Meinung: Wenn schon digital dann gleich richtig. Was spricht dagegen, einzelnen Servicekapiteln eine Eingabemaske zuzuordnen in denen der Servicetechniker sofort alle durchgeführten Maßnahmen und getauschten Komponenten eintragen und anschließend an das eigene Unternehmen senden kann? In zeitkritischen Situationen wie bei meinem Serverbeispiel kann ich mir vorstellen, dass ein dringend benötigtes Ersatzteil per Kurier auf den Weg gebracht und dadurch schnell montiert werden kann, ohne dass der Servicetechniker noch einen weiteren Besuch einplanen muss. Zumindest in urbanen Gegenden ist das keine große Hürde.

Diese Wunschliste lässt sich noch um etliche Punkte weiterführen, zeigt aber bereits hier, dass eine enge Zusammenarbeit zwischen TR und weiteren Akteuren wie der Entwicklungs- oder der IT-Abteilung ggfs. unabdingbar ist.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Die ewige Frage: Papier oder Digital?

Aus meiner Sicht ist es heute zweckmäßig, Serviceanleitungen digital zu erstellen. Dies insbesondere dann, wenn sie sehr umfangreich sind und sich – wie in meinem Eingangsbeispiel – über mehrere Bände bzw. Dokumente erstrecken. Während bei gedruckten Anleitungen die Navigationsmöglichkeiten der Leser naturgemäß begrenzt sind, bieten digitale Informationsprodukte den Vorteil der Nutzung von internen oder gar externen Links sowie der Volltext- oder datenbankgestützten Suche. Dies ist bereits in der einfachsten Form in einem PDF-Dokument möglich.

Ein weiterer wesentlicher Vorteil liegt darin, dass die Aktualisierung von Serviceunterlagen und ihre anschließende Verteilung in digitaler Form bestechend einfach ist. Sie lassen sich beispielsweise in einem passwortgeschützten Bereich des Unternehmenswebservers bzw. über eine eigene Plattform verteilen. Wenn sie in HTML-Form publiziert werden, stehen sie den Servicekräften rund um die Uhr und quasi in Echtzeit zur Verfügung. Gerade auch bei einem Kundeneinsatz im Ausland ein nicht zu unterschätzendes Plus. Auch vergessene Unterlagen oder die für einen nicht vorhergesehenen Auftrag sind so schnell verfügbar. In Verbindung mit progressiven Webapps lässt sich so auch weitestgehend sicherstellen, dass alle Servicetechniker stets auf die aktuellsten Ausgabestände Zugriff haben.

Aber wo Licht ist, ist auch Schatten: Digitale Anleitungen in HTML–Form, insbesondere dann wenn es sich um AR und VR handelt, erfordern meist Spezialisten, die sich um die Realisierung und Implementierung kümmern. Hier ist dann auch mit den entsprechenden Kosten zu rechnen. Dabei sollten wir aber nicht vergessen, dass die Qualität der Serviceanleitungen und damit des Service an sich einen großen Einfluss auf die User-Experience eines Produktes haben, denn Maschinenstillstandzeiten bedeuten für ein Unternehmen Verluste.

Fazit

Halten wir also fest:

  • Die grundsätzlichen Anforderungen an die Erstellung von Betriebs- und Serviceanleitungen sind prinzipiell deckungsgleich. Dennoch scheint es im Servicesektor – zumindest bei komplexen Geräten und Anlagen – zweckmäßig, verstärkt auf digitale Informationsprodukte zu setzen und diese ständig optimiert an den täglichen Gebrauch des Servicepersonals anzupassen.
  • Auch die zeitnahe Verteilbarkeit der Unterlagen ist in digitaler Form ein wichtiger Faktor im Servicebereich.
  • Zeit ist Geld – besonders in der Industrie und lange Ausfallzeiten kann und will sich niemand leisten. Ja, auch die Erstellung solcher Informationsprodukte kostet mitunter viel Geld, kann sich aber durchaus schnell bezahlt machen.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen