Introduzione alla documentazione di .NET Core
Questo articolo è stato scritto da Jeff Sandquist, General Manager di Cloud + Enterprise Division.
Oggi è stata rilasciata un'anteprima della documentazione di .NET in docs.microsoft.com. Per altre informazioni sui nuovi miglioramenti dell'esperienza di documentazione docs.microsoft.com offerte, visitare il post di blog introduttivo docs.microsoft.com. Oltre ad avere tutte le funzionalità di collaborazione, il contenuto open source e gli URL più amici disponibili nella piattaforma docs.microsoft.com, sono state introdotte alcune nuove funzionalità specifiche per gli sviluppatori .NET. Questo post evidenzia queste nuove funzionalità e riepiloga i nostri piani per il futuro.
Evidenziazione dell'esperienza di documentazione di .NET
Per accompagnare l'emozionante versione RTM di .NET Core, la home page della documentazione .NET viene messa davanti e centrale. Per integrare la versione di .NET Core RTM con tutto ciò che è necessario iniziare rapidamente, sono stati inseriti collegamenti ad articoli e una nuova esperienza di riferimento nella parte superiore dell'elenco.
Ecosistema .NET a portata di mano
Verranno visualizzati collegamenti per scaricare le nuove librerie .NET Core, ASP.NET, Entity Framework, Azure, usando Xamarin per compilare applicazioni iOS usando .NET e creare app piattaforma UWP (Universal Windows Platform) (UWP) usando .NET. Non è ancora stato spostato tutto il contenuto .NET in docs.microsoft.com ancora abbastanza, ma la home page della documentazione .NET sarà il punto di partenza per ottenere tutta la documentazione di .NET.
Articoli
I nostri writer e ingegneri, oltre a alcuni membri della community dedicati, hanno lavorato in modo incessante creando nuovi articoli correlati a .NET Core disponibili nella sezione Documentazione di .NET . Qui troverai un'ampia gamma di articoli come:
Questi e molti altri argomenti sono tutti presentati nel tema docs.microsoft.com, con un sommario pulito in ogni pagina, nonché il tempo stimato per leggere ogni articolo e informazioni di collaboratore per ogni articolo.
Tutti gli articoli .NET sono open source e disponibili in GitHub nel repository di documentazione del team .NET. Se si verificano problemi nella documentazione o si desidera migliorarlo, in questo modo è facile fare clic sul pulsante di modifica nella navigazione a destra di ogni articolo.
La modifica di un articolo è semplice come fare clic sul pulsante di modifica in uno qualsiasi dei file Markdown nel repository, aggiungendo il contenuto e inviando una richiesta pull. Una volta che uno dei nostri team esamina e accetta la richiesta pull, i tuoi contributi verranno inseriti nel sito in pochi minuti.
Informazioni di riferimento sulle API
Oltre ai grandi contenuti creati dai nostri scrittori, ingegneri e membri appassionati della community, abbiamo apportato miglioramenti significativi all'esperienza di riferimento. L'esperienza di riferimento è stata completamente riprogettata in questa versione di anteprima, prendendo in prestito gli stessi principi di progettazione usati negli articoli docs.microsoft.com.
Come questi articoli, le nuove pagine di riferimenti sono reattive, progettate con principi Web moderni e saranno migliori nei dispositivi mobili.
È stata aggiunta una ricerca dei tipi a tutte le pagine dello spazio dei nomi. Ciò consente di cercare facilmente in base al nome del tipo per tutti i tipi .NET. Con ogni tastopresso, viene filtrato l'elenco dei tipi visualizzati nello spostamento a sinistra. Questa nuova funzionalità interessante dell'area di riferimento è inclusa nel nuovo framework per la generazione di documentazione di riferimento .NET nota come DocFX, un progetto open source in GitHub.
Quando si fa clic su singoli tipi nello spostamento a sinistra per qualsiasi spazio dei nomi, verrà eseguito l'hop direttamente nella sezione introduzione della pagina dello spazio dei nomi a tale tipo. Facendo clic sul nome del tipo nell'area principale del contenuto di riferimento verrà visualizzata la pagina dei dettagli della classe, che contiene la catena di ereditarietà, la dichiarazione e i dettagli della proprietà e dei membri del metodo della classe.
Per ogni membro del metodo verranno visualizzati i dettagli sui parametri e un riepilogo del metodo.
Principi informativi e di ingegneria
Oltre a continuare lo sviluppo e il miglioramento degli strumenti di generazione di documenti DocFX, sono stati apportati miglioramenti significativi ai principi di progettazione e documentazione che saranno evidenti nella nuova esperienza di documentazione .NET.
Automazione migliore
Quando le richieste pull vengono ricevute da potenziali collaboratori, si verifica che il collaboratore abbia seguito un semplice processo di firma del contratto di licenza collaboratore (questo processo è completamente elettronico e richiede alcuni minuti per completare). Purché i contributi siano conformi alle linee guida per i contributi, le piccole modifiche devono essere visualizzate nei minuti del sito dopo l'accettazione delle richieste pull.
URL migliori
Un principio importante dell'esperienza generale di docs.microsoft.com è un migliore URL per migliorare l'indicizzazione della ricerca e "indovinare". Questo principio è stato mantenuto nella documentazione di .NET. Gli articoli e la documentazione di riferimento hanno URL più puliti. Ad esempio, l'URL MSDN classico per lo spazio dei nomi System:
Nella nuova documentazione di riferimento l'URL è più logico, leggibile e più importante, più individuabile.
Creazione più agile e aperta
Il contenuto non è solo open source e non solo accettare contributi della community. Inoltre, tutti i contenuti in docs.microsoft.com (inclusa la documentazione .NET) sono tutti disponibili in una licenza Creative Commons. È possibile leggerlo, copiarlo, farvi riferimento e riutilizzare le parti di esso (anche per l'uso commerciale). Gli scrittori e gli ingegneri stanno lavorando attivamente con i membri della community per mesi nel nuovo sistema. È stata una transizione interessante ed emozionante, e abbiamo più da venire in futuro.
Piani futuri
Questa sezione di docs.microsoft.com, come è il resto del sito, è ancora in anteprima, quindi si incoraggiano commenti e commenti costruttivi. Inviare le idee di funzionalità a UserVoice.
Nelle prossime settimane verranno pubblicati i commenti XML usati per generare la documentazione di riferimento direttamente nel codice sorgente .NET. Ciò consentirà a chiunque di fare clic facilmente sull'aggiornamento della documentazione di riferimento di .NET Framework.
Continuerà anche a modificare la progettazione e il layout del riferimento, nonché la possibilità di modificare il contenuto di riferimento stesso.
Siamo lieti di portare la nuova area di documentazione .NET in docs.microsoft.com e siamo lieti di rendere la tua esperienza migliore in futuro!