SuperAPI AI 工具集

create-skill-from-source-code

写作与研究

查看项目

更新于 10-16 06:56

技能介绍

用途

该技能面向需要将现有源代码转化为教学材料或可复用文档的场景。当你手头有一份参考实现,希望从中提取设计模式、架构思路并整理成结构化的技能文件时,可以按照它提供的系统化工作流来完成。

主要能力

  • 阅读并解析完整源代码文件,理解其整体范围。
  • 识别关键架构模式,包括核心设计模式(如 Observer、Factory、MVC)、关键实现技巧、重要数据结构、核心算法以及外部系统集成点。
  • 创建技能目录结构,按需建立 examples、templates 等辅助目录。
  • 生成包含 YAML frontmatter 的 SKILL.md,正文涵盖概述、关键模式、完整代码模板、使用示例、最佳实践、适用场景、相关模式与参考资料等章节。
  • 校验文件创建结果与 frontmatter 格式,确保文件以 --- 开头、包含 name 与 description 字段、并以 --- 闭合。
  • 可选地添加示例脚本、模板文件与配置示例等辅助资源。

使用方式

工作流分为六步:

  1. 读取并解析源代码,例如使用 cat /path/to/source/file.ext 或文件读取工具。
  2. 识别关键架构模式,记录 3 至 5 个定义实现的主要模式。
  3. 创建技能目录,例如 mkdir -p skills/skill-name,如需辅助文件可再建 examples、templates 子目录。
  4. 生成 SKILL.md,frontmatter 需用 --- 包围,name 使用小写与连字符,description 控制在 1 至 2 句。正文按标题层级组织,包含概述、关键模式(每个模式说明目的、实现方式、关键代码元素)、完整代码模板、基础与进阶使用示例、最佳实践、适用场景、相关模式与参考资料。
  5. 验证文件与 frontmatter,例如 ls -la skills/skill-name/SKILL.md 与 head -n 5 skills/skill-name/SKILL.md。
  6. 可选添加辅助文件,如演示脚本、起始模板与配置示例。

适用场景

适合需要从参考实现中提炼可教学、可复用模式的开发者或技术写作者。文档中给出的示例是将一个实现虚拟滚动的 VirtualList.ts 转化为 virtual-scrolling-pattern 技能,涵盖分块渲染、滚动事件监听、DOM 动态更新与可见项状态管理等模式。

限制与注意事项

文档列出了常见陷阱:过于具体、缺少 frontmatter、没有示例、模板不完整、组织混乱。同时提供校验清单,要求 frontmatter 有效、name 小写连字符、description 简洁、关键模式清晰、代码示例带注释、内容经过泛化、文件结构符合约定、不残留任务特定细节、指令可操作。关于该技能的具体收费、价格、平台支持范围等信息,资料中暂未提供。