技术写作简介

图片来源：#WOCinTech Chat

技术写作影响着每一位开发人员。他们以文档的形式阅读技术作家撰写的内容，同时也创作技术内容。公司和开源项目都深知，精心编写的文档是产品被广泛采用的关键。事实上，在 2017 年 GitHub 的一项调查中，93% 的受访者表示，“文档不完整或过时是开源领域普遍存在的问题” 。

因此，我们理解了技术写作的重要性，但技术写作到底是什么呢？

在这篇文章中，您将了解什么是技术写作，发现软件及其他领域技术写作的示例，并了解技术作家为创建成功有效的文档而开发的其他技能。

什么是技术写作？

技术写作是一种以文本形式为用户创建指导性或信息性文档的实践。在软件开发领域，常见的技术写作类型包括产品和 API 文档、手册页、教程和指南。但技术写作并不局限于软件或开发者工具领域；技术写作还包括从消费产品到制造业、航空航天工程和医疗技术等各个领域的用户手册。在某些情况下，数据可视化、白皮书、知识库/在线帮助文章等文档也属于技术写作。（技术写作是更广泛实践领域的一门专业，被称为技术交流。）

技术写作与其他形式的写作有何不同

与其他写作形式（例如市场营销或广告文案）不同，技术写作力求精准和实用。例如，想象一下你在送餐包里找到的食谱。食谱列出了你需要的确切配料以及每种配料的精确用量。这种写作既精准又简洁；食谱作者知道，正在做饭的人肯定不想看冗长的食谱！技术作家也试图以类似的方式传达信息。这种写作风格旨在创造一种读者几乎难以察觉的流畅用户体验。

如果技术写作有效，读者就能更快地理解。但如果写作质量低劣，读者可能会难以继续阅读，从而感到沮丧。例如，一位开发人员在尝试解决工作中遇到的问题时，决定查阅某个包管理器的官方文档。他们时间紧迫，需要能够快速浏览文档以找到解决方案。他们会快速浏览页面，寻找能够指引他们正确方向的特定单词、短语或代码片段。优秀的技术写作会牢记这一点。

如果故障排除步骤含糊不清、不完整或充斥着冗长的语言，开发人员将需要更长的时间才能完成任务。在这种情况下，开发人员访问文档并不是为了欣赏文档编写者的写作能力，而是为了寻求文档的帮助。

让我们考虑一个软件之外的例子。副驾驶员必须在飞行过程中查阅手册。他们需要能够快速找到手册中能够帮助他们解读某个飞行仪表的章节。在这种情况下，用户（飞行员）没有时间去思考这些指令的含义，尤其是在紧急情况下。他们不想听笑话或花言巧语，也不想听背景故事。他们想找到问题的解决方案，不想耗费不必要的脑力。

这就是为什么与我们在电子邮件简报、博客文章或落地页上看到的文案相比，一些技术文档显得“枯燥”或“缺乏亮点”。文案用于说服用户采取某种行动，而技术写作则是为了支持用户并消除完成任务的障碍。优秀的技术写作很难，因为作者必须直奔主题，避免读者迷失或感到困惑。这需要作者熟悉主题，具备倾听和观察的能力，以及对读者的深刻理解。

技术作家可以做的不仅仅是写作

除了语气之外，技术作家也非常注重文档设计。我们阅读在线内容的方式与阅读印刷内容的方式不同，因此文档设计也取决于文档格式。文档设计的要素包括布局、页面格式、字体、颜色和其他视觉辅助工具。技术作家会构建文档结构以方便阅读理解。他们了解许多读者会浏览和扫描文档来寻找所需信息，而作家则会寻找向读者呈现相关重要信息的方法。他们也认识到，用户需要按照特定顺序执行步骤才能达到预期效果。

技术写作不仅限于撰写草稿。技术作家必须熟悉研究方法、可用性、视觉设计和教学设计等。他们必须了解用户以及促使用户与文档交互的场景。他们必须能够搜索正确的信息，并知道如何向主题专家提问。他们了解文本和视觉设计如何协同工作以创造具有凝聚力的用户体验。他们会根据需要审查和修改自己的作品，并认识到编辑在写作过程中的重要性。

想要了解更多有关技术写作的知识吗？

我整理了一份技术写作资源清单，供大家继续学习。其中包括写作风格指南、书籍、在线资料和课程。

在能够向专家学习，并将所学知识应用于项目或作业的环境中，我的学习效果最佳。如果您也一样，我建议您参加加州大学圣地亚哥分校的推广项目或技术传播者协会（Society of Technical Communicators）的技术传播课程。美国其他大学也提供在线技术传播课程和证书课程。

这篇文章最初出现在我的博客上。

我是 Stephanie，一名内容策略师和技术项目经理。访问developersguidetocontent.com了解更多关于我的工作！

资料来源：

文章来源：https://dev.to/radiomorillo/a-brief-introduction-to-technical-writing-53bh