Documentation Stack Overflow pour les développeurs Microsoft

Cet article a été écrit par Jeff Sandquist, Directeur Général de la division Cloud + Enterprise.

Nous lançons aujourd’hui un partenariat avec Stack Overflow afin de prendre en charge la documentation Stack Overflow pour les développeurs Microsoft. Dans le cadre de cette annonce, nous avons annoncé que Stack Overflow contenu de documentation sera intégré au contenu de référence de l’API docs.Microsoft.com à l’avenir. Microsoft a longtemps été un partenaire de Stack Overflow sous forme de balises parrainées, et le lancement de Stack Overflow Documentation permet à la communauté d’avoir un moyen simple de créer et de voter dans des exemples de code à l’aide de la .NET Framework, Xamarin et d’autres produits et technologies Microsoft.

Objectifs partagés

Docs.microsoft.com et Stack Overflow avaient des objectifs partagés. nous souhaitons faciliter et simplifier la tâche de la communauté en matière d’utilisation des produits et services. Les deux ensembles de contenu ont une licence ouverte, utilisent la démarque comme format de contenu et permettent facilement les contributions de la Communauté (cliquez sur modifier à partir de n’importe quelle page docs.microsoft.com).

Présentation rapide des Stack Overflow pour les développeurs .NET

Lorsque vous accédez pour la première fois à la documentation de StackOverflow, vous trouverez la catégorisation familière des rubriques disponibles. À première vue, vous verrez toutes les balises créées précédemment par la communauté StackOverflow. Une fois que vous avez filtré par balise, une liste de chacun s’affiche avec quelques métriques importantes indiquées à l’avance le nombre de demandes de rubrique, les modifications proposées et les demandes d’amélioration.

Recherche de contenu à l’aide de balises

Demander une rubrique

Peu de développeurs ont résolu des problèmes difficiles sans l’aide du public StackOverflow. En collaboration avec nos collègues, pairs et légendes de la communauté qui surveillent StackOverflow pour des questions relatives à leurs propres produits, nous avons créé un réseau d’informations organisé par des balises. La documentation insiste sur l’engagement de l’assistance pour créer collectivement des connaissances en nous permettant de demander de l’aide : la section « rubriques demandées » de chaque balise donne à la communauté un emplacement pour identifier les problèmes courants.

Rubriques demandées

En cliquant sur « créer une rubrique », vous pouvez créer du contenu pour la rubrique, fournir vos propres exemples de code et la même documentation. L’expérience fournit des conseils sur l’emplacement de chaque section de contenu, qui peut être modifiée à l’aide de la syntaxe de démarque si vous préférez. Lorsque vous créez des rubriques, votre progression est enregistrée dans la navigation de droite, où vous pouvez voir tout le contenu du brouillon que vous n’avez pas encore terminé ou envoyé pour révision.

Création d’une rubrique

Expérience d’affichage de code familière

Comme avec le site StackOverflow Q & a, le code pour les rubriques individuelles est présenté de façon claire et concise, ce qui vous permet de copier-modifier-utiliser ou de lire simplement le code. Les développeurs peuvent obtenir des exemples de code de vote, tout comme les réponses sur Stack Overflow.

Rubrique existante

Intégration future

À l’avenir, docs.microsoft.com intègre une liste organisée d’exemples de documentation Stack Overflow directement dans la documentation de l’API Microsoft. Les développeurs qui regardent les informations de référence sur les API Microsoft voient les exemples créés par Microsoft ainsi que les exemples de Stack Overflow créés par la communauté. Les exemples sont organisés pour s’assurer que les exemples de code utilisent les instructions de codage .NET établies et les meilleures pratiques. Nous publierons plus de détails sur cette intégration à l’avenir.