Visão geral da edição de documentação no Microsoft Learn

Obrigado pelo seu interesse em editar documentação no Microsoft Learn! As suas contribuições ajudam-nos a garantir que a nossa documentação está bem escrita, atualizada e precisa. As informações contidas nesta página ajudá-lo-ão a decidir qual o melhor método de contribuição para si.

Pré-requisito

Antes de começar, verifique se você está conectado à sua conta do GitHub. Se você não tiver uma conta no GitHub, navegue até para https://github.com/join obter um processo de inscrição rápido e gratuito.

Pequenas alterações à documentação

Pequenas alterações são rápidas e fáceis. Exemplos de pequenas alterações incluem:

  • Correção de erros de digitação
  • Revisão de um único artigo
  • Adicionar uma secção a um artigo
  • Corrigir um erro
  • Atualizando links quebrados

Se você estiver fazendo pequenas alterações, tudo o que você precisa é de uma conta no GitHub!

Para fazer uma pequena alteração, selecione o ícone de lápis Editar este documento na parte superior do artigo. Esta ação leva você ao arquivo de origem no GitHub, onde você pode fazer suas alterações. Quando terminar, você será solicitado a criar uma solicitação pull (PR) para propor suas alterações. Para obter um passo a passo completo desse processo, consulte Editar documentação no navegador.

Principais alterações à documentação

Grandes mudanças envolvem mais tempo e esforço. Exemplos de alterações importantes incluem:

  • Alterações complexas que levarão vários dias para serem concluídas
  • Revisões de vários artigos que você deseja enviar juntos
  • Criar um novo artigo
  • Contribuir frequentemente

Se você estiver fazendo grandes alterações, precisará baixar e instalar algumas ferramentas para facilitar seu trabalho. Siga estes passos para começar:

  1. Instale as ferramentas Git e Markdown.
  2. Configure um repositório Git local.
  3. Faça alterações na documentação.
  4. Crie um PR.

Descrição geral do processo

O fluxo de processo abaixo mostra as etapas de alto nível envolvidas no início de pequenas e grandes alterações. Observe que alguns itens são etapas únicas, enquanto outros ocorrem toda vez que você inicia uma nova contribuição.

Process flow map showing the basic workflow for getting started with the contribution process.

A imagem começa com um ponto de decisão de É a sua primeira vez contribuindo? Se sim, o próximo passo é configurar sua conta do GitHub. Se não, o próximo passo é outro ponto de decisão de A sua mudança é menor? Se sim, o próximo passo é editar dentro do navegador. Se não, as próximas etapas envolvem instalar ferramentas de criação, bifurcar e clonar o repositório, fazer alterações, abrir uma solicitação pull e revisar e assinar sua solicitação pull.

Alterações aos módulos de formação

Os colaboradores não podem editar ou propor alterações aos módulos de formação. No momento, apenas a documentação do Microsoft Learn armazenada em repositórios públicos está aberta para contribuições públicas.