deesaster.org

Viele Menschen müssen heutzutage für ihre Arbeit oder ihr Hobby Dokumente schreiben. Bei der Arbeit im Software-Bereich betrifft das Designdokumente und Schnittstellenbeschreibungen (APIs), im Hardware-Bereich betrifft es eher Schaltbilder oder Pin-Belegungen. In beiden Fällen sind die Schreiber oft nicht extra dafür ausgebildet worden. Das Buch „Technisches Schreiben“ soll dabei helfen, bessere Dokumente zu verfassen.

Für wen ist das Buch gedacht?

Wie in der Einleitung geschrieben gibt es sowohl bei der täglichen Arbeit, als auch in freiwilligen Projekten viel zu dokumentieren. Kaum jemand hat die Kunst des Schreibens erlernt und tut sich mehr oder weniger schwer damit. Einige verzweifeln bereits an einer kurze Zusammenfassung oder an einer einfachen Inhaltsbeschreibung zu einem Thema. Andere haben mit der Aneinanderreihung von Wörtern keine Probleme, verstricken sich dafür aber in Wiederholungen und verlieren der roten Faden sehr schnell.

Das Buch „Technisches Schreiben“ von Christoph Prevezanos versucht dabei allen Menschen dieser breiten Fähigkeitenspanne zu helfen – und schafft dies mehr oder weniger gut. Wirft man einen Blick in das erste Kapitel, sieht man, dass sehr viel Wert auf die Einhaltung von Normen (sowohl DIN als auch ISO) gelegt wird. Die Zielgruppe, für die diese Normen eine Bedeutung haben ist aber, im Vergleich zu der gesamten schreibenden Zunft, eher klein. Manche Leser könnten sich davon sogar abgeschreckt fühlen.

Ignoriert man die Norm-Hinweise aber einfach oder sieht sie nur als nettes Beiwerk an, gibt es zahlreiche Kapitel, die jedem Dokumenten-Schreiber hilfreich sein können. Sei es z.B. bei einem Artikel für ein Magazin (wie diesem hier), einer Anleitung in einem Wiki, einem Blogbeitrag oder bei einer API-Beschreibung für ein großes Software-Projekt, den einen oder anderen Tipp kann man immer mitnehmen.

Die Zielgruppe streut sich daher sehr breit. Einige Kapitel betreffen daher nur eine eingeschränkte Zielgruppe, die an Universitäten oder Behörden beschäftigt ist. Andere Kapitel wiederum können für jeden hilfreiche Hinweise zum besseren Schreiben liefern.

Was steht drin?

Nach der Einleitung weist der Autor zunächst in Kapitel 2 auf die verschiedenen Dokumentationswerkzeuge hin. Sehr schön ist, dass nicht nur – wie bei einigen anderen Büchern – der Quasi-Standard Microsoft Office vorgestellt wird, sondern auch freie Alternativen wie Libre Office oder OpenOffice. Selbst LaTeX findet Erwähnung, wird es doch sehr häufig an Universitäten in den naturwissenschaftlichen Fächern eingesetzt.

Neben dem Standard-Schreibwerkzeug wird auf viele kleine technische Details eingegangen. Wie wichtig sind Format-Vorlagen (Antwort: Sehr wichtig!), welche Schriften sind passend und wie gestaltet man die einzelnen Seitenelemente. Leider wird hierbei sehr wenig auf Online-Medien eingegangen. So gibt es zahlreiche Formatierungshinweise für Kopf- und Fußzeilen, Seitenränder etc., die es in einem Wiki oder einem Blog in der Art nicht gibt. Hier hätte man sich vielleicht doch noch einen kleinen Exkurs in die digitale Welt erhofft, der auf die Eigenheiten beim Online-Schreiben eingeht.

Das dritte Kapitel behandelt den wichtigen Punkt der Planung. Denn oft führt wildes Drauflosschreiben nicht zu einem gut strukturiertem Text, um den es dann auch in Kapitel 4 geht. Aber auch hier geht es mehr um die kleineren technischen Details, die im wissenschaftlichen Bereich sicherlich eher gefragt sind als im normalen Berufsalltag oder für ein Hobby-Projekt.

Am interessantesten und für eine sehr große Zielgruppe am geeignetsten sind die Kapitel 5 bis 7. Kapitel 5 befasst sich sehr ausführlich mit Zitaten. Nach den letztjährigen Problemen einiger Politiker eine ordentlich zitierte Quelle anzugeben, sollte man das Thema nicht unterschätzen. Aber selbst für den normalen Alltag sind Zitate oder zumindest Quellnachweise nahezu unerlässlich. Dank dem neuen Leistungsschutzrecht und zahlreichen Abmahnanwälten sollte man sich auch als Blogger über die aktuelle Rechtslage informieren. Und der neue Kollege wird es einem danken, wenn er das Dokument, auf das man verweist, auch wirklich sofort findet und nicht erst ewig suchen muss.

Der kleine Abstecher in Sachen Interpunktion am Ende von Kapitel 5 ist ebenfalls sehr praktisch und lehrreich. Von „korrekten“ und "inkorrekten" Anführungszeichen bis hin zur richtigen Benutzung von Binde- und Gedankenstrichen – alles ist dabei.

Kapitel 6 umfasst den mit am wichtigsten, aber auch am schwierigsten Teil eines Dokuments, nämlich Sprache und Ausdruck. Beides ist etwas, was man nur mit viel Geduld, aber vor allem viel Praxis lernen kann. Konkret lernt man gutes Schreiben nicht durch das Lesen von Büchern. Neben den Grundlagen zur richtigen Wortwahl und gutem Satzbau wird auch auf die Ansprache der Leser und die Geschlechterfrage eingegangen. In beiden Punkten gibt es zahlreiche, verschiedene Meinungen, sodass man die des Autors teilen kann, aber nicht muss.

Ebenfalls interessant ist das siebte Kapitel zu Fremd- und Modewörtern. Diese sollte man nur so einsetzen, wie es das Zielpublikum auch verarbeiten kann. So deuten viele Fachbegriffe vielleicht auch darauf hin, dass man die Materie verstanden hat, aber ob man sie ebenso einem Laien vermitteln kann, ist eine andere Frage. Anglizismen werden auch behandelt, ebenso wie „falsche Freunde“, d.h. englische Wörter, die ähnlich zu einem deutschen Wort klingen, aber etwas ganz anderes bedeuten (so wie „gift“ oder „handy”).

Im vorletzten inhaltlichen Kapitel geht es um den Einsatz von Bildern und Tabellen. Hier wird auch erklärt, wie man fremde Bilder korrekt wiedergibt – etwas, was im Fazit noch eine Rolle spielen wird.

Das vorletzte Kapitel behandelt dann noch Verzeichnisse jeglicher Art und den Abschluss bieten die etwas trockenen Normen.

Ist das Buch zu empfehlen?

Die Frage nach einer Empfehlung ist schwer zu beantworten. Insgesamt lesen sich die ersten Kapitel etwas schwerer, da sie von der Thematik her auch etwas trockener sind. Wer beschäftigt sich schon gerne mit Anhängen, Fußnoten oder dem Inhaltsverzeichnis? Nutzt man diese nicht ganz korrekt, macht das in der Regel einen guten Text nicht wesentlich schlechter, auch wenn er formal nicht ganz korrekt ist.

Das ist auch etwas, worauf Christoph Prevezanos sehr oft pocht: die Einhaltung von Formen und Normen. Offen gestanden benötigt man das außer in einigen akademischen Berufen und speziellen Tätigkeitsfeldern eher weniger. Wer Dokumente nur „nebenbei“ schreibt (sei es im Berufsalltag oder im Privatleben), den wird selten interessieren, welche Normen man für Ränder oder Kopf- und Fußzeile einhalten muss. Diese Abschnitte oder Kapitel habe ich daher auch sehr schnell überlesen.

Anders ist es bei den inhaltlichen Themen. Wie baut sich ein Dokument, ein Kapitel, ein Absatz oder ein Satz auf? Welche Wortwahl ist geeignet und welche weniger? Und wie zitiert man richtig? Dies sind wichtige Hinweise, die man im Buch finden kann.

Update 08.11.2013, 18:00 Uhr: Wegen des Hinweis von Onli in den Kommentaren habe ich folgenden Absatz etwas umgeschrieben, da ich die Rechtslage auch nicht einhundertprozentig einschätzen kann. Der gestrichene Teil ist unten angegeben.

Der größte Kritikpunkt geht an das Kapitel zu der Verwendung von Bildern. Der Autor hält sich hier nämlich nicht an seine eigenen Hinweise. So wird in Kapitel 8 auf Seite 157/158 extra auf Creative-Commons-Lizenzen hingewiesen. Auf Seite 10 wird aber ein Bild von Libre Office der Document Foundation benutzt, deren Bilder aber in der Regel unter einer CC-Lizenz stehen, die nicht mit angegeben ist. Hier wird also vermutlich gegen eine Lizenz verstoßen.

Daneben wird auf Seite 14 ein Bild von Adobe FrameMaker aus der Wikipedia verwendet. Die Quelle wird zwar korrekt angegeben, das Bild selbst wird bei Wikipedia aber als „non free“ markiert. Im amerikanischen Raum fällt die Verwendung im privaten Bereich sicherlich unter Fair Use, in den deutschen Gerichtssälen gab es dazu noch kein Urteil, was die Verwendung von Screenshots mit rechtlicher geschützer Software angeht. Dennoch ist die Verwendung zumindest etwas wackelig. (Gestrichen: Dummerweise fällt dieses in den Bereich „non free“ und dürfte vor allem für den kommerziellen Gebrauch in einem Buch höchstwahrscheinlich nicht verwendet werden ohne die Rechte von Adobe zu verletzen.)

Etwas unverständlich ist auch der erste Satz in Kapitel 8.5: „Es gibt keine Bildzitate!“ Sicherlich darf man der Wikipedia nicht alles glauben, aber es gibt sogar einen extra Artikel zu dem Thema. Selbst das Landgericht Berlin hat hierzu ein Urteil erlassen, was das Zitieren von Bildern angeht. Insofern sind die Aussagen des Autors nicht verständlich.

Sieht man über diese kleineren Probleme hinweg, enthält das Buch vor allem in den mittleren drei Kapiteln einige interessante und hilfreiche Informationen. Ob es dabei hilft, ein besserer Autor zu werden, muss aber wahrscheinlich jeder für sich selbst beantworten.