Atualização de novembro para docs.microsoft.com

Esta postagem foi escrita por Jeff Sandquist, Gerente Geral na Divisão de Nuvem e Corporativa.

Hoje estamos orgulhosos de anunciar que migramos a documentação do Azure, Visual Studio 2017 RC, C++, ASP.NET Core, Entity Framework Core e SQL no Linux para docs.microsoft.com!

A integração de todo o conteúdo levará a uma consistência da experiência dos nossos clientes, para suporte a dispositivos móveis, localização, comentários, compartilhamento social ou contribuições da comunidade.

Embora esse seja um grande lançamento, continuaremos a atualizar o conteúdo e os recursos do site regularmente, portanto, certifique-se de nos enviar comentários do UserVoice a respeito da experiência com o conteúdo.

Você também pode aguardar com expectativa a adição de conteúdo para o Dynamics 365, Windows Server, SQL Server, System Center e para a área de trabalho do Windows nos próximos meses.

Nesta postagem

• Principais recursos do Docs
• Novos recursos do Docs
• Documentação do Azure
• Documentação do Visual Studio 2017 RC
• Documentação do C++
• Documentação do ASP.NET Core
• Documentação do Entity Framework Core
• Documentação do SQL no Linux

Principais recursos do Docs

Para aqueles que não estão familiarizados com docs.microsoft.com, aqui estão alguns dos principais recursos dessa nova experiência.

Tempo estimado de leitura e Última atualização

Um aprimoramento simples que fizemos com base nas informações oferecidas por você, foi dar um tempo estimado para a leitura de um artigo. Sabemos que muitos de vocês aprendem e avaliam tecnologias durante aqueles poucos minutos de intervalo entre reuniões, e é mais provável que você leia os artigos ao saber o tempo necessário para isso.

Também adicionamos carimbos de tempo ao conteúdo para ajudar os clientes a entender o quão recente é o conteúdo – você não precisa mais adivinhar quando foi a última vez em que um artigo foi atualizado.

Design Responsivo

Para criar uma ótima experiência em dispositivos móveis, tablets e PCs, implementamos um layout responsivo. Ao clicar no botão Opções na parte superior da página, em dispositivos de tela pequena, será possível acessar as mesmas opções que você veria em um navegador de área de trabalho.

Documentação do global

Ouvimos diversas vezes dos clientes internacionais sobre a importância de conteúdo localizado. O docs.microsoft.com agora dá suporte a 45 idiomas, incluindo os idiomas da direita para a esquerda, como árabe e hebraico, bem como um total de 63 localidades para conteúdo do Dynamics 365 com lógica de fallback, na qual documentos localizados podem não estar disponíveis. Isso torna nossos documentos realmente globais e prontos para o conteúdo adicional que está chegando no próximo ano.

Anotações rápidas e comentários

Suas perguntas e comentários são importantes para nós. Fizemos uma parceria com a Livefyre para fornecer comentários e anotações rápidas em todos os artigos. Na parte superior de cada artigo, você verá uma opção para acessar diretamente a seção de comentários.

Queremos ouvir você e temos o compromisso de monitorar e responder a todos os comentários e perguntas deixados nas páginas do Docs.

Para fazer um comentário, você pode fazer logon usando as suas credenciais do Twitter, Facebook, Google, Yahoo ou Microsoft.

Além disso, você poderá seguir os tópicos em que aguarda acompanhamento – fique sempre informado de quando um dos membros da nossa equipe ou da comunidade respondeu a você.

Você também pode adicionar anotações rápidas em cada parágrafo do conteúdo ou texto especificamente realçado. Para fazer isso, basta selecionar um bloco de texto com o cursor do mouse ou clicar no ícone de comentário que aparece no lado direito do parágrafo conforme você passa o mouse sobre ele.

Compartilhamento Social

O botão de compartilhamento, na parte superior da página, permite que você compartilhe facilmente nosso conteúdo para seus seguidores do Twitter e amigos do Facebook.

Você também pode selecionar o conteúdo diretamente com o mouse para compartilhá-lo por meio do widget contextual.

Tema claro / escuro

Também adicionamos um seletor de temas para que você possa alterar entre um tema claro e escuro, algo que alguns de vocês têm [asked for on UserVoice](https://msdocs.uservoice.com/forums/364242-general-site-feedback/suggestions/14999211-komplete-dark-theme).

URLs amigáveis

Nos preocupamos com nossa experiência na Web, e uma coisa que sempre nos importunou como usuários do TechNet e MSDN é que os artigos não têm URLs amigáveis e legíveis. Veja um exemplo do mesmo artigo com novas URLs.

Antes

https://technet.microsoft.com/library/dn646983.aspx3

After (após)

https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune

Contribuições da Comunidade

A maioria dos documentos em nosso site estão habilitados para contribuições da comunidade. Basta clicar no botão Editar no menu superior à direita para ir para a página correspondente do GitHub, divida o repositório, faça uma alteração e envie a solicitação de alteração. Edições em conteúdo localizado e comentários sobre a experiência de contribuição geral são bem-vindos!

Novos recursos do Docs

Embora muitos desses recursos já existam desde nosso dia de início em maio, também adicionamos vários recursos novos, como descrito abaixo.

Filtro de Sumário em tempo real

Habilitamos o Sumário para ser instantaneamente filtrável. Isso significa que você pode facilmente digitar apenas alguns caracteres para filtrar um texto correspondente e localizar o conteúdo que você está procurando.

Sumário de navegação à esquerda

Outro recurso importante que adicionamos resolve o problema de conteúdo em vários sites. Um artigo sobre como implantar um aplicativo ASP.NET para o Serviço de Aplicativo do Azure deve ser listado no Azure ou ASP.NET? A resposta é nos dois, mas sem duplicar o conteúdo nas duas seções do site por motivos de descoberta e consistência.

Para fazer isso, habilitamos as equipes de conteúdo a selecionar qualquer conteúdo em documentos e criar uma exibição desse conteúdo para os clientes. A figura abaixo mostra como seria um layout hipotético para desenvolvedores do .NET usando o Docker, que pode ter conteúdo que vem do Azure, ASP.NET, .NET Core e de equipes do SDK do Visual Studio do Azure – tudo em uma única exibição.

Exemplos de código verificáveis

Um dos recursos mais frustrantes da documentação é quando os exemplos apresentados ou vinculados, na realidade, não funcionam em seu computador. Na Microsoft, temos milhares de exemplos de código e snippets de código e queremos ter a certeza de que os clientes podem confiar que esses exemplos funcionam em plataformas e configurações com suporte.

Para fazer isso, desenvolvemos um sistema de CI (integração contínua) extensível, para garantir que os exemplos compilam e produzem a saída esperada para um determinado conjunto de sistemas operacionais e cadeias de ferramentas. Enquanto estamos trabalhando para integrar mais equipes nisso, queremos garantir que os usuários que fazem o download de nosso código estejam seguros de que ele passará em todas as verificações de qualidade necessárias.

Conteúdo de referência integrado

Reprojetamos o mecanismo subjacente do DocFX, componente de código-fonte aberto que aciona o docs.microsoft.com, para incluir associações de linguagens para diferentes plataformas e formatos. Isso inclui suporte para:

• CLI do Azure (Python)
• PowerShell
• .NET e .NET Core
• Java
• Swagger / APIs REST

Isso significa para os clientes que a documentação não deve descompassar da sincronia com os recursos da API, pois agora há uma fonte de verdade que orienta os documentos e o código. Você pode ler mais sobre o suporte específico à referência da API nas seções Azure e ASP.NET/EF abaixo.

Suporte PDF

Outro recurso importante que os clientes vêm solicitando é o suporte a PDF – você pode baixar um conjunto específico de documentos sem que isso consuma gigabytes de espaço, e levar com você para qualquer lugar, quer esteja usando um dispositivo móvel, quer um desktop.

Para habilitar isso, ativamos o suporte a PDF para o nosso sumário. Nos certificamos de que o arquivo PDF é atualizado quando o conteúdo é atualizado no site ativo, para que você sempre obtenha o nosso conteúdo melhor e mais recente.

<img alt="screenshot16]()

Documentação do Azure

Ouvimos seus comentários sobre fragmentação e desafios com a experiência, portanto, estamos no percurso de migração da documentação técnica do Azure do azure.microsoft.com, do MSDN e do GitHub consolidando-a no https://docs.microsoft.com/azure/.

Nova página de Hub do Azure

Também aproveitamos a oportunidade para alterar a aparência e experiência da página inicial do conteúdo do Azure. Alguns destaques incluem:

• Uma guia de Serviços, que lista os serviços do Azure agrupados por categoria.
• Uma guia de Desenvolvedor, que lista todos os conteúdos de referência do Azure para API REST, SDK do .NET do Azure, SDK de Java do Azure, CLI do Azure e Azure PowerShell.
• Uma guia de Arquitetura para arquitetos e desenvolvedores aprenderem sobre padrões de design de escala de nuvem.

Nova página de Serviço

Garantimos que nossas páginas iniciais são consistentes e vinculam-se aos principais recursos, incluindo:

• Um link de Visão geral do Serviço.
• Tutoriais de Introdução a todas as plataformas relevantes e linguagens de programação.
• Um link para todos os tutoriais de vídeo de um determinado serviço.
• Links para conteúdo de referência de API.
• Um link para baixar toda a documentação para aquele serviço.

Novo Sumário

Enquanto que nos mudamos para o docs.microsoft.com/azure estamos aproveitando a oportunidade para aprimorar a consistência na navegação do Sumário. Embora cada serviço tenha características exclusivas, você agora verá uma navegação semelhante enquanto estiver se movendo pelo site.

Colorização aperfeiçoada

Para amostras de código que representam a Interface de linha de comando (CLI) do Azure, adicionamos a colorização de palavras-chave e parâmetros para que você tenha maior facilidade na leitura e compreensão do nosso código.

Aprimoramentos de referência

Um dos maiores problemas que ouvimos de todos vocês é que nosso conteúdo de API, linha de comando, e do PowerShell nunca estão atualizados. Assim que ocorrem alterações no Azure, nossos fluxos de trabalho manuais herdados não funcionam.

Nesta versão, alteramos nossos sistemas para criar referência diretamente do código-fonte. Quando novas compilações forem entregues, novo conteúdo também será entregue. E assim como você pode contribuir com nosso conteúdo Como, também poderá fazer o mesmo para a parte gerada automaticamente da documentação.

Também estamos padronizando o uso da Especificação aberta da API (anteriormente conhecida como Swagger) para descrever nossas APIs REST, o que nos fornecerá uma representação consistente de dados para os serviços REST que poderão ser usados para documentação, bem como para SDKs clientes. No futuro, também poderemos adicionar recursos interativos à nossa documentação de REST e cargas de exemplo de solicitação/resposta.

Para esta versão, habilitamos:

• CLI do Azure 2.0 (Versão prévia)
• Azure PowerShell
• SDK do Java do Azure
• SDK do Azure .NET
• APIs REST do Azure

Documentação do Visual Studio 2017 RC

Estamos introduzindo toda a documentação do Visual Studio, integrada diretamente na experiência nova e atualizada do docs.microsoft.com.

Nova página de Hub do Visual Studio

A página de Hub do Visual Studio inclui links essenciais para começar a usar a versão Release Candidate do Visual Studio 2017.

Isso inclui os tutoriais de Guia de instalação, Novidades, e Introdução. Conteúdo localizado em breve. Novo conteúdo estará disponível para tópicos como refatoração, trabalhando com código que não esteja em um projeto, depuração de problemas de desempenho, dicas sobre como otimizar o tempo de inicialização do Visual Studio, detalhes sobre todos os novos recursos de produtividade e de navegação no editor do código e muito mais.

Agora que o Visual Studio dá suporte a um processo de instalação totalmente personalizável, no qual você pode selecionar apenas os componentes que deseja usar, você pode aprender mais sobre como isso funciona para seus projetos de desenvolvimento individual, independentemente se suas cargas de trabalho envolvem plataformas Windows, Azure, Python ou ASP.NET.

Documentação do ASP.NET e Entity Framework Core

A documentação do ASP.NET e Entity Framework Core também foram migradas de docs.asp.net e GitHub, respectivamente.

Referência do ASP.NET / Entity Framework

Uma vez que o ASP.NET Core e o Entity Framework Core são projetos de software livre, integramos profundamente seu código-fonte e comentários de barra tripla para criar a respectiva documentação de referência de API. Isso significa que a API e a documentação estarão sempre em sincronização, automaticamente.

Documentação do C++

Em resposta a solicitações antigas de clientes, nós refatoramos a referência da C++ em um formato mais compacto que requer menos links entre tópicos. Agora, você pode encontrar todos os documentos para membros de classe no mesmo tópico da classe.

Além disso, saiba mais sobre as últimas alterações de conformidade de padrões de C++ e sobre as novas opções de build, como /fastlink, use as novas diretrizes de portabilidade para atualizar seu código das versões anteriores do Visual Studio e descubra como experimentar o novo suporte ao build em sistemas Linux com o gcc!

Documentação do SQL no Linux

O SQL Server no Linux (parte do SQL Server vNext Customer Technical Preview 1) está aqui e pronto para ser testado! A página de Hub inclui links essenciais que te levam da Introdução ao gerenciamento e desenvolvimento com o SQL Server no Linux. Conteúdo localizado estará disponível em breve.

Conclusões

Estamos ansiosos para fornecer ainda mais recursos para o novo site de documentação e termos a certeza de que a experiência seja consistente com nossos produtos e serviços. Como você, o usuário, é a peça mais crítica no processo de documentação, incentivamos você a entrar em contato conosco e fornecer comentários sobre como podemos tornar essa experiência melhor para você no Twitter.