Představujeme .NET Core Docs

Autorem tohoto článku je Jeff Sandquist, šéf oddělení Cloud + Enterprise.

Dnes jsme vydali verzi Preview dokumentace k .NET na docs.microsoft.com. Další informace o nových vylepšeních prostředí dokumentace docs.microsoft.com nabídek najdete v úvodním blogovém příspěvku docs.microsoft.com. Kromě toho, že máme všechny funkce pro spolupráci, opensourcový obsah a přívětivější adresy URL dostupné na platformě docs.microsoft.com, představili jsme některé nové funkce specifické pro vývojáře .NET. Tento příspěvek zvýrazní tyto nové funkce a shrne naše plány pro budoucnost.

Nejdůležitější informace o prostředí dokumentace k .NET

Abychom mohli doprovázet vzrušující verzi RTM .NET Core, umístíme ji do popředí a do centra na domovské stránce dokumentace k .NET. Abychom mohli verzi .NET Core RTM doplnit o všechno, co budete muset rychle začít, přidali jsme odkazy na články a nové referenční prostředí v horní části seznamu.

.NET Docs Home Page

Ekosystém .NET na dosah ruky

Zobrazí se odkazy ke stažení nových knihoven .NET Core, ASP.NET, Entity Framework, Azure pomocí Xamarinu k vytváření aplikací pro iOS pomocí .NET a vytváření aplikací pro Univerzální platformu Windows (UPW) pomocí .NET. Zatím jsme nepřesunuli veškerý obsah .NET do docs.microsoft.com, ale domovská stránka dokumentace k .NET bude vaším výchozím bodem pro přístup ke všem dokumentaci k .NET.

Links to .NET Documentation Sections

Články

Naši spisovatelé a technici, stejně jako několik vyhrazených členů komunity, pracovali bez pneumatiky na vytváření nových článků souvisejících s .NET Core, které najdete v části Dokumentace k .NET . Tady najdete řadu článků, jako je:

Tato a mnoho dalších témat jsou uvedena v motivu docs.microsoft.com s čistým obsahem na každé stránce a také odhadovaným časem čtení jednotlivých článků a informací přispěvatelů pro každý článek.

Articles and guidance

Všechny články .NET jsou opensourcové a dostupné na GitHubu v úložišti dokumentace týmu .NET. Pokud v dokumentaci najdete nějaké problémy nebo ho chcete vylepšit, stačí kliknout na tlačítko pro úpravy v pravém navigačním panelu každého článku.

Click the edit button to view/edit the page in GitHub

Úprava článku je stejně jednoduchá, jako když kliknete na tlačítko pro úpravy u libovolného souboru Markdownu v úložišti, přidáte obsah a odešlete žádost o přijetí změn. Jakmile náš tým zkontroluje vaši žádost o přijetí změn a přijme vaši žádost o přijetí změn, vaše příspěvky se budou na webu během několika minut živě nacházet.

Then you can edit the content directly in GitHub.

Reference rozhraní API

Kromě skvělého obsahu, který vytvořili naši spisovatelé, technici a nadšení členové komunity, jsme výrazně vylepšili referenční prostředí. Referenční prostředí bylo v této verzi Preview zcela přepracováno a půjčuje si stejné principy návrhu, které jsme použili v článcích docs.microsoft.com.

Reference Namespace View

Stejně jako tyto články jsou nové stránky odkazů responzivní, navržené s moderními webovými principy a budou vypadat lépe na mobilních zařízeních.

Responsive design in reference

Přidali jsme vyhledávání typů na všechny stránky oboru názvů. To vám umožní snadno vyhledávat podle názvu typu pro všechny typy .NET. Při každém stisknutí klávesy vyfiltrujeme seznam typů zobrazených v levém navigačním panelu. Tato vzrušující nová funkce referenční oblasti je součástí naší nové architektury pro generování referenční dokumentace .NET známé jako DocFX, opensourcový projekt na GitHubu).

Reference Namespace View

Když kliknete na jednotlivé typy v levém navigačním panelu pro libovolný obor názvů, přejdete přímo do úvodní části stránky oboru názvů tohoto typu. Kliknutím na název typu v hlavní oblasti referenčního obsahu uvidíte stránku podrobností třídy, která obsahuje řetězec dědičnosti třídy, deklaraci a podrobnosti o vlastnosti třídy a členy metody.

Class view

U každého člena metody uvidíte podrobnosti o parametrech a souhrn metody.

Method view

Principy informací a inženýrství

Kromě dalšího vývoje a vylepšování nástrojů pro generování dokumentů DocFX jsme výrazně vylepšili principy přípravy a dokumentace, které jsou zřejmé v novém prostředí dokumentace k .NET.

Lepší automatizace

Když jsou žádosti o přijetí změn od potenciálních přispěvatelů přijaty, ověříme, že přispěvatel provedl jednoduchý proces podepsání licenční smlouvy přispěvatele (tento proces je plně elektronický a dokončení trvá několik minut). Pokud příspěvky dodržují pokyny k příspěvku, měly by se malé změny na webu zobrazit v minutách od přijetí žádostí o přijetí změn.

Lepší adresy URL

Jedním z důležitých principů celkového prostředí docs.microsoft.com je lepší adresy URL pro zlepšení indexování vyhledávání a "odhadování". Tento princip jsme zachovali v dokumentaci k .NET. Články i referenční dokumentace obsahují čistější adresy URL. Příklad klasické adresy URL MSDN pro obor názvů systému:

System Namespace URL on MSDN

V nové referenční dokumentaci je adresa URL logičtější, čitelnější a nejpodstatnější.

System Namespace URL on docs.microsoft.com

Agilnější a otevřené vytváření

Obsah není pouze opensourcový, a ne pouze přijímáme příspěvky komunity. Veškerý obsah na docs.microsoft.com (včetně dokumentace k .NET) je navíc dostupný v rámci licence Creative Commons. Můžete si ho přečíst, zkopírovat, odkazovat na něj a znovu použít jeho části (i pro komerční použití). Autoři a technici aktivně pracují s členy komunity v novém systému. Bylo to zajímavý a vzrušující přechod, a v budoucnu musíme přijít více.

Budoucí plány

Tato část docs.microsoft.com, stejně jako zbytek webu, je stále ve verzi Preview, takže podporujeme konstruktivní zpětnou vazbu a komentář. Odešlete své nápady na funkce do UserVoice.

V nadcházejících týdnech budeme publikovat komentáře XML, které se používají k vygenerování referenční dokumentace přímo do zdrojového kódu .NET. To umožní každému snadno kliknout na aktualizaci referenční dokumentace rozhraní .NET Framework.
Budeme také pokračovat v úpravě návrhu a rozložení odkazu, stejně jako výše zmíněné možnosti upravovat samotný referenční obsah.

S radostí vám přinášíme novou oblast dokumentace k .NET na docs.microsoft.com a těšíme se na zlepšení vašeho prostředí v budoucnu!