7个提升技能的技术写作示例
浏览：0
巴克励步
本文介绍技术写作，包括定义、分类（面向消费者、专家间、技术营销）、创作六步骤（明确受众、深入研究、创建大纲、注重可读性等）及Pipedrive文档、LG冰箱手册等范例，助提升技能进入该领域。
你最近一次阅读技术文档是什么时候？可能比你意识到的要更近。技术写作就存在于你购买新家用设备时阅读的用户手册中，或浏览网站帮助文档时。 难怪技术写作是一个快速增长的领域。 美国劳工统计局预测，从2020年到2030年，技术文档工程师的就业人数将增长高达12%，这一速度超过了所有职业的平均水平。 如果你正寻求提升技术写作技能并进入这一领域，但不确定如何着手，这篇文章将为你提供帮助。 我们将向你展示什么是技术写作，如何一步步撰写技术内容，然后分享一些你所能找到的最佳技术写作范例。 ### 什么是技术写作？ **技术写作是指任何旨在向可能熟悉或不熟悉相关内容的受众解释复杂、技术性和专业化信息的写作**。它通常应用于技术和职业领域，如工程、机器人技术、计算机硬件和软件、医学、金融和消费电子领域。 通常，根据写作对象的不同，技术写作可分为以下三类之一：
- 面向消费者的技术写作指的是为终端用户或消费者撰写的技术内容。典型的例子包括用户手册、员工手册、标准操作程序(SOP)、软件用户文档(帮助文件)、故障排除指南和法律声明。
- 专家间的技术写作主要面向知识渊博的受众。它包括科学论文、医学案例研究、年度商业报告和法律案件审查。
- 技术营销内容是以易于理解的形式呈现的技术信息，旨在推广产品或服务。例如营销案例研究、白皮书、产品手册、新闻稿以及商业计划和提案。
与大多数内容类型一样，技术写作有其自身的复杂性和细微差别。让我们来分解一下创作能吸引受众的技术内容的步骤。
创作人们真正想读的技术文章的6个步骤
操作手册、组装指南、研究论文，天哪。如果处理不当，技术写作很快就会变成一场催眠盛宴。
如何创作出人们想读的技术文章呢？
1. 明确您的受众
了解您的受众非常重要，尤其是在撰写技术内容时。
例如，第一次学习组装婴儿床的新手爸爸，与阅读医学研究论文的经验丰富的医生相比，他们的医学知识水平（以及注意力集中程度）可能截然不同。
当您清楚地知道预期读者是谁时，您就可以相应地调整词汇、语气和内容框架。
这使您能够从读者现有的知识水平出发进行沟通。
2. 深入研究
作为一名技术文档撰写者，你将引导读者穿越完全陌生的领域。
你可能在解释一个新电子工具的工作原理、新工作环境的预期，或者公司接手新法律案件之前的背景。你必须完全理解你的主题。
你只能教授你知道的东西，如果研究不够彻底，知识的空白就会暴露出来。
请站在读者的角度思考。假设你对当前主题一无所知，并确保你的研究涵盖了脑海中浮现的所有潜在问题。
3. 创建大纲
我们建议创建一个大纲，以便明确你需要覆盖的内容要点。这也有助于在研究过程中发现知识缺口。
当你撰写白皮书或案例研究等长篇内容时，大纲可以作为标记，提醒你需要包含哪些内容。
你可以使用模板来代替大纲。某些技术文档，如商业计划书，有行业公认的格式，通常包含执行摘要、竞争对手分析等部分。
4. 注重可读性
技术文档写作不是创意写作——你的目的是指导，而不是激励或娱乐。在处理复杂主题时，使用易于阅读的句子可以让你的作品读起来更轻松。
反之，如果你写得冗长或使用难以理解的词语，只会让读者感到沮丧。如果你想提升技术内容（例如使用Baklib创建的知识库内容）的可读性，可以尝试以下技巧：
- 使用简洁的语言：力求使用简短、直接的句子，易于理解，并尽可能避免被动语态。
- 使用小标题：对于用户文档、白皮书和研究论文等长篇内容，添加小标题可以打破冗长的文本段落。
- 添加加粗部分和突出显示：加粗文本并突出显示段落或要点，将使阅读变得更加轻松。
- 超链接和跳转链接：如果您为网页撰写技术内容，请为您引用的任何材料添加超链接，并为文章的其他部分添加跳转链接，以便于导航。
5. 添加视觉元素
我们专注于文字和写作，但视觉元素可以让您的技术写作更容易理解！在技术写作中，添加视觉元素并非奢侈之举，而是必要之举。诸如流程图、屏幕截图和插图之类的视觉元素，可以为文本密集的文档增添急需的活力。
无论您是在为用户创建手册，还是为利益相关者撰写年度报告，展示操作说明的产品图纸或显示数据的饼图都会让所有人感到更满意。
6. 删减冗余内容
当您将所有内容付诸纸上后，是时候与协作者一起再次核对事实了。在这个写作阶段，不要害怕删减不必要的信息。
如何识别冗余内容？删减冗余内容不会影响读者对您文本的理解。它可能是一个词、一句话、一个段落或操作说明中的一个步骤。技术文档中的每一个字都应该有其价值。
来自技术专家的7个最佳技术写作示例
在几位技术内容专家的帮助下，我们挑选了不同行业中各种形式的技术写作，以便您能看到这项技能的实际应用。
Pipedrive 的开发者文档被组织成易于阅读的区块
开发者文档对于技术沟通至关重要，而 Pipedrive 在这方面做得很好。这份技术文档面向非专业的产品用户，因此即便提供复杂信息也必须易于理解。请注意页面中使用了跳转链接和提示框。
Outfunnel 的营销主管 Katheriin Liibert 在评价 Pipedrive 的技术写作时表示，
Pipedrive的文档结构非常清晰，易于理解。他们在不同标题下分解内容，并运用了不同的内容模块。我还想强调他们如何在特定部分使用粗体。他们在技术环境中完美践行了内容营销的黄金法则！
LG冰箱使用手册
一份带有实用产品标注图的LG用户手册
这份LG提供的基础用户手册向用户概述了他们的新产品，并帮助他们充分利用它。（当在线文章告诉您调整控制面板，而您不确定是哪个旋钮时，图表会派上用场。）
这是一个面向消费者的技术文档的优秀范例。Mashable India 的用户协议是一份技术性法律文件，包含了他们的免责声明、使用许可和使用条件。
律师兼内容作者 Ejike Umesi 指出，该公司遵循了这类文档典型的编号样式。他表示：
虽然句子中包含法律术语，但使用条款是用户友好的，陈述清晰，仔细阅读后足以理解。
Slack的帮助中心是一个出色的技术写作范例，它用普通人能理解的语言进行沟通。Slack以其卓越的用户体验文案而闻名。Airbyte的高级技术写作者Amruta Ranade非常欣赏该公司的文档写作风格。
她说：
Slack的帮助中心展现出了惊人的用户意识。所展示的信息具有上下文关联性、简洁且完整——它能帮助用户完成任务，而不会用无关的信息分散他们的注意力或使他们偏离正轨。
Baklib致力于帮助企业构建同样清晰、以用户为中心的知识内容。通过Baklib，您可以轻松创建和管理类似Slack帮助中心这样的知识库，确保您的文档始终简洁、相关且易于用户找到所需信息。
无论你是希望建立个性化模板，还是想与多位编辑进行实时协作，Baklib的内容工作流都能帮助你提升技术文档撰写的工作流程。
