参考内容类型

我们创建参考文章以及其他文章中的参考章节。

• 某些重要主题可能需要独立的参考文章，尤其是当参考内容大量时，例如 GitHub Actions 中的搜索语法或 YAML 语法。
• 对于较少的内容或更具体的信息，如功能支持的语言列表或硬件需求，请在程序性或概念性文章的上下文中使用参考章节。

如何编写参考内容

有关参考内容模板，请参见 模板。

• 编写一句话或整个概念章节来介绍参考内容。
• 清晰且一致地呈现实际的参考内容。
• 对于仅需解释单一要素的主题，请使用列表。
  • 示例：组织的仓库角色
• 对于需要解释多个要素的主题，请使用表格。
  • 示例：组织的仓库角色
• 对于更长的参考内容，例如工作流的 YAML 语法，请一致使用标题。
  • 每个独立章节使用 H2 标题。
  • 子章节（如示例）使用 H3 标题。
  • 示例：GitHub Actions 工作流语法

参考内容的标题

• 参考文章或参考章节的标题应清晰描述该章节内容，且通常以名词开头。
• 标题应包含足够信息，使新手用户易于理解，并完整描述每个章节的内容。
• 标题避免堆叠名词——使用介词来拆分冗长的名词串。

参考内容示例

• 参考文章
  • 键盘快捷键
  • 企业中角色的权限
  • 计费的 REST API 端点 在 REST API 文档中
  • 变更 在 GraphQL API 文档中
• 其他文章中的参考章节
  • “支持的语言” 在 GitHub Mobile 中
  • “硬件考虑因素” 在 Installing GitHub Enterprise Server on AWS 中