跳到正文
登录免费开始写
Bookeen

编写操作指南

操作指南帮助读者完成一项具体任务。先说清结果,再按可行的顺序展示步骤,并说明如何判断每一步是否成功。把最终结果放在开头几段,用读者自己的说法来写。然后从读者真正所处的起点展示第一步,而不是从一个理想的准备状态开始。当早期的一步能用眼睛检验、而不只是相信时,操作指南才赢得信任。

免费开始写你的书

什么是操作指南电子书?

操作指南是一部围绕「做事」组织起来的教学类图书:搭建一套流程、学习一项实用技能或完成一个项目。每一章都应让读者离承诺的结果更近一步。背景知识放在有助于做决定的地方,排错放在读者可能卡住的那一步附近。告诉读者最后会得到什么、开始之前需要什么,以及他们将如何知道某一步成功了。如果把结果埋在背景知识下面,读者要读上三页才能动手,很多人就此停下。

操作指南应该如何组织步骤?

操作指南应按照读者必须执行的先后顺序来安排动作。先说明起始条件,再描述动作,并展示如何检查它的结果。多步流程要编号,让读者能记住自己进行到哪一步。

“A procedure is a sequence of numbered steps for accomplishing a task.”

译文: 流程就是为完成一项任务而排列的带编号步骤。

— Google 开发者文档风格指南,Procedures
  • Google 的流程指导建议:单步流程用一句话加一个项目符号,而不是只含「1」的编号列表。
  • 对于包含两个或更多动作的流程,要把有顺序的步骤与无序的材料或选项列表区分开。
  • 在这个 Bookeen 工作坊示例中,使用三个检查点:确认受众、批准活动方案、检查材料。这个数字属于本示例,而不是每一份操作指南。

用 Bookeen 从你的流程笔记发展出章节顺序。然后亲自执行这些说明,或请合适的读者试一遍;看起来清晰的编号步骤,并不能证明流程真的可行。

来源核对 .

何时选择这种图书类型

  • 当读者需要一套可重复的流程时,选择操作指南。读者应当能说清自己在流程中的位置,以及完成时是什么样子。如果这本书主要是反思、没有可检验的步骤,另一种书更合适。
  • 先界定读者已经知道什么、开始前需要什么。写出他们已经拥有的工具、权限和词汇。一本写给所有人的指南,会解释真实读者早就懂的术语,又跳过他们特意来避开的那个具体错误。
  • 如果练习和书面作答承担了大部分价值,就改用练习册。小练习可以放在某个步骤旁边。如果大部分价值在于读者填写、决定并回看,就让那本书主导,把这一本留给流程。

实用大纲

  1. 说明结果和起始条件。用读者的话写出最终结果,再写他们真正开始的地方。一个与他们桌面不符的理想准备状态,会让第一步显得不可能。
  2. 汇总材料、信息或前提条件。只列出步骤会用到的内容。一长串可选装备的购物清单,会盖住读者开始前必须拥有的那两样东西。
  3. 用一个连贯的例子走完各个步骤。让同一个例子从第一步带到最后一步,读者才能看到工作如何变化。每一章换一个新例子,会迫使他们重新熟悉情境,而不是学会技能。
  4. 检查结果、排错,并规划下一步。告诉他们如果某一步失败会看到什么,以及接下来该尝试哪一个改动。把排错放在书末的一章,这些提醒就容易被错过。
示例

一份规划首场社区工作坊的指南

跟着一位组织者,从模糊的主题走到一份可行的活动方案。关于受众的一章确定谁应该参加。下一章把这些受众转成一个学习目标,再转成日程和材料清单。读者可以拿自己的决定与这个贯穿始终的例子对照,而不必在每一章都从零开始。让同一位组织者从第一个选择一直到最后一份清单都在视野里,让后面的章节引用这位组织者已经做过的决定。读者通过观察一个案例的变化来学会整个流程,而不是每次主题一变就面对一个新的假设。

操作指南应该面向谁?

操作指南应当面向一位明确定义的读者,并从一个清晰的起点出发。动笔之前先定义读者。在使用术语的地方解释术语,不要只因为自己熟悉这个主题就随意增加章节。写出读者已经尝试过什么,以及他们害怕做错什么。一本写给所有人的指南,会解释真实读者早就懂的术语,又跳过他们特意来避开的那个具体错误。

  • 尽早说明前提条件。用后面步骤会用的同一套说法,讲清他们在第一个动作之前需要什么。问题里换个同义词,常常看起来像一个新概念。
  • 把必需步骤和可选改进分开。必需步骤会改变结果。可选的改进可以这样标注出来。如果所有东西看起来都是必须的,读者会卡在那些并不影响结果的活儿上。
  • 让结果可以被观察到。读者能看见、能数、能比较的结果就是一次检验。只说他们会理解这个主题的结果,只是一种期望,指南无法据此检验。

检验操作说明

一份指南读起来可能很清楚,却漏掉了关键动作。像读者那样把整个流程走一遍。对照工具或界面的当前行为,检查步骤之间的依赖、示例以及所有引用。只用手头这一章列出的材料,按草稿亲自做一遍。每当你依赖了一个这一章从未提到的习惯,就把这个习惯补进页面,否则读者会在你顺利驶过的地方卡住。

  • 同一个动作始终使用一致的名称。
  • 在关键步骤之后加上检查点。
  • 说明常见错误和恢复办法。

在 Bookeen 中搭建草稿

把受众、目标和流程笔记交给 Bookeen。用这些输入先发展出一份大纲,再逐章检查是否遗漏了步骤。你的经验和核对,才让这些说明真正有用。带上一次真实的尝试,包括你平常会犹豫的那一点。让它给出下一步,以及能告诉你这一步成功了的检验方法。然后在接受这套措辞之前,先试着做那项检验。

  • 让一个例子贯穿整份指南。
  • 用具体的决定和行动替换泛泛的建议。
  • 在准备读者文件之前,通读整个流程。

比较图书类型

读者、文件与下一步

探索一个相关的写作场景,然后选择适合你读者的版本。

探索 Bookeen 图书创作工具

编写操作指南:常见问题解答

操作指南和练习册有什么不同?

操作指南讲解一套流程。练习册给读者空间和提示去实践它。两者可以结合,但应让其中一种主导结构,读者才知道该照着做,还是完成练习。如果读者主要是照着指示做,你写的就是操作指南。如果他们主要是填写、决定并回看自己写下的内容,重心就在练习册。两种方式都可以放进一个小练习,但应让其中一项工作主导。

每一章都需要一样长吗?

不需要。给每一步足够的说明,让它可用即可。复杂的决定可能需要备选方案和一个例子;简单的动作也许只要一句简短说明和一次检查。花一分钟就能完成的步骤应当短一些。人们常常失败的那一步,值得给一个例子和一次检查。章节长度相等是一种设计习惯,不是对读者的服务。

操作指南应该包含排错内容吗?

应该,前提是你能找出真正的失败点。在相关步骤附近说明症状、可能的原因和下一步。不要为了把一章写长而凭空编造问题。对,就放在出现麻烦的那一步旁边。告诉读者如果这一步失败会看到什么,以及接下来该尝试哪一个改动。把排错放在书末的一章,这些提醒就容易被错过。

能把我已有的文章改写成一份指南吗?

可以,但要把它们改写成一条连贯的流程。删掉重复的引言,补上步骤之间的缺口,并保持术语一致。一份有用的指南需要一段连续的读者旅程,而不只是一堆文章的合集。先删掉那些无助于这位读者达到这个结果的内容。为不同场合写的文章会留下缺口和重复。给合并后的草稿一个起点和一种检验结尾的方式。

应该选择哪种文件格式?

EPUB 适合读者会在不同屏幕上调整大小的文本。PDF 保留固定的版式。修订期间保留一份可编辑的书稿,分享之前先检查导出的版本。选择与读者使用步骤的方式相匹配的文件。流动的文本适合他们在手机上阅读的指南。必须让图表和清单保持在一起的页面,需要固定版式。等步骤清楚之后再做这个选择,并检查实际的文件。

把你的经验变成清晰的步骤。

在 Bookeen 里围绕一个有用的结果、一套实用的流程和读者能跟上的示例,做出你的操作指南。

免费开始写你的书

简单的月度方案随时取消一切归你所有