Come scrivere un manuale di procedura

Sommario:

Anonim

Una procedura è come una ricetta: un insieme di istruzioni che indica chiaramente chi fa qualcosa, quando dovrebbe essere fatto, come è fatto e quale dovrebbe essere il risultato. Elenca ogni fase nell'ordine in cui deve essere completata. Compilare più procedure in un manuale organizzato per descrizione del lavoro, reparto, funzione o qualsiasi ordine rende le informazioni più accessibili agli utenti del manuale. Non confondere le politiche con le procedure. Le politiche sono regole o dichiarazioni di posizione; le procedure sono ciò che le persone seguono per attuare le politiche.

Articoli di cui avrai bisogno

  • Documentazione esistente che può essere materiale di risorse

  • Esperti in materia che sanno come eseguire le procedure

Decidi quali procedure documentare. Due metodi per la scelta del contenuto del manuale consistono nel sondare i potenziali utenti manuali per scoprire quali attività necessitano di chiarimenti o maggiori informazioni oppure si preferisce creare un elenco di problemi operativi che è possibile risolvere con procedure chiaramente definite.

Raccogliere informazioni. Una persona che sta già facendo l'attività è la tua migliore risorsa a meno che tu non stia creando procedure da zero. Osserva la persona che esegue l'operazione e prende appunti, o chiedi alla persona di scrivere per te tutti i passaggi coinvolti nell'attività, oltre a suggerimenti o avvertenze apprese tramite l'esperienza.

Stabilisci il layout del tuo manuale. Un formato a due colonne rende le procedure chiare e facili da leggere. Indica ogni pagina con il nome della procedura e metti sotto il titolo un elenco o paragrafo di fatti che non rientrano in una fase, ad esempio la frequenza con cui viene eseguita la procedura e suggerimenti o avvertenze. La procedura dovrebbe seguire dopo quella in una tabella a due colonne.

Scrivi una bozza approssimativa. Nella colonna di sinistra, elenca la persona responsabile della procedura. Nella colonna di destra, elenca in ordine i passaggi che la persona esegue. Se la procedura coinvolge più persone, dovrebbero essere tutte in grado di vedere chiaramente dove si inseriscono nel processo e cosa devono fare.

Prova le procedure Chiedere a qualcuno che non ha familiarità con le procedure per seguirli dalla bozza. È importante usare qualcuno inesperto, quindi la persona non prenderà alcuna scorciatoia abituale o sorveglierà punti non chiari che un altro lettore non capirebbe.

Revisionare la bozza. Chiarire, aggiungere, eliminare e riorganizzare i passaggi fino a quando le procedure possono essere seguite da chiunque legga il manuale.

Pubblica il manuale. Includi un sommario in modo che i lettori possano individuare rapidamente le procedure. Aggiungi un glossario che definisca una terminologia insolita o specifica per il tuo settore.

Suggerimenti

  • Non usare un'elegante variazione di parole per ravvivare la scrittura. Un "widget" è un widget ogni volta, non un "oggetto" o un "dispositivo". Descrivere le cose in modo coerente può essere ripetitivo, ma migliora la chiarezza per i lettori.