Tutorials schreiben

Anhang: Checkliste

Die folgende Checkliste soll helfen, beliebte Schwachstellen im eigenen Tutorial zu finden. Das ist keine Garantie für ein perfektes Tutorial und umgekehrt muss auch nicht alles „falsch“ sein, nur, weil es hier als „Fehler“ klassifiziert wird. Diese „Regeln“ hier sind keineswegs in Stein gemeißelt, sondern sollen ausschließlich als Orientierung dienen.

Allgemein

  1. Ist die Zielgruppe klar definiert und passt sie zum Thema des Tutorials?
  2. Wird die Zielgruppe über- oder unterfordert? Beispielsweise durch zu viele oder zu wenige Erklärungen?
  3. Um welche Art Tutorial handelt es sich? Grundlagen-Tutorial, HowTo, Projekt-Tutorial oder eine Mischform? Passt das zum Thema?
  1. Wird überall die „wir“-Form verwendet? Konkret: Taucht irgendwo ein „du“ oder „Sie“ auf? Oder ein „ich“ an einer anderen Stelle, als in der Einleitung?
  2. Sind Selbstbezüge wie „im nächsten/vorherigen Kapitel“ vorhanden? Ein „Wie schon erläutert“ das eine Wiederholung kennzeichnet, ist dabei kein Problem.
  3. Wird der Leser nur dann angesprochen, wenn er explizit aufgefordert werden soll, beim Lesen inne zu halten und sich etwas zu überlegen?
  4. Ist der Schreibstil zu trocken? Wirkt das Tutorial langweilig?
  5. Ist der Schreibstil zu locker? Lässt er an der Ernsthaftigkeit des Textes zweifeln?

Motivation

  1. Wird die Zielgruppe zum Weiterlesen motiviert? Wird klar, warum man das Tutorial lesen soll?
  2. Geht das Tutorial inhaltlich auf die Zielgruppe ein?
  3. Wenn es ein Anfänger-Tutorial ist: Werden schnell sichtbare Resultate präsentiert?

Verständlichkeit

  1. Ist das Tutorial für die Zielgruppe verständlich?
  2. Wird dem Leser ein Überblick über das Thema, die Herangehensweise bzw. die Idee gegeben? Ist der „rote Faden“ erkennbar?
  3. Werden die wichtigen Inhalte wiederholt?
  4. Werden alle für die Zielgruppe unbekannten Begriffe erklärt?
  5. Werden diese Begriffe, sofern sie wichtig sind, wiederholt?
  6. Existieren immer jeweils Definitionen und Beispiele?
  7. Sind die Beispiele „natürlich“ oder wird immer nur von „Foo“ und „Bar“ gesprochen? Kann man den Beispielen glauben, dass sie auch in der Praxis funktionieren?
  8. Werden nötige Hintergrundinformationen geliefert?
  9. Bei HowTos: Kann der Leser das Tutorial verwenden, wenn seine Situation leicht anders ist?
  10. Bei Projekt- und Grundlagen-Tutorials: Sind Aufgaben für den Leser vorhanden? In ausreichender Zahl?
  11. Deckt das Tutorial alles, was zum Thema gehört, ab? Hält das Tutorial, was der Titel verspricht?
  12. Werden Vorwärts-Referenzen vermieden?
  13. Sind die einzelnen Sätze verständlich? Oder sind sie vielleicht zu lang und zu kompliziert? Werden Negationen vermieden?
  14. Werden Grafiken und Code sinnvoll eingesetzt? Nimmt der Text Bezug darauf?
  15. Bei großen Projekt-Tutorials: Gibt es „Code-Checkpoints“? Genügend?
  16. Sind alle Definitionen, Beispiele, Codes und Aussagen „mustergültig“ (für die Zielgruppe)? Oder stimmen sie vielleicht nur „ungefähr“?
  17. Werden Begriffe richtig verwendet?

Aufbau

  1. Macht der Titel neugierig? Beschreibt er das Thema genau?
  2. Sind genügend Abschnitte vorhanden? Aber auch nicht zu viele? Faustregel: Eine Überschrift für jede halbe Seite.
  3. Ist der Text durch Absätze gegliedert?
  4. Gibt es eine Einführung ins Thema?
  5. Gibt es einen „Ausblick“ oder ein „Fazit“ am Ende? Oder wird das Tutorial auf andere Weise abgeschlossen?

Kapitel: | Zurück | 1 | 2 | 3 | 4 | 5 | 6 | 7 |

4 Kommentare


  1. Danke für dieses Tutorial!

    Ich plane selbst eine Tutorial/Projekt Seite und ich glaube dein Tutorial hier hat die Qualität meiner entstehenden Tutorials jetzt im Vorfeld schon verbessert.

    Liebe Grüße!

    P.S. Warum hast Du kein Google Adsense? Normal klicke ich da gerne mal drauf, nach guten Informationen.


  2. Schön, dass dir mein Tutorial gefällt. 🙂 Freut mich.

    Warum hast Du kein Google Adsense?

    Ich bin einfach kein Fan von sowas.

    mfg

    Christian



Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.