DeepSeek Harness Plugin

Lucky020/dsh-delivery-kit

Stars ★ 0 Downloads (30d) 2,494 Category Docs & Rendering Added 2026-11-02 npm dsh-delivery-kit

Turns a repository and a running system into acceptance material - database design, design specs, a user manual with screenshots, and test / go-live / acceptance reports. Sections follow GB/T 8567-88; anything it cannot verify is left blank instead of invented. Requires Python 3 with python-docx for .docx output, and Google Chrome for automatic screenshots.

Install

# from npm (prebuilt)

dsh plugin --profile web add dsh-delivery-kit

# from GitHub (first run asks for allowBuilds approval — follow the hint, retry)

dsh plugin --profile web add github:Lucky020/dsh-delivery-kit

Any plugin you install runs third-party code with your own permissions — it can read your files, use your credentials, and reach the network, and tool approvals don’t sandbox it. GitHub-sourced plugins also run build scripts at install time — pnpm blocks those until you allow them, so an install can stop with ERR_PNPM_GIT_DEP_PREPARE_NOT_ALLOWED or ERR_PNPM_IGNORED_BUILDS; dsh prints the exact key to add under allowBuilds in your profile’s pnpm-workspace.yaml, and the install works on the next run. Allowing a build is a trust decision: only install sources you trust, and pin a commit (github:owner/repo#sha).

README

This plugin publishes its README in Chinese only.

把代码仓库 + 运行中的系统变成系统验收材料。DeepSeek Harness 插件,本地运行,不上传代码。

8 份文档:数据库设计 / 概要设计 / 详细设计 / 使用说明书 / 测试报告 / 上线报告 / 验收报告 / 技术协议

它替你干的三件苦力活

你平时怎么做 装了之后
翻菜单、截图、记路由,整理功能清单 从系统/代码自动取,35 条页面 + 路由一次到位
使用说明书 30+ 张截图,一张张截、一张张排版 打开系统自动逐页截图,按章节插图
记不住国标要求哪几章(GB/T 8567-88) 骨架按国标走,缺章自己补不上

它不干的:正文词句还是模板话,业务内容得你自己写进去——这一点不吹。

能生成哪些文档

文档 自动化 需要你提供
数据库设计文档 95% —
概要设计说明书 70% 架构取舍(可选)
详细设计说明书 60% 关键流程(可选)
技术协议 10% 合同范围 / 性能指标 / 验收标准
测试报告 30% 测试环境、真实执行结果
上线报告 30% 上线时间、参与人
验收报告 40% 合同号、验收日期、结论、签认
使用说明书 50% 界面截图(系统在跑可自动截)

用法

delivery_catalog   先问:能生成哪些、每份要什么材料、项目规模多大
        ↓ 用户挑
delivery_doc       逐份生成;材料缺了就返回 missing,不替你编

核心约定:代码里没有的事实,工具不写。数量(功能数/字段数)、结论(测试通过/验收符合)一律留「待填写 / 待验证」。

数据库结构从哪来

数据库设计文档的质量取决于能不能拿到真实表结构。三条路,按推荐排序:

方式 需要你给 能拿到
① 建表 SQL(推荐) 一份 .sql 文件 表名、字段、真实类型、可空、默认值、注释
② 字段清单 .csv / .tsv / Excel 另存 同上(手动整理,最省事)
③ 结构 JSON .json 同上
④ 只读连接 连接串(多数场景拿不到) 同上,自动
⑤ 扫代码模型 无 仅模型字段名,类型靠推断,没有注释

不需要数据库账号:一条 mysqldump --no-data 或 pg_dump --schema-only,或者从 Navicat/DBeaver 右键「DDL」,就能拿到建表 SQL。

// schema_path 文件格式
{ "tables": [ { "name": "banqian_xieyi", "comment": "搬迁补偿协议",
  "fields": [ { "name": "xieyi_no", "type": "varchar(64)", "nullable": false, "comment": "协议编号" } ] } ] }

支持 PostgreSQL 与 MySQL,只读 information_schema,不做任何写操作。

使用说明书的截图

  • 系统在运行:给 base_url + 页面清单,自动 headless 截图并插图
  • 系统没运行:返回提示,由你后期手动补图

安装

dsh plugin --profile web add github:Lucky020/dsh-delivery-kit

装完重启 dsh web。

依赖

用途 依赖
文档渲染 python3 + python-docx
自动截图 Google Chrome(或 DSH_COPYRIGHT_CHROME 指定路径)
python3 -m pip install python-docx

篇幅原则

篇幅由内容决定,不灌水:材料齐的按 25 页标准写;材料缺的该省就省,文档自然变短,不拿通用章节凑页数。

与 dsh-copyright-kit 的关系

两者独立:软著工坊出软著登记材料(源程序 + 说明书),交付工坊出验收材料(设计/测试/上线/验收/协议)。渲染引擎各自内置,互不依赖。

MIT

Content from the project README on GitHub ↗

Links

More in this category

View the whole category →

Community comments

Comments are public GitHub Discussions. Loading them connects to GitHub and Giscus; a GitHub account is required to post.