W witrynie docs.microsoft.com pojawi się nowy system opinii

Autorem tego wpisu jest Rob Eisenberg, starszy menedżer programów w zespole docs.microsoft.com.

Misją firmy Microsoft jest umożliwienie każdej osobie i każdej organizacji na planecie osiągania coraz więcej. Ta idea przyświecała nam, gdy tworzyliśmy witrynę docs.microsoft.com na podstawie otwartej platformy GitHub. Teraz przenosimy go na wyższy poziom, wprowadzając system opinii na temat dokumentacji oparty na usłudze GitHub.

Opinie na temat zawartości w usłudze GitHub

Choć nasza dokumentacja od samego początku znajdowała się w usłudze GitHub, mechanizm przesyłania opinii na temat zawartości korzystał z usługi Livefyre do obsługi komentarzy w artykułach. Usługa Livefyre to świetne rozwiązanie do obsługi komentarzy, ale nie do końca spełniała nasze potrzeby, tj. śledzenie problemów z zawartością zgłaszanych przez klientów, przypisywanie do nich właścicieli i utrzymywanie ich stanu.

Rozważaliśmy kilka możliwości wprowadzenia ulepszeń, ale cały czas wracaliśmy do jednego pytania, które nadawało kierunek dużej części naszej pracy: Gdyby nasza dokumentacja była traktowana tak, jak kod typu open source, czego byśmy użyli do rozwiązania problemu? Odpowiedź na to pytanie wydawała się oczywista: problemów usługi GitHub, więc zaczęliśmy eksperymentować z głębszą integracją interfejsów API usługi GitHub z naszymi stronami dokumentacji i utworzyliśmy pełny system obsługi opinii na podstawie infrastruktury usługi GitHub.

Nowy system umożliwia tworzenie problemów usługi GitHub bezpośrednio z poziomu strony zawartości, dzięki czemu można wchodzić w bardziej rozbudowane interakcje z autorami i zespołami produktów. Dostrzegasz problem związany z dokumentem? Błąd w przykładowym kodzie? Mylące objaśnienie? Pominięcie ważnej informacji? Przewiń do dołu strony, a następnie wybierz pozycję Prześlij opinię o dokumentacji.

Użytkownik logujący się i przesyłający opinię

Bezpośrednio na stronie dokumentacji możesz wyświetlić wszystkie otwarte i zamknięte problemy skojarzone z dokumentem. Dzięki temu zawsze wiesz, kiedy problemy zostały usunięte:

Prezentowanie otwartych i zamkniętych problemów

Do problemów, które są dla Ciebie istotne, możesz dodać komentarz, a nawet reakcję:

Dodawanie reakcji do problemów usługi GitHub

Teraz pracownicy firmy Microsoft mogą korzystać z pełnego zestawu funkcji problemów usługi GitHub, aby klasyfikować zgłoszone problemy i reagować na nie oraz planować i wprowadzać odpowiednie poprawki, a cały ten proces będzie transparentny.

Przykład opinii dotyczącej dokumentacji

Załóżmy, że za pomocą problemów usługi GitHub zgłosisz przerwany hiperlink w artykule. Nasz zespół sklasyfikuje problem oraz przypisze mu etykietę i właściciela, który będzie odpowiedzialny za poprawkę (lub zada dodatkowe pytania). Gdy właściciel prześle żądanie ściągnięcia, które rozwiązuje ten problem, otrzymasz powiadomienie (w zależności od ustawień powiadomień usługi GitHub), że problem został rozwiązany/zamknięty. Dzięki temu powstaje pozytywny cykl opinii.

Ponadto można stosować wszystkie standardowe przydatne funkcje znane z usługi GitHub, np. język Markdown w komentarzach, subskrypcje pojedynczych problemów lub całych repozytoriów, kanały informacyjne RSS z aktywnością organizacji, @wzmianki, osoby przydzielone itd. Uważamy, że większa integracja narzędzia typu open source zapewni nowe możliwości rozwoju i współpracy społeczności.

Oddzielenie opinii o produkcie

Jednym z problemów w poprzednim systemie było pomieszanie opinii dotyczących produktu i dokumentacji w jednym strumieniu. Klasyfikowanie i dalsza obsługa były niezwykle trudne, gdy nie wszystkie pozycje miały spójne etykiety. Podjęliśmy kroki w celu rozwiązania tego problemu przez wyraźne oddzielenie ich od siebie:

Przesyłanie opinii dotyczącej produktu

Teraz po kliknięciu przycisku Prześlij opinię o produkcie nastąpi przekierowanie bezpośrednio do witryny, w której zespół produktu skojarzonego z konkretną stroną dokumentacji obsługuje opinie dotyczące produktu.

Wprowadzanie

Pewnie się zastanawiasz, kiedy system opinii zostanie wprowadzony. Już kilka miesięcy temu wprowadziliśmy go pilotażowo w dokumentacji środowiska IDE programu Visual Studio oraz interfejsu wiersza polecenia platformy Azure. W połowie lutego zaczniemy wprowadzanie go w całej witrynie docs.microsoft.com.

Twoja opinia

Twoja opinia jest dla nas ważna, dlatego chcemy szybko udostępnić nowy system. Jest to nasz kolejny krok ulepszający opinie i zwiększający zaangażowanie, ale w żadnym wypadku nie jest to krok ostatni. Koniecznie napisz, co myślisz o tych zmianach, na platformie UserVoice lub oznacz nas w serwisie Twitter.