编写程序手册的指南

程序手册是用于各种就业设置的有用工具。员工是否需要知道如何操作复印机或如何完成所需的健康与安全培训,都可以通过程序手册来概述这些步骤。许多雇主设计了组合的“政策和程序”手册,但重要的是要认识到区别:政策反映规则,而程序反映流程以及如何完成它们。在编写有效的程序手册时,必须专注于程序本身,并提供对员工完成程序更有用的信息。

特质

程序手册应该易于阅读和使用。仅需要阅读自己的程序手册的程序手册对任何员工来说都没有多大用处。此外,程序手册在所有元素上都应保持一致,包括样式,设计和信息。程序手册旨在帮助他人完成某项任务,因此在编写时应牢记读者的注意。所描述的过程应该清晰且合乎逻辑,以便所有读者都可以毫无困难地遵循该过程。

特征

根据详细信息的类型,程序手册的特定功能会有所不同。然而,在大多数情况下,有效的程序手册必须采用清晰一致的格式,以便读者知道如何阅读本手册。段落应该开始和结束而不会引起混淆,读者也不必怀疑一个步骤在哪里结束而另一步骤在哪里开始。在描述步骤时,作者应使用强烈的动作动词以确保读者确切地知道该怎么做,并在适当时提供解释和选择。任何图标、图像或图形/图表都应该易于理解且易于遵循。

写作风格

程序手册的写作风格应使用简洁明了的语言。所有程序信息均应准确无误,所有缩写词应在括号中加以说明,例如“食品和药物管理局(FDA)”。在将要散发一段时间的程序手册中,请避免使用可能会很快过时的特定信息。应当避免大多数人不熟悉的技术语言和行话。

设计

程序手册的设计将在很大程度上取决于所概述的程序类型,但是某些设计建议适用于所有程序手册。一本好的程序手册会占用大量空白。就是说,手册并没有印刷过多,而是提供了许多缩进和段落间的间隔,以免吓倒读者。有效的程序手册也有清晰的标题和副标题,以及任何其他适当的标签和许多要点的概述。

职责范围

负责编写程序手册的人员还负责定期对其进行审查。如果材料变得无关紧要,则应将其删除或更新。如果该信息不能有效地帮助员工,则应该对手册进行修订和完善。程序手册仅与使读者能够完成的工作一样有用,如果手册未能做到,则作者有责任对其进行更改。