Tutorial schreiben¶

Bisher verwendeter Text im ersten Abschnitt der TYPO3 Tutorials:

„Dieses Dokument ist ein Tutorial. Tutorials sind als Schritt-für-Schritt-Anleitungen konzipiert, die speziell erstellt wurden, um einen Anfänger von Anfang bis Ende durch eine bestimmte Aufgabe zu führen. Um ein effektives Lernen zu erleichtern, bieten Tutorials Beispiele zur Veranschaulichung der behandelten Themen. Darüber hinaus bieten Tutorials Anleitungen zur Vermeidunghäufige Fallstricke und heben Schlüsselkonzepte hervor, die für zukünftige Referenzzwecke in Erinnerung bleiben sollten.“

Wenn wir uns die unten erwähnte Literatur ansehen, sollten wir die folgenden wichtigen Punkte berücksichtigen:

• ein Tutorial ist eine lernorientierte Lektion, die Schritte zeigt, um etwas zu vervollständigen und den Leser kenntnisreicher zu machen
• Der Leser sollte etwas Sinnvolles erreichen und Erfolg erleben, es machbar und angenehm finden, die Kompetenz verbessern, Vertrauen gewinnen und es wieder tun wollen.
• konzentriere dich auf praktisches Wissen, nicht auf theoretisches Wissen. Lerne ein neues Handwerk oder eine neue Fertigkeit, konzentriere dich auf das Lernen, indem du

Richtlinien machst:

• lassen sie den benutzer lernen, indem sie,
• gehen von einfach zu komplex
• Erhalten die benutzer begann
• es ist ok zu zeigen die schritte die anfänger versteht beste. „Best Practice“ kann etwas anderes sein. Wie ein erfahrener Benutzer es tun würde, kann etwas anderes sein.
• Das Ziel ist es, den Leser zum Laufen zu bringen, nicht, ihn zu einem endgültigen Ziel zu bringen.
• Stellen Sie sicher, dass Ihr Tutorial funktioniert!
• Inspirieren Sie das Vertrauen des Anfängers: in der Software, im Tutorial, im Tutor und natürlich in ihrer eigenen Fähigkeit, das zu erreichen, was von ihnen verlangt wird.
• Sicherstellen, dass der Benutzer die Ergebnisse sofort sieht
• Der Abschluss jedes Abschnitts eines Tutorials oder des Tutorials als Ganzes muss eine sinnvolle Leistung sein.
• Ihr Tutorial muss zuverlässig wiederholbar sein.
• Konzentrieren Sie sich auf konkrete Schritte, nicht auf abstrakte Konzepte. Die Versuchung, Abstraktion einzuführen, ist groß: Widerstehen Sie!
• Geben Sie die minimal erforderliche Erklärung an
• Konzentrieren Sie sich nur auf die Schritte, die der Benutzer ausführen muss