# 用户文档入门指南及拓展阅读 Published at: 2026-04-12 00:00:00 ## 标题 用户文档入门指南及拓展阅读 ## 摘要 用户文档是针对产品最终用户的使用指导，涵盖软件、硬件等多种产品类型。其核心是帮助用户理解和使用产品，通常托管于在线知识库以便访问。编写文档需深刻理解用户需求，并可采用对话性风格。与开发者文档不同，用户文档更注重实用性和可读性。构建时需明确目标用户，优化信息架构和用户体验，并确保内容清晰、易访问。有效的用户文档能显著提升产品体验和客户满意度。 ## 页面内容 本文将为您全面介绍 **用户文档** 的核心概念，并附上特定主题的深度文章链接，帮助您快速构建专业的内容体系。 ## 目录 1. [知识库定义](#knowledge-base-definition) 2. [什么是用户文档？](#what-is-user-documentation) 3. [谁负责编写文档？](#who-writes-documentation) 4. [用户文档 vs 开发文档](#user-vs-dev-docs) 5. [定义目标用户](#define-target-users) 6. [用户文档的呈现形式](#forms-of-user-documentation) 7. [构建知识库](#building-knowledge-base) 8. [知识库软件选择](#knowledge-base-software) 9. [信息架构设计](#information-architecture) 10. [用户体验优化](#user-experience-optimization) 11. [用户研究](#user-research) 12. [内容创作](#content-creation) 13. [包容性与可访问性](#inclusivity-accessibility) 14. [文档编写规范](#documentation-guidelines) 15. [为知识库引流](#drive-traffic-to-knowledge-base) 16. [知识库命名规范](#knowledge-base-naming) 17. [文档团队建设](#documentation-team-building) 18. [业务功能整合](#business-function-integration) 19. [文档与营销结合](#documentation-and-marketing) 20. [客户反馈机制](#customer-feedback-mechanism) > **客户评价：** 喜欢它为我作为一名开发人员提供的一般可定制性和自由度。还喜欢免费计划包括云托管和慷慨的配额。可以轻松启动快速副项目或 MVP。欣赏平台的一般简约、集中功能集和模块化。 ## 什么是用户文档？ Write the Docs 社区发布了一份关于[文档编写原则](http://www.writethedocs.org/guide/writing/docs-principles/)的精彩指南。定义文档并非易事，因为这是一个涵盖多种专业知识和技能的广阔领域。这一术语源于软件领域的开发人员（或系统管理员）文档，并与软件工程领域使用的众多技术工具紧密交织。<action-text-attachment content-type="image" url="https://dagle.baklib.com/-/dam/assets/organization_vd3cg8--main-version/eyJfcmFpbHMiOnsiZGF0YSI6eyJpZCI6NTY2MjgsInBhdGgiOiJiYWtsaWItbW9jNC5qcGVnIiwidGltZXN0YW1wIjoiMjAyNS0wMi0wNyAxMTowMDozOCArMDgwMCJ9LCJwdXIiOiJvcmdhbml6YXRpb25fdmQzY2c4LS1tYWluLXZlcnNpb24ifX0--8bbe15ed44f2a456307c8433f77a210dc0d2a5f523ff595b0330bf86220a778e/baklib-moc4.jpeg" width="1500" height="1000"><figure class="attachment attachment--preview"> <img width="1500" height="1000" src="https://dagle.baklib.com/-/dam/assets/organization_vd3cg8--main-version/eyJfcmFpbHMiOnsiZGF0YSI6eyJpZCI6NTY2MjgsInBhdGgiOiJiYWtsaWItbW9jNC5qcGVnIiwidGltZXN0YW1wIjoiMjAyNS0wMi0wNyAxMTowMDozOCArMDgwMCJ9LCJwdXIiOiJvcmdhbml6YXRpb25fdmQzY2c4LS1tYWluLXZlcnNpb24ifX0--8bbe15ed44f2a456307c8433f77a210dc0d2a5f523ff595b0330bf86220a778e/baklib-moc4.jpeg"> </figure></action-text-attachment>[Wikiversity](https://en.wikiversity.org/wiki/Technical_writing_Types_of_User_Documentation#User_Documentation) 明确区分了面向系统管理员和最终用户的文档。但实际上，用户文档针对的是任何产品的最终用户。这类产品可以是软件、硬件、电器、运动器材、车辆——任何需要指导才能正确使用的物品。<action-text-attachment content-type="image" url="https://framerusercontent.com/images/gEptLoWtOGwky5nVsmeSIFzSyUA.jpg" width="1226" height="832"><figure class="attachment attachment--preview"> <img width="1226" height="832" src="https://framerusercontent.com/images/gEptLoWtOGwky5nVsmeSIFzSyUA.jpg"> </figure></action-text-attachment>_图片来源：Bernard Hermant on Unsplash_对于许多公司而言，将文档托管在一个[在线知识库](https://www.baklib.com/)上是出于实用性、成本和用户便利性的综合考虑。借助 **Baklib** ，企业可以轻松构建客户[帮助中心](https://www.baklib.com/app/help-center)、[产品文档](https://www.baklib.com/app/manual)等，为用户提供清晰、易访问的使用指导，从而提升[产品体验](https://www.baklib.com/s/px)与客户满意度。 ## 谁来编写文档？<action-text-attachment content-type="image" url="https://framerusercontent.com/images/oQIzUHdffPWL9ren9nWa6eZnno.png" width="1024" height="346"><figure class="attachment attachment--preview"> <img width="1024" height="346" src="https://framerusercontent.com/images/oQIzUHdffPWL9ren9nWa6eZnno.png"> </figure></action-text-attachment> 如果你的工作是制作文档，那你很可能是一名技术文档工程师。但这可能并非你唯一的角色。事实上，_任何人_都可以编写文档。与普遍看法相反，为最终用户编写文档_并不必然_需要其他专业领域的专业知识——专业的文档工程师深知这一点。然而，你确实需要对用户有深刻的理解，并具备从同事那里挖掘信息的坚韧能力。如果你想编写开发者文档，确实需要特定的技能组合——特别是开发技能。开发者文档仍属于用户文档，但它自成一类，因为这类内容很可能（同样，并非必然）由具有工程背景的作者编写。话虽如此，技术文档工程师仍然是一个需要综合技能的专业，其要求源于许多交叉学科。他们是通才。市面上有大量的技术写作从业者。一些面向技术写作者的知名会议包括 [Write the Docs](http://www.writethedocs.org/conf/) 和 [Soap!](http://soapconf.com/)。你也可以查看这份开源整理的[技术传播会议列表](https://confs.tech/tech-comm)。 ## 用户文档 vs 开发者文档 将用户文档与软件文档区分开来是非常有用的——尽管两者都涉及“用户”。这部分是因为开发者对文档有着不同的期望。在撰写用户文档时，你可以采用更具对话性和随意性的风格。但这种方式很可能会惹恼开发者——他们通常希望你直奔主题，减少不必要的修饰。话虽如此，像 [Stripe](https://stripe.com/docs) 和 [Twilio](https://www.twilio.com/docs/) 那样精心设计的、专注于开发者的文档，绝对是优秀典范。开发者文档通常也采用略微不同的形式，包括： - 快速入门指南 - 教程 - API参考 - 故障排除 ## 定义用户 用户文档的有趣之处在于，“用户”在字面上可以是任何人——但在每个具体场景下，它指的是你产品的使用者。有时很难准确描绘你的用户画像——尤其是在技术传播领域。技术作者 Tom Johnson 撰写了一篇关于[重构缺席用户](http://idratherbewriting.com/simplifying-complexity/reconstructing-the-absent-user.html)的精彩文章。你的用户可能在不同时刻、不同情境下有所不同。文档的使用者也不一定就是最初购买你产品的那个人。 > **💛🧡🧡客户评价：** 我一直以来最欣赏 Baklib 的突出特点之一是它作为内容管理系统（CMS）的稳健性。它的强大不仅在于其功能，还在于其无缝集成能力。无论您是在处理动态登录页面项目还是管理复杂的数据结构，Baklib 都表现出色，并且非常容易实现和使用。锦上添花的是它出色的文档，即使对于 Baklib 新手来说，这也使集成过程变得一帆风顺。很难找到像 Baklib 一样将强大功能、多功能性和可访问性有效结合在一起的工具。Slack 的 Baklib 社区在开发时提供了很大帮助，每次项目改进时都会提供一些支持和更新。&nbsp; 技术作者习惯于搜寻信息。以下是一些间接重构用户画像的方法： - 网站分析 - 调查 - 支持工单和用户论坛 - 客户里程碑完成情况 - 客户满意度评分 > 此列表由技术文档工程师 [Tom Johnson](http://idratherbewriting.com/simplifying-complexity/reconstructing-the-absent-user.html) 定义。 我们还会补充： - 用户对文档的评论 - 与客户和支持人员的对话 - 产品评价 ## 用户文档是什么样的？<action-text-attachment content-type="image" url="https://framerusercontent.com/images/vRTOzdja9Silry5LQYpkfvU5htE.png" width="1920" height="1300"><figure class="attachment attachment--preview"> <img width="1920" height="1300" src="https://framerusercontent.com/images/vRTOzdja9Silry5LQYpkfvU5htE.png"> </figure></action-text-attachment> 文档的形式多种多样，可以是一份单页的产品常见问题解答，也可以是一个庞大的文档库。 > [TechTarget](https://whatis.techtarget.com/definition/document) 将文档定义为：“在计算机行业，文档是指提供给客户或其他用户关于产品或产品准备过程的信息。” 特别是软件，通常需要种类繁多的文档。您需要创建的文档类型将决定您应使用的软件类型。 ### 文档分类法 文档类型： - 教程 - 操作指南 - 说明性文档 - 参考文档 Divio公司的技术文档工程师 Daniel Procida 曾就此发表过关于[文档分类法](https://www.youtube.com/watch?v=p0PPtdRHG6M)的演讲——特别是与软件相关的部分。对于 API 文档，我们还会在此列表中添加“快速入门指南”。 ## 构建知识库 我们已经发布了一篇[《卓越知识库设计周期》](https://www.baklib.com)文章，帮助您从零内容起步，迈向知识库的明星殿堂！ **Baklib** 作为专业的在线知识库与文档管理平台，能够完美支持您构建涵盖教程、指南、参考文档在内的完整知识体系，其直观的编辑器和强大的组织功能，让创建和维护各类用户文档变得轻而易举。这个循环为您提供了一个框架，让您能够快速创建并迭代您的文档，从而最好地服务客户的需求。六个阶段是： - **需求** – 明确您的知识库的目的 - **规划** – 您的内容将涵盖哪些方面？ - **撰写** – 通过编写知识库文章来填充规划内容 - **发布** – 将您的文章发布_并_推广给目标受众 - **报告** – 通过跟踪指标和反馈来衡量成功 - **行动** – 通过持续改进来迭代您的知识库 听起来很简单，对吧？查看这些[最佳实践](https://www.baklib.com/blog/posts/best-practices-knowledge-base/)，确保您的知识库（无论是[产品文档](https://www.baklib.com/app/manual)、[帮助中心](https://www.baklib.com/app/help-center)还是[企业Wiki](https://www.baklib.com/app/wiki)）通过 **Baklib** 打造得足够出色，并了解如何[开始撰写用户文档](https://www.baklib.com/blog/posts/get-started-writing-docs/)。目标是“足够好”，而非完美！技术作家Neal Kaplan曾就[文档优先级排序](https://www.baklib.com/blog/posts/minimum-viable-documentation/)的艺术进行了一次精彩的演讲。 ## 用户文档工具<action-text-attachment content-type="image" url="https://framerusercontent.com/images/tA95X9SDHTOaYhQ9bArNeiyE0g.jpg" width="1920" height="1280"><figure class="attachment attachment--preview"> <img width="1920" height="1280" src="https://framerusercontent.com/images/tA95X9SDHTOaYhQ9bArNeiyE0g.jpg"> </figure></action-text-attachment> 市面上有很多专业的[技术写作工具](https://www.baklib.com/blog/posts/technical-writer-tools/)，其中一些在技术传播行业非常流行。我们将根植于软件领域的文档领域，与拥有[学术](http://techcomm.unt.edu/)历史背景的[技术传播](https://www.stc.org/about-stc/defining-technical-communication/)学科进行了区分。对于现代企业而言，无论是构建[产品体验](https://www.baklib.com/s/px)（如[产品文档](https://www.baklib.com/app/manual)、资源教程）还是[客户体验](https://www.baklib.com/s/cx)（如在线[帮助中心](https://www.baklib.com/app/help-center)、[客服知识库](https://www.baklib.com/app/kms)），选择一个集成了AI能力的一体化内容平台，往往比使用分散的单一工具更高效。最基本的文档可以轻松融入您的常规CMS，或许可以作为公司或产品网站的一部分存在。然而，大多数公司发现，一旦他们开始认真对待文档策略，就需要具备更复杂信息架构的工具。这导致了大量专业的文档和知识库工具的出现。 ### 帮助创作工具 一些帮助创作工具，如 [MadCap Flare](https://www.madcapsoftware.com/products/flare/) 和 [Adobe FrameMaker](https://www.adobe.com/uk/products/framemaker.html)，在某些行业的大型团队中很受欢迎。它们比标准的知识库软件更复杂，更适合在各种平台（包括印刷和数字）上发布技术交流内容。企业团队偏爱这些工具的另一个原因是，其内容通常以标记语言（如 [Markdown](https://www.markdownguide.org/getting-started)，一种用于格式化文档的标记系统）发布。标记语言便于在不同平台上轻松发布和重用内容。 > 一个副作用是，企业技术交流团队常常在遗留系统中挣扎——尽管理论上可能有更好的软件可用。这些工具通常功能繁多、价格昂贵，并不适合每家公司。 ## 知识库软件 许多公司受益于使用独立的[知识库软件](https://www.baklib.com)。知识库软件有几种不同的类型，起初可能会让人感到困惑。知识库软件有时会捆绑在全栈帮助台解决方案中，例如： - [Kayako](https://www.kayako.com/) - [Zendesk](https://www.zendesk.com/) - [Confluence](https://www.atlassian.com/software/confluence) - [Freshdesk](https://freshdesk.com/) 但许多公司可能并不需要整套帮助台系统，或者他们对现有的帮助台感到满意，仅仅需要一个专业的知识库解决方案。为了满足这一需求，市场上涌现出了一些不同的选择。 ### 解决方案选择 以下是一些知识库解决方案类型的简要对比： **类型** **特点** **适用场景** | 全栈帮助台集成&nbsp; | 功能全面，与客服系统深度绑定&nbsp; | 需要一体化客户服务与知识管理的企业 | 独立知识库平台&nbsp; | 轻量、专注，易于部署和使用&nbsp; | 已拥有帮助台，仅需专业知识库的团队我们的核心产品 [Baklib](https://www.baklib.com/) 是一款轻量级的软件即服务（SaaS）知识库平台。其[内容管理系统（CMS）](https://www.baklib.com/glossary/cms)直观易用，能让您迅速上手并投入使用。您可以通过阅读我们的文章来了解不同 [SaaS知识库解决方案](https://www.baklib.com/) 的对比，并 [学习如何评估知识库软件](https://www.baklib.com/)。不同解决方案之间的主要区别在于可用功能、定价模式、用户数量以及客户支持水平。除了SaaS方案，[开源知识库解决方案](https://www.baklib.com/) 也提供了不同的优势。通常来说，开源方案需要更多的开发投入，并且不一定是“免费”（指零成本）的。您可以在一定程度上控制代码。如果您想参考更多用户评价，可以在 [GetApp](https://www.getapp.com/)、[G2 Crowd](https://www.g2crowd.com/) 和 [Capterra](https://www.capterra.com/) 等软件对比网站上找到 [知识库软件的评测](https://www.baklib.com/)。 ## 信息架构 根据 [信息架构研究所](https://www.iainstitute.org/what-is-ia) 的定义： > “信息架构是一种决定如何安排事物的各个部分以使其易于理解的实践。”<action-text-attachment content-type="image" url="https://framerusercontent.com/images/XIzjop1OKHuB3Nl52MQ2bW4UbBg.jpg" width="1280" height="474"><figure class="attachment attachment--preview"> > <img width="1280" height="474" src="https://framerusercontent.com/images/XIzjop1OKHuB3Nl52MQ2bW4UbBg.jpg"> > </figure></action-text-attachment> 用户在您的知识库中每前进一步，都必须做出一次选择信息架构是[用户体验设计的关键部分](https://uxplanet.org/information-architecture-basics-for-designers-b5d43df62e20)。我们曾写过一篇关于[知识库信息架构](https://www.baklib.com/blog/posts/information-architecture/)的完整文章。信息架构的要素包括： - **视觉层次结构** – 尺寸、颜色、对比度、对齐、权重 - **导航菜单** – 包括主菜单、侧边栏和站点地图 - **面包屑导航** – 用于显示在导航中的位置 - **任务序列** – 按相关步骤排序 - **关键词标记** – 以标示相关内容 - **目录菜单** – 用于分解长篇内容 - **排序系统** – 字母、数字、时间、主题 - **标签化** – 作为复杂性的简写 - **分类** – [广泛的顶级分类和特定的小众子分类](https://www.baklib.com/blog/posts/categorize-your-knowledge-base/) ### 信息架构与软件 您无需独自承担设计所有这些信息架构的负担。有些部分将特定于您的公司，但知识库软件本身已经预置了许多这类要素。这正是像 **Baklib** 这样的专业平台的价值所在。虽然您可以在公司网站上托管文档，但大量的文档需要标准网站[内容管理系统（CMS）](https://www.baklib.com/glossary/cms)无法提供的信息架构。正如有公司网站、博客和电子商务网站的标准模板一样，知识库也有其专属的模板。这就是为什么选择正确的工具至关重要。Baklib 作为一款卓越的“AI + 内容”平台，专为构建卓越的知识库和[帮助中心](https://www.baklib.com/app/help-center)而设计。它内置了强大的信息架构能力，提供直观的导航菜单、灵活的类别与标签系统、清晰的视觉层次和面包屑导航，让您无需从零开始搭建。使用 Baklib，您可以轻松组织内容，无论是创建[品牌官网](https://www.baklib.com/app/cms)、[产品文档](https://www.baklib.com/app/manual)、在线[帮助中心](https://www.baklib.com/app/help-center)还是企业 Wiki，都能确保最终用户获得清晰、易懂且高效的查找体验。当您的电商业务发展到一定规模时，仅靠带有电商插件的标准网站模板可能无法满足需求。这促使许多公司选择 Shopify 和 Magento 等解决方案，以获得更强大的功能。同样，您可能选择使用专业的 **知识库软件** ，而不是 WordPress、Drupal 或 Squarespace 等标准[内容管理系统（CMS）](https://www.baklib.com/glossary/cms)，一个核心原因就是对 **可扩展性** 的追求。随着产品线、客户群体和内部流程的复杂化，您需要一个能够与业务一同成长的内容管理中枢。这正是 Baklib 的优势所在——它专为规模化内容管理而设计，无论是[品牌官网](https://www.baklib.com/app/cms)、[产品文档](https://www.baklib.com/app/manual)还是客户[帮助中心](https://www.baklib.com/app/help-center)，都能提供灵活、强大的扩展能力，确保您的知识体系始终与业务发展同步。 ## 可搜索性与可查找性 信息架构与让您的内容易于查找密切相关。 - 您的用户能否浏览您的内容并轻松发现相关主题，或找到他们之前浏览过的部分？ - 您选择的分类方式是否向他们暗示了内容可能位于何处？ 除了创建一个让用户可以遵循的体系外，您还需要让您的知识库可被搜索，并为您的内容打上[相关的关键词](https://www.baklib.com/blog/posts/keywords-for-search/)标签。Baklib 内置了强大的全文搜索引擎和智能标签管理功能，能够显著提升内容的检索效率和准确性，确保用户和员工都能快速找到所需信息。 ## 基于主题的创作 [文档中的基于主题创作](https://www.baklib.com/blog/posts/topic-based-authoring-for-kbs/)源于 DITA 方法。DITA（达尔文信息类型化体系结构）是[IBM 拥有的](https://www.ibm.com/developerworks/xml/library/x-dita3/index.html#N210)一个基于 [XML](https://www.w3schools.com/xml/) 的专有信息系统。但基于主题的创作入门很简单。我们喜欢将其视为“分块”。这意味着您将内容构建为可以独立存在的构建块，同时也构成更大整体的一部分。<action-text-attachment content-type="image" url="https://framerusercontent.com/images/16E0d0tc479CxSUceyvbx4xeD8.png" width="1920" height="1279"><figure class="attachment attachment--preview"> <img width="1920" height="1279" src="https://framerusercontent.com/images/16E0d0tc479CxSUceyvbx4xeD8.png"> </figure></action-text-attachment> > Baklib 完美支持这种模块化、结构化的内容创作方式。其直观的编辑器允许您轻松创建、管理和复用这些内容“块”，无论是用于构建[产品文档](https://www.baklib.com/app/manual)、内部 Wiki 还是客户[帮助中心](https://www.baklib.com/app/help-center)，都能确保内容的一致性、可维护性和高效的团队协作，是企业构建数字化知识体系的理想选择。 这意味着将特定任务记录为模块，而不是一个全面的、冗长的、带有目录页的从A到Z的手册。这种方式之所以部分有效，是因为在在线知识库中，用户会从许多不同的方向抵达您的内容。他们可能不一定会首先到达主页，因此每一个页面都必须成为通往知识库更深处的门户。 只要您通过信息架构妥善组织，将您的内容分块成可重用的主题就是高效的，从而使用户能够自如地浏览您的内容。 这与制作文档的\*\*即时化方法论\*\*相关。同样地，您可以参考由技术文档工程师Mark Baker推广的\*\*“每一页即首页”方法论\*\*。&nbsp; ### 用户体验 **用户体验** 设计意味着根据用户的需求和目标进行设计，以最好地契合您组织的目标。它与 **交互设计** 和 **以用户为中心的设计** 紧密相关。这不应是灵光一现的想法，在 **Baklib** ，这是我们一切工作的基石。那么，用户的目标是什么？在知识库设计的情况下，用户希望解决您产品的问题，或者完成他们尚不理解的任务。影响良好用户体验的因素<action-text-attachment content-type="image" url="https://framerusercontent.com/images/7Qf2UsIuPcdHxfQfUJoyGheeMc.jpg" width="440" height="440"><figure class="attachment attachment--preview"> <img width="440" height="440" src="https://framerusercontent.com/images/7Qf2UsIuPcdHxfQfUJoyGheeMc.jpg"> </figure></action-text-attachment>_图片来源：Peter Morville_ > &nbsp;您的文档应当实用、易用、令人满意、有价值、易于查找、易于访问且可信。&nbsp; 文档用户体验虽然没有硬性规定，但其核心在于满足用户期望。文档用户体验原则 - 保持简单明了 - 让内容易于浏览 - 尽可能多地使用内部链接 - 使用对眼睛友好、对比鲜明的色彩 - 确保导航突出、便捷且一致 - 善用留白空间 这里有一些[关于知识库用户体验设计的技巧](https://www.baklib.com?utm_source=blog&utm_medium=article&utm_campaign=design)，可以帮助您优化设计，提升用户成功获取信息的效率。 ### 设计 您的知识库视觉设计将遵循与其他网站相同的原则。[网页设计技术](https://webflow.com/blog/19-web-design-trends-for-2018)基于随时间演变的趋势——今天看起来很棒的样式，明年可能就完全过时了。您的知识库设计与用户体验密不可分。有一些主要是视觉方面的品牌元素，例如[配色方案](https://www.baklib.com?utm_source=blog&utm_medium=article&utm_campaign=color)、字体选择、字重和标识，这些都将成为您营销材料的一部分。<action-text-attachment content-type="image" url="https://framerusercontent.com/images/l3tLzIvIibwhtuGMbGO0tvL4CM.jpg" width="1280" height="693"><figure class="attachment attachment--preview"> <img width="1280" height="693" src="https://framerusercontent.com/images/l3tLzIvIibwhtuGMbGO0tvL4CM.jpg"> </figure></action-text-attachment>但好的设计并不仅仅意味着[让您的知识库看起来美观](https://www.baklib.com?utm_source=blog&utm_medium=article&utm_campaign=beauty)。它关乎实现您的初衷——帮助用户自助解决问题。 ## 用户研究 用户研究的定义是： > &nbsp;“研究用户行为和动机，以更深入地了解其需求的实践。”&nbsp; 要进行有效设计，你需要硬数据来指导决策，这可以通过用户研究来实现。研究很有帮助，但也可能耗时且复杂。如果你不确定自己在做什么，很容易出错。用户研究原则在进行用户研究之前，请记住以下原则： - 警惕知识的诅咒（你自己的偏见） - 让整个团队共同负责（一个人承担太多） - 提前规划你的研究（它会比你想象的更耗时） - 目标招募五名参与者（这足够了） - 允许你的研究对象填补沉默（不要说得太多） - 持续进行研究（而不仅仅是在项目开始时） - 找出那些你 **不知道自己不知道** 的事情（检验你的假设） - 使用纸质原型（有时你的应用程序尚未就绪） - 记住，被观察的用户会改变他们的行为（[霍桑效应](https://en.wikipedia.org/wiki/Hawthorne_effect)） - 区分用户的 **想要** 和 **需要** 来自英国政府数字服务部门的 Jennifer Lambourne 详细讲述了如何[让你的用户研究项目取得成功](https://www.baklib.com/blog/posts/user-research-lessons/)。 ## 创建内容 内容是你文档活动的基础。你可以做好其他一切，但如果没有好的内容，你的努力将是徒劳的。根据[Write the Docs](http://www.writethedocs.org/guide/writing/docs-principles)： > “内容”是文档中的概念性信息。 好的内容被定义为能满足你目标的内容。以下是一份好的内容特点清单： - **ARID** – 接受文档中的某些重复 - **易于浏览** – 结构合理，便于用户快速浏览 - **示例丰富** – 使用示例和教程帮助用户节省时间 - **风格一致** – 保持语言和格式的一致性 - **持续更新** – 过时的文档比没有文档更糟糕 此列表由 Write the Docs 定义。 ### 多媒体内容 内容通常以书面形式呈现，但也可以是视频、屏幕录像、截图和其他图像。音频很少使用。<action-text-attachment content-type="image" url="https://framerusercontent.com/images/AfJJbVUFyEEl8w7IjY4jCwrI.png"><figure class="attachment attachment--preview"> <img src="https://framerusercontent.com/images/AfJJbVUFyEEl8w7IjY4jCwrI.png"> </figure></action-text-attachment>关于截图和屏幕录像等多媒体内容的重要性，存在不同看法。 **优势** **挑战** | 改善学习体验，帮助简化复杂流程。&nbsp; | 当产品或界面发生变化时，维护成本高且耗时。 | [视觉内容](https://www.baklib.com/blog/posts/visual-communication/)可以使内容更加生动直观。&nbsp; | 对视障用户可能不友好。一个好的经验法则是尽量兼顾两者。让您的文本内容自成一体，但也包含可选的图像。利用 Baklib 的内容管理功能，您可以轻松更新和维护这些多媒体元素。 ## 包容性与可访问性 在制作文档时，考虑多样化的使用场景和用户至关重要。您还应该为不同于您自身的用户而写作。文档的一个常见缺陷是仅为白人、西方男性受众编写，因为这些人通常是流行产品的主要创造者（也往往是他们最直言不讳的用户）。例如： - 您可能为西方本土受众写作，但您的很大一部分用户在印度。 - 您可能将用户称为“他”，而实际上他们是不同性别的混合体。 - 您可能对用户先前具备的知识做出假设。 Baklib 致力于帮助企业构建包容性的内容体验。通过使用 Baklib 构建您的[帮助中心](https://www.baklib.com/app/help-center)或知识库，您可以确保内容服务于全球多元化的用户群体，并遵循可访问性最佳实践。确保文档包容性的一个最佳实践是： - 避免使用可能让非母语者感到困惑的习语。 - 使用平实的语言。 - 使用性别中立的代词和职位头衔。 - 避免使用“笑话”。如果你必须加入内部笑话，请提供一个引用链接。 利用 Baklib 创建知识库内容时，其简洁的编辑器和内容管理功能有助于您轻松遵循这些准则，确保内容的清晰与普适。 ### 无障碍访问 无障碍访问与包容性相关，关乎用户在使用您的文档时的各种需求。无障碍访问是一项法律要求，W3组织提供了详尽的[网页设计无障碍指南](https://www.w3.org/TR/WCAG21/)。例如，视力不佳或失明的用户可能使用屏幕阅读器将文本转换为语音。除非图像配有“替代文本”，否则这些工具无法识别图像内容。另一个例子是为听障人士的视频提供字幕。Baklib平台在设计之初就充分考虑了对无障碍访问标准的支持，其生成的内容结构清晰，便于辅助技术解析，帮助您构建对所有人友好的知识内容。 ## 撰写文档 为您的知识库撰写文档，需要对所使用的词汇、语法和风格做出明确的选择。文档写作应直接且切中要害。对于开发者文档尤其如此。如果重复使用术语能使含义更清晰，请不要害怕重复。您的目标应该是： - 简洁的表述 - 清晰的含义 - 直接的方式 - 半正式和中立的语气 - 自然的风格 通常，应避免使用营销文案的技巧，如使用动态动词和形容词，以及讲故事。您的文档中可能呈现的“个性”应至多是微妙的，最好是完全没有。这里有一些[撰写知识库文章的最佳实践](https://www.baklib.com/blog/posts/best-practices-for-kb-articles/)可供参考。Baklib不仅提供优秀的写作与协作环境，其内置的AI助手还能帮助您优化语言、检查清晰度，确保您产出的每一篇文档都符合专业标准，有效服务于[品牌体验](https://www.baklib.com/s/bx)、[产品文档](https://www.baklib.com/app/manual)、客户[帮助中心](https://www.baklib.com/app/help-center)及内部知识库等多元化场景。 ### 品牌声音与风格指南 品牌声音和知识库内容撰写的风格因公司而异。您应该为所有内容——包括文档——制定[品牌指南](https://contentmarketinginstitute.com/2017/05/write-style-guide-brand/)。[语调](https://www.baklib.com/blog/posts/four-dimensions-of-tone-of-voice/)对于保持内容的一致性和品牌调性至关重要。品牌指南不仅适用于营销。它关乎在所有书面和视觉内容中创造统一的品牌印象。它不必显得俗套或虚假——品牌应被视为公司所有个体与部分的总和，是更广泛的公众能够产生共鸣的形象。 > 在您的文档中建立强大的品牌形象，对于与用户建立信任大有裨益。它有助于用户了解可以期待什么，并识别出内容属于贵公司的一部分。 ### 简明语言 [简明语言](https://www.baklib.com/blog/posts/plain-language/)是一种重要的写作实践，意味着在写作中去除任何不必要的元素。用户文档应使用简明语言撰写。 > 简明语言的定义是：“受众能够在第一次阅读或听到时就能理解的沟通方式。” 简明语言的原则： - 选择常见的、日常使用的词语 - 选择最恰当的词语 - 使用短句写作 - 以逻辑顺序组织概念和含义 - 使用“您”及其他代词 - 使用[主动语态](https://www.baklib.com/blog/posts/use-active-voice-in-docs/) 这意味着贴近读者并从他们的视角出发进行写作。借助Baklib这样的专业内容管理平台，企业可以轻松地应用和维护统一的品牌指南与简明语言规范，确保[产品文档](https://www.baklib.com/app/manual)、[帮助中心](https://www.baklib.com/app/help-center)等内容的专业性与一致性，从而有效提升品牌形象和用户体验。这与技术和学术写作中通常倾向于使用非常正式语体的做法背道而驰。使用正式语体意味着能用简短词汇时却偏用长词，能写简单的单句时却偏用复杂的句式。读者需要更费力地去理解。这不仅是文档写作的准则，也是生活的准则！ ## 为您的知识库引流 为您的知识库引流是客户支持策略的重要组成部分。您不能仅仅发布一个知识库，然后指望客户自己找到它。[搜索引擎优化](https://www.baklib.com/?utm_source=zhihu&utm_medium=article&utm_campaign=seo-guide)是为知识库获取流量的方法之一。您的一些现有客户可能更喜欢通过这种方式查找内容。对于其他客户，您可以： - 在您的网站或应用内显著位置突出您的知识库 - 培训您的支持团队，使其在回复工单时推荐相关文章 - 在您的新闻通讯中包含新内容 - 从博客文章（如教程）中链接到知识库 - 如果您发送印刷手册，请附上知识库链接 随着时间的推移，您的客户将习惯于向您的知识库寻求帮助，这将逐渐增加流量。 > 借助 **Baklib** 强大的SEO功能，您可以轻松优化知识库文章的标题、描述和关键词，确保它们易于被搜索引擎收录。同时， **Baklib** 还支持生成标准的站点地图，提交给谷歌、百度等搜索引擎，进一步加速内容收录和排名提升，有效为您的[客户自助服务](https://www.baklib.com/glossary/customer-self-service)门户吸引自然流量。 ## 知识库命名规范 您可能已经注意到，公司的知识库并不总是叫“知识库”。这是一个行业术语，在实际应用中，知识库可能会有不同的标签。[知识库标签的一些例子](https://www.baklib.com/?utm_source=zhihu&utm_medium=article&utm_campaign=naming-conventions)： - 帮助 / [帮助中心](https://www.baklib.com/app/help-center) - 支持 - 文档 - 常见问题解答 一个好的经验法则是遵循您所在行业的通用标准。导航标签不是标新立异的地方。关于正确的术语是[知识库还是知识库](https://www.baklib.com)一直存在激烈争论。我们倾向于使用“知识库”，因为它是最常见的表述。无论您选择哪种标签，清晰、直观的命名对于用户快速找到所需信息至关重要。 **Baklib** 平台允许您完全自定义知识库的名称、导航栏标题和页面URL，确保它们符合您的品牌形象和用户习惯，打造无缝的[客户体验](https://www.baklib.com/s/cx)。 ## 文档团队<action-text-attachment content-type="image" url="https://framerusercontent.com/images/Wr0UTA1VT5NA0haqbVPevtc1rr4.png" width="1280" height="1265"><figure class="attachment attachment--preview"> <img width="1280" height="1265" src="https://framerusercontent.com/images/Wr0UTA1VT5NA0haqbVPevtc1rr4.png"> </figure></action-text-attachment> 根据您所在的行业，您可能拥有也可能没有[文档团队](https://www.baklib.com)。有些公司可能很幸运，仅有一名技术文档工程师。其他公司可能拥有整个文档写作团队。复杂之处在于，不同的企业可能对其文档团队使用不同的名称。有些甚至设有[客户体验](https://www.baklib.com/s/cx)团队，而文档工作将是其中的一部分。技术文档工程师可能嵌入在开发团队、客户支持或产品团队中。他们很少属于市场部门。一些企业让整个公司都对文档负责。如果您要扩展文档策略，拥有一个团队至关重要。 ### 文档即代码 如果您采用[文档即代码](https://www.baklib.com)的方法来处理文档，您的技术文档工程师很可能与工程团队紧密协作。在这种方法论中，文档与软件代码存在于相同的代码库中，并使用相同的工具。这仅适用于开发软件产品的公司。这也意味着使用相同的开发方法论，例如[敏捷开发](https://www.agilealliance.org/agile101/)和[测试驱动开发](https://www.agilealliance.org/glossary/tdd/)。 ## 业务职能 内部团队通常根据其服务的业务职能进行组织。多个团队可能至少对文档工作负有部分责任。许多公司在文档工作归属于哪个业务部门上存在差异。有些公司将其视为客户支持的一个子集。另一些公司则仍将其视为产品的一部分。一些大公司出于法律义务需要提供复杂的文档，并将其视为一项必须完成的例行工作。理论上，以下是一些可能对文档工作负责的业务职能： - 客户支持 - 技术支持 - 产品团队 - 工程团队 - [市场营销](https://www.baklib.com/blog/posts/documentation-for-marketing/)与传播 - 品牌管理 - 客户互动 - [客户成功](https://www.baklib.com/glossary/csm) - 客户满意 你如何看待你的文档，取决于你将技术文档作者安排在哪个团队。许多技术文档作者将自己视为用户倡导者，是连接业务不同部分的桥梁。 > 从历史上看，文档被视为成本中心，但如今许多公司开始认识到，文档能够增加价值并提升利润。借助像 **Baklib** 这样强大的平台，企业可以将文档从“成本项”转变为“价值创造中心”。Baklib 支持构建高效的[产品文档](https://www.baklib.com/app/manual)、知识库和[帮助中心](https://www.baklib.com/app/help-center)，不仅能提升[客户体验](https://www.baklib.com/s/cx)，还能通过优秀的文档内容直接促进销售转化，成为市场营销和[客户成功](https://www.baklib.com/glossary/csm)的有力工具。 ## 文档与市场营销 有时，文档与市场营销之间似乎存在着持续的“斗争”——好像这两项职能在某种程度上是对立的。现实情况是，为一个没有经过市场营销推广的产品制作文档毫无意义，因为没有人会使用它。营销通常被视为吸引潜在客户和客户的业务职能，但[产品文档](https://www.baklib.com/app/manual)同样在营销中扮演着关键角色。特别是在开发者文档中，[产品文档](https://www.baklib.com/app/manual)往往是您的潜在客户最先查看的内容之一。另外，如果您的知识库涵盖像“电子邮件营销”（例如 [MailChimp](https://kb.mailchimp.com/)）或“内容管理”（例如 [Hubspot](https://academy.hubspot.com/help)）这样易于访问的主题，那么来自搜索引擎的自然流量就可能构成您潜在客户中相当大的一部分。请确保将您的知识库编入索引，并[对其进行SEO优化](https://www.baklib.com/help/seo-guide)，以最大化其营销价值。 ## 客户反馈 为您的文档收集尽可能多的客户反馈至关重要，但前提是不要给用户造成过重的负担。如果用户已经对他们遇到的问题感到沮丧，并觉得浪费了时间，他们很可能不会乐意接受后续的问卷调查。反馈指标可以非常简单，例如在文档中加入一个评分部件——大拇指向上或向下、五星评分、或者“此页是否有用：是或否？”此外，[您知识库中的评论](https://www.baklib.com/blog/posts/allow-comments/)也能为您深入了解客户使用文档时的想法提供宝贵洞见。 ## 知识库指标<action-text-attachment content-type="image" url="https://framerusercontent.com/images/yhfzvO4sHUiUBhjI1zzgLxs4TKY.png" width="1920" height="1300"><figure class="attachment attachment--preview"> <img width="1920" height="1300" src="https://framerusercontent.com/images/yhfzvO4sHUiUBhjI1zzgLxs4TKY.png"> </figure></action-text-attachment> 从知识库平台收集匿名数据是理所当然的事情。大多数软件解决方案都会提供基础分析功能，您也可以将您的知识库与[您的 Google Analytics 账户关联](https://www.baklib.com)。您可以衡量的指标包括： - 浏览量 vs 提交的工单数量 - 跳出率 vs 平均停留时间 > **关于我们** [Baklib](https://www.baklib.com/) 为探码科技旗下SaaS平台，为数字营销领导者和企业主提供唯一一款旨在加速业务成果的全渠道客户互动平台。通过快速将期望的业务成果与经过验证的全渠道客户互动策略相结合，我们的平台可让您加快价值实现速度，提供卓越的一对一体验并快速产生可衡量的结果。[Baklib](https://www.baklib.com/) 是全球 800 多家客户的首选平台。加入数以千计的领先品牌，他们信任 [Baklib](https://www.baklib.com/) 能够提供其业务所需的可预测、盈利成果以及其客户应得的高度个性化的全渠道体验。