Foreword
之前跟大家分享了英語技術(shù)文檔中如何正確使用時態(tài)撞牢，得到了來自一些學(xué)生、老師叔营，以及其他小伙伴很好的反饋屋彪。
在日常 Review 技術(shù)文檔時，我發(fā)現(xiàn)除了時態(tài)問題绒尊，另一個比較常見的問題就是人稱問題畜挥。尤其是對于 Technical Writer 新手，貢獻(xiàn)技術(shù)文檔的程序員婴谱，以及運維小伙伴們來說蟹但，人稱的使用往往會出現(xiàn)不規(guī)范的情況。
出現(xiàn)這種問題谭羔，最主要的原因就是技術(shù)文檔輸出者對于技術(shù)文檔規(guī)范不了解华糖。
像 IBM 和 Google 這種大外企對技術(shù)文檔規(guī)范都有各自詳細(xì)的說明，雖不完全相同口糕，但都遵循業(yè)內(nèi)一些基本的規(guī)范缅阳。如果你是相關(guān)專業(yè)的學(xué)生，或者是一枚 Technical Writer景描，那你很可能對 IBM 和 Google 的規(guī)范多多少少有所了解十办。畢竟，IBM 在這個領(lǐng)域內(nèi)是一種資深的存在超棺。
接下來向族，我會結(jié)合 IBM 和 Google 的文檔規(guī)范與示例，跟大家分享一下英語技術(shù)文檔中該如何正確使用第一人稱棠绘、第二人稱件相，以及第三人稱。
第一人稱
第一人稱代詞包括：
- I, me, my, mine, myself
- we, us, our, ours, ourselves
第一人稱代詞雖然有很多氧苍，但容易用錯的主要是 we 和 our夜矗。We 這個詞尤其需要注意，不了解技術(shù)文檔規(guī)范的小伙伴很容易让虐，甚至很喜歡用這個詞紊撕。
關(guān)于第一人稱在技術(shù)文檔中的使用，大家需要知道以下兩點：
-
技術(shù)文檔中避免使用第一人稱赡突。
原因：
-
第一人稱太過主觀对扶。
第一人稱從文檔作者的主觀角度出發(fā)区赵，而非文檔的讀者或者文檔傳達(dá)的信息。
然而浪南，技術(shù)文檔撰寫出來的目的就是服務(wù)于產(chǎn)品用戶即文檔使用者的笼才。如果不以文檔使用者為中心，就偏離了文檔的目的络凿。脫離目標(biāo)受眾的文檔不會是好的文檔骡送。
此外，規(guī)范的技術(shù)文檔中喷众，作者應(yīng)該是隱身的各谚，不能在技術(shù)文檔中流露出個人主觀的態(tài)度和觀點等。
-
第一人稱太不正式到千。
主觀的口吻很容易給人一種不正式的感覺昌渤，就像其它正式的文體也會保持客觀一樣。
設(shè)想一下憔四，如果在用戶文檔里使用了很多 we膀息，文檔讀者可能會疑惑：你是那樣操作的，那我按你說的步驟來操作可以得到想要的結(jié)果嗎了赵？除了不正式潜支，還容易導(dǎo)致不夠明確。而直接以客觀的口吻告訴讀者怎么做就會避免此類問題柿汛。
舉例：
錯誤示例 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昌腰。在技術(shù)文檔中，第二人稱主要指 you 這個詞膀跌。
關(guān)于第二人稱在技術(shù)文檔中的使用遭商，大家同樣需要知道以下兩點：
-
盡可能多地使用第二人稱 you。
為什么呢捅伤？因為第二人稱關(guān)注的是文檔的使用者或產(chǎn)品用戶株婴，即文檔的目標(biāo)受眾。
正確示例：When you create a database, you must provide a unique name.
-
如果是指導(dǎo)用戶執(zhí)行某項操作，使用祈使句困介，主語默認(rèn)為 you，不必再加蘸际。
注意：由于祈使句已經(jīng)有默認(rèn)的主語 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
關(guān)于第三人稱在技術(shù)文檔中的使用粮彤，大家需知道這一點：使用第三人稱來描述概念根穷、事實和結(jié)果。
第三人稱關(guān)注的是所呈現(xiàn)的信息本身导坟。大多數(shù)情況下屿良，技術(shù)信息是關(guān)于事物而不是人。因此惫周，第三人稱可使用名詞和第三人稱代詞（如 it 和 they）來表示尘惧。當(dāng)使用第三人稱時，除非上下文要求递递，否則不要使用特定性別的人稱代詞喷橙，例如 he 和 she。
- 正確示例 1：The first three exercises show how to build complex models.
- 正確示例 2：Specify whether users can add themselves to a project.
Afterword
以上便是英語技術(shù)文檔中人稱使用的一些規(guī)范登舞，只要了解了并在寫文檔或 Review 文檔時多加注意贰逾，就能有效地避免錯誤，讓文檔更規(guī)范菠秒、更明確疙剑、更易用。
再劃一下重點：慎用第一人稱践叠，多用第二人稱 you言缤，祈使句里隱藏 you。
參考資料：
- The IBM Style Guide酵熙，介紹見技術(shù)傳播從業(yè)者必知必看的書籍
- https://developers.google.cn/style/person
你可能想讀：
技術(shù)文檔誕生記 | 完整的技術(shù)寫作流程是怎樣的轧简？
Technical Writer 可提供的交付物有哪些？
GitHub + Markdown 的新輕型技術(shù)寫作模式速覽
GitHub + Markdown 的技術(shù)文檔方案深度解析
Technical Writer 日常工作中好用的小工具
技術(shù)傳播人士應(yīng)該知道的色彩搭配常識
如何使用顏色來提高技術(shù)文檔的可讀性匾二？
Technical Writer 如何 Review 技術(shù)文檔哮独？| 重細(xì)節(jié)+全局觀
技術(shù)翻譯需要有 Technical Writer 的 sense
深度解析關(guān)于技術(shù)翻譯的六個認(rèn)知誤區(qū)
如何讓你的內(nèi)容輸出更加專業(yè)更有設(shè)計感？
書單 | 有哪些技術(shù)傳播從業(yè)者必知必看的書籍察藐？
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客皮璧？（一）
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客？（二）
經(jīng)驗分享 | 來自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（上篇）
經(jīng)驗分享 | 來自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（下篇）
英語技術(shù)文檔的標(biāo)題到底該大寫還是小寫分飞？
不同階段如何應(yīng)對 Technical Writer 的職業(yè)顧慮或煩惱悴务？
如何使用正則表達(dá)式批量添加和刪除字符？
Markdown：寫技術(shù)文檔、個人博客和讀書筆記都很好用的輕量級標(biāo)記語言
如何為 Markdown 文件自動生成目錄讯檐？
技術(shù)寫作實例解析 | 簡潔即是美
兩分鐘趣味解讀 Technical Writer
若脫離理解羡疗，直譯得再正確又有何意？
優(yōu)質(zhì)譯文不應(yīng)止于正確别洪，還要 Well-Organized
Technical Writer 需要 Technical 到會寫代碼嗎叨恨？
寫在入職技術(shù)型創(chuàng)業(yè)公司 PingCAP 一個月之后
揭秘 Technical Writer 的工作環(huán)境 | 加入 PingCAP 五個月的員工體驗記
-END-
