前言¶
在 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