Hur man skriver en procedurhandbok

Innehållsförteckning:

Anonim

Ett förfarande är som ett recept - en uppsättning instruktioner som tydligt anger vem som gör någonting, när det ska ske, hur det görs och vad resultatet ska vara. Ange varje steg i den ordning som den måste fyllas i. Kompilera flera procedurer i en manual som är organiserad av arbetsbeskrivning, avdelning, funktion eller vilken ordning som gör informationen tillgänglig för handbokens användare. Förväxla inte politik med förfaranden. Politiken är regler eller ställningstaganden; förfaranden är vad folk följer för att genomföra politik.

Föremål du behöver

  • Befintlig dokumentation som kan vara resursmaterial

  • Ämnesexperter som vet hur man utför förfarandena

Bestäm vilka förfaranden som ska dokumenteras. Två metoder för att välja handbokens innehåll är att undersöka potentiella manuella användare för att ta reda på vilka uppgifter de behöver klargöras eller mer information om, eller kanske du föredrar att göra en lista över operativa problem som du kan lösa med tydligt definierade förfaranden.

Samla information. En person som redan gör uppgiften är din bästa resurs om du inte skapar rutiner från början. Titta på personen utföra uppgiften och ta anteckningar eller fråga personen om att skriva ner för dig alla steg som är inblandade i uppgiften, samt eventuella tips eller varningar som lärt sig genom erfarenhet.

Upprätt din manuals layout. Ett format med två kolumner gör procedurerna tydliga och lätta att läsa. Titel varje sida med procedurens namn och sätt under rubriken en lista eller ett stycke av några fakta som inte faller inom ett steg, till exempel hur ofta förfarandet utförs och tips eller varningar. Förfarandet bör följas efter det i en tabell med två kolumner.

Skriv ett grovt utkast. I den vänstra kolumnen ska du lista den person som är ansvarig för förfarandet. I den högra kolumnen listar du de steg som personen utför. Om förfarandet omfattar flera personer, ska de alla kunna se tydligt hur de passar i processen och vad de behöver göra.

Testa procedurerna. Få någon som inte är bekant med förfarandena för att följa dem från utkastet. Det är viktigt att använda någon oerfaren, så personen kommer inte att ta några vanliga genvägar eller glans över oklara punkter som en annan läsare inte skulle förstå.

Ändra utkastet. Klargör, lägg till, radera och ändra steg tills procedurerna kan följas av någon som läser handboken.

Publicera handboken. Inkludera en innehållsförteckning så att läsare snabbt kan hitta procedurer. Lägg till en ordlista som definierar vilken terminologi som är ovanlig eller specifik för din bransch.

tips

  • Använd inte elegant ordvariant för att uppleva skrivandet. En "widget" är en widget varje gång, inte ett "objekt" eller en "enhet". Att beskriva saker konsekvent kan vara repeterande, men det förbättrar tydligheten för läsarna.