Esta versão do GitHub Enterprise Server será descontinuada em 2026-04-09. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Tipo de conteúdo de instruções

Explicar como concluir uma tarefa usando GitHub produtos e recursos.

Neste artigo

Instruções contêm etapas numeradas que descrevem como usar GitHub produtos para realizar uma tarefa. Geralmente, eles são necessários para aproveitar ao máximo GitHub.

Os artigos de instruções se concentram nas etapas mínimas essenciais para concluir uma tarefa. Eles podem vincular a outros tipos de conteúdo como pré-requisitos (especialmente conceitos ou referência) ou próximas etapas (especialmente tutoriais). De acordo com nossa estratégia de vinculação, elas devem ser usadas somente quando explicitamente úteis e necessárias.

Normalmente, incluir 1-2 frases introdutórias breves antes das etapas está bom. Se mais explicações além de algumas frases forem necessárias, considere adicionar as informações como um artigo conceitual.

A solução de problemas é seu próprio tipo de conteúdo, mas artigos de instruções podem incluir seções de solução de problemas curtas em que isso ajuda as pessoas a concluir a tarefa.

Títulos de artigos de instruções

Títulos de artigo e seções de instruções em artigos são baseados em tarefas e começam com um gerúndio.

  • Use: "Candidatar-se a um pacote para desenvolvedores estudantes" Use verbos ativos e específicos (faça um levantamento de ideias ou use um dicionário de sinônimos quando necessário). Os títulos descrevem especificamente a tarefa contida no artigo ou no cabeçalho, mas são gerais o suficiente para refletir todo o conteúdo.

Títulos curtos de artigos de instruções usam frases de verbo curtas e não gerundiais. Títulos curtos aparecem na navegação da barra lateral.

  • Use: "Gerenciar seu plano" ou "Criar problemas com Copilot"

Considerações para guias passo a passo

Para obter o modelo de conteúdo de instruções, consulte Modelos.

  • Siga as diretrizes de estilo para as etapas de procedimentos em Guia de estilo.
  • O conteúdo de tutoriais pode se tornar repetitivo –– procure oportunidades para agrupar conteúdo relacionado em um único artigo mais longo.
    • Agrupe vários instruções relacionadas em um único artigo, a menos que haja uma razão convincente para não fazer isso.
    • Se desabilitar uma configuração ou desfazer uma tarefa exigir as mesmas etapas e não tiver implicações especiais, não escreva uma instrução separada.
    • Se desabilitar uma configuração ou desfazer uma tarefa exigir etapas diferentes ou tiver implicações importantes ou especiais, crie um artigo mais longo para conter as duas instruções.
  • Sempre inclua o resultado pretendido do guia (geralmente esse será o título).
  • Inclua dicas de solução de problemas em pontos de dor conhecidos.

Exemplos de conteúdo de instruções

  •         [AUTOTITLE](/actions/using-workflows/using-starter-workflows)