In 5 Schritten zur konformen Bedienungsanleitung E-Book

Bärbel Hoffmann

• Herausgeber: neobooks
• Kategorie: Bildung
• Serie: Technik verständlich
• Sprache: Deutsch
• Veröffentlichungsjahr: 2024

Seitenzahl: 46

Beschreibung

Sie müssen eine Bedienungsanleitung zu Ihrer technischen Entwicklung schreiben? Vielleicht ein Handbuch zu Ihrer Software? Möglicherweise möchten Sie auch Ihre Anleitungen nutzerfreundlicher gestalten? – In Eigenregie! Und: Sich zuerst theoretische Abhandlungen zu erarbeiten, dafür haben Sie keine Zeit. Nehmen Sie das Buch und setzen Sie den Aufbau der Anleitung, deren Text, Terminologie, die erforderlichen Sicherheitshinweise Schritt für Schritt um. Stürzen Sie sich in die praktische Umsetzung. Das Buch ist aus der Praxis für die Praxis geschrieben.

Leseprobe

Vorwort

Hauptsächlich orientiere ich mich hier am Konzept von Dietrich Juhl1 und dem Funktionsdesign, entwickelt von Muthig/Schäflein-Armbruster.2

Geschrieben habe ich es für Menschen, die den Einstieg in die Materie suchen. Aus welchen Gründen auch immer.

Das kann eine Entwicklung sein, ob Maschine, Gerät oder Software, für die Sie eine Bedienungsanleitung benötigen: Hier finden Sie die Struktur und alle Teile, die für eine Betriebsanleitung erforderlich sind.

Vielleicht haben Sie in Ihrem Unternehmen auch festgestellt, dass das Handbuch dringend überarbeitet werden sollte. Vor allem, um Ihren Nutzern einen besseren Zugang zu verschaffen. Überhaupt: Das Gebot der Stunde ist eine nutzerfreundliche Anleitung.

Das kompakte Buch ermöglicht Ihnen einen raschen Einstieg in das Gestalten von Bedienungsanleitungen. Vielleicht überhaupt einen Einstieg in das Strukturieren von Informationen. Eine weiterführende Literaturliste habe ich Ihnen zudem angehängt, für vertiefende Studien.

Ein wichtiger Hinweis vorab. Sie werden tagtäglich mit verschiedenen Begriffen konfrontiert, was die Materie betrifft: Gebrauchsanleitung, Gebrauchsanweisung, Bedienungsanleitung, Bedienungshandbuch, Manual, Anleitung, Handbuch, Dokumentation. Auch ich habe weiter oben unterschiedliche Begriffe gewählt. Ich hoffe, Sie haben sie alle als eine Sache gelesen.

Alle Benennungen meinen dasselbe. Allerdings, um vorzugreifen, ist das Reduzieren und Entwirren der Fachsprache bereits eines der Themen, mit denen Sie sich beim Verfassen einer Bedienungsanleitung beschäftigen werden. Auch ich verwende im Buch ab sofort nur den Begriff Bedienungsanleitung oder ab und zu auch Anleitung. Mehr zu Fachsprache im Kapitel Terminologie.

Danksagung

Ich bedanke mich bei Christian Cipin, der mir und den anderen Kursteilnehmern während unserer Ausbildung zu Technischen Redakteuren bei AK Training + Beratung GmbH, Mannheim, 2009 zur Seite stand. Wir haben viel gelernt und hatten viel Spaß dabei. Den ein oder anderen Tipp habe ich in meine Ausführungen mit aufgenommen.

Auch den Kollegen mit technischem Hintergrund, die mir später im Job zur Seite standen, bin ich dankbar für sehr viel Durchblick, den sie mir verschafft haben.

Noch ein Wort zur gendergerechten Sprache. Mir ist Lesefreundlichkeit und Verständlichkeit bei der Kommunikation das Wichtigste, neben der Faktenbasiertheit. Ich schreibe so, wie das Gros der Menschen spricht. Daher verwende ich das generische Maskulinum, das die weibliche Form von Substantiven und in der Folge Artikeln und Adjektiven einschließt. Das weibliche, mithin auch diverse Geschlecht sind jederzeit eingeschlossen.

Inhaltsverzeichnis

Vorwort

Inhaltsverzeichnis

Einleitung

1. Aufbau Bedienungsanleitung

Leistungsbeschreibung

Bestimmungsgemäßer Gebrauch

Gerätebeschreibung

Vertieftes Verständnis und technische Unterlagen

Übersicht: Aufbau Bedienungsanleitung

2. Tätigkeitsbeschreibung

Handlung Schritt für Schritt

Weitere Möglichkeiten der Beschreibung

Funktionsdesign

3. Sicherheit im Fokus

Sicherheitshinweise – gebündelt vor der Tätigkeitsbeschreibung

Gefahrenbereiche ermitteln

SAFE und SAFER – das Restrisiko benennen

4. Technisches Schreiben

Inhalt

Textstruktur

Eigene Schreibregeln aufstellen

Textgestaltung

5. Terminologie

Terminologiearbeit

Prozess Terminologiearbeit

Anmerkungen/Richtlinien/Literaturliste

Anmerkungen

Richtlinien und Normen: eine (kleine) Auswahl

Literaturliste

Anhang

Sicherheitshinweise vor einer Handlung

Porträt

Einleitung

Warum überhaupt eine Bedienungsanleitung?

Die meisten Geräte, Vorrichtungen oder auch Gegenstände verfügen bei Kauf über eine Anleitung. Das muss so sein, es ist gesetzlich vorgeschrieben oder, falls nicht erforderlich, mittlerweile Standard. Oft werfen wir jedoch keinen einzigen Blick auf die Erläuterungen, etwa bei einem Fahrradhelm, beim Handmixer oder auch bei Software. Meist erübrigt sich der Blick auch, da die Geräte oder Programme bereits nutzerfreundlich gestaltet sind.

Warum also überhaupt eine Bedienungsanleitung? – Bei Installation des neuen Druckers, der Erstbedienung des Fernsehers oder dem Aufbau der Regalwand sieht es schon etwas anders aus. Ebenfalls bei einer tieferen Nutzung der Software; es heißt zum Beispiel, dass normale Nutzer nur etwa fünf Prozent der Word-Funktionen bedienen. Möglichkeiten zur Aneignung gibt es unterschiedliche: Die beigelegte Bedienungsanleitung anschauen, das Video-Tutorium auf YouTube besuchen oder sich bei Möbeln in die beigefügten Zeichnungen vertiefen, wichtig ist – ein Motto, das Sie sich schon mal merken sollten – die Befähigung zum Handeln. Oder weniger amtlich: sicher, schnell, dauerhaft nutzen.

Ziel ist, das Gerät schnell bedienen, die Software unmittelbar verwenden zu können. Ohne fremde Hilfe und auf Dauer. Ist selbstverständlich, sagen Sie? Stimmt. Doch hier geht es um das Erstellen einer Bedienungsanleitung. Dabei muss Selbstverständliches oft ausdrücklich genannt werden.

Was die schnelle Aneignung betrifft, verschaffen Sie den Nutzern, insbesondere in Haushalt, Büro oder Homeoffice, unmittelbar ein Erfolgserlebnis: Bei der neuen Mikrowelle können Sie vorschlagen, gleich ein Getränk zu erhitzen. Bei der Software für die Bildbearbeitung sofort ein Foto leicht umzugestalten. Das alles, ohne dass die Funktionen umfassend bekannt sind.

Übertragen lässt sich das auch auf komplexe Maschinen, Installationen, komplette Anlagen, etwa eine Seilbahnanlage mit Stationen und Antrieb, Seilführung und Kabinen. Da es hier um große Dokumentationen geht, ist es sinnvoll, unterschiedliche Nutzergruppen zu identifizieren.

Dabei hilft beispielsweise eine Wer-macht-was-Matrix. Mit ihr identifizieren Sie die Zielgruppe, besser gesagt die Zielgruppen. Daraus wiederum resultieren unterschiedliche Bedienungsanleitungen: zum Beispiel für Techniker im Maschinenraum, für Servicegruppen, die für Instandhaltung zuständig sind. Die Wer-macht-was-Matrix lässt sich gestalten als Tabelle (siehe Anhang). Allgemeine Fragen dazu wären: Wozu dient das Gerät? Wer geht mit dem Gerät um? Falls es mehrere Personen sind: Für wen ist welche Information erforderlich?3

1. Aufbau Bedienungsanleitung

Warum eine Struktur? Dumme Frage, sagen Sie? Das ergibt sich beim Schreiben und Erläutern ja immer von selbst. Ja, schon, doch geht es hier nicht um die von Fall zu Fall passende Struktur, sondern um den Aufbau einer klugen Struktur, die nicht nur in einem, sondern in allen, na ja in den meisten Fällen passt.4 Dabei steht für die direkte Ansprache der Nutzer die Tätigkeitsbeschreibung im Fokus. Doch zuerst zu den Bestandteilen, die zur Beschreibung eines Gerätes, einer Anlage dazugehören.

Leistungsbeschreibung