Tutorials und Richtlinien

Ihr kennt das bestimmt: Ihr wollt euch ein neues Open Source Projekt genauer ansehen oder eine bestimmte Technologie und sucht nach einem Tutorial. Schnell stellt ihr fest, um ein Tutorial durchgehen zu können muss man zwischendurch nach weiteren suchen oder endlos googeln.
Meiner Meinung nach sind 90% aller Tutorials, die man im Netz findet unnötig, da sie unvollständig oder im schlimmsten aller Fälle nicht korrekt sind und dadurch die Leser verärgern.

Hier ein paar Dinge, die man beachten sollte, wenn man ein Tutorial schreibt:

• Fachliche Kompetenz: Seid ihr euch auch wirklich sicher, dass ihr euch mit dem Thema auch wirklich gut genug auskennt, um ein Tutorial darüber schreiben zu können?
• Wann wurde das Tutorial verfasst bzw. von welcher damals aktuellen Software-Version war die Rede: der Leser möchte nicht unbedingt ein Tutorial durchgehen, sich ständig wundern weshalb nichts von den Angaben funktioniert bis er nach langer Recherche dahinter kommt, dass der Artikel drei Jahre alt ist und er mittlerweile mit Version 8.0.1 arbeitet, das Tutorial aber zur Version 0.0.1 beta geschrieben wurde.
• Angabe des Schwere-Grades: Bitte gebt euren Tutorials einen sinnvollen Schwierigkeitslevel. Besser ein oder zwei Grad zu hoch angeben, als dass man verzweifelte Leser vor dem Bildschirm sitzen hat.
• Eigenes Wissen bitte nicht auf den Leser projezieren: was für den Verfasser selbstverständlich ist, muss für den Leser nicht auch zutreffen. Man verfasst doch im Normalfall ein Tutorial, um anderen etwas zu erklären.
• Auf die Vollständigkeit achten: ein Tutorial wo in jedem zweiten Absatz auf Google verwiesen wird, wenn man sich mit diesem oder jenem Bereich nicht auskennen sollte, hat meiner Meinung nach nichts mit einem guten Tutorial zu tun.
• Wortwahl & Formulierung: einfache Formulierungen und Satzstellungen verwenden. Sätze, die über fünf Absätze laufen sind oftmals in einem neuen fachlichen Kontext schwer zu verstehen.
• Gliederung: das Tutorial in sinnvolle Passagen gliedern. Überschriften verwenden.

Nehmt euch das bitte beim Verfassen von Tutorials oder Anleitungen zu Herzen, solltet ihr das bislang noch nicht getan haben, und die Internetgemeinde wird es euch danken. Ich werde es euch danken.