Skip to main content

Enterprise Server 3.21 目前作为发布候选版本提供。

入门内容类型

入门内容提供使用产品或功能的最小基本信息。

入门内容提供使用GitHub产品和功能的入口点。 本部分应仅包含用户需要的最低基本信息,然后才能转到概念和操作方法。 我们这样做是为了简洁,也为了让用户在开始使用某项功能时不觉得太复杂。

入门注意事项

“入门”是一组文章,应该便于快速浏览。 它应包含少于 5 篇文章,理想情况下只有两篇文章:

  • 快速入门
  • 关于 [PRODUCT] (或“什么是 [PRODUCT]”)

唯一可能的例外是可用套餐和账单信息,即在使用该产品或功能时必须提供此类信息的情况下。

有关快速入门内容的详细信息,请参阅 快速入门内容类型

具体而言,包含这些信息的文章不应归入“Get started”:

  • 属于操作方法内容类型下的文章。
  • 设置或注册步骤:这些内容也属于操作指南。 它们记录了如何在 UI 中执行某些操作。
  • 帮助用户开始使用某项特定功能、但不涵盖整个产品领域的内容。 此类内容更适合放在“概念”部分。
  • 一般情况下,最佳做法。 对功能不熟悉的用户缺少充分利用这些功能所需的上下文。