Introduktion till docs.microsoft.com
Det här inlägget har skrivits av Jeff Sandquist, General Manager inom Cloud + Enterprise-avdelningen.
Idag presenterar vi förhandsversionen av vår nya dokumentationstjänst /, med innehåll för våra Enterprise Mobility-produkter.
Varför docs.microsoft.com?
Kort sagt, innehåll är viktigt. Vi har intervjuat och genomfört undersökningar bland hundratals utvecklare och IT-proffs och gått igenom er webbplatsfeedback under åren på UserVoice. Det var tydligt att vi behövde genomföra en förändring och skapa ett modernt webbgränssnitt för innehåll. Det första vi gjorde var att utvärdera vår befintliga innehållsinfrastruktur TechNet och MSDN. Båda webbplatserna bygger på en 10–15 år gammal sårbar kodbas med ett omodernt publicerings- och distributionssystem som aldrig utformades för att köras i molnet.
Vår fokus låg inte bara på gränssnittet, utan även på innehållet vi skapar och hur du använder det. I flera år har kunder bett oss att gå längre än textmängder med innehåll på funktionsnivå och hjälpa dem att implementera lösningar på deras affärsproblem. Vi visste att innehållet vi levererade och plattformen vi byggde måste göra det enkelt för kunderna att lära sig och distribuera lösningar.
Vi insåg att det var bäst att börja om från början och skapa en ny, enhetlig användarupplevelse. Resultatet blev https://docs.microsoft.com – Microsofts uppdaterade dokumentationsmiljö.
Obs! Den här förhandsversionen av webbplatsen innehåller *endast* innehåll för Enterprise Mobility-dokumentation (som består av Advanced Threat Analytics, Azure Active Directory, Azure RemoteApp, Multi-Factor Authentication, Azure Rights Management, Intune och Microsoft Identity Manager). I framtiden, i och med att vår plattform utvecklas med hjälp av feedback, kommer vi att migrera mer av vår dokumentation till det här gränssnittet.
Viktiga funktioner
Vi börjar med ett exempel på en dokumentationssida som visas nedan, där vi kan demonstrera några av de nya funktionerna på webbplatsen.
Läsbarhet
För att förbättra innehållets läsbarhet har vi ändrat till fast innehållsbredd på webbplatsen. Studier av ögonrörelser har visat att det går att förbättra förståelse och läshastighet med en fast innehållsbredd eftersom det är svårt för ögat att följa långa textavsnitt från vänster till höger. För att åskådliggöra det visas nedan ett exempel på en Intune-artikel på docs.microsoft.com följt av samma artikel på TechNet. Vi har också ökat teckenstorleken för navigeringen till vänster och själva texten, något som kunder har efterfrågat (UserVoice - öka teckenstorleken).
Beräknad lästid
En annan enkel förbättring vi har gjort utifrån feedback är att visa en beräknad lästid för en artikel. Vi vet att många av er undersöker/utvärderar teknik under några minuter mellan möten och att det är mer troligt att du läser artiklar om du vet hur lång tid det tar. Vi har även lagt till datumstämplar i innehåll så att kunderna ser hur ny informationen är utifrån UserVoice-feedback.
Innehåll och webbplatsnavigering
En viktig del utifrån kundintervjuer och UserVoice-feedback var förbättringar av webbplatsnavigering, informationsarkitektur och innehållsorganisation utifrån kundens avsikt. Vi omstrukturerade innehållet i logiska grupper kring utvärdera, komma igång, planera, distribuera, hantera och felsöka produkter och tjänster. Innehållet är uppdelat både i navigeringen till vänster och på våra produkt-/tjänstsidor.
Nedan visas en skärmbild av startsidan för Intune-dokumentation:
Samma kategorisering finns även i navigeringen till vänster i artiklar:
Kortare artiklar
En annan vanlig typ av feedback var att innehållet ibland kan vara överväldigande på grund av dess längd och att det är svårare att navigera och hitta det du söker i långa artiklar. För att lösa det har vi delat upp många längre artiklar i kortare logiska steg och lagt till knapparna Föregående och Nästa längst ned i artiklar för att navigera mellan stegen i självstudier med flera delar enligt vad som visas nedan.
Även om många kunder vill ha möjligheten till självstudier i flera delar, har vi också hört från kunder som vill kunna sätta ihop självstudier med flera steg till en enda PDF-fil som kan användas offline och som kan skrivas ut. Vi har inte ordnat det ännu, men det kommer snart att finnas i förhandsversionen.
Dynamisk design
För att skapa ett bra gränssnitt på mobila enheter, surfplattor och datorer som har efterfrågats på UserVoice har vi bytt till en responsiv layout. Om du klickar på Alternativ visas/döljs samma alternativ i en skrivbordsvy.
Communitybidrag
All dokumentation på docs.microsoft.com bygger på öppen källkod och är utformad för att tillåta communitybidrag. Det följer andra team på Microsoft som redan har använt öppen källkod för all eller viss dokumentation, inklusive ASP.NET, Azure, .NET Core och Microsoft Graph.
I alla artiklar finns en redigeringsknapp (visas nedan) som leder till markdown-källfilen i GitHub. Där kan du enkelt skicka en pullbegäran om att rätta eller förbättra innehållet.
Feedbackmekanismer
Dina frågor, kommentarer och feedback är viktig för oss. Vi samarbetar med Livefyre för att erbjuda kommentarer och sidoanteckningar i alla våra artiklar. Längst upp i alla artiklar visas en länk för kommentarer enligt nedan.
Om du klickar på kommentarer hamnar du längst ned på sidan där du kan logga in (med autentiseringsuppgifter för Twitter, Facebook, Google, Yahoo eller Microsoft) och lägga till, följa eller gilla kommentarer.
Du kan också lägga till sidoanteckningar eller anteckningar i varje stycke med innehåll eller specifikt markerad text. Klicka med pekaren på kommentarssymbolen till höger om du vill lägga till en infogad kommentar.
Social delning
Med delningsknappen längst upp på sidan kan du enkelt dela med Twitter och Facebook.
Du kan också markera innehåll i en artikel med pekaren och lägga till en kommentar eller dela på Twitter eller Facebook direkt från snabbmenyn enligt nedan.
Tydliga webbadresser
Webbgränssnittet är viktigt och en sak som regelbundet har stört oss som användare av TechNet och MSDN är att artiklarna inte hade tydliga, läsbara webbadresser. Här är ett exempel på samma artikel med våra nya webbadresser.
Före: https://technet.microsoft.com/en-us/library/dn646983.aspx
Efter: /en-us/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune
Webbplatsteman
Vi har även lagt till en temaväljare i artiklar så att du kan ändra mellan ljust och mörkt tema, något som vissa har efterfrågat på UserVoice.
På bilden nedan visas skillnaden mellan det ljusa och det mörka temat.
Grunderna
Grunder som webbplatsprestanda är en viktig del och något som många kunder har bett oss att förbättra på UserVoice. Sidinläsningstiden på docs.microsoft.com är 50–300 % snabbare och vi är bättre fördelade geografiskt än någonsin tidigare. Vi har också byggt på en arkitektur som till 100 % körs på Azure.
Vi vill ha din feedback!
Vi hoppas att du gillar förhandsversionen av docs.microsoft.com. Skicka gärna feedback till https://aka.ms/sitefeedback. I kommande inlägg kommer vi att diskutera våra planer för att avsevärt förbättra gränssnittet för referensinnehåll och våra planer för översättning av innehåll.