Introdução ao docs.microsoft.com

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

Hoje estamos anunciando a versão prévia do novo serviço de documentação https://docs.microsoft.com, demonstrando conteúdo com suporte a nossos produtos Enterprise Mobility.

Por que o docs.microsoft.com?

Em resumo, o conteúdo é importante. Entrevistamos e pesquisamos centenas de desenvolvedores e profissionais de TI e separamos os comentários sobre o seu site ao longo dos anos no UserVoice. Ficou claro que precisávamos fazer uma alteração e criar uma experiência na Web moderna para conteúdo. A primeira coisa que fizemos foi avaliar nossa infraestrutura de conteúdo existente TechNet e MSDN. Ambos os sites são compilados partindo de uma base de código frágil, com 10 a 15 anos de existência, além de um sistema de publicação e implantação arcaico que nunca foi projetado para ser executado na nuvem.

Nosso foco foi não apenas na experiência, mas também no conteúdo que criamos e em como cada um de vocês o consome. Por anos, os clientes nos disseram para ir além de muralhas de texto com conteúdo no nível de recurso e para ajudá-los a implementar soluções para seus problemas de negócios. Sabíamos que o conteúdo que distribuímos e a plataforma que criamos com certeza tornaria o aprendizado e a implantação de soluções mais fácil para os clientes

Para garantir o sucesso geral da experiência, percebemos que era necessário começar do zero. Foi assim que surgiu o https://docs.microsoft.com, uma nova esperança para a documentação da Microsoft.

Observação: esta versão prévia do site inclui conteúdo *somente* para documentação do Enterprise Mobility (que consiste em Análise Avançada de Ameaças, Azure Active Directory, Azure Remote App, autenticação multifator, Azure Rights Management, Intune e Microsoft Identity Manager). No futuro, conforme nossa plataforma amadurecer com a ajuda dos seus comentários, migraremos mais de nossa documentação para essa experiência.

Principais recursos

Vamos começar com uma página de documentação de exemplo mostrada abaixo e demonstraremos alguns dos novos recursos no site.

Exemplo de Documentação

Legibilidade

Para melhorar a legibilidade de conteúdo, alteramos o site para que ele tenha uma largura de conteúdo definida. Estudos de acompanhamento ocular mostraram que você pode aprimorar a compreensão e a velocidade da leitura com uma largura de conteúdo definida, pois é difícil para os olhos seguir passagens longas da esquerda para a direita. Para mostrar isso em ação, abaixo está um exemplo de um artigo Intune em execução em docs.microsoft.com, seguido do mesmo artigo no TechNet. Também aumentamos o tamanho da fonte do painel de navegação à esquerda e do texto, algo que os clientes têm solicitado (UserVoice – Aumentar tamanho da fonte).

Comparação entre documentos e TechNet

Tempo estimado de leitura

Outro aprimoramento simples que fizemos com base nas informações oferecidas por vocês foi dar um tempo estimado da leitura de um artigo. Sabemos que muitos de vocês aprendem e avaliam tecnologias durante os minutos de intervalo entre reuniões, e é mais provável que você leia os artigos quando sabe o tempo necessário para nisso. Também adicionamos carimbos de data ao conteúdo para ajudar os clientes a entenderem quão recentes as informações são, baseando-se em comentários UserVoice.

Tempo estimado de leitura

Navegação de Site e Conteúdo

Uma das principais áreas de investimento com base em entrevistas com clientes e comentários do UserVoice foram os aprimoramentos na navegação do site, a arquitetura de informações e a organização do conteúdo com base na intenção do cliente. Podemos refatorar nosso conteúdo em agrupamentos lógicos no que se refere à avaliação, introdução, planejamento, implantação, gerenciamento ou solução de problemas de produtos ou serviços. Você pode ver este conteúdo dividido tanto no painel de navegação esquerdo quanto em nossas páginas de produto/serviço.

Abaixo está uma captura de tela da home page documentação do Intune:

Captura de tela de documentação do Intune

Essa mesma classificação também está no painel de navegação esquerdo dos artigos:

Navegação à esquerda

Tamanho Reduzido do Artigo

Outro item recorrente nos comentários foi que o conteúdo às vezes fica difícil de entender devido à extensão. É mais difícil navegar e localizar o que você está procurando em artigos longos. Para resolver isso, dividimos vários artigos mais longos em etapas lógicas menores e fornecemos botões Anterior e Próximo na parte inferior dos artigos para navegar entre as etapas de um tutorial de várias partes, conforme mostrado abaixo.

Botões Voltar e Avançar

Enquanto muitos clientes apreciam a capacidade de ter tutoriais de várias partes, também ouvimos os clientes que desejam a capacidade de combinar tutoriais de várias etapas em um único PDF offline amigável para impressora. Essa função ainda não está disponível, mas está em breve na preview.

Design Responsivo

Para criar uma ótima experiência em dispositivos móveis, tablets e PCs como a que você solicitou no UserVoice, mudamos para um layout responsivo. Clicar no botão Opções expandirá/recolherá para mostrar as mesmas opções em uma exibição de área de trabalho.

Design de Página Responsivo

Contribuições da Comunidade

Toda a documentação em docs.microsoft.com está em software livre e projetado para permitir contribuições da comunidade. Isso segue a trilha de outras equipes da Microsoft, que já transformaram toda a documentação ou parte dela em software livre, incluindo ASP.NET, Azure, .NET Core, e Microsoft Graph.

Todo artigo tem um botão Editar (mostrado abaixo), que leva para o arquivo Markdown de origem no GitHub no qual você pode facilmente enviar uma solicitação de pull para corrigir ou aprimorar o conteúdo.

Mecanismos de Comentários

Suas perguntas e comentários são importantes para nós. Fizemos uma parceria para [Livefyre](https://web.livefyre.com/) fornecer comentários e notas laterais em todos os nossos artigos. Na parte superior de cada artigo você verá um link de comentários, conforme mostrado abaixo.

Link de comentários

Clicar em comentários levará você até a parte inferior da página, na qual você pode fazer logon (usando as credenciais do Twitter, Facebook, Google, Yahoo ou Microsoft) para adicionar, seguir ou curtir comentários.

Comentários na parte inferior

Você também pode adicionar anotações ou anotações rápidas em cada parágrafo do conteúdo ou texto especificamente realçado. Para fazer isso, com o cursor do mouse sobre o símbolo de comentário à direita, clique para adicionar um comentário embutido.

Exemplo de sidenote

Compartilhamento Social

O botão de compartilhamento na parte superior da página permite que você compartilhe facilmente com o Twitter e Facebook.

Compartilhando com o Twitter e o Facebook

Você também pode usar o cursor do mouse para selecionar conteúdo de um artigo a compartilhar no Facebook ou Twitter ou no qual adicionar um comentário, diretamente no menu de contexto, conforme mostrado abaixo.

Selecione e comentar ou compartilhar conteúdo

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.aspx>

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

Tema do site

Também adicionamos um seletor de tema aos artigos para que você possa alternar entre um tema claro e escuro, que foi uma solicitação de alguns de vocês no UserVoice.

Seletor de tema claro e escuro

A imagem abaixo mostra a diferença entre o tema claro e o escuro.

Temas claros e escuros

Conceitos básicos

Conceitos básicos de como o desempenho do site são um recurso importante, e algo que muitos clientes solicitaram no UserVoice que melhorássemos. Os tempos de carregamento de página em docs.microsoft.com são 50 a 300% mais rápidos, e nossa distribuição geográfica está melhor do que nunca. Também criamos uma arquitetura que está sendo executada 100% no Azure.

Seus comentários são muito importantes para nós!

Esperamos que você goste da versão prévia do docs.microsoft.com e envie seus comentários para https://aka.ms/sitefeedback. Na postagens futuras, discutiremos os planos para aprimorar consideravelmente a experiência no conteúdo de referência e os planos para a localização de conteúdo.