Sådan skrives en procedurehåndbog

Indholdsfortegnelse:

Anonim

En procedure er som en opskrift - et sæt instruktioner, der klart angiver hvem der gør noget, når det skal gøres, hvordan det er gjort og hvad resultatet skal være. Skriv hvert trin i den rækkefølge, den skal udfyldes. Kompilér flere procedurer i en manual, der er organiseret efter jobbeskrivelse, afdeling, funktion eller hvilken ordre der gør informationen mest tilgængelig for brugerens brugere. Forveks ikke politikker med procedurer. Politikker er regler eller erklæringer om stilling; procedurer er, hvad folk følger for at gennemføre politikker.

Elementer du skal bruge

  • Eksisterende dokumentation, der kan være ressource materiale

  • Faglige eksperter, der ved, hvordan man udfører procedurerne

Bestem hvilke procedurer der skal dokumenteres. To metoder til at vælge manualens indhold er at undersøge potentielle manuelle brugere for at finde ud af hvilke opgaver de har brug for præciseret eller mere information om, eller du foretrækker måske at lave en liste over operationelle problemer, du kan løse med klart definerede procedurer.

Samle information. En person, der allerede udfører opgaven, er din bedste ressource, medmindre du laver procedurer fra bunden. Se personen udføre opgaven og noter eller spørg personen om at skrive ned for dig alle de trin, der er involveret i opgaven, samt eventuelle tips eller advarsler, der er lært gennem erfaring.

Fastlæg din manuals layout. Et to-kolonne format gør procedurerne klare og nemme at læse. Titel på hver side med procedurens navn, og læg under titlen en liste eller et afsnit af eventuelle fakta, der ikke falder inden for et trin, f.eks. Hvor ofte proceduren udføres og tip eller advarsler. Proceduren skal følge efter det i en to-kolonne tabel.

Skriv et groft udkast. I den venstre kolonne skal du liste den person, der er ansvarlig for proceduren. I den højre kolonne skal du liste efter de trin, som personen udfører. Hvis proceduren involverer flere personer, skal de alle være i stand til tydeligt at se, hvor de passer ind i processen, og hvad de skal gøre.

Test procedurerne. Få nogen uvant med procedurerne for at følge dem fra udkastet. Det er vigtigt at bruge nogen uerfarne, så personen vil ikke tage nogen sædvanlige genveje eller glans over uklare punkter, som en anden læser ikke ville forstå.

Revider udkastet. Afklare, tilføj, slet og omstil trin, indtil procedurerne kan følges af alle, der læser manualen.

Udgiv håndbogen. Medtag indholdsfortegnelse, så læserne hurtigt kan finde procedurer. Tilføj en ordliste der definerer enhver terminologi, der er ualmindeligt eller specifik for din branche.

Tips

  • Brug ikke elegant ordvariation til at opleve skrivningen. En "widget" er en widget hver gang, ikke en "vare" eller en "enhed". Beskrive ting konsekvent kan være gentagne, men det forbedrer klarhed for læsere.