Tutorials schreiben (2147 Downloads)

Überblick

Es ist jetzt mittlerweile fast drei Jahre her, dass ich angefangen habe, Tutorials zu schreiben. Seit dem habe ich einiges gelernt. Insbesondere auch dadurch, dass ich mittlerweile fast schon regelmäßig fremde Tutorials korrekturlese. Dabei sind mir einige Dinge aufgefallen, die ich nun hier zusammenfassen möchte. Auch wenn ich meine eigenen bisherigen Tutorials wieder lese, so fällt mir einiges auf, das ich mittlerweile anders machen würde und bei so mancher Formulierung muss ich heute über meine damaligen Texte schmunzeln. Wer Lust hat, kann ja mal nach der Lektüre dieses Tutorials meine bisherigen Texte nach Fehlern und Verbesserungsmöglichkeiten durchsuchen. Es finden sich da so einige…

Ich kann nicht behaupten, dass ich eine besondere Qualifikation für so ein Tutorial vorweisen kann. Ich habe weder etwas dahingehendes studiert, noch Sekundärliteratur zum Thema gelesen. Das, was ich hier beschreibe, stützt sich ausschließlich auf meine „Erfahrungen“ mit eigenen und fremden Tutorials und ich denke, ich hätte den ein oder anderen Fehler nicht begangen, wenn mir jemand gesagt hatte, was man besser nicht macht. Nichtsdestotrotz bleibt es natürlich jedem selbst überlassen, was er von meinen Tipps hält. Kommentare jeglicher Art sind herzlich willkommen.

Dieses Tutorial richtet sich somit an alle, die gerne selbst mal ein Tutorial schreiben möchten. Hauptsächlich geht es hier um Programmier-Tutorials, jedoch gilt vieles von dem hier vorgestellten für jegliche Art Tutorial.

Zielgruppe

Ganz wichtig beim Tutorials schreiben – wie beim Schreiben von allen anderen Texten auch – ist es, die Zielgruppe zu beachten. Wer soll hinterher das Tutorial eigentlich lesen? Diese Frage ist viel elementarer, als sie auf den ersten Blick erscheint. Vorwissen, Interessen und Erwartungen der potentiellen Leser müssen berücksichtigt werden, wenn die Leserschaft weder über- noch unterfordert oder gar frustriert werden soll.

Bevor man also überhaupt mit dem Schreiben anfängt, sollte man sich also genau mit der zukünftigen Leserschaft auseinandersetzen. Es wird natürlich immer wieder Leser geben, die nicht zur gedachten Zielgruppe passen. Das ist nicht zu vermeiden, aber auch nicht weiter tragisch. Es geht hier mehr darum, die typischen Leser auszumachen. Das muss nicht zwangsweise eine ganz klar abgegrenzte Gruppe sein. Wenn man jedoch versucht ein Tutorial für Einsteiger und Profis, für Grundschüler, Studenten und Rentner zu schreiben, wird dies vermutlich schief gehen.

Die folgenden Fragen sollen helfen sich über die Zielgruppe klar zu werden:

• Welches Vorwissen bringen die Leser wohl mit?
• Allgemein: Welche Bildung haben sie? Sind es Schüler, Mathematikprofessoren oder Rentner?
• Konkreter: Was können sie nicht? Wo sind ihre Grenzen? Müssen viele (englische?) Fachbegriffe erläutert werden? Muss genauer auf mathematische Grundlagen eingegangen werden?
• Wie alt sind sie? Kinder müssen beispielsweise eher motiviert werden als Erwachsene.
• Welche Erwartungen haben sie an das Tutorial?
• Was wollen sie auf keinen Fall? Was würde sie langweilen? Was überfordern?

Wenn die Zielgruppe nicht klar ersichtlich, d.h. aus dem Thema ableitbar ist, ist es auch eine gute Idee am Anfang des Tutorials diese explizit zu benennen. Insbesondere können so erwartete Grundkenntnisse o.ä. erwähnt werden.

Arten von Tutorials

Im Grunde genommen gibt es drei Arten von Tutorials: Grundlagen-Tutorials, Anleitungen (auch bekannt als HowTos) und Projekt-Tutorials. Oftmals entspricht ein Tutorial genau einer dieser drei Arten. Es gibt allerdings auch diverse Mischformen.

Grundlagen-Tutorials sollen, wie der Name schon sagt, die Grundlagen zu einem bestimmten Thema vermitteln und dabei möglichst ausführlich und vollständig sein.

Anleitungen sind eher dazu da, um eine ganz konkrete Aufgabenstellung Schritt für Schritt zu lösen. Beispielsweise könnte ein HowTo erklären wie ein bestimmtes Programm zu installieren oder zu konfigurieren ist. Grundlagen werden hierbei größtenteils ausgeklammert. Das heißt nicht, dass man nicht erklären sollte, was passiert. Das ist wichtig für das Verständnis und für den Fall, dass sich die gegebene Situation des Lesers in Details von der des Tutorials unterscheidet. Beispielsweise aufgrund einer anderen Programmversion. Allerdings steht hier das konkrete Problem und dessen – schnelle – Lösung im Vordergrund.

Bei Projekt-Tutorials handelt es sich um eine Anleitung zum Einüben der Grundlagen an einer konkreten größeren Aufgabenstellung. „Wie schreibe ich einen HTML-Editor?“ fiele in diese Kategorie. So sind diese Art Tutorials meist aus einer Folge von Erklärungen, Aufgabenstellungen und Musterlösungen aufgebaut.

Kapitel: | 1 | 2 | 3 | 4 | 5 | 6 | 7 | Weiter |