技术写作的6个新趋势，你了解几个？

作为一个常年潜伏在产品文档和知识管理一线的研究员，我越来越觉得，产品手册不是写完就完事的，它得活起来。很多企业做产品手册，要么扔给一个实习生用Word撸一遍，要么套个模板往那一放，根本没人看。这背后其实是两件事没想透：第一，用户要的不是说明书，是解决问题的方法；第二，产品手册的呈现方式决定了它能不能被用起来。所以当看到技术写作领域开始扎堆讨论新趋势时，我知道，产品手册建设的那个“老规矩”时代，真要翻篇了。

如今，在线可用的写作工具越来越多，推动了一个技术写作新趋势：写作者不再死守微软Word，而是用各种技术写作工具来规划、创建、编辑和发布内容。

既然能用多个专业化工具提升写作水平，为什么还要只靠一个通用软件呢？比如，你可以用 Notion 做规划，用 Miro 画图。这样做效果远好于因为习惯了而用一个不合适的万能工具处理所有事。不过，在写作和编辑环节，大多数写作者会选定一个解决方案来保持内容有序。

Baklib，我们的产品文档平台，就是为此而生的——不仅功能强大，还能很好地与外部应用集成。Baklib 的编辑器让你在单一平台上写作、编辑和整理内容。但如果你紧跟技术写作趋势，你可能需要的远不止这些：Baklib 提供了25种嵌入和集成，这意味着你可以在不切换多个标签和窗口的情况下，混合使用不同的写作工具。

举一个场景：清晰性是优秀技术写作的前提之一，你很可能在使用 Grammarly 之类的写作助手。如果你用 Baklib，与 Grammarly 的集成让你在写作时直接调用助手，无需复制粘贴，这避免了格式错误的风险。两个工具协作的效果远胜一个。想象一下，如果你探索专为行业打造的工具，其他领域的技术写作会提升多少。记住，工具是为了协助你创作更好的技术内容。一旦你走出舒适区，你会发现能改进技术写作各个领域的新工具。

随着企业越来越意识到优质技术文档带来的好处，它们开始让更多人参与创作过程，以确保最终成果的精良。这一转变催生了新的技术写作趋势：文档协作。技术写作不再是孤岛。写作者、领域专家、编辑和审校者在写作过程中都扮演着关键角色。不过，电子邮件和 Slack 消息并不是实现最优团队协作的方式；更好的做法是使用带有内置提及系统的写作平台，比如 Baklib。在 Baklib 中，所有协作者都可以高亮内容部分并留下评论，还可以通过标记用户和引用相关文档来确保信息传达到位。这样，所有对变更、澄清和更新的请求都一目了然。这个趋势最大的好处是，你无需等待写作者提交初稿就能进入下一个阶段。协作工具让所有参与方从一开始就介入，这对于保持术语的一致性尤其有用。

在几乎所有软件产品都附带技术文档之前，技术写作常常是未知领域。然而，技术内容的兴起促进了更成熟的写作实践，进而催生了标准化趋势。这些标准来自技术写作者社区的持续演进，并非一成不变。无论你写的是成熟行业还是机器学习这类创新领域，你都可以在线找到别人是如何向读者呈现信息的。甚至还有针对深度学习的专业文档，比如 PyTorch 的文档。此外，你可以查看越来越多的技术写作资源：技术写作书籍、风格指南和博客，学习如何更好地呈现内容。尽管缺乏严格的或政府颁布的标准，但丰富的资源让写作者更容易看到别人如何处理技术话题，共享写作实践的趋势也增加了可参考材料的可获得性。不过，写作实践经常变化，你应该把经常更新的资源当作写作标准。

客户想要容易获取的信息，最好的方式就是让文档具有交互性。交互性的关键要素是让用户按自己的节奏浏览文档。例如，在文档中加入搜索栏，方便用户搜索所需信息；可点击的目录帮助读者直接跳到相关章节，无需翻阅所有页面。一些公司甚至让内容本身变得可交互，这主要体现在实体产品的文档中。软件产品本身已是交互式的，用户可以自己探索功能。但描述实体产品时，你不能让用户把半吨重的设备翻来覆去地检查。因此，交互式3D模型正成为技术文档的标准功能。3D模型是交互式文档的真正体现，它允许读者从各个角度检查产品、放大查看组件细节，有些甚至可以透视内部结构。读者成了内容的控制者。作为技术写作者，你可能不需要学习CAD工具，但应该准备好为产品提供更多描述，以回应读者可能选择的每个视图。交互式文档开发起来可能更费劲，但它让探索产品变得更容易，所以这个趋势会持续下去。

如果你最近在技术文档中发现了更多视频或GIF，你实际上已经见证了媒体丰富型技术写作的新趋势。客户想要信息，却不想花大把时间去获取。这就是为什么冗长的过程描述被更亲和的视频等格式取代。以 Datree 的文档为例，在介绍如何发现 Kubernetes 清单文件中的错误配置时，它先用一个短视频引入主题，然后跟随简洁的说明，辅以截图和GIF。这种媒体组合让用户直接看到过程，而不是阅读后可能产生误解。当然，视觉元素的选择取决于你要传达什么：视频和GIF更适合描述过程，而截图和图片则常见于许多技术文档中，带有清晰注释的图片可以帮助用户导航软件产品。此外，GIF也变得越来越流行，因为它们既有视频的动态效果，又保留了简单格式的优点，即使通过数据流量也能加载。

最后但同样重要的是，AI正在改变技术写作。从语法检查到自动补全，AI工具正帮助写作者提高效率和质量。例如，Baklib 中的AI功能可以辅助写作，提供建议或自动生成部分内容。虽然这不会取代人类写作者，但可以让他们更专注于高价值的创作任务。

---

Baklib 是一个 API 优先的可组合软件平台，它收集和组织整个企业的内容，以答案的形式提供相关的可操作信息，无论人们在何处询问有关企业的问题。5 多年来，Baklib 一直在创新构建数字体验平台的配套组件。随着时间的推移，我们稳步推出了互补的产品和功能，帮助企业在各种第一方和第三方数字接触点提供答案。