Skip to main content

关于合并多个内容类型

可以在单个文章中合并多个内容类型,以帮助用户完成复杂的任务。

“参与 GitHub Docs”部分中的文章指的是文档本身,是 GitHub 员工和开放源代码参与者的资源。

通常,在上下文中对信息进行分组有助于人们完成复杂的任务、了解一组相关任务或演示整个工作流。 使用结合各种内容类型的较长文章,确保用户在正确的位置找到上下文内容。 较长的文章还有助于消除内容的重复,并准备内容以随着产品中添加更多选项而进行缩放。 人们在积极使用产品时通常需要较长的文章,他们可能需要在其旅程的不同阶段查阅文章。

如何在文章中合并多个内容类型

  • 在较长的文章中使用概念性、过程性、参考性、故障排除或已知问题内容,不要使用快速入门或教程。
  • 根据需要使用文章中不同内容类型的部分,并遵循内容类型的标题准则。
  • 通常,这些文章至少包含一个过程部分以及至少一个附加的概念性、参考性或过程部分。
  • 使用内容排序准则来组织文章中的标题。
  • 尽可能频繁地使用故障排除信息。
  • 如果需要,可以在标头中复制文章标题。

合并多个内容类型的文章的标题指南

  • 如果文章中有一个过程,请使用以动名词开头的基于任务的标题。
  • 标题具有通用性,足以描述文章中包含的信息和任务的范围。
  • 标题描述要切换的设置,并且与读者选择的设置无关,例如“设置存储库可见性”,而不是“公开专用存储库”。

合并多个内容类型的文章示例