前言¶
在 DeepSeek Harness(DSH)裏做項目,代碼和聯調環境往往已經就緒,但交付側仍要單獨整理數據庫設計、概要/詳細設計、使用說明書、測試與上線/驗收報告、技術協議等成套文檔。常見做法是人工翻菜單記路由、逐頁截圖排版,再對照 GB/T 8567-88 等規範補章節——耗時長,且容易把代碼裏沒有的事實寫進正文。
下面介紹社區插件 dsh-delivery-kit(交付工坊):在本地 DSH 進程中運行,不上傳代碼,把代碼倉庫與運行中的系統作爲輸入,按約定生成上述驗收類材料;材料不足時明確返回缺失項,不替用戶編造結論與數量。
這是什麼¶
dsh-delivery-kit 由維護者 Lucky020 發佈,在 SkillHub 目錄中歸類爲「工作流」類 DSH 插件。npm 包名同爲 dsh-delivery-kit,當前版本 0.3.5,許可證 MIT,要求 Node.js >= 22。
定位一句話:交付工坊——從代碼倉庫與運行中的系統生成驗收材料,輸出包括數據庫設計、概要設計、詳細設計、使用說明書、測試報告、上線報告、驗收報告、技術協議共 8 份文檔(骨架參考國標 GB/T 8567-88 等結構;正文業務表述仍需人工填寫)。
與 dsh-copyright-kit(軟著工坊)相互獨立:前者面向軟著登記材料,後者面向驗收交付文檔;渲染引擎各自內置,互不依賴。
核心功能¶
三類自動化減負(README 對照表)¶
| 平時做法 | 插件側能力 |
|---|---|
| 翻菜單、截圖、記路由,整理功能清單 | 從系統/代碼抽取,README 稱可一次覆蓋約 35 條頁面與路由 |
| 使用說明書大量截圖與排版 | 系統在跑時按頁面清單 headless 截圖並按章節插圖 |
| 記不清國標章節結構 | 文檔骨架按國標組織,缺章需自行補全 |
明確不做的事:模板化詞句與業務實質內容需用戶寫入;代碼與運行態中不存在的事實,工具不寫。功能數、字段數、測試通過/驗收符合等結論一律留「待填寫 / 待驗證」。
八份文檔與自動化程度¶
| 文檔 | 自動化(README 估計) | 需要你提供 |
|---|---|---|
| 數據庫設計文檔 | 約 95% | — |
| 概要設計說明書 | 約 70% | 架構取捨(可選) |
| 詳細設計說明書 | 約 60% | 關鍵流程(可選) |
| 技術協議 | 約 10% | 合同範圍、性能指標、驗收標準 |
| 測試報告 | 約 30% | 測試環境、真實執行結果 |
| 上線報告 | 約 30% | 上線時間、參與人 |
| 驗收報告 | 約 40% | 合同號、驗收日期、結論、籤認 |
| 使用說明書 | 約 50% | 界面截圖(系統運行時可自動截) |
篇幅原則:材料齊全時按約 25 頁標準渲染;材料缺失則相應縮短,不用通用章節湊頁數。
數據庫結構來源¶
數據庫設計文檔質量取決於能否拿到真實表結構。README 推薦順序如下:
- 建表 SQL(推薦):一份
.sql,可得到表名、字段、類型、可空、默認值、註釋。 - 字段清單:
.csv/.tsv/ Excel 另存爲同等信息(需手動整理)。 - 結構 JSON:
.json,格式示例見下。 - 只讀連接:連接串(多數場景難以提供);支持 PostgreSQL 與 MySQL,只讀
information_schema,無寫操作。 - 掃代碼模型:無額外輸入時僅模型字段名,類型靠推斷,無註釋。
無需數據庫賬號時,可用 mysqldump --no-data 或 pg_dump --schema-only,或從 Navicat/DBeaver 導出 DDL。
// schema_path 文件格式(README 示例)
{ "tables": [ { "name": "banqian_xieyi", "comment": "搬遷補償協議",
"fields": [ { "name": "xieyi_no", "type": "varchar(64)", "nullable": false, "comment": "協議編號" } ] } ] }
使用說明書截圖¶
- 系統在運行:提供
base_url與頁面清單,自動 headless 截圖並插入文檔。 - 系統未運行:返回提示,由後續手動補圖。
安裝與啓用¶
DSH 生態採用「一切皆插件」;SkillHub(https://www.skillhub.cn/plugins/Lucky020/dsh-delivery-kit)爲社區目錄,與 DeepSeek / 幻方無官方從屬關係。安裝前應自行查看 GitHub 源碼與 MIT 許可證;插件以當前 dsh 進程權限在本地執行。
官方安裝命令:
dsh plugin --profile web add github:Lucky020/dsh-delivery-kit
裝完後重啓 dsh web。
依賴(README):
| 用途 | 依賴 |
|---|---|
| 文檔渲染 | python3 + python-docx |
| 自動截圖 | Google Chrome(或通過環境變量 DSH_COPYRIGHT_CHROME 指定路徑) |
python3 -m pip install python-docx
典型用法¶
README 給出的工作流是兩步:
delivery_catalog 先問:能生成哪些、每份要什麼材料、項目規模多大
↓ 用戶挑選
delivery_doc 逐份生成;材料缺了就返回 missing,不替你編
先做 delivery_catalog 瞭解可生成文檔清單、每份所需材料與規模;再調用 delivery_doc 按選擇逐份生成。任一材料缺失時返回 missing,需補齊後重試,而不是自動虛構內容。
適用場景與注意¶
適合:已有可訪問代碼倉庫、部分文檔可來自 DDL/字段清單或只讀庫;聯調或演示環境可訪問時,需要快速搭齊驗收文檔骨架並導出 docx 的團隊。
注意:
- 技術協議、測試/上線/驗收報告中的合同號、日期、籤認、真實測試結果等必須由人提供。
- 正文措辭仍是模板框架,業務敘述不能指望全自動。
- GitHub 倉庫當前星標爲 1(以目錄與 README 徽章爲準),使用前請自行評估維護活躍度與 Issue 反饋。
結尾¶
dsh-delivery-kit 把「倉庫 + 運行中系統」收斂爲可執行的交付文檔流水線:catalog 問清材料,doc 逐份出稿,缺什麼就標什麼。若你在 DSH web profile 下做項目驗收材料,可按官方命令安裝並配好 Python docx 與 Chrome 後,從 delivery_catalog 起步。
- 目錄頁:https://www.skillhub.cn/plugins/Lucky020/dsh-delivery-kit
- GitHub:https://github.com/Lucky020/dsh-delivery-kit