本页面包含有关 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 社区不断发展和变化的需求。
如果用户前往所请求的文档的路径混乱或中断，他们就会搜索失败、对产品失去信任，甚至可能完全放弃购买。
有解决方案。以下是提高可检测性并支持用户路径访问所需文档的方法：
- 确定和设置类别标题的样式
- 评估类别标题，并确保它们能够正确处理主题（如有必要，提出更新建议）
- 查看文章并确保分类正确无误
- 为每篇报道定义子类别
- 确保没有搜索结果会将用户引导至支持论坛
- 请注意删除重复或已过时的主题
过去 17 年里，WordPress 社区已经取得了骄人的成绩，大家也分享了很多成就。每月创建近 7, 000 万个新帖子和 7, 700 万条新评论，旨在更新分类并确保用户转化历程准确无误，这有助于持续提升用户的增长、成功和忠诚度。
简介
作家约瑟夫·坎贝尔提出了“英雄之旅”这个词。在小说中，它指的是故事主角进入世界的世界、面对和克服挑战并最终实现回归的结构概念。
在技术文档领域，用户还开始了一段旅程：引导他们前往帮助主题，以学习、获得解答和排查问题。如果用户能够做到这一点，就说明其周围环境良好。如果用户无法找到答案，就会感到失望和沮丧。
但是，为什么会发生这种情况？这并不是因为作家捷径、不关心或无专业知识，通常情况下，技术文档工程师没有考虑用户体验历程。作者可能会全心投入创作优质内容，但并未考虑用户将如何访问主题。关注用户体验历程至关重要。我们必须考虑他们想要了解什么，以及如何实现这些目标。
我与 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 获得了 63.6% 的 CMS 市场份额。
鉴于如此程度的受欢迎程度，准确、易于理解的文档是赢得 WordPress 用户青睐的必要条件。
通过考虑用户体验历程和影响可能的用户路径的问题，WordPress 可以对帮助类别和标记进行现代化改造，从而有效地解答问题并排查问题。如此一来，WordPress 就可以在未来几年继续吸引满意的客户。