Uma atualização na migração do MSDN e do TechNet para o docs.microsoft.com

  • Artigo

Esta postagem foi escrita por Jeff Sandquist, vice-presidente corporativo, Relações com desenvolvedores.

Hoje, temos o prazer de fornecer uma atualização importante sobre a migração do conteúdo do MSDN e do TechNet para o docs.microsoft.com. Esta postagem no blog documenta as últimas etapas de um esforço de toda a empresa para reformular a estrutura do conteúdo, o formato e a infraestrutura subjacente, bem como centralizar a documentação técnica da Microsoft em um só site.

Do MSDN e do TechNet para o docs.microsoft.com

Em 1992, nasceu o Microsoft Developer Network como um serviço de assinatura do cliente para fornecer informações técnicas sobre programação para Windows. Seis anos mais tarde, em 1998, o site MSDN Online foi lançado, hospedando mais de 250 mil páginas de conteúdo.

Captura de tela do MSDN Online em 1999

Naquela época, o processo de publicação consistia em criar conteúdo no Microsoft Word, convertê-lo em HTML e publicar por meio de uma ferramenta chamada pubwiz (Assistente de Publicação). Por mais de 20 anos, o processo deu suporte ao lançamento de novos produtos, serviços e atualizações, resultando em um número impressionante de 45 milhões de páginas de conteúdo técnico!

À medida que o ciclo de lançamento de produtos passou de anos para meses, a demanda por uma documentação atualizada e acessível aumentou. O sistema de publicação precisava estar à altura da velocidade da engenharia e, por isso, decidimos reinventar a forma como gerenciamos a documentação na Microsoft na era da nuvem. Em novembro de 2015, os membros fundadores da equipe do docs.microsoft.com, Dan Fernandez, Mary McHale, Carol Zeumault e Jeff Sandquist, escreveram um documento chamado “Uma nova esperança” (uma homenagem ao Episódio IV de Guerra nas Estrelas), que descrevia a visão para o novo site. Ele incluía um conjunto dos princípios orientadores mais importantes:

  • Documentação técnica unificada. O novo site deveria consolidar as dezenas de sites de documentação hospedados pela Microsoft. Um desenvolvedor que estiver aprendendo a criar um aplicativo Web controlado por dados só precisará visitar um único site para encontrar todo o conteúdo relevante sobre ASP.NET, Azure, Entity Framework ou qualquer outra tecnologia da Microsoft.
  • Melhor experiência do usuário. Um fator-chave na definição do sucesso de um site é a experiência que ele oferece aos clientes. O novo site deveria ter um melhor desempenho de carregamento, fontes legíveis, sumários acessíveis, URLs legíveis por humanos, suporte para controle de versão, compatibilidade com navegadores móveis e seguir as práticas de design inclusivo por meio de recursos acessíveis e suporte à internacionalização.
  • Democratização da criação e da participação da comunidade. O novo site deveria ser ativado por padrões e ferramentas de software livre, que capacitassem qualquer pessoa a criar e editar a documentação. Ele deveria usar o Markdown para o conteúdo, o YAML para a documentação da API gerada automaticamente e depender do GitHub como a camada de conteúdo subjacente, que permitiria o uso de verificações de qualidade automatizadas. A organização MicrosoftDocs no GitHub cresceu para mais de 7.400 membros, e o repositório de documentação do Azure é um dos projetos de software livre de crescimento mais rápido (470% em relação ao ano anterior) e o quinto repositório com o maior número de contribuições de todo o GitHub, conforme visto no State of the Octoverse 2018.
  • Suporte à documentação da API. O novo site deveria ter suporte de primeira classe para a documentação de APIs escritas para linguagens de programação e plataformas usadas por nossos clientes, incluindo .NET, Java, Python, JavaScript e TypeScript, PowerShell, CLI do Azure, Q#, OpenAPI, entre outras. A experiência deveria ser impulsionada pela automação, ter uma cobertura confiável de API e ter a capacidade de publicar a documentação de API em minutos, em vez de semanas.
  • Modernização da infraestrutura de engenharia. O docs.microsoft.com deveria ser executado no Azure, permitindo reduzir os custos de manutenção (uma economia superior a US$ 7 milhões), melhorar os tempos de implantação, passando de intervalos de três semanas para implantações diárias (ou com uma velocidade maior), bem como reduzir a duplicação de engenharia.
  • Extensível por padrão. À medida que o site evoluir, ele deverá conseguir atender às necessidades de nossos clientes da maneira mais eficiente. Ao assumir esse compromisso, conseguimos criar e integrar uma experiência de aprendizado interativo inteiramente nova – o Microsoft Learn, bem como nosso navegador de código de exemplo.

Com uma plataforma moderna em vigor, pretendíamos garantir que não estivéssemos perdendo uma parte importante do conteúdo ao migrá-lo para o novo site. Abaixo, você encontrará mais informações sobre nosso progresso.

Bibliotecas MSDN e TechNet

Status: ✅ concluído

Iniciamos a migração da Biblioteca MSDN e da Biblioteca TechNet para o docs.microsoft.com no final de 2017 e concluímos a migração este ano.

Anteriormente, as bibliotecas forneciam documentação para produtos da Microsoft, incluindo documentação da API, código de exemplo e artigos técnicos. Originalmente disponível por meio de CDs, o conteúdo passou a ser disponibilizado online com o lançamento dos sites MSDN e TechNet.

A migração exigiu a conversão de uma variedade de formatos baseados em XML em Markdown para o conteúdo editado por humanos e em YAML para a documentação da API gerada automaticamente, abrangendo mais de cem conjuntos variados de conteúdo. Garantimos a implementação de redirecionamentos de página para milhões de páginas da Web, impedindo a referência de links desfeitos fora do nosso site, como blogs e fóruns.

Para ter uma ideia do volume de conteúdo com o qual trabalhamos, veja algumas estatísticas:

Se você tiver marcado qualquer conteúdo do MSDN ou do TechNet, os links serão automaticamente redirecionados para a nova localização em docs.microsoft.com.

Revista MSDN

Status: ✅ concluído

A última edição da MSDN Magazine foi publicada em 1º de novembro de 2019. Enviamos uma mensagem final para os leitores e os autores na edição de agosto da MSDN Magazine.

O conteúdo da MSDN Magazine publicado no MSDN foi migrado para docs.microsoft.com/archive.

Os assinantes da MSDN Magazine que pagaram suas respectivas assinaturas receberão um reembolso proporcional, com base no tempo restante que tinham. Os cheques de reembolso serão enviados por correio após a publicação da edição de novembro. Essa alteração não afeta a assinatura da Plataforma MSDN.

Boletins informativos do Desenvolvedor Microsoft e do TechNet Flash

Status: ✅ concluído

Os boletins informativos publicados no MSDN e no TechNet foram migrados para docs.microsoft.com/archive.

Os assinantes atuais continuarão recebendo esses boletins informativos. Podemos aprimorar e alterar o formato e o agendamento de publicação.

Caso não deseje mais assinar nossos boletins informativos, cancele a assinatura no próximo email que receber.

Blogs do MSDN e do TechNet

Status: ✅ concluído

Em julho de 2019, os sites Blogs do MSDN e Blogs do TechNet passaram a ser somente leitura. Os Blogs do MSDN e do TechNet foram migrados e arquivados no docs.microsoft.com/archive.

Se você marcou algum blog do MSDN ou do TechNet, os links para eles serão redirecionados para o novo local em docs.microsoft.com/archive, ou para outros sites de blog se eles forem ativamente mantidos e atualizados em blogs.

Status: ✅ concluído

Redirecionamos todas as páginas da Galeria de códigos do MSDN para o navegador de exemplos e arquivamos os principais exemplos no GitHub na organização MicrosoftArchive. Leia mais sobre esse processo em nossa recente postagem no blog.

Encontre os exemplos de códigos mais atualizados em docs.microsoft.com/samples.

Status: 🚧 em andamento

A Galeria do TechNet será desativada no início de 2020. Em dezembro de 2019, o site passará a ser somente leitura e deixará de aceitar novas contribuições da comunidade. Em breve, publicaremos comunicados e informações adicionais.

Use docs.microsoft.com/samples para encontrar os exemplos de códigos mais atualizados. Se, anteriormente, você contribuiu com a Galeria do TechNet, migre seus exemplos para uma localização gerenciada pessoalmente, como seu próprio repositório do GitHub.

TechNet Wiki

Status: 🚧 em andamento

Estamos trabalhando em um plano e um agendamento de migração mais concretos para o TechNet Wiki. Acesse este artigo posteriormente para obter detalhes adicionais. No momento, você pode continuar participando do conteúdo do wiki e interagindo com ele.

Fóruns do MSDN e do TechNet

Status: 🚧 em andamento

Anunciamos a versão prévia do Microsoft Q&A, que substitui fóruns MSDN e TechNet. Para garantir uma transição tranquila e minimizar as interrupções, dividimos a migração em várias fases. Esperamos concluir a migração até meados de 2020. Acesse este artigo posteriormente para obter detalhes adicionais.

Channel 9

Status: 🚧 em andamento

O Channel 9 continua sendo um investimento importante para o conteúdo de vídeo voltado para o desenvolvedor. Estamos trabalhando em um caminho de migração que integrará melhor nossos vídeos e nosso conteúdo técnico do Channel 9. Acesse este artigo posteriormente para obter detalhes adicionais.

Queremos saber sua opinião

Estamos felizes de continuar investindo em nossa plataforma e garantir que você obtenha a documentação técnica mais relevante e confiável para todo o ecossistema da Microsoft. Envie-nos comentários e sugestões de melhoria no GitHub e no Twitter.