Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-03-26. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

参考内容类型

参考内容提供了用户在主动使用某个功能时所需的详细信息。

我们在其他文章中创建参考文章和参考部分。

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

如何编写参考内容

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

  • 编写一个句子或整个概念性部分来介绍参考内容。
  • 清晰、一致地呈现实际参考内容。
  • 对于具有要说明的单个元素的主题,请使用列表。
  • 对于具有要说明的多个元素的主题,请使用表。
  • 对于较长的参考内容(例如工作流的 YAML 语法),请一致地使用标头。

参考内容的标题

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

参考内容的示例