Schreib-Tipps für Schule & Studium

Wieso Schreib-Tipps?

Schon mal eine zweistellige Zahl von Seiten in Rauch aufgehen sehen? Oder eine Woche Arbeit verloren? Vielleicht zwei Tage vor Abgabe festgestellt, dass Ihr alle Bildangaben nochmal umformatieren müsst? Und, und, und…
Das eigentliche Schreiben ist schon schwer genug, da solltet Ihr all die Dinge, die beim Schreiben einer Arbeit schief gehen können, nicht selbst heraus finden müssen. Dieser Blogpost ist eine Art «note to my daughter» für spätere Arbeiten. 😉

Die Tipps in diesem Post sind in keiner bestimmten Reihenfolge, sondern so, wie sie mir eingefallen sind. Die Liste erhebt auch keinerlei Anspruch auf Vollständigkeit und es gibt beispielsweise auf Twitter eine ganze Menge von Leute, deren Tipps und Tweets ich nur empfehlen kann1. Falls hier noch Tipps eintreffen oder mir noch Dinge einfallen, dann werde ich diesen Blogpost hier unten ergänzen.

Meine Erfahrungen

Vorab: arbeitet mit einem Workflow, der für Euch passt. Lasst Euch gerne inspirieren und lernt, aber befolgt nicht sklavisch irgendwelche “best practices”, ohne sie verstanden zu haben. Versucht zu Beginn einige Ansätze und bewertet die aus Eure Praxis. Hybrid ist OK, ich habe alle meine Bücher auf Papier als Zettelsammlung/Post-Its begonnen.

Terminologie ist wichtig. Legt Euch ein Glossar und ein Abkürzungsverzeichnis in einer eigenen Datei an und haltet Euch daran. Abkürzungen immer erst erklären, dann die Abkürzung einführen.

Anglizismen um der Anglizismen willen zeigen nur, dass man die eigene Sprache nicht beherrscht. Andererseits nicht krampfhaft versuchen, Sachen zu übersetzen. Niemand bei Verstand sagt mehr „Kellerspeicher“, das ist ein „stack“ ;-)

Gebt den Text jemand zu lesen, der nicht in der Materie drinsteckt. Meine Frau hat XML-Bücher lektoriert für mich, ich als IT-Mensch Durchführung von Jugend-Freizeiten für sie. Das zeigt schnell, ob Ihr für Fachidioten oder verständlich schreibt. Es gibt den geflügelten Spruch, dass viele deutsche Autoren schreiben, um zu beeindrucken und viele amerikanische Autoren, um verstanden zu werden. Da ist was dran 😉

Lernt Markdown (https://arminhanisch.de/2018/05/warum-markdown/) oder Asciidoc (http://asciidoc.org), das geht in einem Nachmittag. Rettet Euch den Hintern! :-)

Formatierungen und Layout macht der Markdown/AsciiDoc Generator (HTML, ePub, PDF, Word gibt es automatisch, das ist auch so ein Vorteil dieser Dinger). Wenn es denn eine Textverarbeitung sein soll: nur (und nochmal: nur) Formatvorlagen, nie direkt rumformatieren!

Bilder und Grafiken nie in das Dokument, sondern immer referenzieren und die Dateien mit den Grafiken in einem Ordner sammeln. Dateiformat wenn mögl. PNG oder SVG für Diagramme. Für Fotos JPG. Lernt die Unterschiede zwischen den Dateiformaten. Wenn Ihr mit Dateipfaden arbeitet, immer mit einem relativen Pfad von einem Basisordner aus arbeiten, das erlaubt das Verschieben der Arbeit an einen anderen Platz.

Besorgt Euch eine Literaturverwaltung (ich empfehle für den Anfang http://zotero.org). Vergebt eindeutige Kennungen und tragt die in den Text ein (z.B. wie hier https://simondcoll.com/references-markdown-zotero/).

Lernt zitieren und Zitatregeln, das hält Jahrzehnte! Ihr bekommt wahrscheinlich eine Vorgabe, wie Ihr zu zitieren habt, aber seid Euch darüber rim Klaren, dass es Hunderte andere anerkannte Regeln von vielen Fachpublikationen gibt, die sich je nach Branche und Fachbereich unterscheiden. Eine Literaturverwaltung nimmt Euch das Erzeugen der Bibliographie ab.

Attribuierung (z.B. für Bildlizenzen) ist wichtig und keine oder eine unvollständige Angabe verletzte die Lizenzbedingungen und damit ist es das Gleiche, als hättet Ihr nicht angegeben, nämlich eine Urheberrechtsverletzung.

Sucht Euch eine Konvention für Dateinamen. Wenn Ihr das Datum da drin haben wollt, dann nehmt das ISO-Format YYYY-MM-DD. Besser noch, nutzt eine Versionsverwaltung, dann braucht Ihr das nicht. Verschiedene Verzeichnisse für Abbildungen, Diagramme, Notizen machen die Organisation wahrscheinlich leichter.

Zur Versionsverwaltung: seht Euch z.B. http://gitlab.com oder http://github.com an und lernt die Weboberfläche. Sieht schwerer aus als es ist (notfalls hier fragen oder Tutorial googlen), wollt Ihr aber nie wieder anders haben (ist wie Google Docs auf Doping)

Fragt, fragt, fragt. Ich habe Leuten die Ohren abgekaut und dumme Fragen gestellt und jede Menge dabei gelernt. Vorher fragen ist immer besser, als hinterher korrigieren zu müssen. Lieber einmal zu viel gefragt als ein Mal zu wenig und dann Stunden damit zu verbringen, irgendwas im kompletten Text zu korrigieren.

Oh, one more thing: Backups. Backups! BACKUPS! Und nochmal: macht mindestens zwei Scheiss-Backups auf zwei verschiedenen Medien! Ich kann Euch Stories erzählen …
Ja, ich mein das ernst: macht ein Backup. Jetzt! Ich warte.

Bunkert die Backups an unterschiedlichen Orten! Nein, nicht einfach neben dem Rechner! Nein, nicht auf dem USB Stick der eh immer drin steckt! Lagert ein Backup verschlüsselt in die Cloud aus und lagert ein externes Backup an einem anderen Ort/in einem anderem Gebäude. So habt Ihr zumindest einen Grund, mal wieder die Eltern oder Freunde zu besuchen 😉


  1. Stellvertretend für alle nur einen, der mit großer Erfahrung und viel Praxiswissen schreibt: Herbert Hertramph.
Share Kommentieren
X

Ich habe einen Kommentar zum Artikel

Sie können die Kommentarfunktion ohne die Speicherung personenbezogener Daten nutzen. Schreiben Sie Ihren Kommentar und klicken Sie auf "Abschicken", der Versand erfolgt per Mail von meinem Auftritt aus an mich zur Prüfung. Dieser Versand und die Übertragung Ihres Kommentars ist zur Erfüllung der von Ihnen mit dem Klick auf "Abschicken" ersichtlichen Absicht technisch notwendig und bedarf keiner weiteren Einwilligung.

Wichtiger Hinweis: Sie haben keinen Anspruch auf die Veröffentlichung Ihres Kommentars. Jeder hier eingegebene Kommentar wird zuerst geprüft. Ich behalte mir die Entscheidung vor, welche Kommentare ich als Ergänzung an den Artikel anfüge.