快速入门内容类型

快速入门最适合那些希望快速获得指导，而无需冗长解释某事物如何工作或为何要使用它的用户。

本文内容

快速入门使人们能够通过仅说明工作流程中必要的步骤（大约五分钟或 600 字）来快速完成离散的、集中的任务。快速入门可用于快速设置新工具，或快速完成其他任务。对于更复杂的任务，请使用教程。

当有人已经了解功能或产品并准备尝试时，快速入门非常有用。

在整个网站上，我们将教程和快速入门统称为“指南”。在 `/guides` 首页上，我们在文档集的指南列表中包含教程、快速入门和某些程序性文章。

有关快速入门模板，请参见“模板”。

快速入门内容

简介
- 使用以下措辞突出显示本指南的快速性和重点
  - 快速将[功能]添加到您的项目
  - [产品] 入门的要点
  - 熟悉[功能]的人员的简要指南
- 明确目标受众
- 明确说明所需的先决条件和先验知识
- 说明用户将完成或构建的内容
程序性部分
- 根据快速入门目标受众，步骤可以比程序性内容中使用的步骤更简洁、更正式。如果目标受众不需要那样详细的级别，则不必使用现有的可复用组件来形成这些步骤。
- 链接到其他文章或资源，而不是复制它们，以避免中断信息流。
- 提供视觉提示。大量使用代码块和屏幕截图，以帮助确保用户正在执行正确的操作。
故障排除（可选）
- 如果快速入门存在相关的故障排除内容，请提供指向该内容的链接。
后续步骤
- 作为向后续步骤过渡的一种方式，请快速回顾快速入门中已完成的内容。
- 包含用户完成快速入门后可以执行的 2-3 个可操作的后续步骤。始终链接到有关该功能或产品的概念性内容。您还可以链接到 docs.github.com 或 GitHub Skills 上的其他相关信息。