Как написать руководство по процедуре

Оглавление:

Anonim

Процедура похожа на рецепт - набор инструкций, в которых четко указывается, кто что-то делает, когда это должно быть сделано, как это делается и каков должен быть результат. Перечислите каждый шаг в том порядке, в котором он должен быть выполнен. Скомпилируйте несколько процедур в руководстве, которое организовано по должностной инструкции, отделу, функции или в зависимости от того, какой порядок делает информацию наиболее доступной для пользователей руководства. Не путайте политики с процедурами. Политики - это правила или заявления о позиции; Процедуры - это то, что люди следуют, чтобы проводить политику.

Предметы, которые вам понадобятся

  • Существующая документация, которая может быть ресурсным материалом

  • Эксперты в данной области, которые знают, как выполнять процедуры

Решите, какие процедуры документировать. Два способа выбора содержания вашего руководства - опрос потенциальных пользователей руководства, чтобы выяснить, какие задачи им необходимо уточнить или получить дополнительную информацию, или вы можете составить список операционных проблем, которые вы могли бы решить с помощью четко определенных процедур.

Собрать информацию. Человек, уже выполняющий задачу, является вашим лучшим ресурсом, если вы не создаете процедуры с нуля. Наблюдайте за тем, как человек выполняет задание, и делайте заметки, или попросите его записать для вас все шаги, связанные с заданием, а также любые советы или предупреждения, полученные из опыта.

Установите макет вашего руководства. Формат в две колонки делает процедуры понятными и удобными для чтения. Назовите каждую страницу названием процедуры и поместите под заголовком список или абзац любых фактов, не подпадающих под действие шага, например, как часто выполняется процедура, а также советы или предупреждения. Процедура должна следовать после этого в таблице из двух столбцов.

Напишите черновик. В левом столбце укажите лицо, ответственное за процедуру. В правом столбце укажите порядок действий, которые выполняет этот человек. Если в процедуре участвуют несколько человек, все они должны иметь возможность четко видеть, где они вписываются в процесс и что им нужно делать.

Протестируйте процедуры. Получите кого-то незнакомого с процедурами, чтобы следовать им из проекта. Важно использовать кого-то неопытного, чтобы он не использовал привычные ярлыки и не скрывал неясные моменты, которые другой читатель не поймет.

Пересмотреть проект. Уточняйте, добавляйте, удаляйте и переставляйте шаги до тех пор, пока кто-нибудь не прочитает руководство.

Опубликовать руководство. Включите оглавление, чтобы читатели могли быстро найти процедуры. Добавьте глоссарий, определяющий любую терминологию, которая необычна или специфична для вашей отрасли.

подсказки

  • Не используйте элегантное изменение слов, чтобы оживить написание. «Виджет» - это каждый раз виджет, а не «элемент» или «устройство». Последовательное описание вещей может быть повторяющимся, но это улучшает ясность для читателей.