Uma Atualização sobre a Migração do MSDN e TechNet para o docs.microsoft.com

  • Artigo

Esta mensagem foi escrita por Jeff Sandquist, Vice-presidente Corporativo, Relações com Programadores.

Hoje, temos o prazer de anunciar uma atualização importante da migração de conteúdos do MSDN e do TechNet para o docs.microsoft.com. Esta publicação de blogue documenta os últimos passos de um esforço de toda a empresa para reformular a estrutura dos conteúdos, o formato e a infraestrutura subjacente, e centralizar a documentação técnica da Microsoft num só site.

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

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

Captura de ecrã a mostrar o MSDN Online em 1999

Naquela altura, o processo de publicação consistia em criar conteúdos no Microsoft Word, convertê-los em HTML e publicá-los através de uma ferramenta denominada pubwiz (Publishing Wizard). Ao longo de mais de 20 anos, o processo possibilitou o lançamento de novos produtos, serviços e atualizações, o que resultou numas impressionantes 45 milhões de páginas de conteúdos técnicos!

Com a mudança do ciclo de lançamento de produtos de anos para meses, a procura por documentação acessível e atualizada cresceu. Como o sistema de publicação precisava de corresponder à velocidade da engenharia, decidimos reinventar a forma como gerimos a documentação na Microsoft numa era dominada pela cloud. Em novembro de 2015, os membros fundadores da equipa do docs.microsoft.com (Dan Fernandez, Mary McHale, Carol Zeumault e Jeff Sandquist) escreveram um documento intitulado "A New Hope" ("Uma Nova Esperança") em homenagem ao primeiro filme da saga Guerra das Estrelas (Star Wars: Episódio IV), no qual se delineou uma visão para o novo site. Este documento incluía um conjunto de princípios de orientação fundamentais:

  • Documentação técnica unificada. O novo site deverá consolidar as dezenas de sites de documentação alojados pela Microsoft. Um programador que esteja a aprender a criar uma aplicação Web condicionada por dados só precisa de visitar um site para encontrar todos os conteúdos relevantes sobre o ASP.NET, Azure, Entity Framework ou qualquer outra tecnologia da Microsoft.
  • Experiência do utilizador melhorada. Um fator essencial para definir o sucesso de um site é a experiência que este proporciona aos seus clientes. O novo site deverá ter um melhor desempenho de carregamento, tipos de letra legíveis, tabelas de conteúdos acessíveis, URLs legíveis por humanos, suporte de controlo de versões e compatibilidade com browsers móveis, e seguir as práticas de design inclusivo através de funcionalidades acessíveis e suporte à internacionalização.
  • Democratizar a autoria e o envolvimento da comunidade. O novo site deverá contar com a tecnologia de padrões e ferramentas open source que permitam a qualquer pessoa criar e editar a documentação. Deverá utilizar Markdown para os conteúdos e YAML para a documentação da API gerada automaticamente, e utilizar o GitHub como a camada de conteúdos subjacente, que permite a utilização de verificações de qualidade automatizadas. A organização MicrosoftDocs do GitHub tem mais de 7400 membros e o repositório de documentação do Azure é um dos projetos de open source com maior crescimento (470% ano após ano) e o 5.º repositório com mais contribuições em todo o GitHub, conforme se pode observar no relatório The State of the Octoverse 2018!
  • Documentação da API de suporte. O novo site deve ter suporte de primeira classe para documentação de APIs escritas para linguagens e plataformas de programação que os nossos clientes utilizam, incluindo .NET, Java, Python, JavaScript e TypeScript, PowerShell, CLI do Azure, Q#, OpenAPI e muito mais. A experiência deve contar com a tecnologia de automatização, ter uma cobertura de API fiável e ser capaz de publicar a documentação da API em minutos em vez de semanas.
  • Modernizar a infraestrutura de engenharia. O site docs.microsoft.com deve ser executado no Azure, para que possamos reduzir os custos de manutenção (mais de 7 mil milhões de USD poupados), melhorar os tempos de implementação de três em três semanas para diariamente (ou até mais rápido) e reduzir a duplicação de engenharia.
  • Extensível por predefinição. À medida que o site cresce, o mesmo tem de conseguir satisfazer as necessidades dos nossos clientes da forma mais eficiente possível. Ao assumir este compromisso, conseguimos criar e integrar uma nova experiência de aprendizagem interativa (o Microsoft Learn), bem como o nosso browser de código de exemplo.

Com uma plataforma moderna em vigor, resolvemos certificarmo-nos de que não estamos a perder conteúdos valiosos ao migrá-los para o novo site. A seguir, irá encontrar mais informações sobre o nosso progresso.

Bibliotecas do MSDN e TechNet

Estado: ✅ Concluído

Iniciámos a migração da Biblioteca do MSDN e da Biblioteca do TechNet para o docs.microsoft.com no final de 2017, tendo sido concluída este ano.

As bibliotecas forneceram previamente documentação para os produtos da Microsoft, incluindo documentação da API, código de exemplo e artigos técnicos. Originalmente disponíveis através de CDs, os conteúdos foram posteriormente colocados online com o lançamento dos sites MSDN e TechNet.

A migração exigiu a conversão em Markdown de vários formatos baseados em XML para conteúdos editados por humanos e em YAML para documentação da API gerada automaticamente, que abrangia mais de cem conjuntos de conteúdos diferentes. Garantimos que os redirecionamentos de páginas estão em vigor para milhões de páginas Web, de modo a impedir as ligações quebradas referidas fora do nosso site, tais como blogues e fóruns.

Para lhe dar uma ideia do volume de conteúdos com que trabalhámos, eis algumas estatísticas:

Se tiver adicionado conteúdos do MSDN ou do TechNet aos favoritos, as ligações serão redirecionadas sem problemas para a respetiva nova localização no docs.microsoft.com.

Revista do MSDN

Estado: ✅ Concluído

A última edição da MSDN Magazine foi publicada no dia 1 de novembro de 2019. Enviámos uma mensagem final aos leitores e autores na edição de agosto da MSDN Magazine.

Os conteúdos da MSDN Magazine que foram publicados no MSDN foram movidos para docs.microsoft.com/archive.

Os subscritores da MSDN Magazine que pagaram as respetivas subscrições receberão um reembolso proporcional, com base no tempo restante da respetiva subscrição. Os cheques de reembolso serão enviados após a publicação da edição de novembro. Esta alteração não afeta a Subscrição da Plataforma MSDN.

Newsletters do Microsoft Developer e TechNet Flash

Estado: ✅ Concluído

As newsletters publicadas no MSDN e TechNet foram movidas para docs.microsoft.com/archive.

Os atuais subscritores continuarão a receber estas newsletters. No futuro, poderemos desenvolver e alterar o formato, bem como a agenda de publicação.

Se não quiser continuar a subscrever as nossas newsletters, pode cancelar a subscrição no próximo e-mail que receber.

Blogues do MSDN e TechNet

Estado: ✅ Concluído

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

Se tiver marcado os blogues do MSDN ou do TechNet, as ligações para os mesmos serão redirecionadas para a nova localização no docs.microsoft.com/archive ou para outros sites de blogue se forem mantidos ativamente e atualizados blogues.

Estado: ✅ Concluído

Redirecionámos todas as páginas da Galeria de Código do MSDN para o browser de exemplos e arquivámos os principais exemplos na organização MicrosoftArchive do GitHub. Leia mais sobre esse processo na nossa publicação de blogue mais recente.

Os exemplos de código mais recentes podem ser encontrados em docs.microsoft.com/samples.

Estado: 🚧 em curso

A Galeria do TechNet será descontinuada no início de 2020. Em dezembro de 2019, o site será só de leitura e não irá aceitar contribuições novas da comunidade. Anúncios e informações adicionais a seguir.

Utilize docs.microsoft.com/samples para encontrar os exemplos de código mais recentes. Se já tiver contribuído para a Galeria do TechNet, certifique-se de que migra os seus exemplos para uma localização gerida pessoalmente, como o seu próprio repositório do GitHub.

TechNet Wiki

Estado: 🚧 em curso

Estamos a trabalhar num plano e calendário de migração mais concreto para o TechNet Wiki. Volte a consultar esta página para obter mais detalhes. Pode continuar a participar e interagir com os conteúdos wiki agora mesmo.

Fóruns do MSDN e TechNet

Estado: 🚧 em curso

Anunciámos a versão de pré-visualização das Perguntas e Respostas da Microsoft, que veio substituir os fóruns do MSDN e TechNet. Para garantir uma transição tranquila e minimizar a interrupção, dividimos a migração em múltiplas fases. Esperamos concluir a migração até meados de 2020. Volte a consultar esta página para obter mais detalhes.

Channel 9

Estado: 🚧 em curso

O Canal 9 continua a ser um investimento importante para os conteúdos de vídeo centrados nos programadores. Estamos a trabalhar num caminho de migração que irá integrar melhor os nossos vídeos e conteúdos técnicos do Canal 9. Volte a consultar esta página para obter mais detalhes.

Queremos saber a sua opinião

Estamos entusiasmados por continuar a investir na nossa plataforma e garantir que obtém a documentação técnica mais relevante e fiável para todo o ecossistema da Microsoft. Dê-nos a sua opinião e sugestões de melhorias no GitHub e no Twitter.