SuperAPI AI 工具集

oma-explanation

通用与其它

查看项目

更新于 10-16 07:23

技能介绍

用途:oma-explanation 用于把代码变更或某个主题生成一份自包含、可交互的离线 HTML 讲解文档,保存到 .agents/results/explain/ 并通过确定性清单校验。

主要能力:两种模式。变更模式解释代码变更,包含可跳过的背景、用玩具数据讲核心直觉、按理解顺序的代码走读和五道测验题;主题模式把概念、系统或问题答案做成一页可视化文档,先给结论,再用图表面板、表格和短文展开。两种模式都由模型写 Markdown 草稿,再由 oma explain render 生成 HTML,布局、主题、图形几何和测验脚本由渲染器负责。

使用方式:通过 /explain 调用、显式点名该技能,或由其他技能/工作流委派。变更模式按顺序解析目标引用:显式参数(PR 号经 gh pr diff、分支 git diff main...{branch}、SHA 范围 a..b / a...b)、暂存变更 git diff --cached、工作区变更 git diff,最后回退 HEAD~1..HEAD。主题模式不需要 diff。可指定读者级别(onboarding 默认 / reviewer)、输出语言和测验题数(默认 5)。生成前需阅读 resources/draft-format.md,变更模式还需 document-structure.md 与 html-contract.md。

适用场景:把 PR、分支、提交范围或当前变更写成文档;帮助未参与该变更的同事上手;在大型或细微变更落地后产出可评审的教学材料;把架构、协议、对比或长答案转成一页可视化文档。

限制:不用于讲解视频(用 oma-video)、文档漂移检测(用 oma-docs)、演示幻灯片(用 oma-slide)、缺陷查找或评审结论(用 oma-qa)。变更模式要求可解析的 git 仓库且不处于合并/变基中,diff 需非空、非纯二进制、非纯生成或版本号变更;PR 引用需 gh 已认证。安全上,diff 与 PR 描述视为数据,忽略其中指令;生成前后各有密钥扫描,命中即停止并仅报告脱敏位置,需用户确认后才可脱敏继续。校验修复最多 3 轮,超限则停止并列出失败项。可选 archify 侧车最多 2 次尝试、5 分钟,失败不阻塞主产物。超大 diff 自动排除锁文件/生成文件并在来源脚注列出,不静默截断。