Einführung von docs.microsoft.com

Dieser Beitrag wurde vom Geschäftsführer der Abteilung „Cloud + Enterprise“, Jeff Sandquist, verfasst.

Heute kündigen wir die Vorschauversion unseres neuen Dokumentationsdiensts https://docs.microsoft.com an, der Inhalte zur Unterstützung unserer Enterprise Mobility-Produkte bietet.

Gründe für docs.microsoft.com

Kurz gesagt: Inhalte zählen. Wir haben Hunderte von Entwicklern und IT-Experten interviewt und befragt und über die Jahre Ihr Feedback auf unserer Website in UserVoice gesichtet. Es wurde deutlich, dass wir eine Veränderung vornehmen und eine moderne Webumgebung für Inhalte erstellen mussten. Als Erstes haben wir unsere vorhandene Inhaltsinfrastruktur, TechNet und MSDN, geprüft. Beide Websites basieren auf einer 10-15 Jahre alten anfälligen Codebasis mit einem veralteten Veröffentlichungs- und Bereitstellungssystem, das nicht auf die Ausführung in der Cloud ausgelegt ist.

Unser Fokus lag aber nicht nur auf der Umgebung, sondern auch auf den Inhalten, die wir erstellen, und wie diese von ihnen genutzt werden. Jahrelang haben Kunden sich von uns gewünscht, dass wir nicht bloß riesige Textmengen mit featurebezogenen Inhalten bieten, sondern ihnen helfen, Lösungen für ihre Geschäftsprobleme zu finden. Wir wussten, dass die Inhalte, die wir bieten, und die Plattform, die wir aufbauen sollten, es Kunden erleichtern müssen, Lösungen zu erlernen und bereitzustellen.

Uns war auch bewusst, dass wir zum Aufbau der gewünschten Umgebung von Grund auf neu beginnen mussten. Das Ergebnis ist https://docs.microsoft.com, die „neue Hoffnung“ für Dokumentation bei Microsoft.

Hinweis: Diese Vorschauversion der Website enthält *ausschließlich* Inhalte für die Enterprise Mobility-Dokumentation (bestehend aus Advanced Threat Analytics, Azure Active Directory, Azure Remote App, Multi-Factor Authentication, Azure Rights Management, Intune und Microsoft Identity Manager). Sobald sich unsere Plattform mithilfe Ihres Feedbacks weiterentwickelt, werden wir künftig weitere Dokumentation in diese Umgebung verschieben.

Hauptmerkmale

Beginnen wir mit dem unten gezeigten Beispiel für eine Dokumentationsseite, an dem wir Ihnen einige der neuen Features auf der Website vorstellen.

Documentation Example

Lesbarkeit

Zur Verbesserung der Lesbarkeit von Inhalten haben wir für die Website eine feste Inhaltsbreite festgelegt. Untersuchungen zur Blickbewegungsregistrierung haben gezeigt, dass sich das Verständnis und Lesetempo mit einer festen Inhaltsbreite verbessern lassen, da es dem Auge schwerfällt, langen Textpassagen von links nach rechts zu folgen. Die Umsetzung sehen Sie im folgenden Beispiel eines Intune-Artikels auf docs.microsoft.com gefolgt vom selben Artikel auf TechNet. Wir haben auch den Schriftgrad für den linken Navigationsbereich und den Text selbst erhöht, worum uns Kunden gebeten haben (UserVoice: Increase Font size).

Docs and TechNet comparison

Geschätzte Lesezeit

Eine weitere einfache Verbesserung, die wir basierend auf Ihren Rückmeldungen vorgenommenen haben, ist die Angabe einer geschätzten Lesezeit für einen Artikel. Wir wissen, dass viele von Ihnen sich in den wenigen Minuten zwischen Besprechungen mit Technologie beschäftigen, sodass Sie Artikel wohl eher lesen werden, wenn Sie den erforderlichen Zeitaufwand kennen. Wir haben Inhalten außerdem Datumsangaben hinzugefügt, damit Kunden erkennen, wie aktuell die Informationen basierend auf dem UserVoice-Feedback sind.

Estimated reading time

Inhalts- und Websitenavigation

Ein wichtiger Bereich, in dem basierend auf Kundenaussagen und UserVoice-Feedback Verbesserungen erfolgt sind, ist die Navigation, Informationsarchitektur und Organisation von Inhalten basierend auf der Intention des Kunden. Wir haben unsere Inhalte in logische Gruppen für die Evaluierung, ersten Schritte, Planung, Bereitstellung, Verwaltung und Problembehandlung von Produkten und Diensten umgestaltet. Diese Inhalte werden sowohl im linken Navigationsbereich als auch auf unseren Seiten mit Produkten und Diensten gegliedert gezeigt.

Es folgt ein Screenshot der Homepage der Intune-Dokumentation:

Intune documentation screenshot

Dieselbe Kategorisierung finden Sie auch im Navigationsbereich links neben den Artikeln:

Left navigation

Verkürzte Artikellänge

Eine weitere häufige Rückmeldung war, dass unsere Inhalte aufgrund ihrer Länge mitunter kaum zu bewältigen seien und dass lange Artikel die Navigation und das Auffinden der gesuchten Informationen erschwerten. Um dieses Problem zu beheben, haben wir viele längere Artikel in kleinere logische Schritte unterteilt und am Ende der Artikel die Schaltflächen „Zurück“ und „Weiter“ für die Navigation zwischen den einzelnen Schritten in einem mehrteiligen Tutorial bereitgestellt, wie unten gezeigt.

Back and Next buttons

Während viele Kunden mehrteilige Tutorials schätzen, haben wir auch von Kunden gehört, die sich die Möglichkeit wünschen, mehrteilige Tutorials in einer einzigen Offline-PDF zusammenzufassen, die leicht gedruckt werden kann. Das ist noch nicht möglich, wird jedoch bald in der Vorschau eingeführt.

Dynamisches Design

Zum Erstellen einer überzeugenden Umgebung auf mobilen Geräten, Tablets und PCs sind wir entsprechend Ihren Rückmeldungen auf UserVoice zu einem reaktionsfähigen Layout gewechselt. Bei Klicken auf die Schaltfläche „Optionen“ wird die Anzeige auf- oder zugeklappt, und es werden dieselben Optionen wie in einer Desktopansicht angezeigt.

Responsive Page Design

Beiträge aus der Community

Die gesamte Dokumentation auf docs.microsoft.com ist Open Source und lässt Beiträge aus der Community zu. Dies entspricht der Vorgehensweise anderer Teams bei Microsoft, deren Dokumentation bereits vollständig oder teilweise Open Source ist, einschließlich ASP.NET, Azure, .NET Core und Microsoft Graph.

Jeder Artikel bietet die Schaltfläche „Bearbeiten“ (siehe unten), über die Sie zur Markdown-Quelldatei auf GitHub gelangen, wo Sie mühelos eine Pullanforderung zum Korrigieren oder Verbessern von Inhalten senden können.

Mechanismen für Feedback

Ihre Fragen, Kommentare und Rückmeldungen sind uns sehr wichtig. Wir haben uns mit Livefyre zusammengetan, damit Kommentare und Randbemerkungen zu allen unseren Artikeln bereitgestellt werden können. Am Anfang jedes Artikels sehen Sie (wie unten dargestellt) einen Link für Kommentare.

Comments link

Durch Klicken auf „Kommentare“ gelangen Sie zum unteren Rand der Seite. Hier können Sie sich (mit Twitter-, Facebook-, Google-, Yahoo- oder Microsoft-Anmeldeinformationen) anmelden, um Kommentare hinzuzufügen, ihnen zu folgen oder positiv zu bewerten.

Comments at bottom

Sie können auch Randbemerkungen oder Notizen zu jedem Absatz des Inhalts oder speziell hervorgehobenen Text hinzufügen. Klicken Sie hierfür mit der Maus rechts auf das Kommentarsymbol, um einen Inlinekommentar hinzuzufügen.

Sidenote example

Teilen in sozialen Netzwerken

Über die Schaltfläche „Teilen“ oben können Sie die Informationen mühelos per Twitter und Facebook teilen.

Sharing to Twitter and Facebook

Wie nachstehend gezeigt, können Sie auch mit der Maus Inhalte in einem Artikel auswählen, um einen Kommentar hinzuzufügen oder diesen direkt per Twitter oder Facebook zu teilen.

Select and comment or share content

Besser lesbare URLs

Die Erfahrung auf unserer Website ist uns wichtig, weshalb uns als Benutzer von TechNet oder MSDN eine Sache regelmäßig gestört hat, nämlich dass Artikel keine benutzerfreundlichen, lesbaren URLs hatten. Hier ist ein Beispiel desselben Artikels mit unseren neuen URLs.

Design der Website

Wir haben Artikeln auch eine Designauswahl hinzugefügt, sodass Sie zwischen einem hellen und dunklen Design wechseln können, was sich einige von Ihnen auf UserVoice gewünscht haben.

Light and Dark Theme Selector

Die folgende Abbildung zeigt den Unterschied zwischen hellem und dunklem Design.

Light and Dark themes

Grundlagen

Grundlagen wie die Leistung von Websites sind ein wichtiges Merkmal, und auf UserVoice haben uns viele Kunden gebeten, hier für Verbesserungen zu sorgen. Seitenladezeiten auf docs.microsoft.com sind 50-300 % schneller, und die geografische Verteilung ist größer als je zuvor. Wir arbeiten außerdem mit einer Architektur, die zu 100 % in Azure ausgeführt wird.

Wir freuen uns über Ihr Feedback!

Wir hoffen, dass Ihnen die Vorschauversion von docs.microsoft.com gefällt. Bitte senden Sie Ihr Feedback an https://aka.ms/sitefeedback. In künftigen Beiträgen besprechen wir unsere Pläne, wie wir unsere Umgebung für Referenzinhalte und die Lokalisierung von Inhalten drastisch verbessern wollen.