Wprowadzenie witryny docs.microsoft.com

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

Dzisiaj ogłaszamy wersję zapoznawcza nowej usługi https://docs.microsoft.comdokumentacji, pokazującą zawartość wspierającą nasze produkty 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 internetowej zawiera zawartość *tylko* dla dokumentacji pakietu Enterprise Mobility (która składa się z usługi Advanced Threat Analytics, Azure Active Directory, Azure Remote App, 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

Zacznijmy od przykładowej strony dokumentacji pokazanej poniżej i przedstawimy niektóre nowe funkcje w witrynie.

Czytelność

Aby poprawić czytelność zawartości, ustawiliśmy stałą szerokość zawartości witryny. Badania śledzenia oczu wykazały, że można poprawić zrozumienie i szybkość czytania z ustawioną szerokością zawartości, ponieważ trudno jest obserwować długie przejścia od lewej do prawej. 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. Zwiększyliśmy również rozmiar czcionki dla nawigacji po lewej stronie i sam tekst— coś, o co prosili klienci (UserVoice — zwiększ rozmiar czcionki).

Szacowany czas czytania

Innym prostym ulepszeniem, które wprowadziliśmy na podstawie danych wejściowych, jest zapewnienie szacowanego czasu czytania artykułu. Wiemy, że wielu z Was uczy się/ocenia technologię kilka minut między spotkaniami i częściej czytasz artykuły, jeśli wiesz, ile czasu jest wymagane. Dodaliśmy również daty utworzenia zawartości, aby ułatwić klientom sprawdzenie aktualności informacji, na podstawie opinii w usłudze UserVoice.

Nawigowanie po zawartości i witrynie

Jednym z kluczowych obszarów inwestycji w oparciu o wywiady klientów i opinie użytkownikówVoice były ulepszenia nawigacji witryny, architektury informacji i organizacji zawartości w oparciu o intencję klienta. 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:

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

Zmniejszenie długości artykułów

Innym typowym elementem opinii było to, że nasza zawartość czasami może być przytłaczająca ze względu na jego długość i że długie artykuły są trudniejsze do poruszania się i znajdowania szukanych treści. Aby rozwiązać ten problem, podzieliliśmy wiele dłuższych artykułów na mniejsze kroki logiczne i udostępniliśmy przyciski Wstecz i Dalej w dolnej części artykułów, aby nawigować między krokami w samouczku wieloczęściowym, jak pokazano poniżej.

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.

Elastyczne środowisko

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.

Współtworzenie w ramach społeczności

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ę w [Livefyre](https://web.livefyre.com/) celu udostępnienia komentarzy i przypisów bocznych we wszystkich naszych artykułach. W górnej części każdego artykułu zobaczysz link do komentarzy, jak pokazano poniżej.

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.

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.

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.

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.

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 nowymi adresami URL.

• Przed:<https://technet.microsoft.com/library/dn646983.aspx>

• Po:<https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune>

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.

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

Podstawy

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. Utworzyliśmy również architekturę, która działa 100% 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, aby znacznie poprawić środowisko zawartości referencyjnej i nasze plany lokalizacji zawartości.