优秀技术作家的11项技能

by ClickHelp —最佳的联机帮助创作工具

是什么让优秀的技术作家呢? 这个专业似乎只是简单而直接的。 作为一名技术作家,有很多隐藏的岩石,而要成为一名优秀的作家,还有更多。

作为一家因为我们为技术文档创建软件而拥有与技术作家合作的丰富经验的公司,我们决定创建此列表。

如果您是寻找新雇员的雇主,则可以将本文用作清单。 如果您是一名技术作家,我们希望为您提供成长的想法。

其余所有-只是喜欢阅读和学习新事物。

写作技能

首先,技术作家应该擅长写作。 好的软件文档的主要标准是文本的清晰度。 只有知道如何写作,如何用简单的话语表达最困难的想法的人才能做到这一点。

一个好的作家通常只知道这些东西,感觉何时使用这个或那个结构,哪个词最适合,等等。

所有这些听起来都像一个人拥有或不拥有的某种天赋。 但是,实际上,一切都取决于努力和实践。 阅读更多高质量的文本,分析那里的单词选择,弄清楚文本的结构-您将可以逐步提高自己的写作技巧。 或者,您也可以尝试参加有关该主题的培训课程。

使用技术写作工具的能力

技术不断发展。 如今,一切都与效率,团队合作和敏捷性有关。

使用软件进行文档编写的公司越来越多。 难怪–技术写作工具专为技术写作而设计,它们提供非常特定于任务的功能,并且仅是用户友好的文本编辑器。

技术写作工具如何使技术交流者的工作更轻松? 通常,此类工具具有为技术作家团队开发的工作流,它们支持流行的技术写作格式,如Word,PDF,CHM等,并且还有一种称为“单一来源”的东西,可以节省大量时间和文档团队的努力。 作为参考,您可以查看ClickHelp提供的功能列表,ClickHelp是一种在线文档创作工具。

一个好的技术作家需要了解市场上提供的产品。 理想情况下,他们应该尝试一些工具来了解事物的工作原理,并找出对他们个人有吸引力的事物。

研究探索能力

这些技能可能与任何技术作家有关,但可能对外包商的影响最大。

在外包公司工作意味着您必须与从未听说过并且不了解其产品的各种客户公司打交道。

在这种情况下编写软件文档非常困难。 只有经过数小时的深入研究,您才能在给定领域上收集足够的信息以开始撰写过程。

此外,即使您对自己充满信心的领域进行研究,也总是很棒的。 记住,我们生活在不断变化的世界中。 所以,这里要仔细检查!

系统化

软件文档是一个系统。 一些用户指南可能变得如此庞大和复杂,并且充斥着帮助文章,很难相信这是一个系统。 好吧,也许不再了。 而且,这很糟糕。

首先,结构不良的文档会破坏用户体验,因为它无法实现其主要功能-为人们提供易于获得的数据。

其次,文档编写者也会遭受痛苦。 如果没有系统,则很难进一步维护用户指南。

因此,一名优秀的技术作家总是总是事先计划文档结构,并且从不乱作一团,希望以后再进行整理。

团队合作

技术文档团队是更大机制的一部分。 他们必须能够与其他部门进行良好的沟通。

科技作家需要彼此交流,编辑,设计师,开发人员……

起初,技术写作似乎是为性格内向的人而设计的,但是这种表象是欺骗性的。 不要忘记技术交流员为技术交流员举办的所有会议!

问题是,只有当用户指南的作者知道一切工作原理时,它才能清晰明了。 因此,总是有很多关于各种事情的交流和询问。

擅长单一采购

您可能会为技术编写人员使用工具,而永远不会完全意识到其潜力。 单一采购可以节省任何技术作家的时间。 如果您希望能够不费吹灰之力完成更多工作,则应该学习这些技术。

基本上,单一资源允许使用一个相同的源创建多个文档。 例如,有一项任务是创建用户指南的专业版和初学者版。 使用Single-Sourcing,您只能创建一个文档,标记仅适用于专业人士的零件,并获得两个不同的文档作为输出。

另一个示例是文档项目中变量的用法。 您可以使用产品版本创建变量(一种用于保存一些数据的容器)。 这样,以后,您只需更改一次变量值就可以更改文档中的版本。

社会学

了解社会学的基础知识是非常有用的技术交流技能。

为某些产品或服务的用户创建了技术文档。 每个产品或服务都有其核心用户群和目标受众。 任何技术作家的任务之一就是弄清楚最终用户是谁。 一旦完成,就可以开始编写过程。

最简单的示例是B2C和B2B用户指南之间的区别。 在第一种情况下,解释必须非常简单,并且要扎根。 而在第二种情况下,内容应该更深,更复杂和更详细。

就文献编写而言,社会学正在了解读者的想法,并找出为社会的这一特定部分提供内容的最佳方式。

批判性思维

批判性思维是一个广义术语。 而且,它似乎也是技术作家最需要的技能之一。

基本上,批判性思维可以解释为做出理性而清晰的判断的能力。

此概念包括收集信息,对其进行分析和系统化。 仅系统化只是整个批判性思维故事的一小部分。

是什么使一个好的批判性思想家呢? 好吧,关于此事的大多数理论都说答案是个人经验。 而且,这确实是有道理的。 获取和处理信息的整个过程越有意识,输出就会越清晰。

网页设计基础

此技能是可选的。 但是,最近几年表明,用记事本写东西已经不够了。 市场上出现了越来越多的在线文档工具。 他们中的一些提供了现成的模板,您可以按需使用它们,也可以根据自己的喜好对其进行调整。 并且,也可以使用HTML和CSS进行调整。

即使我们从UX的角度来看-设计可以改善或破坏UX-外观不好的配色方案,难看的屏幕截图……用户肯定不会对此感到满意。

教育

那么,技术作家需要特殊文凭吗?

是的,没有。

当然,成为技术作家比没有前端的前端开发者要容易得多。 在大多数情况下,您不需要技术写作学位。 但是,许多雇主仍然抱有一定的期望。 以下是技术作家最欣赏的学士学位列表:

  • 新闻学
  • 英语
  • 通讯技术
  • 计算机科学
  • 工程

常识

技术交流者还有另一个“必须具备”的条件。 而且,对于任何人而言。

您的常识将帮助您了解何时做正确的事情。 就像,多少张屏幕截图足以解释火箭科学这个话题。 如果您的常识告诉您火箭科学不需要屏幕截图,那么我对您来说是个坏消息😉

现实检查有助于极大地恢复常识。 不要过于自信,去四处询问并听取人们的意见。

结论

现在,对于任何技术作家都有用的技能列表已经完成。 当然,这并不意味着技术作家必须具备所有这些条件,不是。 但是,在技术写作中,就像在其他任何专业领域一样,总是有机会成长为专家。

如果您真的有兴趣成为一名技术作家,请查看我们最近发布的博客文章,内容涉及技术作家的职业道路。 我们希望,这些信息可以为您显示改进和成功的方向。

祝您技术上写好运!
ClickHelp —联机文档和帮助创作工具