Stack Overflow Documentation pro vývojáře používající technologie Microsoftu
Autorem tohoto článku je Jeff Sandquist, šéf oddělení Cloud + Enterprise.
Dnes oznamujeme partnerství s komunitou Stack Overflow, které zajistí vývojářům používajícím technologie Microsoftu přístup k obsahu Stack Overflow Documentation. V rámci tohoto oznámení oznamujeme, že obsah dokumentace ke Stack Overflow bude v budoucnu integrován do referenčního obsahu rozhraní API docs.microsoft.com . Microsoft je již dlouho partnerem pro Stack Overflow ve formě sponzorovaných značek a spuštění dokumentace ke službě Stack Overflow umožňuje komunitě snadno vytvářet ukázky kódu a hlasovat o ní pomocí rozhraní .NET Framework, Xamarin a dalších produktů a technologií Microsoftu.
Sdílené cíle
Docs.microsoft.com i Stack Overflow měly společné cíle – chceme, aby komunita snadno a jednoduše přispěla skvělou dokumentací k používání produktů a služeb. Obě sady obsahu mají otevřenou licenci, používají markdown jako formát obsahu a snadno umožňují příspěvky komunity (na libovolné docs.microsoft.com stránce klikněte na Upravit).
Rychlá prohlídka Stack Overflow pro vývojáře .NET
Když se poprvé dostanete do dokumentace k StackOverflow, najdete známé kategorizace témat na základě značek, která jsou k dispozici. Na první pohled uvidíte všechny značky vytvořené komunitou StackOverflow. Jakmile vyfiltrujete podle značky, zobrazí se seznam každé z nich s několika důležitými metrikami zobrazenými přímo před sebou – počet žádostí o téma, navrhované změny a žádosti o vylepšení.
Žádost o téma
Jen málo vývojářů vyřešilo složité problémy bez pomoci cílové skupiny StackOverflow. Společně s kolegy, kolegy a legendami z komunity, kteří monitorují StackOverflow pro otázky související s jejich vlastními produkty, jsme vytvořili síť informací uspořádaných podle značek. Dokumentace se zaměřuje na závazek publika ke kolektivnímu budování znalostí tím, že nám poskytuje místo, kde můžeme požádat o pomoc – oddíl "Požadovaná témata" každé značky poskytuje komunitě místo pro identifikaci běžných problémů.
Kliknutím na Vytvořit téma můžete vytvořit obsah tématu, poskytnout vlastní ukázky kódu a dokumentaci. Prostředí poskytuje pokyny k tomu, kde se jednotlivé části obsahu poskytují. Pokud chcete, můžete je upravit pomocí syntaxe Markdownu. Při vytváření témat se váš postup uloží v pravém navigačním panelu, kde uvidíte veškerý koncept obsahu, který jste ještě nedokončili nebo neodeslali ke kontrole.
Známé prostředí pro zobrazení kódu
Stejně jako u webu StackOverflow Q&A je kód pro jednotlivá témata prezentován v jasném a stručném formátu, takže můžete kopírovat a upravovat nebo se učit z jednoduchého čtení kódu. Vývojáři můžou vzorky kódu hlasovat nahoru nebo dolů stejně jako odpovědi na Stack Overflow.
Budoucí integrace
V budoucnu bude docs.microsoft.com integrovat kurátorovaný seznam ukázek dokumentace Stack Overflow přímo do dokumentace rozhraní Microsoft API. Vývojáři, kteří se dívají na referenční informace k rozhraní Microsoft API, uvidí ukázky vytvořené Microsoftem i ukázky služby Stack Overflow vytvořené komunitou. Ukázky budou kurátorované, aby se zajistilo, že ukázky kódu budou používat zavedené pokyny a osvědčené postupy pro kódování .NET. Další podrobnosti o této integraci zveřejníme v budoucnu.