主题用于筛选文章,并且可在 GitHub Docs 站点中搜索。 对于某些布局(如登陆页面或指南),用户可以通过筛选主题来选择显示哪些文章。 使用这些指南来帮助选择要添加到文章的前言的主题。 有关向文章添加主题的详细信息,请参阅“主题”;有关所有允许的主题的列表,请参阅 allowed-topics
。
所有内容类型的主题
- 所有文章都应至少有一个主题
- 使用名词作为主题
- 主题可帮助人们对内容进行有意义的分组
- 如果可能,请使用更具体的相关主题,而不仅仅是广泛的主题。 例如,
REST
或GraphQL
,而不是API
- 确保类似文章的主题一致,使按主题筛选的人获得所有相关文章。 例如,有关 CI 的所有文章都应包含
CI
主题以及更具体的主题 - 避免不明确的主题。 例如,
Actions
在 Actions 产品中可能不是有用的主题,因为它可能指产品 GitHub Actions 或称为操作的产品元素
- 如果可能,请使用更具体的相关主题,而不仅仅是广泛的主题。 例如,
- 主题会增加价值,并且不复制文章的标题、类型或类别
- 例如,在 Actions 产品中,
Actions
不会增加价值,因为阅读文档的此部分的人已经知道他们正在查看 Actions 文档
- 例如,在 Actions 产品中,
- 将
Fundamentals
用于与产品领域的核心概念相关的文章。- 使用:在“GitHub Actions 简介”这样的文章中使用
Fundamentals
- 避免在“GitHub Actions简介”等文章中使用
Actions
- 使用:在“GitHub Actions 简介”这样的文章中使用
- 可以使用普遍认可的缩写,但应避免使用模糊或不明确的缩写
- 使用:
CI
,而不是Continuous integration
- 避免使用
AS
而不是Advanced Security
- 使用:
- 使用 GitHub 产品名称的简短形式
- 使用:
Actions
而不是GitHub Actions
- 使用:
用于选择主题的清单
请考虑这些问题以帮助选择文章的主题。 并非每篇文章都有清单中每一项的主题。
- 功能或产品区域是什么?
- 示例:
Enterprise
文章是否关于子功能(除非产品名称与功能名称匹配)? - 示例:
Dependabot
- 示例:
- 功能是否属于受限程序?
- 示例:
Advanced Security
- 示例:
- 文章是功能或产品的哪个元素?
- 示例:
Organizations
- 示例:
- 文章的广义用途是什么?
- 示例:
Permissions
- 示例:
- 文章明确介绍了哪些编程语言、包管理器或生态系统? 仅当这些主题为筛选文档的人增加价值时,才包括这些主题,而不仅仅是当文章列出了支持的语言、包管理器或生态系统时。
- 示例:
Ruby
- 示例: