Hoe een procedurehandleiding te schrijven

Inhoudsopgave:

Anonim

Een procedure is als een recept: een reeks instructies die duidelijk aangeven wie iets doet, wanneer het moet gebeuren, hoe het gedaan is en wat het resultaat zou moeten zijn. Maak een lijst van elke stap in de volgorde waarin deze moet zijn voltooid. Stel meerdere procedures samen in een handleiding die is ingedeeld op functieomschrijving, afdeling, functie of welke volgorde de informatie het meest toegankelijk maakt voor gebruikers van de handleiding. Verwar beleid niet met procedures. Beleid zijn regels of standpunten; procedures zijn wat mensen volgen om beleid uit te voeren.

Items die je nodig hebt

  • Bestaande documentatie die mogelijk als grondstof kan worden gebruikt

  • Experten op het gebied van onderwerpen die weten hoe ze de procedures moeten uitvoeren

Bepaal welke procedures moeten worden vastgelegd. Twee methoden om de inhoud van uw handleiding te kiezen, zijn om potentiële handmatige gebruikers te onderzoeken om uit te vinden welke taken ze verduidelijkt of meer informatie nodig hebben, of u kunt een lijst maken van operationele problemen die u kunt oplossen met duidelijk omschreven procedures.

Informatie verzamelen. Een persoon die de taak al uitvoert, is uw beste bron, tenzij u vanuit het niets procedures aan het maken bent. Bekijk de persoon die de taak uitvoert en notities maakt, of vraag de persoon om voor u alle stappen te noteren die bij de taak zijn betrokken, evenals tips of waarschuwingen die door ervaring zijn geleerd.

Bepaal de lay-out van uw handleiding. Een tweekolomsformat maakt de procedures overzichtelijk en gemakkelijk leesbaar. Titel elke pagina met de naam van de procedure en zet onder de titel een lijst of alinea van feiten die niet binnen een stap vallen, zoals hoe vaak de procedure wordt uitgevoerd en tips of waarschuwingen. De procedure moet daarna volgen in een tabel met twee kolommen.

Schrijf een ruwe schets. In de linkerkolom een ​​lijst van de persoon die verantwoordelijk is voor de procedure. In de rechterkolom, lijst om de stappen die persoon uitvoert. Als de procedure meerdere mensen betreft, moeten ze allemaal duidelijk kunnen zien waar ze passen in het proces en wat ze moeten doen.

Test de procedures. Laat iemand onbekend zijn met de procedures om ze te volgen vanuit de draft. Het is belangrijk om iemand onervaren te gebruiken, zodat de persoon geen gebruikelijke snelkoppelingen of onduidelijke punten gebruikt die een andere lezer niet zou begrijpen.

Herzie de diepgang. Verduidelijken, toevoegen, verwijderen en herschikken van stappen tot de procedures kunnen worden gevolgd door iedereen die de handleiding leest.

Publiceer de handleiding. Neem een ​​inhoudsopgave op zodat lezers snel de procedures kunnen vinden. Voeg een woordenlijst toe die elke terminologie definieert die ongebruikelijk of specifiek is voor uw branche.

Tips

  • Gebruik geen elegante woordvariatie om het schrijven levendiger te maken. Een "widget" is elke keer een widget, geen "item" of een "apparaat". Het consistent beschrijven van dingen kan repetitief zijn, maar het verbetert de leesbaarheid van de lezer.