主题用于过滤文章,并且可以在整个 GitHub Docs 网站上搜索。对于某些布局(例如登录页面或指南),人们可以通过过滤主题来选择显示哪些文章。使用这些指南来帮助选择要添加到文章 frontmatter 的主题。有关将主题添加到文章的更多信息,请参阅“主题”,有关所有允许主题的列表,请参阅 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
- 示例: