Introduktion till .NET Core-dokument
Det här inlägget har skrivits av Jeff Sandquist, General Manager inom Cloud + Enterprise-avdelningen.
Idag släppte vi en förhandsversion av .NET-dokumentationenpå docs.microsoft.com. Mer information om de nya förbättringarna av dokumentationsupplevelsen docs.microsoft.com erbjudanden finns i blogginlägget introduktionen docs.microsoft.com. Förutom att ha alla samarbetsfunktioner, innehåll med öppen källkod och mer användarvänliga URL:er tillgängliga på docs.microsoft.com-plattformen har vi introducerat några nya funktioner som är specifika för .NET-utvecklare. Det här inlägget belyser dessa nya funktioner och sammanfattar våra planer för framtiden.
Höjdpunkter i .NET-dokumentationsupplevelsen
I samband med den spännande RTM-versionen av .NET Core placerar vi den i centrum på startsidan för .NET-dokumentationen. För att komplettera .NET Core RTM-versionen med allt du behöver för att komma igång snabbt har vi lagt till länkar till artiklar och en ny referensupplevelse överst i listan.
.NET-ekosystemet nära till hands
Du ser länkar för att ladda ned de nya .NET Core-biblioteken, ASP.NET, Entity Framework, Azure, med Xamarin för att skapa iOS-program med .NET och skapa Universell Windows-plattform-appar (UWP) med hjälp av .NET. Vi har inte flyttat över allt .NET-innehåll till docs.microsoft.com ännu, men startsidan för .NET-dokumentationen är startpunkten för att komma till all .NET-dokumentation.
Artiklar
Våra författare och tekniker, samt några dedikerade communitymedlemmar, har arbetat outtröttligt med att skapa nya .NET Core-relaterade artiklar som du hittar i avsnittet .NET-dokumentation . Här hittar du en rad artiklar som:
Dessa och många andra ämnen presenteras i temat docs.microsoft.com, med en ren innehållsförteckning på varje sida, samt den uppskattade tiden för att läsa varje artikel och deltagarinformation för varje artikel.
Alla .NET-artiklar har öppen källkod och är tillgängliga på GitHub på .NET-teamets dokumentlagringsplats. Om du hittar några problem i dokumentationen eller vill förbättra den är det lika enkelt som att klicka på redigeringsknappen i den högra navigeringen i varje artikel.
Att redigera en artikel är lika enkelt som att klicka på redigeringsknappen på någon av Markdown-filerna på lagringsplatsen, lägga till ditt innehåll och skicka en pull-begäran. När vårt team har granskat och accepterat din pull-begäran kommer dina bidrag att live på webbplatsen på några minuter.
API-referens
Förutom det fantastiska innehåll som författas av våra författare, ingenjörer och passionerade communitymedlemmar har vi gjort betydande förbättringar av referensupplevelsen. Referensupplevelsen har gjorts om helt i den här förhandsversionen och lånar på samma designprinciper som vi använde i docs.microsoft.com artiklar.
Precis som dessa artiklar är de nya referenssidorna dynamiska, utformade med moderna webbprinciper och kommer att se bättre ut på mobila enheter.
Vi har lagt till en typsökning på alla namnområdessidor. På så sätt kan du enkelt söka efter typnamn för alla .NET-typer. Med varje nyckeltryck filtrerar vi listan över typer som visas i det vänstra navigeringsfönstret. Den här spännande nya funktionen i referensområdet ingår i vårt nya ramverk för att generera .NET-referensdokumentation som kallas DocFX, ett projekt med öppen källkod på GitHub).
När du klickar på enskilda typer i det vänstra navigeringsfältet för ett namnområde hoppar du direkt till namnområdessidans introduktionsavsnitt till den typen. Genom att klicka på namnet på typen i huvudområdet i referensinnehållet visas klassens informationssida, som innehåller klassens arvskedja, deklaration och information om klassens egenskaps- och metodmedlemmar.
För varje metodmedlem visas information om parametrarna och en sammanfattning av metoden.
Informations- och teknikprinciper
Förutom fortsatt utveckling och förbättring av DocFX-verktygen för dokumentgenerering har vi gjort betydande förbättringar av de tekniska och dokumentationsprinciper som visas i den nya .NET-dokumentationsupplevelsen.
Bättre automatisering
När pull-begäranden tas emot från potentiella deltagare verifierar vi att deltagaren har följt en enkel process för att signera vårt deltagarlicensavtal (den här processen är helt elektronisk och tar några minuter att slutföra). Så länge bidragen följer riktlinjerna för bidrag bör små ändringar visas live på webbplatsen minuter efter att pull-begäranden har accepterats.
Bättre URL:er
En viktig princip för den övergripande docs.microsoft.com upplevelsen är bättre URL:er för att förbättra sökindexering och "gissning". Vi har behållit den här principen i .NET-dokumentationen. Både artiklarna och referensdokumentationen har renare URL:er. Ta till exempel den klassiska MSDN-URL:en för systemnamnområdet:
I den nya referensdokumentationen är URL:en mer logisk, läsbar och viktigast av allt mer identifierbar.
Mer flexibel och öppen redigering
Innehållet är inte bara öppen källkod, och vi accepterar inte bara bidrag från communityn. Dessutom är allt innehåll på docs.microsoft.com (inklusive .NET-dokumentationen) tillgängligt under en Creative Commons-licens. Du kan läsa den, kopiera den, referera till den och återanvända delar av den (även för kommersiellt bruk). Författarna och ingenjörerna har arbetat aktivt med samhällsmedlemmar i månader i det nya systemet. Det har varit en intressant och spännande övergång, och vi har mer att komma i framtiden.
Framtida planer
Det här avsnittet av docs.microsoft.com, liksom resten av webbplatsen, är fortfarande i förhandsversion, så vi uppmuntrar konstruktiv feedback och kommentarer. Skicka in dina funktionsidéer till UserVoice.
Under de kommande veckorna kommer vi att publicera XML-kommentarerna som används för att generera referensdokumentation direkt i .NET-källkoden. På så sätt kan vem som helst enkelt klicka på uppdatera .NET Framework referensdokumentation.
Vi kommer också att fortsätta att justera referensens design och layout, samt den tidigare nämnda möjligheten att redigera själva referensinnehållet.
Vi är glada över att kunna ge dig det nya .NET-dokumentationsområdet på docs.microsoft.com, och vi ser fram emot att göra din upplevelse bättre i framtiden!