前言¶
用 DSH 做安全自查时，扫描结果往往只在终端里滚一遍。领导要自查表、客户要整改说明、测评或归档要检查记录时，常见做法是从日志里手工复制到 Excel，慢、容易漏，格式也不统一。更麻烦的是手写文档时容易把「提示项」写成「已合规」这类越界结论。
dsh-compliance-doc（npm 包名 @deepwhale-cn/dsh-compliance-doc）不负责再跑一遍规则，而是把已有的本地静态检查 JSON 报告整理成三份带边界声明、可直接交付的文件。维护者为 feely0208，在插件目录中归类为 admin-security。它与 dsh-sbom、dsh-data-rights 等「查」类插件、dsh-fix-verify 的「复核」配合使用，处在编排与交付链路的文档成文环节。
这是什么、不是什么¶
一句话：dsh-compliance-doc 把查出来的结果写成能交出去、且有边界说明的文档；它不产生新判据，规则来自你已安装的深鲸守护类插件。
| 输出文件 | 内容 | 主要读者 |
|---|---|---|
自查表.csv |
序号、检查项、严重度、依据、位置、状态、建议；UTF-8 BOM，Excel 可直接打开 | 执行整改的人 |
整改说明.md |
背景、检查范围与方法、逐条问题与建议、复核方式 | 领导、客户、项目经理 |
合规证明.md |
检查范围、规则条数、依据清单（去重）、结论措辞 | 对外提交、归档 |
明确不是：合规认证；等保测评、监管检查或第三方审计的替代品；扫描器本身。三份文件都不会写「已合规」「保证通过」「绝对合规」；未命中规则时也会提醒「未命中不等于没有问题」。
三份文件均包含同一条声明：
本文件由本地静态检查生成，不构成合规结论，不替代等保测评/监管检查/第三方审计。
核心功能¶
- 从普通扫描报告生成三份文档：输入
dsh-guard-core标准输出的 JSON（含generatedAt、stats、findings等），输出上述三个文件。 - 兼容改前改后复核报告：输入
dsh-fix-verify的 JSON（顶层含fixed、remaining、regressed数组），可整理成面向交付的整改说明等材料。 - 可选元数据与文档档次：
--org、--date写入单位名与检查日期；--profile 等保三级只影响文档组织方式，不改变规则集，也不构成等保测评结论。 - 严格失败：输入缺失、JSON 损坏或字段不对时退出码为
2，不会生成一份「看起来正常」的文档。
成功生成时退出码为 0。输出目录不存在时会自动创建。
安装与启用¶
在 DSH 环境中按官方说明安装（需 Node.js ≥ 18，DSH 引擎 >=0.1.0-rc.6 <0.3.0）：
dsh plugin --profile web add @deepwhale-cn/dsh-compliance-doc
安装前建议自行查看 GitHub 仓库 源码与 MIT 许可证。插件以当前 dsh 进程权限运行，权限范围与本地读取的报告路径需自行把控。
典型用法¶
下面介绍从报告到交付目录的最小流程。
从普通扫描报告生成三份文档：
dsh-compliance-doc --input report.json --out ./交付文档
带单位名、检查日期与等保三级文档档次（仅排版与结构，非测评结论）：
dsh-compliance-doc --input report.json --out ./交付 \
--org "某某科技有限公司" --date 2026-10-20 --profile 等保三级
配合 dsh-fix-verify 把复核结果成文：
dsh-fix-verify --before old --after new --json > fix-verify.json
dsh-compliance-doc --input fix-verify.json --out ./交付 --org "某某科技有限公司"
命令行成功时，终端会汇总类似信息：三份文件路径、扫描文件数与规则条数、提示项数量及严重度分布（具体数字以你的报告为准）。
适用场景与注意¶
适合谁：已在本地或 CI 中跑过深鲸守护系列扫描、需要把结果交给内部整改、客户沟通或归档留痕的团队；需要与 dsh-guard-suite 一键体检、dsh-fix-verify 改前改后复核串联交付时。
使用上请注意：
- 不要把
合规证明.md当作对外「合规证书」；不要删掉文件中的免责声明。 - 输入报告为空或零提示项时，不要据此断定项目没有问题。
--profile 等保三级不得用于暗示已完成等保测评。
DSH 生态理念是「一切皆插件」；社区目录（如 SkillHub 插件页、dsh-plugin.org）为独立站点，与 DeepSeek、幻方无官方从属关系。
结尾¶
dsh-compliance-doc 解决的是「检查结果能交出去」的最后一环：自查表、整改说明、带边界声明的合规证明一次生成，措辞按提示项而非越界结论。进一步了解可访问插件目录页与源码仓库。
- 目录页：https://www.skillhub.cn/plugins/feely0208/dsh-compliance-doc
- GitHub：https://github.com/feely0208/dsh-compliance-doc
