Představujeme docs.microsoft.com

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

Dnes oznamujeme vydání naší nové dokumentace https://docs.microsoft.comve verzi Preview , která ukazuje obsah podporující naše produkty Enterprise Mobility.

Proč docs.microsoft.com?

Na obsahu prostě záleží. Zjišťovali jsme názory stovek vývojářů a IT specialistů a důkladně jsme prošli vaše názory na webu UserVoice, které se v průběhu let nashromáždily. Bylo naprosto jasné, že musíte udělat změnu a vytvořit moderní webové prostředí pro obsah. Ze všeho nejdřív jsme vyhodnotili stávající infrastrukturu webů TechNet a MSDN. Oba tyto weby využívají 10 až 15 let starý a poměrně křehký kód s archaickým systémem publikování a nasazení, který nikdy nebyl navržený pro běh v cloudu.

Soustředili jsme se nejenom na vlastní uživatelské prostředí, ale také na obsah, který vytváříme, a způsob, jakým ho jednotliví uživatelé využívají. Po celá léta jsme od zákazníků slyšeli, že bychom se neměli soustředit jenom na vlastní text, ale zajistit obsah na úrovni funkcí a pomáhat při implementaci řešení jejich obchodních problémů. Věděli jsme, si, že obsah, který poskytneme, a platformy, které vytvoříme, musí zákazníkům usnadňovat zjišťování nových poznatků a nasazování řešení.

Uvědomili jsme si, že musíme začít úplně od začátku, jinak se nám nepovede udělat prostředí takové, jaké chceme. Výsledkem tohoto našeho úsilí je https://docs.microsoft.com – nová naděje pro dokumentaci v Microsoftu.

Poznámka: Tato verze Preview webu obsahuje obsah *pouze* pro dokumentaci Enterprise Mobility (která se skládá z Advanced Threat Analytics, Azure Active Directory, vzdálené aplikace Azure, vícefaktorového ověřování, Azure Rights Management, Intune a Microsoft Identity Manageru). V budoucnu, až na s pomocí vašich připomínek naše platforma vyzraje, převedeme do tohoto prostředí další část naší dokumentace.

Klíčové funkce

Začněme ukázkovou stránkou dokumentace, která je uvedená níže, a ukážeme si některé nové funkce na webu.

Documentation Example

Čitelnost

Ke zlepšení čitelnosti obsahu jsme web změnili tak, aby měl pevnou šířku obsahu. Studie sledování očí ukázaly, že můžete zlepšit porozumění a rychlost čtení s nastavenou šířkou obsahu, protože je obtížné sledovat dlouhé pasáže zleva doprava. Ukážeme vám to v praxi – prohlédněte si článek o službě Intune na webu docs.microsoft.com a pod ním stejný článek na TechNetu. Také jsme zvětšili velikost písma pro levou navigaci a samotný text, něco, co zákazníci žádali (UserVoice – Zvětšit velikost písma).

Docs and TechNet comparison

Odhadovaná doba čtení

Dalším jednoduchým vylepšením, které jsme provedli na základě vašeho vstupu, je poskytnout odhadovanou dobu čtení článku. Víme, že se mnoho z vás učí a vyhodnocuje technologie několik minut mezi schůzkami a s větší pravděpodobností si přečtete články, pokud víte, kolik času se vyžaduje. Na základě názorů uvedených na UserVoice jsme obsah dál doplnili o časová razítka, na základě kterých zákazníci snadno zjistí, jak aktuální příslušné informace jsou.

Estimated reading time

Navigace na webu a v obsahu

Jednou z klíčových oblastí investic na základě zákaznických pohovorů a zpětné vazby UserVoice byla vylepšení navigace na webu, architektury informací a organizace obsahu na základě záměru zákazníka. Náš obsah jsme rozdělili do několika logických skupin souvisejících s vyhodnocením, zahájením práce, plánováním, nasazením nebo řešením problémů s produkty a službami. Toto rozdělení obsahu je patrné jak na levé navigaci, tak na stránkách k jednotlivým produktům a službám.

Dál je snímek domovské stránky dokumentace k Intune:

Intune documentation screenshot

Stejné rozdělení do kategorií najdete i na levé straně článků:

Left navigation

Zkrácená délka článků

Další běžnou zpětnou vazbou bylo, že náš obsah může být občas ohromující kvůli délce a že dlouhé články jsou obtížnější procházet a najít to, co hledáte. Abychom to vyřešili, rozdělili jsme mnoho delších článků do menších logických kroků a v dolní části článků jsme zadali tlačítka Předchozí a Další, abyste mohli procházet kroky v kurzu s více částmi, jak je znázorněno níže.

Back and Next buttons

Přestože celé řadě zákazníků vyhovuje možnost používat vícedílné kurzy, naslouchali jsme i zákazníkům, kteří chtějí kombinovat kurzy s několika kroky do jednoho souboru PDF, který se dá vytisknout offline na tiskárně. Tahle funkce ještě není hotová, ale brzy ji do verze Preview zařadíme.

Přizpůsobivý návrh

Pro zajištění optimálního uživatelského prostředí na mobilních zařízeních, tabletech i počítačích, o které jste na webu UserVoice žádali, jsme přešli na přizpůsobivé rozložení. Kliknutím na tlačítko Možnosti můžete rozbalit nebo sbalit obsah tak, aby zobrazoval stejné možnosti jako v zobrazení plochy.

Responsive Page Design

Komunitní příspěvky

Veškerá dokumentace na docs.microsoft.com využívá open source a je navržená tak, aby umožňovala příspěvky ze strany komunity. Jdeme tím ve stopách jiných týmů v Microsoftu, které už na open source převedly veškerou svou dokumentaci (nebo její část), včetně ASP.NET, Azure, .NET Core a Microsoft Graph.

Každý článek obsahuje tlačítko pro úpravy (zobrazené níž), pomocí kterého přejdete ke zdrojovému souboru Markdown na GitHubu, kde můžete snadno odeslat žádost o přijetí změn pro opravu nebo vylepšení obsahu.

Mechanismy zpětné vazby

Vaše dotazy, komentáře a názory jsou pro nás důležité. Ve spolupráci s Livefyre jsme poskytli komentáře a poznámky ke všem našim článkům. V horní části každého článku uvidíte odkaz na komentáře, jak je znázorněno níže.

Comments link

Kliknutím na komentáře přejdete do dolní části stránky, kde se můžete přihlásit (pomocí Twitteru, Facebooku, Googlu, Yahoo nebo přihlašovacích údajů Microsoftu) a přidat, sledovat nebo lajkovat komentáře.

Comments at bottom

K jednotlivým odstavcům obsahu nebo ke konkrétnímu zvýrazněnému textu můžete také přidávat poznámky na okraj. Pokud chcete přidat vložený komentář , stačí nastavit ukazatel myši na symbol komentáře napravo a kliknout na něj.

Sidenote example

Sdílení na sociálních sítích

Tlačítko pro sdílení v horní části stránky umožňuje snadné sdílení pomocí Twitteru a Facebooku.

Sharing to Twitter and Facebook

Pomocí ukazatele myši můžete také v článku vybrat obsah a přidat k němu komentář nebo ho sdílet na Twitteru nebo Facebooku přímo z kontextové nabídky, jak ukazuje následující obrázek.

Select and comment or share content

Popisné adresy URL

Uživatelské prostředí na našich stránkách je pro nás velice důležité a jednou z věcí, které nás jako uživatele TechNetu a MSDN dlouho trápily, bylo, že jednotlivé články neměly popisné a čitelné adresy URL. Tady je příklad stejného článku s našimi novými adresami URL.

Nastavování motivů na webu

K článkům jsme také doplnili výběr motivu, takže můžete volit mezi světlým a tmavým motivem. Také o to někteří z vás na webu UserVoice žádali.

Light and Dark Theme Selector

Následující obrázek ukazuje rozdíl mezi světlým a tmavým motivem.

Light and Dark themes

Základy

Základní parametry, jako je třeba výkon, jsou pro práci s webem klíčové. Právě k jejich vylepšení nás řada zákazníků na webu UserVoice vyzývala. Časy načtení stránek na docs.microsoft.com jsou rychlejší o 50-300 % a naše distribuce je z pohledu zeměpisné polohy lepší, než kdy byla. Také jsme vytvořili architekturu, na které běží 100 % v Azure.

Chceme slyšet váš názor!

Doufáme, že se vám verze Preview webu docs.microsoft.com líbila. Svoje názory a připomínky nám prosím pošlete na adresu https://aka.ms/sitefeedback. V budoucích příspěvcích probereme naše plány, abychom výrazně zlepšili prostředí pro referenční obsah a naše plány lokalizace obsahu.