在用户手册中使用“ you”一词[已关闭

题

我正在编写一本用户手册，并与同事进行了讨论。他说我不能在手册中的任何地方使用“您”一词。现在，我记得学校对此有所了解，但这并不是为了编写程序。另外，我观察到大多数使用它的教程。我更喜欢使用它，但是只有当这被认为是好的做法时。你怎么看？

解决方案

有人认为应该写手册，就像它们是科学论文一样。其他人则认为技术准确性和可读性更为重要。我有说服力 - 如果适合您的整体风格，请使用“您”，但在您的用法中保持一致 - 我发现在“您”和“我们”之间切换的文档很令人讨厌（这是我的罪过对我自己有罪）。

其他提示

我知道的替代方案是：

我自己的偏好是：

哪个更容易理解？

单击按钮。您将看到一个对话框，您可以在其中输入名称。

或者

单击按钮的动作将导致对话框的外观，从而使用户有可能输入其名称。

第一个更容易掌握。（使用“您”有时可能是草率的，但这往往是在用作替代“一个”或“某些人”或“一般人”的情况下。指的是阅读文字的人。）

如果你想要，您可以通过以被动/命令性的方式写作来避免您的风格。您也可以尝试“我们”的方法，但这听起来可能有点幼稚。不过，您没有做错事。
避免在You-style中写作，采用被动/命令风格。我们的诉讼可能还工作, ，尽管听起来有点幼稚。不过，使用您没有错。
我们可以通过采用被动/命令风格来避免以You型写作。或者我们可以使用我们的诉求，尽管我们听起来可能有点幼稚。一个人可以尝试一种方法，但有可能听起来像僵硬的嘴唇和疏远读者。我们不过，不要偶尔使用您。

我本人确实更喜欢第二行。一系列命令更容易遵循，然后在您形式上的故事。

您应该在第三人称中写植被。

Java Streams模型是一个经典的装饰图案示例。

您应该在第二人称中编写说明，但即使那样，将读者称为“您”仍然不是一个好主意。

创建一个可以初始化的构造函数列表基于给定的列表。

现在，在我向您的读者发出2个命令后，您感觉如何？

技术写作强制执行仅使用被动文本的规则。这意味着避免“您”将是一个好主意。这是基于我个人的方式。

我会做Google，Microsoft，Yahoo等。这是Google的随机帮助页面：

显示“您”正在使用。您也可以检查Microsoft如何编写其用户手册。

附带说明，我不会使用“ I”或“我们”。

我认为，如果您提供的要求，例如“打开门”，或者直接向读者致辞，那么您应该使用“您”，而不是通过谈论一些抽象用户来使自己更难理解。

即使在科学论文中，我能想到的一些最正式的写作，是否有争议一世, 我们其他第一人称语言是允许的。尽管高中语法老师可能会喜欢您思考，但没有普遍适当的计划。

我会说要小心。它可能太随意了。如果预定的受众是业务，我会避免。但是，如果这是家庭用户场景或营销是休闲的（想想西南航空公司），我会说。

只是不要过度使用。然后，它对读者征税。

示例要如何使用它？

这完全取决于您写作的语气和风格。正式方法不鼓励使用“您”。就个人而言，我喜欢使用一种简洁的风格，以至于相对非正式。少数使用时，我对“ you”词没有问题。

避免过度使用如下：

当您要启动应用程序时，您必须输入密码，然后必须选择要使用的功能。

来自技术写作手册。第八版（第262页）：

您可以通过遗漏一些文章（a，an，the），一些代词（您，this，this）和一些动词来使句子更短，但是这些句子可能会导致电报风格，并且很难理解。

因此，我会说可以使用您，但是就像Gilbert Le Blanc在评论中所说的那样，通常最好写“然后单击按钮”而不是“然后单击按钮”。

非个人化形式应该是首选。 “您”的使用太清楚了，您的大多数客户都会相信您不是专业的。清晰的手册还将减少销售后客户支持的需求，并对公司造成损失。

许可以下： CC-BY-SA 和归因