Skrive en tutorial¶

Tekst brukt så langt i den første delen AV TYPO3 tutorials:

«dette dokumentet er en tutorial. Opplæringsprogrammer er designet for å være trinnvise instruksjonerspesielt opprettet for å gå en nybegynner gjennom en bestemt oppgave fra begynnelse til slutt. For å lette effektiv læring, tutorials gi eksempler for å illustratethe fagene de dekker. I tillegg gir veiledninger veiledning om hvordan du kan unngåvanlige fallgruver og markere nøkkelbegreper som bør huskes for fremtidig referanse.»

Fra å se på litteraturen nevnt nedenfor, bør vi vurdere følgende hovedpunkter:

  • en opplæring er en leksjon, læringsorientert, som viser trinn for å fullføre noe, noe som gjør leseren mer kunnskapsrik
  • leseren skal oppnå noe meningsfylt og oppleve suksess, finne det gjennomførbart og hyggelig, øke kompetansen, få tillit og ønsker å gjøre det igjen.
  • konsentrere seg om praktisk kunnskap, ikke teoretisk kunnskap. Lær et nytt håndverk eller ferdighet, konsentrere deg om læring ved å gjøre

Retningslinjer:

  • tillat brukeren å lære ved å gjøre,
  • gå fra enkle til komplekse
  • Få brukeren i gang
  • det er ok å vise trinnene nybegynnere forstår best. «best practice» kan være noe annet. Hvordan en erfaren bruker ville gjøre det kan være noe annerledes.
  • målet er å få leseren i gang, ikke å få dem til en endelig destinasjon.
  • Kontroller at opplæringen fungerer!
  • inspirer nybegynnerens tillit: i programvaren, i opplæringen, i veilederen og selvfølgelig i egen evne til å oppnå det som blir bedt om dem.
  • Sikre at brukeren ser resultater umiddelbart
  • avslutningen av hver del av en tutorial, eller opplæringen som helhet, må være en meningsfull prestasjon.
  • opplæringen må være pålitelig repeterbar.
  • Fokus på konkrete trinn, ikke abstrakte begreper. Fristelsen til å introdusere abstraksjon er enorm: motstå!
  • Gi den minste nødvendige forklaringen
  • Fokuser bare på trinnene brukeren må ta

Litteratur¶

  • Ubuntu: hvordan skrive en tutorial
  • Daniele Procida: «Hva ingen forteller deg om dokumentasjon ( Mai 19, 2017) – en veldig god bloggpost om ulike typer manualer.

Legg igjen en kommentar

Din e-postadresse vil ikke bli publisert.