Microsoft Docs

Microsoft Docs
URL docs.microsoft.com
Коммерческий да
Тип сайта База знаний
Регистрация необязательная
Язык (-и) многоязычный
Владелец Microsoft
Создатель Microsoft
Начало работы июнь 2016
Текущий статус работает

Microsoft Docs — библиотека технической документации для конечных пользователей, разработчиков и IT-специалистов, работающих с продуктами Microsoft. Сайт Microsoft Docs содержит технические спецификации, статьи, руководства, обучающие материалы, справочники по API, примеры кода и другую информацию, относящуюся к программным продуктам и веб-сервисам Microsoft. Microsoft Docs был запущен в 2016 году и должен был стать заменой библиотек MSDN и TechNet, на которых ранее размещались подобные материалы.[1][2]

Структура и возможности

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

Большая часть материалов имеют открытый исходный код и у пользователей имеется возможность отправить предложение по внесению изменений в них. Каждая статья представлена файлом с разметкой Markdown в репозитории на GitHub.[3][4]

Программное обеспечение для редакторов

Microsoft выпустили пакет расширений Visual Studio Code — Docs Authoring Pack, призванный облегчить редактирование статей на Microsoft Docs.[5] В его состав входят:

  • Docs Markdown — утилита для редактирования Markdown с поддержкой форматирования, создания списков и таблиц, вставки ссылок и изображений. В отличие от других редакторов, Docs Markdown поддерживает нестандартные расширения Markdown для docs.microsoft.com, например примечания и фрагменты кода.
  • DocFX — средство предварительного просмотра с ограниченной поддержкой специфичных для docs.microsoft.com элементов Markdown.[6]
  • markdownlint — средство анализа разметки Markdown на соответствие стандартам и общепринятым соглашениям о стиле.

История

Предварительная версия Microsoft Docs была запущена в июне 2016 г., изначально она содержала только документацию по .NET.[4]. Процесс переноса основной части материалов из библиотек MSDN и TechNet занял приблизительно два года. Ключевые события:

  • Ноябрь 2016: добавлена документация по Azure, Visual Studio 2017 RC, C++, ASP.NET Core, Entity Framework Core и SQL для Linux.[7]
  • Сентябрь 2017: документация по Office SharePoint, Windows 10, Windows Server 2016, и BizTalk Server ITPro перенесена с MSDN/TechNet.[8]
  • Февраль 2018: добавлена новая система отзывов, основанная на GitHub issues.[9]
  • Ноябрь 2018: техническая документация по OneDrive перенесена с TechNet на Microsoft Docs[10]

См. также

Примечания

  1. ↑ Mark J. Price: C# 7 and .NET Core: Modern Cross-Platform Development Packt Publishing Ltd, 2017, p. 126
  2. ↑ Jonathan Allen. MSDN/TechNet Being Replaced by Open Source Project docs.microsoft.com Архивная копия от 26 сентября 2020 на Wayback Machine Новости InfoQ
  3. ↑ Sergio Govoni. Microsoft Docs and Localization Community Platform. Дата обращения: 15 марта 2019. Архивировано из оригинала 18 марта 2019 года.
  4. ↑ 1 2 Introducing Microsoft Docs. Microsoft. Дата обращения: 15 марта 2019. Архивировано 12 апреля 2019 года.
  5. ↑ Microsoft Docs blog: Docs extension. Microsoft. Дата обращения: 15 марта 2019. Архивировано 25 сентября 2018 года.
  6. ↑ Chris Ward. DocFX: The Next Documentation Tool to Consider? Дата обращения: 15 марта 2019. Архивировано 14 апреля 2018 года.
  7. ↑ Microsoft Docs November Update. Microsoft. Дата обращения: 15 марта 2019. Архивировано 2 июня 2019 года.
  8. ↑ Microsoft Docs September 2017 release notes. Microsoft. Дата обращения: 15 марта 2019. Архивировано 16 марта 2020 года.
  9. ↑ A New Feedback System Is Coming to docs.microsoft.com. Microsoft. Дата обращения: 15 марта 2019. Архивировано 16 марта 2019 года.
  10. ↑ João Carrasqueira. Microsoft is moving its OneDrive technical documentation to Microsoft Docs Архивная копия от 27 ноября 2018 на Wayback Machine Neowin News

Ссылки