SuperAPI AI 工具集

explain-visually

写作与研究

查看项目

更新于 10-24 16:17

技能介绍

用途

该技能在用户要求“视觉化解释”或“用视觉方式解释”时使用,也适用于解释代码变更、提案、计划或架构决策,帮助读者在不逐行阅读代码的情况下快速理解决策所需信息。

主要能力

  • 先研究和收集事实,将每条事实连同来源记录在 facts.md 中;若已有事实文件则直接作为事实来源。
  • 规划页面:在 notes.md 前 15 行内写出单句答案及主要成本、3–5 个关键数字、4–8 个需解释术语、一个真实代码片段(≤8 行)以及各章节一句话说明。
  • 支持章节类型:概览(始终)、故事(5–7 步,一个演进图形)、代码走读(仅当变更涉及读者必须看到的代码)、决策(当用户需要做决定时,使用选项 JSON)。
  • 概览需用标题陈述答案及主要成本,一个句子,一个主视觉(数字可用 ev-bars--hero),至多一个“Decide”提示。
  • 使用 explainer-kit 的组件和片段契约构建章节,不新增主题、字体、组件或自定义布局 CSS。
  • 将真实代码片段放入决策 JSON 的推荐选项代码中,而非单独成章。
  • 引用信息放在详情中:代码头部写文件路径,决策的 Sources 开关放链接。
  • 最后用 preview.py、assemble.py 和 check.py 组装并检查单页 index.html,发布为 artifact(除非要求只写文件)。

使用方式

用户提出视觉化解释需求后,技能按步骤执行:收集事实 → 规划页面 → 逐章编写 HTML 片段 → 组装、检查、发布。编写章节时使用 Write 工具逐个文件写入,避免 shell heredoc。所有文件写入完成后,以一条链式命令运行组装和检查脚本。检查脚本只运行一次,修复所列问题后再运行一次即停止。

适用场景

  • 解释代码变更、提案、计划或架构决策。
  • 需要让读者快速理解决策要点并做出知情决定。
  • 需要单页、约 1000–1500 词的视觉化说明。

限制

  • 页面仅使用 explainer-kit 现有组件,不新增主题、字体或布局 CSS。
  • 不编造事实;数字需来自命令或真实测量,并注明方法和版本。
  • 不得将单个测量结果扩大为“每个”或“所有”。
  • 概览不使用信息框网格。
  • 仅在用户要求时添加 explain-with-section-clips、-slides 或 -video。
  • 不启动子代理来构建此规模的页面。
  • 不阅读 kit.css、kit.js、assemble.py 或 SCRIPTS-AND-TABS.md 来构建页面。
  • 不通过截图或自写浏览器脚本排查其他问题。
  • 发布后回复不超过 5 行,包含答案、页面路径和未检查事项。