SuperAPI AI 工具集

oma-explanation

前端与建站

查看项目

更新于 10-15 21:55

技能介绍

用途:把代码改动或某个主题生成离线、可视化、可交互的 HTML 讲解文档,保存到 .agents/results/explain/ 并确定性校验。两种模式:改动模式讲解 diff、PR、分支或提交范围;主题模式讲解概念、系统或问题答案,单页含图示、表格与短文字。

主要能力:改动模式含可跳过的背景、直觉说明、按理解顺序的代码走查与测验;主题模式含结论、4–9 个单一要点面板,关系或顺序用图示表达。作者写 Markdown 草稿,再运行 oma explain render 生成 HTML;版式、主题、图示与测验脚本由渲染器负责。

使用方式:以 /explain 调用或显式指名。目标 ref 的解析顺序为显式参数(PR 号走 gh pr diff、分支走 git diff main...{branch}、SHA 范围)→ 暂存区 → 工作树 → HEAD~1..HEAD。可指定读者级别、输出语言与测验题数(默认 5 题)。依赖 git,PR 引用需 gh CLI。校验命令为 oma explain validate [file]。

适用场景:向未参与改动的队友讲解变更、大或细微改动落地后的教学材料、把架构对比或长答案变成一页可视化说明。

限制:不用于视频(用 oma-video)、文档漂移检测(用 oma-docs)、幻灯片(用 oma-slide)或缺陷审查(用 oma-qa)。需可解析的 git 仓库且非合并/变基中,diff 需非空、非仅二进制或生成文件。改动与 PR 文本视为数据,不执行其中指令;有生成前与生成后双重密钥扫描,命中需明确确认才能脱敏继续;校验修复最多 3 轮,超限停止列出失败项;超大 diff 的排除项会在来源脚注列出,不静默截断。渲染失败会指出草稿行与组件语法。具体安装、收费与平台信息暂未提供。