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 vylepšeních prostředí nové dokumentace docs.microsoft.com nabídek najdete v blogovém příspěvku s představením docs.microsoft.com. Kromě toho, že jsou na platformě docs.microsoft.com k dispozici všechny funkce pro spolupráci, opensourcový obsah a přívětivější adresy URL, jsme zavedli některé nové funkce specifické pro vývojáře .NET. Tento příspěvek tyto nové funkce zvýrazní a shrne naše plány do budoucna.
Hlavní body prostředí dokumentace k .NET
Abychom mohli doprovodit vzrušující vydání rtm .NET Core, umístíme ho na domovskou stránku dokumentace k .NET. Abychom doplnili vydání .NET Core RTM o všechno, co budete potřebovat k rychlému zahájení práce, umístili jsme na začátek seznamu odkazy na články a nové referenční prostředí.
Ekosystém .NET na dosah ruky
Uvidíte odkazy na stažení nových knihoven .NET Core, ASP.NET, Entity Framework a Azure, vytváření aplikací pro iOS pomocí Xamarinu pomocí .NET a sestavování aplikací Univerzální platforma 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 výchozím bodem pro přístup k veškeré dokumentaci k .NET.
Články
Naši autoři a technici, stejně jako několik vyhrazených členů komunity, neustále pracují 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 jsou:
Tato a mnoho dalších témat jsou prezentovány v motivu docs.microsoft.com, s čistým obsahem na každé stránce a také odhadovaným časem přečtení jednotlivých článků a informací o přispěvatelích pro každý článek.
Všechny články .NET jsou opensourcové a dostupné na GitHubu v úložišti dokumentace týmu .NET. Pokud v dokumentaci narazíte na nějaké problémy nebo je chcete vylepšit, stačí kliknout na tlačítko pro úpravy v pravém navigačním panelu jednotlivých článků.
Při úpravách článku stačí kliknout na tlačítko Upravit u libovolného souboru Markdownu v úložišti, přidat obsah a odeslat žádost o přijetí změn. Jakmile jeden náš tým zkontroluje a přijme vaši žádost o přijetí změn, vaše příspěvky budou na webu během několika minut živě.
Reference rozhraní API
Kromě skvělého obsahu, který vytvořili naši spisovatelé, inženýři a náruživí č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 využívá stejné principy návrhu, které jsme použili v článcích docs.microsoft.com.
Stejně jako u těchto článků jsou i stránky nových odkazů responzivní, navržené s moderními webovými principy a budou vypadat lépe na mobilních zařízeních.
Na všechny stránky oboru názvů jsme přidali hledání typu. To vám umožní snadno vyhledávat podle názvu typu pro všechny typy rozhraní .NET. Při každém stisknutí kláves 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 označované jako DocFX, opensourcový projekt na GitHubu.
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ů k danému typu. Kliknutím na název typu v hlavní oblasti referenčního obsahu se zobrazí stránka podrobností třídy, která obsahuje řetězec dědičnosti třídy, deklaraci a podrobnosti o vlastnostech a členech metody třídy.
Pro každého člena metody uvidíte podrobnosti o parametrech a souhrn metody.
Informační a technické principy
Kromě neustálé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é uvidíte v novém prostředí dokumentace .NET.
Lepší automatizace
Při přijetí žádostí o přijetí změn od potenciálních přispěvatelů ověříme, že přispěvatel provedl jednoduchý proces podepsání naší licenční smlouvy s přispěvatelem (tento proces je plně elektronický a dokončení trvá několik minut). Pokud příspěvky odpovídají pokynům pro příspěvky, měly by se na webu zobrazit malé změny živě několik minut po přijetí žádostí o přijetí změn.
Lepší adresy URL
Jedním z důležitých principů celkového docs.microsoft.com prostředí jsou 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 mají čistší adresy URL. Vezměme si například klasickou adresu URL MSDN pro systémový obor názvů:
V nové referenční dokumentaci je adresa URL logičtější, čitelnější pro člověka a co je nejdůležitější, zjistitelnější.
Agilnější a otevřené vytváření obsahu
Obsah není jenom opensourcový, ale nepřijímáme jenom příspěvky komunity. Veškerý obsah na docs.microsoft.com (včetně dokumentace k .NET) je navíc dostupný pod licencí 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 v novém systému aktivně spolupracují se členy komunity už měsíce. Byl to zajímavý a vzrušující přechod a v budoucnu máme další.
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áře. Své nápady na funkce odešlete na UserVoice.
V nadcházejících týdnech budeme publikovat komentáře XML, které slouží ke generování referenční dokumentace, přímo do zdrojového kódu .NET. To umožní každému snadno kliknout na aktualizovat referenční dokumentaci k rozhraní .NET Framework.
Budeme také pokračovat v úpravě návrhu a rozložení odkazu a také výše uvedené možnosti upravovat samotný obsah odkazu.
S radostí vám přinášíme novou oblast dokumentace k .NET na docs.microsoft.com, a těšíme se, že v budoucnu zlepšíme vaše prostředí.