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 aan van onze nieuwe documentatieservice /. Deze service bevat inhoud ter ondersteuning van 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 *alleen* documentatie voor Enterprise Mobility (bestaande uit Advanced Threat Analytics, Azure Active Directory, Azure RemoteApp, 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.

Belangrijke functies

Laten we beginnen met het onderstaande voorbeeld van een documentatiepagina zodat we u een paar van de nieuwe functies op de site kunnen laten zien.

Leesbaarheid

Ter verbetering van de leesbaarheid hebben we een vaste inhoudsbreedte ingesteld. Uit onderzoek naar de bewegingen van de ogen is gebleken dat begrip en leessnelheid kunnen worden verbeterd met een vaste inhoudsbreedte omdat het voor de ogen 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. Ook hebben we de tekengrootte voor het linkernavigatiegedeelte en de tekst zelf vergroot, een wijziging die is aangevraagd door klanten (UserVoice - Increase Font size (Tekengrootte vergroten)).

Geschatte leestijd

Een andere eenvoudige verbetering die we hebben aangebracht op basis van uw input, is de informatie over de geschatte leestijd voor een artikel. We zijn ons ervan bewust dat velen van u technologieën leren gebruiken of deze evalueren tijdens de paar minuten die u hebt tussen alle vergaderingen door en het lijkt ons dan ook waarschijnlijker dat u een artikel gaat lezen als u weet hoeveel tijd u hier ongeveer mee kwijt bent. 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.

Inhoud en sitenavigatie

Een belangrijk verbeterpunt dat is voortgekomen uit interviews met klanten en UserVoice-feedback, is de betere afstemming van de sitenavigatie, informatiearchitectuur en indeling van de inhoud op 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:

Dezelfde categorisering wordt gebruikt voor het linkernavigatiegedeelte van artikelen:

Lengte artikelen ingekort

Andere algemene feedback had betrekking op het feit dat de inhoud af en toe enigszins overweldigend kan zijn vanwege de lengte en dat het lastig kan zijn om in lange artikelen te navigeren en de gewenste informatie te vinden. Daarom hebben we een groot aantal langere artikelen opgedeeld in kleinere, logische stappen en onder aan elk artikel de knoppen Vorige en Volgende toegevoegd om tussen de stappen in een tutorial te kunnen navigeren. Zie het voorbeeld hieronder.

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.

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. Daarom hebben we het in samenwerking met Livefyre mogelijk gemaakt om opmerkingen en Sidenotes toe te voegen aan al onze artikelen. Boven aan elk artikel ziet u een koppeling voor opmerkingen, zoals hieronder is weergegeven.

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.

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.

Delen op social media

Met de knop voor delen boven aan de pagina kunt u de pagina eenvoudig 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.

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. Hieronder ziet u een voorbeeld van hetzelfde artikel met de nieuwe URL's.

• Voor: https://technet.microsoft.com/en-us/library/dn646983.aspx

• Na: /en-us/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.

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

Basisbeginselen

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. Ook hebben we een architectuur gebruikt die volledig op Azure wordt uitgevoerd.

Geef ons uw feedback

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 gaan we in op onze plannen om de ervaring voor referentiemateriaal aanzienlijk te verbeteren en de plannen voor lokalisatie van de inhoud.