前言¶
在 DeepSeek Harness(DSH)里做「教一门课」或「生成成套学习笔记」,常见做法是临时写 prompt,让 agent 输出零散 Markdown。产物往往缺少统一结构、节与节之间的动手主线、以及可离线浏览和判分的配套界面。维护者 GamecialX 的插件 dsh-study-notes(GitHub:GamecialX/dsh-study-notes,社区目录:skillhub 插件页)向当前 profile 注册 study-notes 技能:按内置《学习笔记生成准则》交付标准 Markdown 笔记库、读者自建的 project/ 动手线、以及单文件本地网页门户(含练习与章末测试判分)。插件分类为工作流;index.js 仅使用 node: 内置模块,零依赖、零构建,可离线安装。
这是什么¶
dsh-study-notes 是一个 DSH bundle:加载后在会话技能目录中出现 study-notes。当用户想从零学一门科目、需要学习笔记 / 教学文档 / 讲义式材料时,技能指导 agent 生成能从头跟到尾的课(而非概念百科):每节在读者自己的 project/(非代码科目则为推导本、句子本、时间线等)里产出可检查的结果,下一节承接上一节;概念在第一次用到它的步骤里出现。新课程会先写一节样章,用户确认风格后再批量生成。当前 package 版本为 2.1.2,许可证 MIT,要求 Node.js >= 20。
核心功能¶
技能交付的产物¶
生成内容位于用户指定的笔记根目录,主要包括:
| 产物 | 说明 |
|---|---|
00 大纲.md |
科目简介、跟课方式、逐章逐节「本节产物 / 动手入口」、概念检索表 |
Cha_X 章名/ |
节笔记(接上一节 → 若干「第 N 步」→ 小结 → 练习)、CX 速查.md、CX 测试.md、src/ 图源;章末通跑与项目地图 |
project/ |
读者动手目录,从空开始;agent 不在此写入 |
code/(代码类科目) |
答案快照 code/answer/chNN/、运行输出 code/out/、演示 notebook 等 |
checklist.md |
规划、进度指针、样章风格约定、变更与恢复上下文 |
web/ |
单文件门户 index.html、数据 notes_data.js、离线 KaTeX、serve.mjs |
| 启动脚本 | 启动学习服务器.bat、start_server.sh 一键起服务并打开门户 |
门户能力(据 README):进度与均分仪表盘、侧栏目录树、五种标注块渲染(答案默认折叠)、锚点与 Markdown 链接、速查页、离线公式(KaTeX 0.16.22,本地缺失时可回退 CDN)、节内练习即时判分、章末测试与成绩单、知识图谱、全文搜索、localStorage 持久化。
规范与校验¶
技能资产在 assets/study-notes/:SKILL.md 为入口;references/ 含笔记格式、教学设计、流程恢复、质量门禁、门户契约、Typora 兼容、分科目 playbook 等;templates/ 提供大纲、节笔记、速查、测试等骨架及门户模板。
用户或维护者可用插件内脚本校验生成库,例如:
node assets/study-notes/scripts/check-library.mjs "<笔记根目录>"
node assets/study-notes/scripts/check-library.mjs "<笔记根目录>" --strict
node assets/study-notes/scripts/run-course.mjs "<笔记根目录>"
check-library.mjs 检查结构、链接、可移植性、教学篇幅与练习数量、代码绑定、课程线规则 R1–R12 等;--strict 将课程线 warning 升为 error,适合新库验收。
安装与启用¶
插件包即仓库根目录(含 package.json 的一层)。DSH 从本地绝对路径安装,需先把仓库放到本机(官方 README 示例):
git clone https://github.com/GamecialX/dsh-study-notes.git
记克隆后的绝对路径为 <插件目录>,任选一种方式安装。
方式 A:Web 界面(推荐)
- 打开 DSH Web 界面,左侧 Plugins → Add plugin。
- 填写
<插件目录>的绝对路径(须指向含package.json的目录)。 - 点 Install;bundle 与 id 为
study-notes的项默认启用。
方式 B:会话内 plugin_manager
在启用 plugin_manager 的 Creator 模式会话中,要求 agent 使用 install_bundle 将 <插件目录> 装到当前 profile(非完全权限下需批准)。
方式 C:CLI
dsh plugin --profile <profile 名> add "<插件目录>"
安装后确认:Plugins 页出现 Study notes (学习笔记) 卡片;新会话技能列表含 study-notes。若通过符号链接指向本地目录安装,不要移动或删除该目录,否则 skill 或资源路径会失效。
典型用法¶
- 在新会话中说:「我想从零学 \<某科目>,给我生成学习笔记。」
- agent 应加载
study-notes,先确认科目与目的;按流程 P0–P5 规划,P2.5 样章确认后再批量写章。 - 笔记就绪后,在笔记根目录执行启动脚本或
web/serve.mjs/ Python 静态服务,浏览器打开本地门户阅读、做题与章末测试。 - 交付前对笔记根目录运行
check-library.mjs --strict(及代码类科目的run-course.mjs)做验收。
插件开发自测可在插件目录执行:
npm test
适用场景与注意¶
适合:希望在 DSH 里把「学一门新课」固化为可复用工作流的产品/教学场景;需要 Typora 优先的标准 Markdown、节节累积的动手线、以及离线可用的本地门户与判分,而不是一次性 chat 输出。
注意:
- 插件以当前 DSH 进程权限运行;安装前请阅读仓库源码与 MIT 许可证,确认路径与 profile 策略符合你的环境。
- 社区目录站点与 DeepSeek / 幻方无官方从属关系,插件来自社区维护者 GamecialX,星标等元数据以目录页与 GitHub 为准。
- 浏览器内的门户视觉效果(毛玻璃、动效等)README 说明需人工查看;自动化测试覆盖渲染与判分逻辑,不覆盖全部 UI 细节。
结尾¶
dsh-study-notes 把「从零学一门课」收敛为 DSH 技能 study-notes:标准 Markdown 库、读者 project/ 主线、校验脚本与本地学习门户一体,零 npm 运行时依赖。进一步了解请查看 GitHub 仓库 与 skillhub 目录页。