Stack Overflow-dokumentation för Microsoft-utvecklare
Det här inlägget har skrivits av Jeff Sandquist, General Manager inom Cloud + Enterprise-avdelningen.
Idag meddelar vi ett samarbete med Stack Overflow för att stödja Stack Overflow-dokumentation för Microsoft-utvecklare. Som en del av det här meddelandet meddelar vi att Stack Overflow-dokumentationsinnehåll kommer att integreras i docs.microsoft.com API-referensinnehåll i framtiden. Microsoft har länge varit partner med Stack Overflow i form av sponsrade taggar, och lanseringen av Stack Overflow-dokumentationen gör det möjligt för communityn att enkelt skapa och rösta på kodexempel med hjälp av .NET Framework, Xamarin och andra Produkter och tekniker från Microsoft.
Delade mål
Både docs.microsoft.com och Stack Overflow hade delade mål – vi vill göra det enkelt och enkelt för communityn att bidra med bra dokumentation för användning av produkter och tjänster. Båda innehållsuppsättningarna har en öppen licens, använder markdown som innehållsformat och aktiverar enkelt bidrag från communityn (klicka på Redigera från valfri docs.microsoft.com sida).
En snabb genomgång av Stack Overflow för .NET-utvecklare
När du först kommer till StackOverflow-dokumentationen hittar du den välbekanta taggbaserade kategoriseringen av de ämnen som är tillgängliga. Vid första anblicken ser du alla taggar som skapats tidigare av StackOverflow-communityn. När du filtrerar efter tagg visas en lista över var och en med några viktiga mått som visas direkt – antalet ämnesbegäranden, föreslagna ändringar och förbättringsbegäranden.
Begära ett ämne
Få utvecklare har löst svåra problem utan hjälp av StackOverflow-publiken. Tillsammans med våra kollegor, kollegor och förklaringar från communityn som övervakar StackOverflow för frågor som rör deras egna produkter har vi skapat ett nätverk med information som organiseras efter taggar. Dokumentationen bygger på målgruppens engagemang för att samla kunskap genom att ge oss en plats där vi kan be om hjälp – avsnittet "Begärda ämnen" i varje tagg ger communityn en plats för att identifiera vanliga problem.
Genom att klicka på "Skapa ämne" kan du skapa innehåll för ämnet, ange egna kodexempel och dokumentation. Upplevelsen ger vägledning om var du kan ange varje avsnitt med innehåll, som kan redigeras med Markdown-syntax om du vill. När du skapar ämnen sparas förloppet i rätt navigering, där du kan se allt utkastinnehåll som du ännu inte har slutfört eller skickat för granskning.
Välbekanta funktioner för kodvisning
Precis som med StackOverflow Q&A-webbplatsen visas koden för enskilda ämnen i ett tydligt, koncist format så att du kan kopiera och redigera eller lära dig av att bara läsa koden. Utvecklare kan samla in och ned röstkodexempel precis som svar på Stack Overflow.
Framtida integrering
I framtiden kommer docs.microsoft.com att integrera en granskad lista över Stack Overflow-dokumentationsexempel direkt i Microsoft API-dokumentationen. Utvecklare som tittar på Microsoft API-referens ser både exempel som skapats av Microsoft samt Stack Overflow-exempel som skapats av communityn. Exemplen kommer att kureras för att säkerställa att kodexempel använder etablerade riktlinjer och metodtips för .NET-kodning. Vi kommer att släppa mer information om den här integreringen i framtiden.