Como escrever um manual de procedimentos

Índice:

Anonim

Um procedimento é como uma receita - um conjunto de instruções que afirma claramente quem faz alguma coisa, quando deve ser feito, como é feito e qual deve ser o resultado. Liste cada etapa na ordem em que ela deve ser concluída. Compile vários procedimentos em um manual organizado por descrição de cargo, departamento, função ou qualquer outro pedido que torne as informações mais acessíveis aos usuários do manual. Não confunda políticas com procedimentos. Políticas são regras ou declarações de posição; procedimentos são o que as pessoas seguem para executar as políticas.

Itens que você precisará

  • Documentação existente que pode ser material de recurso

  • Especialistas no assunto que sabem executar os procedimentos

Decida quais procedimentos documentar. Dois métodos para escolher o conteúdo do seu manual são pesquisar usuários manuais em potencial para descobrir quais tarefas eles precisam ser esclarecidas ou mais informações, ou você pode preferir fazer uma lista de problemas operacionais que você poderia resolver com procedimentos claramente definidos.

Juntar informação. Uma pessoa que já está fazendo a tarefa é seu melhor recurso, a menos que você esteja criando procedimentos a partir do zero. Observe a pessoa realizar a tarefa e fazer anotações, ou peça à pessoa para escrever para você todas as etapas envolvidas na tarefa, bem como quaisquer dicas ou avisos aprendidos com a experiência.

Estabeleça o layout do seu manual. Um formato de duas colunas torna os procedimentos claros e fáceis de ler. Dê um título a cada página com o nome do procedimento e coloque abaixo do título uma lista ou um parágrafo de todos os fatos que não se enquadram em uma etapa, como a frequência com que o procedimento é realizado e dicas ou avisos. O procedimento deve seguir depois disso em uma tabela de duas colunas.

Escreva um rascunho. Na coluna da esquerda, liste a pessoa responsável pelo procedimento. Na coluna da direita, liste em ordem as etapas que a pessoa realiza. Se o procedimento envolver várias pessoas, todas devem poder ver claramente onde elas se encaixam no processo e o que precisam fazer.

Teste os procedimentos. Peça a alguém familiarizado com os procedimentos para segui-los no rascunho. É importante usar alguém inexperiente, de modo que a pessoa não use atalhos habituais nem encare os pontos obscuros que outro leitor não entenderia.

Revise o rascunho. Esclareça, adicione, elimine e reorganize as etapas até que os procedimentos possam ser seguidos por qualquer pessoa que leia o manual.

Publique o manual. Inclua um índice para que os leitores possam localizar rapidamente os procedimentos. Adicione um glossário que defina qualquer terminologia incomum ou específica para o seu setor.

Dicas

  • Não use variações de palavras elegantes para animar a escrita. Um "widget" é um widget sempre, não um "item" ou um "dispositivo". Descrever as coisas consistentemente pode ser repetitivo, mas melhora a clareza para os leitores.