方法

我们怎么核验

每一页都有一行字,写明最后核验时间与是否复现。这一页解释这两个词的确切含义。

「核验时间」是什么

checked 是最后一次把这一页讲的东西真跑一遍、并拿输出与正文逐句对照的那天。它不是发表日期,也不是自动生成的。久未重跑的页,日期就停在旧的那天——这正是它存在的意义。

「是否复现」三档含义

取值含义
yes端到端跑过,输出按我们看到的样子贴出,只做长度裁剪。
partial跑了一部分。页面会写明哪一段没跑、为什么。
no没跑过。该节依据文档写成,并明确标注。

数字从哪里来

  • 钱:读自我们自己的服务商账单页与终端输出,不是抄价格表。
  • 版本:每页都钉住版本号。某版写的页不会悄悄改成新版。
  • 耗时:除页面另有说明,均来自同一台机器。

我们不做的事

  • 把没测过的数字写得像测过。
  • 只挪日期,不改旁边那句话。
  • 把厂商文档改写成第一人称,然后称之为「实测」。

命令怎么呈现

命令旁边一定跟着一条「你该跑的校验」,而不是只给命令。复制这一段、跑那条校验、对比结果。这就是本站构建时用的那一对:

$ npm run build; echo $?
0

更正

把页面地址、那个数字、以及你的结果发到 hello@agenthardway.com。实质性修改会记在变更日志里。