.NET Core ドキュメントの概要

この投稿は、クラウド + エンタープライズ部門の Jeff Sandquist、 General Manager によって書かれています。

本日、docs.microsoft.comの .NET ドキュメント のプレビューをリリースしました。 新しいドキュメント エクスペリエンスの改善 docs.microsoft.com オファーの詳細については、ブログ記事 docs.microsoft.com 紹介するを参照してください。 docs.microsoft.com プラットフォームで利用可能なすべてのコラボレーション機能、オープンソース コンテンツ、およびわかりやすい URL に加えて、.NET 開発者に固有の新機能をいくつか紹介しました。 この記事では、これらの新機能を強調し、将来の計画をまとめます。

.NET ドキュメント エクスペリエンスのハイライト

.NET Core の魅力的な RTM リリースに伴い、.NET ドキュメントのホーム ページの先頭と中央に配置します。 .NET Core RTM リリースを、すぐに開始するために必要なものすべてを補完するために、記事へのリンクと新しいリファレンス エクスペリエンスを一覧の一番上に配置しました。

.NET Docs ホーム ページのする

.NET エコシステムをすぐに利用できる

Xamarin を使用して .NET を使用して iOS アプリケーションをビルドし、.NET を使用してユニバーサル Windows プラットフォーム (UWP) アプリをビルドする、新しい .NET Core ライブラリ、ASP.NET、Entity Framework、Azure をダウンロードするためのリンクが表示されます。 すべての .NET コンテンツをまだ docs.microsoft.com に移動していませんが、.NET ドキュメントのホーム ページが、すべての .NET ドキュメントにアクセスするための出発点となります。

記事

ライターとエンジニア、およびいくつかの専用コミュニティ メンバーは、.NET ドキュメント セクションで見つかる新しい .NET Core 関連の記事を絶え間なく作成しています。 次のようなさまざまな記事があります。

• .NET Core チュートリアル の
• .NET Core アプリケーションの展開 の
• .NET Core での単体テストの

これらのトピックとその他の多くのトピックはすべて、docs.microsoft.com テーマに表示され、各ページの目次と、各記事の各記事と共同作成者情報の推定読み取り時間が表示されます。

すべての .NET 記事はオープン ソースであり、.NET チームのドキュメント リポジトリの GitHub で入手できます。 ドキュメントに問題がある場合や改善したい場合は、各記事の右側のナビゲーションにある 編集 ボタンをクリックするのと同じくらい簡単です。

でページを表示または編集します

記事の編集は、リポジトリ内の任意の Markdown ファイルの編集ボタンをクリックし、コンテンツを追加し、pull request を送信するのと同じくらい簡単です。 チームが pull request をレビューして受け入れると、投稿は数分でサイトに公開されます。

API リファレンス

ライター、エンジニア、情熱的なコミュニティ メンバーによって作成された優れたコンテンツに加えて、リファレンス エクスペリエンスが大幅に改善されました。 リファレンス エクスペリエンスは、このプレビュー リリースで完全に再設計され、docs.microsoft.com 記事で使用したのと同じ設計原則に基づいて借用されています。

これらの記事と同様に、新しい参照ページは応答性が高く、最新の Web 原則を使用して設計されており、モバイル デバイスでは見た目が良くなります。

リファレンス

のすべての名前空間ページに 型検索 が追加されました。 これにより、すべての .NET 型の型名で簡単に検索できます。 各キー押下では、左側のナビゲーションに表示される型の一覧をフィルター処理します。 このリファレンス領域のこの魅力的な新機能は、GitHub のオープンソース プロジェクトである DocFXと呼ばれる .NET リファレンス ドキュメントを生成するための新しいフレームワークに含まれています。

名前空間の左側のナビゲーションで個々の型をクリックすると、その型に対する名前空間ページの概要セクションに直接移動します。 参照コンテンツのメイン領域で型の名前をクリックすると、クラスの詳細ページが表示されます。このページには、クラスの継承チェーン、宣言、クラスのプロパティとメソッドのメンバーに関する詳細が含まれます。

メソッド メンバーごとに、パラメーターの詳細とメソッドの概要が表示されます。

情報とエンジニアリングの原則

DocFX ドキュメント生成ツールの継続的な開発と改善に加えて、新しい .NET ドキュメント エクスペリエンスで明らかにされるエンジニアリングとドキュメントの原則が大幅に改善されました。

より優れた自動化 を する

潜在的な共同作成者からプル要求を受け取ると、共同作成者が共同作成者ライセンス契約に署名する簡単なプロセスに従っていることを検証します (このプロセスは完全に電子的であり、完了するまでに数分かかります)。 投稿が 投稿ガイドラインに準拠している限り、pull request が受け入れられた数分後に小さな変更がサイトに反映されます。

より適切な URL を する

docs.microsoft.com エクスペリエンス全体の重要な原則の 1 つは、検索インデックス作成と "推測" を向上させるための URL の向上です。この原則は、.NET ドキュメントに保持されています。 記事とリファレンス ドキュメントの両方に、よりクリーンな URL があります。 たとえば、System 名前空間の従来の MSDN URL を次に示します。

MSDNする

新しいリファレンス ドキュメントでは、URL はより論理的で、人間が判読でき、最も重要なのは、より検出可能なです。

docs.microsoft.com

アジャイルでオープンなオーサリング

コンテンツはオープンソースであるだけでなく、コミュニティの貢献を受け入れるだけではありません。 さらに、docs.microsoft.com 上のすべてのコンテンツ (.NET ドキュメントを含む) は、すべてクリエイティブ コモンズ ライセンスで入手できます。 読み取ったり、コピーしたり、参照したり、その一部を再利用することができます (商用の場合でも)。 ライターとエンジニアは、新しいシステムで何ヶ月も積極的にコミュニティメンバーと協力してきました。 それは興味深くエキサイティングな移行であり、将来的にはもっと多くを得る必要があります。

今後の計画

docs.microsoft.com のこのセクションは、サイトの残りの部分と同様にプレビュー段階であるため、建設的なフィードバックと解説を奨励しています。 機能のアイデア UserVoice に送信してください。

今後数週間以内に、参照ドキュメントを生成するために使用される XML コメントを .NET ソース コードに直接発行する予定です。 これにより、誰でも簡単にクリックして .NET Framework リファレンス ドキュメントを更新できます。
また、参照のデザインとレイアウト、および参照コンテンツ自体を編集する前述の機能も引き続き調整します。

docs.microsoft.com に関する新しい .NET ドキュメント領域をお届けできることを楽しみにしています。今後のエクスペリエンスの向上を楽しみにしています。