直播回顾 | RWS 直播分享会：独家揭秘大厂都在用的文档核心技能

直播回顾 | RWS 直播分享会：独家揭秘大厂都在用的文档核心技能

产品经理作为第一批感知“春江水暖”的岗位，对市场的变化和需求尤为敏感。

随着市场的规范和成熟，B端产品需求不断上升，竞争变得日益激烈。特别是在企业大规模进军建立全球业务时，产品经理的基本功——产品文档的重要性不断增加。

面对这样的变化，以往的经验不再百试百灵，B端产品技术文档的核心发生改变。不少产品经理反馈他们在工作中经常会遇到以下问题：

1. 什么样的产品文档才是用户更感兴趣的，更容易理解的？
2. 产品文档怎样写才能提高我们的业务效率？
3. B端产品技术文档在撰写时，如何进行内容思维的升级？
4. 面向海外市场，如何构建一个多语言文档系统？

为了帮助更多产品人系统构建B端产品文档思维，切实地提高产品文档质量，人人都是产品经理联合 RWS 举办了2023年特别企划活动。

4月19日，本场活动我们邀请到了字节跳动文档工程师@杨鹤 、RWS 语言服务和技术事业部中国区首席咨询顾问@呼延韶文 2 位嘉宾，从用户、产品文档、模型及固件等方面与大家讨论怎样升级文档技能，以实现产品价值提升。

01 产品文档的结构化设计

杨鹤：字节跳动文档工程师。负责火山引擎toB的产品文档，飞书开放平台和PICO开发者文档的建设。在软件产品文档开发、文档质量管控和信息架构搭建领域拥有丰富经验。

分享伊始，杨鹤老师先是再次强调了产品文档的重要性，它贯穿于整个用户旅程，也在各个产品中随处可见。如果产品文档写得不够准确，会给用户带来不好的使用感受，进而影响业务。

那么如何写好产品文档呢？杨鹤老师认为我们要具备结构化思维。

主流的结构化写法分为三种：Information Mapping、Topic-Based Writing、Every Page is Page One。这三种写法各有利弊，目前使用最为广泛的是后两种。

杨鹤老师对这三种结构化写法一一展开介绍，并用案例辅助理解它们是如何应用在实际的文档写作中的。

接着，她提出一个内容编写的方法：金字塔原理结论先行，突出重点。即确定核心信息、创建主要观点、组织主要观点、添加支持细节、清晰的标题和子标题。

这个金字塔原理要怎样应用在文档中呢？不如去直播中一探究竟吧：https://996.pm/YyXPx

02 激活产品文档的业务价值

呼延韶文：RWS 语言服务和技术事业部中国区首席咨询顾问。专注企业内容管理领域近20年，曾就职于BM、EMC、OpenText等公司的企业内容管理部门。为华为、小米等国内领先企业提供内容管理战略咨询。

产品文档作为产品经理和用户沟通的媒介，在如今数字化的环境下，它在创作、管理、交付上都出现了很多问题，例如：

1. 没有统一的协同创作界面和工具
2. 内容之间的联系错综复杂，管理难度大
3. 缺乏数字化交付能力，内容多以静态文档包形式交付
4. 很难做到个性化的内容交付

在企业出海过程中，一个产品往往存在多个型号、多个版本、多个语种、多个动态交付，几何乘积效应增加了内容管理和交付的复杂度。

面对这样的挑战，结构化的写作和管理方式是解决问题的关键。

通过结构化的管理方式，可以提高内容的质量，实现内容重用，提升用户体验等。并且，给企业带来明显的业务价值：提升产品销量，提高客户满意度，提升品牌忠诚度。

并且，通过结构化创作和动态发布可以满足当下和未来的用户需求。

用户希望以自己喜欢的方式，在需要的时候获取最相关的内容。而产品经理需要做的是，以解决用户需求为出发点的内容数字化动态发布。

还有更多的内容因为篇幅有限不全部展开啦，感兴趣的同学戳链接进行观看：https://996.pm/YyXPx

03 圆桌互动问答

两位老师的分享结束，在场的听众纷纷提出自己的疑问，希望得到老师们的解答。一起来看看有哪些精彩的对话吧。

Q1：产品经理在写文档的时候需要注意什么？容易陷入什么误区？

1）产品经理的文档通常会从产品功能的角度出发，而忽略了用户场景。

例如，有一个产品功能是让用户联网，但文档却描述了创建网络网关等术语，对于没有网络背景知识的用户来说这是不容易理解的。

2）使用过多的术语，或是对概念进行了过度的包装，使用户很难联系起来。

比如，通讯录、组织机构、成员等概念在文档中可能会难以理解。

3）文档信息的缺失。

由于产品经理已经非常熟悉我们的产品，可能会忽略一些用户可能不知道的背景信息，同时缺少关注点提示，直接引导用户到达某一个操作步骤。

Q2：出海产品在文档的写作方式和工具选择上需要注意什么？

很巧合的是，我前两天出差访问了一家主要做海外市场的企业。因为客户群主要在海外，所以他们在产品文档撰写、翻译和多语言发布方面积累了很多经验，同时也经历了不少痛苦。

建议产品经理和文档专家在规划自己的产品和文档时，即使短期内产品还不具备出海条件，但只要不排除未来会拓展海外市场的可能性，就可以在整个产品和文档规划中，提前进行规划，看看是否适合采用结构化的创作方式。

该客户在进行内容出海的多语种转换时用到了XML的创作方式，对内容进行标记。此外，数据库、翻译记忆库、翻译流程自动化、不同翻译资源对接等因素，也是在构建内容创作平台方面非常有益的考虑因素。

因此，建议产品经理和文档专家们从这些方面进行布局和考虑。

Q3：现在为了追求更高效、长寿命地使用产品，越来越多的技术文档贯彻了极简主义，但是经常本末倒置，用户没办法阅读。怎样看待这一现象？

若用户不能有效阅读，这可能是因为内容出现了过度的极简主义，即不是说越少内容越好，而是要去除多余信息，将关键点凸显。在贯彻实践极简主义时，需要在完整性和内容间达到平衡。

例如，可以删去不必要的修饰语和重复表达，避免使用过于专业难懂的术语，可以使用通用词汇，使示例清晰化并注重图表的表达。

强调的应该是在表达上的精炼，而不是减少内容量，避免删除必要的信息，因为那会使用户难以理解。

Q4：有没有好用的工具或者小技巧，可以提升产品文档的写作效率？

我非常赞同使用专业工具来做专业的事。不过，随着时代不断变迁，无论是工具、平台还是方法论都需要不断发展。

例如，10年前我们日常需要印刷版文档的输出，此时InDesign是最专业的工具。然而现在，随着数字化出版的大量应用，InDesign有可能限制输出效率。因此，这些不同工具都是相对的。

在数字出版的时代，我认为杨鹤老师所提到的结构化创作方式能更高效、符合产品内容创作的要求。

这个结构化的创作方式主要有两种，其中一种非常流行。拥有专业的结构化内容创作团队，对于此类应用场景，他们更需要专业且高效的XML编辑器等专业编辑器。

另一种场景是许多非文档专业人士参与产品内容的创作，让他们使用专业的XML创作工具往往不合适。针对这些人，需要一种简单易用但又具有结构化协同特点的编辑环境。

这两种场景通常在企业文档管理中同时存在，因此我们需要综合考虑这个问题。

还有更多有趣精彩的问答，可以在直播当中一睹为快：https://996.pm/YyXPx 。同时，对内容管理感兴趣的同学，也可以扫描下方二维码，关注RWS官方公众号，了解到更多行业资讯。