MSDN と TechNet の docs.microsoft.com への移行に関する更新情報

  • [アーティクル]

この記事は、Developer Relations 担当副社長である Jeff Sandquist によって執筆されました。

本日は、MSDN と TechNet のコンテンツの docs.microsoft.com への移行に関する重要な更新情報をお知らせします。 このブログ記事では、コンテンツの構造、形式、および基盤となるインフラストラクチャを徹底的に見直し、Microsoft の技術ドキュメントを 1 つのサイトに一元化する全社的な取り組みの最後の数ステップについて説明します。

MSDN および TechNet から docs.microsoft.com へ

1992 年、Windows のプログラミングに関する技術情報を提供するカスタマー サブスクリプション サービスとして Microsoft Developer Network が誕生しました。 6 年後の 1998 年には MSDN オンライン サイトが開設され、25 万ページを超えるコンテンツをホストするようになりました。

1999 年の MSDN Online のスクリーンショット

当時、発行プロセスは、Microsoft Wordでコンテンツを作成し、HTML に変換し、 (発行ウィザード) というpubwizツールを使用して発行することで構成されていました。 このプロセスは新しい製品、サービス、更新プログラムのリリースを 20 年以上にわたってサポートし、その結果、4,500 万ページもの技術コンテンツが提供されました。

製品のリリース サイクルが数年から数か月へと変わるにつれて、アクセス可能な最新のドキュメントに対する需要が増大しました。 発行システムをエンジニアリングのスピードに合わせることが必要になり、クラウドの時代における Microsoft でのドキュメント管理方法を再検討することに決めました。 2015 年 11 月には、docs.microsoft.com チームの設立メンバーである Dan Fernandez、Mary McHale、Carol Zeumault、および Jeff Sandquist が、新しいサイトのビジョンを概説した「新たなる希望」という名前 ("スターウォーズ エピソード IV へのオマージュ") のドキュメントを執筆しました。 そこで示された主要な指針は次のとおりです。

  • 技術ドキュメントの集約。 新しいサイトは、Microsoft がホストしている多数のドキュメント Web サイトを集約したものである必要があります。 データドリブン Web アプリを作成する方法を学ぼうとする開発者は、1 つのサイトにアクセスするだけで、ASP.NET、Azure、Entity Framework、またはその他の Microsoft テクノロジに関連するすべてのコンテンツを検索できます。
  • ユーザー エクスペリエンスの向上。 Web サイトの成功を定義する重要な要素の 1 つは、サイトによってお客様に提供されるエクスペリエンスです。 新しいサイトは、読み込みパフォーマンスの向上、読みやすいフォント、アクセスしやすい目次、人間が判読できる URL、バージョン管理のサポート、モバイル ブラウザーとの互換性を提供し、アクセス可能な機能と国際化のサポートを通してインクルーシブ デザインを実践するものである必要があります。
  • オーサリングとコミュニティ エンゲージメントの民主化。 新しいサイトでは、あらゆるユーザーがドキュメントを作成および編集できるように、オープン ソースの標準とツールを採用する必要があります。 コンテンツには Markdown を使用し、自動生成される API ドキュメントには YAML を使用する必要があります。また、基盤となるコンテンツ レイヤーとして GitHub を使用します。これにより、自動化された品質チェックを利用できるようになります。 MicrosoftDocs の GitHub 組織はメンバー数が 7,400 を超えるまでに拡大しました。そして Azure ドキュメント リポジトリは、最も急速に成長しているオープン ソース プロジェクトの 1 つであり (前年比 470%)、GitHub の全リポジトリ中 5 番目に拡大したリポジトリとなっています。これについては、「The State of the Octoverse 2018」 (GitHub の統計情報サイト) をご覧ください。
  • API ドキュメントのサポート。 新しいサイトでは、お客様が使用している .NET、Java、Python、JavaScript と TypeScript、PowerShell、Azure CLI、Q#、OpenAPI やその他のプログラミング言語とプラットフォーム向けに記述された API のドキュメントに対して、質の高いサポートを提供する必要があります。 このエクスペリエンスは、自動化を採用した、信頼性の高い API カバレッジを備えたものである必要があり、数週間ではなく数分で API ドキュメントを発行できる必要があります。
  • エンジニアリング インフラストラクチャの最新化。 docs.microsoft.com は Azure 上で運用される必要があります。これにより、メンテナンス コストを削減し ("700 万ドルを上回る節約")、展開の間隔を 3 週間ごとから毎日 ("またはそれ以下") に短縮し、エンジニアリングの重複を減らすことができます。
  • 既定で拡張可能。 サイトは、その進化に応じて、最も効率的な方法でお客様のニーズを満たすことができなければなりません。 このコミットメントによって、Microsoft Learn というまったく新しい対話型ラーニング エクスペリエンスと、サンプル コード ブラウザーを構築し、統合することができました。

最新のプラットフォームを導入することで、新しいサイトへの移行によって貴重なコンテンツを失うことがないようにしています。 進捗状況について詳しくは、以下をご覧ください。

MSDN および TechNet ライブラリ

状態: ✅ 完了

MSDN ライブラリと TechNet ライブラリの docs.microsoft.com への移行は、2017 年の後半に開始し、今年完了しました。

それらのライブラリでは以前、API ドキュメント、サンプル コード、技術記事など、Microsoft 製品に関するドキュメントを提供していました。 最初は CD で入手可能であったコンテンツは、その後 MSDN および TechNet Web サイトの開設に伴いオンラインに移行しました。

この移行では、100 を超える各種コンテンツ セットにまたがるさまざまな XML ベースの形式を、人が編集するコンテンツの場合は Markdown に、自動生成される API ドキュメントの場合は YAML に変換することが必要でした。 壊れたリンクがブログやフォーラムなどの弊社サイト外で参照されることがないように、何百万という数の Web ページに対してページ リダイレクトが機能することを確認しました。

この作業で扱ったコンテンツの量が垣間見える統計をいくつかご紹介します。

MSDN または TechNet のコンテンツにブックマークを設定している場合、リンクは docs.microsoft.com 上の新しい場所へシームレスにリダイレクトされます。

MSDN マガジン

状態: ✅ 完了

MSDN マガジンの最後の号が 2019 年 11 月 1 日に発行されました。 MSDN マガジン 8 月号の読者と執筆者の皆様に終了のお知らせをお送りしています。

MSDN で発行された MSDN マガジンのコンテンツは docs.microsoft.com/archive に移行済みです。

購読料をお支払い済みの MSDN マガジン定期購読者様には、購読の残り期間に基づいて日割り計算で返金が行われます。 11 月号の発行後に払戻小切手を郵送させていただきます。 この変更は、MSDN プラットフォームのサブスクリプションには影響しません。

Microsoft Developer および TechNet Flash ニュースレター

状態: ✅ 完了

MSDN と TechNet で公開されていたニュースレターは、docs.microsoft.com/archive に移行されました。

現在の定期購読者様には、引き続きこれらのニュースレターをお届けします。 発行スケジュールだけでなく、形式も進化し、変更される可能性があります。

ニュースレター購読の継続を希望しない場合は、次に受信する電子メールから購読を中止できます。

MSDN および TechNet のブログ

状態: ✅ 完了

2019 年 7 月に MSDN ブログと TechNet ブログのサイトを読み取り専用にしました。 MSDN と TechNet のブログは docs.microsoft.com/archive のアーカイブに移されています。

MSDN または TechNet のブログにブックマークを設定している場合、docs.microsoft.com/archive 上の新しい場所にリダイレクトされるか、他のブログ サイトが活発に更新されている場合、そちらにリダイレクトされます。

状態: ✅ 完了

MSDN コード ギャラリーのすべてのページをサンプル ブラウザーにリダイレクトし、主要なサンプルを MicrosoftArchive 組織の GitHub にアーカイブしました。 このプロセスの詳細については、最近のブログ記事をご覧ください。

最新のコード サンプルは、docs.microsoft.com/samples にあります。

状態: 🚧 進行中

TechNet ギャラリーは、2020 年前半に廃止される予定です。 サイトは 2019 年 12 月に読み取り専用になり、コミュニティへの新しい投稿は受け付けられなくなります。 今後のお知らせと追加情報をお待ちください。

最新のコード サンプルを探すには、docs.microsoft.com/samples をご利用ください。 以前に TechNet ギャラリーに投稿したことがある場合は、個人で管理している場所 (ご自分の GitHub リポジトリなど) にサンプルを移行するようにしてください。

TechNet Wiki

状態: 🚧 進行中

TechNet Wiki については、移行の計画とスケジュールの具体化に取り組んでいるところです。 詳細については、しばらくしてからもう一度お確かめください。 現時点では、引き続き wiki に参加し、コンテンツを編集することができます。

MSDN および TechNet フォーラム

状態: 🚧 進行中

MSDN フォーラムと TechNet フォーラムに代わる Microsoft Q&A のプレビュー リリースを発表しました。 スムーズな移行を確実に行い、中断を最小限に抑えるために、移行を複数の段階に分けて進めることにしました。 2020 年半ばまでの移行完了を目指しています。 詳細については、しばらくしてからもう一度お確かめください。

Channel 9

状態: 🚧 進行中

Channel 9 は、開発者に焦点を合わせたビデオ コンテンツに対する重要な投資であり続けます。 Channel 9 のビデオと技術コンテンツをより適切に統合する移行パスについて作業中です。 詳細については、しばらくしてからもう一度お確かめください。

ご意見をお聞かせください

Microsoft では、プラットフォームへの投資を継続し、Microsoft のエコシステム全体について、最も関連性の高い信頼できる技術ドキュメントを皆様が入手できるようにしていきます。 GitHub と Twitter で、ご意見や改善提案をお寄せください。