Dokumentacja Stack Overflow dla deweloperów korzystających z produktów firmy Microsoft

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

Informujemy o rozpoczęciu partnerskiej współpracy z serwisem Stack Overflow, mającej na celu obsługę dokumentacji Stack Overflow dla deweloperów korzystających z produktów firmy Microsoft. W ramach tego ogłoszenia ogłaszamy, że zawartość dokumentacji usługi Stack Overflow zostanie zintegrowana z zawartością referencyjną interfejsu API docs.microsoft.com w przyszłości. Firma Microsoft od dawna współpracuje z firmą Stack Overflow w formie sponsorowanych tagów, a uruchomienie dokumentacji Stack Overflow umożliwia społeczności łatwe tworzenie i głosowanie nad przykładami kodu przy użyciu .NET Framework, platformy Xamarin i innych produktów i technologii firmy Microsoft.

Wspólne cele

Zarówno docs.microsoft.com, jak i Stack Overflow miały wspólne cele — chcemy ułatwić społeczności współtworzenie doskonałej dokumentacji dotyczącej korzystania z produktów i usług. Oba zestawy zawartości mają otwartą licencję, używają języka Markdown jako formatu zawartości i łatwo włączają współtworzenie społeczności (kliknij pozycję Edytuj na dowolnej stronie docs.microsoft.com).

Krótki przewodnik po stosie Overflow dla deweloperów platformy .NET

Po pierwszym nadejściu dokumentacji stackOverflow znajdziesz znaną kategoryzację opartą na tagach dostępnych tematów. Na pierwszy rzut oka zobaczysz wszystkie tagi utworzone przez społeczność StackOverflow. Po filtrowaniu według tagu zostanie wyświetlona lista z kilkoma ważnymi metrykami wyświetlanymi bezpośrednio z góry — liczba żądań tematów, proponowanych zmian i żądań ulepszeń.

Żądanie tematu

Niewielu deweloperów rozwiązało trudne problemy bez pomocy odbiorców StackOverflow. Wraz z naszymi współpracownikami, rówieśnikami i legendami społeczności, którzy monitorują stackOverflow pod kątem pytań związanych z własnymi produktami, utworzyliśmy sieć informacji zorganizowanych według tagów. Dokumentacja zwraca się do zaangażowania odbiorców w zbiorcze budowanie wiedzy, dając nam miejsce na prośbę o pomoc — sekcja "Żądane tematy" każdego tagu daje społeczności miejsce do identyfikowania typowych problemów.

Klikając pozycję "Utwórz temat", możesz utworzyć zawartość dla tematu, podać własne przykłady kodu i dokumentację. Środowisko zawiera wskazówki dotyczące tego, gdzie udostępnić każdą sekcję zawartości, którą można edytować przy użyciu składni języka Markdown, jeśli wolisz. Podczas tworzenia tematów postęp jest zapisywany w prawej nawigacji, gdzie można zobaczyć całą zawartość roboczą, która nie została jeszcze ukończona lub wysłana do przeglądu.

Znane środowisko wyświetlania kodu

Podobnie jak w przypadku witryny StackOverflow Q&A, kod poszczególnych tematów jest przedstawiony w jasnym, zwięzłym formacie, dzięki czemu można kopiować-edytować i uczyć się od prostego czytania kodu. Deweloperzy mogą w górę/w dół przykłady kodu głosowania, podobnie jak odpowiedzi w witrynie Stack Overflow.

Przyszła integracja

W przyszłości docs.microsoft.com zintegrowa listę wyselekcjonowanych przykładów dokumentacji Stack Overflow bezpośrednio w dokumentacji interfejsu API firmy Microsoft. Deweloperzy patrzący na dokumentację interfejsu API firmy Microsoft zobaczą zarówno przykłady utworzone przez firmę Microsoft, jak i przykłady stack Overflow utworzone przez społeczność. Przykłady zostaną wyselekcjonowane, aby upewnić się, że przykłady kodu używają ustalonych wytycznych dotyczących kodowania platformy .NET i najlepszych rozwiązań. W przyszłości udostępnimy więcej szczegółów na temat tej integracji.