Smernice za pisanje priročnikov za pisanje

Priročniki s postopki so uporabna orodja za različne zaposlitvene nastavitve. Ne glede na to, ali morajo zaposleni vedeti, kako upravljati s fotokopirnim strojem, ali kako opraviti zahtevano usposabljanje na področju zdravja in varnosti, lahko postopkovni priročnik nudi pregled korakov. Številni delodajalci oblikujejo kombinirane priročnike za "politike in postopke", vendar je pomembno prepoznati razlikovanje: politike odražajo pravila, medtem ko postopki odražajo procese in kako jih dokončati. Pri sestavljanju učinkovitega postopkovnega priročnika se je treba osredotočiti na sam postopek in zagotoviti informacije, ki bodo zaposlenim bolj koristne za njegovo izvedbo.

Kakovosti

Priročnik s postopki mora biti enostaven za branje in uporabo. Priročnik s postopki, ki zahteva svoj priročnik s postopki, samo da ga prebere, nobenemu zaposlenemu ne koristi. Poleg tega mora biti priročnik s postopki skladen v vseh elementih, vključno s slogom, oblikovanjem in informacijami. Priročnik s postopki je zasnovan tako, da pomaga drugim pri izpolnjevanju določene naloge, zato ga je treba napisati z mislijo na bralce. Opisani postopki morajo biti jasni in logični, tako da lahko vsi bralci brez težav upoštevajo postopek.

Lastnosti

Priročniki s postopki se bodo glede na vrsto podrobnih informacij razlikovali glede na značilnosti. Večinoma pa so učinkoviti postopkovni priročniki tisti, ki imajo jasno in dosledno oblikovanje, tako da bralci vedo, kako slediti gradivu. Odstavki se morajo začeti in končati brez zmede, bralci pa se ne bi smeli spraševati, kje se en korak konča in drugi začne. Pri opisovanju korakov bi morali pisci z glagoli z močnim dejanjem zagotoviti, da bralci natančno vedo, kaj storiti, in po potrebi ponuditi pojasnila in možnosti. Vse ikone, slike ali grafi / grafikoni morajo biti očitni za razumevanje in enostavni za sledenje.

Stil pisanja

Način pisanja postopkovnega priročnika se mora zanašati na jasen in jedrnat jezik. Vse postopkovne informacije bi morale biti natančne, vse kratice pa je treba pojasniti z obrazložitvijo v oklepaju - na primer "Uprava za hrano in zdravila (FDA)". V priročnikih za postopke, ki bodo v uporabi nekaj časa, se izogibajte uporabi določenih informacij, ki bi lahko hitro zastarele. Izogibati se je treba tehničnim jezikom in žargonom, ki jih večina ne pozna.

Oblikovanje

Zasnova postopkovnega priročnika bo v veliki meri odvisna od vrste postopka, ki je opisan, vendar nekatera priporočila za oblikovanje veljajo za vse priročnike za postopke. Dober priročnik za postopke uporablja veliko prostora. Se pravi, da priročnik ni preobremenjen s tiskom, temveč ponuja veliko vdolbin in prelomov odstavkov, da se bralca ne prestraši. Priročniki za učinkovite postopke imajo tudi jasne naslove in podnaslove ter vse druge ustrezne nalepke in orise za številne točke.

Odgovornosti

Odgovorni za pisanje priročnikov za postopke so odgovorni tudi za njihovo redno pregledovanje. Če material postane nepomemben, ga je treba odstraniti ali posodobiti. Če informacije ne pomagajo zaposlenim, je treba priročnik revidirati in izboljšati. Priročnik s postopki je uporaben le toliko, kot je delo, ki ga bralcem omogoča, in če priročnik tega ne stori, je pisatelj odgovoren, da ga spremeni.