英语技术文档中如何正确使用人称?

Foreword

之前跟大家分享了英语技术文档中如何正确使用时态,得到了来自一些学生、老师,以及其他小伙伴很好的反馈。

在日常 Review 技术文档时,我发现除了时态问题,另一个比较常见的问题就是人称问题。尤其是对于 Technical Writer 新手,贡献技术文档的程序员,以及运维小伙伴们来说,人称的使用往往会出现不规范的情况。

出现这种问题,最主要的原因就是技术文档输出者对于技术文档规范不了解。

像 IBM 和 Google 这种大外企对技术文档规范都有各自详细的说明,虽不完全相同,但都遵循业内一些基本的规范。如果你是相关专业的学生,或者是一枚 Technical Writer,那你很可能对 IBM 和 Google 的规范多多少少有所了解。毕竟,IBM 在这个领域内是一种资深的存在。

接下来,我会结合 IBM 和 Google 的文档规范与示例,跟大家分享一下英语技术文档中该如何正确使用第一人称、第二人称,以及第三人称。

第一人称

第一人称代词包括:

  • I, me, my, mine, myself
  • we, us, our, ours, ourselves

第一人称代词虽然有很多,但容易用错的主要是 we 和 our。We 这个词尤其需要注意,不了解技术文档规范的小伙伴很容易,甚至很喜欢用这个词。

关于第一人称在技术文档中的使用,大家需要知道以下两点:

  1. 技术文档中避免使用第一人称。

    原因:

    • 第一人称太过主观。

      第一人称从文档作者的主观角度出发,而非文档的读者或者文档传达的信息。

      然而,技术文档撰写出来的目的就是服务于产品用户即文档使用者的。如果不以文档使用者为中心,就偏离了文档的目的。脱离目标受众的文档不会是好的文档。

      此外,规范的技术文档中,作者应该是隐身的,不能在技术文档中流露出个人主观的态度和观点等。

    • 第一人称太不正式。

      主观的口吻很容易给人一种不正式的感觉,就像其它正式的文体也会保持客观一样。

      设想一下,如果在用户文档里使用了很多 we,文档读者可能会疑惑:你是那样操作的,那我按你说的步骤来操作可以得到想要的结果吗?除了不正式,还容易导致不够明确。而直接以客观的口吻告诉读者怎么做就会避免此类问题。

    举例:

    • 错误示例 1Let's start by planning the home page for the website.

    • 正确示例 1Start by planning the home page for the website.

    • 错误示例 2We can add a model to the project that we created in the previous step.

    • 正确示例 2You can add a model to the project that you created in the previous step.

    • 错误示例 3If we're deleting multiple entries at a time ...

    • 正确版本 1If you're deleting multiple entries at a time ...

    • 正确版本 2When deleting multiple entries at a time ...(需注意前后主语一致)

2.(例外)在以下情境中可以使用第一人称。

  • FAQ 的问题部分。
  • 博客文章、白皮书,以及描述作者观点的其它文档中。

举例:

  • 错误示例:Q: How does one change the properties of a class? Tests were conducted on servers in three different environments.
  • 正确示例:Q: How do I change the properties of a class? We conducted tests on servers in three different environments.

第二人称

第二人称代词包括:you,your,yours,yourself,yourselves。在技术文档中,第二人称主要指 you 这个词。

关于第二人称在技术文档中的使用,大家同样需要知道以下两点:

  1. 尽可能多地使用第二人称 you。

    为什么呢?因为第二人称关注的是文档的使用者或产品用户,即文档的目标受众。

    正确示例:When you create a database, you must provide a unique name.

  2. 如果是指导用户执行某项操作,使用祈使句,主语默认为 you,不必再加。

    注意:由于祈使句已经有默认的主语 you,在英文句子里通常不需要再加一个 you。

    • 错误示例 1:Let's click Submit now.
    • 错误示例 2:We now click Submit.
    • 稍好一些版:You now click Submit.
    • 正确建议版:Click Submit.

第三人称

第三人称代词包括:

  • he, him, his, himself
  • she, her, hers, herself
  • it, its, itself
  • they, them, their, theirs, and themselves

关于第三人称在技术文档中的使用,大家需知道这一点:使用第三人称来描述概念、事实和结果。

第三人称关注的是所呈现的信息本身。大多数情况下,技术信息是关于事物而不是人。因此,第三人称可使用名词第三人称代词(如 it 和 they)来表示。当使用第三人称时,除非上下文要求,否则不要使用特定性别的人称代词,例如 he 和 she。

  • 正确示例 1The first three exercises show how to build complex models.
  • 正确示例 2:Specify whether users can add themselves to a project.

Afterword

以上便是英语技术文档中人称使用的一些规范,只要了解了并在写文档或 Review 文档时多加注意,就能有效地避免错误,让文档更规范、更明确、更易用。

再划一下重点:慎用第一人称,多用第二人称 you,祈使句里隐藏 you。

参考资料:

你可能想读

技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 可提供的交付物有哪些?
GitHub + Markdown 的新轻型技术写作模式速览
GitHub + Markdown 的技术文档方案深度解析
Technical Writer 日常工作中好用的小工具
技术传播人士应该知道的色彩搭配常识
如何使用颜色来提高技术文档的可读性?
Technical Writer 如何 Review 技术文档?| 重细节+全局观
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
英语技术文档的标题到底该大写还是小写?
不同阶段如何应对 Technical Writer 的职业顾虑或烦恼?
如何使用正则表达式批量添加和删除字符?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
Technical Writer 需要 Technical 到会写代码吗?
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记

-END-

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

推荐阅读更多精彩内容

  • Foreword 关于英语技术文档的时态问题,相信上过英语技术文档写作课程或者自己阅读过相关专业书籍的 Techn...
    Lilian_Lee阅读 1,692评论 0 3
  • 文/小绾西 01 前年机缘巧合下得到一份杭州的工作,我也是在那里的两个月,认识了小苏。 当时她在杭州上大学,周末到...
    小绾西阅读 1,835评论 10 20
  • 我是发现生活中的美第八期的播报员。 拥有一双发现美的眼睛,拥有一颗耐心体味的心,无论身处何种环境,用心发现生活中的...
    前_773a阅读 109评论 0 0
  • 你知道怎么科学有效的减肥吗? 现在市面上流行几种减肥方法,我分别来说说这些方法有什么问题,错在哪?以及,正确的减肥...
    一枚冰儿阅读 430评论 1 0
  • 相比重口味,本人更喜欢清淡和原汁原味。重油重盐重辣,都对身体健康有不利影响。 蒜炒苦瓜,很简单的一...
    夏苏牧雅落阅读 457评论 0 1