wie  erstelle  ich  ein  benutzerhandbuch?

ã Berchtold Moser

Bleichemattstrasse 18, CH-5000 Aarau

berchtold.moser@bluewin.ch

Alle Angaben über Unternehmen und Personen stammen aus öffentlich zugänglichen Quellen.

Gewerblicher Gebrauch nur mit Einwilligung des Autors gestattet!

Inhaltsverzeichnis

Persönlich ansprechen                                      

Reden …                                                          

… und Schreiben                                              

Gegenstand und Zielpublikum                         

Benutzer-Dokumentation, das gestaltbare Element zwischen Gegenstand und Zielpublikum       

Aspekte des dokumentierten Gegenstandes     

Aspekte des Zielpublikums                              

Generell                                                            

Konzept                                                            

Weitere Funktionen des Dokuments                

Terminplan für das Erstellen der Dokumentation    

Struktur                                                            

Mehrsprachigkeit                                              

Aufmachung                                                     

Format                                                              

Druck                                                               

Papier                                                               

Layout                                                              

Elemente des Satzspiegels                                

Der Satzspiegel                                                 

Schriften für Textkörper und Titel                    

Illustrationen                                                    

Einleitung                                                         

Arten der Illustration                                        

Vorteile der einzelnen Illustrationsarten           

Zweidimensionale Zeichnung                          

Perspektivzeichnung                                         

Explosionszeichnung                                        

Bildschirm-Ausdrucke                                      

Schematische Grafiken verschiedenster Art     

Strukturierende Grafiken (Piktogramm, Icon)  

Clip Art                                                             

Cartoons                                                           

Fotografie                                                         

Ton- und Videosequenzen                                

Fachspezifische Darstellungen                         

Typische Anwendungsfälle für Illustrationen   

Tipps zum Einsatz von Illustrationen               

Ihre Aufgabe als technischer Redaktor             

Die vier Aspekte einer Botschaft                      

Gliederung - Ordnung im Textaufbau              

Einfache sprachliche Formulierung                  

Einfachheit hat ganz verschiedene Aspekte     

Kürze - Prägnanz (statt Weitschweifigkeit)      

Zusätzliche Stimulanz (anregende Stilmittel)   

Zur Wiederholung nochmals die Grundsätze   

Software-Ergonomie                                         

Gestaltung des Bildschirms                              

Gestaltung der Einzelinformationen                 

Farbe am Bildschirm                                         

 

 

 

Unsere Entwickler leben, essen und atmen Computer. Aber die meisten Leute, die mit ihnen arbeiten, tun das nicht und wollen es auch nicht tun. Eine Sprecherin des Software-Konzerns Microsoft

Persönlich ansprechen

Auch eine schriftliche Botschaft soll den Leser persönlich ansprechen und benutzt deshalb Elemente des mündlichen Ausdrucks:

Reden …

Wenn wir jemandem mündlich etwas wirkungsvoll beibringen wollen, versuchen wir, seine ganze Aufmerksamkeit zu gewinnen. Wir suchen den Blickkontakt zu ihm und sprechen laut, deutlich und in der angemessenen Kürze zu ihm. Andere weichen zum Beispiel dem Blickkontakt wenn immer möglich aus, reden ausschweifend oder sagen freiwillig kaum etwas. Generell können wir diese anerzogenen Verhaltensweisen in der mündlichen Kommunikation nur mit sehr grossen Aufwand und langem Training ändern.

 

… und Schreiben

Auch eine schriftliche Botschaft erreicht den Leser am wirkungsvollsten, wenn sie ihn persönlich anspricht. Beispiele aus der Werbung sehen Sie in der Einleitung.

Gute Gebrauchsanweisungen wenden sich ebenso direkt und durchdacht an ihr Zielpublikum. Wenn der Redaktor Techniker ist und für Nicht-Techniker schreibt, muss er sich bewusst sein, dass sein Zielpublikum in einer anderen Welt lebt. Das einleitende Zitat von Microsoft bringt dies drastisch zum Ausdruck. Aber auch wer mehr oder weniger professionell Gebrauchsanweisungen und Ähnliches schreibt, merkt, dass er sich immer in sein Zielpublikum versetzen muss, um mit seinen Werken auch anzukommen.

Im Unterschied zum mündlichen Sprechverhalten können wir unsere schriftlichen Ausdrucksmöglichkeiten relativ einfach ändern und erweitern, denn wir stehen beim Schreiben weniger unter Zeitdruck. Es fehlt auch das direkte Gegenüber. Das kann weniger psychologischen Druck bedeuten, vielleicht aber auch weniger Inspiration.

Gebrauchsanweisungen wie jede andere Art technischer Dokumentation sind für ihre Leser Pflichtlektüre. Kaum jemand liest solche Anweisungen aus Vergnügen am originellen Text. Deshalb sollten diese dem Leser einen Gegenstand möglichst wirkungsvoll erklären.

Es ist das Ziel dieses Kurses, die schriftlichen Ausdrucksfähigkeiten des Kursteilnehmers dahingehend zu erweitern, dass er einem definierten Zielpublikum die Handhabung von Gegenständen der Technik und inbesonders von Computerprogrammen angemessen und wirkungsvoll erläutern kann.

Auch dem geübten technischen Redaktor gerinnen übrigens technische Inhalte in Gedanken gerne zu ellenlangen Passivsätzen. Auch bei ihm fügen sich Illustrationen und Gestaltungselemente nicht automatisch in die Dokumentation ein. Erst mit einer gewissen Erfahrung kann er bereits beim Niederschreiben der Gedanken zweckmässig strukturieren und formulieren.

Zahlreiche Übungen sollen deshalb neue Ausdrucksfähigkeiten trainieren. Wenn Sie die Mühe dazu nicht scheuen, erreichen Sie mit Sicherheit ein ansprechendes Niveau. Wer nämlich die Klippen erkannt hat, wird sie mit zunehmender Leichtigkeit umschiffen können.

Sprechen und auch Schreiben sind menschliche Verhaltensweisen ähnlich wie zum Beispiel Singen, Schwimmen, Rennen, Radfahren und andere mehr. Das Verständnis für Regeln ist nötig, aber nur intensives Üben kann zur weitgehenden Souveränität im Sprachgebrauch und im Schreiben führen.

 

 

Übung 1: Vielerlei Fehler

Sicher finden Sie im Text der folgenden Anleitung Dinge, die noch zu verbessern sind. Notieren Sie sich unter den entsprechenden Stichworten, was Sie anders gemacht hätten. Lösungshinweise finden Sie ab Seite 58.

 

Orthographie; Grammatik:

Darstellung:

Verständlichkeit:

 

Weiss man einmal, wie ein Gerät funktioniert, dann dauert es nicht mehr lange, bis man auch die Gebrauchsanweisung kapiert. Konsumenten-Weisheit aus dem 20. Jahrhundert

Benutzer-Dokumentation, das gestaltbare Element zwischen Gegenstand und Zielpublikum

Betrachten wir das Thema dieses Kurses etwas näher:

·        Benutzer-Dokumentation in Form von Gebrauchsanweisungen, Handbüchern, Bildschirm-Masken, Online-Hilfen, Hilfetexten und Ähnlichem

·        ist das Erklären, Erhellen, Erläutern, Auseinandersetzen, Instruieren, Klarmachen, Nahebringen, Einweisen

·        eines Gegenstandes wie zum Beispiel
eines Gerätes, einer Maschine, einer Software

·        bei einem Zielpublikum, zum Beispiel bei
einem Anlage-Operateur, einem beliebigen Computerbenutzer, einem Reinigungsbeauftragten, einem Ingenieur.

Gegenstand, Dokumentation und Zielpublikum bilden also eine Einheit, deren gemeinsames Ziel ein effizienter Arbeitsprozess ist. Wenn nur ein Eckpunkt mangelhaft ist, so leidet die Effizienz des Arbeitsprozesses und somit auch die Qualität und/oder die Quantität der Produktion.

Daraus folgt, dass Gegenstand, Benutzer-Dokumentation und Zielpublikum aufeinander abgestimmt sein müssen. Die Benutzer-Dokumentation ist das Scharnier, der variable Faktor zwischen Gegenstand und Zielpublikum. Deshalb muss die Benutzer-Dokumentation im Zentrum der Bemühungen um die Einweisung des Zielpublikums in einen Gegenstand sein. Die Gestaltbarkeit des zu dokumentierenden Gegenstandes und des Zielpublikums sind naturgemäss sehr begrenzt. Einige Hinweise dazu scheinen uns dennoch nützlich.

Aspekte des dokumentierten Gegenstandes

Ein Gerät oder eine Maschine muss nach den Regeln des guten Designs konstruiert sein. Der wichtigste Grundsatz guten Designs besagt, dass die Form des Gerätes dessen einwandfreies Funktionieren sicherstellen soll. Beschriftungen von Schaltern zum Beispiel sind gut leserlich und ausführlich genug an der richtigen Stelle anzubringen. Originelles Aussehen ist in der Regel nicht Anzeichen guten Designs, sondern eines eigenwilligen Marketings.

Für das gute Gelingen einer Dokumentationsarbeit ist die Herkunft der Informationen zum Gegenstand von entscheidender Bedeutung. Geben Sie sich als technischer Redaktor nicht mit der erstbesten Quelle zufrieden! Fragen Sie verschiedene Personen in der Entwicklungsabteilung oder auch im Marketing, was über den Gegenstand schon auf Papier vorliegt. Typische Quellen sind:

·        Frühere Version der Benutzer-Dokumentation zu ähnlichem Gegenstand

·        Autor dieser früheren Version

·        Technische Unterlagen aus Planung, Konstruktion, Analyse

·        Kundenanforderungen, Pflichtenheft, Ansprechpartner aus der Produktion.

Aspekte des Zielpublikums

Der Blick auf das Zielpublikum spielt beim Abfassen einer Benutzer-Dokumentation eine äusserst wichtige Rolle. Versuchen Sie, die Leute persönlich kennen zu lernen. In diesen Zusammenhang sind folgende Fragen abzuklären:

·        Ausbildungsstand?

·        Sprach- und Lesekenntnisse?

·        Kenntnisse von ähnlichen Produkten vorhanden?

·        Spezielle Motivation nötig (zum Beispiel bei Umstellung eines Ablaufes auf EDV) ?

·        Gibt es mehrere Zielgruppen, die mit je verschiedenen Dokumentationsvarianten zu bedienen sind?

Zur Einstimmung in die Problematik folgt Übung 2. Bitte lesen Sie den nachfolgenden Auszug aus einer Gebrauchsanweisung durch und notieren Sie sich auf den freien Zeilen die Fehler, welche zum Teil beim Übersetzen entstanden sind, aber nicht korrigiert wurden. Wie wären sie zu vermeiden gewesen?

RADIOBETRIEB Das Uhrenradiogerät sollte nur mit Hanshaltwechselstrom betrieben werden. Die 9 Volt Batterien im Gehäuse sind dazu da, um die Zeit weiterlaufen zu lassen, nachdem der Strom unterbrochen ist..   ZEITZÄHLEINSTELLUNG ZUM SCHLAFEN Speziell vorgesehen für das Radiohören vor dem Einschlafen. Die Schlafen löst einen automatischen Zeitzähler aus, der das Radio zu irgendeiner beliebigen, vorher gewählten Zeit zwischen 1 und 59 Minuten ausschaltet. Drücken Sie die Schlafen (4) und Knopf für Schnell (3) das Radio schaltet sich sofort ein und die Uhrenanzeige zählt von 59 bis null ab, wobei jede Zahl eine vorgewählte Zeit in Minuten darstellt. Lassen Sie den Knopf los, wenn die gewünschte Einstellung erreicht ist und das Radio wird sich automatisch auschalten, wenn die gewählte Zuhörzeit abgelaufen ist.