Hogyan kell írni eljárási kézikönyvet

Tartalomjegyzék:

Anonim

Az eljárás olyan, mint egy recept - utasítások halmaza, amely egyértelműen kimondja, hogy ki csinál valamit, mikor kell megtenni, hogyan kell csinálni, és mi legyen az eredmény. Sorolja fel az egyes lépéseket a sorrendben, amelyet be kell fejezni. Állítson össze több eljárást egy olyan kézikönyvben, amelyet a munkaköri leírás, a részleg, a funkció vagy a rendelés szerint rendeznek meg, hogy az információk a kézikönyv felhasználóinak leginkább hozzáférhetők legyenek. Ne keverje össze a szabályokat az eljárásokkal. A politikák szabályok vagy állásfoglalások; eljárásokat követnek, amit az emberek követnek a politikák végrehajtásához.

A szükséges elemek

  • Meglévő dokumentáció, amely erőforrásanyag lehet

  • Tárgy szakértők, akik ismerik az eljárások végrehajtását

Döntse el, mely eljárásokat kell dokumentálni. A manuális tartalom kiválasztásának két módszere az, hogy felmérje a potenciális manuális felhasználókat, hogy megtudja, mely feladatokat kell tisztázni, vagy több információt szeretne kapni, vagy ha az operatív problémák listáját világosan meghatározták.

Információgyűjtés. Az a személy, aki már elvégzi a feladatot, a legjobb erőforrás, hacsak nem hoz létre eljárásokat a semmiből. Nézze meg a személyt, hogy végezze el a feladatot, és vegye fel a jegyzeteket, vagy kérje meg a személyt, hogy írja le az összes lépést a feladatban, valamint a tapasztalatok alapján megtanult tippeket és figyelmeztetéseket.

Állítsa be a kézikönyv elrendezését. A kétoszlopos formátum egyértelművé és könnyen olvashatóvá teszi az eljárásokat. Adjon meg minden oldalt az eljárás nevével, és tegye a cím alatt egy olyan listát vagy bekezdést, amely nem tartozik egy lépésbe, például az eljárás gyakoriságát és a tippeket vagy figyelmeztetéseket. Ezt az eljárást két oszlopban kell követni.

Írjon egy durva vázlatot. A bal oldali oszlopban felsorolja az eljárásért felelős személyt. A jobb oldali oszlopban sorolja fel azokat a lépéseket, amelyeket az adott személy végez. Ha az eljárás több embert is magában foglal, mindenkinek egyértelműen látnia kell, hol illeszkednek a folyamatba, és mit kell tennie.

Tesztelje az eljárásokat. Szerezz valakit, aki nem ismeri a tervezetből követendő eljárásokat. Fontos, hogy valaki tapasztalatlanul használjon, így a személy nem fog semmiféle szokásos parancsikont vagy fényt adni a tisztázatlan pontokon, amit egy másik olvasó nem ért.

Módosítsa a tervezetet. A lépések pontosítása, hozzáadása, törlése és átrendezése addig, amíg az eljárást követni nem tudja a kézikönyv olvasója.

Nyissa meg a kézikönyvet. Tartalmazza a tartalomjegyzéket, így az olvasók gyorsan megtalálhatják az eljárásokat. Adjon hozzá egy szószedetet, amely meghatározza az iparág számára nem szokványos vagy sajátos terminológiát.

tippek

  • Ne használjon elegáns szóváltozatot az írás élénkítésére. A "widget" egy widget minden alkalommal, nem egy "elem" vagy "eszköz". A dolgok következetes leírása ismétlődő lehet, de javítja az olvasók egyértelműségét.