SuperAPI AI 工具集

explain

编程与开发

查看项目

更新于 11-11 18:37

技能介绍

explain 是一个智能体编程技能,核心思路是“先图后文”:用图解展示真实机制,包括实际组件、数据流和状态变化,再配以简短的说明文字。

【用途与模式】调用时传入参数,第一个词为 html 时使用 HTML 模式,否则默认终端模式;其余内容为解释主题。未提供主题时,解释当前对话内容。

【共同要求】两种模式都要呈现真实机制,使用真实名称、形状和数字,避免“处理中”这类空泛标签。说明文字遵循简化技术英语:每步不超过 20 词,每条描述不超过 25 词,主动语态,每句一个观点,用词含义单一;代码和标识符保持原样。若解释当前项目中的代码,需先阅读源码并标注路径与行号。

【终端模式】绘制不超过 80 列宽的 ASCII 图,优先纵向堆叠而非单行长排;图后配编号说明,使用图中的标签。

【HTML 模式】为每个步骤建立任务并完成;如可用,加载 html-design-examples 技能获取视觉模式。在工作目录的 .explain/<kebab-slug>.html 写入一个自包含页面,使用内联 CSS 和 JS,无需构建步骤;修订同一主题时复用 slug。在 git 仓库中,若 $(git rev-parse --git-path info/exclude) 缺少 .explain/,则追加,使页面保持未跟踪状态而不改动 .gitignore。核心图放在首个 1200x800 屏幕内,细节放在下方,读者不滚动即可理解核心思想。图表使用内联 SVG 以便高亮和动画;大型流程图或时序图可使用来自 cdn.jsdelivr.net 的 Mermaid。对于流程类内容(流水线、算法、协议、请求生命周期),构建分步演示:由同一步骤索引驱动场景,提供上一页/下一页按钮、方向键和播放/暂停,每个场景高亮变化并显示一行说明,加载时停在最终完整场景以展示全貌;完成标准是按钮、方向键和播放/暂停都能移动步骤索引。仅在改变数值有教学意义时添加滑块、开关或对比视图。支持 prefers-color-scheme 明暗主题,文字满足 WCAG AA 对比度。若浏览器工具可用,分别截取明暗模式下首个 1200x800 屏幕并读取控制台,修复文字裁切、重叠和错误;无浏览器工具时需说明页面未做视觉检查。最后回复页面路径和 2-3 行摘要,不在回复中包含 HTML 内容。

【适用场景】适合解释技术概念、系统架构、代码实现和流程机制,尤其需要可视化理解时。

【限制】仅依据上述技能说明;其具体安装方式、依赖环境和收费信息暂未提供。