前言¶
用 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 倉庫。