SuperAPI AI 工具集

explainer-artifact

写作与研究

查看项目

更新于 10-26 05:55

技能介绍

用途:在用户需要为某个概念、代码差异、想法或一段工作回顾编写解释文档时,生成一份可长期保存的本地说明文档,并在交付前进行结构和链接校验。

主要能力:

  1. 输入分类:把请求归为概念、diff、想法、工作回顾窗口四类之一,并确定读者对象;对“是否应采用 X”这类判断问题、以及“为日后工作记录已解决问题”的请求不做处理;诊断类操作问题直接在对话中回答。
  2. 支撑材料收集:概念类要求每条主要论断有来源引用,或明确标注无出处;diff 类要求引用能解析到提交,空范围时需说明实际解析结果并征得用户同意后才替换;想法类按用户原话解释其含义与取舍;回顾类以仓库活动为窗口。
  3. 检查点:在揭示内容前判断是否需要“测验”环节,记录用户选择“仅解释”或“测验我”;diff 模式下若选择测验,需先让用户预测改动内容与原因,收到预测后才撰写解释,并指出预测与实际之间的差距。
  4. 撰写与校验:默认生成单个自包含 HTML 文件(可选 Markdown),写入运行目录后做结构检查(合法解析、无未替换占位符、内部锚点可解析)和链接检查(外链可访问或标注 [unchecked]),失败可修复重试一次。
  5. 练习:仅在“测验我”时于对话中逐题提问、批改并指出暴露的差距,练习不放入文档内。
  6. 交付:询问一次目标位置,任何发布或远程迁移都需用户看到完整警示后明确确认,并由人工执行;无法完成确认时保留并报告本地路径。

使用方式:通过技能调用触发,可携带概念、diff 引用、想法或回顾窗口作为输入;裸调用时会先提一个阻塞性问题“要解释什么?”并提供“回顾本仓库近期工作”的快捷选项,用户不回答则以无文档结束。运行目录需满足安全条件(非符号链接、属当前用户、权限 700),否则报错退出。

适用场景:需要向他人或未来的自己解释某个概念、某次代码改动、一个想法,或一段时间的仓库工作内容时。

限制:只写本地临时目录,不发布、不远程迁移、不做版本控制或凭据变更;空 diff 范围、空回顾窗口、未回答的裸调用均以无文档的正常结束告终;结构检查重试后仍失败则不作为已校验文档呈现;非交互场景下仅报告本地路径。