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

Улучшение документации Teams

  • Статья

Документация Teams входит в библиотеку технической документации Microsoft Learn . Содержимое организовано в группы, называемые docsets, каждый из которых представляет группу родственных документов, управляемых как одна сущность. Статьи в одном наборе документов имеют одно и то же расширение URL-пути после learn.microsoft.com. Например, /learn.microsoft.com/microsoftteams/... это начало файлового пути к docset Teams. Статьи о Teams написаны на синтаксисе Markdown и размещаются на GitHub.

Настройка рабочей области

  • Установите в VS Code:
  1. Щелкните значок Расширения на боковой панели действий или используйте команду View => Extensions или CTRL+SHIFT+X и выполните поиск по запросу Docs Authoring Pack.
  2. Нажмите кнопку Установить.
  3. После установки кнопка Установить изменяется на кнопку Управление в виде шестеренки.

Ознакомьтесь с руководством участника документации Майкрософт

Руководство для участников содержит инструкции по созданию, публикации и обновлению технического контента на платформе Microsoft Learn .

Руководства Корпорации Майкрософт по написанию, стилю и содержимому

  • Руководство по стилю письма Майкрософт. Руководство по стилю письма (Майкрософт) — это комплексный ресурс для технических писателей, отражающий современный подход корпорации Майкрософт к голосу и стилю. Для удобства добавьте это интерактивное руководство в меню Избранное браузера.

  • Написание содержимого для разработчиков. Содержимое, специфичное для Teams, предназначено для аудитории разработчиков, обладающих глубоким пониманием основных концепций программирования и процессов. Важно, чтобы вы предоставляли четкие, технически точные сведения убедительным образом, сохраняя тон и стиль корпорации Майкрософт.

  • Написание пошаговых инструкций. Прикладное и интерактивное взаимодействие пользователей — отличный способ для разработчиков узнать о продуктах и технологиях Майкрософт. Представлять сложные или простые процедуры в прогрессивном формате естественно и понятно пользователям.

Справочник по MarkDown

Страницы Microsoft Learn написаны с использованием синтаксиса MarkDown и анализируются с помощью обработчика Markdig. Дополнительные сведения о конкретных тегах и соглашениях о форматировании см. в справочнике по Docs Markdown.

Пути к файлу

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

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

Важно!

Чтобы сослаться на статью, которая является частью платформы Teams:
 ✔ Используйте относительный путь без косой черты в начале.
 ✔ Включите расширение файла Markdown.
Например: parent directory/directory/path-to-article.md —>создание приложения для Microsoft Teams

Чтобы сослаться на статью Microsoft Learn, которая не входит в набор документов по платформе Teams, выполните следующие действия:
 ✔ Используйте относительный путь, начинающийся с косой черты.
 ✔ Не включайте расширение файла.
Например: /docset/address-to-file-location —>использование API Microsoft Graph для работы с Microsoft Teams

Чтобы сослаться на страницу за пределами Microsoft Learn, например GitHub, используйте полный https путь к файлу.

Примеры кода и фрагменты кода

Примеры кода играют важную роль для эффективного использования API и пакетов SDK. Хорошо представленные примеры кода могут объяснить механизм работы лучше, чем только описательный текст и инструктивная информация. Примеры кода должны быть точными, краткими, хорошо документированными и понятными для чтения. Код, который легко прочитать, должен быть простым для понимания, тестирования, отладки, обслуживания, изменения и расширения. Дополнительные сведения см. в статье о включении кода в статью.

Следующее действие

Устранение неполадок приложения Microsoft Teams

Дополнительные ресурсы