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

Artigo
09/15/2023

Esta mensagem foi escrita por Jeff Sandquist, Gestor Geral na Divisão Empresarial + Nuvem.

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

Reunir todo o nosso conteúdo irá fomentar a consistência da experiência para os nossos clientes, para suporte móvel, localização, comentários, partilha social ou contribuições da comunidade.

Apesar de ser um grande lançamento, iremos continuar a atualizar as funcionalidades do site e conteúdo regularmente, por isso certifique-se de que nos envia feedback do UserVoice relativamente à experiência de conteúdo.

Também pode aguardar a adição de conteúdo do Dynamics 365, Windows Server, SQL Server, System Center e ambiente de trabalho do Windows durante os próximos meses.

Nesta Mensagem

Principais Funcionalidades do Docs
Novas Funcionalidades 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 Funcionalidades do Docs

Para as pessoas que não estão familiarizadas com o docs.microsoft.com, eis algumas das principais funcionalidades da nossa nova experiência.

Tempo de Leitura Estimado e Última Atualização

Um melhoramento simples que fizemos com base na sua entrada é fornecer um tempo de leitura estimado para um artigo. Sabemos que muitos de vocês estão a aprender e a avaliar tecnologias durante esses poucos minutos entre reuniões e é mais provável que leia artigos se souber quanto tempo o compromisso é necessário.

Também adicionámos carimbos de data/hora ao conteúdo para ajudar os clientes a compreender quão recente o conteúdo é. Já não precisa de adivinhar quando foi a última vez que um artigo foi atualizado.

Design Reativo

Para criar uma ótima experiência em dispositivos móveis, tablets e PCs, implementámos um esquema reativo. Clicar no botão Opções na parte superior da página em dispositivos de ecrã pequeno irá permitir-lhe aceder às mesmas opções que veria num browser do ambiente de trabalho.

Documentação Global

Ouvimos vezes sem conta os clientes internacionais falarem da importância de terem o conteúdo localizado. O docs.microsoft.com agora suporta 45 idiomas, incluindo idiomas da direita para a esquerda, tal como o árabe e o hebraico, bem como 63 regiões no total para conteúdo do Dynamics 365 com lógica de contingência onde os documentos localizados poderão não estar disponíveis. Isto torna os nossos documentos verdadeiramente globais e prontos para o conteúdo adicional do novo ano.

Comentários e notas laterais

As suas perguntas, comentários e comentários são importantes para nós. Estabelecemos uma parceria com a Livefyre para fornecer comentários e notas laterais sobre todos os nossos artigos. Na parte superior de cada artigo, verá uma opção para aceder diretamente à secção de comentários.

Queremos saber a sua opinião e estamos empenhados em monitorizar e responder a todos os comentários e perguntas nas páginas do Docs.

Para comentar, pode iniciar sessão com as suas credenciais existentes do Twitter, Facebook, Google, Yahoo, ou Microsoft.

Além disso, poderá seguir os threads onde espera seguimentos. Saiba sempre quando um dos membros da sua comunidade ou equipa lhe respondeu.

Também pode adicionar notas laterais em cada parágrafo de conteúdo ou texto realçado especificamente. Para o fazer, basta selecionar uma parte do texto com o cursor do rato ou clicar no ícone de comentário que é apresentado no lado direito do parágrafo à medida que paira o cursor sobre o mesmo.

O botão de partilha na parte superior da página permite-lhe partilhar facilmente o nosso conteúdo com os seus seguidores do Twitter e amigos do Facebook.

Também pode selecionar conteúdo diretamente com o seu rato para partilhá-lo com o widget contextual.

Tema Claro/Escuro

Também adicionámos um seletor de temas para que possa mudar 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 simples

A nossa experiência Web é importante para nós e algo que nos incomodava regularmente enquanto utilizadores do TechNet e do MSDN era que os artigos não tinham URLs legíveis amigáveis. Eis um exemplo do mesmo artigo com os nossos novos URLs.

Antes

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

Depois

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

Contribuições da Comunidade

A maioria dos documentos no nosso site estão ativados para contribuições da comunidade. Basta clicar no botão Editar no menu no canto superior direito para aceder à página do GitHub correspondente, bifurcar o repositório, efetuar uma alteração e submeter o seu pedido Pull. Agradecemos edições sobre o conteúdo localizado e feedback sobre a experiência de contribuição geral!

Novas Funcionalidades do Docs

Apesar de muitas destas funcionalidades estarem disponíveis desde o dia do lançamento em maio, também adicionámos várias funcionalidades novas, descritas abaixo.

Filtro de Índice em Tempo Real

Permitimos que o nosso Índice seja filtrável instantaneamente. Isso significa que pode escrever facilmente alguns carateres para filtrar o texto correspondente para localizar o conteúdo que procura.

Outra funcionalidade principal que adicionámos aborda o problema de ter conteúdo em múltiplos sites. Um artigo sobre como implementar uma aplicação ASP.NET no Serviço de Aplicações do Azure deve estar indicado no Azure ou ASP.NET? Deve estar em ambos, mas sem duplicar o conteúdo em ambas as secções do site por motivos de deteção e consistência.

Para o fazer, permitimos que equipas de conteúdo selecionem qualquer conteúdo em documentos e criem uma vista desse conteúdo para os clientes. A imagem abaixo mostra o que um esquema hipotético pode ser para Programadores .NET a utilizar o Docker que pode ter conteúdo que é fornecido por equipas do Azure, ASP.NET, .NET Core e Visual Studio Azure SDK, tudo numa única vista.

Exemplos de Código Verificável

Uma das funcionalidades mais frustrante da documentação é quando os exemplos apresentados ou ligados não funcionam no seu computador. Na Microsoft, temos milhares de fragmentos e exemplos de código e queremos garantir que os nossos clientes têm a certeza de que esses exemplos funcionam nas configurações e plataformas suportadas.

Para o fazer, desenvolvemos um sistema de Integração Contínua (CI) extensível, para garantir que os exemplos compilam e produzem o resultado esperado para um determinado conjunto de sistemas operativos e cadeias de ferramentas. Enquanto trabalhamos para envolver mais equipas nisto, queremos garantir que os utilizadores que transferem o nosso código têm a certeza de que este irá transmitir todas as verificações de qualidade necessárias.

Conteúdo de Referência Integrado

Reestruturámos o motor DocFX subjacente, o componente de open source que aciona o docs.microsoft.com, para incluir enlaces de idioma para diferentes plataformas e formatos. Isto inclui suporte para:

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

Isto significa para os clientes que a documentação já não deve deixar de estar sincronizada com as capacidades da API, pois existe uma origem de verdade que orienta os documentos e o código. Pode ler mais sobre o suporte específico para a referência da API nas secções Azure e ASP.NET/EF abaixo.

Suporte para PDF

Outra funcionalidade principal que os clientes têm pedido é o suporte para PDF. Pode transferir um conjunto específico de documentos sem este ocupar gigabytes de espaço e pode levá-lo consigo para qualquer lugar, quer esteja num computador ou dispositivo móvel.

Para possibilitar isto, ativámos o suporte para PDF para o nosso índice. Garantimos que o ficheiro PDF é atualizado quando o conteúdo é atualizado no site ativo, para que aceda sempre ao conteúdo mais recente e importante.

<img alt="screenshot16]()

Documentação do Azure

Ouvimos o seu feedback sobre fragmentação e desafios com a experiência, pelo que estamos no bom caminho para migrar a nossa documentação técnica do Azure a partir de azure.microsoft.com, MSDN e GitHub e consolidá-la no https://docs.microsoft.com/azure/.

Nova Página do Hub do Azure

Também aproveitamos para alterar o aspeto e funcionalidade da página de destino do conteúdo do Azure. Alguns destaques principais incluem:

Um separador Serviços que indica os Serviços do Azure agrupados por categoria.
Um separador Programador que indica todo o conteúdo de Referência do Azure para API REST, Azure .NET SDK, Azure Java SDK, CLI do Azure e Azure PowerShell.
Um separador Arquitetura para os arquitetos e programadores saberem mais sobre os padrões de estrutura à escala da nuvem.

Nova Página de Serviço

Garantimos que as nossas páginas de destino são consistentes e estabelecem ligação aos recursos chave, incluindo:

Uma ligação para a Descrição Geral do Serviço.
Tutoriais de Introdução para todas as linguagens de programação e plataformas relevantes.
Uma ligação para todos os tutoriais em vídeo de um determinado serviço.
Ligações para o conteúdo de referência da API.
Uma ligação para transferir toda a documentação desse serviço.

Novo Índice

À medida que migramos para o docs.microsoft.com/azure, aproveitamos a oportunidade para melhorar a consistência na navegação do Índice. Apesar de cada serviço ter características exclusivas, agora verá uma navegação semelhante à medida que se move no site.

Coloração Melhorada

Para exemplos de código que representam a Interface de Linha de Comandos do Azure (CLI), adicionámos coloração de palavras-chave e parâmetros para que consiga ler e compreender mais facilmente o nosso código.

Melhorias de Referência

Um dos pontos de maior tensão que ouvimos é que a nossa API, a linha de comandos e o conteúdo do PowerShell nunca estão atualizados. À medida que o Azure muda rapidamente, os nossos fluxos de trabalho manuais legados deixam de funcionar.

Para esta versão, alterámos os nossos sistemas para criar uma referência diretamente a partir do código de origem. Quando forem lançadas novas compilações, também serão lançados conteúdos novos. Tal como pode contribuir para o conteúdo dos nossos Guias de Procedimentos, também o poderá fazer para as partes geradas automaticamente da documentação.

Também estamos a uniformizar a utilização do Open API Specification (anteriormente conhecido como Swagger) para descrever as nossas APIs REST, que agora irão fornecer uma representação dos dados consistente para serviços REST que podem ser utilizados para documentação e SDKs do cliente. No futuro, também poderemos adicionar funcionalidades interativas à nossa documentação REST e payloads de pedido/resposta de exemplo.

Para esta versão ativámos:

Documentação do Visual Studio 2017 RC

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

Nova Página do Hub do Visual Studio

A página do Hub do Visual Studio inclui ligações chave para começar a utilizar a versão Release Candidate do Visual Studio 2017.

Isto inclui o Guia de Instalação, Novidades e Tutoriais de Introdução. O conteúdo localizado será disponibilizado em breve. O novo conteúdo estará disponível para tópicos como refatorização, trabalhar com código que não está num projeto, depurar problemas de desempenho, sugestões para otimizar o tempo de arranque do Visual Studio, detalhes sobre as funcionalidades de navegação de código e produtividade no editor e muito mais.

Agora que o Visual Studio suporta um processo de instalação totalmente personalizável, onde obtém apenas os componentes que quer utilizar, pode saber mais sobre como isto funciona para os seus projetos de implementação individuais, independentemente de as suas cargas de trabalho envolverem plataformas SP.NET, Azure, Python ou Windows.

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

A documentação do ASP.NET e Entity Framework Core também foi migrada do docs.asp.net e GitHub respetivamente.

Referência do ASP.NET/Entity Framework

Como o ASP.NET Core e Entity Framework Core são projetos de open source, integrámos totalmente o código de origem e os comentários de barras triplas para criar a respetiva documentação de referência da API. Isso significa que a API e a documentação estarão sempre sincronizadas, automaticamente.

Documentação do C++

Em resposta a pedidos de longa data dos clientes, reformulámos a referência C++ num formato mais compacto que exige menos ligações entre os tópicos. Agora pode localizar todos os documentos de membros de classe no mesmo tópico que a classe.

Além disso, saiba mais sobre as alterações de conformidade de normas C++ mais recentes e novas opções de compilação como o /fastlink, utilize a nova orientação de migração para atualizar o seu código a partir das versões anteriores do Visual Studio e descubra como experimentar o novo suporte para criação 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 está pronto a experimentar! A página do Hub inclui ligações chave que o levam da introdução à gestão e desenvolvimento com o SQL Server no Linux. O conteúdo localizado estará disponível em breve.

Conclusões

Estamos ansiosos por fornecer ainda mais funcionalidades para o novo site de documentação e garantir que a experiência é consistente com os nossos produtos e serviços. Uma vez que o utilizador é a peça mais crítica no processo de documentação, recomendamos que nos contacte e dê feedback sobre como podemos melhorar esta experiência no Twitter.

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

Nesta Mensagem

Principais Funcionalidades do Docs