DSH VERTICAL KIT · 需求文档检查 / 方案文档检查
需求文档检查清单
它决定一件事:这份方案是否让 reviewer 能精确地反对它。
检查规则
| 规则 | 判定 |
|---|---|
empty | 文档为空 → error |
problem-missing | 没有背景/问题/目标段 → error |
criteria-missing | 没有验收标准段 → error |
criteria-vague | 验收标准含愿望词但没有数字/阈值/可观测对象 → error,报行号 |
out-of-scope-missing | 没有「不做/非目标/范围外」段 → error |
criteria-thin | 验收标准少于下限(默认 2)→ warn |
open-questions-empty | 有「待定」标题但下面没条目 → warn |
用法
npx spec-doc-check spec.md --jsonnpx spec-doc-check spec.md --min-criteria 3
真实输入输出
输入
# 导出重做
我觉得现在的导出体验不够好,想重做一下。
## 验收标准
- 体验良好
- 速度合理$ spec-doc-check spec-sample.md
error problem-missing 第0行 没有背景/问题/目标段——读者不知道这个方案在解决什么
error out-of-scope-missing 第0行 没有「不做/范围外」段(认得:## 不做、## 非目标、Out of scope)——没写边界的方案在评审时会被无限扩大
error criteria-vague 第7行 第 7 行验收标准含「良好」但没有数字或可观测对象——「体验良好」既无法通过也无法拒绝
error criteria-vague 第8行 第 8 行验收标准含「合理」但没有数字或可观测对象——「速度合理」既无法通过也无法拒绝
fail: 2 criteria, 4 errors, 0 warnings
出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。
出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /spec-doc-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。
这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
愿望词表:良好/优秀/合理/友好/快速/流畅/尽量/适当/完善/稳定/高效/简洁(含英文同级词)。只要同一条里出现数字、阈值或可观测对象(状态码、字段、命令、百分比)就放行——规则只在「只剩下愿望」时才响。只验文档形状,不验方案是否正确:标准是不是错的标准、问题陈述是不是事后合理化、范围外是不是回避了难点,这些评审才能说。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit