关于内容模型

我们的内容模型解释了我们在 GitHub Docs 中创建的每种内容类型的用途，以及在撰写或更新文章时应包含哪些内容。我们使用内容模型来确保我们的内容以一致、清晰和全面的方式传达人们实现其 GitHub 目标所需的信息。

我们在所有文档集中使用这些类型，以提供一致的用户体验——任何内容类型都适用于任何产品或受众。我们的内容类型会随着时间推移而发展，并且我们会根据需要添加新的类型。我们只发布符合模型的内容。

一致性有助于人们形成对文档的心理模型，并了解如何在随着时间的推移返回 GitHub Docs 时找到他们需要的信息。维护和更新一致的内容也更有效率，无论您是做出首次提交的开源贡献者，还是 GitHub 员工中负责记录全新产品的撰写人员，都可以更轻松、更快速地为文档做出贡献。

内容结构

文档在我们网站上组织成多个层次结构。

顶级文档集
- 类别
  - 主题地图
    - 文章
  - 文章
- 文章

内容组织是在创建有助于人们找到他们正在搜索内容的特定分组，以及限制人们必须浏览的层次结构层级之间的平衡。具有许多嵌套在一起的主题地图的深层层次结构可能难以找到特定文章。具有许多类别或同一层级文章的宽层次结构使人们难以评估和决定他们想要选择什么。

主页内容

GitHub Docs 主页，docs.github.com，重点介绍了人们想要找到的最重要的主题。我们限制了主页上文档集的数量，以便人们能够找到信息，并且主页不会变得过于拥挤且难以搜索。

主页包含所有顶级文档集和一些类别。主页上的内容围绕 GitHub 概念和实践进行组织。例如，“CI/CD 和 DevOps”组包含 GitHub Actions、GitHub Packages 和 GitHub Pages 的顶级文档集。

将文档集添加到主页

主页的目的是帮助人们找到有关他们想要了解的 GitHub 功能或产品的的信息。添加到主页的每个项目都会降低其他每个项目的可发现性，因此我们限制了主页上包含的文档集数量。

如果创建了新的顶级文档集，则将其添加到主页。

如果某个类别是使用 GitHub 产品或功能的起点，则可以将其添加到主页。

例如，在主页上的“安全”分组下，除了“代码安全”顶级文档集外，还包括“供应链安全”、“安全公告”、“Dependabot”、“代码扫描”和“密钥扫描”类别，因为每个类别都是 GitHub 产品和功能的入口点。“安全概述”未包含在主页中，因为它提供了使用代码安全产品的其他信息，而不是对产品或功能的介绍。

顶级文档集

顶级文档集围绕 GitHub 产品、功能或核心工作流进行组织。所有顶级文档集都显示在 GitHub Docs 主页上。只有当有大量内容需要包含在新文档集中、多个细分为主题地图的类别以及主题适用于跨产品、功能或帐户类型时，您才应创建顶级文档集。如果内容可以适合任何现有的顶级文档集，则它可能属于该现有文档集。