Проверка документации с помощью проблем с GitHub

Завершено

Одним из наиболее полезных способов участия в Microsoft Learn является предоставление отзывов непосредственно в статье документации. Используя ссылку обратной связи на странице, вы можете указать изменения, предложения, вопросы или другие аналитические сведения при просмотре. Так как большинство содержимого документации Microsoft Learn хранится в репозиториях GitHub, вы можете предоставить отзыв с помощью процесса GitHub, называемого отправкой проблемы GitHub.

Проблема в GitHub — это средство, которое позволяет пользователям технологий, инженерам и другим посетителям Microsoft Learn поделиться и отслеживать отзывы о конкретной статье. Вы заполните форму, чтобы задокументировать отзыв и опубликовать ее в репозитории исходной статьи в GitHub, где автор или владелец будет уведомлен. Любой пользователь, посещающий репозиторий GitHub, может видеть проблемы. Они служат полезным способом сбора и хранения ценных отзывов, таких как сообщения об ошибках, запросах функций или заметках.

Зачем просматривать содержимое в GitHub?

Предоставление отзывов контента на GitHub — это прямой способ внести свой вклад в тему, о которую вы страстно или осведомлены. Это означает, что вы можете добавить свои идеи по мере изучения темы в документации Майкрософт. Внося свои аналитические сведения в пул знаний, помогает улучшить возможности продуктов Майкрософт для миллионов других пользователей. Ваши отзывы перемещают содержимое для других посетителей Microsoft Learn, которые полагаются на продукты Майкрософт и их вспомогательное содержимое.

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

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

Как дать отзыв о содержимом

Помните, что многие статьи документации в Microsoft Learn хранятся в репозиториях GitHub. Многие репозитории GitHub имеют включенные проблемы с GitHub. Если этот параметр включен, можно найти вариант отправки отзывов на эту страницу в нижней части статьи learn.microsoft.com.

Снимок экрана: параметры обратной связи в нижней части статьи документации.

Вот как отправить проблему в GitHub из статьи Microsoft Learn:

  1. Перейдите к статье документации Microsoft Learn, в которой вы хотите отправить отзыв.

  2. В нижней части статьи найдите заголовок с меткой "Отзывы". Рядом с вопросом , была ли эта страница полезной?есть кнопки для да и нет. Нажмите кнопку, чтобы указать, была ли статья полезной. Откроется форма, в которой можно заполнить комментарии.

  3. Выберите причину вашего отзыва.

  4. В следующем текстовом поле опишите отзывы и укажите необходимый контекст.

  5. По завершении нажмите кнопку "Отправить".

Снимок экрана: пустая форма проблем с GitHub для отправки отзывов в статье документации.

Автор статьи или другие владельцы контента уведомляются при отправке вашего запроса.