A tanulmányi útmutató írása: 7 lépés

A bemutató az utasítások gyűjteménye (könyv). A kézikönyv célja, hogy értékelje a téma, mielőtt osztály osztály, absztrakt osztályok a képzés során, figyelemmel hivatkozás nyomon követése és általános hivatkozás.Használja ezeket a lépéseket, hogy írjon egy tankönyv.

Lépések

egy. Ismerje meg a közönségét. Fedezze fel a közönség tudásának és tapasztalatának szintjét, figyelembe véve a tanulmányi kézikönyv címének szolgáltatását, rendszerét vagy termékét.

Használjon egyszerű nyelvet, és nyújtson széles körű rendszert vagy referenciainformációs tartalmat az új gungs számára. Az új felhasználóknak nem csak a terméket vagy rendszert kell tanulniuk, hanem hogyan kell használni őket.
Használjon magasabb szintű terminológiát és kevesebb referenciainformációt olyan csoportok számára, amelyek ismerik a terméket vagy a rendszert. A meglévő felhasználóknak vagy termékfelhasználóknak tudnia kell az új hozzáadott funkciókról.

Image A képzési kézikönyv írása 2. lépés

2. Írj egy tervet. A rendszer segít az információk megszervezésében. Ezenkívül segít abban, hogy megbizonyosodjon arról, hogy a rendszer vagy a termék összes elemét a tanulmányi kézikönyvben ismertetjük.

3. Indítsa el az orientációt. Vázolja fel a vállalat, szerepkörök és felelősség szerkezetét. Képzelje el a szabványos működési (munka) SOP-eljárások, irányelvek és QA mutatókat (minőségellenőrzés). Tekintse át néhány általános elveket, talán a listákon keresztül vagy a kulcsszavak használatával. Általánosságban elmondható, hogy az olvasó ismer valamit a témáról, vagy akár a szervezetről, és kiállítja a dolgokat.

Tartsa be az érdemek rövid orientációját. Újra olvassa el és válassza ki az összes szükségtelen kiegészítést.

4. Írjon egy tagot. Indítsa el az egyes fejezeteket a következő oldalakon bemutatott információk áttekintéséből. Használja a címsorokat, hogy minden fejezetben kisebb részekre szervezzenek információkat.

Indítsa el az egyes lépéseket vagy irányt az ige műveletből.

Ragaszkodjon a rövid irányelvekhez és lényegében.

Küldje el a referenciaadatokat a védjegyek külön területén, hogy mindent együtt tartson, és segítsen a felhasználóknak az elejétől kezdve.

egy
Figyelmeztető felhasználók bármilyen alternatív módon a lépések végrehajtásához. Ha több mint 1 módja van a művelet befejezéséhez, jelölje meg a tankönyvben.
Engedélyezze a képernyőképeket, ha megengedett. A System Screenshots vizuális juttatást nyújt, amely kiegészíti a szöveges utasításokat.
2. Készítsen külön összefoglaló részlegeket. Írjon rövid áttekintést az egyes szakaszokban található információk lényegéről. Az összehasonlító táblázatok azokat az információkat, amelyekre szüksége lehet, hogy rendszeresen olvassa a felhasználó rendszeresen, például billentyűkombinációk vagy mezőmeghatározásainak.
Helyezze be a lecke végső részeit az egyes fejezetek vége után. Hozzon létre egy alkalmazást vagy linkeket a kézikönyv végén, és kapcsolja be az összes folytatási leckét.
3. Töltsön próbaverziót. Válasszon ki egy olyan résztvevők csoportját, akik emlékeztetnek egy csoportot, amely a végső termékkézikönyvet használja. Hagyja, hogy a csoport egy oktatóanyagot használjon, és az olvashatósági felülvizsgálat, a javulás és a részek, amelyek többé-kevésbé részletes előadást igényelnek.
4. Az utasítások módosítása. Használja a tesztcsoportból kapott visszajelzést (felülvizsgálatok), hogy módosítsa a menedzsment tartalmát vagy bőségét.
Küldjön utasításokat a szerkesztők vagy alkalmazottak csoportjához. Kérd meg őket, hogy állítsák be az előnyök nyelvtanát és írásjelét.

Tippek

Adja meg a visszajelzési űrlapot (vélemények) a tanulmányi kézikönyvben. Az oktatóanyagok felhasználóinak lehetnek módja annak, hogy bármilyen javaslatot küldjenek vagy változtassák az osztályba, vagy dokumentum dokumentációjaként vagy termékként.