从读者角度呈现信息

*节选自 Developing Quality Technical Information, A Handbook for Writers and Editors, 2nd Edition *

从读者角度呈现信息很容易把读者带入“故事”,读者容易想象你所描述的任务的执行过程。

这种写作方式有以下特点:

  • 明确的指向性,多以第二人称(you)为主语。
  • 使用主动语态,使用不同动词,区分读者要进行的动作与产品本身进行的动作。
  • 给出动作的原因。

以下通过几个示例进行说明。

示例一

image.png

评析:
修改前:使用了被动语态,动作主体及原因均不明确。

修改后:修订版本中,将读者作为动作参与者,“you might lose data” 也阐述了该动作的理由,与读者联系起来——“他们不想丢失数据”。

示例二

image.png

评析:
修改前:读者并不能十分清楚原稿中信息与他们有何关联。

修改后:在修改后的版本中,将读者纳入到“故事”中,解释说明了他们为什么要使用这个功能。

提供一个任务帮助时,你十分清楚读者当前所在的界面位置,因而也十分清楚进行任务的哪一部分读者会需要帮助。这一优势能帮助你很好地从读者的角度组织针对性的主题信息。

示例三
以下是个帮助信息,假定读者需要获取Create Table向导的Primary Key 页面(一个第三方页面)的帮助信息。

image.png

image.png

评析:
修改前:若读者已完成了了“Creating a table” 任务的大部分步骤,仅仅需要知道如何指定primary key的一些信息,即creating table的子步骤。修改前的版本成功地“浪费”了读者的时间,提供了很多已经完成的步骤。

修改后:从读者当前可能的位置出发,组织任务信息,同时还提供了primary key概念的链接,以防有些读者在开始任务之前需要了解这些背景信息和概念。

一旦理解了读者的角度,你就可以写出基于任务的主题信息,以帮助读者顺利完成任务。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,896评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,760评论 18 399
  • MySQL技术内幕:InnoDB存储引擎(第2版) 姜承尧 第1章 MySQL体系结构和存储引擎 >> 在上述例子...
    沉默剑士阅读 7,460评论 0 16
  • 一. Java基础部分.................................................
    wy_sure阅读 3,835评论 0 11
  • 2017.7.29 周六 李彤 月芽宝贝36天 天气凉快,麻麻和宝贝一样开心,宝贝脸上身上小痱痱小疹疹基本都逃离啦...
    朴落阅读 307评论 0 0