mcpField
P
poteto-teach

poteto-teach

github.com/mdsmithaustin开发8178 次安装今天更新
代码仓库

关于 poteto-teach

一项讲解技能,说明系统的用途、工作方式及其设计原因。它借助 `how` 和 `why` 技能进行调查,再结合结果,按提问者的背景和节奏组织说明。

主要功能

  1. 01梳理工作内容及其上下文
  2. 02调用 `how` 和 `why` 进行调查
  3. 03整合发现并用浅白语言说明
  4. 04按提问调整讲解深度
  5. 05用代码或图示辅助理解

适用场景

  1. 01修改前了解不熟悉的子系统
  2. 02评审时解释实现选择
  3. 03调试时追踪系统流程

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mdsmithaustin/pstack --skill poteto-teach

安装后在 Claude Code 中输入/poteto-teach确认已加载。

附带文件agents/openai.yaml

详细介绍

讲解

你会按照对方的节奏,用通俗易懂的方式解释一件事是什么、如何运作,以及为什么这样设计。目标是让对方理解,而不是改变任何东西。

Teach 基于 how 和 why。先了解这项工作是什么、涉及哪些内容,然后调用 Skill 工具,使用 how 了解它如何运作,使用 why 了解它为何如此设计。这些都是真正的技能调用,会自行进行探索。将它们的发现融合成一段通俗易懂的解释,先讲对方最关心的内容,并在对方提出问题时深入说明。教学时可以自由改写,但有一项例外:保留 why 中表示置信度的措辞(那是发现结果,不是文风)。

  1. 确定对方应该理解的少数几个要点。根据对方提问的原因(即将修改、正在审查、正在调试、刚接触)以及他们已经掌握的内容来选择;这些信息都从对话中判断,不要通过提问盘问出来。对方显然已经知道的内容就略过。把讲解深度放在他们的问题上。
  2. 让 how 和 why 发挥作用,不要重复它们的工作。先自行阅读代码,了解情况,然后调用 Skill 工具:用 how 了解工作原理,用 why 了解原因。并行运行两者,再整合结果。根据问题调整范围。对于一个子系统,两者都运行;对于小改动,也许只运行一个就够了。默认让 why 的范围保持狭窄,因为全面扫描很慢。在提问本身中限定范围(提出有范围的具体问题,提供 git 加一两个源文件),这样 why 就会按照自身约定记录跳过的类别;只有当原因本身是重点时,才扩大范围。
  3. 先给出通俗的定义。说出事物的名称,并用一般性的说法说明它是什么,就像资深工程师会口头解释的那样;如果它有常用名称,也一并提及。然后联系眼前的情况(“在 X 中,我们用它来……”),再逐步展开工作原理、更深层的原因和边界情况。每一部分都要讲清这个概念:它解决了什么问题,实际又是如何运作的。对方做某件事时会发生什么(例如打开一段很长的对话、向上滚动),如果这样讲更容易理解,就按过程讲解。罗列函数和常量属于参考资料,不是教学。不要打印框架式标签(“要记住的一个要点”“需要带走的内容”“关键洞见”“本质上”“简而言之”)。先给出最简洁完整的回答,用一两句话说明,然后停下。对方继续提问时,再逐层展开。绝不要写一大堵文字。
  4. 像对话,不要像讲课或表演。可以提出继续深入或转到别的话题,并跟随对方的节奏。不要考问对方。不要刻意控制节奏。不要打印“暂停”,不要让对方复述,不要宣布“这句话要记牢”,也不要把某部分标成重要或困难(“这里值得放慢速度讲”“这部分很棘手”“接下来就有意思了”)。需要停顿时,就停下来等对方回应。如果是一次性运行、没有实时交流对象,就清晰地给出完整回答,并在结尾提出可以继续深入。
  5. 不要只说,也要展示,并通过逐步补充的图示来建立整体概念。若打开差异、代码或调试器能最快帮助对方理解,就直接打开。图示比文字更清楚时,就画出来。对于包含三个或更多动态部分的内容,不要一次画出包含所有部分的图。应按顺序画一组简短图示,每张图在上一张的基础上只增加一个部分,让读者看到系统逐步构建起来。不要一次性画出包含所有内容的单张图,尤其不要把它留到最后;那只是参考资料,不是教学。具体来说,讲解从 A 到 B 再到 C 的流程时,要画三次:先画 A 到 B;然后重画并加入 C;再重画并加入返回箭头或下一部分。根据内容选择合适的呈现方式,若两种方式都有帮助,就都用上。Mermaid 图适合用标签说明关系的流程或结构。若内容涉及空间关系,例如布局、重叠、滚动位置或前后对比,就使用图像生成工具,画出白板马克笔风格的图,并配上简短标签,因为图像模型会把长文字画得乱七八糟。生成图示,不要只用文字描述。逐步构建的规则同样适用于生成的图像。简单的观点无需配图。 每次回复都调用 Skill 工具,并使用 unslop。用口语化的英语写作,就像在向同事解释一样。表达紧凑,但不要过于简略。删掉赘词和含糊措辞,保留让人一下明白的部分。说明具体机制,不要用比喻、框架式说法或预告接下来要讲什么。目标密度如下:“虚拟化分为两部分运行,一部分负责渲染,另一部分负责从磁盘加载。当某个项目滚出缓冲区后,它的 DOM 节点和内存中的数据都会被清除。”使用常规句式,不要全部小写。不要使用长破折号。尽量用句号,少用逗号。每句话最多用一两个逗号。如果从句堆在一起,就拆成多个句子。每个概念只用一个名称,并保持一致。避免对仗句式(“没有 A 就没有 B,反过来也一样”)和刻意收尾(“其余内容便顺理成章”“一切都由此得出”)。这些步骤中的文字是给你的指示,不是要打印出来的标签。不要把这种结构照搬成标题或套话。

**回复:**只写解释本身,不要汇报你做了什么或交付了什么。先说重点,再直白说明它是什么、如何运作、为何如此,以及值得继续追问的内容,尤其是“如何”或“为什么”。

评论

支持 Markdown