来源:
notes/documents/关于「把验证边界写进文档」的一次复测.md关于「把验证边界写进文档」的一次复测
结论
文档要写得「可执行」,关键不是把步骤写全,而是把边界写进文档:哪些事该做、哪些事做完就停、哪些事绝不能做。这次复测的对象是「个人助理」正式笔记流程,验证的正是这条边界是否清晰。
验证边界指什么
- 纳入范围:写裸正文、
create --apply注册与三层投影、status复核、commit & push。 - 停止边界:三层的
status都返回synced即结束,不再补一轮自我确认。 - 排除范围:不抓线上网页版、不看 Vercel 部署、不爬博客。网页版是构建期快照,抓站只能看到旧构建。
为什么边界比步骤更重要
步骤缺失时,执行者会暴露在报错里,容易发现;边界缺失时,执行者会「多做一步」,而且这一步看起来还很负责。多做的那一步往往最贵:抓站、跑同步脚本、重复投影,消耗的是时间,换来的是错误结论。
观察到的有效做法
- 在「完成判据」里直接写「到此为止」,并用一句话说明为什么不需要追加验证。
- 把「禁止」写进流程本身,而不是留给读者自行推理,例如「之后不需要再补跑别的同步脚本」。
- 对易错的固定动作给出可复制的命令,降低执行者的自由度,例如用
git add -u提交被忽略但已跟踪的 SQLite。
风险与待验证点
- 本次只覆盖正式笔记一条路径,未覆盖日常事件与书籍附件的边界。
- 「不抓站」的结论依赖「网页版是构建期快照」这一前提,若构建方式改变则需重新评估。待验证。
下一步动作
- 在下一次新会话复测中,只读文档执行,记录任何需要回看源码才能决定的地方,作为文档缺口。
- 若出现新的「多余验证」动作,把它补写成完成判据里的显式「不要做」项。