编写技术文档：如何引用“用户”

Question

我真的不知道比这里更好的地方问这个，所以我走了。

我正在为一个小型大学项目撰写技术文档。一个很大的问题是，如何引用“用户”。我不想把它称为男性，因为我将针对女学生，这似乎是不公平的。

可以打电话给用户 - '它'

像：

要求'它'来安装软件。 问'他'安装软件。 问“她”安装软件。

请原谅我，英语不是我的第一语言，但必须用英语完成。

我在这里问过，因为很多人可能都写过技术文档。

Answer 1

虽然你不想过度使用它，但你可以说“用户”

例如：

“要求用户安装软件。”

但是，你不想在段落中多次使用它......否则用英语阅读就会令人沮丧。

一般来说，“他/他”是性别中立的，但如果你的目标是女性，使用“她/她”并没有错。

不要使用“它”!!!

你总是可以写一个脚注来解释你使用女性代词的原因。

我正在阅读一篇关于口吃的文章，并且有一个脚注*他说：“在这篇文章中，我们将使用男性代名词，因为90％的口吃者是男性。你也可以这样做。” / p>

除了所有这些之外，您还可以使用间接样式进行编写，以最大限度地减少这种情况。

Answer 2

阅读Alan Cooper的关于Face 3 ，我很高兴地注意到每次他必须引用软件产品或设备的用户时他都说“她”。我建议这样做。

  

“要发货，她必须点击”

下面的按钮

现在，您也可以通过“用户”或类似词语来引用用户，而无需使用他/她。为了避免重复，尝试找到“人”，“人”等其他词语。

  

“首先，访客必须至少向购物车添加一个产品。如果购物车为空，则”停运订单“按钮将被停用。人员最多可以添加1000个产品。请注意客户可以随时终止或取消订单。“

小心点。文档的读者必须明白，每次都在谈论相同的演员。阅读要求，我经常混淆客户，客户，访客和用户的条款。通常，这些要求的编写者认为访客和用户是使用该网站的人，但客户或客户 em>是向我们公司订购网站的人。

如果你使用UML，你也可以通过UML演员图中给用户的标签来引用用户（在你的情况下它会是“学生”吗？）。

Answer 3

不，这是不可接受的，无论是良好的英语还是礼貌的对待某人的方式。我建议“你”，或者如果你觉得你必须更加被动“他”或“她”，或者可能是“用户”。

Answer 4

前几天，当我遇到完全相同的问题时，我发现了这个article。如果英语不是您的第一语言，那么它可能是一本难以阅读的内容，因为它指的是一些可能复杂的语法结构。我决定使用的解决方案是使用“他/她”和“他/她”。它向您的读者表明您明确考虑使用代词并且如果您担心的话可以阻止批评。作为额外的好处，如果是为了学校作业，它可以增加文档的长度！

Answer 5

不要写很多用户指南，但我们在需求收集中使用了很多用户故事和角色。

我会通过您描绘的角色来引用用户，例如学生。说他或类似的东西也并不罕见。

Answer 6

使用“用户”有什么问题？即“要求用户安装软件”。这是一个非常有效的结构。

Answer 7

对于一般文档，写“用户”通常有效。例如“要求用户安装软件”。没有错。用户不是性别特定术语，因此效果很好。

但是，你提到你是针对这个项目的女学生。基于此，使用女性术语是有道理的。

Answer 8

术语用户今天已经足够通用，因此使用它是一个好主意。 实际上有关于这些东西的书籍。

阅读：Michael Bremer撰写的“用户手册”

Answer 9

有时人们会阅读文档以获得乐趣。有时他们会阅读它来学习。大多数情况下，他们会阅读它，因为它们会卡住。然后你可以跟他们说话。您可以使用基本模板：

将问题陈述为事实或问题。 要解决此问题，请执行以下操作： 1.打开浏览器 2.单击按钮 3.输入一些信息

您直接与您的读者交谈，这使您不必对他们是谁做出假设。

如果您必须以第三人称，“用户”使用“他们”复数（无性别）。 作为中性单数的“他们”在某些情况下是可以接受的，但在其他情况下则不然。对于大学项目，我肯定会考虑它。