Cum să scrie un tutorial

Tutorial este o colecție de instrucțiuni (carte). Manualul este destinat să furnizeze o revizuire a subiectului înainte de clase de clasă, rezumate pentru clase în timpul cursului de formare, referire la urmărirea și referința generală.Utilizați acești pași pentru a scrie un manual.

Pași

  1. Imagine intitulată Scrieți un manual de instruire Pasul 1
unu. Aflați-vă audiența. Explorați nivelul de cunoaștere și experiență a publicului dvs., având în vedere serviciul, sistemul sau produsul adreselor manualului de studiu.
  • Utilizați limba simplă și furnizați un sistem extins de sistem sau informații de referință pentru GUG-uri noi. Utilizatorii noi nu ar trebui să învețe numai produsul sau sistemul, ci cum să le folosească.
  • Utilizați terminologia nivelului superior și informații mai mici de referință pentru grupurile care sunt familiarizați cu produsul sau sistemul. Utilizatorii existenți sau utilizatorii de produse ar putea avea nevoie să știe despre noi caracteristici adăugate.
  • Imagine intitulată Scrieți un manual de instruire Pasul 2
    2. Scrieți un plan. Schema ajută la organizarea de informații. De asemenea, vă va ajuta să vă asigurați că toate elementele sistemului sau produsului sunt dezvăluite în manualul de studiu.
  • Imagine intitulată Scrieți un manual de instruire Pasul 3
    3. Începeți cu orientarea. Descrieți structura companiei, rolurile și responsabilitățile. Imaginați-vă că procedurile SOP de operare standard (de lucru), directivele și indicatorii QA (controlul calității). Revedeți câteva principii generale pe scurt, probabil prin liste sau prin utilizarea cuvintelor cheie. În general, nu credeți că cititorul știe ceva despre subiect sau chiar despre organizație și stabilește lucrurile clare.
  • Să adere la o scurtă orientare pe merite. Re-citiți și selectați toate adăugările inutile.
  • Imagine intitulată Scrieți un manual de instruire Pasul 4
    4. Scrieți un membru. Porniți fiecare capitol de la revizuirea informațiilor prezentate în paginile următoare. Utilizați titluri pentru a organiza informații în secțiuni mai mici în fiecare capitol.
  • Porniți fiecare pas sau direcție din acțiunea verbului.
  • Stick la directive scurte și în esență.
  • Trimiteți orice informații de referință în câmpuri separate ale mărcilor pentru a păstra totul împreună și pentru a ajuta utilizatorii să aibă un proces de la început până la sfârșit.

    1. unu
    2. Utilizatori de avertizare la orice modalitate alternativă de a efectua pași. Dacă există mai mult de o modalitate de a finaliza acțiunea, marcați-l în manual.
    3. Activați capturile de ecran dacă este permisă. Imaginile de ecran de sistem oferă o alocație vizuală care completează instrucțiunile de text.
    4. Imagine intitulată Scrieți un manual de instruire Pasul 5
      2. Efectuați secțiuni sumare separate ale lecțiilor. Scrieți o scurtă examinare a esenței informațiilor conținute în fiecare secțiune. Utilizați tabele de referință pentru orice informație despre care este posibil să fie necesar să vă referiți în mod regulat utilizatorii, de exemplu, combinații cheie sau definiții de câmp.
    5. Introduceți secțiunile finale ale lecii după încheierea fiecărui capitol. Creați o aplicație sau linkuri în capătul manualului și porniți acolo toate lecțiile de reluare.
    6. Imagine intitulată Scrieți un manual de instruire Pasul 6
      3. Petreceți instruirea procesului. Selectați un grup de participanți care reamintește unui grup care să utilizeze manualul de produs final. Lăsați grupul să utilizeze un tutorial și să vă ofere o revizuire a lizibilității, zone de îmbunătățire și secțiuni care necesită o prezentare mai mult sau mai puțin detaliată.
    7. Imagine intitulată Scrieți un manual de instruire Pasul 7
      4. Schimbați instrucțiunile. Utilizați feedback (recenzii) obținute din grupul de testare pentru a modifica conținutul sau abundența managementului.
    8. Trimiteți instrucțiuni unui grup de editori sau angajați. Cereți-i să ajusteze gramatica și punctuația beneficiului.

    sfaturi

    • Includeți formularul de feedback (recenzii) în manualul de studiu. Utilizatorii de tutoriale pot avea o modalitate de a trimite sugestii sau modificări în postarea în clasă sau ca documentație sau un produs.
    Publicații similare