SuperAPI AI 工具集

tutorial-module-writer

写作与研究

查看项目

更新于 10-16 02:20

技能介绍

用途

Tutorial Module Writer 用于根据已批准的模块计划撰写教程内容,输出到 output/TUTORIAL.md。它强调“通过动手实践来教学”,要求每个模块围绕一个贯穿始终的示例逐步展开,并包含可验证的练习,而不是零散技巧或博客式长文。

主要能力

  • 按 outline/module_plan.yml 中的模块顺序展开教程。
  • 保持贯穿示例在各模块间一致,逐步扩展同一示例。
  • 为每个模块嵌入至少一个练习,包含预期输出与验证步骤。
  • 提供答案要点(不一定是完整解答),帮助学习者自检。
  • 控制范围,避免超出已批准计划。

使用方式

输入要求:

  • 必需:outline/module_plan.yml
  • 必需:DECISIONS.md(必须包含对范围/贯穿示例的批准,通常为 Approve C2)

工作流程:

  1. 确认批准:检查 DECISIONS.md 是否包含所需批准;若缺失,停止并请求签署。
  2. 将模块扩展为正文:遵循 outline/module_plan.yml 的模块顺序,保持贯穿示例一致。
  3. 嵌入练习:每个模块至少包含一个来自 outline/module_plan.yml 的练习,提供答案要点与验证步骤。
  4. 写入 output/TUTORIAL.md:偏好短小节与具体步骤,避免范围漂移。

推荐模块布局(每个模块重复):

  • 目标(1-2 句,可衡量)
  • 关键概念(最多一段)
  • 实操步骤(应用于贯穿示例,展示中间产物)
  • 练习(输入 → 预期输出 → 验证步骤)
  • 答案要点(项目符号;如何验证/常见错误)

适用场景

  • 已有结构化模块计划,需要将其扩展为连贯教程。
  • 需要确保教程包含可验证练习与自检答案要点。
  • 需要保持贯穿示例一致、避免范围蔓延的课程编写。

限制

  • 必须存在 outline/module_plan.yml 与包含批准的 DECISIONS.md,否则应停止并请求签署。
  • 范围严格限制在已批准计划内,不得引入计划外内容。
  • 不提供完整解决方案转储,答案要点仅用于自检。
  • 避免“思考题”式无验证输出的问题。
  • 避免每个模块引入新示例,以免破坏学习连续性。
  • 避免不改变学习者能力的博客式长文。

完成定义

  • output/TUTORIAL.md 按顺序覆盖所有已批准模块。
  • 每个模块包含至少一个练习 + 答案要点 + 验证。
  • 贯穿示例保持一致。

故障排除

  • 问题:教程变成没有教学循环的“博客文章”。修复:围绕目标与练习收紧每个模块,添加明确验证步骤。
  • 问题:范围蔓延超出批准内容。修复:删除 outline/module_plan.yml 之外的内容,并将新范围想法记录到单独迭代。