Stack Overflow-Dokumentation für Microsoft-Entwickler

Dieser Beitrag wurde vom Geschäftsführer der Abteilung „Cloud + Enterprise“, Jeff Sandquist, verfasst.

Heute geben wir unsere Partnerschaft mit Stack Overflow bekannt, mit der wir die Stack Overflow-Dokumentation für Microsoft-Entwickler unterstützen. Im Rahmen dieser Ankündigung informieren wir Sie darüber, dass die Inhalte der Stack Overflow-Dokumentation zukünftig in die API-Referenzmaterialien unter „docs.microsoft.com“ integriert werden. Microsoft ist seit langem Partner von Stack Overflow in Form von gesponserten Tags, und die Einführung der Stack Overflow-Dokumentation bietet der Community eine einfache Möglichkeit, Codebeispiele mit dem .NET Framework, Xamarin und anderen Microsoft-Produkten und -Technologien zu erstellen und darüber abzustimmen.

Gemeinsame Ziele

Stack Overflow und „docs.microsoft.com“ hatten gemeinsame Ziele: Wir möchten der Community das einfache Bereitstellen guter Dokumentationen für die Verwendung von Produkten und Diensten ermöglichen. Beide Inhaltskomponenten verfügen über eine offene Lizenz, verwenden Markdown als Inhaltsformat und ermöglichen das einfache Übermitteln von Communitybeiträgen (auf beliebiger „docs.microsoft.com“-Seite auf „Bearbeiten“ klicken).

Kurze Tour durch Stack Overflow für .NET-Entwickler*innen

Wenn Sie zum ersten Mal die Stack Overflow-Dokumentation nutzen, finden Sie die Ihnen vertraute tagbasierte Kategorisierung der verfügbaren Themen vor. Auf den ersten Blick sehen Sie alle zuvor von der Stack Overflow-Community erstellten Tags. Wenn Sie nach Tags gefiltert haben, wird direkt vorne jeweils eine Liste mit wichtigen Metriken angezeigt: die Anzahl der Themenanforderungen, vorgeschlagenen Änderungen und Verbesserungsanforderungen.

Searching for content using tags

Anfordern eines Themas

Nur wenige Entwickler*innen haben schwierige Probleme ohne die Hilfe der Stack Overflow-Community gelöst. Zusammen mit unseren Kolleg*innen und Legenden aus der Community, die Stack Overflow auf Fragen im Zusammenhang mit ihren eigenen Produkten überwachen, haben wir ein Netzwerk von Informationen erstellt, die nach Tags organisiert sind. Die Dokumentation setzt auf das Engagement der Community, gemeinsam Wissen aufzubauen, indem ein Ort geschaffen wird, an dem um Hilfe gebeten werden kann. Der Abschnitt „Angeforderte Themen“ jedes Tags bietet der Community die Möglichkeit, um häufige Probleme zu identifizieren.

Requested topics

Durch Klicken auf „Thema erstellen“ können Sie Inhalte für das Thema erstellen und Ihre eigenen Codebeispiele und Ihre Dokumentation bereitstellen. Die Benutzeroberfläche enthält Anleitungen dazu, wo sie die einzelnen Inhaltsabschnitte bereitstellen können, die bei Bedarf mithilfe der Markdownsyntax bearbeitet werden können. Wenn Sie Themen erstellen, wird Ihr Fortschritt im rechten Navigationsbereich gespeichert. Dort finden Sie alle Entwurfsinhalte, die Sie noch nicht abgeschlossen oder zur Überprüfung gesendet haben.

Creating a new topic

Vertraute Codeanzeigefunktion

Wie bei der Q&A-Website von Stack Overflow wird der Code für einzelne Themen in einem klaren, präzisen Format dargestellt, sodass Sie den Code einfach kopieren, bearbeiten und verwenden können oder etwas Neues lernen, indem Sie den Code einfach nur lesen. Entwickler*innen können Codebeispiele wie Antworten in Stack Overflow positiv oder negativ bewerten.

Existing topic

Zukünftige Integration

In Zukunft wird „docs.microsoft.com“ eine zusammengestellte Liste mit Stack Overflow-Dokumentationsbeispielen direkt in die Microsoft-API-Dokumentation integrieren. Wenn Entwickler*innen die Microsoft-API-Referenz lesen, werden ihnen sowohl von Microsoft erstellte Beispiele als auch Stack Overflow-Beispiele angezeigt, die von der Community erstellt wurden. Die Beispiele werden zusammengestellt, um sicherzustellen, dass Codebeispiele bewährte .NET-Programmierungsrichtlinien und bewährte Methoden verwenden. Wir werden in Zukunft weitere Details zu dieser Integration veröffentlichen.