编写用户手册的技巧包括什么?

编写用户手册可能是一项困难的任务,但是您希望确保您编写的用户手册实际上对某些人有帮助,并且对用户友好。你不想让读者对他们在第一时间找到你的用户手册时想要了解的内容感到好奇。编写好的用户手册需要好的技术写作。了解并了解你的听众。

在编写用户手册时,了解你的听众是谁可能是成功的一半。通过了解你的读者,你知道什么类型,以及有多少信息可以在手册中提到一个特定的主题。

  • 如果你的听众是计算机技术人员,那么你可以用他们能理解的技术用语来解释手册。
  • 如果你的听众是美容师,他们需要知道市场上新吹风机的答案,那么你就用他们所理解的语言。美容师很可能不想知道如何修理吹风机,但他们想知道如何使用。

在大多数情况下,你想了解你的听众,因为他们想要什么就给他们什么。

知道你的目的

 如果您确定了手册的目标,您将能够更好地确保您将所有正确的信息放入手册中。做一个提纲,让你知道何时何地放置信息。这将给您一个检查点,这样您就不会混淆或使读者过多的细节。

是短暂的和详细的

用户手册需要简明扼要。仅仅是为了添加内容和延长使用时间是不推荐的。如果一个问题可以用几句话来回答,那么最好还是那样做。要简明扼要地回答所有需要解决的重要问题。陈述细节,但要让每个词都有意义。太多会导致信息过载。

包括一个目录表

在建立你应该考虑的编写用户手册的技巧时,目录是关键。大多数用户手册使用目录表来显示手册的组织。目录将帮助指导读者在整个用户手册。一个目录也可以帮助读者找到他们正在寻找的问题的答案。

是对话

除非必要,否则不要使用所有的技术语言。人们常常会感到混乱不堪,不堪重负。在编写用户手册时,会话是可以帮助读者更好地找到他们需要的答案的。对话式的回答似乎能帮助人们感到更轻松,帮助他们更好地理解。会话的一个好例子是采用一个常见问题用户手册的概念和格式,以帮助读者识别。他们有问题,你有答案。它是对话式的,帮助读者找到最常见的问题的答案给用户手册。

提供的例子

编写用户手册的最佳技巧之一就是包含示例。在数学书中,你可以看到数学例子和语法书,你可以看到语法例子。在试图解释技术信息时使用示例使解释更容易。通常,如果人们看到一个例子,说明会更清楚。

2018-02-08T14:06:39+00:00 新闻|