SuperAPI AI 工具集

change-explainer

编程与开发

查看项目

更新于 10-16 01:14

技能介绍

用途:把代码或文档的 diff、commit 或提交范围、PR 补丁、版本对比讲给不了解该项目或文档的“冷读者”听。默认假设读者懂普通编程和 Git,但不了解项目目的、领域、架构、术语与目录结构;若用户明确说明读者背景,则以用户说明为准。核心是讲清系统行为的变化,而非语言语法、补丁机制或逐行改动。

主要能力与结构:按“整体→区域→具体问题→改动→机制”的脚手架组织讲解。遵循基线先于差异(先说明项目或文档做什么、被改子系统或章节做什么、处于什么位置);具体先于抽象(先用一次真实运行、请求或故障展示旧行为及其代价,再归纳所有权、生命周期、契约等);术语先定义再使用,并做到一个概念一个说法;选取1至4条核心思路作为学习主线,其余编辑放入维护细节;按阅读顺序递进深度;只在有助于理解时使用表格或紧凑文本图。解释与判断分离,只对实质性的正确性、回归、契约、安全/数据或长期设计问题提出关切,推断的意图或取舍需标注为推断。

输出契约:直接在最终回复中用 Markdown 给出完整讲解,不创建、保存或打开 HTML 页面、Markdown 文档、图表文件、.change-explainer/ 目录或任何其他产物。工作流保持只读,调用该技能只授权查看,不授权修改被比较的仓库或文档。除非为消除用户请求中的歧义,否则不提及未生成产物。不使用原始 HTML,不依赖可折叠界面。

使用方式:指定要比较的 diff、commit、范围、PR 补丁或文件对。在 Git 仓库中未指定目标时,用 git status --short 查看未提交改动、已暂存与未暂存差异及相关未跟踪文件;若工作区干净或目录不是 Git 仓库,则向用户询问目标。响应长度随改动规模伸缩:微小改动压缩回答但保留“基线→例子→差异→证据”;大改动先给概览,再按行为(而非按文件)分组展开。开头用2至4句话给出结论,随后给出一个“之前→现在→结果”的具体故事,再讲解机制。

适用场景:适用于向不熟悉项目的读者解释代码或文档变更,帮助快速理解改动的影响与原因。限制:仅在用户明确请求时使用;不生成任何制品;不覆盖语法教学或完整迁移说明;资料未提供具体价格、平台与效果信息。