Examinar a documentação usando problemas do GitHub

Concluído

Uma das maneiras mais úteis de contribuir com o Microsoft Learn é fazer comentários diretamente em um artigo de documentação. Usando o link de comentários na página, você pode fornecer edições, sugestões, perguntas ou outras informações conforme elas aparecem em sua navegação. Como a maioria do conteúdo da documentação do Microsoft Learn é armazenada em repositórios do GitHub, você pode fornecer seus comentários usando um processo do GitHub chamado envio de um Problema do GitHub.

Um Problema no GitHub é uma ferramenta que permite que usuários de tecnologia, engenheiros e outros visitantes do Microsoft Learn compartilhem e acompanhem comentários em um artigo específico. Você preenche um formulário para documentar seus comentários e postá-los no repositório do artigo de origem no GitHub, onde um autor ou proprietário será notificado. Qualquer pessoa que visita o repositório GitHub pode ver Problemas. Eles servem como uma maneira útil de coletar e armazenar comentários valiosos, como relatar bugs, solicitações de recursos ou anotações.

Por que revisar o conteúdo no GitHub?

Fornecer revisões de conteúdo no GitHub é uma maneira direta de contribuir para um tópico pelo qual você é apaixonado ou conhecedor. Isso significa que você pode adicionar suas ideias enquanto está explorando um tópico na documentação da Microsoft. Contribuir com suas ideias para o pool de conhecimento ajuda a melhorar as experiências de produtos da Microsoft para milhões de outros usuários. Seus comentários avançam no conteúdo para outros visitantes do Microsoft Learn que dependem de produtos da Microsoft e de seu conteúdo de suporte.

Na maioria dos casos, enviar comentários do GitHub permite que você envie suas ideias para a equipe responsável pelo conjunto de conteúdo do produto. Esse caminho de colaboração entre equipes de conteúdo e usuários de produtos permite que os comentários sejam compartilhados e discutidos diretamente no GitHub.

Contribuir com o conteúdo da documentação também pode fornecer benefícios profissionais para você. O GitHub é uma plataforma conhecida em que as contribuições técnicas podem ser feitas e controladas. Cada vez que você contribui para um projeto no GitHub, ele é refletido em seu perfil do GitHub. Ao longo do tempo, você pode criar um registro de suas contribuições para adicionar ao seu portfólio técnico.

Como fazer comentários sobre o conteúdo

Lembre-se de que muitos artigos de documentação sobre o Microsoft Learn são armazenados em repositórios do GitHub. Muitos repositórios do GitHub têm problemas do GitHub habilitados. Quando habilitado, você pode encontrar a opção de enviar comentários para esta página na parte inferior de um artigo.learn.microsoft.com

Captura de tela das opções de comentários na parte inferior de um artigo de documentação.

Veja como enviar um problema no GitHub de um artigo do Microsoft Learn:

  1. Navegue até o artigo de documentação do Microsoft Learn no qual você gostaria de fazer comentários.

  2. Na parte inferior do artigo, localize o título rotulado Comentários. Ao lado da pergunta esta página foi útil?, há botões para Sim e Não. Selecione um botão para indicar se o artigo foi útil. Isso abre um formulário no qual você pode preencher seus comentários.

  3. Selecione o motivo dos comentários.

  4. Na caixa de texto a seguir, descreva seus comentários e forneça qualquer contexto necessário.

  5. Quando terminar, selecione Enviar.

Captura de tela de um formulário de problemas do GitHub em branco para enviar comentários em um artigo de documentação.

O autor do artigo ou outros proprietários de conteúdo são notificados quando você envia seu problema.