Apresentando documentos do .NET Core
Este post foi escrito por Jeff Sandquist, Gerente Geral da Divisão Cloud + Enterprise.
Hoje lançamos uma versão prévia do de Documentação do .NET do no docs.microsoft.com. Para saber mais sobre as novas melhorias na experiência de documentação docs.microsoft.com ofertas, visite o apresentando docs.microsoft.com postagem no blog. Além de ter todos os recursos colaborativos, conteúdo de software livre e URLs mais amigáveis disponíveis na plataforma docs.microsoft.com, apresentamos alguns novos recursos específicos aos desenvolvedores do .NET. Esta postagem destacará esses novos recursos e resumirá nossos planos para o futuro.
Para acompanhar a emocionante versão rtm do .NET Core, estamos colocando-o na página inicial da Documentação do .NET. Para complementar a versão rtm do .NET Core com tudo o que você precisará para começar rapidamente, colocamos links para artigos e uma nova experiência de referência na parte superior da lista.
Você verá links para baixar as novas bibliotecas do .NET Core, ASP.NET, Entity Framework, Azure, usando o Xamarin para criar aplicativos iOS usando o .NET e criando aplicativos da Plataforma Universal do Windows (UWP) usando o .NET. Ainda não movemos todo o conteúdo do .NET para docs.microsoft.com, mas a home page da Documentação do .NET será seu ponto de partida para acessar toda a documentação do .NET.
Nossos escritores e engenheiros, bem como alguns membros dedicados da comunidade, têm trabalhado incansavelmente criando novos artigos relacionados ao .NET Core que você encontrará na seção documentação do .NET. Aqui você encontrará uma variedade de artigos como:
- tutoriais do .NET Core
- de implantação de aplicativos do .NET Core
- Teste de unidade no .NET Core
Esses e muitos outros tópicos são todos apresentados no tema docs.microsoft.com, com um sumário limpo em cada página, bem como o tempo estimado para ler cada artigo e informações de colaborador para cada artigo.
artigos
Todos os artigos do .NET são de software livre e estão disponíveis em do GitHub no repositório de documentos da equipe do .NET . Se você encontrar problemas na documentação ou quiser melhorá-lo, fazer isso é tão fácil quanto clicar no botão editar na navegação à direita de cada artigo.
Editar um artigo é tão simples quanto clicar no botão editar em qualquer um dos arquivos Markdown no repositório, adicionar seu conteúdo e enviar uma solicitação de pull. Depois que uma de nossa equipe examinar e aceitar sua solicitação de pull, suas contribuições entrarão em operação no site em minutos.
Além do grande conteúdo que está sendo criado por nossos escritores, engenheiros e membros apaixonados da comunidade, fizemos melhorias significativas na experiência de referência. A experiência de referência foi completamente reprojetada nesta versão prévia, emprestando sobre os mesmos princípios de design que usamos nos artigos docs.microsoft.com.
Assim como esses artigos, as novas páginas de referência são responsivas, projetadas com princípios modernos da Web e terão uma aparência melhor em dispositivos móveis.
de referência
Adicionamos um de Pesquisa de Tipo de a todas as páginas do Namespace . Isso permite que você pesquise facilmente por nome de tipo para todos os tipos .NET. Com cada tecla, filtramos a lista de tipos que estão sendo mostrados na navegação à esquerda. Esse novo recurso interessante da área de referência está incluído em nossa nova estrutura para gerar a documentação de referência do .NET conhecida como DocFX, um projeto de software livre no GitHub).
Ao clicar em tipos individuais na navegação à esquerda para qualquer namespace, você saltará diretamente para a seção de introdução da página do namespace para esse tipo. Clicando no nome do tipo na área principal do conteúdo de referência, você verá a página de detalhes da classe, que contém a cadeia de herança, a declaração e os detalhes da classe sobre a propriedade e os membros do método da classe.
exibição de classe
Para cada membro do método, você verá detalhes sobre os parâmetros e um resumo do método.
Exibição do método
Além do desenvolvimento e aprimoramento contínuos nas ferramentas de geração de documentos do DocFX, fizemos melhorias significativas nos princípios de engenharia e documentação que você verá evidentes na nova experiência de Documentação do .NET.
melhor de Automação
Quando as solicitações de pull são recebidas de possíveis colaboradores, validamos que o colaborador seguiu um processo simples de assinatura de nosso Contrato de Licença de Colaborador (esse processo é totalmente eletrônico e leva uma questão de minutos para ser concluído). Desde que as contribuições aderem às diretrizes de contribuição , pequenas alterações devem aparecer ao vivo no site minutos após a aceitação das solicitações de pull.
MELHORES URLs
Um princípio importante da experiência geral de docs.microsoft.com é melhores URLs para melhorar a indexação de pesquisa e a "adivinhação". Mantivemos esse princípio na Documentação do .NET. Os artigos e a documentação de referência têm URLs mais limpas. Veja, por exemplo, a URL clássica do MSDN para o namespace do sistema:
MSDN
Na nova documentação de referência, a URL é mais lógica, legível por humanos e, mais importante, mais detectável.
de criação mais ágil e aberta
O conteúdo não é apenas de software livre e não só aceitamos contribuições da comunidade. Além disso, todo o conteúdo em docs.microsoft.com (incluindo a Documentação do .NET) está disponível sob uma licença do Creative Commons. Você pode lê-lo, copiá-lo, referenciá-lo e reutilize partes dele (mesmo para uso comercial). Os escritores e engenheiros têm trabalhado ativamente com membros da comunidade por meses no novo sistema. Foi uma transição interessante e emocionante, e temos mais por vir no futuro.
Esta seção do docs.microsoft.com, assim como o restante do site, ainda está em versão prévia, portanto, estamos incentivando comentários construtivos e comentários. Envie suas ideias de recurso ao UserVoice.
Nas próximas semanas, publicaremos os comentários XML usados para gerar a documentação de referência diretamente no código-fonte do .NET. Isso permitirá que qualquer pessoa clique facilmente em atualizar a documentação de referência do .NET Framework.
Também continuaremos a ajustar o design e o layout da referência, bem como a capacidade mencionada de editar o próprio conteúdo de referência.
Estamos empolgados em trazer a nova área de Documentação do .NET em docs.microsoft.com e estamos ansiosos para melhorar sua experiência no futuro!