教程帮助人们了解产品并通过引导完成整个工作流来解决真实世界的问题。相比其他内容，教程的语气更具对话性。它像开发者之间的交流，却仍能让不同技术水平的读者轻松理解。有教程的产品必须已经拥有快速入门。对于简短的工作流，请改用快速入门模型。
教程面向需要专家建议以及对其问题相关最佳实践进行详细讨论的读者。它们也帮助过去在其他产品上实现过类似方案的用户使用 GitHub。教程还能帮助读者判断该方案是否适合自己的需求。
我们统称教程和快速入门为“指南”。在 /guides 着陆页上，我们将教程、快速入门以及某些过程性文章列入文档集的指南列表。
如何编写教程
有关教程模板，请参阅 模板。
教程内容
- 介绍
- 明确受众。
- 清晰列出所需的前提条件和先前知识。
- 说明读者将完成或构建的内容。
- 包含一个成功项目的示例。
- 不提供完成任务所需的预估时间——这取决于完成教程的人的经验水平。
- 过程性章节
- 根据教程的受众，步骤可以比过程性内容更不明确和非正式。如果受众不需要如此详细的层次，也不必使用已有的可重用组件来呈现这些步骤。
- 使用：“从您的个人资料中，点击 Settings，然后点击 Developer settings”。
- 避免：“在任何页面的右上角，点击您的个人头像，然后点击 Settings。在左侧边栏，点击 Developer settings”。
- 链接到其他文章或资源，而不是复制它们，以免打断教程的信息流。
- 提供视觉提示。大量使用代码块和截图，帮助读者确认自己正在执行正确的操作。
- 提供真实示例。
- 例如，不要仅仅告诉读者“输入提交信息”，而是给出一个符合前面步骤的合适的示例提交信息。
- 根据教程的受众，步骤可以比过程性内容更不明确和非正式。如果受众不需要如此详细的层次，也不必使用已有的可重用组件来呈现这些步骤。
- 故障排除
- 说明任务中可能出现的问题，并列出读者可能遇到的常见问题及其解决方案。
- 结论
- 回顾已完成或已构建的内容。参考引言中提供的项目，将其作为成功项目的示例。
- 后续步骤
- 列出 2–3 个可操作的后续步骤，供读者在完成教程后继续使用。可链接到以下相关信息：
- GitHub 上展示所介绍概念的项目
- docs.github.com 上的相关信息
- 相关的 GitHub 技能
- Hubbers 发布的相关演讲、博客文章或社区论坛系列帖子
- 列出 2–3 个可操作的后续步骤，供读者在完成教程后继续使用。可链接到以下相关信息：
教程标题指南
- 遵循过程性文章的标题指南。
- 标题中不要使用 “tutorial” 或 “guide”。
教程示例
教程
语言与框架指南