新しいフィードバック システムが docs.microsoft.com

この投稿は、docs.microsoft.com チームのシニア プログラム マネージャーである rob Eisenberg 氏によって執筆されました。

Microsoft の使命は、地球上のすべての人とすべての組織がより多くのことを達成できるように支援することです。 これは、オープンな GitHub プラットフォーム の上に docs.microsoft.com を構築際の考慮事項の 1 つでした。 現在、新しい GitHub ベースのドキュメント フィードバック システムに移行して、次のレベルに進んでいます。

GitHub のコンテンツ に関するフィードバック

Microsoft のドキュメントは最初から GitHub に掲載されていますが、コンテンツ フィードバック メカニズムでは、記事に関するコメントに Livefyre を使用しています。 Livefyre は優れたコメント ソリューションですが、お客様が発生したコンテンツの問題の追跡、割り当て、状態の維持など、特定のニーズには不十分であることが判明しました。

私たちはそれを改善するための多くの手段を探りましたが、私たちの仕事の多くを導いた1つの質問が再表面化しているように見えました:私たちのドキュメントがオープンソースコードと同じように扱われた場合、この問題を解決するために何を使用しますか? GitHub の問題 、GitHub の問題に対する回答が明らかになっているように見えたので、GitHub API をより深くドキュメント ページに統合して、GitHub インフラストラクチャ上に完全なフィードバック システムを構築できるようにしました。

新しいシステムを使用すると、コンテンツ ページから GitHub の問題を直接作成できるようになりました。これにより、ライターや製品チームとより豊富な方法で対話できます。 ドキュメントに関する問題を確認する 不適切なコード サンプルですか? 混乱を招く説明 重大な省略? ページの一番下までスクロールし、[ドキュメントフィードバックを を選択します。

ユーザー

ドキュメントに関連するすべての未解決の問題と終了した問題は、ドキュメント ページ自体から直接確認できます。そうすることで、常に問題が修正され、解決されるタイミングを把握できます。

コメントを付けて、重要な問題に 反応を追加。

現在、Microsoft の従業員は GitHub イシューの全機能を活用して、報告された問題のトリアージ、対応、計画、修正を行うことができます。このプロセスは常に可視化されます。

ドキュメントフィードバックの例

たとえば、記事の破損したハイパーリンクに関する GitHub の問題を報告するとします。 Microsoft のチームは、問題をトリアージし、ラベルを割り当て、所有者を割り当てて修正を行います (またはフォローアップの質問をします)。 所有者が問題を修正する pull request を送信すると、(GitHub の通知設定に基づいて) 問題が解決または終了されたことが通知され、フィードバックの好循環が作成されます。

さらに、コメント内の Markdown、個々の問題またはリポジトリ全体へのサブスクリプション、組織アクティビティの RSS フィード、@ メンション、担当者など、すべての標準的な GitHub の良さを活用できます。 より深いレベルのオープンソース ツール統合は、コミュニティの成長とコラボレーションのための新しい機会を促進すると考えています。

製品フィードバックの分離

以前のシステムの問題の 1 つは、製品とドキュメントのフィードバックを 1 つのストリームに混在させたものでした。すべての項目に一貫してラベルが付けられていたわけではない場合、トリアージとフォローアップは非常に困難でした。 2 つを分ける明確な方法を作成することで、この問題を解決するための一歩を踏み出しました。

製品フィードバックの送信

[製品フィードバック をクリックすると、特定のドキュメント ページに関連付けられている製品チームが製品フィードバックを処理するサイトに直接移動します。

Roll-Out

フィードバック システムがいつ稼働するのか疑問に思うかもしれません。 Visual Studio IDE と azure CLI ドキュメント については、数か月間パイロットを実施しています。 2 月中旬から、docs.microsoft.com 全体でロールアウトを開始します。

フィードバック

お客様のフィードバックは Microsoft にとって重要であるため、この新しいシステムをすばやく手に入れたいと考えています。 プラットフォームでのフィードバックとエンゲージメントを向上させる次のステップですが、それは決して最後のステップではありません。 GitHub で変更についてご意見をお寄せいただき、Twitter でタグを付けます。