Document ID: /fineweb-2-swissfilter-quality_10-filterrobots/filtered/03136.jsonl.gz/238

Irgendwann wie Stevens schreiben
Jeder will sie - kaum jemand schreibt sie: Die klare, verständliche, lesbare technische Dokumentation. Wie schreibt man gute technische Dokumentation? Was ist das eigentlich, "gutes Schreiben"?
Gut schreibt, wer verständlich schreibt. Gut schreibt, wer seine Aussage in einen Satz mit höchstens einem Komma und höchstens einem Fremdwort steckt. Gut schreibt, wer oft und viel schreibt, wer schreiben übt. Gutes Schreiben ist weder eine exklusive Begabung noch eine geniale Inspiration: Schreiben ist Handwerk und es gibt einfache Regeln für gutes Schreiben und deswegen kann man Schreiben lernen. Für alle Textarten wendet man ein Set von Regeln an - egal, ob über Technik, über Philosophie oder Tagebuch geschrieben wird: Die erste Regel lautet: Kein Passiv. "Tagebuch geschrieben wird" - von wem denn? Warum bloss? "Ein Segfault wurde ausgelöst." Von wem? Durch welches Problem? Was war die Ursache? Nicht umsonst haben Sätze ein Subjekt (der "Agent", der Handelnde) und ein Objekt (das, worauf sich die Handlung bezieht) und ein Prädikat (das Verb). Passiv benutzt man dann, wenn kein Subjekt vorhanden ist - und das kommt wirklich selten vor. Ein einfaches Syntaxhighlighting im Lieblingseditor genügt, um seinen Stil sofort klarer zu gestalten. Da, ein verstecktes Passiv! Wer gestaltet da was klarer? Mit dem Syntaxhighlighting in Vim oder Emacs kann der Autor schlechten Stil und Passiv hervorheben. Schon präziser!
Gerade bei komplizierten Beschreibungen von Technik will der Leser Klarheit und Präzision, nein halt: Genauigkeit. Wieso ein Fremdwort verwenden, wenn man keins braucht? Also, der Leser will Klarheit und Genauigkeit. Unmissverständlich. Das ist die zweite Regel: Nicht sloterdijken und nicht habermasen! Moderne Philosphie - ich nenne es postmodernes Hirnwichsen - ist oft unlesbar: "Das Subjekt erzeugt in seiner metaphsysischen Relevanz ein reziprokes Rhizom zur Deprivation seiner Selbst." Das muss nicht sein: Viele berühmte Philosophen kommen ganz ohne Fremdworte und gedrechselte Sätze aus, weil ihr Ziel Klarheit war. Natürlich kann man auch technische Phrasen dreschen - Handbücher und Howtos sind voll davon. Autoren vergessen gern, dass Leser Bücher und Texte verstehen wollen. Man schreibt einen Text für einen Leser, nicht gegen ihn.
Zusammengefasst: Kein Passiv, so einfach und klar wie möglich. Das ist sehr schwierig und klingt am Anfang ungewohnt - ist denn nicht nur kompliziertes Schreiben gutes Schreiben? Ist nur was wissenschaftlich klingt auch eine Wissenschaft? Nein. Unsinn. Hemingway hat 1954 den Nobelpreis für seine Sammlung von Subjekt - Objekt - Prädikat Sätzen bekommen und was für Hemingway gut war, sollte für uns ausreichen. Jeder Stevens macht es uns vor: Klare Sätze. Niemals länger als 2, höchstens 3 Zeilen. Jeder Satz bestückt mit Wissen. Wer Grammatik beherrscht wie Thomas Mann darf mehr als 3 Zeilen schreiben. Der Rest von uns bleibt unter 3 Zeilen Satz und trennt, sobald er einen Relativsatz beginnt, den Satz in mehrere Sätze auf. Also: Der Rest von uns bleibt unter 3 Zeilen Satz. Sobald er einen Relativsatz beginnt, trennt er ihn in zwei Sätze auf. Damit erspart man sich auch lästige Kommaregeln. Die braucht man nämlich nicht, wenn kein Komma notwendig ist.
Das zeigt uns die nächste Falle: Nicht schwafeln, sondern informieren. Es gibt im Deutschen eine Sammlung Nullwörter, die man in beliebiger Menge in Texte einstreuen kann: Wirklich, nun, ja, gar, so, ungefähr - alle Worte, die bereits durch den Wortsinn einleiten, dass jetzt etwas folgt, was ungenau ist: "Ungefähr" ist eine ungenaue Zeit- oder Mengenangabe. "Der Compiler braucht ungefähr drei Stunden". Wie wäre es stattdessen mit: "Ist die CPU schneller als 1 GHz, braucht der Compiler 2.45 Minuten, ist die CPU langsamer, dauert der Durchlauf 3.30 Minuten. Mit einem 486er wirft man den Compiler besser gleich über Nacht an." Na also. Jetzt weiss der Leser, was ihn wirklich erwartet!
Ebenso überflüssig: Adjektive. Da fällt es den meisten Schreibern schwer, auszumisten, denn Adjektive machen den Text schwungvoll und lebendig. Das erscheint nur auf den ersten Blick so: Adjektive machen den Text schwülstig und langatmig und quetschen das letzte Fünkchen Phantasie aus dem Leser - bloss nicht selbst die Leidenschaft vorstellen, lieber hinschreiben: "Leidenschaftlich und wild küsste er ihren herrlich gerundeten Bauchnabel, sie stöhnte tief und .." Damit gewinnt man den Bastei-Lübbe Billigpreis. Verben machen den Text lebendig, denn mit Verben drückt man Bewegung und Handlung aus. Wieso nicht besser schreiben: "Er fickte sie, sie biss zurück und schrie dann in die Nacht hinaus." Wie sie es nun machen, bleibt der Vorstellung des Lesers überlassen. In technischen Texten spart man sich analog Adjektive wie "der tolle Editor" - wär' er Mist, würde man keinen Artikel schreiben. "Der grossartige Compiler" oder auch der "schnelle Compiler" sind genauso überflüssig: Schnell in Bezug auf was? Warum bewertet der Autor den Compiler als grossartig? Stattdessen nennt man die Vorzüge, die einen Compiler oder Editor aus der Masse der anderen Produkte hervorheben: "Das höppelgewöppte Doppelnipp macht den gcc zu einem schnellen Compiler. Alle anderen Compiler schnöppen nur das Huppelwupp und das macht sie langsam, weil kein Dippelschnipp optimiert wird." Na gut. Ein Passiv. "weil keine Funktion für optimiertes Dippelschnipp existiert." Oder noch besser: "Weil kein Entwickler die Funktion zum optimierten Dippelschnippen implimentiert hat." Ah. Das Feature fehlt also!
Entschuldigung - "diese Fähigkeit" fehlt also. Die goldene Regel für Anglizismen lautet: Anglizismen nur dann verwenden, wenn der englische Ausdruck ein wichtiges Stichwort ist, unter dem man eine Suchmaschine befragen kann oder die Übersetzung Unsinn ergibt: Die Suche nach "Übersetzer" fördert andere Links zutage als die Suche nach "Compiler" und deswegen bleibt ein Compiler bei mir ein Compiler. Allerdings schreibe ich: "Ich lade den Compiler unter ftp.bla.de" herunter und nicht: "Ich downloadete den Compiler unter ftp.bla.de". So bleibt bei mir auch ein Array und Hash in Perl ein Array und ein Hash - schreibe ich aber allgemein über Listen, schreibe ich "Listen" und nicht etwa "Arrays". Ich entscheide von Fall zu Fall - brauche ich eine eingedeutschte Verbform, fliegt der Anglizismus raus und ich versuche, eine gute Übersetzung zu finden. Nochmal alle Tipps zusammen: Kein Passiv, klare, einfache Sätze, wenig Fremdwörter, Adjektive wegstreichen, stattdessen Verben verwenden und Anglizismen nur dort verwenden, wo sie unverzichtbar sind. Fehlt noch was?
Ja! Eine Fähigkeit der deutschen Sprache ist die Nutzung der Anwendung von der Substantivierung von Verben! Oft schreiben unerfahrene Autoren, um seriöser zu klingen, Sätze wie diesen: "Durch die Compilierung wird die Software zu einem Binary" - das geht klarer und einfacher: "Der gcc (Subjekt - Wer?) kompiliert (Verb - was passiert?) die Sourcen (das Objekt - Wen?) zu einem Binary (Ziel der Aktion)." Jetzt weiss man, wer was mit welchem Ziel tut. Mein Satz geht auch noch knapper: "Oft schreiben unerfahrene Autoren" .. Wer da was tut, taucht erst spät im Satz auf: "Unerfahrene Autoren schreiben oft.." oft? Weg damit. "Unerfahrene Autoren schreiben Sätze mit substantivierten Verben, um seriöser zu klingen:" Na also. Wer tut was womit und zu welchem Zweck? Alle Fragen beantwortet.
Die goldene Regel lautet: Wegstreichen, kürzen, rauswerfen! Ein Text gewinnt fast immer, wenn der Autor rigoros kürzt. Satz zu lang, mehr als 2 Kommata und keine Aufzählung? Zwei Sätze draus machen. Zuviele Adjektive? Raus damit, durch Verben ersetzen. Substantivierte Verben und Fremdworte? Geht alles knapper, klarer, genauer: Weg damit. Anfangs erscheint der Satz dann abgehackter - man könnte auch sagen: knackiger, kürzer und daran muss man sich erst gewöhnen. Wie erkennt man auf einen Blick problematische Wortgruppen?
Passiv: wird, wurde, geworden, gemacht sind typische Formen, die ganz sicher in einem Passivsatz ohne Subjekt enden. Kann man die Frage "wer macht da was?" klar beantworten, hat man ein Subjekt und dann soll man es auch hinschreiben.
Fremdwörter: Fremdwörter enthalten bestimmte Endungen, die man gut hervorheben kann: -ismus, -tät, -ierung, -tion, -tor. Fast jedes Fremdwort kann man durch ein passendes deutsches Wort ersetzen und so die Verständlichkeit erhöhen, ohne den Sinn zu entstellen. Nur selten ist ein Fremdwort ein klarer Fachbegriff, der unverzichtbar ist: Gastritis? Magenschleimhautentzündung. Ist zwar länger, aber -itis ist immer eine Entzündung und das Gast- irgendwas mit dem Magen des Menschen zu tun hat, weiss auch nicht jeder. Ismen benutzt man als Endsilbe für "streben nach" - Kapitalismus - streben nach Kapital, Imperialismus, streben nach Imperien. Die Silbe -tät beschreibt einen Zustand, die Silbe -ierung den Prozess dazu: "Globalität" ist der Zustand, den wir nach dem Prozess der "Globalisierung" erreichen. Deswegen sind Formulierungen wie "der Prozess der Industrialisierung" oder "der Zustand der Konformität" doppeltgemoppelt - raus damit. Der "-or" ist immer der Täter in einem Fremdwort: Terminator. Diktator. Contruktor. Imperator. Und der Täter sorgt für ein Ziel der Handlung - ein "-ion": Der Construktor sorgt für eine Construktion, der Terminator sorgt für eine Termination. Die Terminierung ist der Prozess des Terminators mit dem Ziel der Termination! Und eine Terministis ist eine akute Metallgelenksentzündung mit schwerwiegenden Folgen für die Umwelt. Eine Termite hingegen.. ok.
Nullwörter: da ja, nun, gleich, obwohl, als wenn, gar, so, "ohne weiteres", "bis hin zu", wirklich, überhaupt, sehr, je, manchmal, beinahe, nur, Gerade (am Satzanfang) kann man fast immer ersatzlos streichen. Das gleiche gilt für Marketingworte: Substantiv enthält das Wort "Substanz" - und von "Agile Programmierung" bis "Zero Administration Needed Feature" enthalten die Worte keine - raus damit.
Adjektive: Einige Adjektive sind nützlich, weil sie den Zustand, das "So-Sein" eines Wortes genauer beschreiben: Rot. Grün. Tot. Kombinationen mit einem Substantiv, dass bereits diesen Zustand suggeriert, ergeben den berühmten weissen Schimmel. Oder für Nerds: Den grünen Schimmel. Ein Schimmel IST sowieso weiss, sonst hiesse er nicht so. Eine Leiche ist tot. Deswegen hat uns der Duden das Wort "Leiche" geschenkt. Dazu kommen die schwachen Adjektive, die sich von anderen Worten ableiten: Endungen wie -lich, -haft, -sam oder -isch kommen in Worten wie arbeitssam (fleissig), lachhaft (ich lache) oder unglaublich vor: Fast immer kann man ein Verb daraus machen und erzeugt so eine Handlung und muss dann auch einen Handelnden einfügen: "Das ist unglaublich" - Was denn? Und wer glaubt da was nicht? Wieso? Wer sich nicht sicher ist, ob ein Adjektiv angebracht ist oder nicht: Rauswerfen.
Substantivierte Verben: Die Endung -ung ist ein totsicheres Merkmal. Endung kommt von enden und Hoffnung von hoffen. Deswegen kann man genauso gut schreiben: "Endet ein Wort mit der Silbe -ung.." oder "Wenn das Wort mit der Silbe -ung endet.." Zunächst erscheint es kleinlich, aber ein Substantiv in ein Verb umwandeln zwingt den Autor aus einer Compilierung ein "Wer kompiliert was" zu machen und aus einer Verkabelung ein "wer verkapelt was womit".
Für Fortgeschrittene gibt es noch ein paar mehr Regeln - die oben genannten für Einsteiger kann man mit vielen Editoren hervorheben und gleich rauswerfen, bevor man sie fertig getippt hat. Wer sich einlesen möchte: Für die deutsche Schriftsprache liest man "Deutsch fürs Leben" und "Deutsch für Kenner" von Wolf Schneider. Zu einem besseren Stil in Englisch verhilft der Klassiker "On Writing Well" von William Zinser - übrigens eine Erleichterung für jeden, der die Zeitenfolge von Relativsätzen oder Passivformen nicht mehr im Kopf hat: War ja sowieso kein guter Stil. Wer dann wissen will, wie Schriftsteller mit den Worten ringen und solche Stilmittel befolgen, dem sei Stephen Kings "Das Leben und das Schreiben" (englisch: "On Writing") ans Herz gelegt.