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

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，文档读者可能会疑惑：你是那样操作的，那我按你说的步骤来操作可以得到想要的结果吗？除了不正式，还容易导致不够明确。而直接以客观的口吻告诉读者怎么做就会避免此类问题。

   举例：

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

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

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

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

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

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

   • 正确版本 2：When 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。

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

Afterword

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

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

参考资料：

• The IBM Style Guide，介绍见技术传播从业者必知必看的书籍
• https://developers.google.cn/style/person

你可能想读：

技术文档诞生记 | 完整的技术写作流程是怎样的？
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-