本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- WordPress
- 技术文档工程师：
- dmivelli
- 项目名称：
- 提高了 WordPress HelpHub 文档中文章的可检测性
- 项目时长：
- 标准时长（3 个月）
Project description
内容提要
WordPress 的受欢迎程度每分每秒都在增长。截至 2020 年 7 月初，WordPress 5.4（2020 年 3 月 21 日发布的最新版本）已下载近 5100 万次。最常用的语言是英语（71%），其次是西班牙语（4.7%）和印度尼西亚语（2.4%）。
优质的技术文档是所有帮助系统的基石。经验丰富的技术文案撰写者会将知识转化为面向用户的内容。用户此时希望执行一些对他们有价值的或需要的操作。优秀的技术文档撰写者深知，编写准确且内容详实的文档，以及站在用户角度思考问题，是必不可少的。不过，对技术文档编写者来说最重要的内容（例如编辑和制作质量）对用户来说可能不如及时性和可检测性重要。如果用户找不到精心编写的帮助主题，那又有什么用呢？
自 2003 年问世以来，WordPress 在开源领域的发展吸引了开发者、用户和贡献者。原始文章类别和标签需要更新和现代化，以跟上 WordPress 社区的发展和不断变化的需求。
如果用户查找所需文档的路径令人困惑或中断，他们会搜索失败，对产品失去信任，甚至可能完全放弃该产品。
我们有解决方案。您可以通过以下方式提高可检测性并支持指向预期文档的用户路径：
- 确定并设置类别标题的样式
- 评估类别标题，确保其准确反映主题（如有必要，建议更新）
- 查看文章，确保分类正确无误
- 为每篇报道定义子类别
- 确保没有搜索结果会引导用户前往支持论坛
- 注意要删除的重复或过期主题
WordPress 社区在过去 17 年中取得了令人瞩目的成就，并将继续分享这些成就。每个月创建近 7, 000 万条新帖子和 7, 700 万条新评论的用户都将持续提升分类水平、确保用户转化历程的准确性和忠诚度。
简介
“英雄之旅”是作家约瑟夫·坎贝尔 (Joseph Campbell) 提出的。在小说中，它指的是故事的主人公进入世界的历程，面对并克服各种挑战并带来改变的回归。
在技术文档领域，用户也会踏上一段旅程，前往帮助主题，以便学习、获取答案和排查问题。当用户能够完成此操作时，一切都会顺利进行。如果用户找不到答案，就会感到沮丧和失望。
但为什么会出现这种情况？这并不是因为创作者偷工减料、不关心或缺乏专业知识。这通常是因为技术文档编写者没有考虑用户体验历程。创作者可能会全身心投入到创作优质内容中，却忽略了用户将如何访问该主题。关注用户体验历程至关重要。我们必须考虑他们想要了解什么以及他们想要如何达成目标。
我与 WordPress 顾问和用户体验设计师 Estela Rueda 进行了交谈，她向我介绍了一些历史背景。目前，有些标题没有正确描述文章内容。类别用作标签，由于它们是在 15 年前创建的，因此有些类别已过时。代码植入不一致。这会给用户寻找答案带来障碍。
当前状态
WordPress 支持分为九个主要类别（使用入门、安装 WordPress、基本使用、基本管理、自定义、维护、安全、高级主题、问题排查）。每个类别都包含多个子类别或子主题，这些子类别或子主题会指向文章，每个着陆页上可能包含更多文章。
拥有热情协作的 WordPress 贡献者的好处在于，这里有很多主题可供选择。但是，由于声音和观点众多，标记和类别不一致。
这些主题需要进行现代化改造，以确保这些类别符合 WordPress 用户的当前需求。我们提供了 200 多篇文章，其中就标签和分类问题进行了介绍。
方案分析
主要目标是审核和重新分类文章，以提高搜索性。我建议您采取以下步骤：
与导师 Estela Rueda 合作，巩固流程
- 这是确保确认和达成一致的关键步骤
- 根据 Estela 的建议，我们将在电子表格中跟踪所有建议的更新（Estela 的经验表明，最好先收集信息，然后再提出建议）
确定并设置类别标题的样式
- 我建议为使用当前时态的类别采用统一、一致的结构，而不是采用动名词形式（安装与安装），因为动名词形式（-ing）可能会给作为第二语言 (ESL) 的英语用户带来困难，而 -ing 没有给用户带来任何价值
- 有些类别是单词和双字词主题（例如“维护”“安全”“基本管理”），有些类别是动名词短语（例如“WordPress 使用入门”“自定义”），因此有必要讨论如何使结构保持一致
- 我一直在研究其他组织如何设置在线帮助，并将与我的导师讨论这方面可能有用的信息
评估类别标题（并提出更新建议）
- 这些内容应从 WordPress 目标受众群体的角度来看清晰易懂，并符合他们的当前需求
- 确认其一致且符合 WordPress 样式指南标准
- 确保标题传达/说明意图
- 影视内容应明确说明任何必要的预先操作或用户/设备状态
查看文章/主题
- 这些主题是否准确满足 WordPress 目标受众群体的用户需求？
- 主题是否设定了正确的背景信息，还是某个主题的一部分？
- 步骤是否区分了任务中的各个参与者（用户、系统/设备，以及各自执行的操作）？
- 演员是否有明显的区别？
- 这些步骤是否将复杂流程分解为可操作的部分？
定义和标记子类别
- 参阅用户故事，并不断向电子表格中添加内容，以备日后参考
- 继续向子类别列表中添加内容，并详细说明其路径
确保没有任何搜索结果会将用户引导至支持论坛
记下要删除的重复或过时主题；这项取证工作有助于了解用户历程并简化其流程
时间轴
2020 年 8 月 16 日之前
- 继续查看 WordPress 文档
- 熟悉 WordPress 文档样式
- 研究有关客户转化历程的最佳实践，并将其归入帮助主题
8 月 17 日至 9 月 13 日
- 了解 Estela 和 WordPress 社区并与之合作
- 与 Estela 合作，优化项目步骤并提出完成里程碑的建议
- 创建包含里程碑和每周任务的时间表
- 与 Estela 安排沟通节奏（及时解决所有障碍）
9 月 14 日至 11 月 30 日
- 与 Estela/导师一起启动项目并开展开发工作
12 月 2 日至 5 日
- 提交最终工作成果报告
12 月 3 日至 10 日
- 提交项目成效评估和与 WordPress 导师和团队合作的体验评估
总结
WordPress 是最受欢迎的内容管理系统 (CMS)。根据 W3techs 的数据，37.7% 的网站都选择了 WordPress 作为 CMS，这使得 WordPress 在 CMS 市场占有率达到 63.6%。
要想赢得 WordPress 用户的心，就必须提供准确且简单易懂的文档。
通过考虑用户体验历程以及有助于了解可能用户路径的问题，WordPress 可以改进帮助类别和标记，从而有效解答问题和排查问题。这样，WordPress 将在未来几年继续吸引满意的客户。