Revise a documentação usando os problemas do GitHub

Concluído

Uma das maneiras mais úteis de contribuir para o Microsoft Learn é enviar comentários diretamente sobre um artigo de documentação. Usando o link de feedback na página, você pode fornecer edições, sugestões, perguntas ou outras informações à medida que elas surgem na 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 sobre um artigo específico. Você preenche um formulário para documentar seu feedback e publicá-lo no repositório do artigo de origem no GitHub, onde um autor ou proprietário será notificado. Qualquer pessoa que visite o repositório GitHub pode ver Problemas. Eles servem como uma maneira útil de coletar e armazenar feedback valioso, como relatar bugs, solicitações de recursos ou anotações.

Por que revisar conteúdo no GitHub?

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

Na maioria dos casos, enviar feedback 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 as equipes de conteúdo e os usuários do produto permite que o feedback seja compartilhado e discutido diretamente no GitHub.

Contribuir para o conteúdo da documentação também pode proporcionar benefícios profissionais para você. O GitHub é uma plataforma bem conhecida onde contribuições técnicas podem ser feitas e rastreadas. Cada vez que você contribui para um projeto no GitHub, isso se reflete no seu perfil do GitHub. Com o tempo, você pode criar um registro de suas contribuições para adicionar ao seu portfólio técnico.

Como dar feedback 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 ativados. Quando ativado, você pode encontrar a opção de enviar comentários para esta página na parte inferior de um artigo sobre learn.microsoft.com.

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

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

  1. Navegue até o artigo da documentação do Microsoft Learn sobre o qual você gostaria de dar feedback.

  2. Na parte inferior do artigo, encontre o título rotulado Feedback. 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 onde você pode preencher seus comentários.

  3. Selecione o motivo do seu feedback.

  4. Na caixa de texto a seguir, descreva seus comentários e forneça o 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 sobre um artigo de documentação.

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