Schön, dass Du Dich dafür interessierst, hier ein Tutorial zu schreiben. Wenn Du noch nie ein Tutorial geschrieben hast, so ist das kein Hinderungsgrund. Diese Website ist zum Lernen gedacht; dazu kann durchaus auch das Erlernen des Schreibens von Tutorials gehören. Lies dafür jedoch zuvor bitte folgende Punkte durch:

Ein Tutorial ist eine Mischung aus „Vorkauen“ und zielführender Erklärung. Eine Referenz kann zusätzlich ein Tutorial sehr positiv abrunden und ist besonders als Nachschlagewerk interessant. Hier geht es darum kurz und prägnant, das Wissen des Tutorials zusammen zu fassen. Eine Referenz ist aber kein Tutorial. Ein Tutorial dient dazu, einen ahnungslosen Anfänger/Interessierten auf einen besseren Wissensstand zu bringen. Tutorials hier sollten für 12jährige lesbar (und durch Fragen im Forum nachvollziehbar), für 16jährige nachvollziehbar und für Studenten einfach durchzuarbeiten sein. Euer Zielpublikum sollte also etwa ein Mensch sein, der das Wissen der 10. Klasse besitzt, wobei Besonderheiten durchaus nochmals erwähnt oder erklärt werden dürfen. Solltet ihr euch an eine andere Leserschaft richten, dann sagt dies direkt am Anfang des Tutorials und gebt Hinweise, wo man fehlende Informationen findet.

Kurze Definitionen ergeben kein Tutorial, sondern nur verhältnismäßig leere Seiten. Stichwortsammlungen, die ein 16jähriger nicht nachvollziehen kann, die ein 12jähriger nicht einmal lesen kann und bei denen ein ausgebildeter Informatiker erst mal ins Grübeln kommt, wie er sich das jetzt erklärt, sind kein Tutorial. Ein Tutorial soll etwas erklären; nicht der Leser muss sich das Tutorial selbst erklären.

Haltet euch im Hinterkopf, dass ihr kein Wissen voraussetzt - häufig erlebt man, dass man Texte, die man selbst vor drei Monaten geschrieben hat, nicht mehr versteht, weil Wissen und Gedankengänge, die einem zuvor selbstverständlich erschienen nun vergessen sind. Der Leser hatte diese Gedanken nie. Also erklärt lieber einen Satz mehr als einen Satz zu wenig.

Bilder lockern ein Tutorial deutlich auf. Das gilt auch für verbal gezeichnete Bilder. Wenn ihr eine abstrakte Idee erklärt, zieht diese Idee immer wieder in das reale Leben zurück. Beispiel: Ein Zeiger in einer Programmiersprache ist wie ein Autobahnschild auf dem Köln steht. Es gibt einen Platz, wo das Ortsschild steht, aber das Schild steht vermutlich außerhalb von Köln. Oftmals sind die Bilder bereits vorhanden, wie eben in „Zeiger“, dem „Schlüssel“ bei Datenbanken oder wie beim „Verzeichnis“ oder im „Datei“-system. Beim AmigaOS nannte man Sie „Drawer“.

Auf der „Workbench“ (Arbeitstisch) öffnete man einen „Drawer“ (Schublade) und gelangte so an das gesuchte „Tool“ (Werkzeug).

Aufwendige Ideen sind häufig bereits mit solchen Bildern vereinfacht worden. Benutzt diese Bilder, statt sie einfach nur aufzuzählen.

Bilder helfen auch, sich den Stoff zu merken. Ein Hyperlink wird in einem HTML-Dokument mit dem Tag <a> statt <link> gemacht, weil es sich um einen Anchor (Anker) handelt und Anchors wurden in den ersten HTML-Seiten auf der gleichen Seite gestaltet. Das Inhaltsverzeichnis auf dieser Seite springt zu den Überschriften. Die Überschriften sind die interessanten Punkte, da wo man hinfahren/scrollen will und vor Anker geht. Schließlich hat man diese Anker auch verwendet, um auf eine andere Seite zu verlinken. Kennt man die Geschichte, kann man sich leichter merken, warum es <a> und nicht <link> ist.

Der Mensch kann sich eine Anhäufung von Wissen nicht merken. Packt man Wissen in eine Geschichte und in ein bekanntes Umfeld (Zeiger = Autobahnschild), ist das neue Wissen fürs Gehirn viel leichter zu verdauen.

Skizziert Dinge. Wenn ihr mit Programmen wie GIMP (kostenlos), Photoshop, Illustrator oder Inkscape (kostenlos) keine Skizzen zeichnen könnt, nehmt Papier und Stift und fotografiert diese Skizzen oder zieht sie durch einen Scanner. Auch eine Skizze, die nicht professionell hergestellt wurde, ist viel aussagekräftiger als eine fehlende Skizze.

Ein Tutorial bewegt den Leser von einem Punkt „Keine Ahnung“ zu einem Wissenstand „Ich habe etwas verstanden“. Ein Tutorial muss also nicht einen vollständigen Themenbereich abdecken, sondern kann bereits vollständig sein, wenn es in ein Thema einführt. Ein Linux-Tutorial muss nicht den kompletten Kernel erklären, sondern es reicht zu zeigen, wie man Linux installiert und wie man dort Programme installiert. Dann ist das Tutorial zu Ende. Anschließend kann man zusätzliche Artikel schreiben, wie 'Was ist ein Cron-Job?' oder 'Wie starte ich einen Webservice?'. Beide Artikel können ohne eine Linux-Installation nicht nachvollzogen werden. Sie runden einen Linux-Bereich ab, aber jeder kann sich entscheiden, ob er sich jetzt für diesen Bereich interessiert oder erst später. Mit der Linux-Installation sind die Grundlagen geschaffen, auf der spätere Artikel um Linux aufbauen können.

Bitte trennt die Themen sauber. Es kann passieren, dass sich Themen überschneiden, zum Beispiel HTML und CSS oder SDL und OpenGL. Bitte sprecht euch dann mit dem jeweiligen Autor ab und sorgt so dafür, dass sich Informationen im Wiki nicht wiederholen oder im schlimmsten Fall sogar widersprechen.

Wir brauchen Tutorials, die vorzeigbar sind, die ich direkt auf der Startseite verlinken kann, auf die man Aufmerksamkeit lenken kann. Das bedeutet, dass FIXMEs und leere Links nicht erwünscht sind. Macht ein Tutorial lieber kleiner oder beginnt einfach mit einem Artikel, wenn die Zeit für ein großes Tutorial fehlt. Beschreibt wie man eine Installation des jeweiligen Tools bewerkstelligt und damit ist der Artikel abgeschlossen. Dieser Artikel kann später als Einleitung für ein Tutorial dienen, ist aber auch für sich selbst bereits eine Bereicherung. Fehlt einem später die Zeit, so hilft das mehr, als eine lange Liste nicht fertiggestellter Seiten.

Im Idealfall informiert eine Tutorialseite über ihren Inhalt und die Voraussetzungen. Sie fasst also kurz zusammen, welche Kompetenz auf dieser Seite vermittelt wird und warum: „In diesem Kapitel schauen wir uns dynamische Speicherverwaltung an, um zur Laufzeit neue Datensätze anlegen und freigeben zu können. Hierfür benötigen wir Kenntnis über Zeiger und Variablen.“ Wobei die Voraussetzungen im Tutorial vorher behandelt worden sein müssen. Anschließend darf eine kurze Zusammenfassung der Inhalte kommen:

• Die Funktion malloc()
• Zugriff auf den Speicher
• Freigabe mit free().

Abschließend sollte in kurzen Worten zusammengefasst werden, was man gerade gelesen hat und was man damit machen kann. Das ist im Prinzip das gleiche wie die Einleitung zuvor. Die Einleitung hilft sich gedanklich auf den Stoff einzustellen, die Zusammenfassung am Ende hilft den Stoff nochmal gedanklich durchzugehen. Ein Hinweis (und Link) was in der nächsten Seite kommt, die im Idealfall auf dieser Seite aufbaut ist wünschenswert: „Im kommenden Kapitel bauen wir auf diesem Wissen Datenstrukturen auf“ und verlinkt entsprechend.

Unterschätzt die Arbeit für ein Tutorial nicht. Ein gutes Tutorial zu schreiben ist wie ein Buch zu schreiben. Das erfordert auch viel Arbeit und auch Recherche, selbst bei Themen, mit denen man im Alltag gut klarkommt. proggen.org ist eine Seite zum Lernen und ausprobieren, das gilt für die Leser von Tutorials genauso, wie für diejenigen, die sich daran probieren wollen, Tutorials zu schreiben. Ein Tutorial schreibt sich in der Regel nicht einfach runter.

Sprecht über eure Vorhaben und holt euch Ratschläge ein. Diskutiert euer Vorhaben und den Aufbau im Tutorials-Board, das hilft eine erfolgreiche Umsetzung abzusichern.