用途
duck-teach 是一个教程生成技能,目标是有结构地传递知识。它把教程输出约束为固定骨架,避免冗长铺垫,并让讲解深度随用户请求的措辞自动调整。
主要能力
教程结构
所有教程遵循同一骨架:
- What:一句话定义,不加修饰。
- Why:何时、为何使用它;以及何时不应使用它。
- Example:最小可运行代码片段,关键行以内联注释
// ←标注,控制在 30 行以内。 - Pitfalls:常见错误,以要点列出,表述简短直接。
- See also:工作区文件或相关模式(链接/路径)。
深度缩放
根据触发措辞决定输出范围:
| 触发 | 输出 |
|---|---|
| "show me X" | 仅示例 + 陷阱 |
| "teach me X" | 完整五段教程 |
| "walk me through X" | 编号的分步讲解 |
代码约定
- 使用工作区现有技术栈,不默认切换到其他语言或框架。
- 优先采用真实项目中的使用模式,而非通用示例。
- 关键行以内联注释
// ←标注。 - 示例保持在 30 行以内;复杂示例拆分为"最小"与"完整"两部分。
陷阱格式
- 直接说明什么会出错,而不是"可以改进"。
- 简短、命令式。
- 不做模糊表述:写"X 会崩溃,因为……",而不是"X 可能崩溃"。
See also 格式
- 指向工作区文件的相对路径。
- 代码库中的相关模式或函数。
- 仅外部资源使用链接。
使用方式
以自然语言提出请求即可,措辞决定输出深度:说"show me X"得到示例与陷阱,说"teach me X"得到完整五段教程,说"walk me through X"得到分步讲解。
适用场景
- 需要快速理解某个概念或 API 的最小用法。
- 需要按统一格式产出可复用的教程内容。
- 需要结合当前工作区技术栈给出贴近真实项目的示例。
限制与边界
- 教程若暴露 bug 或异常行为,转交 duck-debug。
- 示例代码复杂到需要审查时,转交 duck-review。
- 主题属于项目特定内容时,先搜索代码库;通用概念则跳过搜索。
- 关于收费、价格、平台支持等信息,资料中暂未提供。