SuperAPI AI 工具集

developer-tutorial

通用与其它

查看项目

更新于 10-16 08:45

技能介绍

用途:该技能用于编写或审计开发者产品的教学教程,目标是让尚不会某项能力的学习者,通过亲手构建一个可运行成果,最终掌握该能力。它强调教程不同于快速上手(quickstart):快速上手只证明产品可用,教程要留下可迁移的技能。

主要能力:先做范围检查,若目标只是快速验证产品、读者已有技能只需完成具体任务、产物是 API 参考、工程博客或视频脚本等,则路由到其他技能。通过访谈明确学习目标、受众水平、构建产物、运行环境、时长(Good Docs Project 建议 15 至 60 分钟)、是否有配套仓库或沙箱、是全新编写还是审计、上线日期、是一次性还是长期资产、作者工时上限与页面负责人。

使用方式:采用逆向设计,先写以动词开头的学习目标,再确定最终检查点与无辅助变体,然后选择最小构建产物,声明受众与前置条件,构建概念阶梯(骨架、核心概念、真实数据、健壮性、打磨),按依赖排序,每步只引入一个新概念,逐步淡出引导(早期给完整文件,中期只给新增行,后期只给需求与预期输出)。每 3 至 5 步设置检查点,包含命令、预期输出与恢复路径,并作为可恢复点。结尾说明学习者已掌握的能力并给出完整最终产物,再指向 how-to、参考与解释文档。

适用场景:面向自学用户的公开教程,或内部/企业工具的上手教程。限制:不编造功能、收费、平台或效果;资料未提供具体命令、代码示例、仓库地址与发布日期等信息。教程应避免分支与选择,保持单一保证路径,解释控制在一句话并外链。