Writing a tutorial¶

tähän mennessä TYPO3 tutorialsin ensimmäisessä osassa käytetty teksti:

”this document is a tutorial. Tutorials on suunniteltu askel-askeleelta instructionspecifically luotu kävellä aloittelija läpi tietyn tehtävän alusta loppuun. Tehokkaan oppimisen helpottamiseksi tutoriaalit tarjoavat esimerkkejä, jotka havainnollistavat niiden käsittelemiä aiheita. Lisäksi tutorials antaa ohjeita siitä, miten välttää yhteisiä sudenkuoppia ja korostaa keskeisiä käsitteitä, jotka olisi muistettava tulevaa käyttöä varten.”

tarkasteltaessa alla mainittua kirjallisuutta on syytä tarkastella seuraavia avainkohtia:

  • opetusohjelma on oppimispainotteinen oppitunti, jossa näytetään askelia jonkin täydentämiseksi, jolloin lukijan tulee saada enemmän tietoa
  • lukijan tulisi saavuttaa jotain mielekästä ja kokea menestys, löytää se toteutettavissa ja nautittavaa, parantaa osaamista, saada itseluottamusta ja haluaa tehdä sen uudelleen.
  • keskity käytännön tietoon, älä teoreettiseen tietoon. Opettele Uusi käsityö tai taito, keskity tekemällä oppimiseen

ohjeet:

  • anna käyttäjän oppia tekemällä,
  • siirry yksinkertaisesta monimutkaiseen
  • Aloita käyttäjä
  • on ok näyttää vaiheet, jotka aloittelija ymmärtää parhaiten. ”paras käytäntö” voi olla jotain muuta. Se, miten kokenut käyttäjä sen tekisi, voi olla jotain muuta.
  • tavoitteena on saada lukija liikkeelle, ei saada heitä lopulliseen määränpäähän.
  • varmista, että opetusohjelma toimii!
  • herätä aloittelijan luottamus: ohjelmistossa, tutorissa, tutorissa ja tietysti omassa kyvyssään saavuttaa se, mitä heiltä pyydetään.
  • varmista, että käyttäjä näkee tulokset välittömästi
  • jokaisen opetusohjelman osan tai koko opetusohjelman päättämisen on oltava mielekäs suoritus.
  • opetusohjelman tulee olla luotettavasti toistettavissa.
  • keskity konkreettisiin vaiheisiin, älä abstrakteihin käsitteisiin. Kiusaus ottaa abstraktio käyttöön on valtava: vastusta!
  • anna tarvittava vähimmäisselitys
  • keskity vain niihin toimenpiteisiin, jotka käyttäjän on tehtävä

kirjallisuus¶

  • Ubuntu: How to write a tutorial
  • Daniele Procida: ”What nobody tells you about documentation (May 19, 2017) – Erittäin hyvä blogipostaus erilaisista käsikirjoista.

Vastaa

Sähköpostiosoitettasi ei julkaista.