关于 teach
teach 是用于解释代码库设计与代码变更的技能,面向需要理解系统结构和行为的开发者。它按目标选择讲解范围,并依据代码、测试和文档建立有来源支撑的模型。
主要功能
- 01按请求选择最小连贯讲解范围
- 02追踪入口、流程与接口约定
- 03结合代码、测试和架构说明
- 04按需使用代码片段与图示
- 05说明边界情况、权衡与维护影响
适用场景
- 01理解某个子系统或功能的职责
- 02学习代码变更及其影响
- 03梳理应用整体结构
- 04解释数据流或控制流
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sjunepark/ agent-scripts --skill teach安装后在 Claude Code 中输入/teach确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlevals/evals.jsontriggers.jsonguides/changes.mddiagrams.mdsnippets.mdwhole-application.md详细介绍
教学
基于源代码,建立对目的、职责、契约、控制流或数据流,以及让设计易于理解的决策的心智模型。 这是一项讲解工作:按要求讲解语法或实现机制,只有在外部背景会改变对本地模型的理解时,才纳入相关内容。
选择目标和指南
- 对于差异、提交、范围、补丁或代码/文档比较,请阅读 变更讲解。在 Git 仓库中未指定目标时,默认查看已暂存、未暂存和相关的未跟踪变更。 阅读内容前先列出变更路径,并从默认选择中排除包含密钥的 环境或凭据文件,以及私人文档。如果没有符合条件的内容,请询问目标。 引用或总结所选内容前,先对机密和私人个人数据进行脱敏。
- 对于目标明确为
project、需要了解整个应用,或需要跟进其学习地图的情况,请阅读 整个应用概览。 - 其他情况请选择能满足请求的最小完整子系统、功能、边界或流程。
- 需要精确代码来解释契约、条件、数据形状或状态转换时,请阅读 代码片段。
- 可视化关系能显著提升理解时,请阅读 图示。
基于依据构建并讲解模型
从相关入口点或公共边界开始。根据需要阅读支持代码、测试以及附近的说明或架构文档,追踪主流程,并在不臆测的前提下解释其契约。对推断出的意图要明确标注。
按学习顺序讲解:先说明目的和背景,再讲重要流程、归属关系和决策。根据学习者和目标调整深度与形式;小型变更可能只需一段说明。选择性地提供证据,并将源码位置附在其支持的论述旁,而不是让读者主要依靠路径来理解。
在不变式、边缘情况、权衡和维护后果会影响理解时,将它们纳入说明。指出容易误导的名称或模糊的边界,作为教学提示;不要把讲解变成未经请求的全面审查。
最后,形成一个连贯的模型,帮助学习者推理这部分内容或对其进行修改。在能带来帮助时,强调最值得记住的要点;避免为了满足结尾章节的形式要求而重复简短的讲解。
评论
支持 Markdown