Introduzione a docs.microsoft.com
Questo post è stato scritto da Jeff Sandquist, General Manager nella divisione Cloud + Enterprise.
Oggi è in corso l'annuncio della versione di anteprima del nuovo servizio di documentazione https://docs.microsoft.com, con contenuti che supportano i prodotti Enterprise Mobility.
In breve, il contenuto è importante. Abbiamo intervistato e intervistato centinaia di sviluppatori e professionisti IT e abbiamo preso in considerazione il feedback del tuo sito web negli anni su UserVoice. Era chiaro che era necessario apportare una modifica e creare un'esperienza Web moderna per il contenuto. La prima cosa che abbiamo fatto è stata valutata l'infrastruttura di contenuti esistente TechNet e MSDN. Entrambi i siti sono basati su una codebase fragile di 10-15 anni con un sistema di pubblicazione e distribuzione arcaico che non è mai stato progettato per l'esecuzione nel cloud.
La nostra attenzione non era solo sull'esperienza, ma anche sul contenuto che creiamo e sul modo in cui ognuno di voi lo utilizza. Per anni i clienti ci hanno detto di andare oltre le pareti del testo con contenuti a livello di funzionalità e aiutarli a implementare soluzioni ai loro problemi aziendali. Sapevamo che il contenuto fornito e la piattaforma che abbiamo creato devono semplificare l'apprendimento e la distribuzione di soluzioni da parte dei clienti.
Ci siamo resi conto che per ottenere l'esperienza complessiva giusta abbiamo bisogno di iniziare da zero; da questo sforzo viene https://docs.microsoft.com: una nuova speranza per la documentazione in Microsoft.
Nota: questa versione di anteprima del sito Web include il contenuto *only* per la documentazione di Enterprise Mobility (che è costituito da Advanced Threat Analytics, Azure Active Directory, Azure Remote App, Multi-Factor Authentication, Azure Rights Management, Intunee Microsoft Identity Manager). In futuro, man mano che la piattaforma matura con l'aiuto dei commenti e suggerimenti, verrà eseguita la migrazione di più della documentazione in questa esperienza.
Si inizierà con una pagina di documentazione di esempio illustrata di seguito e verranno illustrate alcune delle nuove funzionalità del sito.
Esempio di documentazione
Per migliorare la leggibilità del contenuto, il sito è stato modificato in modo da avere una larghezza del contenuto impostata. studi di tracciamento oculare hanno dimostrato che è possibile migliorare la comprensione e la velocità di lettura con una larghezza del contenuto impostata perché è difficile per l'occhio seguire lunghi passaggi da sinistra a destra. Per mostrarlo in azione, di seguito è riportato un esempio di articolo di Intune in esecuzione su docs.microsoft.com seguito dallo stesso articolo su TechNet. Sono state aumentate anche le dimensioni del carattere per lo spostamento a sinistra e il testo stesso, qualcosa che i clienti hanno chiesto (UserVoice - Aumentare le dimensioni del carattere).
confronto tra
Un altro semplice miglioramento apportato in base all'input consiste nel fornire un tempo di lettura stimato per un articolo. Sappiamo che molti di voi stanno imparando/valutando la tecnologia a pochi minuti tra le riunioni e si ha maggiore probabilità di leggere articoli se si sapeva quanto è necessario un impegno di tempo. Sono stati aggiunti anche indicatori di data al contenuto per aiutare i clienti a comprendere il modo in cui le informazioni aggiornate si basano su userVoice feedback.
Un'area chiave di investimento basata su interviste ai clienti e feedback di UserVoice è stata migliorata la navigazione nel sito, l'architettura delle informazioni e l'organizzazione del contenuto in base all'intento del cliente. Il refactoring del contenuto è stato sottoposto a raggruppamenti logici per valutare, iniziare, pianificare, distribuire, gestire o risolvere i problemi relativi a prodotti o servizi. È possibile visualizzare questo contenuto suddiviso sia nel riquadro di spostamento a sinistra che nelle pagine di prodotto/servizio.
Di seguito è riportato uno screenshot della documentazione di Intune home page:
Questa stessa categorizzazione si trova anche nel riquadro di spostamento a sinistra degli articoli:
di spostamento a sinistra
Un altro elemento comune di feedback è che il contenuto a volte può essere travolgente a causa della sua lunghezza e che gli articoli lunghi sono più difficili da esplorare e trovare ciò che si sta cercando. Per risolvere questo problema, sono stati suddivisi molti articoli più lunghi in passaggi logici più piccoli e sono stati forniti i pulsanti Indietro e Avanti nella parte inferiore degli articoli per spostarsi tra i passaggi in un'esercitazione in più parti, come illustrato di seguito.
Anche se molti clienti amano la possibilità di avere esercitazioni in più parti, abbiamo sentito parlare anche dai clienti che vogliono combinare esercitazioni in più passaggi in un unico PDF compatibile con la stampante offline. Questo non è ancora disponibile, ma sarà presto disponibile per l'anteprima.
Per creare un'esperienza ottimale su dispositivi mobili, tablet e PC come richiesto in UserVoice, è stato passato a un layout reattivo. Facendo clic sul pulsante Opzioni si espande/comprime per visualizzare le stesse opzioni in una visualizzazione desktop.
Tutta la documentazione su docs.microsoft.com è open source e progettata per consentire i contributi della community. Di seguito sono riportate le orme di altri team di Microsoft che hanno già aperto la documentazione o tutte le parti della documentazione, tra cui ASP.NET, Azure, .NET Coree Microsoft Graph.
Ogni articolo include un pulsante Modifica (illustrato di seguito) che consente di accedere al file Markdown di origine in GitHub, in cui è possibile inviare facilmente una richiesta pull per correggere o migliorare il contenuto.
Le domande, i commenti e il feedback sono importanti per noi. Abbiamo collaborato con [Livefyre](https://web.livefyre.com/) per fornire commenti e note sidenote su tutti i nostri articoli. Nella parte superiore di ogni articolo verrà visualizzato un collegamento per i commenti, come illustrato di seguito.
Facendo clic sui commenti, si accederà alla parte inferiore della pagina in cui è possibile accedere (usando Twitter, Facebook, Google, Yahoo o Microsoft credenziali) per aggiungere, seguire o come commenti.
È anche possibile aggiungere note sidenote o note in ogni paragrafo del contenuto o testo evidenziato in modo specifico. A tale scopo, con il cursore del mouse sul simbolo di commento a destra, fare clic su di esso per aggiungere un commento inline.
Il pulsante di condivisione nella parte superiore della pagina consente di condividere facilmente con Twitter e Facebook.
Puoi anche usare il cursore del mouse per selezionare il contenuto di un articolo per aggiungere un commento o condividere su Twitter o Facebook direttamente dal menu di scelta rapida, come illustrato di seguito.
Ci interessa l'esperienza Web e una cosa che ci ha segnalato regolarmente come utenti di TechNet e MSDN è che gli articoli non hanno URL descrittivi e leggibili. Ecco un esempio dello stesso articolo con i nuovi URL.
prima:
<https://technet.microsoft.com/library/dn646983.aspx>dopo:
<https://learn.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune>
È stata anche aggiunta una selezione tema agli articoli in modo che sia possibile passare da un tema chiaro a quello scuro, qualcosa che alcuni di voi hanno chiesto su UserVoice.
L'immagine seguente mostra la differenza tra la luce e il tema scuro.
Concetti fondamentali come le prestazioni del sito sono una funzionalità chiave e molti clienti ci hanno chiesto di migliorare UserVoice. Il tempo di caricamento delle pagine in docs.microsoft.com è compreso tra 50 e 300% più veloce in termini di tempo di caricamento e la distribuzione geografica è migliore che mai. È stata creata anche un'architettura che esegue 100% in Azure.
Ci auguriamo di godere della versione di anteprima di docs.microsoft.com e inviare commenti e suggerimenti a https://aka.ms/sitefeedback. Nei post futuri verranno illustrati i nostri piani per migliorare notevolmente l'esperienza per il contenuto di riferimento e i nostri piani per la localizzazione dei contenuti.