Introductie van .NET Core Docs
Dit bericht is geschreven door Jess Sandquist, General Manager in de Cloud + Enterprise-divisie.
Vandaag hebben we een preview uitgebracht van de .NET-documentatie op docs.microsoft.com. Ga voor meer informatie over de nieuwe verbeteringen in de documentatie-ervaring docs.microsoft.com aanbiedingen naar het blogbericht Introductie docs.microsoft.com. Naast alle samenwerkingsfuncties, opensource-inhoud en gebruiksvriendelijkere URL's die beschikbaar zijn op het docs.microsoft.com-platform, hebben we een aantal nieuwe functies geïntroduceerd die specifiek zijn voor .NET-ontwikkelaars. In dit bericht worden deze nieuwe functies belicht en worden onze plannen voor de toekomst samengevat.
Hoogtepunten van de .NET-documentatie-ervaring
Ter begeleiding van de spannende RTM-release van .NET Core zetten we deze centraal op de startpagina van .NET-documentatie. Om de .NET Core RTM-release aan te vullen met alles wat u nodig hebt om snel aan de slag te gaan, hebben we koppelingen naar artikelen en een nieuwe naslagervaring boven aan de lijst geplaatst.
Het .NET-ecosysteem binnen handbereik
U ziet koppelingen voor het downloaden van de nieuwe .NET Core-bibliotheken, ASP.NET, Entity Framework, Azure, met behulp van Xamarin om iOS-toepassingen te bouwen met behulp van .NET en het bouwen van Universeel Windows-platform -apps (UWP) met behulp van .NET. We hebben nog niet alle .NET-inhoud naar docs.microsoft.com verplaatst, maar de startpagina van .NET-documentatie is het beginpunt om naar alle .NET-documentatie te gaan.
Artikelen
Onze schrijvers en technici, evenals een aantal toegewijde communityleden, hebben onvermoeibaar gewerkt aan het maken van nieuwe .NET Core-gerelateerde artikelen die u kunt vinden in de sectie .NET-documentatie . Hier vindt u een reeks artikelen, zoals:
Deze en vele andere onderwerpen worden allemaal gepresenteerd in het docs.microsoft.com thema, met een schone inhoudsopgave op elke pagina, evenals de geschatte tijd voor het lezen van elk artikel en inzenderinformatie voor elk artikel.
Alle .NET-artikelen zijn opensource en beschikbaar op GitHub in de docs-opslagplaats van het .NET-team. Als u problemen in de documentatie vindt of als u deze wilt verbeteren, is dit net zo eenvoudig als klikken op de knop Bewerken in de rechternavigatie van elk artikel.
Het bewerken van een artikel is net zo eenvoudig als het klikken op de knop Bewerken op een van de Markdown-bestanden in de opslagplaats, het toevoegen van uw inhoud en het indienen van een pull-aanvraag. Zodra één van ons team uw pull-aanvraag beoordeelt en accepteert, worden uw bijdragen binnen enkele minuten live op de site weergegeven.
API-verwijzing
Naast de geweldige inhoud die is geschreven door onze schrijvers, technici en gepassioneerde communityleden, hebben we aanzienlijke verbeteringen aangebracht in de referentie-ervaring. De referentie-ervaring is volledig opnieuw ontworpen in deze preview-versie en is gebaseerd op dezelfde ontwerpprincipes die we in de docs.microsoft.com artikelen hebben gebruikt.
Net als deze artikelen zijn de nieuwe referentiepagina's responsief, ontworpen met moderne webprincipes en zien ze er beter uit op mobiele apparaten.
We hebben een type zoeken toegevoegd aan alle naamruimtepagina's. Hierdoor kunt u eenvoudig op typenaam zoeken naar alle .NET-typen. Met elke toetsdruk filteren we de lijst met typen die worden weergegeven in de linkernavigatiebalk. Deze interessante nieuwe functie van het referentiegebied is opgenomen in ons nieuwe framework voor het genereren van .NET-referentiedocumentatie die bekend staat als DocFX, een opensource-project op GitHub).
Wanneer u in de linkernavigatiebalk op afzonderlijke typen klikt voor een naamruimte, gaat u rechtstreeks naar de sectie inleiding van de naamruimtepagina voor dat type. Als u op de naam van het type in het hoofdgebied van de verwijzingsinhoud klikt, ziet u de detailpagina van de klasse, die de overnameketen, declaratie en details over de eigenschap en methodeleden van de klasse bevat.
Voor elk methodelid ziet u details over de parameters en een samenvatting van de methode.
Informatie- en technische principes
Naast de voortdurende ontwikkeling en verbetering van de docFX-hulpprogramma's voor het genereren van documenten, hebben we belangrijke verbeteringen aangebracht in de technische en documentatieprincipes die u zult zien in de nieuwe .NET-documentatie-ervaring.
Betere automatisering
Wanneer pull-aanvragen van potentiële inzenders worden ontvangen, controleren we of de inzender een eenvoudig proces heeft gevolgd voor het ondertekenen van onze inzenderlicentieovereenkomst (dit proces is volledig elektronisch en duurt enkele minuten om te voltooien). Zolang de bijdragen voldoen aan de richtlijnen voor bijdragen, moeten kleine wijzigingen live worden weergegeven op de site minuten nadat pull-aanvragen zijn geaccepteerd.
Betere URL's
Een belangrijk principe van de algehele docs.microsoft.com ervaring is betere URL's voor het verbeteren van zoekindexering en 'raden'. We hebben dit principe gehandhaafd in de .NET-documentatie. Zowel de artikelen als de referentiedocumentatie hebben schonere URL's. Neem bijvoorbeeld de klassieke MSDN-URL voor de system-naamruimte:
In de nieuwe referentiedocumentatie is de URL logischer, beter leesbaar en vooral beter vindbaar.
Flexibelere en open creatie
De inhoud is niet alleen open source en we accepteren niet alleen bijdragen van de community. Bovendien is alle inhoud op docs.microsoft.com (inclusief de .NET-documentatie) allemaal beschikbaar onder een Creative Commons-licentie. U kunt het lezen, kopiëren, ernaar verwijzen en delen ervan hergebruiken (zelfs voor commercieel gebruik). De schrijvers en technici werken al maanden met communityleden actief aan het nieuwe systeem. Het was een interessante en spannende overgang, en we hebben nog meer in de toekomst.
Toekomstplannen
Dit gedeelte van docs.microsoft.com is, net als de rest van de site, nog in preview, dus we moedigen constructieve feedback en commentaar aan. Stuur uw ideeën voor functies naar UserVoice.
In de komende weken publiceren we de XML-opmerkingen die worden gebruikt om referentiedocumentatie rechtstreeks in de .NET-broncode te genereren. Hierdoor kan iedereen eenvoudig klikken op het bijwerken van de .NET Framework referentiedocumentatie.
We blijven ook het ontwerp en de indeling van de verwijzing aanpassen, evenals de bovengenoemde mogelijkheid om de verwijzingsinhoud zelf te bewerken.
We zijn verheugd u de nieuwe .NET-documentatie op docs.microsoft.com te brengen en we kijken ernaar uit om uw ervaring in de toekomst te verbeteren.