Technisches Schreiben: Betriebsanleitung, Handbuch, Softwaredokumentation ...
Mit technischem Schreiben ist das Verfassen fachlicher Texte gemeint. Ein solcher Fachtext muss schnell die gewünschte Information liefern. In der Technischen Dokumentation (Bedienungsanleitungen, Handbücher) soll der Nutzer schnell ein Gerät bedienen, eine Software verwenden können. Das habe ich auch bei Einführung Bedienungsanleitung erwähnt. In einer Dokumentation, einem Fachartikel oder einem Referat muss das angesprochene Problem Leser oder Zuhörer unmittelbar eingängig sein. (Falls Sie die Ausführungen zu einer anderen Zeit lesen möchten, hier die PDF dazu.)
Leser möchten:
-
schnell informiert sein.
-
wenig lesen müssen.
-
sofort verstehen können.
Textinhalt
Bevor es ans Schreiben, ans Strukturieren und Schreiben geht, muss der Inhalt geklärt sein. Handelt es sich um einen Fachtext, muss das Thema gut recherchiert und die Darstellung wasserdicht sein. Als Autor oder Autorin wollen Sie den Inhalt dem Leser so gut wie möglich vermitteln. Hier kommt es auf die Zielgruppe an: Fachpublikum oder Laien. Oder etwas zwischendrin. Das heißt nicht, dass man für Eingeweihte besonders kompliziert schreibt. Niemand, auch wenn promoviert oder gar habilitiert, möchte einen komplizierten Text lesen.
Doch in der Regel können Sie beim Fachpublikum das Fachjargon voraussetzen. Zudem sparen Sie sich die ein oder andere Erläuterung. Bauteile wie Trapezgewinde, Kondensator oder Bundbuchsen bzw. Bot, Proxy, Telematik müssen nicht erklärt werden. Anders bei Laien oder Fachleuten aus verwandten Gebieten.
Textstruktur
Der Text sollte immer verständlich aufgebaut sein. Nicht um den heißen Brei herumreden, sondern auf den Punkt kommen. Um nichts zu vergessen, stellen Sie sich die W-Fragen: wer, was, wann, wo, wie, warum. Nicht immer ist die Beantwortung aller Fragen erforderlich. Eine Bedienungsanleitung folgt einem strengen Aufbau: etwa Beschreibung des Gerätes, Inbetriebnahme, Handhabung.
Ein Fachartikel ist journalistisch aufgebaut: das Wichtigste zuerst, Rechercheergebnisse, auf Augenhöhe mit dem Leser. Bei einer Projektdokumentation steht die Beschreibung des Problems sowie dessen Lösung im Vordergrund – und so weiter.
Immer informativ formulieren, passendes Wort suchen, lesefreundliche Sätze bilden.
Denken Sie daran: Die Leser haben keine Zeit, auf sie warten wichtige Aufgaben.
Passende Wörter / lesefreundliche Sätze
Rücken Sie mal ab von Ihrem üblichen Sprachgebrauch. Das kann erhellend sein. Reflektieren Sie Ihre Wortwahl, ersetzen Sie Begriffe und übliche Formulierungen:
Schreiben Sie statt innovativ vielleicht erfindungsreich.
Sprechen Sie statt von nachhaltig von dauerhaft.
Verschlanken Sie Wörter: Problem reicht, Problemhaftigkeit is too much.
Nehmen Sie nicht mehr die Herausforderung an, sondern ändern Sie ganz einfach etwas.
Lesefreundliche Sätze erzeugen Sie, indem Sie beispielsweise aktiv schreiben, Verben bevorzugen, Schachtelsätze vermeiden, die Hauptaussage herausstellen. Wobei, durch WhatsApp-Nachrichten, Posts auf Twitter, Instagram oder Linkedin sind wird bereits auf Reduktion konditioniert.
Aktiv schreiben
Die Maschine wird von Fachpersonal gereinigt.
Fachpersonal reinigt die Maschine.
Verben bevorzugen
Nicht Verzicht leisten, sondern verzichten.
Im Deutschen besteht die Tendenz Sätze in Verbklammern zu zwängen. Lassen Sie das bleiben, wenn es geht.
Die Firmenleitung schenkte den Hinweisen, die sie von Mitarbeitern erhalten hatte, keine Beachtung.
Die Firmenleitung ignorierte die Hinweise, die sie von Mitarbeitern erhalten hatte.
Lange in kurze Sätze umzuformen ist nicht das Allheilmittel. Auch wenn Sie das vielleicht schon öfter gelesen haben. Es kommt in erster Linie auf Verständlichkeit an.
Stellen Sie Sätze auf den Prüfstand.
-
Sind Wörter überflüssig?
-
Wird ein Sachverhalt besser in einem Satz oder in mehreren ausgedrückt?
-
Wird der Sachverhalt verständlicher durch einen Nebensatz?
Beispiele
Die vorliegende Änderung bearbeiten.
Die Änderung bearbeiten.
Plastikhalterung an der Ablaufpumpe entsichern und dann die gesamte Ablaufpumpe nach rechts drehen und entnehmen.
Plastikhalterung an der Ablaufpumpe entsichern.
Ablaufpumpe nach rechts drehen.
Ablaufpumpe entnehmen.
Die zu erörternde Frage hat mit dem Betrieb von Kraftwerken zu tun.
Die Frage, die zu erörtern wäre, hat mit dem Betrieb von Kraftwerken zu tun.
Sie sehen, Verständlichkeit hat nicht immer mit Länge zu tun.
Textaufbau
Die innere Struktur muss stimmen, klarer Fall. Dafür haben Sie bereits gesorgt. Auch dem Leser sollte die Struktur eingängig sein. Bei einem Artikel sind es Zwischenüberschriften, Listenpunkte, Hervorhebungen, vielleicht auch Tabellen, natürlich auch eine aussagekräftige Überschrift.
Denken Sie gut über Überschriften nach, das ist das Erste, was der Leser sieht, womit Sie ihn anlocken. Machen Sie Entwürfe, feilen Sie daran, verwerfen Sie alles und beginnen wieder von vorne. Lassen Sie sich Zeit.
Beispiel:
Sie beschreiben Photovoltaikanlagen und unterteilen das Kapitel „Solare Anwendungsformen" in:
Solarzellen und Solarzellenmodule
Dünnschichtmodule
Kristalline Module
Modulqualität ...
Sie können aber schon gleich mehr Informationen liefern:
Solarzellen und ihre Anwendung:
Vielzahl an Solarzellen
Dünnschichtmodule mit weniger Wirkkraft
Kristalline Module mit guten Montagemaßen
Module für mitteleuropäisches Wetter
...
Aus den Überlegungen resultiert ein kluges und eingängiges Inhaltsverzeichnis.
Falls erforderlich fügen Sie eine Literaturliste mit Ihren Quellen ein, vielleicht Fußnoten. Sie fertigen ein Stichwortverzeichnis an, nichts Kreatives, aber Aufwendiges. Den Aufbau können wir besprechen. Das Layout passen Sie Ihrem Firmenauftritt an.
Illustrationen, Medien
In der Regel werden Artikel mit Illustrationen angereichert, Veröffentlichungen im Web mit Videos, wissenschaftliche Vorträge mit allem.
Bei verschiedenen Bedienungsanleitungen ersetzen Zeichnungen ganz und gar schriftliche Anweisungen. Wir kennen das ja von den Zusammenbauplänen von Möbelhäusern.
Doch in der Regel benötigen wir Erläuterungen, Handlungsanweisungen, passend zu den Illustrationen. Zumindest eine Bildunterschrift oder eine Einführung vor dem Video.
Beliebt sind Video-Tutorien. Ich mag sie nicht so gerne, weil ich Filme nicht querlesen kann. Als ich meinen derzeitigen Drucker installiert habe, war ich schon fertig, da hat der junge Mann im Film noch die Verpackung entsorgt. Sorry, war aber ähnlich. Nichtsdestotrotz, auch die Filme müssen getextet werden, ein Drehbuch, eine Struktur ist vonnöten. Zumindest sollten Sie sich Gedanken über den Ablauf machen, auch über die Länge. Genau wie bei anderen Texten.
Beispiele in den ersten beiden Videos geht es um Drucker, im dritten um Calibre (Verwalten/Erstellen von E-Books):
1. https://www.youtube.com/watch?v=p27pNcUyqDA
2. https://www.youtube.com/watch?v=-Hy631NyJlQ
3. https://www.youtube.com/watch?v=bG1qt0kiAiE
Meine Beurteilung:
zu 1. Zu viel Vorrede, der Drucker steht lange verpackt auf dem Tisch. Und wird jetzt Stück für Stück entblößt, wobei der Moderator auch noch gespannt darauf ist, was sich darin befindet. Ich vermute ein Drucker. An der Stelle war ich draußen. Doch wie die Kommentare zeigen, vielen gefällt es. Dennoch: Bleiben Sie kurz und knapp, schreiten Sie schnell voran, denn Ihre Zuschauer haben nicht die Zeit, sich lange mit dem Thema zu beschäftigen, sie wollen so schnell wie möglich mit dem Drucken beginnen.
zu 2. Der junge Mann hier geht sehr flott vor: Ausgepackt ist bereits und er setzt voraus, dass Sie die passenden Funktionen im Rechner bereits aufgerufen haben. Bei Letzterem wäre eine knappe Hinführung doch angeraten. Mir gefällt die zweite Version viel besser. Doch bestimmt gibt es eine Version, die zwischen 19 (erstes Beispiel) und 2 Minuten (zweites Beispiel) liegt.
3. Der Moderator, der im Hintergrund bleibt, macht genaue Angaben über die Voraussetzungen, das ist schon mal gut. Es geht um Calibre, zum Verwalten und Erstellen von E-Books, eine Einführung für Neulinge. Er beginnt mit dem Download, was wohl nicht unbedingt sein muss. Ein Download wird einem doch, sucht man im Netz nach einer Software, sehr schnell offeriert und es ist auch ohne Umstände durchzuführen. Nach der Einführung geht es flott weiter.
Hier finden Sie die Ausführungen zum Herunterladen als PDF.
Haben Sie bis hierhin Fragen? Melden Sie sich bei mir! Wir können jederzeit ein Informationsgespräch führen.