前言¶
用 DSH 或智能体流水线产出方案、说明、交付包时,文档往往在人工通读前就已经打包。占位符没删、同一段复制了两遍、某节编号从 3 直接跳到 5,这类问题肉眼容易漏,发出去再改成本更高。人工全文搜关键词能补一部分,但重复段落、超长块、中英文标点混用等规则化检查仍费时。
下面介绍社区插件 深鲸文档质检(npm 包名 @deepwhale-cn/dsh-doc-qc,仓库 feely0208/dsh-doc-qc),在本地对目录下的文本类交付物做一批固定规则扫描,适合挂在交付前或 CI 里跑一遍。
这是什么¶
深鲸文档质检 是 DeepSeek Harness(DSH)下的工作流类插件:对指定根目录下的 .md、.txt(以及条件允许时的 .docx)做静态检查,把常见问题列出来,不依赖云端上传。源码托管于 GitHub(维护者与仓库归属见 目录页 与仓库说明);包内作者信息为温州深鲸智能科技有限公司,许可证 MIT(见仓库 package.json)。
它解决的是「交付前把看起来正常、发出去才发现的文档毛病挑出来」——与只靠人工通读或零散搜索相比,规则集固定、可重复执行,并可通过退出码接入自动化。
核心功能¶
依据仓库 README 与 package.json 描述,当前检查项包括:
- 占位符残留
- 重复段落
- 超长段落(阈值 >800 字)
- 连续空行
- 半角标点混用(相对中文排版语境)
- 编号断档
格式支持:
.md/.txt:插件直接读取。.docx:需要本机具备python3与python-docx;缺库时会跳过相关文件并标注,不会静默当作通过。
运行方式: 纯本地处理,README 明确说明不上传文档内容。
除命令行外,启用 Web 配置后可在 DSH 面板侧栏使用「深鲸文档质检」入口(与 README「面板」说明一致)。
安装与启用¶
安装命令以 README 为准(使用 npm 作用域包名,而非 github:owner/repo 形式):
dsh plugin --profile web add @deepwhale-cn/dsh-doc-qc
package.json 中声明的引擎要求为:dsh 版本 >=0.1.0-rc.6 <0.3.0,Node >=18。安装前请对照本机 DSH 与 Node 版本,并自行查阅仓库源码与 MIT 许可证;插件以当前 DSH 进程权限访问你指定的 --root 目录,应对路径与敏感内容做到心中有数。
典型用法¶
对交付材料目录做一次扫描:
dsh-doc-qc --root ./交付材料
需要机器可读结果、并在有命中时用非零退出码(便于 CI)时:
dsh-doc-qc --root ./交付材料 --json
README 说明:--json 模式下若有命中则退出码为 1。可将上述命令放在打包脚本末尾,或在合并前作为门禁步骤。
面板侧:安装并加载 Web 配置后,从侧栏「深鲸文档质检」进入,适合在编辑交付包时随手跑检查(具体交互以当前 DSH Web 面板为准)。
适用场景与注意¶
适合:
- 项目交付、投标材料、对内方案等批量
.md/.txt(及可解析的.docx)在发出前的最后一道规则扫描。 - 希望在 CI 或发布脚本里用
--json+ 退出码做硬门禁的团队。
注意:
.docx依赖 Python 环境;未满足时相关文件会被跳过并标注,不能假设「全目录已检」。- 检查项是规则化启发式,不能替代法务、保密或业务事实审阅。
- 社区目录 skillhub.cn 上的 feely0208/dsh-doc-qc 是独立插件索引站点,与 DeepSeek / 幻方无官方从属关系;DSH 生态遵循「一切皆插件」,选用插件前建议自行审查源码与权限行为。
结尾¶
深鲸文档质检 把占位符、重复段、超长段、空行、标点混用、编号断档等交付常见问题收成一条可重复的本地命令或面板操作,适合挂在交付前与 CI。进一步了解可访问 SkillHub 目录页 与 GitHub 仓库。