快速入门内容类型

快速入门最适合那些想要快速获取说明的人，而不需要冗长的解释说明如何操作或为什么他们想要使用它。

在本文中

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

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

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

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

快速入门指南的内容

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