从读者角度呈现信息

*节选自 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概念的链接,以防有些读者在开始任务之前需要了解这些背景信息和概念。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容

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