SuperAPI AI 工具集

teach-me

写作与研究

查看项目

更新于 10-15 23:25

技能介绍

用途:teach-me 用于把“某一个东西”讲透,对象可以是文件、函数、功能、子系统、概念或错误信息,也可指定讲给某类听众(如工程师、经理、设计师、孩子)。它不做整个陌生代码库的通读,那属于其他技能。

主要能力:按固定输出框架组织内容——听众、TL;DR 加类比、七步(名称、来源、存在理由、工作机制、权衡、限制、在整体系统中的位置)、So what。工作机制部分优先真实运行代码并观察状态,而非静态猜测;无法运行时明确标注为静态解释。

使用方式:先确定听众与范围,读取对应来源;能运行时用具体输入驱动代码,借助已有调试工具(如 python3 -m pdb、breakpoint()、node --inspect、console.log)临时插桩观察;随后按框架生成回答,默认内联 mermaid 图,用户同意时才生成 HTML 说明页;最后移除所有临时插桩并用 git diff 确认干净。

适用场景:需要向特定对象解释某个具体机制、报错或设计取舍时;需要为不同听众(工程师、管理者、非技术者)调整深度与表达时。

限制:范围限于单一对象,不写 wiki、不分析整个项目;非技术听众不得出现代码块或反引号;无法运行环境时只能静态解释并说明未经验证;未观察到的运行时断言需记入待确认清单;临时插桩未清理则视为未完成。