参考内容类型

我们创建参考文章并在其他文章中引用参考部分。

• 一些主要主题可能需要自己的参考文章，尤其是在存在大量参考内容的情况下，例如 GitHub Actions 中的搜索语法或 YAML 语法。
• 对于少量内容或更具体的信息，例如功能支持的语言或硬件要求列表，请在程序或概念文章中使用上下文中的参考部分。

如何编写参考内容

有关参考内容模板，请参阅“模板”。

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

参考内容的标题

• 参考文章或参考部分的标题清晰地描述了该部分的内容，通常以名词开头。
• 标题包含足够的信息，以便新手用户可以访问并全面描述每个部分的内容。
• 标题避免堆叠名词 - 使用介词来分解长串名词。

参考内容示例

• 参考文章
  • 键盘快捷键
  • 企业中的角色
  • 计费的 REST API 端点（在 REST API 文档中）
  • 更改（在 GraphQL API 文档中）
• 其他文章中的参考部分
  • “支持的语言”（在GitHub 移动版中）
  • “硬件注意事项”（在在 AWS 上安装 GitHub Enterprise Server中）