Ler em inglês

Compartilhar via


Documentação do Stack Overflow para desenvolvedores da Microsoft

Este post foi escrito por Jeff Sandquist, Gerente Geral da Divisão Cloud + Enterprise.

Hoje estamos anunciando uma parceria com o Stack Overflow para dar suporte à Documentação do Stack Overflow para desenvolvedores da Microsoft. Como parte deste anúncio, 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. A Microsoft é parceira do Stack Overflow há muito tempo na forma de marcas patrocinadas, 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 e tecnologias da Microsoft.

Metas Compartilhadas

Tanto o docs.microsoft.com quanto o Stack Overflow tinham metas compartilhadas- queremos tornar mais fácil e simples para a comunidade contribuir com uma ó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 o formato de conteúdo e habilitam facilmente as contribuições da comunidade (clique em Editar de qualquer página docs.microsoft.com).

Um tour rápido do Stack Overflow para desenvolvedores do .NET

Ao chegar pela primeira vez à Documentação do StackOverflow, você encontrará a categorização familiar baseada em marca dos 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 antecipadamente – a contagem de solicitações de tópico, alterações propostas e solicitações de melhoria.

GIF animado da janela Documentação do Stack Overflow, que mostra o usuário filtrando a documentação por marcas.

Solicitar um tópico

Poucos desenvolvedores resolveram problemas difíceis sem a ajuda do público do StackOverflow. Junto com nossos colegas, colegas e legendas da comunidade que monitoram o StackOverflow em busca de perguntas relacionadas a seus próprios produtos, criamos uma rede de informações organizada por marcas. A documentação capitaliza o compromisso do público em criar conhecimento coletivamente, dando-nos um lugar para pedir ajuda - a seção "Tópicos Solicitados" de cada marca dá à comunidade um lugar para identificar problemas comuns.

Captura de tela da janela do navegador Da Documentação do Stack Overflow, que mostra a lista de tópicos que foram solicitados pela comunidade.

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

Captura de tela da janela do navegador Documentação do Stack Overflow, que mostra a caixa de diálogo Criar Tópico.

Experiência familiar de exibição de código

Assim como acontece com o stackOverflow Q&um site, o código para tópicos individuais é apresentado em formato claro e conciso para que você possa copiar-editar-usar ou aprender simplesmente lendo o código. Os desenvolvedores podem obter exemplos de código de votação para cima/para baixo, assim como respostas no Stack Overflow.

Captura de tela da janela do navegador Da Documentação do Stack Overflow, que mostra um exemplo de código que pode ser copiado.

Integração futura

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