dsh_docs
IdentifiedDeepSeek Harness docs plugin.
DeepSeek Harness Docs
一个 DeepSeek Harness(DSH)插件:在项目中创建并维护专属的 dsh_docs 文档目录,为 DSH 开发、维护项目提供背景知识与技术架构参考。
功能
-
规范注入:插件激活后,向 DSH 的系统提示词注入
dsh_docs文档规范(目录结构、DSHD.md 固定模板、概述/索引/细分文档编写规则,以及“先读文档再读代码”的建议)。 -
初始化工具
dsh_docs_init:可被 DSH 调用,一键在项目中生成dsh_docs/骨架:- 始终写入固定的
dsh_docs/DSHD.md(记录插件版本); - 仅在不存在时创建
dsh_docs/OVERVIEW.md、dsh_docs/INDEX.md占位文件。
- 始终写入固定的
-
校验更新工具
dsh_docs_update:由用户手动触发文档内容更新与校验。工具只读,会检查:- 固定文件是否存在、DSHD.md 是否与当前插件版本的固定模板一致;
- OVERVIEW.md 是否包含“概述 / 项目结构 / 开发规则 / 禁止行为”四部分且已替换占位内容;
- INDEX.md 是否覆盖所有模块文档目录、其中的相对链接是否有效;
- 各 Markdown 文档中的相对链接是否指向存在的路径。
工具返回文档清单、结构问题与更新工作单;随后由 agent 以代码为唯一事实来源,逐份核对并修正与实际情况不符的内容,再次调用工具直到结构状态为
ok。
工具用法
在 DSH 中直接要求 agent 校验或更新项目文档,例如:
校验并更新本项目的 dsh_docs
agent 会调用 dsh_docs_update 获取工作单,对照代码修改文档后再次校验。也可以让 agent 调用 dsh_docs_init 初始化新的 dsh_docs/。
dsh_docs 目录结构
dsh_docs/
├── DSHD.md # 固定说明文档,记录插件版本
├── OVERVIEW.md # 概述文档(概述 / 项目结构 / 开发规则 / 禁止行为)
├── INDEX.md # 索引文档(模块 → 细分目录的查找索引)
└── <模块目录>/ # 按项目模块划分的细分文档
安装
本插件是一个 DSH bundle 包(package.json 声明了 dsh.bundle.patch)。在 DSH 中通过 Bundle 安装:
plugin_manager install_bundle <本仓库绝对路径或包名>
或在 DSH 的插件管理界面安装。
开发与测试
npm test
测试使用 Node.js 内置测试运行器,以及一个基于本地磁盘的最小 fs 假实现,覆盖初始化、未初始化、结构问题、DSHD 内容漂移、缺失固定文件、问题数量上限、合法文档树与仓库 dsh_docs 自检等场景。
文件说明
| 文件 | 说明 |
|---|---|
package.json | 包清单,声明 dsh.bundle.patch、exports、版本与图标 |
cordis.patch.yml | Loader 补丁,插入插件行 |
index.js | 插件实现:注入系统提示词规范 + 注册 dsh_docs_init、dsh_docs_update 工具 |
test/tools.test.mjs | 两个工具的自动化测试 |
locale/en.json / locale/zh.json | 插件标题与描述(英文 / 中文) |
icon.svg | 插件图标 |
版本
当前版本:1.1.0
Comments
Loading…
Similar plugins
by wryyyds7
Community plugins for DeepSeek Harness (dsh)
★ 0
MIT
TypeScript
Aug 18, 2026
dsh plugin --profile web add @wryyyds7/dsh-plugins-rootby bobby-sheng
Search, inspect, update, and install DeepSeek Harness plugins from DSH Get.
★ 0
MIT
JavaScript
Aug 19, 2026
dsh plugin --profile web add dshget-pluginby haimuhaimu
My first DeepSeek Harness plugin (dsh-plugin)
★ 0
JavaScript
Aug 19, 2026
dsh plugin --profile web add dsh-hello-pluginby XGrin
A tiny DeepSeek Harness (DSH) plugin
★ 3
MIT
JavaScript
Aug 22, 2026
dsh plugin --profile web add dsh-search-routerby Ceelog
deepseek harness plugins
★ 9
↓ 229/wk
TypeScript
Aug 23, 2026
dsh plugin --profile web add @opendsh/dsh-plugin-scheduled-tasksby wqty123
Shared real browser plugin for DeepSeek Harness
★ 195
↓ 6.7k/wk
MIT
TypeScript
Nov 7, 2026
dsh plugin --profile web add dsh-builtin-browser