如何编写程序手册

程序就像一个食谱 - 一组指令，清楚地说明谁做某事，什么时候应该做，做得如何以及结果应该是什么。按顺序列出每个步骤。在按作业说明，部门，功能或任何顺序组织的手册中编译多个程序，使手册的用户最容易访问这些信息。不要将政策与程序混淆。政策是规则或立场声明;程序是人们遵循的政策。

你需要的物品

确定要记录的程序。选择手册内容的两种方法是调查潜在的手动用户，以找出他们需要澄清哪些任务或更多信息，或者您可能更愿意列出您可以通过明确定义的程序解决的操作问题。

收集信息。除非您从头开始创建过程，否则已完成任务的人员是您最好的资源。观察执行任务的人并做笔记，或要求此人为您写下任务中涉及的所有步骤，以及通过经验学到的任何提示或警告。

建立手册的布局。双列格式使程序清晰易读。使用程序的名称标题每个页面，并在标题下方放置不属于某个步骤的任何事实的列表或段落，例如执行该程序的频率以及提示或警告。之后应该在两列表中执行该过程。

写一份草稿。在左栏中，列出负责该过程的人员。在右列中，按顺序列出人员执行的步骤。如果程序涉及多个人，他们都应该能够清楚地看到他们在过程中的位置以及他们需要做什么。

测试程序。让不熟悉程序的人从草稿中跟随他们。使用缺乏经验的人是很重要的，因此这个人不会采取任何习惯性的捷径或掩盖其他读者不理解的不明确点。

修改草案。澄清，添加，删除和重新排列步骤，直到阅读本手册的任何人都可以遵循程序。

发布手册。包括目录，以便读者可以快速找到程序。添加词汇表，定义任何不常见或特定于您所在行业的术语。