mcpField
F
feynman

feynman

github.com/owainlewis文档处理4446 次安装10 周前更新
代码仓库

关于 feynman

用于撰写技术主题教学文档的技能,通过机制、示例、边界情况和练习讲解一个连贯主题,并提供结构、解释和检查指导。

主要功能

  1. 01聚焦一个技术主题
  2. 02先解释机制再引入术语
  3. 03在各章节使用具体示例
  4. 04说明局限与争议边界
  5. 05加入结尾练习

适用场景

  1. 01讲解聚焦的技术概念
  2. 02将宽泛主题拆分为较小选项
  3. 03说明技术机制的运作方式
  4. 04依据教学标准检查草稿

安装

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

$npx skills add https://github.com/owainlewis/agent-skills --skill feynman

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

详细介绍

Feynman

通过机制、示例、边界情况和练习,撰写一份讲解一个技术主题的文档。

规则

  • 讲解一个连贯的主题。
  • 如果主题太宽泛,提供 2-4 个更具体的主题,并请用户选择一个。
  • 开篇从读者熟悉的现象入手,而不是下定义。
  • 在介绍细节前,先说明读者能学到什么。
  • 在每个章节中,先说明要点,再进行解释。
  • 先解释机制,再说出术语。
  • 先用一句通俗的话建立心智模型,再介绍正式表述。
  • 每个章节使用一个具体示例。
  • 先逐步讲解示例,再给出通用规则。
  • 使用类比时,指出类比不适用的地方。
  • 指出尚未解决、复杂或有争议的边界问题。
  • 结束时纠正显而易见的错误结论。
  • 使用短句和常用词。
  • 删除听起来深刻、却没有提供信息的句子。
  • 将参考资料、表格、速查表和语法摘要放在单独的文档中。

结构

# [Title: claim or question]

[Opening: 2-4 sentences. Observation from the reader's experience.]

[Promise: what the reader will understand.]

## [Section title: specific claim]

[Point in one sentence.]
[One concrete example, walked through completely.]
[Code, command, prompt, or diagram only when it clarifies the idea.]

## [Next section]

## Putting it together

[Short scenario that uses the sections together.]

## Try it

[One exercise. Under ten minutes.]

[Closing sentence that earns the opening promise.]

缩小范围示例

"AI agents" is too broad. Pick one:

1. Agent memory: types, mechanics, when to use each
2. Tool calling: loop mechanics and tool design
3. Error handling: failures, recovery, avoiding hangs

机制示例

较弱:“这会使用 RAG 检索相关上下文。”

较强:“RAG 分三步工作。首先,搜索存储的文档,找出与用户问题相关的内容。其次,将这些内容粘贴到提示词中。最后,使用这些信息生成答案。这个名称只是步骤的顺序:检索、增强、生成。”

检查

  • 开篇描述了读者熟悉的现象。
  • 在细节之前说明了读者能学到什么。
  • 先介绍机制,再说出术语。
  • 每个章节围绕一个要点进行讲解,并使用一个示例。
  • 纠正了显而易见的错误结论。
  • 指出了类比的局限。
  • 指出了边界问题。
  • 包含 Putting it together。
  • 包含练习。

评论

支持 Markdown