een tutorial schrijven¶

tot nu toe gebruikte tekst in de eerste sectie van TYPO3 tutorials:

” dit document is een tutorial. Tutorials zijn ontworpen om stap-voor-stap instructiesspecifiek gemaakt om een beginner door een bepaalde taak van begin tot eind lopen. Om effectief leren te vergemakkelijken, geven tutorials voorbeelden om de onderwerpen te illustreren die zij behandelen. Daarnaast bieden handleidingen over hoe gemeenschappelijke valkuilen kunnen worden vermeden en de aandacht vestigen op belangrijke concepten die moeten worden onthouden voor toekomstig gebruik.”

uit de onderstaande literatuur zouden we de volgende hoofdpunten moeten overwegen::

• een tutorial is een les, leergericht, die stappen laat zien om iets te voltooien, waardoor de lezer meer kennis heeft
• de lezer moet iets betekenisvols bereiken en succes ervaren, het doenbaar en plezierig vinden, competentie vergroten, vertrouwen winnen en het opnieuw willen doen.
• concentreren op praktische kennis, niet op theoretische kennis. Leer een nieuw vak of een nieuwe vaardigheid, concentreer je op leren door te doen

richtlijnen:

• laat de gebruiker leren door te doen,
• ga van eenvoudig naar complex
• start de gebruiker
• het is ok om de stappen te tonen die de beginner het beste begrijpt. “best practice” kan iets anders zijn. Hoe een ervaren gebruiker het zou doen kan iets anders zijn.
• het doel is om de lezer aan de slag te krijgen, niet om ze naar een eindbestemming te brengen.
• zorg ervoor dat uw tutorial werkt!
• inspireer het vertrouwen van de beginner: in de software, in de tutorial, in de tutor en, natuurlijk, in hun eigen vermogen om te bereiken wat van hen wordt gevraagd.
• zorg ervoor dat de gebruiker onmiddellijk resultaten ziet
• de conclusie van elke sectie van een tutorial, of de tutorial als geheel, moet een zinvolle prestatie zijn.
• uw tutorial moet betrouwbaar herhaalbaar zijn.
• Focus op concrete stappen, niet op abstracte concepten. De verleiding om abstractie te introduceren is enorm: verzet je!
• Geef de minimaal noodzakelijke uitleg
• Focus alleen op de stappen die de gebruiker moet nemen