BA #033 Die Betriebsanleitung für ein noch in der Entwicklung befindliches Produkt

Die Tätigkeiten im Alltag einer technischen Redaktion sind vielfältig – und dabei manchmal Routine, manches Mal können sie sogar eine echte Herausforderung sein.

Herausforderungen stellen wir uns im Leben oft – beruflich wie privat. Von einer beruflichen Herausforderung in der technischen Redaktion handelt dieser Podcast.

Aktuell arbeite ich an einer Bedienungsanleitung für ein kleines, handgeführtes Gerät aus dem Bereich der Autoreparatur. Nicht dass mir meine Arbeit auch sonst keinen Spaß machen würde, aber als passionierter privater Autoschrauber freu e ich mich auf diese Aufgabe ganz besonders.

Das Besondere an dieser Arbeit ist nun, dass es dieses Produkt eigentlich noch gar nicht gibt. Soll heißen: Außer einem Prototyp existiert bislang kein weiteres Gerät. Einer ähnlichen Herausforderung hatte ich mich bereits in einem vorhergehenden Fall zu stellen – hier handelte es sich um den Prototypen einer Maschine für den Nahrungsmittelbereich. Anderes Produkt – nahezu gleiche Voraussetzungen. Nahezu deswegen, weil der Geräte-Prototyp der Maschine für den Nahrungsmittelbereich – anders als der aus der Kfz-Werkstatt – unserer Redaktion physikalisch nicht vorlag. Gründe hierfür können beispielsweise sein, dass der Prototyp für die weitere Entwicklung beim Hersteller verbleiben muss oder dass der Prototyp bis zu diesem Zeitpunkt nur mit sehr eingeschränkten Funktionen oder sogar nur virtuell existiert. Eine kleine Herausforderung also.

Hinzu kommt dann der auch sonst ständig vorhandene Druck, dass die Bedienungsanleitung pünktlich zur Auslieferung, besser noch vor der Auslieferung des Produktes fertiggestellt sein muss – dies ist eine der Anforderungen im Rahmen der CE-Kennzeichnung. Hieraus folgt, dass mit der Erstellung der Bedienungs- und Betriebsanleitungen so früh wie nur möglich begonnen werden muss um dieser Anforderung zu genügen. Ist das Produkt erst zur Auslieferung verpackt ist es zu spät.
Anders herum kann ein zu früher Arbeitsbeginn an der Anleitung dazu führen, dass sich während des Prozesses noch diverse Änderungen ergeben können die selbstverständlich zu erfassen sind.  Es ist daher sehr wichtig sich bereits im Vorfeld mit allen Bedingungen auseinanderzusetzen und einen zum Produkt passenden Prozess zu finden.

Wie schreibe ich eine Bedienungsanleitung für ein Produkt, das nur als Prototyp existiert, dessen Funktionen und Steuerungen noch nicht final implementiert sind und das ich wie im Fall der Maschine für den Nahrungsmittelbereich nicht einmal vor mir habe?

Nun kann nicht jedes Produkt in Natura auf dem Schreibtisch stehen, wenn man die zugehörige Dokumentation verfasst – wie soll das beispielsweise bei einer Maschine für die Landwirtschaft oder gar einer industriellen Produktionsanlage auch vor sich gehen?

Bevor man mit dem Verfassen einer Dokumentation beginnt, muss immer eine Produktanalyse stattfinden. Sie wird i. d. R. von demjenigen erstmalig ausgeführt, der die Risikobeurteilung erstellt. Die Produktanalyse lässt sich verständlicherweise umso besser durchführen, je einfacher der Zugriff auf das zu beschreibende Produkt ist, denn man verschafft sich hierbei ja einen Überblick über das Produkt: Wozu dient es, was kann es, wie macht man was, um das und das zu erreichen, etc.
Sind Ersteller der Risikobeurteilung und Ersteller der Bedienungsanleitung nicht die selbe Person, muss auch der technische Redakteur der die Bedienungsanleitung erstellt sich mit dem Produkt intensiv befassen.

Prototypen können hier eine Herausforderung sein, besonders dann, wenn ihre Entwicklung zum Zeitpunkt, an dem mit der Dokumentation begonnen wird, noch lange nicht abgeschlossen ist. Dies hat zur Folge, dass sich im weiteren Verlauf zahlreiche Rückfragen und Änderungen ergeben können deren Umsetzung zeitintensiv und damit finanziell aufwändig ist. So beispielsweise, wenn das Produkt plötzlich um eine WLAN- oder Bluetooth-Schnittstelle erweitert werden soll und das Produkt damit unter die Funkanlagen- und EMV-Richtlinie fällt. Und auch die Risikobeurteilung selbst kann bei noch in der Entwicklung befindlichen Produkten herausfordernd sein, da sie ja alle Produktlebensphasen umfassen muss.

Die Produktanalyse eines in der Entwicklung noch nicht abgeschlossenen Prototypen besitzt aber nach meiner Ansicht auch einen positiven Aspekt: Sowohl der Ersteller der Risikobeurteilung als auch der im späteren Verlauf tätige technische Redakteur fungieren hier quasi als erste externe Beta-Tester. Ein entsprechendes technisches Verständnis der Personen vorausgesetzt, kann eine solche Produktanalyse somit dem Hersteller durchaus wertvolle Hinweise auf mögliche Schwachstellen beispielsweise in der Benutzerführung oder auch in konstruktiver Hinsicht liefern, die bisher gar nicht bedacht wurden oder auffielen. Das kann sich auf die Usability eines Produktes durchaus positiv auswirken.

Dennoch, so wertvoll dieser Aspekt auch ist, ich möchte ihn nun aber nicht so verstanden wissen, dass Hersteller ihre Produkte künftig auf diesem Wege quasi so ganz nebenbei auf ihre Tauglichkeit testen lassen können. Dazu haben wir in der technischen Redaktion schon genug mit anderen Problemen zu kämpfen – einige erwähnte ich bereits. Die Liste ist damit aber noch nicht am Ende. So hat die technische Redaktion auch schon einmal mit der Erwartungshaltung des Auftraggebers hinsichtlich des Zeit- und Kostenaufwandes zu kämpfen. Dieser hat oftmals keine Vorstellung wie aufwändig und zeitfordernd die Erstellung einer Dokumentation sein kann. So sei nur das Thema Normenrecherche erwähnt. Auch erlebt man oft, dass der Auftraggeber scheinbar der Meinung ist: Das sind technische Redakteure – die müssen doch wissen wie mein Produkt funktioniert und daher muss ich nur eine entsprechend übersichtliche Produktbeschreibung liefern. Dazu gleich noch etwas mehr.

Und auch ein weiteres Thema sorgt schon mal für Verdruss: Im Maschinenbau wird oft auf Basis von Lastenheften gearbeitet. Ähnlich wie Produktbeschreibungen sind auch sie teilweise schlecht oder falsch ausgearbeitet und enthalten nicht umsetzbare Anforderungen. Richtig problematisch wird es dann, wenn der Vertrieb bestimmte Funktionen verbindlich zugesagt hat die aber aus dem mangelhaften Lastenheft nicht hervorgehen und ihr Fehlen so erst spät – im schlimmsten Fall erst bei der Abnahme durch den Kunden – auffällt.

Nicht nur bei Prototypen, nein auch bei finalen Produkten, bekommt man also längst nicht immer alle Informationen und Unterlagen vom Hersteller geliefert, die man sich für die Redaktionsarbeit wünscht.

Schauen wir uns die Knackpunkte etwas näher an:

Da wäre als Allererstes eine korrekt ausgearbeitete Risikobeurteilung zu nennen. Leider zeigt die Praxis immer wieder, dass es bereits hieran oftmals hapert. Die Risikobeurteilung ist das wohl wichtigste Dokument zu einem Produkt und die unverzichtbare Arbeitsgrundlage in der technischen Redaktion. Nun scheint so mancher Hersteller die Bedeutung dieses Dokumentes nicht zu kennen, dessen Erstellung doch in allen EU-Richtlinien gefordert ist. Zu diesem Thema verweise ich auf einen kurzen aber sehr informativen Videocast von Regina Schlindwein-Reimold.

Auch in dieser Hinsicht ist es daher sehr hilfreich, wenn der technische Redakteur über ein mindestens gutes technisches Verständnis und idealerweise über eine umfangreiche Berufserfahrung in einem technischen Beruf verfügt und so manche Stolperstelle in der Risikobeurteilung hinterfragen kann. Aber auch technische Redakteure die keine technische Ausbildung als Grundlage mitbringen erkennen anhand ihrer Berufserfahrung schnell, was in einer Risikobeurteilung möglicherweise fehlt. Dies kann insbesondere bei nicht finalen Prototypversionen von großer Bedeutung sein.

Dennoch entbindet das den Hersteller nicht von seiner Verpflichtung, eine korrekte Risikobeurteilung selbst zu erstellen. So muss eine Risikobeurteilung alle Produktlebensphasen berücksichtigen. Leider trifft man häufig auf eine Arbeitsweise seitens der Hersteller die dieser Forderung nicht unbedingt gerecht wird, so wenn nur stur die Gefährdungsliste in Anhang B.1 der DIN EN ISO 12100 abgearbeitet wird. Real bestehende Risiken des Produktes die möglicherweise nicht in der Liste vorkommen, werden so schnell übersehen. Bitte nicht vergessen: Diese Liste beinhaltet Beispiele und entbindet nicht von der Verpflichtung die Risiken des eigenen Produktes gewissenhaft zu ermitteln.

Wenn der Hersteller also aus personellen oder anderen Gründen nicht vermag eine Risikobeurteilung zu erstellen, ist er gehalten diese Aufgabe an einen kompetenten Dienstleister zu vergeben

In diesem Zusammenhang verweise ich auch auf die Podcasts meiner Kollegen Florian Schmider und Florian Seckinger sowie meinen zweiteiligen Videocast „Von der Risikobeurteilung zum Warnhinweis“.

Von der Risikobeurteilung zum Warnhinweis – Teil 1

Von der Risikobeurteilung zum Warnhinweis – Teil 2

Risikobeurteilung? Da haben wir mal was vor Jahren gemacht

Risikobeurteilung – Die ersten Schritte – Voraussetzungen für die Risikobeurteilung

Optische Komponenten wie Fotos, Grafiken, Skizzen, etc. sind für die Vermittlung von Wissen unverzichtbar. Leider steht man auch hier als technischer Redakteur oft vor Problemen. Sei es, dass der Hersteller aus unterschiedlichen Gründen kein Material zur Illustration liefern kann oder gar will. So bekommt man schon mal nur Ausgangsmaterial in Form von STEP- oder anderen CAD-Formaten geliefert, aus denen man sich bei Bedarf die entsprechenden Ansichten selbst generieren muss. Dies hat natürlich auf der anderen Seite auch erhebliche Vorteile, denn man kann sich die entsprechen-den Illustrationen genau so generieren wie sie in der Bedienungsanleitung gebraucht werden oder weil beispielsweise Maschinenteile visualisiert werden sollen, die sich unter Abdeckungen befinden, die für die Anfertigung eines Fotos erst demontiert werden müssten. Obwohl dies im Grunde genommen eine praktische Sache ist, denn die Zeichnungen kommen ja gewissermaßen direkt aus der Konstruktionsabteilung, sind solche Grafiken nicht immer geeignet, um dem Benutzer bestimmte Sachverhalte optimal zu illustrieren. Hier sind Fotos oder fotorealistische Grafiken öfters praktikabler.

Nicht selten also stellen wir das benötigte Material mit Fotoapparat, Grafik und Bildbearbeitungsprogrammen oder CAD-Software selbst her. Das kostet Zeit und wirft dann Probleme auf, wenn sich wie in meinem Fall der Prototyp nicht am Arbeitsplatz, sondern sehr weit weg beim Hersteller befindet oder das Produkt noch gar nicht existiert. Eine andere Herausforderung ist es, wenn eine Anlage dokumentiert werden soll, die erst beim Kunden nach gewissen Spezifikationen aufgebaut werden muss. Auch Fotos die Handlungsanweisungen eines über Stunden andauernden Prozesses illustrieren sollen sind eine oft schwer zu knackende Nuss.

Ein weiterer Knackpunkt sind geradezu spartanisch anmutende Beschreibungen des Produktes, welche vom Hersteller geliefert werden – die eine oder andere verdiente dabei durchaus das Prädikat „sehr übersichtlich“. So erhält man schon mal Produktbeschreibungen die aus nicht sehr viel mehr als einer stichpunktartigen Auflistung der wichtigsten Eckpunkte bestehen und es bleibt nichts anderes übrig als sich die Funktionen des Produktes selbst zu erschließen.

Nun ist es nicht so, dass ein wenig detektivische Ermittlungsarbeit bei der Produktanalyse per se schlecht ist, dennoch empfinde ich diese unausweichliche Notwendigkeit unter dem Strich als sehr bedauerlich und in gewisser Hinsicht auch unnötig, denn wer wenn nicht die Konstrukteure eines Produktes können seine Funktionen detaillierter beschreiben? Dabei rede ich hier ja gar nicht von einer grammatikalisch und didaktisch perfekten Abhandlung im redaktionellen Sinne, sondern nur von einer grundlegenden und nachvollziehbaren Funktionsbeschreibung. Gerade diese Ausgangslage – eine mangelhafte Produktbeschreibung und eine mangelhafte Risikobeurteilung – bereiten technischen Redakteuren oftmals die meisten Kopfzerbrechen – dazu braucht es noch nicht mal einen – zu allem Überfluss auch noch unerreichbaren – Prototypen.

Halten wir also fest:

• Falls irgend möglich sollte der Prototyp der technischen Redaktion zur Verfügung stehen oder ein Zugang dazu gewährt werden.
• Obwohl die Erstellung der Risikobeurteilung eigentlich nicht die Aufgabe des technischen Redakteurs ist, sollte meiner Meinung nach bei der Produktanalyse eines Prototypen mit besonders wachem Auge hingesehen werden, um eventuell bisher unerkannte Probleme zu benennen. Dies gilt im Übrigen auch für die Funktionen und das Thema Usability allgemein.
• Sofern der Prototyp nicht die finale Version darstellt, sollte im Auftrag berücksichtigt werden, dass sich Änderungen ergeben können, die zeitliche und finanzielle Auswirkungen haben.
• Mit dem Auftraggeber sollte abgesprochen werden, welches Informations- und Bildmaterial geliefert wird.
• Ob Prototyp oder fertiges Produkt: Mit der technischen Dokumentation sollte so früh wie möglich begonnen werden. Hierbei ist es jedoch oftmals erforderlich sich auch Gedanken um den gesamten Prozess zu machen um ständiges Nachfragen, Nachforderungen und Verzögerungen zu minimieren.
• Regelmäßige Zwischenstandsberichte sind meiner Meinung nach insbesondere bei noch in der Entwicklung befindlichen Produkten ein unbedingtes Muss. Nur so erfährt der Auftraggeber zeitnah, wo es ggfs. noch hakt. Zu diesem Zweck setze ich gerne auf ein von mir entsprechend kommentiertes PDF eines aktuellen Proofs der Bedienungsanleitung, das dann wieder vom AG kommentiert werden kann (Stichwort Kommentarfunktion im Acrobat Reader).