Документация по Stack Overflow для разработчиков Майкрософт

Публикацию подготовил Джефф Сэндквист (Jeff Sandquist), директор подразделения Cloud and Enterprise.

Мы рады объявить о партнерстве с платформой Stack Overflow в рамках информационной поддержки (документации по Stack Overflow), совместно оказываемой разработчикам Майкрософт. В рамках этого объявления мы информируем о том, что в будущем содержимое Stack Overflow Documentation будет интегрировано в справочное содержимое, связанное с API docs.microsoft.com. Корпорация Майкрософт уже давно является партнером Stack Overflow, предоставляя спонсируемые теги. Благодаря запуску Stack Overflow Documentation сообщество может легко создавать и выбирать путем голосования примеры кода с использованием .NET Framework, Xamarin и других продуктов и технологий Майкрософт.

Общие цели

И у docs.microsoft.com, и у Stack Overflow общие цели: мы хотим, чтобы сообщество без усилий предоставляло исчерпывающую документацию по использованию продуктов и служб. Оба типа содержимого имеют открытую лицензию, используют разметку в качестве формата и позволяют без усилий вносить вклад сообщества (нужно просто щелкнуть "Изменить" на любой странице docs.microsoft.com).

Краткий обзор Stack Overflow для разработчиков .NET

Когда вы впервые перейдете в Stack Overflow Documentation, вы обнаружите знакомую категоризацию доступных тем на основе тегов. Вы увидите все теги, ранее созданные сообществом Stack Overflow. После того, как вы отфильтруете содержимое по тегу появится список с несколькими важными метриками: количество запросов тем, предлагаемых изменений и запросов на улучшение.

Запрос темы

Немногим разработчикам удавалось решать сложные задачи без помощи аудитории Stack Overflow. Вместе с нашими коллегами и легендами сообщества, которые отслеживают в StackOverflow вопросы, связанные с их собственными продуктами, мы создали сеть информации, упорядоченной по тегам. Проект документации опирается на приверженность аудитории коллективному накоплению знаний. Это место, где можно попросить о помощи, — раздел Requested Topics (Запрошенные темы) каждого тега позволяет сообществу выявлять общие проблемы.

Щелкнув Create Topic (Создать тему), вы можете создать содержимое, связанное с определенной темой, а также предоставить собственные примеры кода и документацию. Этот интерфейс содержит рекомендации о том, где можно предоставить каждый раздел содержимого, который можно редактировать с помощью синтаксиса Markdown, если вы предпочитаете его использовать. Когда вы создаете темы, ваш прогресс сохраняется в области навигации слева, где вы можете увидеть все черновики содержимого, которые вы еще не завершили или не отправили на рассмотрение.

Знакомый интерфейс для просмотра кода

Как и в разделе Q&A на сайте Stack Overflow, код для отдельных тем представлен в четком и лаконичном формате, поэтому вы можете копировать, редактировать, использовать или учиться, просто читая код. Разработчики могут голосовать за примеры кода так же, как и за ответы на сайте Stack Overflow.

Предстоящая интеграция

В будущем docs.microsoft.com интегрирует отобранный список примеров документации Stack Overflow непосредственно в документацию по Microsoft API. Разработчики, просматривающие справочник по Microsoft API, увидят как примеры, созданные корпорацией Майкрософт, так и примеры, созданные сообществом Stack Overflow. Примеры будут отобраны, чтобы убедиться, что при создании кода использовались утвержденные рекомендации и лучшие практики программирования на .NET. Мы опубликуем более подробную информацию об этой интеграции в будущем.