快速入门内容类型

快速入门使用户能够在大约 5 分钟或 600 字内演示仅包含基本步骤的工作流，从而快速完成分散的重点任务。快速入门可用于快速设置新工具，或快速完成其他任务。对于更复杂的任务，请使用教程。

当某些读者已经了解功能或产品，而且准备好试用时，快速入门非常有用。

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

如何编写快速入门

有关快速启动模板，请参阅“模板”。

快速入门的内容：

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