Hvordan skrive en prosedyrhåndbok

Innholdsfortegnelse:

Anonim

En prosedyre er som en oppskrift - et sett med instruksjoner som klart sier hvem som gjør noe, når det skal gjøres, hvordan det er gjort og hva resultatet skal være. Skriv hvert trinn i den rekkefølgen den må være ferdig med. Samle flere prosedyrer i en håndbok som er organisert av jobbbeskrivelse, avdeling, funksjon eller hvilken rekkefølge som gjør informasjonen mest tilgjengelig for brukerens brukerhåndbok. Ikke forveksle retningslinjer med prosedyrer. Politikk er regler eller uttalelser av stilling; prosedyrer er hva folk følger for å gjennomføre politikk.

Elementer du trenger

  • Eksisterende dokumentasjon som kan være ressursmateriale

  • Saksfelt eksperter som vet hvordan å utføre prosedyrene

Bestem hvilke prosedyrer som skal dokumenteres. To metoder for å velge håndbokens innhold er å undersøke potensielle manuelle brukere for å finne ut hvilke oppgaver de trenger klarlagt eller mer informasjon om, eller du kan foretrekke å lage en liste over operative problemer du kan løse med klart definerte prosedyrer.

Samle inn informasjon. En person som allerede gjør oppgaven, er din beste ressurs med mindre du lager prosedyrer fra bunnen av. Se personen utføre oppgaven og ta notater, eller be personen om å skrive ned for deg alle trinnene som er involvert i oppgaven, samt eventuelle tips eller advarsler lært gjennom erfaring.

Opprett håndbokens layout. Et to-kolonne format gjør prosedyrer klare og enkle å lese. Tittel på hver side med prosedyrens navn, og sett under tittelen en liste eller et avsnitt av noen fakta som ikke faller innenfor et trinn, for eksempel hvor ofte prosedyren utføres og tips eller advarsler. Prosedyren bør følge etter det i en to-kolonne tabell.

Skriv et grovt utkast. I den venstre kolonnen, oppgi personen som er ansvarlig for prosedyren. I høyre kolonne, liste i rekkefølge trinnene som personen utfører. Hvis prosedyren involverer flere personer, bør de alle kunne tydelig se hvor de passer i prosessen og hva de trenger å gjøre.

Test prosedyrene. Få noen ukjent med prosedyrene for å følge dem fra utkastet. Det er viktig å bruke noen uerfaren, så personen vil ikke ta noen vanlige snarveier eller gloss over uklare poeng som en annen leser ikke ville forstå.

Endre utkastet. Forklar, legg til, slett og omarbeide trinnene til prosedyrene kan følges av alle som leser håndboken.

Publiser håndboken. Ta med innholdsfortegnelse slik at leserne raskt kan finne prosedyrer. Legg til en ordliste som definerer hvilken terminologi som er uvanlig eller spesifikk for din bransje.

Tips

  • Ikke bruk elegant ordvariasjon for å gi opp skrivingen. En "widget" er en widget hver gang, ikke et "element" eller en "enhet". Beskrive ting konsekvent kan være repeterende, men det forbedrer klarheten for leserne.