Sobre tópicos

Um artigo pode ser definido como relevante para um ou mais tópicos, tendo esses tópicos listados na matéria inicial do artigo. Por exemplo:

---
title: "Managing branches in your repository"
topics:
  - "GitHub"
  - "Git"
  - "Repositories"
---

Para saber mais sobre como adicionar tópicos a um artigo, confiraUsar front matter YAML. Para obter uma lista de todos os tópicos permitidos, consulteallowed-topics.

Tópicos para todos os tipos de conteúdo

• Use substantivos como tópicos
• Os tópicos ajudam as pessoas a agrupar o conteúdo de maneira significativa
  • Quando possível, use tópicos mais específicos que sejam relevantes e não apenas tópicos amplos. Por exemplo,REST ouGraphQL em vez deAPI
  • Verifique se os tópicos sobre artigos semelhantes são consistentes para que as pessoas que filtram o conteúdo por um tópico obtenham todos os artigos relevantes. Por exemplo, todos os artigos sobre CI devem ter o tópicoCI, além de tópicos mais específicos
  • Evite tópicos ambíguos. Por exemplo, talvezActions não seja um tópico útil no produto Actions, pois ele pode se referir ao produto GitHub Actions ou ao elemento do produto chamado ação
• Os tópicos adicionam valor e não replicam o título, o tipo nem a categoria do artigo
  • Por exemplo, no produto Actions,Actions não agrega valor, pois alguém que esteja nessa seção da documentação já saberá que está examinando a documentação do Actions
• UseFundamentals para artigos relacionados aos principais conceitos de uma área de produto.
  • Use:Fundamentals em um artigo como “Introdução ao GitHub Actions”
  • Evite:Actions em um artigo como "Introdução ao GitHub Actions"
• As abreviações comumente reconhecidas podem ser usadas, mas as abreviações obscuras ou ambíguas devem ser evitadas
  • UseCI em vez deContinuous integration
  • Evite:CS em vez deCode scanning
• Use as formas curtas de nomes de produtos do GitHub
  • UseActions em vez deGitHub Actions

Lista de verificação para escolha de tópicos

Considere estas perguntas para ajudar a escolher os tópicos para um artigo. Nem todos os artigos terão um tópico para cada item da lista de verificação.

• Qual é o recurso ou a área do produto?
  • Exemplo:Enterprise O artigo trata de um sub-recurso (a menos que o nome do produto corresponda ao nome do recurso)?
  • Exemplo:Dependabot
• O recurso faz parte de um programa restrito?
  • Exemplos:Copilot
• Qual elemento do recurso ou do produto é o artigo?
  • Exemplo:Organizations
• Qual é a finalidade geral do artigo?
  • Exemplo:Permissions
• Quais linguagens de programação, gerenciadores de pacotes ou ecossistemas o artigo aborda explicitamente? Só inclua esses tópicos se isso agregar valor a alguém que filtra a documentação, não apenas se um artigo listar as linguagens compatíveis, os gerenciadores de pacotes ou os ecossistemas.
  • Exemplo:Ruby