Introductie van docs.microsoft.com

Dit bericht is geschreven door Jess Sandquist, General Manager in de Cloud + Enterprise-divisie.

Vandaag kondigen we de preview-versie van onze nieuwe documentatieservice https://docs.microsoft.comaan, met inhoud die ondersteuning biedt voor onze Enterprise Mobility-producten.

Waarom docs.microsoft.com?

Kort gezegd: omdat inhoud belangrijk is. We hebben honderden ontwikkelaars en IT-professionals geïnterviewd en ondervraagd en de feedback over de website doorgespit die jarenlang via UserVoice is binnengekomen. Er was duidelijk verandering nodig naar een moderne webervaring voor inhoud. Als eerste hebben we de bestaande inhoudsinfrastructuur van TechNet en MSDN geëvalueerd. Beide sites draaien op een tien tot vijftien jaar oude, zwakke codebasis met een verouderd publicatie- en implementatiesysteem dat niet is ontworpen om te worden uitgevoerd in de cloud.

Onze focus lag niet alleen bij de ervaring, maar ook bij de inhoud die we maken en hoe u deze inhoud gebruikt. Jarenlang hebben onze klanten ons geadviseerd om de beperkingen van tekst los te laten en inhoud met de allure van hoofdartikelen te ontwikkelen die ze kunnen gebruiken om oplossingen voor hun bedrijfsproblemen te implementeren. Het was duidelijk dat de inhoud en het platform ervoor moesten zorgen dat klanten op eenvoudige wijze de oplossingen leren gebruiken en kunnen implementeren.

We moesten helemaal opnieuw beginnen om die algehele ervaring te realiseren. Uit die inspanningen is https://docs.microsoft.com voortgekomen, de nieuwe benadering voor documentatie bij Microsoft.

Opmerking: deze preview-versie van de website bevat inhoud *alleen* voor Enterprise Mobility-documentatie (die bestaat uit Advanced Threat Analytics, Azure Active Directory, Azure Remote App, Multi-Factor Authentication, Azure Rights Management, Intune en Microsoft Identity Manager). Naarmate het platform zich verder ontwikkelt aan de hand van uw feedback, wordt meer documentatie naar deze ervaring gemigreerd.

Belangrijkste functies

Laten we beginnen met een voorbeelddocumentatiepagina die hieronder wordt weergegeven en we laten enkele van de nieuwe functies op de site zien.

Voorbeeld van documentatie

Leesbaarheid

Ter verbetering van de leesbaarheid hebben we een vaste inhoudsbreedte ingesteld. Oogtraceringsstudies hebben aangetoond dat u de begrijpelijkheid en leessnelheid kunt verbeteren met een vaste inhoudsbreedte omdat het moeilijk is om lange passages van links naar rechts te volgen. Ter illustratie hiervan ziet u hieronder een voorbeeld van een artikel over Intune op docs.microsoft.com gevolgd door hetzelfde artikel op TechNet. We hebben ook de tekengrootte voor de linkernavigatie en de tekst zelf verhoogd, iets waar klanten om hebben gevraagd (UserVoice - Tekengrootte vergroten).

Vergelijking tussen docs en TechNet

Geschatte leestijd

Een andere eenvoudige verbetering die we hebben aangebracht op basis van uw invoer, is door een geschatte leestijd voor een artikel te bieden. We weten dat velen van u een paar minuten technologie leren/evalueren tussen vergaderingen en u waarschijnlijk artikelen leest als u weet hoeveel tijd er nodig is. Ook hebben we op basis van feedback op UserVoice datumstempels aan de inhoud toegevoegd zodat klanten inzicht krijgen in hoe recent de inhoud is toegevoegd.

Geschatte leestijd

Inhoud en sitenavigatie

Een belangrijk investeringsgebied op basis van klantgesprekken en UserVoice-feedback was verbeteringen in sitenavigatie, informatiearchitectuur en inhoudsorganisatie op basis van de intentie van de klant. We hebben onze inhoud opnieuw gestructureerd op basis van logische groepen die betrekking hebben op evalueren, aan de slag gaan, plannen, implementeren, beheren en het oplossen van problemen met producten of services. Deze onderverdeling ziet u terug in het linkernavigatiegedeelte en op de product- en servicepagina's.

Hieronder ziet u een schermopname van de startpagina van de documentatie voor Intune:

Schermopname van de documentatie voor Intune

Dezelfde categorisering wordt gebruikt voor het linkernavigatiegedeelte van artikelen:

Linkernavigatiebalk

Lengte artikelen ingekort

Een ander veelvoorkomend deel van feedback was dat onze inhoud soms overweldigend kan zijn vanwege de lengte en dat lange artikelen moeilijker te navigeren zijn en vinden wat u zoekt. Om dit aan te pakken, hebben we veel langere artikelen onderverdeeld in kleinere logische stappen en hebben we de knoppen Vorige en Volgende onderaan artikelen opgegeven om te navigeren tussen stappen in een meerdelige zelfstudie, zoals hieronder wordt weergegeven.

Knoppen Vorige en Volgende

Hoewel veel klanten graag werken met tutorials in meerdere delen, hebben we ook gehoord dat klanten soms een tutorial met meerdere delen willen samenvoegen in één offline PDF-bestand, zodat ze dit kunnen afdrukkken. Dit is nog niet beschikbaar, maar wordt binnenkort geïmplementeerd in de preview.

Responsief ontwerp

We zijn overgestapt op een responsieve indeling om de uitmuntende ervaring voor mobiele apparaten, tablets en pc's te kunnen leveren waar u om hebt gevraagd op UserVoice. Gebruikers kunnen op de knop Opties klikken om opties uit of samen te vouwen en dezelfde opties weer te geven als voor een bureaubladweergave.

Responsief paginaontwerp

Bijdragen van de community

Alle documentatie op docs.microsoft.com is open source en is ontworpen voor bijdragen van de community. Deze aanpak volgt die van andere teams bij Microsoft die hun documentatie al gedeeltelijk of volledig open source hebben gemaakt, zoals ASP.NET, Azure, .NET Core en Microsoft Graph.

Elk artikel heeft een knop Bewerken (hieronder aangegeven) waarmee u naar het Markdown-bronbestand in GitHub kunt gaan om eenvoudig een pull-aanvraag voor een inhoudscorrectie of -verbetering te verzenden.

Feedbackmethoden

We vinden uw vragen, opmerkingen en feedback belangrijk. We hebben samengewerkt [Livefyre](https://web.livefyre.com/) om opmerkingen en Sidenotes te geven voor al onze artikelen. Boven aan elk artikel ziet u een koppeling voor opmerkingen, zoals hieronder wordt weergegeven.

De koppeling Opmerkingen

Als u op Opmerkingen klikt, gaat u naar de onderkant van de pagina waar u zich kunt aanmelden (met referenties voor Twitter, Facebook, Google, Yahoo of Microsoft) om opmerkingen toe te voegen, te volgen of leuk te vinden.

Opmerkingen onder aan de pagina

U kunt Sidenotes of notities ook toevoegen aan elke alinea met inhoud of aan speciaal geselecteerde inhoud. Als u dit wilt doen, plaatst u de muisaanwijzer op het opmerkingensymbool aan de rechterkant en klikt u op dit symbool om een inlineopmerking toe te voegen.

Voorbeeld sidenote

Delen op social media

Met de knop voor delen boven aan de pagina kunt u de pagina eenvoudig delen op Twitter en Facebook.

Delen op Twitter en Facebook

U kunt ook de muisaanwijzer gebruiken om inhoud van een artikel te selecteren om een opmerking toe te voegen of de inhoud rechtstreeks te delen op Twitter of Facebook, zoals hieronder is weergegeven.

Inhoud selecteren en een opmerking toevoegen of de inhoud delen

Beschrijvende URL's

We vinden een goede webervaring belangrijk en één ding dat ons regelmatig dwarszat wanneer we TechNet en MSDN gebruikten, was dat artikelen geen beschrijvende, leesbare URL's hadden. Hier volgt een voorbeeld van hetzelfde artikel met onze nieuwe URL's.

  • Voordat:<https://technet.microsoft.com/library/dn646983.aspx>

  • Na:<https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune>

Websitethema's

We hebben ook een themakiezer toegevoegd aan artikelen waarmee u tussen een licht en donker thema kunt wisselen, iets waar sommigen van u om hebben gevraagd op UserVoice.

Kiezer voor licht en donker thema

In de onderstaande afbeelding ziet u het verschil tussen het lichte en het donkere thema.

Licht en donker thema

Basisprincipes

Fundamentele voorzieningen als siteprestaties zijn van groot belang en veel klanten hebben ons op UserVoice om verbetering gevraagd. De laadtijden voor pagina's op docs.microsoft.com zijn tussen 50 en 300% sneller en de geografische distributie is beter dan ooit tevoren. We hebben ook gebouwd op een architectuur die 100% wordt uitgevoerd in Azure.

We stellen uw feedback zeer op prijs!

We hopen dat deze preview-versie van docs.microsoft.com u bevalt en we ontvangen graag uw feedback via https://aka.ms/sitefeedback. In toekomstige berichten bespreken we onze plannen om de ervaring voor referentie-inhoud en onze plannen voor lokalisatie van inhoud aanzienlijk te verbeteren.