教程通过在整个工作流中引导用户以完成任务，帮助用户了解产品并解决实际问题。 教程的语气比其他内容更具对话性。 教程感觉就像是开发人员与开发人员的对话，同时仍可供具有各种技术知识的读者使用。 包含教程的产品必须已有快速入门。 对于小型工作流，请改用快速入门模型。
教程适用于需要专家建议并详细讨论与其问题相关的最佳做法的人。 教程还帮助过去通过其他产品实现过类似解决方案的用户使用 GitHub。 教程还可以帮助用户验证解决方案是否适合其需求。
我们将教程和快速入门统称为整个网站的“指南”。 在 /guides 登陆页上，我们在文档集的指南列表中包括教程、快速入门和某些过程文章。
如何编写教程
有关教程模板，请参阅 模板。
教程内容：
- 简介
- 阐明受众。
- 明确说明先决条件和所需的先验知识。
- 说明某人将完成或生成的内容。
- 包括成功项目的示例。
- 不要包括完成任务可能需要的预期时间 - 这取决于完成教程的人的经验水平。
- 过程部分
- 根据教程的受众，这些步骤可能不如过程内容中使用的步骤明确和正式。 如果受众不需要该级别的详细信息，则不必使用现有的可重用内容来构成这些步骤。
- 使用：“在个人资料中，单击‘设置’，然后单击‘开发人员设置’。”
- 避免：在任一页面的右上角，单击你的个人资料照片，然后单击“设置”。 在左侧边栏中，单击“开发人员设置”。
- 链接到其他文章或资源，而不是复制它们，以避免中断教程中的信息流。
- 提供视觉提示。大量使用代码块和屏幕截图来帮助确保用户正在执行正确的操作。
- 提供真实示例。
- 例如，不要让某人“输入提交消息”，而是为他们提供与前面的步骤匹配的适当示例提交消息。
- 根据教程的受众，这些步骤可能不如过程内容中使用的步骤明确和正式。 如果受众不需要该级别的详细信息，则不必使用现有的可重用内容来构成这些步骤。
- 故障排除
- 确认任务中可能出现的问题，并在解决方案中列出读者可能会遇到的一些常见问题。
- 结论
- 查看已完成或生成的内容。 请参考简介中提供的项目，作为成功项目的示例。
- 后续步骤
- 包括 2-3 个可操作的后续步骤，用户可以在完成教程后执行这些步骤。 链接到其他相关信息，例如：
- GitHub 上的项目，说明介绍的概念
- docs.github.com 上的相关信息
- 相关的 GitHub Skills
- Hubbers 的相关已发布演讲、博客文章或社区论坛系列文章
- 包括 2-3 个可操作的后续步骤，用户可以在完成教程后执行这些步骤。 链接到其他相关信息，例如：
教程标题指南
- 遵循过程文章的标题指南。
- 请勿在标题中使用“教程”或“指南”。
教程示例
教程：
语言和框架指南：