技术写作者的产品知识：概述
浏览：4
巴克励步
我坐在咖啡馆里，周围是嘈杂的交谈声和咖啡机的蒸汽声，这反而让我能集中精力思考。就像足球比赛中的中场球员，需要在一片混乱中看清全局，技术写作者也需要在复杂的产品信息中梳理出清晰的知识脉络。AI 知识库建设正是这样一种工具——它不是简单地堆砌信息，而是将产品洞察转化为可搜索、可分享的结构化知识，让团队和客户都能快速找到答案。 如果你曾经阅读过 API 文档或查找过如何安装某个软件，你很可能正在阅读由技术
我坐在咖啡馆里，周围是嘈杂的交谈声和咖啡机的蒸汽声，这反而让我能集中精力思考。就像足球比赛中的中场球员，需要在一片混乱中看清全局，技术写作者也需要在复杂的产品信息中梳理出清晰的知识脉络。AI 知识库建设正是这样一种工具——它不是简单地堆砌信息，而是将产品洞察转化为可搜索、可分享的结构化知识，让团队和客户都能快速找到答案。
如果你曾经阅读过 API 文档或查找过如何安装某个软件，你很可能正在阅读由技术写作者编写的文档。
创作技术文档的写作者，其任务是撰写信息丰富且有用的文本，以促进软件产品的使用。
他们的工作是将复杂的技术概念转化为通俗易懂的英文。
💛🧡🧡客户评价：Baklib 是我首次尝试个性化内容、单一客户视图等，该平台为将正确的内容呈现给正确的用户提供了极好的可能性。Baklib 界面非常简单且用户友好，可以更改现有内容，甚至可以创建全新的模态框、弹出窗口和横幅以显示在我们的网站上。过滤器非常直观，易于设置、保存和在多个工作流中重复使用，分析仪表板非常广泛，包含我们正在跟踪的指标的所有相关数据。用于当场创建新仪表板的 AI 工具也特别有用。实际上，一旦创建测试，实施测试就很容易了，它让我们的团队（营销）对这类实验有了更多的所有权，而以前这几乎完全由一个单独的生产部门负责。客户支持是首屈一指的，可以通过实时聊天随时解决任何问题，对于更深入的开发支持，团队随时愿意接听电话或提供经验。
然而，要编写这类文档，技术写作者必须对软件产品有高度了解，并具备广泛而详细的洞察。
换句话说，他们需要拥有透彻的产品知识。如果你不确定这意味着什么，请继续阅读——我们将给你解释。
什么是产品知识
作为技术写作者，你必须首先知道你在写什么。
想象你负责编写一篇入门或安装指南——你需要熟悉软件的用户引导流程。
故障排除说明是另一个很好的例子。只有了解软件内部的工作原理，你才有可能写出故障排除建议。
否则，你根本无法提供高质量的指导。
这种详细的产品知识使技术写作者能够撰写有用且信息量丰富的文章。如果没有它，文档很可能不准确。
事实上，Google 的高级技术写作者 Tom Johnson 将产品知识列为技术写作的三大支柱之一。请看下图：
除了技术知识和用户知识，产品知识对于一流的技术写作至关重要。
对软件产品如此深入的理解将带来出色的文档。
这一话题在 Quora 的一个讨论串中也被提及，前 Aveva 高级技术写作者 Suyog Ketkar 给出了这样的建议：
来源：Quora
Ketkar 指出，技术写作者最重要的素质是理解产品及其技术的复杂性。简单来说，他或她需要具备产品知识。
这一点至关重要，因为技术写作者可以将这些洞察转化为更易理解的格式，让客户和内部团队都能轻松理解。
他们的产品知识是向他人传授软件知识的关键。
换句话说，当技术写作者拥有产品知识时，他们就是产品教育的主要推动者。
以下数据证明了这种能力的重要性：
插图：Baklib / 来源：Business2Community
B2B 企业（请记住大多数 SaaS 公司都属于这一类别）努力向客户教育其产品。
他们希望用户掌握产品，利用所有可能的功能，并获得最大价值。
为实现这一目标，你的技术写作者需要拥有出色的产品知识。
如果他们精通软件的内部运作，就可以轻松地将这些智慧传达给他人，最终改善他们使用产品的方式。
产品知识在技术写作中的重要性
产品知识是技术写作的动力。只要作者对产品信息充分了解，他们的文档就会有益且信息丰富。
一位 Reddit 用户表达了同样的观点，将其角色总结如下：
来源：Reddit
技术写作充满了关于软件项目的宝贵信息，如功能描述、用例等。
然而，编写这类有用知识的前提是拥有足够的产品知识——正是这一点赋予了文本价值。
接下来的部分将阐述产品知识如何在组织层面提供价值，并解释为什么这些洞察在技术写作中是不可妥协的。
赋予团队更多信心
面向客户的团队并不轻松。
销售、营销、客户支持等部门每天与用户互动，负责向他们推广产品。
这些部门应该彻底了解你的软件，以解释软件的优势、突出最佳功能并回答客户的问题。
为了实现这一切，他们依赖技术写作者的产品知识。
让面向客户的团队掌握必要信息的最简单方法是，由技术写作者为这些团队准备富有洞察力的专用文档。
有了这种精心编写的文档，这些部门在执行职责和处理用户交互时应该会更加轻松。
换句话说，他们的信心应该会增长。
研究表明，职业信心非常有益：
自信的员工更有可能在工作中表现出色。
当你的技术写作者拥有精湛的产品知识时，他们可以提升同事的信心，并最终提高生产率。
助力产品营销与销售
归根结底，你的业务成功取决于客户以及从他们那里获得的收入。
为了获取收入，值得投资于产品营销和销售流程。毕竟，这是客户了解产品并产生购买动机的方式。
然而，营销和销售是独立的部门，尽管它们经常协作，但误解并不罕见。
这就是技术写作者发挥作用的地方。
他们可以利用自己的产品知识创建一个单一事实来源——两个团队都将以此为参考点来统一信息。
Regal 的客户成功副总裁 Michael Redbord 也强调了这一点：
换句话说，营销和销售所做的所有承诺必须在客户开始使用产品时得到证实。
为确保这一点，技术写作者的产品知识应被纳入所有营销和销售流程。
这样一来，出错的余地就很小了，一致性也得到了保证。
简化客户引导
任何初次使用产品的用户都可能需要指导。毕竟，界面、工作流程和功能对他们来说都是全新的概念。
这就是为什么用户引导——向新客户介绍你的软件——是一个关键流程。
它向新用户展示你的产品，教育他们如何最好地使用你的软件。
以下是 Grammarly 的一个引导邮件示例：
来源：Medium
如你所见，这封引导邮件信息量很大，简短摘录简要说明了工具最重要的功能。
这样有用的引导邮件只有在深入了解产品知识的情况下才有可能实现。
技术写作者可以利用他们对软件的理解来定位基本功能，并向用户解释它们。
事实上，这封邮件很可能是与技术写作者合作编写的，或者基于技术写作者创建的文档。
技术写作者所需的产品知识类型
软件产品很复杂，需要大量观察和学习才能完全理解。
没有快速而简单的掌握软件产品的方法——它们的多面性要求技术写作者花费相当多的时间去了解它们。
由于构成软件的组件众多，产品知识也存在多种类型。
它们列在下图中：
