Поделиться через


Новая система отзывов приближается к docs.microsoft.com

Эта запись была написана Роба Эйзенберга, старшего руководителя программы в команде docs.microsoft.com.

Миссия Майкрософт заключается в том, чтобы расширить возможности каждого человека и каждой организации на планете, чтобы добиться большего. Это было одним из наших соображений, так как мы построен docs.microsoft.com на основе открытой платформы GitHub. Сегодня мы переходим на следующий уровень с переходом к новой системе обратной связи на основе GitHub.

Отзывы о содержимом на GitHub

Хотя наша документация была на GitHub с самого начала, наш механизм обратной связи с контентом использовал Livefyre для комментариев по статьям. Хотя Livefyre является отличным решением для комментариев, оказалось недостаточно для наших конкретных потребностей, что заключается в отслеживании, назначении владельцев и поддержании состояния проблем содержимого, поднятых клиентами.

Мы изучили ряд возможностей, чтобы сделать его лучше, но один вопрос, который руководствовал большую часть нашей работы, казалось, вновь устрашает: Если наша документация рассматривалась так же, как открытый исходный код, что бы мы использовали для решения этой проблемы? Ответ на вопрос казался очевидным: проблемы GitHub, поэтому мы начали экспериментировать с интеграцией API GitHub более глубоко в наши страницы документации, что позволяет создать полную систему обратной связи на основе инфраструктуры GitHub.

Благодаря новой системе теперь можно создавать проблемы GitHub непосредственно на странице содержимого, что позволяет взаимодействовать с авторами и командами продуктов. См. проблему с документом? Недопустимый пример кода? Запутанное объяснение? Критическое упущение? Просто прокрутите страницу до нижней части страницы и выберите Отправить отзыв о документации.

вход пользователей и отзыв

Все открытые и закрытые проблемы, связанные с документом, можно увидеть непосредственно на самой странице документации. Таким образом, вы всегда находитесь в курсе, когда все будет исправлено и решено:

Showcasing открытые и закрытые проблемы

Вы можете комментировать и даже добавлять реакции к вопросам, которые важны для вас:

Добавление реакций на проблемы GitHub

Теперь сотрудники Майкрософт могут использовать полную мощность проблем GitHub для обработки, реагирования, планирования и устранения обнаруженных проблем - и вы всегда будете иметь представление о процессе!

Пример обратной связи с документацией

Предположим, что вы запустите проблему с GitHub для сломанной гиперссылки в статье. Наша команда будет расследовать проблему, назначить метку и назначить владельца, чтобы исправить (или задать дальнейшие вопросы). Когда владелец отправляет запрос на вытягивание, который устраняет проблему, вы получите уведомление (на основе параметров уведомлений GitHub), что проблема устранена или закрыта, создавая виртуозный цикл обратной связи.

Кроме того, вы можете использовать все стандартные преимущества GitHub, такие как Markdown в комментариях, подписки на отдельные проблемы или целые репозитории, RSS-каналы деятельности организации, @ упоминания, назначаемые и многое другое! Мы считаем, что более глубокий уровень интеграции инструментов с открытым исходным кодом будет способствовать новым возможностям для роста сообщества и совместной работы.

Разделение отзывов о продукте

Одна из проблем, связанных с предыдущей системой, заключалась в сочетании между продуктами и документацией в одном потоке - это было крайне трудно по тризировать и отслеживать, когда не все элементы последовательно помечены. Мы шаг вперед по устранению этой проблемы путем создания четкого способа разделения двух:

отправки отзывов о продукте

Щелкнув Дайте отзыв о продукте, теперь вы перейдете непосредственно на сайт, где группа продуктов, связанная с определенной страницей документации, обрабатывает отзывы о продукте.

Roll-Out

Возможно, вам интересно, когда система отзывов будет жить. Мы пилотируем его в течение нескольких месяцев для интегрированной среды разработки Visual Studio и документации по Azure CLI. Начиная с середины февраля, мы начнем развертывание этого по всем docs.microsoft.com.

Ваши отзывы

Ваши отзывы важны для нас, поэтому мы хотим быстро получить эту новую систему в ваших руках. Хотя это наш следующий шаг в улучшении отзывов и участия на нашей платформе, это не означает, что наш последний шаг. Убедитесь, что ваши мысли об изменениях на GitHub, или пометьте нас в Twitter.