Kako napisati tutorial
Vodič je zbirka uputstava (knjiga). Priručnik je namijenjen pružanju pregleda teme prije nastave, sažetaka za nastavu tokom tečaja za obuku, podlozi za praćenje i opće reference.Koristite ove korake za pisanje udžbenika.
Korake
jedan. Naučite svoju publiku. Istražite nivo znanja i iskustva vaše publike, s obzirom na uslugu, sustav ili proizvod adresa priručnika za studiju.
- Koristite jednostavan jezik i pružate opsežni sistem ili referentni sadržaj informacija za nove gunga. Novi korisnici ne bi trebali samo naučiti proizvod ili sustav, već kako ih koristiti.
- Koristite terminologiju višeg nivoa i manje referentne informacije za grupe koje su upoznate sa proizvodom ili sistemom. Postojeći korisnici ili korisnici proizvoda možda će trebati znati o novim dodatnim funkcijama.
2. Napišite plan. Shema pomaže u organiziranju informacija. Takođe će vam pomoći da se uvjerite da se sve stavke sistema ili proizvoda objavljuju u priručniku za studiranje.
3. Započnite s orijentacijom. Nacrtajte strukturu kompanije, uloge i odgovornosti. Zamislite standardni operativni (radni) SOP postupci, direktiva i QA pokazatelji (kontrola kvaliteta). Nakratko pregledajte neke opće principe, možda putem lista ili pomoću ključnih riječi. Općenito, nemojte misliti da čitalac zna nešto o temi ili čak i organizaciji i izvađuje stvari jasne.
4. Pisati člana. Započnite svako poglavlje iz pregleda podataka predstavljenih na sljedećim stranicama. Koristite naslove za organiziranje informacija u manje odjeljke u svakom poglavlju.
Pošaljite bilo kakve referentne informacije u zasebnim poljima maraka kako bi sve ostali zajedno i pomogli korisnicima da imaju proces od početka do kraja.
- jedan
- Upozorenje korisnika na bilo koji alternativni način za obavljanje koraka. Ako postoji više od 1 načina za dovršetak akcije, označite ga u udžbeniku.
- Omogućite snimke zaslona ako je dozvoljeno. Snimke zaslona sistema pružaju vizualni dodatak koji nadopunjuje tekstualne upute.
- 2. Napraviti odvojene sažetke pojedinosti. Napišite kratak pregled suštine podataka sadržanih u svakom odjeljku. Koristite referentne tablice za sve informacije o kojima ćete možda trebati redovito redovito odnositi na korisnike, na primjer, kombinacije ključeva ili definicije polja.
- Umetnite završne presjeke lekcije nakon završetka svakog poglavlja. Kreirajte aplikaciju ili veze na kraju priručnika i uključite se tamo sve lekcije za životopis.
- 3. Provedite probni trening. Odaberite grupu učesnika koji podsjeća na grupu koja će koristiti završni priručnik za proizvod. Neka grupa koristi udžbenik i pruži vam pregled čitljivosti, područja za poboljšanje i odjeljke koji su potrebni više ili manje detaljne prezentacije.
- 4. Promijenite upute. Koristite povratne informacije (recenzije) dobivene iz testne grupe kako bi se izmjene sadržaja ili obilje upravljanja.
- Pošaljite upute grupi urednika ili zaposlenika. Zamolite ih da prilagode gramatiku i interpunkciju koristi.
Savjeti
- Uključuju obrazac za povratne informacije (recenzije) u priručniku za studiranje. Korisnici tutorijala mogu imati način da pošalju bilo kakve prijedloge ili promjene u objavljivanju u klasi ili kao dokumentaciju ili proizvod dokumentacije ili proizvoda.