Com escriure un manual de procediment

Taula de continguts:

Anonim

Un procediment és com una recepta: un conjunt d'instruccions que indiquen clarament qui fa alguna cosa, quan s'ha de fer, com es fa i quina ha de ser el resultat. Escrigui cada pas en l'ordre que s'ha de completar. Compileu diversos procediments en un manual que està organitzat per la descripció del lloc de treball, el departament, la funció o el que sigui que la informació sigui més accessible per als usuaris del manual. No confongui polítiques amb procediments. Les polítiques són regles o declaracions de posició; Els procediments són els que segueixen les persones per dur a terme polítiques.

Articles que necessiteu

  • Documentació existent que pot ser material de recurs

  • Experts subjectes que coneixen la forma de realitzar els tràmits

Decidiu quins procediments documentar. Dos mètodes per triar el contingut del manual són per encarar possibles usuaris manuals per esbrinar quines tasques necessiten més informació o aclarir-ne, o bé podeu fer una llista de problemes operatius que podeu resoldre amb procediments clarament definits.

Recopila informació. Una persona que ja fa la tasca és el vostre millor recurs a menys que estigueu creant procediments des de zero. Observeu la persona que realitza la tasca i pren notes, o demana a la persona que escrigui per a vostè tots els passos involucrats en la tasca, així com qualsevol consell o advertència a través de l'experiència.

Estableix el disseny del vostre manual. Un format de dues columnes fa que els procediments siguin clars i fàcils de llegir. Títol de cada pàgina amb el nom del procediment, i posa sota el títol una llista o paràgraf de qualsevol fet que no sigui dins d'un pas, com la freqüència amb què es realitza el procediment i consells o advertències. El procediment s'ha de seguir després d'això en una taula de dues columnes.

Escriure un esborrany. A la columna de l'esquerra, indiqueu la persona responsable del procediment. A la columna dreta, llista els passos que realitza. Si el procediment implica diverses persones, tots haurien de poder veure clarament on estan en el procés i què han de fer.

Prova els procediments. Feu que algú no estigui familiaritzat amb els procediments per seguir-los des del projecte. És important utilitzar algú sense experiència, per la qual cosa la persona no adoptarà cap dreceres habituals ni brillarà en punts poc clars, un altre lector no entendria.

Revisa l'esborrany. Aclareu, afegiu, suprimiu i reorganitzeu els passos fins que els usuaris puguin seguir els procediments que llegeixin el manual.

Publica el manual. Inclou una taula de continguts perquè els lectors puguin localitzar ràpidament els procediments. Afegiu un glossari que defineixi qualsevol terminologia que sigui poc habitual o específic per a la vostra indústria.

Consells

  • No utilitzeu una variació elegant de les paraules per animar l'escriptura. Un "widget" és un widget cada vegada, no un "element" o un "dispositiu". Descriure les coses de manera consistent pot ser repetitiu, però millora la claredat dels lectors.