Documentação da Stack Overflow para Desenvolvedores da Microsoft

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

Hoje, estamos anunciando uma parceria com a Stack Overflow para dar suporte à Documentação da Stack Overflow para desenvolvedores da Microsoft. Como parte deste esforço, estamos anunciando que o conteúdo da documentação do Stack Overflow será integrado ao conteúdo de referência da API docs.microsoft.com no futuro. As marcas patrocinadas fazem parte da parceria de longa data da Microsoft com o Stack Overflow, e o lançamento da Documentação do Stack Overflow permite que a comunidade tenha uma maneira fácil de criar e votar em exemplos de código usando o .NET Framework, o Xamarin e outros produtos da Microsoft e tecnologias.

Metas compartilhadas

Nós, por meio do docs.microsoft.com, e o Stack Overflow temos objetivos compartilhados – queremos facilitar e simplificar a contribuição da comunidade com ótima documentação para o uso de produtos e serviços. Ambos os conjuntos de conteúdo têm uma licença aberta, usam markdown como formato de conteúdo e possibilitam as contribuições da comunidade de maneira fácil (clique em Editar em qualquer página docs.microsoft.com).

Um Tour Rápido pelo Stack Overflow para Desenvolvedores .NET

Quando você acessa a Documentação do StackOverflow pela primeira vez, encontra a familiar categorização baseada em marcas de tópicos disponíveis. À primeira vista, você verá todas as marcas criadas anteriormente pela comunidade StackOverflow. Depois de filtrar por marca, uma lista de cada uma aparece com algumas métricas importantes mostradas logo de cara – a contagem de solicitações de tópicos, alterações propostas e solicitações de melhorias.

Solicitar um Tópico

Poucos desenvolvedores resolveram problemas difíceis sem a ajuda do público do StackOverflow. Juntamente com nossos colegas, pares e lendas da comunidade que monitoram o StackOverflow em busca de perguntas relacionadas a seus próprios produtos, construímos uma rede de informações organizadas por marcas. A documentação aproveita o compromisso do público com a construção coletiva de conhecimento, dando-nos um local para pedir ajuda – a seção "Tópicos solicitados" de cada marca oferece à comunidade um local para identificar problemas comuns.

Ao clicar em "Criar Tópico", você pode criar conteúdo para um tópico, fornecer seus próprios exemplos de código e documentação. A experiência fornece orientação sobre onde fornecer cada seção de conteúdo, que pode ser editada usando a sintaxe Markdown, se você preferir. À medida que você cria tópicos, seu progresso é salvo na navegação direita, onde você pode ver todo o conteúdo de rascunho que ainda não concluiu ou enviou para revisão.

Experiência Familiar de Exibição de Código

Assim como no site Q&A do StackOverflow, o código para tópicos individuais é apresentado em um formato claro e conciso para que você possa copiar, editar, usar ou aprender simplesmente ao ler o código. Os desenvolvedores podem votar contra ou a favor nos exemplos de código, assim como em relação às respostas do Stack Overflow.

Integração futura

No futuro, o docs.microsoft.com integrará uma lista selecionada de amostras de documentação do Stack Overflow diretamente na documentação da API da Microsoft. Os desenvolvedores que examinarem a referência da API da Microsoft verão os exemplos criados pela Microsoft e do Stack Overflow, criados pela comunidade. Os exemplos serão selecionados para garantir que as amostras de código usem diretrizes e práticas recomendadas de codificação .NET estabelecidas. Daremos mais detalhes sobre essa integração no futuro.