说人话检查挂进 CI 和 sync-stats.ps1,CLAUDE.md 写明规则

This commit is contained in:
albert4719
2026-09-28 16:27:50 +08:00
parent cf095a6925
commit 4058ce4e94
3 changed files with 16 additions and 1 deletions
+11
View File
@@ -55,6 +55,17 @@ jobs:
node-version: 22
- run: node tools/check-refs.mjs --check
# 说人话检查:长度、研究行话、抽象说法。理由同上,单独一个 job,不挡发布。
plain:
name: 说人话检查
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- run: node tools/check-plain.mjs
build:
runs-on: ubuntu-latest
steps:
+1 -1
View File
@@ -47,7 +47,7 @@
- **每句有明确主语**(你、医生、警察、公司、法院),少用被动句和「其」「该」「之」「予以」「系」。书面语换口语:及→和,若→如果,应当→要(来源栏不动),自……之日起→从……那天算起。
- **括号套括号一律拆开**,括号里超过十个字的补充拿出来单独成句;术语解释要短,写「95% CI 0.50–0.63(可信范围)」而不是整句解释,同一条里同一个术语只解释一次。
- **每句话要能单独读懂**:交叉引用前面那句必须把意思说完,引用只是「想细看去哪」。
- **说人话 2 到 4 句、120 字以内**,只留方向和量级,其余留在收益栏。
- **说人话 2 到 4 句、120 字以内**,只留方向和量级,其余留在收益栏。不写样本量、分组和研究设计(「257 例」「那组」「随机」),不写「另一头」「产出」这类要读者自己翻译的比喻。`node tools/check-plain.mjs` 机器查这三样,CI 里是「说人话检查」job,sync-stats.ps1 末尾也会跑(2026-09-28 issue #42 读者嫌 AI 味重,当天查出 173 条不合格,全部改掉)。它查不出的是电报体:句句十来个字、一句一个句号,读着像念提纲。有因果、转折的两句可以用「因为」「所以」「但」连成一句,结尾别加总结升华句。
- **备注里有争议的仍必须以「争议」开头**:sync-stats.ps1 按「备注行以争议开头」计数,把争议挪到备注中段,README 的争议条数就会掉(2026-09-21 通俗化时有 9 条这么掉过,已改回)。
- 收益与口径是后加的两个字段,用来回答「值不值得做」(证据等级只回答「数字可不可信」,两者正交)。口径按这条主要换回什么定:死亡率(含健康终点、存活率)、金钱(含保障待遇)、时间(含精力)、自由(含法律责任、个人信息)。**不同口径之间不做比较**。
- 收益量级尽量按阈值从条目自己的「收益」栏机械套,不凭感觉:死亡率口径看相对降幅(≥20% 大 / 10–20% 中 / <10% 或只有替代终点 小);金钱看金额(万元级 大 / 数百到数千 中 / 几十元 小);自由看后果(避免刑责 大 / 避免拘留或行政处罚 中 / 避免民事纠纷 小);时间看节省量(每天小时级 大 / 每周小时级 中 / 一次性 小)。数字不足以判定时才用判断,并在核实记录里写明凭什么定的。
+4
View File
@@ -120,6 +120,10 @@ if ($node) {
& $node.Source (Join-Path $PSScriptRoot 'check-refs.mjs')
if ($LASTEXITCODE -ne 0) { throw 'check-refs.mjs 失败' }
'提交前扫一眼 docs/引用对照.md 的 diff:条号没动而「指向的条目」变了,就是被顺延撞歪的引用。'
# 说人话检查只提示不中断:数字已经同步完了,卡在这里反而让人以为统计没更新。CI 里它会红
''
& $node.Source (Join-Path $PSScriptRoot 'check-plain.mjs')
if ($LASTEXITCODE -ne 0) { '上面列出的说人话不合格,提交前改掉(规则见 tools/check-plain.mjs 文件头)。' }
} else {
''
'没找到 node,跳过引用对照表;改完条目请手动跑 node tools/check-refs.mjs'