技术作家:他们是什么,你需要一个吗?

已发表: 2022-03-11

技术作家指南

作家可以在专业写作领域担任多个不同的职位。 虽然行业外的企业倾向于滥用术语,但每种作家都有特定的角色和特定的职责。 如果你想让他们做最好的工作,雇佣正确类型的作家是很重要的。

  • 作者,通常写不太正式的长篇内容,如书籍。
  • 文案通常为广告、社交媒体帖子、产品描述和其他媒体编写简短的副本。
  • 技术作家,通常编写产品文档和帮助中心材料。
  • 博主通常专注于网络发布的中等长度内容。

而且,当然,你也有特定行业的作家,比如医学作家或非营利部门的资助作家。 最重要的是,他们都可以是代笔人,也是。

正如今天帖子的标题所暗示的那样,我将深入研究其中一个角色。 具体来说,让我们谈谈技术作家。

目录
什么是技术作家?
具体来说,技术作家做什么?
技术作家需要什么技能?
任何人都可以成为技术作家吗?
您需要技术作家吗?

什么是技术作家?

假设您购买了一种新产品。 你找到它并打开它,会发现一本 50 页的手册,里面有零件图、规格图以及有关其工作原理的操作说明。 它是半复杂的,所以你需要参考手册。

这就是技术作家所做的,也是他们获得技术写作职位的方式。

“技术作家撰写公司文档,例如说明手册、中间到最终用户手册、参考指南、操作程序指南、白皮书和专业产品描述。” – 技术作家总部。

技术作家创建的内容可以用于不同的目的,包括:

  • 内部业务使用内容包括程序文档、用户指南、手册、服务文档或报告。
  • 外部业务使用内容包括使用指南、维修指南、知识库文档、客户服务文档和客户提案文档。

因此,您的技术作家可能会帮助起草员工手册、编写您的内部知识库 wiki,或者构建客户服务数据库或常见问题解答。 他们可能会编写产品使用手册或记录业务流程以实现内部一致性。 他们还可以为更高级别的执行团队创建报告和建议,并促进 C 级和董事之间的沟通。

Mailchimp 示例技术内容

正如您所料,所有这些都属于“技术文档”的标题,因此属于技术作家。 正如您所料,内容本身是技术性的。

技术作家可以是:

  • 自由承包商,按项目工作。
  • 长期承包商,致力于记录有关业务的所有内容,直到赶上。
  • 兼职或全职员工,在整个运营过程中根据需要记录所有内容。

技术作家很少是代笔作家。 代笔作家通常通过出售署名来换取金钱。 技术文档很少有署名,因此无需聘请代笔而不是普通作家来制作它。 期望不存在。

具体来说,技术作家做什么?

技术写作的广泛领域相当复杂。 一家公司的专业作家可能与另一家公司的作家有着完全不同的职责。

您会在技术作家的职位描述中找到的典型职责包括:

  • 研究业务部门、流程或产品的技术规范。
  • 按逻辑顺序规划技术文档。
  • 了解对目标受众来说什么是必要的,什么不是。
  • 创建、复制和完善文档。
  • 根据需要创建图表和其他插图。
  • 维护相关词汇表、常见问题解答或其他相关术语库。
  • 为高级业务使用开发技术报告或正式提案。

许多作家将拥有技术写作证书、发表的期刊文章或现有作品,以及在各自领域的多年经验。 他们应该能够证明他们在您的特定行业拥有技术写作生涯。

您的汽车随附的手册教您如何更换轮胎或使用转向信号灯,是一篇技术文章。 维修手册也是如此,适用于机械师而非最终用户。 汽车制造商网站上的客户自助服务知识库也充满了技术内容。

所有的海恩斯手册、谷歌的帮助中心,甚至像案例研究这样的东西都是技术写作的例子。

Google Search Console 帮助文章示例

技术作家需要是他们所在领域的不懈专家(但不一定是经过认证的)。 汽车制造商的技术作家需要从内到外了解汽车的设计。 医学领域的技术作家需要对生物化学有足够的了解才能正确记录药物。 业务的技术作家需要了解业务的运作方式,以适当地编写流程文档。

也就是说,技术作家经常让主题专家审查他们的最终产品并批准它。 例如,医学作家可能有真正的生物化学家审查并确保准确性。 创建产品手册的技术作家可能会在发布之前让律师查看它,以保证其中没有任何内容能够为公司造成责任。

毕竟,技术文档需要准确,并且需要为适当的受众编写。

再次使用汽车制造商示例,销售规格文档、用户手册和维修手册必须包含类似的技术信息。 但是,最有价值的信息会有所不同,技术细节的级别会有所不同,并且文档的范围也会发生变化。

示例自动指南

向最终用户提供海恩斯手册是不恰当的。 那是因为想要买车、想要排除车辆故障的人以及专业修理车辆的人都有不同的需求。 大多数人对汽车知识的需求包括使用转向灯和给轮胎充气,而不是更换空气管道或更换催化转化器。

技术作家需要什么技能?

技术作家需要一套特定的写作技巧和沟通技巧才能有效。

1.首先,他们需要是高效的沟通者。 技术作家需要将准确的技术信息传达给最终用户以理解和解析它。 如果指南中充满了他们难以理解的复杂信息,那么它将令人困惑到无用的地步。 如果太简单,用户将得不到任何价值。

同时,技术作者可能需要向主题专家提出实际问题。 在他们的文档中,他们可能会遇到他们没有也找不到答案的问题。 他们需要向相关专家询问他们需要了解哪些文档。 而且,由于专家可能不知道何时停止,技术作者还需要知道如何从可能冗长的响应中提取特定值。

技术内容的示例 Slack 通信

2.相关地,技术作家需要牢牢掌握他们的语言。 他们需要准确地说出他们所说的内容,并写到实用的阅读水平,专门针对他们的听众。 技术错误、选词不当、含义混乱; 对于技术文档来说都是可怕的。

3.接下来,他们需要有一个注重细节的视角。 技术作家需要关注小细节,因为小细节需要准确。 他们不能掩盖特定的细节,因为这些细节可能是必要的。

Z
Z
Z
您的博客是否为您带来了生意? 如果没有,让我们解决这个问题。

我们创建可转化的博客内容——不仅为我们自己,也为我们的客户。

我们选择博客主题,例如对冲基金选择股票。 然后,我们创建的文章要好 10 倍以赢得头把交椅。

内容营销有两个要素——内容和营销。 我们在这两方面都获得了黑带。

如果您经营一家基于互联网的企业并希望扩大规模,请安排电话与我们的创始人交谈:
免费策略调用

例如,在我关于某个 Web 服务或另一个的操作指南中,我可能会写如下内容:

“登录您的仪表板并在侧边栏中找到报告部分。”

这对我来说已经足够了,因为我不是在写技术文档; 我正在写一个非常简单的操作指南。 同时,技术作家可能会写道:

“在仪表板中,单击左侧边栏中的报告标题,从顶部数第三个。”

它们更具体,因为技术文档的一部分是特异性的。 当然,这是一个通用的例子。

4.技术作家也需要理解逻辑流程。 在记录业务流程时,您的作者将需要批判性思维能力,并且需要适当地排序步骤。 例如,考虑一个食谱。 您按照完成的顺序依次写下烘烤一条面包的分步说明。 但是,您也许可以重新组织一些; 例如,没有理由在烘烤前对面团进行一个小时的打样时,将“烤箱预热”放在开头; 没有人愿意让他们的烤箱在里面空无一物地运行那么久。

不同的汽车制造商有不同的模式。 文档越长或越大,选择就越多,建立约定就越重要。 自动手册可能从可用性开始,然后转向隐藏功能和小修。

丰田汽车指南示例

5.这与对技术作家的另一个要求有关,即单一来源。 单一来源意味着获取大量信息并制作针对不同受众的多条内容。 用户手册和海恩斯手册的汽车示例就是一个很好的例子; 它们都包含来自同一来源(制造商)的同一辆车的信息,但其中一个更具技术性。

6.一些技术作家可能还需要基本的代码或Web开发知识。 例如,创建客户服务文档的技术作家可能需要了解足够多的 HTML、CSS、JavaScript 或 Wiki 语法才能从头开始或在框架内创建基于 Web 的文档。 技术作家很少写纯文本副本 - 通常他们需要另一种技能才能被视为技术作家。

技术内容代码示例

例如,全栈开发的技术作家可能有两种技能:技术写作和编程。 如果不是程序员,作家没有其他方法可以创建这种准确的程序员内容。

任何人都可以成为技术作家吗?

老实说,没有。

技术写作是一种特殊的高风险写作。 它具有异常严格的质量标准,因为糟糕的文档可能会给公司带来许多问题。 糟糕的文档会大大降低用户体验和对产品的满意度。 高效的技术写作流程可以为企业大规模节省数百万美元。

例如,假设一家软件开发公司的指南太混乱或难以让用户理解。 在这种情况下,他们的流失率将高于平均水平,他们将失去大量客户——这一切都是由于写作不佳。

技术作家需要注重细节的个性和社交能力的特定组合才能与主题专家互动。 通常,技术作家还需要其主题的学位或技术证书才能适当地写它。

例如,医学作家可能会获得护理学位或医学科学或计算机科学的 4 年制学位。 作者甚至可以参加针对医学内容的特定技术写作课程。 他们不需要攻读硕士或博士课程,但他们至少需要一些正规教育,例如学士学位。

班级和本科生的例子

许多技术内容作者选择感兴趣的行业并专注于它。

也就是说,技术作家并不总是需要这些学位才能进入某个领域。 通常,他们所需要的只是英语或写作、新闻学、技术交流或工程等技术领域的学位(尽管这种情况往往不太常见。)

我已经做了十多年的作家,但作为一个博主,我不会成为一名技术作家。 当然,我可以学习如何,但我必须抑制我的许多习惯(比如以第一人称视角或随意写作)。

您需要技术作家吗?

也许!

几乎每个企业都需要某种程度的商业写作和技术文档。 我经营着一家小型企业,但我仍然制作诸如房屋风格指南、内容简介或我的网站隐私政策之类的东西。

但是,我不会说我需要技术作家。 我可以在在线模板和内部文档所需的较低标准之间编写技术。

内容驱动的技术内容示例

假设您的业务在您有客户服务需求的领域运营,而不仅仅是接听电话和与客户交谈。 在这种情况下,您可能会受益于让技术作家创建文档。 如果您的大型部门具有生成报告或使用 ATS 的特定流程,技术作家可以记录这些流程。

当然,如果您的企业生产技术产品,并且该产品比钢笔或鞋子更复杂,那么为您的用户创建用户手册或在线帮助中心可能是个好主意。

即便如此,并非所有公司都为他们的手册使用技术作家。 考虑宜家; 他们以在汇编指令中只使用象形图而闻名,部分原因是他们希望单个文档与整个世界相关,而不管语言如何。 技术作家可能已经制作了这些,但与其说是写作,不如说是图形设计。

我可以说一件事:技术写作是一项特定的技能,是一项很难培养的技能。

根据美国劳工统计局的数据,技术作家的平均年收入约为 75,000 美元,高端、高技能的技术作家每年的收入超过 100,000 美元,这是有充分理由的。 在适当的情况下,它们的价值堪比黄金。

您是否正在考虑聘请技术作家? 您对我们有任何关于技术作家的问题,以及他们与文案或内容作家的区别吗? 请在评论区告诉我! 我很乐意提供帮助并开始就这个主题进行对话。