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