Aggiornamento sulla migrazione di MSDN e TechNet a docs.microsoft.com

  • Articolo

Questo post è stato scritto da Jeff Sandquist, Corporate Vice President, Developer Relations.

Oggi siamo lieti di offrire un importante aggiornamento sulla migrazione del contenuto dei siti MSDN e TechNet a docs.microsoft.com. In questo post di blog sono documentati gli ultimi passaggi di un impegno esteso a tutta l'azienda per la revisione della struttura del contenuto, del formato e dell'infrastruttura sottostante per la centralizzazione della documentazione tecnica Microsoft in un solo sito.

Da MSDN e TechNet a docs.microsoft.com

Microsoft Developer Network è nato nel lontano 1992 come servizio in abbonamento per i clienti per fornire informazioni tecniche sulla programmazione per Windows. Sei anni dopo, nel 1998, è stato lanciato il sito MSDN Online che ospitava più di 250.000 pagine di contenuto.

Screenshot di MSDN Online nel 1999

A quei tempi, il processo di pubblicazione comprendeva la creazione di contenuto in Microsoft Word, la relativa conversione in HTML e la pubblicazione tramite uno strumento denominato pubwiz (Publishing Wizard). Per più di 20 anni il processo ha supportato il rilascio di nuovi prodotti, servizi e aggiornamenti, con il risultato incredibile di ben 45 milioni di pagine di contenuto tecnico.

Dato che il ciclo di rilascio dei prodotti si è ridotto da anni a mesi, è aumentata la richiesta di documentazione aggiornata accessibile. Il sistema di pubblicazione doveva adattarsi alla velocità di progettazione e si è quindi deciso di reinventare la modalità di gestione della documentazione Microsoft nell'era del cloud. Nel novembre 2015, i membri fondatori del team di docs.microsoft.com, ovvero Dan Fernandez, Mary McHale, Carol Zeumault e Jeff Sandquist, hanno scritto un documento intitolato "A New Hope" ("Una nuova speranza" in omaggio a Guerre Stellari Episodio IV), che illustrava la visione del nuovo sito. Il documento delineava un gruppo di principi chiave:

  • Documentazione tecnica unificata. Il nuovo sito deve consolidare le decine di siti Web di documentazione ospitati da Microsoft. Uno sviluppatore che vuole apprendere come creare un'app Web basata sui dati deve avere la possibilità di visitare un solo sito per trovare tutti i contenuti rilevanti per ASP.NET, Azure, Entity Framework o qualsiasi altra tecnologia Microsoft.
  • Esperienza utente finale migliorata. Un fattore chiave per la definizione del successo di un sito Web è l'esperienza offerta ai clienti. Il nuovo sito deve offrire prestazioni di caricamento migliori, tipi di carattere leggibili, sommari accessibili, URL comprensibili, supporto per il controllo delle versioni, compatibilità con i browser per dispositivi mobili e seguire le procedure di progettazione inclusiva tramite funzionalità accessibili e il supporto per l'internazionalizzazione.
  • Democratizzazione della creazione del contenuto e coinvolgimento della community. Il nuovo sito deve essere basato su standard e strumenti open source che permettono a chiunque di creare e modificare la documentazione. Deve usare Markdown per il contenuto, YAML per la documentazione delle API generata automaticamente e basarsi su GitHub come livello del contenuto sottostante, che consente l'uso di controlli di qualità automatizzati. L'organizzazione GitHub MicrosoftDocs si è estesa fino a più di 7.400 membri e il repository della documentazione di Azure è uno dei progetti open source a crescita più rapida (470% di anno in anno) e il quinto repository per la quantità di contributi per l'intero GitHub, come indicato nel report The State of the Octoverse 2018.
  • Supporto della documentazione relativa alle API. Il nuovo sito deve avere il supporto di prima classe per la documentazione delle API scritte per linguaggi di programmazione e piattaforme che i clienti usano, tra cui .NET, Java, Python, JavaScript e TypeScript, PowerShell, interfaccia della riga di comando di Azure, Q#, OpenAPI e altro ancora. L'esperienza dovrebbe essere basata sull'automazione, avere una copertura affidabile delle API ed essere in grado di pubblicare la documentazione delle API nel giro di pochi minuti piuttosto che di settimane.
  • Modernizzare l'infrastruttura di progettazione. docs.microsoft.com deve essere eseguito in Azure, consentendo di ridurre i costi di manutenzione (con un risparmio di più di 7 milioni di dollari), migliorare i tempi di distribuzione da ogni tre settimane a ogni giorno (o più velocemente) e ridurre la duplicazione degli interventi di progettazione.
  • Estensibile per impostazione predefinita. Con l'evolversi del sito, questo deve essere in grado di soddisfare le esigenze dei clienti nel modo più efficiente possibile. Basandosi su questo presupposto, è stato possibile creare e integrare una nuova esperienza di apprendimento interattivo, Microsoft Learn, nonché il sito per esplorare tutto il codice di esempio.

Grazie a una piattaforma moderna, è stato possibile assicurarsi che non vadano persi contenuti preziosi con la migrazione al nuovo sito. Di seguito sono disponibili altre informazioni sullo stato di avanzamento.

Librerie MSDN e TechNet

Stato: ✅ completamento

La migrazione di MSDN Library e TechNet Library a docs.microsoft.com è iniziata alla fine del 2017 e la migrazione è stata completata quest'anno.

Queste raccolte offrivano in precedenza la documentazione per i prodotti Microsoft, tra cui la documentazione delle API, il codice di esempio e gli articoli tecnici. Disponibile in origine tramite CD, il contenuto è stato spostato in seguito online con il lancio dei siti Web MSDN e TechNet.

Per la migrazione si è resa necessaria la conversione di un'ampia gamma di formati basati su XML in Markdown per il contenuto modificato manualmente e YAML per la documentazione delle API generata automaticamente, che si estende su oltre 100 diversi set di contenuti. Ci si è accertati che fossero disponibili i reindirizzamenti delle pagine per milioni di pagine Web, evitando collegamenti interrotti per riferimenti dall'esterno del sito, ad esempio blog e forum.

Per farsi un'idea del volume dei contenuti gestito, di seguito sono riportate alcune statistiche:

Nel caso di segnalibri aggiunti per qualsiasi contenuto MSDN o TechNet, i collegamenti verranno reindirizzati automaticamente alla nuova posizione in docs.microsoft.com.

MSDN Magazine

Stato: ✅ completamento

L'ultima edizione di MSDN Magazine è stata pubblicata il 1° novembre 2019. È stato inviato un messaggio finale ai lettori e agli autori nell'edizione di agosto di MSDN Magazine.

Il contenuto di MSDN Magazine pubblicato in MSDN è stato spostato in docs.microsoft.com/archive.

Gli abbonati a MSDN Magazine che hanno pagato l'abbonamento riceveranno un rimborso proporzionale, in base al tempo rimanente. Gli assegni di rimborso verranno inviati per posta dopo la pubblicazione dell'edizione di novembre. Questa modifica non ha alcun effetto sull'abbonamento MSDN Platform.

Newsletter Microsoft Developer e TechNet Flash

Stato: ✅ completamento

Le newsletter pubblicate in MSDN e TechNet sono state spostate in docs.microsoft.com/archive.

Gli attuali iscritti continueranno a ricevere queste newsletter. È possibile che il formato si evolva e venga modificato, così come la pianificazione di pubblicazione.

Se non si vogliono più ricevere le newsletter, è possibile annullare l'iscrizione dal prossimo messaggio di posta elettronica ricevuto.

Blog MSDN e TechNet

Stato: ✅ completamento

I siti dei blog MSDN e dei blog TechNet sono diventati di sola lettura da luglio 2019. I blog MSDN e TechNet sono stati migrati e archiviati in docs.microsoft.com/archive.

Se hai segnalibro qualsiasi blog MSDN o TechNet, i collegamenti a tali blog verranno reindirizzati alla nuova posizione in docs.microsoft.com/archive o ad altri siti di blog se sono attivamente gestiti e aggiornati.

Stato: ✅ completamento

Tutte le pagine di MSDN Code Gallery sono state reindirizzate al sito di esplorazione degli esempi e gli esempi chiave sono stati archiviati in GitHub nell'organizzazione MicrosoftArchive. Per altre informazioni su questo processo, vedere questo recente post di blog.

Gli esempi di codice più aggiornati sono disponibili in docs.microsoft.com/samples.

Stato: 🚧 in corso

La raccolta TechNet Gallery verrà ritirata agli inizi del 2020. Nel dicembre 2019 il sito verrà reso di sola lettura e non accetterà più i nuovi contributi della community. Seguiranno altri annunci e ulteriori informazioni.

Usare docs.microsoft.com/samples per trovare gli esempi di codice più aggiornati. Se in precedenza sono stati inviati contributi a TechNet Gallery, assicurarsi di eseguire la migrazione degli esempi in un percorso gestito personalmente, ad esempio il proprio repository GitHub.

Wiki di TechNet

Stato: 🚧 in corso

È in corso l'elaborazione di un piano e una pianificazione di migrazione più concreti per TechNet Wiki. Ulteriori dettagli saranno disponibili in seguito. Al momento è possibile continuare a partecipare e interagire con il contenuto del wiki.

Forum su MSDN e TechNet

Stato: 🚧 in corso

È stata annunciata la versione di anteprima di Microsoft Q&A, che sostituisce i forum MSDN e TechNet. Per garantire una transizione senza problemi e ridurre al minimo eventuali disservizi, la migrazione è stata suddivisa in più fasi. Il completamento della migrazione è previsto entro metà del 2020. Ulteriori dettagli saranno disponibili in seguito.

Channel 9

Stato: 🚧 in corso

Channel 9 continua a essere un investimento importante per il contenuto video destinato agli sviluppatori. È in corso di definizione un percorso di migrazione che migliorerà l'integrazione dei video e dei contenuti tecnici da Channel 9. Ulteriori dettagli saranno disponibili in seguito.

Esprimere un'opinione.

Microsoft è entusiasta di continuare a investire nella piattaforma per assicurarsi che i clienti ottengano la documentazione tecnica più rilevante e affidabile per l'intero ecosistema Microsoft. È possibile inviare, commenti, opinioni e suggerimenti per il miglioramento su GitHub e Twitter.