SuperAPI AI 工具集

explainer-book

通用与其它

查看项目

更新于 10-15 21:38

技能介绍

用途:当一篇 20 分钟以内的速习资料不够用时,把主题拆成分章、可动手的书籍式学习资料(<topic>-book/01-quickstart.md、02-….md 等),面向指定读者画像设计、撰写并检验。需先阅读相邻的 explainer/SKILL.md,它提供读者画像、图示与验证机制;本技能补的是整本书的设计与检查。

主要能力:章节目录与顺序、每章学习目标(写成“读完后能判定什么”,并配至少一个测验题)、概念引入顺序(概念恰好由一章引入,未引入前不得使用,requires 形成依赖图)、读时预算(500 字/分 + 代码 15 行/分)、练习(write 类需“起点跑会失败、答案能通过”;check 类需可再生成判定输出,答案放在同节 details)、生成依赖图与 SVG,并把多页构建为带目录和前后章导航的 HTML。

使用方式:按步骤执行——1 定读者画像与全书问题;2 列出 3〜6 个应掌握的判定,每章 1〜2 个;3 用 book.json 的 introduces/requires 确定概念顺序;4 先做示例与练习并实跑验证;5 按 explainer 的写作范式写章(章首写时长、目标、前提,章尾加理解度检查并链到下一章);6 运行 node <skill>/scripts/verify-book.mjs <book-dir> [--write](--write 重生成依赖图与 SVG);7 让首位读者读 quickstart 与练习章;8 交付 dist/index.html 与各章一句摘要,并标注未验证点。verify-book.mjs 会调用相邻 explainer 的 scripts/verify-doc.mjs,两个技能需放在同一位置;之后 README 与全部章节需再经 verify-doc.mjs --pages 检查引用、图、页间链接与 vlmkit 门禁,直到 book verdict 为 VERIFIED。

适用场景:内容需动手练习、概念存在先后依赖、单篇资料超过 20 分钟或需章级测验时。

限制:不适用于可用单篇 explainer 覆盖的内容;不得为凑章节稀释内容、不得让练习答案未跑通、不得重复前章说明(应引用章号)、不得靠同义改写绕开概念检查。依赖安装方式同 explainer;本资料未提供具体安装命令、收费、平台与效果信息。