即將在 docs.microsoft.com 推出新的意見反應系統

這篇貼文由 docs.microsoft.com 小組的資深專案經理 Rob Eisenberg 撰寫。

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 上標記我們。