Theorie Schrijven van Tutorials

Uit Roncalli Wiki
Ga naar: navigatie, zoeken

Het zelf schrijven van een tutorial (of howto) is een van de moeilijkste dingen die er is. Je moet namelijk

  • snappen wat je aan het doen bent
  • het ook nog uit kunnen leggen
  • op een leuke manier, zodat je publiek meedoet
  • en je eigen fouten (die er altijd zijn) op kunnen sporen

Als je dit allemaal kunt, ben je klaar voor elke uitdaging.

Inhoud

Proces

  • Verzin een eindproduct dat je tutorial op zal leveren. Bijvoorbeeld: een foto van jezelf met een haai aan je been.
  • kijk af in andere tutorials, boeken, experts welke foefjes je nodig hebt; verzamel bookmarks. Als je bronnen gebruikt, geef je eigen draai aan het verhaal en geef een verwijzing aan je bronnen
  • verzorg eigen bronmateriaal. Zorg dat je het copyright op foto's of ander materiaal niet schendt.

De Opbouw van je tutorial

De tutorial bestaat uit een inleiding, een aantal stappen en een eindresultaat met conclusie en tips voor een vervolg.

Inleiding

In de inleiding geef je eerst aan wat het doel is van de tutorial. In deze tutorial leer je hoe je twee foto's samenvoegt.

Je laat afbeeldingen zien van het eindresultaat en eventueel van het origineel, zodat de bezoeker gelijk weet waar het om gaat. Ook geef je aan welke voorkennis - de moeilijkheid - en programma's - met name de versienummers - er nodig zijn. Geef ook aan of je Windows of Apple commando's gebruikt en hoe de lezer met een verschil moet omgaan. In de inleiding wek je interesse en vertrouwen dat jouw tutorial de moeite waart is en van fatsoenlijk niveau.

Stappenreeks

In elke stap, geef duidelijk aan:

  • Stap nummer # met titel. Zorg dat de kop opvalt in het design.
  • Een afbeelding die de stap uitlegt
  • Een tekst die je de stap verklaart. Leg elke stap zo kort en helder mogelijk uit, maar raffel het niet af. Pas op met zinnen die je op meerdere manieren kunt lezen, of, zinnen die helemaal niet te lezen zijn.

Conclusie

In de conclusie vat je stapppen en het eindresultaat nog even samen. Geef leuke ideeën of tips hoe de lezer verder kan gaan met een volgende stap. Geef ook aan welk copyright / copyleft je hanteert.


Didactiek

  • De opbouw die je hierboven hebt, gebruikt het hamburgermodel : broodje, hamburger, broodje. Bekijk de hamburger

Dit betekent het hamburgermodel:

  • Eerst zeg je wat je gaat doen
  • Dan doe je het
  • Dan zeg je wat je hebt gedaan.

Schrijftips

  • Controleer de tutorial door 'm zelf ook nog een keer te doen als je denkt dat ie af is (ik geef toe: mij lukt dat ook niet altijd!)
  • Gebruik consequent (=telkens) dezelfde woorden en dezelfde opmaak voor dezelfde koppen en teksten.
  • Zorg voor nagenoeg perfect taalgebruik. op het niveau van je publiek. Als het voor professoren of imbecielen is geschreven, leest niemand 't.
  • Een foutje kan altijd gebeuren, maar zorg dat je de spellingschecker aan hebt staan. Gebruik ook geen spreektaal. Neem ook de Theorie Schrijven voor Print & Web nog even door.
  • Omgaan met problemen. Als je een testgroep de tutorial laat doen, kom je erachter waar ze vast lopen. Gebruik dan waarschuwingen pas op dat je of 'tips als je last hebt van ... doe dan ...
  • Stuur gebruikers niet via Google naar een download, maar geef de directe link naar de download. Zorg dat de URL zelf ook in beeld is, voor het geval dat iemand m uitprint. Dus : ga naar http://getfirefox.com om Firefox te downloaden.
  • Plaatjes goed uitlijnen is vaak lastig in Wordpress. Zet de uitlijning op Geen Uitlijning en schrijf gewoon alleen onder en boven het plaatje.

Opdracht

Als oefenopdracht schrijf je een tutorial over het gebruiken van de spellingchecker op je favoriete browser (Safari, Chrome, Firefox), in een andere taal.

Schrijf de tutorial in je weblog, als pagina. Gebruik bij elke stap een kop met nummer, en een plaatje als het handig is.

  • Screenshots maken met CMD-SHIFT-4 en sleep om een gedeelte van het venster te selecteren.
Persoonlijke instellingen