跳至主要内容

关于主题

使用主题使文章可搜索。

可以通过在文章的前置信息中列出这些主题来定义一篇文章与一个或多个主题相关。例如

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

有关将主题添加到文章的更多信息,请参阅“使用 YAML 前置信息”。有关所有允许主题的列表,请参阅 allowed-topics

所有内容类型的主题

  • 使用名词作为主题
  • 主题帮助人们有意义地对内容进行分组
    • 如果可能,请使用与之相关的更具体的主题,而不仅仅是宽泛的主题。例如,使用 RESTGraphQL,而不是仅使用 API
    • 确保类似文章上的主题保持一致,以便按主题筛选的用户可以获取所有相关的文章。例如,所有关于 CI 的文章都应包含 CI 主题以及更具体的主题
    • 避免使用模棱两可的主题。例如,在 Actions 产品中,Actions 可能不是一个有用的主题,因为它可能指的是 GitHub Actions 产品或称为操作的产品元素
  • 主题除了文章标题、类型或类别之外,还增加了价值
    • 例如,在 Actions 产品中,Actions 不会增加价值,因为此部分文档的用户已经知道他们在查看 Actions 文档
  • 对于与产品领域的核心概念相关的文章,请使用 Fundamentals
    • 使用:在诸如“GitHub Actions 简介”之类的文章中使用 Fundamentals
    • 避免:在诸如“GitHub Actions 简介”之类的文章中避免使用 Actions
  • 可以使用常用的缩写,但应避免使用模糊或模棱两可的缩写
    • 使用:使用 CI 代替 Continuous integration
    • 避免:使用 AS 代替 Advanced Security
  • 使用 GitHub 产品名称的简写形式
    • 使用:使用 Actions 代替 GitHub Actions

选择主题的清单

考虑以下问题,以帮助为文章选择主题。并非每篇文章都会针对清单中的每个项目都有一个主题。

  • 功能或产品领域是什么?
    • 示例:Enterprise 文章是否与子功能有关(除非产品名称与功能名称匹配)?
    • 示例:Dependabot
  • 此功能是否属于受限程序的一部分?
    • 示例:Advanced Security
  • 文章涉及功能或产品的哪个元素?
    • 示例:Organizations
  • 文章的总体目的是什么?
    • 示例:Permissions
  • 文章明确涉及哪些编程语言、包管理器或生态系统?仅当这些主题对筛选文档的用户有价值时才包含这些主题,而不仅仅是在文章中列出了支持的语言、包管理器或生态系统。
    • 示例:Ruby