Technisches Schreiben

18.1.2017

Im Rahmen des 43. Linzer Technologieplauscherls besuchte das AppRaum Team einen Vortrag über technisches Schreiben.

Ein Softwareentwickler ist es gewohnt täglich mehrere hundert Zeilen Programmcode zu tippen, selten aber steht man vor der Herausforderung ein Buch über komplexe technische Zusammenhänge zu schreiben.

Als sich Stefan Baumgartner die Gelegenheit bot für den Manning-Verlag ein Buch zu schreiben, zögerte er aber nicht lange und berichtete uns nun von seinen Erfahrungen:

  • Am besten beim Inhaltsverzeichnis beginnen und somit einen roten Faden durch Kapitel und Unterkapitel ziehen
  • Ein Bild sagt mehr als tausend Worte: nach der Kapitelstruktur die Kerninformation eines Kapitels wenn möglich grafisch darstellen. Die Grafiken nach Bedarf langsam erweitern während man sie im Laufe des Kapitels näher erklärt.
  • Technische Informationen zu anderen Technologien nicht in einem eigenen Kapitel erklären, sondern da wo sie der Leser das erste Mal benötigt.
  • In guten technischen Büchern steckt auch eine kleine Geschichte. Durch Cliffhanger an Kapitelenden (wie man sie von Serien kennt) wird der Leser motiviert weiterzulesen.

Kerstin Breiteneder bekam am Ende ein kostenloses Exemplar seines Buches Front-End Tooling with Gulp, Bower and Yeoman geschenkt.

Wir waren nicht nur vom unterhaltsamen und informativen Vortrag begeistert, man merkt auch wieviel Know-How und Arbeit in seinem Buch steckt!