我正在编写用户手册,并与一位同事进行了讨论。他说我不能在手册的任何地方使用“你”这个词。现在我记得在学校关于这件事的一些事情,但那不是为了编写程序。此外,通过谷歌搜索,我发现大多数教程都大量使用它。我更喜欢使用它,但前提是这被认为是好的做法。你怎么看?
12 回答
我知道的替代方案是:
- “你”(第二人称单数)——“你应该把盘子放在桌子上。”
- 当务之急——“把盘子放在桌子上。”
- “我们”(第一人称复数)——“我们应该把盘子放在桌子上。”
- “用户”(第三人称单数)——“用户应该把盘子放在桌子上。”
- 被动 - “盘子应该放在桌子上。”
我自己的偏好是:
- 我更喜欢命令式作为默认模式,因为它是最简短的(最少冗长的)。
- 我避免使用被动语态和第一人称复数形式。
- 当我想要一个明确的主语而不是祈使句时,我使用第二人称代词(“you”)或第三人称名词(例如“your system administrator”)。
有些人认为,手册应该像写科学论文一样写。其他人则认为技术准确性和可读性更为重要。我支持后一种说法——如果“你”符合你的整体风格,请使用它,但在使用时要保持一致——我发现在“你”和“我们”之间切换的文件很烦人(这是我犯过的罪对自己感到内疚)。
哪个更容易理解?
单击按钮。您将看到一个对话框,您可以在其中输入您的姓名。
或者
单击按钮的动作将导致出现一个对话框,允许用户输入他或她的姓名。
第一个更容易掌握。(使用“you”有时会很草率,但这往往是在它被用作“one”或“some people”或“people in general”的替代品的情况下。在你实际所在的地方使用它很好指阅读文本的人。)
- 如果你愿意,你可以通过被动/命令式写作来避免你的风格。您也可以尝试“我们”的方法,但这听起来可能有点幼稚。不过,使用你并没有做错什么。
- 为避免以你的风格写作,请 使用被动/命令式风格。我们的方法也可能有效,尽管听起来有点幼稚。不过,使用你并没有错。
- 我们可以通过采用被动/命令式来避免以你的方式写作。或者我们可以使用我们的方法,尽管我们可能听起来有点幼稚。一个人可以尝试一种方法,但有可能听起来上唇僵硬并疏远读者。不过,我们不介意偶尔使用您。
我自己确实更喜欢第二行。一系列命令比你形式的故事更容易理解。
你应该用第三人称写解释。
Java 流模型是一个经典的装饰器模式示例。
你应该用第二人称写指令,但即便如此,将读者称为“你”仍然不是一个好主意。
创建一个可以根据给定列表初始化列表的构造函数。
现在,当我向您发出 2 个命令后,您的读者感觉如何?
技术写作 强制执行仅使用被动文本的规则。这意味着避免“你”将是一个好主意,以保持安全。这是基于我个人的做法。
我认为,如果您提供诸如“开门”之类的命令,或者以其他方式直接向读者讲话,那么您应该使用“您”,而不是通过谈论一些抽象的用户来使自己更难理解。
即使在科学论文中,一些我能想到的最正式的写作,我、我们和其他第一人称语言是否被允许也是有争议的。尽管高中语法老师可能希望您不这么想,但没有普遍适用的方案。
我会做谷歌、微软、雅虎等做的事情。这是来自 Google 的随机帮助页面:
http://mail.google.com/support/bin/answer.py?hl=en&answer=8494
表明“你”正在被使用。您也可以查看 Microsoft 如何编写他们的用户手册。
作为旁注,我不会使用“我”或“我们”。
我会说小心点。它可能会显得过于随意。如果目标受众是商务人士,我会避免使用它。但是,如果它是家庭用户场景或营销是随意的(想想西南航空公司),我会说去吧。
只是不要过度使用。然后它变得对读者征税。
打算如何使用的示例?
这完全取决于你写作的语气和风格。正式的方法不鼓励使用“你”。就个人而言,我喜欢使用简洁、中肯且相对非正式的风格。谨慎使用时,我对“你”这个词没有意见。
避免过度使用,如:
当您要启动应用程序时,您必须输入密码,然后您必须选择要使用的功能。
来自技术写作手册。第 8 版(第 262 页):
你可以通过省略一些冠词(a、an、the)、一些代词(you、this、these)和一些动词来缩短句子,但这样的句子可能会导致电报式的风格,更难理解。
所以,我会说可以使用你,但就像 Gilbert Le Blanc 在他的评论中所说,写“然后单击按钮”而不是“然后你单击按钮”通常更好。
非个人形式应该是首选。“你”的使用太清楚了,你的大多数客户会认为你不专业。清晰的手册也将减少对售后客户支持的需求,并给公司造成损失。