技术写作仍然是专业工作场所令人垂涎的技能。从 2014 年到 2024 年,需求预计将以 10% 的速度增长。这高于所有职业的平均水平。
在本文中,我们将向您展示技术作家的平均一天,如何提高编写复杂文档的技能,以及该领域快速变化的原因。
技术写作的传统定义是:
技术写作是记录过程的实践,例如软件手册或教学材料。传统上,它仅限于某种用户手册。
坦率地说,这个定义已经过时了。技术发展迅速,词典编纂者往往只能追赶。
技术写作的新定义:
今天,技术写作涵盖了复杂技术过程的所有文档。它包括报告、执行摘要声明、简报。任何时候在工作中以书面形式传达技术信息,根据定义,它都是技术写作。
这可能包括高科技制造、工程、生物技术、能源、航空航天、金融、IT 和全球供应链。
该格式不再受限于冗长的用户手册。技术信息必须经过提炼并明确呈现。这可以以技术报告、电子邮件、政策、简报和新闻稿的形式出现。
**重要的是,如果您在技术领域工作,您**有可能从事技术写作。
技术写作与商业写作有何不同?
新定义开始听起来很像商业写作的定义。
请注意,技术写作与商业写作并不完全相同。
商务写作是一个更广泛的类别。可以说技术写作属于商业写作。它涉及许多相同的主题和文件。
然而,技术写作的过程和结果是**的。在这篇文章的其余部分,我们将确切地探讨技术作家的工作。我们将回顾技术写作的例子以及成为专业技术作家需要做什么。
技术作家的工作是什么?
技术作家的工作将根据他们受雇的行业和公司而有所不同。
他们经常在多学科团队中工作,充当技术含量较高的人员和技术含量较低的读者之间的中介。他们将与这些团队密切合作,制定沟通策略。
他们的职责通常不仅仅限于写作。他们必须了解整个项目,从高级目标到实施的复杂性。
以下是您可能需要以技术方式编写的文档列表:
技术报告
传达技术信息的电子邮件
备忘录
用户界面文本
指南和用户手册
新闻稿
白皮书和案例研究
执行摘要
平衡计分卡
产品说明
提案
报告
网站
起初,看到这么多不同类型的文件可能会让人不知所措。但每份文件都使用类似的写作过程,并利用一套既定的技能。如果您开发了一个流程,您可以将其应用于您正在创建的任何技术文档。
技术写作所需的技能
要成为一名成功的技术作家,您需要掌握一组核心技能。以下是成功所需的一些**常见的技能:
研究
研究是技术写作的**步。完成任务后,您将负责收集数据(数字和非数字)并将其转化为有价值的信息。
研究可以来自多个地方,包括:
现场数据
在线和内联网出版物
采访
图书馆和研究数据库
研究完毕后,您将需要综合并开始规划您的文档组织。
观众感知
您研究和收集的技术信息必须根据读者的兴趣、理解和感知进行塑造。
技术作家通常必须向非技术受众传达高度技术性的信息。因此,**有效的技术写作过程的早期步骤是仔细分析您的受众,以便您可以将信息与他们的需求相匹配。
沟通技巧
要想成为一名成功的技术作家,沟通技巧必不可少。您可能会与来自不同角色的多个团队和个人一起工作。
您倾听、记录和交流的能力将至关重要。
技术能力
您必须了解您正在撰写的内容的技术性质。
很难清楚地传达一个你没有掌握的概念。许多技术作家在他们所撰写的主题方面拥有学术或工作经验,许多技术作家拥有工程师、地质学家、地震学家、金融分析师或业务分析师的职位。他们受雇于技术职位,必须跨职能将信息汇总到公司的其他领域。
如果您来自技术方面并且正在学习写作,那么技术写作会稍微容易一些。如果您的背景是写作并且您正在尝试学习技术内容,则有时会更加困难。
写作
出色的写作技巧可确保您的文档易于阅读且没有错误。写作包含此列表中的许多其他技能。
为文档设置正确的语气、样式和格式非常重要。
通常这些规则由雇佣组织在风格指南中概述。
文件设计
您可能负责添加图形以补充您的文档。
图形帮助读者理解信息很重要。图形、表格和图表在技术报告中很常见。
您还需要精通文档格式。格式应该是专业的,并有助于读者浏览文档。标题应易于浏览,内容应有逻辑地组织。
设计不当的文档会使读者更难以理解内容。文档设计是技术写作的一个关键方面。
熟练使用数字工具
今天,作家在技术写作过程中必须使用多种工具。这通常超出了基本的文本编辑器。技术作家应该能够创建图形和注释图像和屏幕截图,并从 Excel 中提取数据并在图表和表格中传达这些数据。
此外,他们可以利用商业作家使用的计划、写作和编辑工具。我们在这里编制了一份**商业写作工具列表。
用户研究和测试
某些形式的技术写作可能需要用户研究和测试。适合进行详细研究和测试的示例应用是指导工程师如何修复深海石油钻井平台上的故障机制的书面指南。
文档易于遵循很重要,尤其是在应用程序对主要功能至关重要的情况下。为了准确地编写指南,作者可能首先观察工程师如何解决问题。他们可能会使用录音设备或只是笔记来写下研究。这种类型的研究与测试密切相关。
测试对于确保您的文档按预期运行是必要的。
作者完成文档草稿后,可以将其交给测试组阅读。然后,他们可以按照说明实时观察**终用户。
他们可能会跟进焦点小组或调查,以获得有关文档有用性的反馈。他们将在修改文档时使用这些真实世界的见解。
即使在不太复杂或关键的应用程序中,让第三方阅读文本始终是一个好主意。这有助于对抗知识的诅咒。知识的诅咒是个人在试图解释他们已经理解的事情时存在的认知偏差。作为专家,很难将自己置于经验不足的学习者的立场。
这就是为什么让第二组眼睛查看文档可以帮助提醒您需要改进的地方。
使用技术写作的行业
今天,技术已经扩展到业务的方方面面。公司不断开发更多的技术流程以寻求更高的效率和利润。
以下是需要强大技术写作的行业列表:
生物技术与药学
咨询
能源化工
工程
信息技术
金融服务
政府和非营利组织
保险
制造业
供应链
如何提高你的技术写作技巧
您无需拥有“技术作家”的头衔即可在工作场所使用技术写作技巧。如果您在一家从事高技能或技术或分析工作的公司工作,您可能已经在进行技术写作。
读
成为更好作家的**方法之一就是阅读。阅读可以帮助你训练你的大脑理解如何写作。你读得越多,写作对你来说就越容易。
阅读相关且高质量的文档至关重要。寻找相关行业的竞争对手或作家制作的文档。检查他们的写作,以确定他们如何通过书面文本组织信息。
创建流程
有一个过程可以防止你在写作时“陷入困境”。拥有清晰的工作流程将帮助您系统地完成工作。我们在技术写作课程中教授技术报告写作的具体过程。
寻求反馈
获得有关您的写作的主观和客观反馈是提高技能的**快方法之一。这就是为什么我们在所有课程中都强调个人反馈。
为了提高您的写作水平,您不仅需要有人审查语法和句法,还需要审查您作为作家的方法和方法。
要真正掌握技术写作,您需要从导师那里获得反馈。这可能是您组织中的某个人,也可能是专业发展小组的成员。如果您正在参加在线课程,另一个不错的选择是与您的导师合作以提高您的写作技巧。
参加课程
上课可能是快速提高写作技巧的**有效方法之一。您想确保您注册的是专门从事技术写作的课程。
课程必须包括一对一的反馈和指导。如果您正在考虑参加在线课程(或聘请讲师进行现场研讨会),请务必查看我们关于如何选择在线商务写作课程的指南。
我们所有的 技术写作课程都附带屡获殊荣的讲师反馈。您可以在此处查看我们的技术写作课程。
实践
重复是巩固新技能的关键。希望将新概念融入您的工作中。您甚至可以回顾旧工作,以批评如果您今天要编写文档,您会采取哪些不同的做法。
确认您参加的课程包括练习机会。例如,该课程是否要求您绘制技术文档的组织和顺序?由于这是一项核心技术写作技能,因此您需要确保获得有关您执行此操作能力的专业反馈。