快速入门帮助用户在大约五分钟或600字内，通过仅列出关键步骤，快速完成一个离散且聚焦的任务。快速入门可用于快速设置新工具，或快速完成其他任务。对于更复杂的任务，请使用教程。
当用户已经了解某个功能或产品并准备尝试时，快速入门非常有用。
我们在全站统称教程和快速入门为“指南”。在 /guides 着陆页中，我们会在文档集的指南列表中包含教程、快速入门以及某些过程性文章。
如何编写快速入门
关于快速入门模板，请参见 模板。
快速入门的内容
- 介绍
- 突出该指南简洁快速，使用如下措辞：
- 快速将 [FEATURE] 添加到您的项目中
- 入门 [PRODUCT] 的要点
- 面向熟悉 [FEATURE] 的用户的简明指南
- 明确受众
- 清晰列出前置条件和所需的先前知识
- 说明用户将完成或构建的内容
- 突出该指南简洁快速，使用如下措辞：
- 过程性章节
- 根据快速入门的受众，步骤可以比过程性内容更简略、非正式。如果受众不需要如此细节，您无需使用现有的可复用模块来组织这些步骤。
- 链接至其他文章或资源，而非复制内容，以免打断信息流。
- 提供视觉提示。大量使用代码块和截图，帮助用户确认自己正在执行正确的操作。
- 故障排除（可选）
- 如果该快速入门有相关的故障排除内容，请提供链接。
- 后续步骤
- 简要回顾在快速入门中已完成的内容，以便过渡到后续步骤。
- 列出 2-3 条可操作的后续步骤，供用户在完成快速入门后执行。始终链接到该功能或产品的概念性内容。您也可以链接到 docs.github.com 或 GitHub Skills 上的其他相关信息。
快速入门标题指南
- 当指南帮助用户快速上手新工具时，请在标题前加上 “Quickstart”，例如 “Quickstart for GitHub Actions” 或 “Quickstart: Procedural title”。
- 对于其他用例，请遵循过程性标题指南，省略 “Quickstart” 一词。