Новости о переносе MSDN и TechNet на docs.microsoft.com

  • Статья

Автор записи — Джефф Сэндквист (Jeff Sandquist), вице-президент корпорации по взаимодействию с разработчиками.

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

С MSDN и TechNet на docs.microsoft.com

Сеть разработчиков Microsoft Developer Network (MSDN) была создана в 1992 г. как служба подписки, предоставлявшая техническую информацию о программировании для Windows. Шесть лет спустя, в 1998 г., был запущен сайт MSDN Online, содержавший более 250 000 страниц.

Снимок экрана MSDN Online в 1999 г.

В то время процесс публикации состоял из создания содержимого в Microsoft Word, преобразования его в HTML и публикации с помощью средства pubwiz (мастер публикации). Более 20 лет этот процесс сопровождал выпуск новых продуктов, служб и обновлений. В результате накопилось 45 миллионов страниц технической документации!

По мере того, как цикл выпуска продуктов сокращался с лет до месяцев, потребность в обновлении документации росла. Систему публикации надо было привести в соответствие скорости разработки, поэтому в эпоху облаков мы решили переосмыслить способы управления документацией Майкрософт. В ноябре 2015 г. члены-основатели команды docs.microsoft.com — Дэн Фернандес (Dan Fernandez), Мэри Макхейл (Mary McHale), Кэрол Земо (Carol Zeumault) и Джефф Сэндквист (Jeff Sandquist) — написали документ под названием «A New Hope» («Новая надежда», в честь эпизода IV «Звездных Войн»), где изложили свое видение нового сайта. Документ включал в себя набор ключевых руководящих принципов:

  • Единая техническая документация. Новый сайт должен консолидировать десятки веб-сайтов документации, поддерживаемых корпорацией Майкрософт. Например, разработчику, создающему управляемое данными веб-приложение, будет достаточно посетить только один сайт, чтобы найти всю нужную информацию об ASP.NET, Azure, Entity Framework или любой другой технологии корпорации Майкрософт.
  • Улучшенное взаимодействие с пользователем. Ключевым фактором, определяющим успех веб-сайта, является интерфейс, который сайт предоставляет пользователям. Новый сайт должен иметь более высокую скорость загрузки, легко читаемые шрифты, доступные оглавления, понятные для человека URL-адреса, поддержку управления версиями, совместимость с мобильными браузерами, а также следовать практикам инклюзивного дизайна при помощи функций специальных возможностей и поддерживать интернационализацию.
  • Демократизация авторства и вовлечение сообщества. Новый сайт должен быть основан на стандартах и средствах с открытым кодом, которые позволяют любому участнику создавать и редактировать документацию. Он должен использовать Markdown для контента, YAML для автоматически генерируемой документации по API и полагаться на GitHub в качестве базового уровня содержимого, что позволило бы использовать автоматические проверки качества. Организация MicrosoftDocs на GitHub выросла до 7400 членов, а репозиторий документации по Azure является одним из самых быстрорастущих проектов с открытым кодом (470 % в год) и пятым по объему участия репозиторием во всем GitHub, согласно «The State of the Octoverse 2018»!
  • Поддержка документации по API. Новый сайт должен иметь первоклассную поддержку документации по API для языков программирования и платформ, используемых клиентами Майкрософт, в том числе .NET, Java, Python, JavaScript и TypeScript, PowerShell, Azure CLI, Q#, OpenAPI и других. Рабочий процесс должен быть основан на автоматизации, иметь надежный охват API и возможность публиковать документацию по API за минуты, а не за недели.
  • Модернизация инженерной инфраструктуры. Сайт docs.microsoft.com должен работать в Azure, что позволяет сократить затраты на обслуживание (экономия более 7 млн долларов), повысить частоту развертывания с раза в три недели до ежедневного (или чаще) и уменьшить число инженерных задач.
  • Расширение по умолчанию. Развиваясь, сайт должен быть в состоянии удовлетворить потребности наших клиентов наиболее эффективным способом. С учетом этого требования мы создали и интегрировали новую службу интерактивного обучения — Microsoft Learn, а также браузер примеров кода.

Имея современную платформу, мы обязаны не потерять ценный контент, а перенести его на новый сайт. Ниже вы найдете дополнительные сведения о том, как идут дела.

Библиотеки MSDN и TechNet

Состояние: ✅ выполнено

Мы начали перенос библиотек MSDN и TechNet на docs.microsoft.com в конце 2017 г. и завершили его в этом году.

Библиотеки предоставляли документацию по продуктам Майкрософт, включая документацию по API, примеры кода и технические статьи. Содержимое, изначально доступное на компакт-дисках, было перенесено в Интернет при запуске веб-сайтов MSDN и TechNet.

Перенос потребовал преобразования различных форматов на основе XML в Markdown для редактируемого контента и в YAML для автоматически создаваемой документации по API более чем для 100 различных наборов содержимого. Мы обеспечили перенаправления для миллионов веб-страниц, чтобы продолжали работать внешние ссылки на наш сайт, например, с блогов и форумов.

Немного статистики, чтобы дать представление о размере проделанной работы:

Если вы добавили в закладки ссылки на содержимое MSDN или TechNet, ссылки будут легко перенаправлены в новое расположение на docs.microsoft.com.

Журнал MSDN

Состояние: ✅ выполнено

Последний выпуск MSDN Magazine был опубликован 1 ноября 2019 г. Мы поместили заключительное сообщение читателям и авторам в августовском выпуске журнала.

Содержимое журнала, опубликованное на MSDN, было перемещено на docs.microsoft.com/archive.

Владельцы платных подписок на журнал получат возмещение, рассчитанное с учетом оставшегося времени подписки. Чеки возврата денежных средств будут высланы после публикации ноябрьского выпуска. Это изменение не затрагивает подписку на платформу MSDN.

Информационные бюллетени Microsoft Developer и TechNet Flash

Состояние: ✅ выполнено

Бюллетени, опубликованные на MSDN и TechNet, были перемещены на docs.microsoft.com/archive.

Подписчики продолжат получать эти информационные бюллетени. Формат и график публикации могут быть изменены.

Если вы больше не хотите получать информационные бюллетени, отмените подписку в следующем полученном вами электронном письме.

Блоги MSDN и TechNet

Состояние: ✅ выполнено

Мы перевели блоги MSDN и блоги TechNet в режим только для чтения в июле 2019 г. Блоги MSDN и TechNet были перенесены и архивированы в docs.microsoft.com/archive.

Если вы добавили в закладки ссылки на блоги MSDN или TechNet, ссылки будут перенаправлены в новое расположение на docs.microsoft.com/archive или на другие блоги, если они активно поддерживаются и обновляются.

Состояние: ✅ выполнено

Мы перенаправили все страницы коллекции исходных кодов MSDN в браузер примеров кода и заархивировали ключевые примеры на GitHub в организации MicrosoftArchive. Подробно об этом процессе читайте в недавней записи нашего блога.

Самые актуальные примеры кода можно найти на docs.microsoft.com/samples.

Состояние: 🚧 выполняется

TechNet Gallery перестанет поддерживаться в начале 2020 г. В декабре 2019 г. этот сайт будет переведен в режим только для чтения и больше не будет принимать новые публикации сообщества. Дополнительные объявления и информация последуют.

Ищите самые актуальные примеры кода на docs.microsoft.com/samples. Если вы ранее участвовали в TechNet Gallery, не забудьте перенести ваши примеры кода в расположение, управляемое вами, например в собственный репозиторий GitHub.

TechNet Wiki

Состояние: 🚧 выполняется

Мы работаем над более конкретными планом и графиком переноса TechNet Wiki. Подробности мы сообщим позже. В настоящее время вы можете продолжать работать с вики-контентом.

Форумы MSDN и TechNet

Состояние: 🚧 выполняется

Мы объявили о выпуске предварительной версии Microsoft Q&A, которая заменяет форумы MSDN и TechNet. Чтобы переход был плавным и вызывал минимальные проблемы у пользователей, мы разделили его на несколько этапов. Завершение перехода ожидается в середине 2020 г. Подробности мы сообщим позже.

Channel 9

Состояние: 🚧 выполняется

Channel 9 остается важным источником видеоматериалов, ориентированных на разработчиков. Мы работаем над способом переноса, который позволит наилучшим образом интегрировать видео и техническое содержимое из Channel 9. Подробности мы сообщим позже.

Нам очень интересно ваше мнение!

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