skrivning af en tutorial liter

tekst, der hidtil er brugt i det første afsnit af TYPO3-tutorials:

“dette dokument er en tutorial. Tutorials er designet til at være trin-for-trin instruktionerspecifikt oprettet for at gå en nybegynder gennem en bestemt opgave fra start tilend. For at lette effektiv læring giver tutorials eksempler til at illustrere de emner, de dækker. Derudover giver tutorials vejledning om, hvordan man undgårfælles faldgruber og fremhæve nøglebegreber, der skal huskes til fremtidig reference.”

fra at se på litteraturen nævnt nedenfor bør vi overveje følgende nøglepunkter:

  • en tutorial er en lektion, læringsorienteret, der viser trin til at fuldføre noget, hvilket gør læseren mere vidende
  • læseren skal opnå noget meningsfuldt og opleve succes, finde det gennemførligt og behageligt, forbedre kompetence, få tillid og ønsker at gøre det igen.
  • koncentrer dig om praktisk viden, ikke teoretisk viden. Lær et nyt håndværk eller færdighed, koncentrer dig om at lære ved at gøre

retningslinjer:

  • Tillad brugeren at lære ved at gøre,
  • gå fra simpelt til komplekst
  • få brugeren startet
  • det er ok at vise de trin, som begynderen forstår bedst. “bedste praksis” kan være noget andet. Hvordan en erfaren bruger ville gøre det kan være noget andet.
  • målet er at få læseren i gang, ikke at få dem til en endelig destination.
  • sørg for, at din tutorial fungerer!
  • inspirer begynderens tillid: i programmet, i vejledningen, i vejlederen og selvfølgelig i deres egen evne til at opnå det, der bliver bedt om dem.
  • sørg for, at brugeren ser resultater med det samme
  • konklusionen af hvert afsnit i en tutorial eller tutorial som helhed skal være en meningsfuld præstation.
  • din tutorial skal være pålideligt gentagelig.
  • fokus på konkrete trin, ikke abstrakte begreber. Fristelsen til at introducere abstraktion er enorm: modstå!
  • giv den mindste nødvendige forklaring
  • fokuser kun på de trin, brugeren skal tage

litteratur¶

  • Ubuntu: hvordan man skriver en tutorial
  • Daniele Procida: “hvad ingen fortæller dig om dokumentation(19.maj 2017) – en meget god blogpost om forskellige slags manualer.

Skriv et svar

Din e-mailadresse vil ikke blive publiceret.