dsh-doc-kit
文档体系体检:注册一个只读工具 doc_lint,并随包分发 doc-governance 技能。
它解决什么
文档体系自己会不会烂掉,通常没人查:索引指向的文件改名了、注入层被塞胖了、
文档里混进决策史、新文档忘了进 git。doc_lint 把这四项变成一次调用就能看清的报告。
它不做什么(重要)
- 不注入任何 prompt:
AGENTS.md 的分层 / 优先级 / 预算由平台原生机制(@deepseek-ai/dsh-agent-instructions)负责。
- 不自动改写任何文件:只读;往注入层加内容仍需用户同意。
- 无 client 半区、无 LLM 调用、无网络、无定时器。
安装
# 从仓库安装
dsh plugin --profile web add github:rezon-aki/dsh-doc-kit
# 本地开发时直接指目录
dsh plugin --profile web add /path/to/dsh-doc-kit
# 重启 dsh web 后生效(host 行由 cordis.patch.yml 自动插入,不要手动再 insert)
装完会:① 注册 doc_lint 工具 ② 把 skills/doc-governance/SKILL.md 同步进技能库(内容不同即覆写)。
工具:doc_lint
四项只读检查,输出 PASS / WARN / FAIL:
| 检查 | 级别 | 含义 |
|---|
quota | FAIL | 注入层超出自律配额(默认 L0 ≤ 2 KB、L1 ≤ 4 KB)——说明有人在往注入层塞东西 |
banned | FAIL | 注入层出现「曾用 / 已废弃 / 已被推翻 / 别再试」这类决策史措辞 |
index | WARN | 索引里点名的文档不存在(描述他人惯例的单元格会被自动跳过) |
git | WARN | 治理文件未进 git —— 没有 diff 历史,漂移无从发现 |
它一起分发的技能:doc-governance
规则的单一真源在 skills/doc-governance/SKILL.md:分层归属、写入前检查、去重规程、收尾体检。
技能随包同步进技能库,改技能库副本不会生效——改仓库那份,重装或重载后自动覆写。
卸载
dsh plugin --profile web remove dsh-doc-kit
卸载后自检("卸载即净"):
- 技能库里的
doc-governance 不会被自动删除(那是技能库的文件,插件只负责写入)——要清就 rm -rf ~/.agents/skills/doc-governance。
doc_lint 工具随 host 行消失(重启后确认)。
- 用户的
AGENTS.md 那几行本就不是本插件装的,不受影响。
配置(可选)
l0(默认 $DSH_HOME/AGENTS.md)、workspaceRoot(默认取当前会话 cwd)、l0Quota(2048)、l1Quota(4096)、skillDir(默认 ~/.agents/skills)。
开发
npm test # 6 例,node --test,零依赖
lib/lint.js 是纯函数(检查逻辑),lib/index.js 只做工具注册与技能同步。
License
MIT