Wprowadzenie witryny docs.microsoft.com

Ten wpis został napisany przez Jeffa Sandquista, dyrektora naczelnego działu Cloud + Enterprise.

Dzisiaj pragniemy ogłosić wprowadzenie nowej usługi dokumentacji https://docs.microsoft.com w wersji zapoznawczej i pokazać zawartość pomocniczą dla produktów pakietu Enterprise Mobility.

Dlaczego warto korzystać z usługi docs.microsoft.com?

Zawartość jest ważna. Przeprowadziliśmy rozmowy i badania z setkami deweloperów oraz informatyków i dokładnie zapoznaliśmy się z opiniami przesłanymi za pośrednictwem witryny sieci Web w ostatnich latach w usłudze UserVoice. Wynikał z nich wyraźny wniosek: musimy wprowadzić zmiany i utworzyć nowoczesne środowisko sieci Web do obsługi zawartości. Najpierw oceniliśmy istniejącą infrastrukturę do obsługi zawartości: TechNet i MSDN. Obie witryny zostały utworzone przy użyciu niestabilnego kodu sprzed 10–15 lat oraz przestarzałego systemu publikowania i wdrażania, który nigdy nie był przeznaczony do działania w chmurze.

Skupiliśmy się nie tylko na środowisku, ale również na tworzonej przez nas zawartości i sposobie korzystania z niej przez użytkowników. Od lat klienci chcą, abyśmy wykroczyli poza formę tekstową i wprowadzili zawartość na poziomie funkcji oraz abyśmy pomogli im w implementowaniu rozwiązań dopasowanych do problemów biznesowych. Wiedzieliśmy, że dostarczana przez nas zawartość i nasza platforma muszą ułatwiać klientom zapoznawanie się z rozwiązaniami i ich wdrażanie.

Aby opracować odpowiednie środowisko, musieliśmy zacząć od podstaw. Wynikiem tej pracy jest witryna https://docs.microsoft.com — nowe rozwiązanie firmy Microsoft do obsługi dokumentacji.

Uwaga: Ta wersja zapoznawcza witryny obejmuje *tylko* zawartość dokumentacji pakietu Enterprise Mobility (składającego się z następujących produktów: Advanced Threat Analytics, Azure Active Directory, Azure RemoteApp, Multi-Factor Authentication, Azure Rights Management, Intune i Microsoft Identity Manager). Wraz z rozwojem naszej platformy na podstawie opinii użytkowników będziemy migrować do tej witryny więcej dokumentacji.

Najważniejsze funkcje

Na początek przedstawimy przykładową stronę dokumentacji, widoczną poniżej, oraz omówimy niektóre z nowych funkcji witryny.

Documentation Example

Czytelność

Aby poprawić czytelność zawartości, ustawiliśmy stałą szerokość zawartości witryny. Badania ruchu oczu wykazały, że stała szerokość zawartości pozwala zwiększyć zrozumienie i szybkość czytania, ponieważ trudniejsze dla oczu jest czytanie długich wierszy od lewej do prawej strony. Aby pokazać, jak to działa, poniżej przedstawiono przykładowy artykuł dotyczący usługi Intune w witrynie docs.microsoft.com oraz ten sam artykuł w witrynie TechNet. Ponadto zwiększyliśmy rozmiar czcionki w lewym obszarze nawigacji i samego tekstu zgodnie z prośbami klientów (UserVoice — zwiększenie rozmiaru czcionki).

Docs and TechNet comparison

Szacowany czas czytania

Innym prostym ulepszeniem, które wprowadziliśmy na podstawie opinii użytkowników, jest podawanie szacowanego czasu czytania artykułu. Wiemy, że wiele osób poznaje technologię podczas krótkich przerw między spotkaniami i podanie tego czasu zwiększa prawdopodobieństwo przeczytania artykułu. Dodaliśmy również daty utworzenia zawartości, aby ułatwić klientom sprawdzenie aktualności informacji, na podstawie opinii w usłudze UserVoice.

Estimated reading time

Nawigowanie po zawartości i witrynie

Na podstawie rozmów z klientami i opinii w usłudze UserVoice ustaliliśmy, że obszarem wymagającym największej poprawy jest nawigowanie po witrynie, architektura informacji i organizowanie zawartości zgodnie z potrzebami klientów. Zrefaktoryzowaliśmy zawartość w grupach logicznych dotyczących oceny, rozpoczynania pracy, planowania, wdrażania, zarządzania oraz rozwiązywania problemów z produktami i usługami. Zawartość jest podzielona w lewym obszarze nawigacji i na stronach produktów/usług.

Poniżej przedstawiono zrzut ekranu strony głównej dokumentacji usługi Intune:

Intune documentation screenshot

Informacje są tak samo podzielone na kategorie w lewym obszarze nawigacji artykułu:

Left navigation

Zmniejszenie długości artykułów

Inną kwestią często poruszaną w opiniach była zbyt długa zawartość, co utrudnia nawigowanie po artykułach i znalezienie odpowiedniej zawartości. Aby rozwiązać ten problem, podzieliliśmy wiele dłuższych artykułów na mniejsze kroki logiczne, dodając przyciski Wstecz i Dalej na końcu artykułów w celu umożliwienia nawigacji między krokami w wieloczęściowych samouczkach, jak pokazano poniżej.

Back and Next buttons

Choć wielu klientów docenia możliwość korzystania z wieloczęściowych samouczków, otrzymywaliśmy również pytania klientów o możliwość połączenia takich wieloetapowych samouczków w jeden plik PDF zoptymalizowany pod kątem drukowania w trybie offline. Ta funkcja nie jest jeszcze dostępna, ale wkrótce pojawi się w wersji zapoznawczej.

Elastyczny układ

Aby umożliwić tworzenie wydajnych rozwiązań dla urządzeń przenośnych, tabletów i komputerów (zgodnie z opiniami w usłudze UserVoice), wprowadziliśmy elastyczny układ. Kliknięcie przycisku Opcje powoduje rozwinięcie/zwinięcie widoku w celu wyświetlenia tych samych opcji na komputerze.

Responsive Page Design

Materiały przekazywane przez społeczność

Cała dokumentacja w witrynie docs.microsoft.com jest udostępniana jako zawartość typu „open source” oraz umożliwia dodawanie zawartości przez społeczność. Takie rozwiązanie wprowadziły już inne zespoły w firmie Microsoft, które udostępniły całą dokumentację lub jej część jako zawartość typu „open source”. Dotyczy to m.in. następujących produktów ASP.NET, Azure, .NET Core i Microsoft Graph.

W każdym artykule jest dostępny przycisk Edytuj (jak pokazano poniżej) umożliwiający przejście do źródłowego pliku Markdown w usłudze GitHub, za pomocą którego można łatwo przesłać żądanie ściągnięcia w celu naprawienia lub ulepszenia zawartości.

Mechanizmy przesyłania opinii

Pytania, komentarze i opinie użytkowników są dla nas bardzo ważne. Nawiązaliśmy współpracę z firmą Livefyre, aby umożliwić dodawanie komentarzy i notatek bocznych do wszystkich naszych artykułów. W górnej części każdego artykułu jest wyświetlany link do komentarzy, jak pokazano poniżej.

Comments link

Kliknięcie linku komentarzy powoduje przejście do dołu strony. W tym miejscu można dodawać i obserwować komentarze oraz oznaczać je jako polubione po zalogowaniu się przy użyciu poświadczeń konta usługi Twitter, Facebook, Google lub Yahoo albo konta Microsoft.

Comments at bottom

Możesz również dodawać notatki lub notatki boczne do każdego akapitu zawartości lub specjalnie wyróżnionego tekstu. W tym celu umieść kursor myszy na symbolu komentarza po prawej stronie i kliknij go, aby dodać komentarz w tekście.

Sidenote example

Udostępnianie w społeczności

Przycisk udostępniania w górnej części strony pozwala łatwo udostępniać zawartość w usługach Twitter i Facebook.

Sharing to Twitter and Facebook

Możesz też zaznaczyć zawartość artykułu przy użyciu kursora myszy, aby dodać komentarz lub udostępnić tę zawartość w usłudze Twitter lub Facebook bezpośrednio z poziomu menu kontekstowego, jak pokazano poniżej.

Select and comment or share content

Przyjazne adresy URL

Środowisko sieci Web jest dla nas bardzo ważne. Jako użytkowników witryn TechNet i MSDN zawsze irytowało nas to, że artykuły nie mają przyjaznych, łatwych do odczytania adresów URL. Oto przykład tego samego artykułu z nowym adresem URL.

Tworzenie motywów witryny sieci Web

Dodaliśmy również do artykułów selektor motywu, dzięki czemu można przełączyć między jasnym i ciemnym motywem. Ta kwestia pojawiała się w opiniach w usłudze UserVoice.

Light and Dark Theme Selector

Na poniższym obrazie pokazano różnicę między motywem jasnym i ciemnym.

Light and Dark themes

Kwestie podstawowe

Podstawowe kwestie, takie jak wydajność witryny, są niezwykle ważne. Wielu klientów w swoich opiniach w usłudze UserVoice prosiło nas o ulepszenia w tym zakresie. Czas ładowania strony w witrynie docs.microsoft.com jest o 50–300% krótszy, a geolokalizacja jest lepsza niż kiedykolwiek. Ponadto opracowaliśmy architekturę w pełni opartą na platformie Azure.

Chcemy poznać Twoją opinię!

Mamy nadzieję, że wersja zapoznawcza witryny docs.microsoft.com Ci się podoba. Wyślij swoją opinię na stronie https://aka.ms/sitefeedback. W przyszłych wpisach omówimy nasze plany dotyczące znaczących ulepszeń środowiska do obsługi materiałów referencyjnych i plany dotyczące lokalizacji zawartości.