Documentazione di Stack Overflow per gli sviluppatori Microsoft

Questo articolo è stato scritto da Jeff Sandquist, General Manager di Cloud + Enterprise Division.

Oggi annunciamo una partnership con Stack Overflow per supportare la documentazione di Stack Overflow per gli sviluppatori Microsoft. Come parte di questo annuncio, annunciamo che il contenuto della documentazione di Stack Overflow verrà integrato in docs.microsoft.com contenuto di riferimento dell'API in futuro. Microsoft è stato a lungo partner con Stack Overflow sotto forma di tag sponsorizzati e il lancio della documentazione di Stack Overflow consente alla community di avere un modo semplice per creare e votare esempi di codice usando .NET Framework, Xamarin e altri prodotti e tecnologie Microsoft.

Obiettivi condivisi

Sia docs.microsoft.com che Stack Overflow hanno avuto obiettivi condivisi: vogliamo semplificare e semplificare per la community contribuire alla documentazione ottimale per l'uso di prodotti e servizi. Entrambi i set di contenuti hanno una licenza aperta, usano markdown come formato di contenuto e consentono facilmente i contributi della community (fare clic su Modifica da qualsiasi pagina di docs.microsoft.com).

Panoramica rapida di Stack Overflow per sviluppatori .NET

Quando si arriva per la prima volta alla documentazione di StackOverflow, si noterà la familiare categorizzazione basata su tag degli argomenti disponibili. A prima vista verranno visualizzati tutti i tag creati in precedenza dalla community di StackOverflow. Dopo aver filtrato in base al tag, viene visualizzato un elenco di ognuna con alcune metriche importanti visualizzate immediatamente, ovvero il numero di richieste di argomenti, modifiche proposte e richieste di miglioramento.

Searching for content using tags

Richiedere un argomento

Pochi sviluppatori hanno risolto problemi difficili senza l'aiuto del gruppo di destinatari di StackOverflow. Insieme ai colleghi, ai colleghi e alle legende della community che monitorano StackOverflow per domande relative ai propri prodotti, abbiamo creato una rete di informazioni organizzate in base ai tag. La documentazione capitalizza l'impegno del pubblico a costruire collettivamente le conoscenze fornendoci un posto per chiedere aiuto: la sezione "Argomenti richiesti" di ogni tag offre alla community un luogo in cui identificare i problemi comuni.

Requested topics

Facendo clic su "Crea argomento", è possibile creare contenuto per l'argomento, fornire esempi di codice e documentazione personalizzati. L'esperienza fornisce indicazioni su dove fornire ogni sezione del contenuto, che può essere modificata usando la sintassi Markdown, se si preferisce. Durante la creazione di argomenti, lo stato di avanzamento viene salvato nel riquadro di spostamento corretto, in cui è possibile visualizzare tutto il contenuto bozza non ancora completato o inviato per la revisione.

Creating a new topic

Esperienza di visualizzazione del codice familiare

Come per il sito StackOverflow Q&A, il codice per i singoli argomenti viene presentato in formato chiaro e conciso, in modo da poter copiare l'uso della modifica o apprendere semplicemente leggendo il codice. Gli sviluppatori possono votare esempi di codice esattamente come le risposte in Stack Overflow.

Existing topic

Integrazione futura

In futuro, docs.microsoft.com integrerà un elenco curato di esempi di documentazione di Stack Overflow direttamente nella documentazione dell'API Microsoft. Gli sviluppatori che esaminano le informazioni di riferimento sulle API Microsoft vedranno entrambi gli esempi creati da Microsoft e gli esempi di Stack Overflow creati dalla community. Gli esempi verranno curati per garantire che gli esempi di codice usino le linee guida e le procedure consigliate per la codifica .NET stabilite. Verranno rilasciati altri dettagli su questa integrazione in futuro.