scrierea unui tutorial

textul folosit până acum în prima secțiune a tutorialelor TYPO3:

„acest document este un tutorial. Tutoriale sunt concepute pentru a fi pas-cu-pas instructionsspecific creat pentru a merge un incepator printr-o anumită sarcină de la început laend. Pentru a facilita învățarea eficientă, tutorialele oferă exemple pentru a ilustra subiectele pe care le acoperă. În plus, tutorialele oferă îndrumări cu privire la modul de evitarecapcanele comune și evidențierea conceptelor cheie care ar trebui amintite pentru referințe viitoare.”

privind literatura menționată mai jos, ar trebui să luăm în considerare următoarele puncte cheie:

• un tutorial este o lecție, orientată spre învățare, arătând pași pentru a finaliza ceva, făcând cititorul mai cunoscut
• cititorul ar trebui să realizeze ceva semnificativ și să experimenteze succesul, să-l găsească realizabil și plăcut, să sporească competența, să câștige încredere și vrea să o facă din nou.
• concentrați-vă pe cunoștințe practice, nu pe cunoștințe teoretice. Învățați o nouă meserie sau abilitate, concentrați-vă asupra învățării făcând

linii directoare:

• permiteți utilizatorului să învețe făcând,
• treceți de la simplu la complex
• începeți utilizatorul
• este ok să arătați pașii pe care începătorul îi înțelege cel mai bine. „cea mai bună practică” poate fi ceva diferit. Modul în care un utilizator experimentat ar face acest lucru poate fi ceva diferit.
• scopul este de a începe cititorul, nu de a-l duce la o destinație finală.
• asigurați-vă că tutorialul dvs. funcționează!
• inspiră încrederea începătorului: în software, în tutorial, în tutore și, desigur, în propria lor capacitate de a realiza ceea ce li se cere.
• asigurați-vă că utilizatorul vede imediat rezultatele
• încheierea fiecărei secțiuni a unui tutorial sau a tutorialului în ansamblu trebuie să fie o realizare semnificativă.
• tutorialul dvs. trebuie să fie repetabil în mod fiabil.
• concentrați-vă pe pași concreți, nu pe concepte abstracte. Tentația de a introduce abstractizarea este uriașă: rezistă!
• furnizați explicația minimă necesară
• concentrați-vă doar pe pașii pe care utilizatorul trebuie să îi facă