Dokumentacja stack Overflow dla deweloperów firmy Microsoft

Ten wpis został napisany przez Jeff Sandquist, dyrektor generalny działu Cloud + Enterprise.

Dziś ogłaszamy partnerstwo z firmą Stack Overflow w celu obsługi dokumentacji Stack Overflow dla deweloperó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 postaci 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 platformy .NET Framework, platformy Xamarin i innych produktów i technologii firmy Microsoft.

Cele wspólne

Zarówno docs.microsoft.com, jak i Stack Overflow miały wspólne cele — chcemy ułatwić i 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 przepełnieniu stosu 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, osobami równorzędnymi i legendami społeczności, którzy monitorują usługę StackOverflow pod kątem pytań związanych z ich własnymi produktami, utworzyliśmy sieć informacji zorganizowanych według tagów. Dokumentacja wykorzystuje zaangażowanie 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ść 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órej jeszcze nie ukończono lub wysłano do przeglądu.

Znane środowisko wyświetlania kodu

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

Integracja w przyszłości

W przyszłości docs.microsoft.com zintegruje wyselekcjonowana listę przykładów dokumentacji stack Overflow bezpośrednio w dokumentacji interfejsu API firmy Microsoft. Deweloperzy patrząc na dokumentację interfejsu API firmy Microsoft zobaczą zarówno przykłady utworzone przez firmę Microsoft, jak i przykłady usługi 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 dotyczących tej integracji.