跳到正文
登录免费开始写
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 里围绕一个有用的结果、一套实用的流程和读者能跟上的示例,做出你的操作指南。

免费开始写你的书

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