技术文档的定位

技术写作是帮助人们了解事物如何运作的手段。 这些人是随机的吗? 一点都不。 对于每本用户手册,其读者至少都有一个共同点,那就是它们都使用相同的产品或服务。 如果我们退后一步并调整规模,我们会发现这些读者的共同点远不止于此。 因此,一旦您弄清楚了它是什么,它将定义您作为技术作家所做的一切。

针对技术文档的想法很简单-您需要说的语言与读者理解的语言相同。 “我为谁写作?” -是您需要回答的基本问题。 事实是,应在采取任何进一步措施之前予以回答。

如何确定目标受众?

您可以先询问公司中的人员。 即销售和营销团队。 请注意,出于我们的原因,他们的答案需要加一点盐,我们将进一步解释原因,但是,现在,让我们看看您可以向同事提出哪些问题。

基本上,您需要创建一个普通读者的肖像,因此,这里有几个要考虑的标准:

  • 年龄
  • 性别
  • 占用
  • 教育
  • 国籍
  • 母语

当这些团队正在围绕目标受众建立其所有流程时,任何销售或营销人员都将获得此信息。

这就是为什么您不应该将他们的答案作为文档团队的最终解决方案的原因:产品和技术文档的目标受众可能会有所不同。 例如,如果您要为老年人创建小工具,则在出现问题时,他们很可能会要求年轻一代提供用户手册的帮助。 或者,如果要为儿童创建玩具,则可能需要考虑为儿童创建一个指令,为他们的父母创建另一个指令,其中您会提到仅涉及父母的细节。 因此,请考虑谁真正将要阅读文档!

确定目标受众的另一种方法是使用统计数据。 例如,集成到在线文档门户中的Google Analytics(分析)可以为您提供有关在线技术文档的读者对象的大量信息。

如何在技术写作中应用目标

想象一下,您已经算出了普通读者,现在呢? 基本上,您需要微调所有内容以符合其特定要求。 这里是要考虑的几个方面:

  • 内容复杂度 。 您需要深入了解技术细节吗? 想象一下,为开发人员和用户编写软件文档时有何不同。 后者将包含更少的代码,更少的术语,以及更详细,更直接的步骤。
  • 视觉内容 。 视觉内容(屏幕快照,方案,图形)使查找某些UI元素,了解机制的工作方式,了解元素之间的相关性等更加容易。尝试找出UI的哪些部分需要屏幕截图。 例如,如果要为专业人士创建技术文档,则基本的UI屏幕截图是多余的。
  • 语言 。 您的语言应该在严格的技术水平和较随意的语言之间站立的位置仅取决于目标受众。 如果您要与国际观众打交道,则需要特别注意这方面。 在这里,使用可读性评分工具可能是个好主意-这些工具可以评估理解书面文字的难易程度。

通常,目标受众是如此之多,以至于技术撰稿人别无选择,只能为每个目标群体的需求量身定制不同版本的用户手册。 在这种情况下,使用具有单一来源技术的技术写作工具是一个很好的解决方案。 单源采购是处理创建同一文档项目的多个输出的最快方法。

结论

技术作家的工作是向他人解释事物的工作原理。 但是,就像您需要根据现实生活中的背景和主题知识向不同的人解释某些事情时会改变方法一样,好的用户手册也会根据其读者进行适当调整。

祝您技术上写好运!
ClickHelp小组
跨平台和设备编写,托管和交付文档