Agent Skills
返回列表
🎓

教程工程师

教育学习 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/tutorial-engineer。

技能介绍

问题在哪

技术文档往往「能读不能练」:概念堆在一起、示例片段不可运行、常见坑没有提前说明,读者跟到一半就卡住。写教程的人若缺少教学设计视角,很容易变成 API 说明书,而不是可独立完成项目的学习路径。

技能如何工作

该技能以教程工程为框架,把「写文档」变成「设计 learning 体验」。核心能力包括:

  • 渐进式披露:把主题拆成原子概念,按依赖关系排成可跟进的章节
  • 动手学习:从完整可运行示例出发,设计填空、调试、扩展、从零构建等练习类型
  • 错误预判:在章节里加入故障排查与刻意错误,教读者从失败里调试

典型流程是:先定义学习目标与先决条件 → 概念拆解并排学习顺序 → 练习设计(由简到繁、带检查点)。输出侧强调 Markdown 教程结构:开篇(你将学到 / 先决条件 / 时间估算)、渐进章节(概念 → 最简示例 → 引导练习 → 变体 → 挑战 → 故障排查)、收尾(总结与后续步骤),并遵循「展示而非告知」、递增复杂度、频繁验证等写作原则。详细示例见 resources/implementation-playbook.md。

适用边界

适用于需要教程结构、练习设计或质量检查清单的任务;与教程工程无关的通用写作、或非本技能覆盖的工具链,应换用其他技能。操作时应先厘清目标、约束与输入,再应用最佳实践并给出可执行步骤与验证方式。

使用场景

  • 为新 SDK 或框架编写分章动手上手教程,需明确学习目标、先决条件与可运行代码示例
  • 将堆叠概念的 API 参考文档改写成渐进章节,并补充引导练习与常见错误排查
  • 发布内部培训或对外教程前,用质量清单核对示例完整性、概念引入顺序与难度曲线
  • 为某一技术主题设计填空、调试挑战、扩展任务等多种练习,并规划章节内的自我检查点

适合人员

  • 负责把版本能力转成可跟做实验文档的内部开发者关系或布道同学
  • 技术文档工程师,需要把参考型长文拆成带时间估算与最终成果的系列教程
  • 培训讲师或开源社区主讲,要按概念依赖编排编码课件与练习类型
  • 开源维护者,希望入门文档能让读者频繁运行代码并从刻意错误里学会调试