DSH VERTICAL KIT · 20 CHECKS
全部 20 个检查一览
每个检查只做一件事:从一份文件本身判定一组可判定的缺陷,说出第几行、缺什么。它们不调用模型,不联网判定,CLI 与 host 路由调同一函数。用这张表选你要的那一个——选错了通常是名词对不上,而不是功能不够。
| 包 | 检查清单 | 搜索名词 | 它决定什么 | 规则数 |
|---|---|---|---|---|
| dsh-agreement-check | 合同结构检查清单 | 合同检查 / 合同审查清单 | 这份合同在结构上是否可审 | 9 |
| dsh-invoice-check | 发票字段检查清单 | 发票检查 / 发票校验 | 发票上能从文本判定的算术与格式是否成立 | 7 |
| dsh-listing-check | 电商商品信息检查清单 | 电商商品信息检查 / listing 检查 | 商品导出表是否达到可上架的结构卫生 | 7 |
| dsh-meeting-notes-check | 会议纪要检查清单 | 会议纪要检查 / 会议记录检查 | 这份纪要是否交代了谁在何时 carries 什么 | 7 |
| dsh-resume-check | 简历检查清单 | 简历检查 / 求职简历检查 | 这份简历在书记层面是否可读、可达、时间自洽 | 7 |
| dsh-release-notes-check | 发布说明检查清单 | 发布说明检查 / 更新日志检查 | 这份发布说明是否交代了哪个版本、何时、什么会坏、怎么迁移 | 5 |
| dsh-weekly-report-check | 周报检查清单 | 周报检查 / 工作汇报检查 | 这份周报是否交代了做完了什么、接下来做什么、什么会卡住、进展是否可检验 | 4 |
| dsh-bug-report-check | 缺陷报告检查清单 | 缺陷报告检查 / bug 报告检查 | 这份 bug 报告是否交代了在哪发生、怎么触发、差在哪 | 6 |
| dsh-api-doc-check | 接口文档检查清单 | 接口文档检查 / API 文档检查 | 这份接口文档是否交代了怎么调、怎么证明身份、失败长什么样 | 4 |
| dsh-test-report-check | 测试报告检查清单 | 测试报告检查 / 用例统计检查 | 这份测试报告的算术是否自洽、环境是否可复跑、失败是否有去处 | 6 |
| dsh-commit-msg-check | 提交信息检查清单 | 提交信息检查 / commit message 检查 | 这条提交信息是否可被工具解析、在 log 里可读 | 7 |
| dsh-dockerfile-check | Dockerfile 检查清单 | Dockerfile 检查 / 镜像构建检查 | 这个 Dockerfile 是否把可复现与最小权限写进了文件本身 | 8 |
| dsh-env-example-check | 环境变量示例检查清单 | 环境变量示例检查 / .env 检查 | 这份示例文件是否只含占位符、键不重复、有用途说明 | 6 |
| dsh-license-check | 许可证检查清单 | 许可证检查 / LICENSE 检查 | 这个 LICENSE 文件是否说了它看起来在说的那件事 | 9 |
| dsh-incident-report-check | 事故复盘检查清单 | 事故复盘检查 / 故障报告检查 | 这份复盘是否给出了时间线、影响、根因与有人负责的后续 | 6 |
| dsh-ops-runbook-check | 运维手册检查清单 | 运维手册检查 / runbook 检查 | 这份手册是否给了读者前置、步骤、退路、确认方式,以及危险命令旁的警告 | 6 |
| dsh-pr-description-check | PR 描述检查清单 | PR 描述检查 / 拉取请求描述检查 | 这条 PR 描述是否给了 reviewer 能动手的 what / why / how-verified | 7 |
| dsh-spec-doc-check | 需求文档检查清单 | 需求文档检查 / 方案文档检查 | 这份方案是否让 reviewer 能精确地反对它 | 7 |
| dsh-adr-check | 架构决策记录检查清单 | 架构决策记录检查 / ADR 检查 | 这份决策记录是否让后来人能重新评估它 | 9 |
| dsh-onboarding-check | 上手指南检查清单 | 上手指南检查 / 新人文档检查 | 这份上手文档是否让一个新人今天就能开始 | 6 |
怎么选
先看你手上是什么文件:
- 合同 → agreement-check;发票 → invoice-check;商品导出表 → listing-check
- 会议纪要 → meeting-notes-check;简历 → resume-check;周报 → weekly-report-check
- 发布说明 → release-notes-check;缺陷报告 → bug-report-check;接口文档 → api-doc-check
- 测试报告 → test-report-check;提交信息 → commit-msg-check;PR 描述 → pr-description-check
- Dockerfile → dockerfile-check;.env.example → env-example-check;LICENSE → license-check
- 事故复盘 → incident-report-check;运维手册 → ops-runbook-check
通用缺陷(交付文件的哈希、报告引用、文档结构、Markdown 表格、数字写法)在 dsh-verify-kit,不在这个对照表里。
共同约束
- 一条发现一行。每条都带行号;没有行号的建议没法动手改。
- 只判可判定的。需要判断力的事不写成规则;需要判断力的事也不能假装判定了。
- warn 与 error 分开。error 是「这份文件没说清一件事」,warn 是「说了但值得看一眼」,多数 warn 在信息里写明什么情况下可以忽略。
- 出口码 0/1/2:干净、有发现、用法或读文件错误。可直接接 CI。
scripts/build-site.mjs 从 scripts/checks-data.mjs 生成,与各检查页同源