技术写作初学者指南（2021）

有一部分人认为科学家、医生、计算机程序员和工程师撰写的文章构成技术写作。

另一组认为技术写作只是写用户手册。

他们两个都错了。

但他们的偏见是可以理解的。 对于普通人来说，这些是专业人士（医生、科学家、工程师等），他们的语言可以称为“技术人员”。 他们认为这些所谓的“技术”人员撰写的白皮书和论文就是技术写作的全部内容。

同样，用户手册是我们大多数人在了解技术资料（我们使用的设备和产品）时接触到的文档。 所以这就回答了第二个偏见。

但事实是大多数人没有意识到技术写作就是为像我们这样的普通人写内容。 事实上，许多技术文章都是在彻底了解读者真正在寻找什么之后才写的。

本指南经过精心设计，旨在让您深入了解什么是技术写作、它与常规内容写作的区别以及成为技术作家所需遵循的步骤。

什么是技术写作？

几年前技术写作是这样定义的——

“记录流程、软件用户手册和设备说明的做法。”

过去，技术写作确实仅限于用户手册。 然而，在现代世界中，技术写作已成为一个涵盖更多定义的总称。

今天，技术写作被定义为——

“几乎所有领域的技术流程文档。 它涉及报告、简报、说明等等。”

它可能涉及广泛的领域，例如工程，信息技术，生物技术，金融等。

简而言之，如果您在任何技术领域工作，都会有人为您和您的产品或服务编写技术文档。

技术写作的目的是什么？

技术作家可以期望他们的角色和职责会根据他们正在工作的行业和公司而改变。 但是，大多数技术作家将与多个团队合作。 它们是连接技术人员与技术含量较低的员工和客户的桥梁。 作为技术作家，您有责任以技术人员能够理解的语言准确地传达技术人员想要传达给读者的内容。

让我们考虑一个简单的例子。 贵公司提出了一种新的销售推广工具。 有多种功能可以启动、暂停和安排向最终客户发送电子邮件。 典型用户需要了解所有这些功能才能充分利用该应用程序。 现在，您既可以让用户自己发现这些功能，也可以提供一份文档来解释每个功能是什么以及如何使用它来简化他们的生活。

对于不懂技术的用户来说，这将是一个福音。 如果没有这个文档，理解和导航应用程序对他们来说可能会非常令人生畏。 他们可能会错过可以使他们的体验更好的功能，甚至可能会不正确地使用某些功能。

总而言之，技术写作的最终目的是避免所有这些陷阱，并确保信息的传达清晰而简单。

技术写作和其他形式的写作有什么区别？

在上一节中，我们曾引用过技术写作背后的核心思想是以清晰的方式传达信息。 但是您可能想知道其他形式的写作是否也是如此。 毕竟，任何文章都旨在以读者可以理解的语言向用户传递一些信息。 好吧，相似之处从那里开始并结束。 以下是技术写作与其他写作形式之间的主要区别 -

重点地区

技术文档仅关注相关主题。 例如，用户手册只关注产品的功能。 然而，其他形式的写作可以为内容注入更多的主题和创造力。 例如，关于电子学习的博客可以讨论更好地开展课程的技巧，以及开办自己的电子学习学院的估计成本。

预期目的

即使其他形式的写作传递信息，该内容的目的通常是为了营销的娱乐。 另一方面，技术内容只专注于改善用户体验。 它提供信息，提供指导，并为主题、应用程序或设备提供解释，仅此而已。

内容的基调

非技术性内容通常以主观语气编写，其中使用意见和轶事使内容更有趣。 另一方面，技术写作本质上总是客观的。 给出的说明中不能有任何意见或任何形式的混淆。

格式

一般写作可以采取多种形式。 例如，有许多格式可以写博客，让读者觉得有趣和有趣。 但技术写作并非如此。 在技​​术写作中，总是有一个固定的结构要遵循。 这确保了传递的信息直截了当，最终用户可以立即开始使用该产品。

写作风格

一般写作和技术写作之间的另一个关键区别是声音。 在非技术性内容中，作者经常使用第一人称格式和非正式的语气来使内容具有对话性和吸引力。

在技​​术写作中，为了方便读者阅读，内容总是以第三人称的形式书写。 它也是超正式的，因此不允许对所提供的内容进行不同的解释。

词汇

两者之间的另一个主要区别是使用的词汇。 在通常的内容写作中，使用的词汇通常具有唤起性，以激发读者的行动或情感。

在技​​术写作中，词汇是高度专业化的，并且取决于产品的类型。 您会看到内容中使用的专业术语为读者提供准确的说明或解释，只是为了帮助他们。

观众

当然，观众在两者之间也存在很大差异。 在技​​术写作中，观众总是专业的并且知道他们的东西。 他们是将购买您的产品或服务的人。 他们也可能是需要有关程序或服务的信息以更好地利用它的业务分析师或产品经理。 在这里，技术作家会发现他们的目标是确保所有必要的利益相关者按时获得所需的信息。 作家们并没有被迫吸引更多的人阅读它。

在另一种写作形式中，受众更加普遍。 他们的年龄组、职业等可能存在很大差异。简而言之，没有特定的人群适合写作。 作者还必须专注于向更多人（对该主题感兴趣）广播的内容。

技术写作示例

以下是最受欢迎的技术写作示例或技术作家所写的内容类型 -

标准作业程序

这些文件旨在向用户提供有关组织内正确操作程序的指导性和信息性内容。 此类文件将涵盖其有关流程和情况的规则、法规和指南。 此外，它还将提供有关升级程序和人员的信息，以应对特定事件。

使用说明书

我们大多数人都熟悉使用说明书。 它们可以是我们在购买智能手机等新电子设备时获得的小册子，也可以是我们收到的与较大物品（如汽车）一起收到的厚书。 所有这些文件都是由技术作家编写的。 在这里，作者旨在提供有关如何正确使用设备或设备的信息。

法律免责声明

这些也称为对冲条款。 它们通常是为了向读者提供免责声明，说明组织在使用其产品或服务时是什么以及不承担什么责任。 技术作家通常必须咨询法律专家和产品开发人员，以了解哪些内容可以写入法律免责声明，哪些内容不能写入。

根据销售产品或服务的市场，法律免责声明更加复杂。这是因为不同国家/地区对公司在该地区支持和服务客户​​有不同的法律要求。

还有很多其他类型。 上面提到的只是一些技术写作示例，供您参考。

你如何成为一名技术作家？

如果您有兴趣成为一名技术作家，那么有好消息。 不仅有很多方法可以进入该领域，而且世界各地的公司对技术作家的需求也一直在增长。 他们需要您的帮助来为其产品、服务和流程编写技术文档。 在这个积极的方面，您可以做以下不同的事情来成为一名技术作家 -

学习写作

虽然这听起来很明显，但学习写作并不仅仅涉及将句子串在一起。 您需要学习写作中的各种子主题，例如为不同类型的写作使用不同的声音，了解如何清楚地描述和参考插图等等。

了解写作的不同阶段

在几乎任何技术写作项目中，你都会经历这三个步骤——

#1。 规划

项目规划通常由您的雇主或客户发起。 在此步骤中，定义了基本要求，例如文档的类型、主题、目标、范围和目标受众。

如果最初没有提供所有内容，您需要与您的客户或雇主交谈，并通过对话获取这些详细信息。 有时他们可能不确定他们在寻找什么。 作为技术作家，您的工作也是确保您能够传达完成项目的需求。

通过适当的提问和对话，这一步可以为您节省大量时间和精力。

#2。 了解受众需求

如果您能够在第一步中缩小受众范围，那么第二步需要了解您的受众是谁以及他们在寻找什么。

在开始写作之前，尽可能多地收集有关您的听众的信息。 例如，您的读者是否具有该领域的技术专长？ 他们能理解复杂的术语和行话吗？ 或者他们是该领域的新手？

此外，观众在阅读技术文档时也可能会有一些期望。 他们会寻找什么？ 他们是想深入了解产品，还是外行只是想知道如何使用产品？ 提供读者真正想要的东西将决定你的整个写作过程。 记住——他们在问问题，你需要提供准确的答案。

此外，寻找 API 文档的开发人员与购买需要组装的全新家具的客户完全不同。 这是两个不同的受众，在他们的技术文档中有不同的要求。

#3。 写给观众

在了解了受众的需求之后，了解您将如何创建文档来满足这些需求。 作者倾向于犯的一个常见错误是创建的文档可以被其他作者很好地接受，但对最终用户几乎没有价值。

所以在你开始在键盘上打字之前，问问自己这些问题——

• 我正在为其写作的读者是否可以轻松访问该文档？
• 从观众的角度来看，该文件是否易于理解？
• 读者将如何使用这份文件？
• 该文档是否易于浏览？
• 文档对我的读者来说太复杂了吗？
• 文档对我的读者来说太简单了吗？

培养技术写作技巧

无论您选择为哪个领域写作，该领域都将涉及一定程度的技术专长。 如果不知道什么是语法、API 和编程语言，就无法编写软件文档。 如果你想写一篇关于 C++ 的文档，你至少应该知道 C++ 是如何工作的。 如果您可以使用它进行编码，那就更好了。

做大量的研究

这不仅仅是为了了解如何编写下一个技术写作作业。 您希望随时了解您所在领域的最新动态，以便更好地向用户解释术语和概念。 如果您的受众由高级软件程序员组成，那么您需要保持在他们的水平上，以确保您的内容对他们有用。

拥有所有这些技术写作技能，您将准备好担任技术作家的角色，无论您是全职还是从事技术写作自由项目。 但重要的是要记住，准备成为一名技术作家是一种持续的经历。

技术作家的角色

写作是技术作家的一部分，即使它是一个主要角色。 如果您想成为一个可以承担任何项目的全面技术作家，那么了解您在从事技术写作工作时将承担的所有角色非常重要。

编写、编辑和校对文档

当然，作为作家，您应该知道如何编写技术文档。 如上所述，这可能包括各种文档，从用户手册到法律免责声明。 此外，技术作家还需要对文档进行编辑和校对，以确保其准确性和可读性。 如果您正在与团队中的其他技术作家合作，您将检查彼此的写作，以确保其符合质量标准并向观众提供所需的信息。

与项目利益相关者协调

每个项目都会有开发人员、工程师、经理、客户和其他利益相关者。 你的工作还包括与他们协调和沟通文件需要什么、它会接触到谁以及它应该包含什么。

您还需要了解可用于特定项目的预算类型，并相应地分配您的时间、资源和精力。 如果没有足够的资源或时间来完成某个项目，您将需要确保您能够从项目经理和领导那里获得这些资源。

使用实验软件提供文档

如果您正在编写具有定期发布更新的软件，您将需要了解实验性软件的功能和特性，以便让用户了解每个更新将包含的内容。 这可以包括补丁说明、错误修复等。通常，补丁说明和错误修复比传统的技术文档要短得多，但它们的发布时间表更频繁。

评估和推荐标准和指南

作为一名技术作家，您将根据您所服务的项目或组织遵守某些指导方针和标准。 这些指南和标准将需要在不同的场合进行更新和更改。 流程和产品会发生变化，因此需要不时审查和监控标准和指南，以确保它们满足受众、产品/服务和组织的需求。

技术写作所需的技能

如果您希望将此作为您的首选职业，请了解除了写作之外，还需要更多技能。 优秀的技术作家拥有多种技能，以确保他们能够创建出色的技术文档。 以下是技术写作所需的不同技能 -

#1。 写作技能

这是给定的。 技术作家需要具备无可挑剔的语言技能以及对语法、语气和词汇的深刻理解，以使他们的文档易于被观众理解。

#2。 研究

技术作家需要知道如何深入研究一个主题并找到否则很难找到的信息。 读者在阅读您的文档时希望了解整体情况，而繁重的工作由您决定。

#3。 团队合作

通常，您会发现自己是团队的一员，与其他技术作家、工程师、团队负责人、经理和法律专家一起工作。 您需要学习有效地与团队合作，才能成为一名出色的技术作家。

#4。 单一来源

单一来源使您可以使用相同的源文档生成多个文档。 当您有一项任务需要您为不同的受众制作多个用户指南但使用相同的源文档时，这非常有用。

一位观众可能是高级用户，而另一位观众可能是完全的外行。 在这里，引用单个文档并为每个受众创建多个文档可以帮助您有效地管理时间和资源。

#5。 系统化

技术写作，虽然是彻底的，但也不应该失去可读性。 如果结构和呈现不当，经过充分研究的技术文档将毫无用处。 读者将难以浏览文档，成为读者理解的苦差事。 在你的写作中系统化和有条理将帮助你更快地完成你的项目，同时也确保观众可以清楚有效地从你的作品中获得价值。

#6。 网页设计技巧

在当今互联的世界中，大多数文档很少放在纸上以供使用。 尽管这是可选的，但学习网页设计和开发技能有助于使您的文档在网站上易于访问，以便在线用户寻找说明和信息。

包起来

无论您是打算从事技术写作自由职业还是计划在该领域全职工作，您都需要了解和掌握上述所有内容。 如果做得好，技术写作工作可能会带来难以置信的回报，因为您正在向成千上万甚至数百万人提供清晰易懂的信息。

但与此同时，从您在上述示例中看到的情况来看，这也是一个要求极高的职业，需要您在计划投入服务的每个领域中紧跟最新趋势、市场、创新等.

如果您需要技术内容并需要专业服务来编写一份出色的用户手册，并支持 AI 质量保证，Scalenut 拥有您需要的所有专业知识。 立即与我们联系并提出您的要求。