docs.microsoft.com 采用全新反馈系统

本文作者:Rob Eisenberg,docs.microsoft.com 团队高级项目经理

Microsoft 的使命是让全球每个人和每个组织取得更大的成就。 这是我们在开放的 GitHub 平台上构建 docs.microsoft.com 时的一个考虑因素。 今天,我们将移动到基于 GitHub 的新文档反馈系统,全面提升体验。

GitHub 上的内容反馈

虽然文档从一开始就位于 GitHub 上,但内容反馈机制一直在使用 Livefyre 对文章进行评论。 虽然 Livefyre 是一个很好的注释解决方案,但事实证明它不足以满足我们的特定需求,即跟踪、分配所有者并维护客户提出的内容问题的状态。

我们探索了很多方法来改进它,但指导我们很多工作的一个问题似乎重新出现了:如果我们的文档:“如果我们的文档被当作是开放源代码来对待,我们会用什么来解决这个问题呢?”问题的答案似乎很明显,那就是 GitHub 问题,所以我们开始尝试将 GitHub API 更深入地集成到我们的文档页中,以便能够在 GitHub 基础结构之上构建一个完整的反馈系统。

现在借助新系统,便可直接从内容页创建 GitHub 问题,由此以更丰富的方式与编写者和产品团队进行交互。 发现文档有问题? 错误的代码示例? 令人困惑的说明? 重要内容遗漏? 只需滚动到页面底部,选择“提供文档反馈”即可。

用户登录和留下反馈

可直接从文档页本身查看与文档相关的所有开启和关闭的问题 - 这样一来,若问题得到了修复和解决,便可始终保持知悉:

展示已开启和已关闭的问题

可向重要的问题添加注释,甚至添加回应

向 GitHub 问题添加回应

现在,Microsoft 员工可利用 GitHub 问题的所有功能来会审、响应、计划和修复报告的问题 - 并且此过程在透明状态下进行!

文档反馈示例

假设就文章中某断开的链接提交 GitHub 问题。 我们的团队将对问题进行会审、分配标签并指定所有者进行修复(或询问后续问题)。 当所有者提交修复问题的拉取请求时,你将收到通知(基于 GitHub 通知设置),告知问题已解决/关闭,从而创建良好的反馈循环。

此外,可利用所有标准的 GitHub 优点,例如评论中的 Markdown、个别问题或整个存储库的订阅、组织活动的 RSS 源,@ 提及、代理人等等! 我们相信更深层次的开源工具集成将为社区增长和协作创造新的机会。

产品反馈的分离

旧版系统的问题之一在于,一个流中混合了产品和文档反馈 - 未一致标记所有项时,会审和跟进非常困难。 我们创建一种明确的方法将两者分离,进一步解决此问题:

提交产品反馈

单击“提供产品反馈”,将直接进入与处理产品反馈特定文档页关联的产品团队的站点

推出

你可能想知道反馈系统何时生效。 我们已针对 Visual Studio IDEAzure CLI 文档试用了几个月。 从 2 月中旬开始,我们将开始在整个 docs.microsoft.com 上推出。

你的反馈

你的反馈对我们很重要,因此我们希望你能够迅速接触到这一新系统。 这是我们改进平台上的反馈与参与的下一步计划,但这绝不意味着改进的结束。 确保在 GitHub 上表达你对这些更改的看法,或在 Twitter 上标记我们。