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, si annuncia che il contenuto della documentazione di Stack Overflow verrà integrato in docs.microsoft.com contenuto di riferimento dell'API in futuro. Microsoft è stato un partner con Stack Overflow sotto forma di tag sponsorizzati e l'avvio di Stack Overflow Documentation consente alla community di avere un modo semplice per creare e votare sugli 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 a una documentazione ottimale per l'uso di prodotti e servizi. Entrambi i set di contenuti hanno una licenza aperta, usare markdown come formato del contenuto e abilitare facilmente i contributi della community (fare clic su Modifica da qualsiasi pagina docs.microsoft.com).

Panoramica rapida di Stack Overflow per sviluppatori .NET

Quando si arriva prima alla documentazione di StackOverflow, si troverà la categorizzazione familiare basata su tag degli argomenti disponibili. A prima vista verranno visualizzati tutti i tag precedenti creati dalla community stackOverflow. Dopo aver filtrato per tag, viene visualizzato un elenco di ognuna con alcune metriche importanti visualizzate in primo piano, ovvero il conteggio delle richieste di argomento, le modifiche proposte e le richieste di miglioramento.

Ricerca di contenuto tramite tag

Richiedere un argomento

Alcuni sviluppatori hanno risolto problemi difficili senza l'aiuto del pubblico stackOverflow. Insieme ai colleghi, ai peer e alle legende della community che monitorano StackOverflow per domande correlate ai propri prodotti, è stata creata una rete di informazioni organizzate da tag. La documentazione capitalizza l'impegno del pubblico per costruire collettivamente le conoscenze fornendoci un posto per chiedere aiuto - la sezione "Argomenti richiesti" di ogni tag offre alla community un luogo per identificare i problemi comuni.

Argomenti richiesti

Facendo clic su "Crea argomento", è possibile creare contenuto per l'argomento, specificare 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.

Creazione di un nuovo argomento

Esperienza di visualizzazione del codice familiare

Come per il sito StackOverflow Q&A, il codice per singoli argomenti viene presentato in formato chiaro e conciso in modo da poter copiare o imparare semplicemente a leggere il codice. Gli sviluppatori possono aumentare o ridurre gli esempi di codice di voto esattamente come le risposte in Stack Overflow.

Argomento esistente

Integrazione futura

In futuro, docs.microsoft.com integra un elenco curato di esempi di documentazione di Stack Overflow direttamente nella documentazione dell'API Microsoft. Gli sviluppatori che esaminano i riferimenti alle 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 linee guida di codifica .NET stabilite e procedure consigliate. In futuro verranno rilasciati altri dettagli su questa integrazione.