Was unterscheidet denn nun das technische Schreiben von, sagen wir mal, dem Schreiben eines Romans oder eines Zeitungsartikels? Gar nicht soviel wie man meinen könnte, wie wir sehen werden.
Für die Qualität eines technischen Textes gibt es eine einzige zentrale Meßlatte: die effektive Verständlichkeit. Die wichtigste Frage ist also ,,Wieviel von der erwünschten Aussage kommt beim Leser im Endeffekt tatsächlich an¿`. Diese Verständlichkeit entsteht aus verschiedenen Beiträgen, die in den folgenden Abschnitten kurz diskutiert werden:
Zuallererst muß natürlich der Inhalt des Dokumentes selbst verständlich sein. Die allererste Voraussetzung dafür ist, daß der Autor das Thema des Textes wirklich verstanden hat; es ist aber durchaus nicht schlimm, wenn das erst im Verlauf des Schreibens eintritt. Die zweite Voraussetzung ist, daß die Verständlichkeit nicht nur irgendwie und im Prinzip gegeben ist, sondern tatsächlich -- und zwar für das Zielpublikum, das den Text lesen sollte.
Damit kommen wir zum Problem von Abdeckung und Detaillierungsgrad: Wo muß ich mit dem Erklären anfangen, was darf ich voraussetzen (Abdeckung) und wie genau muß eine Erklärung sein (Detaillierungsgrad)? Die wichtigste Erkenntnis lautet: Das kann man nie ganz richtig machen. Für eine gute Auslegung muß man vor allem sein Publikum und dessen Vorwissen gut kennen. Ist das nicht erreichbar, muß man versuchen, möglichst viele Zielgruppen zugleich anzusprechen, indem man im Text klar kennzeichnet, welche Teile für welche Breite und Tiefe von Informationsbedürfnis gelesen werden müssen -- und natürlich diese Teile überhaupt erstmal voneinander trennt.
Ein zusätzliches Problem ist häufig der Platzmangel, der zu überkurzen Erklärungen und Formulierungen verleitet. Hier gilt meist die Regel ,,Weniger ist mehr``: wenige gut erläuterte Fakten sind allemal nützlicher als viele unverständliche. Die Wahl von Abdeckung und Detaillierungsgrad ist Teil eines allgemeineren Problems, der Adäquatheit, das unten angesprochen wird.
Eine Schlüsselstellung für die Verständlichkeit nimmt eine geschickte Organisation des Dokuments ein. Das Ziel besteht darin, eine schnelle Erfassung des Wesentlichen auch ohne komplettes Lesen des Dokuments zu ermöglichen. Es soll also die Möglichkeit zum effektiven ,,Querlesen`` geschaffen werden. Dies gilt nicht nur für das Dokument im ganzen, sondern ebenso für jeden einzelnen seiner Abschnitte.
Querlesen ist deshalb wichtig, weil ein technischer Text fast immer erheblich mehr Information enthält, als der überwiegende Teil der Leserschaft benötigt. Der Leitgedanke ist folgender: Das Dokument soll einen Service für den Leser erbringen, nämlich ihm Informationen zu übermitteln, die er benötigt. Dieser Service ist umso besser erbracht, je schneller der Leser oder die Leserin diese und nur diese Informationen aus dem Gesamtdokument extrahieren kann.
Das Hauptmittel einer guten Textorganisation ist eine logische Struktur und Abfolge der Teile. Logisch bedeutet dabei, daß es eine einfache Begründung oder Herleitung für gerade die gewählte Struktur gibt, die der Leser schnell nachvollziehen kann. Wenn der Leser ebendies auch tut, dann ist die Textorganisation erfolgreich. Das beste Mittel, den Leser zum Nachvollziehen der Struktur zu bringen, besteht darin, die Begründung oder Erläuterung der Struktur in der Einleitung des Textes oder Textabschnitts explizit in knapper Form aufzuschreiben.
Weitere technische Mittel zu einer guten Textorganisation sind: Treffende Überschriften, Inhaltsverzeichnisse, Schlagwortindex und andere Verzeichnisse, sowie Querverweise.
Im Inneren eines Textabschnitts lautet die wichtigste Regel für eine gute Textorganisation: Nur ein Gedanke pro Satz! Wenn diese Gedanken dann eine nachvollziehbar logische Abfolge bilden, ist die Verständlichkeit des Textes schon fast gesichert.
Die Verständlichkeit eines Dokuments ist gleich Null, wenn niemand es liest. Niemand liest gern uninteressantes Material. Als Konsequenz aus diesen beiden Aussagen ergibt sich unmittelbar, daß ein technischer Text interessant sein muß -- naja: sein sollte.
Und wie schafft man das? Dazu gibt es eine Fülle von Regeln, zum Beispiel aus dem Journalismus: Das Wichtigste zuerst; schreibe verständliches Deutsch (Ha, ein Ringschluß!); liefere etwas Neues; und so weiter [Sch82]. Leider reichen alle diese Regeln bei technischen Texten oftmals nicht aus; selbst wenn sie alle eingehalten werden, kann das Ergebnis steril und langweilig sein.
Den Unterschied zwischen Gähn! und Staun! machen häufig die folgenden zwei kleinen Tips:
Die zweite Regel ist ein klares Votum für die Benutzung der ersten Person. Die meisten Leute schreiben in wissenschaftlichen Arbeiten und ebenso in technischen Dokumenten aller Art entweder ganz unpersönlich, oder sie verschanzen sich hinter der scheinbar neutralen dritten Person und schreiben ,,die Autoren``, wo sie ,,wir`` meinen oder ,,der Autor``, wo sie ,,ich`` meinen.9.1 Ich plädiere dafür, wirklich ,,ich`` oder ,,wir`` zu schreiben, wenn man das meint. Wenn man das tut, fällt die Befolgung der ersten Regel nämlich leichter und der Leser merkt viel eher, daß da ein menschliches Wesen schreibt. Das tut der Interessantheit gut, weil der Text an Lebendigkeit gewinnt.
Und falls sich irgendwo die Gelegenheit ergibt, ein bißchen Humor in einem Sachtext unterzubringen, wird das der Interessantheit nicht schaden -- aber bitte nur, wenn es auch hinpaßt.
Selbst wenn ein Dokument einen korrekten, verständlichen Inhalt hat, gut organisiert und interessant geschrieben ist, stellt sich noch eine wichtige Frage: Ist er auch angemessen?
Jedes technische Dokument sollte einen möglichst genau bestimmten Zweck haben und muß sich fragen lassen, ob es diesen effektiv und effizient verfolgt. Dagegen gibt es drei Haupthindernisse:
Folglich muß der Zweck eines Dokuments beim Schreiben als zentrale Leitlinie jederzeit im Auge behalten werden.
Über diese Hauptanforderungen (Inhalt, Organisation, Interessantheit, Adäquatheit) hinaus sind folgende Unterpunkte von Belang:
Einer der größten Feinde von Verständlichkeit sind Fehler. Dies ist für den Inhalt offensichtlich: Wenn die Fehler innere Widersprüche hervorrufen, geht die Verständlichkeit verloren, andernfalls wird beim Leser ein falsches Verständnis erzeugt. Aber auch auf der Ebene des Sprachstils ist Korrektheit notwendig, da sprachliche Fehler die Aufmerksamkeit vieler Leser stark ablenken und dadurch effektiv die Interessantheit des Textes verschlechtern.
Zur Rolle der Korrektheit in Rechtschreibung, Zeichensetzung und Grammatik kann man drei Haupttypen von Haltungen unterscheiden: Die Vorschreiber bestehen darauf, unbedingt an jeder Stelle alle Regeln genau einzuhalten; jeden kleinsten Fehler kreiden sie dick mit rot an und regen sich furchtbar über jeden Text auf, der zu viele davon aufweist. Die Zulasser nehmen die gegenteilige Haltung ein: ,,Ist doch egal, ob das so stimmt oder nicht. Hauptsache, man kann es verstehen.``. Dazwischen liegen die Pragmatiker, die zwar Korrektheit anstreben, aber auch abweichende Lösungen zulassen bzw. diejenige auswählen, die ihnen im vorliegenden Fall am angemessensten erscheint. Die gleichen Haltungen gibt es auch im Bezug auf Stilregeln wie die unten aufgeführten.
Ich halte die Vorschreiber-Haltung für kleinlich und ineffizient: Man kann seine Energien fast immer für etwas anderes einsetzen, das wesentlich nutzbringender ist. Bei Stilregeln kann zudem ihre sklavische Einhaltung auch zu schauerlich schlechten Resultaten führen. Die Zulasser-Haltung andererseits ist gefährlich für die Verständlichkeit, denn für einen anderen Leser kann eine Unkorrektheit hinderlich für das Verständnis sein, auch wenn sie es für mich nicht ist. Ich halte deshalb einen gesunden Pragmatismus für die einzig sinnvolle Haltung.
Zumeist ist das wichtigste Mittel zum Erreichen einer adäquaten Form, das Dokument bei gegebener Organisation so knapp wie möglich zu halten. Das bedeutet nicht, Sätze zu verstümmeln oder alle weniger wichtigen Fakten einfach wegzulassen, sondern nur, Ausschweifungen zu vermeiden -- was den meisten Schreibern gar nicht leicht fällt. Insbesondere sollte inhaltliche Redundanz nur sehr gezielt dort eingesetzt werden, wo sie wirklich nötig erscheint.
Unzählige Bücher befassen sich mit dem Thema der guten, verständlichen Schriftsprache. Es sei jedem empfohlen, sich mindestens eines davon zu Gemüte zu führen, z.B. das sehr unterhaltsame ,,Deutsch für Profis`` [Sch82].
Ich stelle hier nur kurz die allerwichtigsten Regeln zusammen, nicht mit Blick auf sprachliche Korrektheit, sondern auf Verständlichkeit und Interessantheit.
1. Es gibt Sätze der richtigen Länge; nicht zu lang, aber auch nicht zu kurz. Wenn man seine Sätze kritisch prüft, kann man sich da einfach auf sein Gefühl verlassen. Also zum Beispiel bitte nicht
In den meisten Fällen ist es das wichtigste Mittel zum Erreichen einer adäquaten Form, wenn man sich bemüht, das Dokument bei gegebener Organisation so knapp wie möglich zu halten, was aber nicht bedeutet, Sätze zu verstümmeln oder alle weniger wichtigen Fakten einfach wegzulassen, sondern nur, Ausschweifungen zu vermeiden, was den meisten Schreibern gar nicht so leicht fällt.und auch nicht
Meist ist das wichtigste Mittel für Adäquatheit: Knapphalten. Das bedeutet nicht, Sätze zu verstümmeln. Auch nicht, alle weniger wichtigen Fakten einfach wegzulassen. Es bedeutet nur, Ausschweifungen zu vermeiden. Das fällt den meisten Schreibern nicht leicht.sondern eher wie oben im Abschnitt 9.1.6 über die Knappheit gelesen.
2. Kauderwelsch vermeiden, auch wenn es ,,im Fach`` üblich erscheint. Oft gibt es ein gutes und verständliches deutsches Wort für ein Fremdwort oder einen englischen Fachbegriff. Dokumentspezifisches Fachvokabular knapp und ordentlich einführen und dabei nach Möglichkeit deutsche Begriffe verwenden -- diese Möglichkeit besteht durchaus nicht immer. Abschreckendes Beispiel:
Um den Workflow managen zu können, muß das System write-Zugriff auf alle Records der User-Datenbank haben, um auch die von den Pointern referenzierten Felder updaten zu können.Übertrieben? Zumindest nicht sehr. Besser wäre es jedenfalls zum Beispiel so:
Um den Arbeitsablauf verwalten zu können, muß das System Schreibrecht für alle Sätze der Benutzerdatenbank haben, um auch die über Zeiger angesprochenen Felder aktualisieren zu können.
3. Einfache Wörter oder Formulierungen sind besser als pompöse. Auch ohne Kauderwelsch kann man sich verklausulieren. Sehr oft sieht man Formulierungen wie
Zu diesem Zeitpunkt erfolgt die Darstellung des Fensters. Hinsichtlich der Effizienz ist es vorzuziehen, die Variable zur Verwendung zu bringen, als einen Prozeduraufruf durchzuführen.Au weia, denn es ginge ja auch so:
Nun wird das Fenster angezeigt. Die Variable zu benutzen, ist effizienter als ein Prozeduraufruf.Auch betont exotische oder altmodische Wörter sollte man lieber vermeiden.
4. Aktiv ist besser als Passiv. Passivsätze werden typischerweise im Amtsdeutsch verwendet; von ihnen wird ein steifer und lebloser Eindruck auf den Leser ausgeübt. Ein aktiver Satz hingegen lebt und zieht den Leser mit in den Text hinein. (Übung: Warum steht hier kein Beispiel?)
5. Verben sind besser als Substantive. Also nicht
Ein Erfordernis für die Darstellung des Fensters ist die vorherige Aktualisierung des Widgets.sondern lieber
Um das Fenster darzustellen, muß man zuvor das Widget aktualisieren.
Von allen diesen Regeln gibt es naturlich Ausnahmen. Siehe die Diskussion über Korrektheit oben.
Als einen besonderen Aspekt von Interessantheit sollte man anstreben, daß auch ein technischer Text ästhetisch befriedigend ist. Wenn man dies erreicht (das ist aber schwer!), kann daraus eine Zugeneigtheit der Leser erwachsen, die die Interessantheit und damit die effektive Verständlichkeit enorm erhöht. Merke: Beruf und Vergnügen können (und sollten) durchaus gemeinsam auftreten!
Um zu der zu Beginn gestellten Frage zurückzukehren: Das Schreiben eines technischen Dokumentes ist insofern fast das gleiche wie das Schreiben eines Zeitungsartikels, als die effektive Verständlichkeit im Mittelpunkt steht. Die Anforderungen sind sogar recht ähnlich denen für das Schreiben eines guten Romans; allerdings muß beim technischen Text im Konfliktfall (aber auch nur dann) die Korrektheit und Knappheit stets der Schönheit vorgezogen werden.