docs.microsoft.com に今後予定されている新しいフィードバック システム

この記事は、docs.microsoft.com チームの上級プログラム管理者、Rob Eisenberg によって執筆されました。

Microsoft の使命は、世界中のすべてのユーザーとすべての組織がより多くのことを成し遂げられるように支援することです。 これが、GitHub のオープン プラットフォーム上に docs.microsoft.com を構築するうえでの考慮事項の 1 つとなりました。 現在、新しい GitHub ベースのドキュメント フィードバック システムへの移行によって、次のレベルへの押し上げを行っています。

GitHub でのコンテンツ フィードバック

Microsoft のドキュメントは最初から GitHub にありますが、記事へのコメントを行う場合、コンテンツ フィードバックのメカニズムで Livefyre を使用しています。 Livefyre は優れたコメント作成ソリューションですが、所有者の追跡、割り当て、顧客から上がったコンテンツの問題の状態の維持といった Microsoft 独自のニーズを満たすうえでは不十分であることがわかりました。

これを改善するためにいくつかの方法が模索されましたが、ここで 1 つの問題が浮上しました。Microsoft のドキュメントがオープン ソース コードと同じように処理された場合、この問題を解決するにはどうすればよいのでしょうか。この質問に対する回答は明らかと思われました。GitHub の課題です。そこで、ドキュメントに対する GitHub API の統合を試行錯誤した結果、GitHub インフラストラクチャの上に完全なフィードバック システムを構築できるようにしました。

この新しいシステムでは、コンテンツ ページから GitHub の Issues を直接作成できるため、ライターや製品チームとより細かくやり取りできるようになりました。 ドキュメントに問題がある、 コード サンプルが不適切である、 説明が紛らわしい、 重要な箇所が省略されている、などのご意見をお寄せ下さい。 ページの下部にスクロールして、[Give documentation feedback](ドキュメントに関するフィードバックを提供する) を選択してください。

ドキュメントのページから直接、ドキュメントに関連する未解決の問題もクローズ済みの問題もすべて見ることができます。これで、問題がいつ修正され、解決されたかを常に把握できます。

重要な問題に、コメントだけでなくリアクションを追加することもできます。

これで、Microsoft の従業員が GitHub の Issues をフル活用して報告された問題のトリアージ、応答、計画、修正ができるようになりました。そして、そのプロセスもすべてユーザーに可視化されています。

ドキュメントに関するフィードバックの例

ある記事の破損したハイパーリンクに関する GitHub の Issues を投稿したとしましょう。 Microsoft のチームは、問題のトリアージ、ラベルの割り当て、所有者の割り当てを行って修正 (またはフォローアップの質問) を行います。 所有者が問題を解決する pull request を送信すると、(GitHub の通知設定に基づいて) 問題が解決/クローズしたことの通知が届きます。これで、フィードバックの好循環が生まれます。

さらに、コメントのマークダウン、個々の問題や全体のリポジトリに対するサブスクリプション、組織のアクティビティの RSS フィード、@ メンション、Assignee といった、GitHub が標準で持つ利点をすべて活用できます。 Microsoft はオープン ソース ツールの深いレベルでの統合によって、コミュニティの成長とコラボレーションの新しい機会が生まれると考えています。

製品に関するフィードバックの分離

以前のシステムには、製品とドキュメントのフィードバックが同じ流れに混在しているという問題がありました。これは、すべてのアイテムに一貫したラベル付けがされていない場合に、トリアージとフォローアップが非常に大変でした。 この問題を修正するため、2 つを明確に区別する方法を考えました。

[Give product feedback](製品に関するフィードバック) をクリックすると、特定のドキュメント ページに関連付けられた製品チームが製品フィードバックを処理するサイトに直接移動するようになりました。

ロールアウト

このフィードバック システムがいつから稼動するのかを疑問に思われているかもしれません。 現在のところ、Visual Studio IDE と Azure CLI のドキュメントに対しては数か月以内の稼動を予定しています。 2 月中旬から、すべての docs.microsoft.com へのロールアウトを開始します。

フィードバック

お客様のフィードバックは非常に重要です。そこで Microsoft はこの新しいシステムを迅速にお客様の元に届けたいと考えています。 プラットフォーム上のフィードバックとエンゲージメントの改善は次のステップであって、決して最後のステップではありません。 変更に関するご意見を GitHub でお寄せいただくか、または Twitter で Microsoft をタグ付けしてください。