Actualización de la migración de MSDN y TechNet a docs.microsoft.com

  • Artigo

El autor de este artículo es Jeff Sandquist, vicepresidente corporativo, Relaciones con los desarrolladores.

Nos complace ofrecer una actualización importante sobre la migración del contenido de MSDN y TechNet a docs.microsoft.com. En esta entrada de blog se documentan los últimos pasos de un esfuerzo de toda la empresa para repasar la estructura de contenido, el formato y la infraestructura subyacente, así como para centralizar la documentación técnica de Microsoft en torno a un sitio.

De MSDN y TechNet a docs.microsoft.com

Microsoft Developer Network nació en 1992 como servicio de suscripción de clientes para proporcionar información técnica sobre la programación para Windows. Seis años más tarde, en 1998, se presentó el sitio MSDN Online, que hospedaba más de 250 000 páginas de contenido.

Captura de pantalla de MSDN Online en 1999

Después, el proceso de publicación consiste en crear contenido en Microsoft Word, convertirlo en HTML y publicarlo a través de una herramienta denominada pubwiz (Asistente para publicación). Durante más de 20 años, el proceso admitía la presentación de nuevos productos, servicios y actualizaciones, lo que dio lugar a la increíble cifra de 45 millones de páginas de contenido técnico.

A medida que el ciclo de lanzamiento de productos pasaba de años a meses, ha crecido la demanda de documentación actualizada accesible. El sistema de publicación necesitaba adaptarse a la velocidad de la ingeniería, por lo que hemos decidido cambiar la manera de administrar la documentación en Microsoft en la era de la nube. En noviembre de 2015, los miembros fundadores del equipo de docs.microsoft.com, Dan Fernandez, Mary McHale, Carol Zeumaulty Jeff Sandquist, escribieron un documento denominado "Una nueva esperanza" (en homenaje a Star Wars Episodio IV), en el que se describía la visión del nuevo sitio. Incluía un conjunto de principios clave:

  • Documentación técnica unificada. El nuevo sitio debe consolidar docenas de sitios web de documentación hospedados por Microsoft. Un desarrollador que está aprendiendo a crear una aplicación web controlada por datos solo debería tener que visitar un sitio para encontrar todo el contenido relevante sobre ASP.NET, Azure, Entity Framework o cualquier otra tecnología de Microsoft.
  • Experiencia del usuario mejorada. Un factor clave para definir el éxito de un sitio web es la experiencia que proporciona a sus clientes. El nuevo sitio debe tener un mejor rendimiento de carga, fuentes legibles, tablas de contenido accesibles, direcciones URL con un lenguaje natural, permitir la existencia de varias versiones y compatibilidad con navegadores móviles, y debe seguir las prácticas de diseño inclusivo mediante las características de accesibilidad y la compatibilidad con la internacionalización.
  • Democratización de la creación y la involucración de la comunidad. El nuevo sitio debe estar basado en estándares y herramientas de código abierto que permitan a cualquier persona crear y editar la documentación. Debe usar Markdown para el contenido, YAML para la documentación de la API generada automáticamente y basarse en GitHub como la capa de contenido subyacente, lo que permitiría el uso de comprobaciones de calidad automatizadas. La organización de GitHub MicrosoftDocs ha conseguido más de 7400 miembros y el repositorio de documentación de Azure es uno de los proyectos de código abierto que más rápido han crecido (un 470 % anual) y el quinto repositorio con más contribuciones de GitHub, tal como se muestra en The State of the Octoverse 2018.
  • Compatibilidad con la documentación de la API. El nuevo sitio debe tener compatibilidad total con la documentación de las API escritas para lenguajes de programación y plataformas que nuestros clientes usan, como .NET, Java, Python, JavaScript y TypeScript, PowerShell, CLI de Azure, Q#, OpenAPI y mucho más. La experiencia debe proporcionarse mediante la automatización, tener una cobertura de API de confianza y poder publicar documentación de API en minutos en lugar de semanas.
  • Modernización de la infraestructura de ingeniería. docs.microsoft.com debe ejecutarse en Azure, lo que permite reducir los costos de mantenimiento (con un ahorro superior a 7 millones de dólares), mejorar el tiempo de implementación de tres semanas a cada día (o más) y reducir la duplicación de la ingeniería.
  • Extensible de forma predeterminada. A medida que el sitio evolucione, debe ser capaz de satisfacer las necesidades de nuestros clientes de la manera más eficaz. Al realizar este compromiso, pudimos crear e integrar una nueva experiencia de aprendizaje interactivo: Microsoft Learn, así como nuestro explorador de códigos de ejemplo.

Con una plataforma moderna ya implementada, trabajamos para garantizar que no se pierde contenido valioso al migrarlo al nuevo sitio. A continuación encontrará más información sobre nuestro progreso.

Bibliotecas de MSDN y TechNet

Estado: ✅ completo

Iniciamos la migración de MSDN Library y Biblioteca de TechNet a docs.microsoft.com a finales de 2017, y la hemos completado este año.

Las bibliotecas proporcionaban la documentación de los productos de Microsoft, incluida la documentación de la API, el código de ejemplo y los artículos técnicos. Originalmente estaba disponible en CD, y después el contenido se migró a la red con el lanzamiento de los sitios web de MSDN y TechNet.

La migración requirió la conversión de múltiples formatos basados en XML a Markdown para contenido editado por personas y YAML para la documentación de API generada automáticamente, lo que abarcaba más de 100 conjuntos de contenido. Nos hemos asegurado de que las redirecciones de páginas están en vigor para millones de páginas web, evitando vínculos rotos a los que se haga referencia fuera de nuestro sitio, como blogs y foros.

Para ofrecerle una visión del volumen de contenido con el que trabajamos, aquí se incluyen algunas estadísticas:

Si ha marcado contenido de MSDN o TechNet, los vínculos se redirigirán sin problemas a su nueva ubicación en docs.microsoft.com.

MSDN Magazine

Estado: ✅ completo

El último número de MSDN Magazine se publicó el 1 de noviembre de 2019. Hemos enviado un mensaje final a los lectores y creadores en la edición de agosto de MSDN Magazine.

El contenido de MSDN Magazine publicado en MSDN se ha migrado a docs.microsoft.com/archive.

Los suscriptores de MSDN Magazine que hayan pagado por sus suscripciones recibirán un reembolso prorrateado en función del tiempo restante de su suscripción. Las comprobaciones de reembolso se enviarán por correo electrónico una vez publicado el número de noviembre. Este cambio no afecta a la suscripción a la plataforma MSDN.

Boletines de Microsoft Developer y TechNet Flash

Estado: ✅ completo

Los Boletines publicados en MSDN y TechNet se han migrado a docs.microsoft.com/archive.

Los suscriptores actuales seguirán recibiendo estos boletines. Podemos evolucionar y cambiar el formato, así como la programación de publicación.

Si ya no quiere seguir suscrito a nuestros boletines, puede cancelar la suscripción en el siguiente correo electrónico que reciba.

Blogs de MSDN y TechNet

Estado: ✅ completo

En julio de 2019, convertimos los sitios de los blogs de MSDN y los blogs de TechNet en sitios de solo lectura. Los blogs de MSDN y TechNet se han migrado y archivado en docs.microsoft.com/archive.

Si ha guardado en favoritos algún blog de MSDN o TechNet, los vínculos a estos se redirigirán a la nueva ubicación en docs.microsoft.com/archive, o a otros sitios de blogs si son blogs que se mantienen y actualizan activamente.

Estado: ✅ Completo

Hemos redirigido todas las páginas de la galería de código de MSDN al explorador de ejemplos y los ejemplos de claves archivadas en GitHub a la organización de MicrosoftArchive. Obtenga más información sobre este proceso en esta entrada de blog reciente.

Puede encontrar los ejemplos de código más actualizados en docs.microsoft.com/samples.

Estado: 🚧 En curso

TechNet Gallery se retirará a principios de 2020. En diciembre de 2019, el sitio pasará a ser de solo lectura y ya no aceptará nuevas contribuciones de la comunidad. Información y anuncios adicionales que se deben seguir.

Use docs.microsoft.com/samples para buscar los ejemplos de código más actualizados. Si ya ha contribuido a TechNet Gallery, asegúrese de migrar los ejemplos a una ubicación administrada de forma personal, como su propio repositorio de GitHub.

Sitio wiki de TechNet

Estado: 🚧 En curso

Estamos trabajando en un plan de migración más concreto y una programación para la wiki de TechNet. Vuelva más tarde para obtener más información. En este momento, puede seguir participando e interactuando con el contenido de la wiki.

Foros de MSDN y TechNet

Estado: 🚧 En curso

Anunciamos la versión preliminar de Microsoft Q&A, que reemplaza los foros de MSDN y TechNet. Para garantizar una transición fluida y minimizar cualquier interrupción, desglosamos la migración en varias fases. Esperamos completar la migración a mediados de 2020. Vuelva más tarde para obtener más información.

Channel 9

Estado: 🚧 En curso

Channel 9 sigue siendo una inversión importante para el contenido de vídeo centrado en desarrolladores. Estamos trabajando en una ruta de migración que integrará mejor nuestros vídeos y contenido técnico de Channel 9. Vuelva más tarde para obtener más información.

Comentarios

Nos complace seguir invirtiendo en nuestra plataforma y asegurarnos de que obtiene la documentación técnica más pertinente y de confianza para todo el ecosistema de Microsoft. Envíenos sus ideas y sugerencias de mejora a GitHub y Twitter.