tekom-Jahrestagung 2008: Beitrag im Tagungsband

10. November 2008, 22:45 Uhr Frank

Technische Redakteure als Autoren eines Sachbuchs für Open-Source-Software

  • Wie man als Technischer Redakteur dazu kommt, ein Sachbuch zu schreiben
  • Was einen Autor beim Dokumentieren von Open-Source-Software erwartet
  • Das »Für Dummies«-Konzept und seine Benutzerfreundlichkeit
  • Unterschied zwischen Sachbuch und klassischer Bedienungsanleitung
  • Tipps zum Schreiben von Sachbüchern

Theresa Rickmann, Hochschule Karlsruhe – Technik und Wirtschaft
Frank Ully, Hochschule Karlsruhe – Technik und Wirtschaft

Wie man als Technischer Redakteur dazu kommt, ein Sachbuch zu schreiben

Die Autoren studieren Technische Redaktion an der Hochschule Karlsruhe – Technik und Wirtschaft. Bei einer Studienarbeit entstand ein Einsteiger-Tutorial für das Open Source Web-Content-Management-System Joomla. Mit Joomla kann man ohne Programmierkenntnisse schnell eine professionelle Website erstellen und verwalten. Im Januar 2006 veröffentlichten die Autoren das Tutorial im Internet zum kostenlosen Download. Es hat sich als Einstiegslektüre für deutschsprachige Joomla-Anfänger etabliert. Durch den Erfolg wurden mehrere Verlage auf die Autoren aufmerksam. Im Juli 2008 erschien »Joomla! für Dummies« in der bekannten gleichnamigen Sachbuchreihe.

Was einen Autor beim Dokumentieren von Open-Source-Software erwartet

Open-Source-Software ist kostenlos und kann von jedem – auch kommerziell – genutzt werden. Der Quelltext ist offen gelegt, das heißt, er darf bearbeitet und weiterverbreitet werden. Die Software wird von einer Gemeinschaft aus Freiwilligen ständig weiter entwickelt.

Der Open-Source-Ansatz hat für die Softwareentwicklung viele Vorteile, die sich für die Dokumentation jedoch in mancher Hinsicht nachteilig auswirken.

Das unzureichende zentrale Management und die verstreuten Entwickler-Teams führen zu folgenden Problemen:

  • Fehlende und unzuverlässige Veröffentlichungstermine
  • Terminologische Inkonsistenz in den Übersetzungen der Benutzeroberfläche
  • Sprachdateien und Erweiterungen erscheinen irgendwann nach der Veröffentlichung der Software

Dadurch ist das Dokumentationsprojekt in vielen Punkten nicht verlässlich planbar. Die genannten Nachteile treten zwar auch in der normalen Softwareentwicklung auf, zeigen sich aber bei Open-Source-Software sehr viel deutlicher.

Um diese Probleme abzuschwächen, dokumentierten die Autoren anhand einer Vorabversion (Beta-Version) und warteten mit der Veröffentlichung des Buchs, bis eine verlässliche Softwareversion und Sprachdateien verfügbar waren. Zum Schluss wurden sämtliche Kapitel noch einmal korrekturgelesen, Screenshots ausgetauscht und die Terminologie wurde überprüft.

Das »Für Dummies«-Konzept und seine Benutzerfreundlichkeit

In Deutschland werden die »Für Dummies«-Bücher vom Verlag Wiley-VCH, Weinheim verlegt. Sie richten sich an Einsteiger. Weltweit wurden mehr als 200 Millionen Bücher zu Tausenden Themen verkauft, von Wirtschaft über Software bis hin zu Religion. Die Software-Bücher zeigen eine große Ähnlichkeit zu klassischen Bedienungsanleitungen (ähnliche Textsorte, Erklärungen ohne Fachchinesisch, Tipps und Warnhinweise). Das Erfolgsrezept der »Für Dummies«-Reihe sind Verständlichkeit und Humor.

In einem Usability-Test wollten die Autoren unter anderem herausfinden, wie sich Humor in didaktisch-instruktiven Texten auf die Benutzerfreundlichkeit auswirkt. Dazu testeten sie ein »Für Dummies«-Buch zu einem Grafikbearbeitungsprogramm mit 16 Probanden. Mehrheitlich wurden humorvolle Texte nicht nur akzeptiert, sondern auch gegenüber sachlich formulierten bevorzugt. Es zeigte sich, dass Humor die Hemmschwelle, den Text zu lesen, herabsetzen kann und dadurch Einsteigern die Angst vor dem Thema nimmt. Wo schnelles Erfassen der Informationen gefragt ist, wie bei Überschriften im Inhaltsverzeichnis, sollte allerdings sachlich formuliert werden. Außerdem ist Humor eine subjektive Angelegenheit und muss mit Bedacht eingesetzt werden.

Unterschied zwischen Sachbuch und klassischer Bedienungsanleitung

Der wohl wichtigste Unterschied: Sachbücher werden gelesen. Sachbücher sind nicht Beilage zu einem Produkt, sondern werden als eigenständiges Produkt ver- und gekauft. Damit ist auch eine ganz andere Erwartungshaltung verbunden: Die Leser sind von Anfang an motiviert, sich mit dem Thema und dem Text auseinanderzusetzen. Diese Erwartung muss der Autor erfüllen. Hierbei kommt es nicht nur auf das sachlich richtige Darstellen der Inhalte an, sondern auch darauf, Leseanreize zu setzen. Das ist umso wichtiger, da die Bücher in der Regel von vorne bis hinten gelesen werden und nicht selektiv wie Bedienungsanleitungen.

Tipps zum Schreiben von Sachbüchern

Generell kann man feststellen, dass viele Konzepte aus der klassischen Technischen Dokumentation ebenso vorteilhaft beim Schreiben von Sachbüchern sind. Dazu zählen vor allem die Trennung von Beschreibung und Anleitung, Schritt-für-Schritt-Anleitungen anstelle von Fließtext und Terminologie-Management. Als Autor muss man sich zwar an einigen Vorgaben des Verlags orientieren, diese reichen jedoch oft nicht aus. Es empfiehlt sich, einen Redaktionsleitfaden mit Festlegungen zu Terminologie und Formulierungsmustern zu erstellen – besonders, wenn mehrere Autoren an einem Buch schreiben.

Zum Weiterlesen

Erschienen in: tekom (Hrsg.) (2008): Jahrestagung 2008 in Wiesbaden : Zusammenfassung der Referate. Stuttgart : tekom.

Thema: Technische Redaktion
Stichwörter: , , , , , , ,

Gefällt Ihnen dieser Artikel? Abonnieren Sie neue Artikel als RSS-Feed!


Abonnement
Buch »Joomla! für Dummies«
Themen
Aktuelle Artikel
Ähnliche Artikel wie tekom-Jahrestagung 2008: Beitrag im Tagungsband
Lizenz

Creative Commons License
Die Texte und Bilder dieses Blogs »Joomla! für Dummies« sind unter einer Creative-Commons-Lizenz lizenziert.

blogoscoop