Microsoft 開発者向けの Stack Overflow のドキュメント

この投稿は、クラウドおよびエンタープライズ事業部の統括部長、Jeff Sandquist によって執筆されました。

Microsoft 開発者向けの Stack Overflow のドキュメントをサポートするために、Stack Overflow とのパートナーシップを締結したことを発表いたします。 この発表の一環として、Stack Overflow ドキュメント コンテンツが将来的にdocs.microsoft.com API リファレンス コンテンツに統合されることを発表します。 Microsoft は長い間、スポンサー タグの形式で Stack Overflow とパートナーの関係にあります。Stack Overflow ドキュメントの立ち上げにより、コミュニティは、.NET Framework、Xamarin、およびその他の Microsoft 製品やテクノロジを使用して、簡単にコード サンプルを作成し、それに対して投票することができるようになりました。

共有の目標

docs.microsoft.com と Stack Overflow は両者とも共通の目標を有しています。私たちは、製品やサービスを使用するための優れたドキュメントをコミュニティが簡単かつシンプルに投稿できるようにしたいと考えています。 どちらのコンテンツ セットにもオープン ライセンスが用意されており、コンテンツ形式としてマークダウンが使用され、コミュニティ投稿の有効化が簡単に行えます (任意の docs.microsoft.com ページから [編集] をクリックする)。

.NET 開発者向けの Stack Overflow のクイック ツアー

StackOverflow ドキュメントに最初にアクセスすると、利用可能なトピックの使い慣れたタグベースの分類が見つかります。 StackOverflow コミュニティによって以前に作成されたすべてのタグが一目でわかります。 タグでフィルター処理すると、それぞれのリストが表示され、いくつかの重要なメトリック (トピック要求、提案された変更、改善要求の数など) がすぐに表示されます。

トピックを要求する

StackOverflow 対象ユーザーの助けを借りずに難しい問題を解決した開発者はほとんどいません。 同僚および仲間と連携して、また StackOverflow を監視して独自の製品に関連する質問が出ていないかどうかを監視しているコミュニティの名高い人物と連携して、情報がタグで整理されるネットワークを構築しました。 ドキュメントでは、知識を集合的に構築することに対して対象ユーザー コミットメントを利用するために、サポートを求める場所が私たちに提供されます。各タグの "要求されたトピック" セクションでは、一般的な問題を明らかにするための場所がコミュニティに提供されています。

[トピックの作成] をクリックすることで、トピックのコンテンツを作成し、独自のコード サンプルとドキュメントを提供できます。 エクスペリエンスには、コンテンツの各セクションを提供する場所に関するガイダンスが用意されています。これは、必要に応じて Markdown 構文を使用して編集できます。 トピックを作成すると、進行状況が適切なナビゲーションに保存されます。そこでは、まだ完了していない、またはレビューのためにまだ送信していないすべてのドラフト コンテンツを確認できます。

使い慣れたコード表示エクスペリエンス

StackOverflow Q&A サイトと同様に、個々のトピックのコードは明確で簡潔な形式で表示されます。そのため、コードをコピー編集して使用したり、単にコードを読むことから学習したりできます。 開発者は、Stack Overflow に対する回答と同様に、投稿コード サンプルを上下することができます。

将来の統合

今後は、docs.microsoft.com で、Stack Overflow ドキュメントのサンプルのキュレーション リストを Microsoft API ドキュメントに直接統合する予定です。 Microsoft API リファレンスを参照している開発者には、Microsoft によって作成されたサンプルと、コミュニティによって作成された Stack Overflow サンプルの両方が表示されます。 該当するサンプルをキュレーションすることで、確立された .NET コーディング ガイドラインとベスト プラクティスが、コード サンプルで確実に使用されるようにします。 今後、この統合の詳細をリリースする予定です。