Writing a tutorial adapterek

a TYPO3 oktatóanyagok első részében eddig használt szöveg:

“ez a dokumentum egy tutorial. Az oktatóanyagokat úgy tervezték, hogy lépésenkénti utasításokkifejezetten azért hozták létre, hogy egy kezdőt egy adott feladaton keresztül kezdjenek az elejétől a végéig. A hatékony tanulás megkönnyítése érdekében az oktatóanyagok példákat mutatnak be az általuk lefedett tantárgyak szemléltetésére. Ezenkívül az oktatóanyagok útmutatást nyújtanak arról, hogyan lehet elkerülni a közös buktatókat, és kiemelik azokat a kulcsfontosságú fogalmakat, amelyeket a jövőben emlékezni kell.”

az alább említett irodalom áttekintéséből a következő kulcsfontosságú pontokat kell figyelembe vennünk:

  • a tutorial egy lecke, tanulás orientált, mutatja lépéseket befejezni valamit, hogy az olvasó több knowledgable
  • az olvasónak el kell érnie valami értelmes és a tapasztalat a siker, úgy találja, hogy megvalósítható és élvezetes, növeli a kompetencia, bizalmat szerezni, és azt akarja, hogy újra.
  • koncentráljon a gyakorlati ismeretekre, ne az elméleti ismeretekre. Tanuljon meg egy új mesterséget vagy készséget, koncentráljon a tanulásra azáltal, hogy

Irányelvek:

  • lehetővé teszi a felhasználó számára, hogy tanuljon,
  • menj az egyszerűtől a komplexig
  • indítsa el a felhasználót
  • rendben van, ha megmutatja azokat a lépéseket, amelyeket a kezdő a legjobban megért. a “legjobb gyakorlat” valami más lehet. Az, hogy egy tapasztalt felhasználó hogyan csinálná, valami más lehet.
  • a cél az, hogy az olvasó elinduljon, nem pedig a végső rendeltetési helyre.
  • győződjön meg arról, hogy a bemutató működik!
  • inspirálja a kezdő bizalmát: a szoftverben, az oktatóanyagban, az oktatóban és természetesen a saját képességükben, hogy elérjék azt, amit kérnek tőlük.
  • győződjön meg róla, hogy a felhasználó azonnal látja az eredményeket
  • az oktatóanyag egyes szakaszainak vagy az oktatóanyag egészének következtetésének értelmes eredménynek kell lennie.
  • az oktatóanyagnak megbízhatóan ismételhetőnek kell lennie.
  • Fókuszban a konkrét lépések, nem elvont fogalmak. Az absztrakció bevezetésének kísértése hatalmas:ellenállj!
  • adja meg a minimálisan szükséges magyarázatot
  • csak azokra a lépésekre összpontosítson, amelyeket a felhasználónak meg kell tennie

Irodalom¶

  • Ubuntu: Hogyan írjunk egy tutorial
  • Daniele Procida: “amit senki sem mond a dokumentációról (május 19, 2017) – egy nagyon jó blogpost a különböző kézikönyvekről.

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.