Ako napísať študijný príručku: 7 krokov

Návod je zbierka pokynov (kniha). Manuál je určený na poskytovanie revízie témy pred triedmi tried, abstrakty pre triedy počas tréningového kurzu, odhlásenie o následnom a všeobecnom referencii.Použite tieto kroky na napísanie učebnice.

Kroky

jeden. Naučte sa svoje publikum. Preskúmajte úroveň vedomostí a skúseností vášho publika, vzhľadom na službu, systém alebo produkt adresy študijnej príručky.

Použite jednoduchý jazyk a poskytnite rozsiahly systém alebo referenčný informačný obsah pre nové gungs. Noví užívatelia by sa nemali naučiť len produkt alebo systém, ale ako ich používať.
Použite terminológiu vyššej úrovne a menej referenčné informácie pre skupiny, ktoré sú oboznámení s produktom alebo systémom. Existujúci používatelia alebo užívatelia produktov môžu vedieť o nových pridaných funkciách.

Obrázok s názvom Napíšte tréningový manuál krok 2

2. Napíšte plán. Systém pomáha organizovať informácie. Pomôže vám tiež uistiť sa, že všetky položky systému alebo produktu sú opísané v študijnom príručke.

Obrázok s názvom Napíšte tréningový manuál Krok 3

3. Začnite s orientáciou. Načrtnúť štruktúru spoločnosti, rolí a zodpovednosti. Predstavte si štandardné prevádzkové (pracovné) postupy SOP, smernice a indikátory QA (kontrolu kvality). Krátko preskúmajte niektoré všeobecné zásady, snáď prostredníctvom zoznamov alebo pomocou kľúčových slov. Všeobecne platí, že si čitateľ pozná niečo o predmete alebo dokonca organizácii a stanovuje veci jasné.

Dodržiavať krátku orientáciu na zásluh. Znova si prečítajte a vyberte všetky zbytočné dodatky.

Obrázok s názvom Napíšte tréningový manuál Krok 4

4. Napíšte člena. Spustite každú kapitolu z prehľadu informácií uvedených na nasledujúcich stranách. Použite titulky na usporiadanie informácií do menších sekcií v každej kapitole.

Začnite každý krok alebo smer od slovesnej akcie.

Držať krátke smernice a v podstate.

Odošlite akékoľvek referenčné informácie v samostatných oblastiach ochranných známok, aby sa všetko dohromady a pomohli používateľom, aby mali proces od začiatku až do konca.

jeden
Upozornenia na vykonanie krokov. Ak existuje viac ako 1 spôsob, ako dokončiť akciu, označte ho do učebnice.
Povoliť snímky obrazovky, ak je prípustné. Systémové screenshoty poskytujú vizuálny príspevok, ktorý dopĺňa textové pokyny.
2. Vykonať samostatné súhrnné časti lekcií. Napíšte stručný prehľad podstaty informácií obsiahnutých v každej časti. Použite referenčné tabuľky pre všetky informácie, na ktorých budete musieť pravidelne odvolávať na používateľov, napríklad kľúčové kombinácie alebo definície poľa.
Po skončení každej kapitoly vložte posledné časti lekcie. Vytvorte aplikáciu alebo odkazy na konci príručky a zapnite tam všetky lekcie životopisu.
3. Stráviť skúšobný tréning. Vyberte skupinu účastníkov, ktorí pripomína skupinu, ktorá bude používať konečnú príručku produktu. Nechajte skupinu použiť tutoriál a poskytnúť vám revíziu čitateľnosti, oblastí na zlepšenie a sekcií, ktoré potrebujú viac či menej podrobnú prezentáciu.
4. Zmeniť pokyny. Použite spätnú väzbu (recenzie) získané zo skúšobnej skupiny, aby sa zmenia obsah alebo hojnosť riadenia.
Poslať pokyny skupine redaktorov alebo zamestnancov. Požiadajte ich, aby upravili gramatiku a interpunkciu výhody.

Tipy

Zahŕňajú formulár spätnej väzby (recenzie) v študijnom príručke. Užívatelia tutoriálov môžu mať spôsob, ako poslať akékoľvek návrhy alebo zmeny vo vysielaní v triede, alebo ako dokumentácia dokumentov alebo výrobku.