对于从医生、工程师到化学家等专家来说,向普通客户或知识较少的专业人士传达复杂的话题至关重要。 这种出于商业目的以报告、产品说明或说明手册的形式使复杂材料更易于访问的行为被称为技术写作。 更多地了解这种沟通方式将有助于您从事符合您兴趣的职业并培养必要的能力。 在这篇文章中,我们将定义技术写作,解释类型和特征,并概述在该领域从事职业的阶段。
什么是技术写作?
技术写作是专家用来交流有关专业主题的信息的一种交流方式。 技术作家可能会生成文本以提供说明或阐明与环境规则、计算机程序或医疗程序有关的技术主题。 以下是一些依赖技术写作的最普遍的行业:
- 工程师
- 计算机硬件和软件
- 机器人
- 化学
- 金融
- 大众电子产品
- 林业
- 航空学
- 医疗和保健服务
- 生物技术
- 技术写作范例
以下是一些著名的技术写作实例:
- 使用说明书
- 电子学习材料
- 产品规格
- 产品规格
- 业务报告
- 报刊上的出版物
- 商业提案
- 工作介绍
- 教科书
技术作家可能正在为某个行业写作,在这种情况下,语言是根据受众的教育水平量身定制的。 但是,技术作家有时可能会为一般读者写作。 技术作家提供的许多数据都很复杂,因此写作过程包括评估信息并以任何阅读它的人都能理解的方式呈现它,即使他们没有该领域的经验。
什么是商业技术写作?
技术写作是指商业、技术、应急手册等所需的任何类型的写作。 总之,技术写作示例是出现在描述“如何完成工作”的手册中的任何实验室报告或研究文章。 在专业行业中,商务写作用于创建和交付客户提案、演示文稿、报告、备忘录和电子邮件。
技术商务写作应具备以下要素:
- 清晰、具体、切题。
- 以行动为导向。
- 必须有效率。
- 非常针对特定观众。
- 精确
技术写作的类型
技术写作的类型从注重细节的技术报告到广泛研究的白皮书,包括广泛的部门和程序。
此外,这种形式的内容非常频繁,以至于我们在生活和职业的各个阶段都会遇到各种类型的技术文档。
这是一个广阔的领域,拥有无数的子领域。 但是,为了清楚起见,以下是您可以从事的最常见的技术写作类型。
#1。 医学和科学论文
医学和科学技术写作属于传统技术写作的范畴。
这是第一个改变技术信息以使其对特定受众易于理解的实例。
研究人员使用这种方法来分析他们的发现,将它们整理并浓缩成有趣的文章,并在各种期刊、时事通讯和在线平台上发表。
医学科学论文需要以下技能:
- 对细节的特别关注,尤其是在剖析高价值实验和发现时。
- 输入姓名、日期、引文等时精度高。
- 有效的组织能力,尤其是将原始数据放入用户友好的内容形式时。
- 具有权威和值得信赖的才能,通常能很好地服务于学术界。
#2。 用户手册和帮助指南
用户手册是一种技术写作,即使是非技术专业人士也会遇到。
这种类型旨在解决消费品的特定使用相关问题,以改善整体最终用户体验。
用户帮助手册需要将产品分解成其组成部分,描述每个部分的工作原理,并解决有关每个项目的解决方案的问题。 此外,它还需要回答客户长时间使用该产品时的问题。
以下是用户指南技术写作的常见技能要求:
- 需要了解如何根据产品的运行方式将说明手册组织成阶段和部分。
- 一种产生以解决方案为导向的信息的才能,这些信息精确地描述了如何解决给定的问题
- 全面了解每款产品
- 一种直截了当的简洁风格,具有清晰简洁的原则和很少的绒毛或填充物。
产品手册和维修手册的作者可以在各种企业找到工作,从文案服务到生产公司。 但是,由于技术写作是一个相当受限的职业,因此在申请该类型的职位时,应寻找一家提供渐进式晋升的公司。
#3。 技术作家的书籍和指南
由于内容的长度、概念特征和深度,编写技术书籍和长篇手册与以前的类型不同。
这种写作风格超出了简单用户指南的范围。 它讨论了产品(通常是软件)的目标和用途。
令人惊讶的是,即使它们更详细,技术书籍也必须以任何用户都能理解的方式编写。
撰写此类技术文章需要具备以下技能:
- 将复杂的、充满术语的信息转化为简单的、有指导意义的内容的能力
- 完全理解这些技术出版物的适当格式、组织、节奏和持续时间
- 了解何时以及如何使用图形、照片和表格等视觉辅助工具来使内容更具吸引力。
- 有撰写关于多个主题的长篇文章的经验
这些书籍还可以作为软件程序的故障排除手册。 在这项工作中,他们必须考虑到程序可能遇到的所有潜在困难,并针对每个困难给出解决方案。
#4。 装配手册
组装和维修手册是另一种小众的技术写作形式,它可能是公司机械维修部门中最常见的。
这是由于理解某台机器或设备的拆卸和重新组装所必需的技术知识。 大多数通用维护手册都包括许多类型机械的安装手册。
组装手册不同于其他形式的技术交流,因为大多数(如果不是全部)雇主都希望您能够拆卸。
组装手册和指南需要以下技能:
- 对相关设备和维修过程的理论和实践理解
- 具有类似类型或功能的机械的工作知识和经验
- 研究能力(寻找更好、更高效的拆卸和维修技术)
- 对生产线如何工作以及如何保持机器以最佳性能运行的广泛知识。
虽然大多数公司更喜欢有写作技能的技术人员,但有些公司接受渴望了解程序的职业作家。
#5。 技术报告、评论和文档
利益相关者会议、提案和业务宣传的审查和报告是企业内容创建的一部分。
这是另一种适应性强的格式,将学术报告与基于技术研究的指南相结合。 报告是描述任何调查过程和结果的技术出版物,无论是科学调查还是商业调查。
可行性报告、初步研究报告、商业计划和招股说明书、简短的提案、新闻稿、案例研究等都是技术报告的例子。
组装手册和指南需要以下技能:
- 对所考虑过程的高度理解,以及类似过程如何随着时间的推移进行
- 完全了解产品,以及以前、现在和预期的未来操作
- 能够以精通业务的方式说话,同时保持对材料的适当技术知识
- 精通英语,注重表达公司信息。
技术报告是业务运营的重要组成部分。 在大多数情况下,这会使工作收入相当丰厚。
技术写作特点
有效的技术写作必须具备以下特征。
#1。 简单易读
作者应该准确地说出他的意思,并且说清楚,以免被误解。
技术报告必须易于目标读者或听众理解。 应使用适当的语言以及该领域的当前技术术语。 使用合适的句法和写作风格可以提高清晰度。
#2。 结构合理,井井有条
技术报告必须经过充分计划和整理。 如果作者不能正确地组织和排序他的材料,可能会导致完全混乱和不清晰。
#3。 应用领域内常用的技术词汇
在技术写作中应使用该领域常用的技术术语。
如果技术报告是为不熟悉专业术语的读者准备的,则应在脚注中对术语进行解释。
作者永远不应该假定观众知道一切。
#4。 使用合适的语言
技术报告的措辞应该直截了当、切中要害。
避免使用难懂的词、陈词滥调或行话。 语法、标点符号和语法应该正确且维护良好。
教科书是技术报告的一个很好的例子。 教科书包括达到一定水平的所有必要知识。 一本供研究生使用的教科书可能与供研究目的使用的教科书大不相同。 一本以研究为目的的书可能会全面回顾在该主题中所做的科学工作。 这种高深知识的指导书可能有助于探索新的技术前沿。
如果技术写作是针对产品宣传手册,则应简洁明了。 同时,也不能忽视重要的事实。 在这种情况下,精确和简洁是必不可少的。
#5。 以行动为动力
优秀技术写作的主要目标是解释在当前情况下进行的调查、研究或分析的最终结论。 此外,这些网络发现是如何产生的以及如何应用它们。
#6。 现实并以事实为基础
技术写作必须始终以真实为基础,而且只能以真实为基础。 在任何情况下,技术报告都不应包含误导性信息。
#7。 由于编写它的原因,它必须是有用的。
一份有效的技术报告必须服务于它的读者。
美国技术作家的薪水
在美国,技术作家的典型工资是每小时 36.16 美元,每年还有 1,800 美元的现金奖金。
如何成为一名技术作家
以下是如何开始成为一名技术作家:
#1。 接受教育。
大多数技术写作工作至少需要学士学位。 对这个职业感兴趣的人应该参加科学、工程和医学等技术学科的课程,以及写作和交流课程。 在申请职位时,技术作家经常需要提供写作示例,以证明他们在这种写作风格方面的能力以及他们对特定主题的理解。 维护样本组合是有益的,特别是对于希望担任自由技术作家的个人而言。
#2。 培养相关能力
除了学位,您还必须培养成为优秀技术作家所需的能力。 这些包括对行业的理解、沟通、写作和其他技术经验。 技术作家必须是优秀的沟通者和作家。
良好的计算机能力使您能够使用各种软件工具生成和修改图表、图形和文档。 技术作家还必须具备出色的校对和编辑技能,才能交付没有风格和语法问题的文档。 此外,技术作家更有效、更清晰地使用表格、图表、图片、插图和绘图。
#3。 学习风格指南。
学习所有主要风格指南也是一个好主意,例如 MLA 手册、芝加哥风格手册、美联社风格手册、APA 风格和电气与电子工程师协会 (IEEE) 风格。 尽管许多公司和客户都有自己的标准,但 IEEE 是技术出版物中最常用的样式,尤其是在工程行业。 如果您在专业领域开展业务,请考虑完全关注该风格指南和公司的具体要求。
#4。 获得认证
技术作家也可以通过一个过程获得认证。 主要有以下三种认证选项:
技术交流协会
技术传播者协会提供三级认证计划。 Foundation、Practitioner、Expert是三个层次。 每个级别都需要通过比之前的考试要求更高、更具挑战性的考试。 如果你获得了这个协会的认证,你可能比其他没有完成认证过程的技术作家更有优势。
美国医学作家协会
如果您想在医学领域担任技术作家,您很可能需要学习如何撰写仅在医疗保健领域可用的特定仪器和流程。 如果你想从事这个领域,美国医学作家协会的医学作家证书是一个合适的选择。 要获得认证,您必须拥有至少两年的医学传播经验和学士学位。 为使您的认证保持最新状态,您必须在整个就业期间参加继续教育课程。
国家科学作家协会
技术作家在科学领域的需求特别高。 来自全国科学作家协会的认证将帮助您展示科学理解力和出色的写作技巧。 申请此认证时,您必须提交过去五年内撰写的五篇文章,以及现有协会成员的两篇推荐信。
#5。 选择您想在哪里工作。
技术作家可以是自由职业者或合同工,也可以在软件或硬件公司、工程公司、建筑公司、化学加工公司、国防公司和其他相关企业找到全职工作。 了解该地区及其所涉及的内容是确定它是否是您想要谋生的重要的第一步。 与技术作家谈论他们的日常活动,或阅读客户支持内容和专业手册等技术文章。
#6。 创建投资组合。
申请技术写作职位时,您必须提供您的能力证明。 如果您是初学者,您可以自己撰写技术出版物来构建您的作品集。 在攻读学士学位的同时,您可以通过寻找实习机会和自由写作机会来获得额外的经验。
#7。 创建一个网络。
首先检查您现有的专业网络,看看您是否认识从事技术写作的人。 与他人建立联系可能会帮助您发现职业前景并加入专门从事技术写作的俱乐部。 您可能还希望参加您所在地区的类似会议和活动,以扩大您的联系网络。
技术写作的基础是什么?
高质量的内容、受众和目的、可访问性、语法和写作风格是技术写作的基础。
什么是五种写作?
- 说明文写作。
- 描述性写作。
- 叙事写作。
- 有说服力的写作。
- 日记和信件写作
什么是技术写作的三个 C?
技术写作的三个 C 是:清晰、简洁和一致。
技术写作的 4 个阶段是什么?
预写、起草、修改和编辑是技术写作的四个阶段。
结论,
根据美国劳工统计局的数据,大多数技术作家的年收入超过六位数。 当技术作家赚到这些钱时,他们就拥有写作和媒体行业中收入最高的职位之一。 迫切需要技术作家来明确沟通,技术作家可以从事各种项目来开发技术论文或技术文档。
找出您的技术营销传播人才在哪里,公司看重哪些技术文档技能,并相应地申请工作,以确保您在职业生涯中取得超越。