Update zur MSDN- und TechNet-Migration zu docs.microsoft.com

Dieser Beitrag wurde von Jeff Sandquist, Corporate Vice President – Developer Relations, verfasst.

Heute freuen wir uns, Ihnen ein wichtiges Update zur Migration von MSDN- und TechNet-Inhalten zu docs.microsoft.com vorstellen zu können. Dieser Blogbeitrag dokumentiert die letzten Schritte einer unternehmensweiten Initiative zur Überarbeitung der Inhaltsstruktur, des Formats und der zugrunde liegenden Infrastruktur sowie zur Zentralisierung der technischen Dokumentation von Microsoft um eine Website herum.

Von MSDN und TechNet zu docs.microsoft.com

Bereits 1992 wurde Microsoft Developer Network als Kundenabonnementdienst mit dem Ziel eingeführt, technische Informationen zur Programmierung für Windows bereitzustellen. Sechs Jahre später, 1998, wurde die MSDN Online-Website mit mehr als 250.000 Seiten Inhalt gestartet.

Screenshot von MSDN Online im Jahr 1999

Damals bestand der Veröffentlichungsprozess darin, Inhalte in Microsoft Word zu erstellen, in HTML zu konvertieren und über ein Tool namens pubwiz (Publishing Wizard) zu veröffentlichen. Mehr als 20 Jahre lang unterstützte der Prozess die Veröffentlichung neuer Produkte, Dienste und Updates, was zu erstaunlichen 45 Millionen Seiten an technischen Inhalten führte!

Da sich der Produktfreigabezyklus von Jahren auf Monate verkürzte, stieg die Nachfrage nach zugänglicher, aktueller Dokumentation. Das Veröffentlichungssystem musste der technischen Geschwindigkeit entsprechen, und so entschieden wir uns, neu zu gestalten, wie wir die Dokumentation bei Microsoft im Cloudzeitalter verwalten. Im November 2015 verfassten die Gründungsmitglieder des docs.microsoft.com-Teams (Dan Fernandez, Mary McHale, Carol Zeumault und Jeff Sandquist) ein Dokument namens „A New Hope“ (eine Hommage an Star Wars Episode IV), das die Vision für die neue Website skizzierte. Es enthielt eine Reihe von wichtigen Leitprinzipien:

  • Vereinheitlichte technische Dokumentation. Die neue Website sollte die zahlreichen Dokumentationswebsites konsolidieren, die von Microsoft gehostet werden. Ein Entwickler, der lernt, wie eine datengesteuerte Web-App erstellt wird, müsste nur eine Website besuchen, um alle relevanten Inhalte zu ASP.NET, Azure, Entity Framework oder einer beliebigen anderen Microsoft-Technologie zu finden.
  • Verbesserte Benutzererfahrung. Ein Schlüsselfaktor bei der Definition des Erfolgs einer Website ist die Benutzererfahrung, die sie ihren Kunden bietet. Die neue Website sollte eine bessere Ladeleistung, gut lesbare Schriftarten, zugängliche Inhaltsverzeichnisse, von Menschen lesbare URLs, Unterstützung für Versionsverwaltung sowie Kompatibilität mit mobilen Browsern aufweisen und die Praktiken für inklusives Design durch zugängliche Funktionen und Unterstützung für Internationalisierung berücksichtigen.
  • Demokratisierung von Dokumenterstellung und Communityengagement. Die neue Website sollte auf Open-Source-Standards und -Tools basieren, die es jedem ermöglichen, Dokumentation zu erstellen und zu bearbeiten. Sie sollte Markdown für Inhalte, YAML für automatisch generierte API-Dokumentation und GitHub als zugrunde liegende Inhaltsebene verwenden, was den Einsatz automatisierter Qualitätsprüfungen ermöglichen würde. Die GitHub-Organisation MicrosoftDocs ist auf über 7.400 Mitglieder angewachsen, und das Azure-Dokumentationsrepository ist eines der am schnellsten wachsenden Open-Source-Projekte (Jahr für Jahr um 470 % ) und hält Platz 5 als Repository mit den meisten Beiträgen in ganz GitHub (wie The State of the Octoverse 2018 belegt)!
  • Unterstützung von API-Dokumentation. Die neue Website sollte erstklassige Unterstützung für die Dokumentation von APIs bieten, die für Programmiersprachen und Plattformen geschrieben wurden, die unsere Kunden verwenden, darunter .NET, Java, Python, JavaScript und TypeScript, PowerShell, die Azure CLI, Q#, OpenAPI und viele mehr. Die Benutzererfahrung sollte auf Automatisierung basieren, über eine zuverlässige API-Abdeckung verfügen und in der Lage sein, API-Dokumentation in Minuten statt in Wochen zu veröffentlichen.
  • Modernisierung der technischen Infrastruktur. docs.microsoft.com sollte in Azure ausgeführt werden, was es uns ermöglicht, die Verwaltungskosten zu senken (Einsparungen von über 7 Millionen USD), die Bereitstellungszeiten von drei Wochen auf täglich (oder schneller) zu verbessern und Engineeringduplizierungen zu verringern.
  • Standardmäßig erweiterbar. Im Zuge der Weiterentwicklung der Website muss sie in der Lage sein, die Anforderungen unserer Kunden auf die effizienteste Weise zu erfüllen. Durch dieses Engagement konnten wir eine brandneue interaktive Lernerfahrung (Microsoft Learn) sowie unseren Beispielcodebrowser entwickeln und integrieren.

Mit einer modernen Plattform haben wir uns zum Ziel gesetzt, sicherzustellen, dass wir keine wertvollen Inhalte durch die Migration zu der neuen Website verlieren. Nachfolgend finden Sie weitere Informationen zu unseren Fortschritten.

MSDN- und TechNet-Bibliotheken

Status: ✅ Abgeschlossen

Wir haben Ende 2017 mit der Migration der MSDN-Bibliothek und der TechNet-Bibliothek zu docs.microsoft.com begonnen und die Migration in diesem Jahr abgeschlossen.

Die Bibliotheken stellten bisher Dokumentation für Microsoft-Produkte bereit, einschließlich API-Dokumentation, Beispielcode und technische Artikel. Ursprünglich auf CDs erhältlich, wurden die Inhalte später mit dem Start der MSDN- und TechNet-Websites online gestellt.

Die Migration erforderte die Konvertierung einer Vielzahl von XML-basierten Formaten in Markdown für durch Menschen bearbeitete Inhalte und YAML für automatisch generierte API-Dokumentation, die über hundert verschiedene Inhaltssätze umfasst. Wir haben sichergestellt, dass Seitenumleitungen für Millionen von Webseiten vorhanden sind, um fehlerhafte Links zu verhindern, auf die von anderen Websites verwiesen wird, z. B. in Blogs und Foren.

Um Ihnen einen Einblick in den Umfang der Inhalte zu geben, mit denen wir gearbeitet haben, folgen hier einige statistische Angaben:

Wenn Sie MSDN- oder TechNet-Inhalte mit einem Lesezeichen versehen haben, werden die Links nahtlos an ihren neuen Speicherort unter docs.microsoft.com umgeleitet.

MSDN Magazine

Status: ✅ Abgeschlossen

Die letzte Ausgabe von MSDN Magazine wurde am 1. November 2019 veröffentlicht. Wir haben in der August-Ausgabe von MSDN Magazine eine letzte Nachricht an Leser und Autoren gesandt.

MSDN Magazine-Inhalte, die auf MSDN veröffentlicht wurden, wurden nach docs.microsoft.com/archive verschoben.

Abonnenten von MSDN Magazine, die für ihre Abonnements bezahlt haben, erhalten basierend auf der verbleibenden Zeit ihres Abonnements eine anteilige Rückerstattung. Die Rückerstattungsschecks werden nach der Veröffentlichung der Novemberausgabe verschickt. Diese Änderung hat keine Auswirkungen auf das MSDN Platform-Abonnement.

Microsoft Developer- und TechNet Flash-Newsletter

Status: ✅ Abgeschlossen

Newsletter, die auf MSDN und TechNet veröffentlicht wurden, wurden in docs.microsoft.com/archive verschoben.

Aktuelle Abonnenten erhalten diese Newsletter auch weiterhin. Wir entwickeln und ändern möglicherweise das Format und den Veröffentlichungszeitplan.

Wenn Sie unseren Newsletter nicht mehr abonnieren möchten, können Sie sich mit der nächsten E-Mail abmelden, die Sie erhalten.

MSDN- und TechNet-Blogs

Status: 🚧 In Bearbeitung

Wir haben die Websites mit MSDN-Blogs und TechNet-Blogs im Juli 2019 mit einem Schreibschutz versehen. Wir sind derzeit damit beschäftigt, alle MSDN- und TechNet-Blogs unter docs.microsoft.com/archive zu archivieren. Es wird erwartet, dass die Migration im Januar 2020 abgeschlossen sein wird.

Wenn Sie MSDN- oder TechNet-Blogs mit einem Lesezeichen versehen haben, werden die Links zu diesen nahtlos an den neuen Speicherort unter docs.microsoft.com/archive weitergeleitet.

Status: ✅ Abgeschlossen

Wir haben alle Seiten des MSDN-Codekatalogs an den Beispielbrowser umgeleitet und wichtige Beispiele auf GitHub in der Organisation MicrosoftArchive archiviert. Erfahren Sie mehr zu diesem Vorgang in unserem letzten Blogbeitrag.

Die aktuellsten Codebeispiele finden Sie unter docs.microsoft.com/samples.

Status: 🚧 In Bearbeitung

Der TechNet-Katalog wird Anfang 2020 eingestellt. Im Dezember 2019 wird die Website mit einem Schreibschutz versehen, und es werden keine neuen Communitybeiträge mehr akzeptiert. Weitere Ankündigungen und Informationen folgen demnächst.

Verwenden Sie docs.microsoft.com/samples, um die aktuellsten Codebeispiele zu finden. Wenn Sie zuvor zum TechNet-Katalog beigetragen haben, stellen Sie sicher, dass Sie Ihre Beispiele zu einem persönlich verwalteten Speicherort migrieren, z. B. in Ihr eigenes GitHub-Repository.

TechNet Wiki

Status: 🚧 In Bearbeitung

Wir arbeiten an einem konkreteren Migrations- und Zeitplan für TechNet Wiki. Schauen Sie später erneut vorbei, um weitere Details zu erfahren. Sie können zu diesem Zeitpunkt weiterhin an Wiki-Inhalten teilnehmen und mit ihnen interagieren.

MSDN- und TechNet-Foren

Status: 🚧 In Bearbeitung

Wir haben die Vorschauversion von Microsoft Q&A angekündigt, die MSDN- und TechNet-Foren ersetzt. Zur Sicherstellung eines reibungslosen Übergangs und der Verringerung von Beeinträchtigungen haben wir die Migration in mehrere Phasen unterteilt. Wir erwarten, die Migration bis Mitte 2020 abzuschließen. Schauen Sie später erneut vorbei, um weitere Details zu erfahren.

Channel 9

Status: 🚧 In Bearbeitung

Channel 9 ist nach wie vor eine wichtige Investition in entwicklerorientierte Videoinhalte. Wir arbeiten an einem Migrationspfad, der unsere Videos und technischen Inhalte aus Channel 9 besser integriert. Schauen Sie später erneut vorbei, um weitere Details zu erfahren.

Wir möchten von Ihnen hören!

Wir freuen uns, weiterhin in unsere Plattform zu investieren und sicherzustellen, dass Sie die relevanteste und zuverlässigste technische Dokumentation für das gesamte Microsoft-Ökosystem erhalten. Teilen Sie uns Ihre Gedanken und Verbesserungsvorschläge auf GitHub und über Twitter mit.