一周后还能用的笔记:给一句“修好了”做编辑
一页原稿、一页改稿,以及每一笔为什么要改。把上下文、证据与边界留进文字,同时保住私人笔记应有的轻便。
这次不先列“好笔记的五个原则”。先拿一张很像我们会写下的便条,给它做一次编辑。
文件改坏了,用
git restore回到上次提交。问题解决了。
当时的你也许知道文件处在哪个状态。一周后的你没有这个现场。若直接照着做,这张便条可能把已经暂存的另一版内容恢复回来;还可能丢掉没留下副本的修改。
短不是问题。问题是,它把一个有条件的动作写成了随时能用的结论。
红笔第一处:“上次提交”是哪一版
先把现场补成三个字母:HEAD 保存 A,暂存区保存 B,工作区又改成 C。
不带其他选项的 git restore 文件 从暂存区恢复工作区,于是工作区变成 B。之前看起来像回到提交,只是因为那时暂存区恰好与提交相同。
回到上次提交 → 从暂存区恢复工作区。
这一笔改动没有增加很多字,却改变了适用条件。查一次反例,比笼统写一句“Git 很复杂,要小心”更能指出原句哪里会失效。完整操作练习仍可在 Git 教程中完成。
红笔第二处:“修好了”拿什么验收
“修好了”是一个结束信号,不是一份可复用记录。它没有说保留了什么、丢弃了什么,也没有说怎样确认。
现在把同一份便条排成前后两页。左页保留问题,右页只补下一次使用会缺少的东西。
读者能沿着右页重建问题,也知道需要核对哪三处。如果希望恢复 A,就应该另查来源选项;这张便条没有替他做那个决定。
红笔第三处:能推广到哪里
换一张便条:
新方法快了 20%。
这次数字可能没算错,但读者仍不知道它来自什么输入、计时是否包含加载、有没有重复测试。先把你真实留下的测量写出来,不必为填模板编造缺少的步骤。
用一份构造记录练习,不冒充已经做过的实验
已知记录只有:同一输入下,旧程序一次耗时 10 秒,新程序一次耗时 8 秒。
可以写:“这一次记录里运行时间从 10 秒降到 8 秒;还没有排除缓存与波动影响。”
不能补成:“重复一百次后稳定提升 20%。”这不是润色,是新增了一项没有发生的实验。
范围说明不一定是一长串免责声明。优先写那个一旦变化,就最需要重新验证的条件。算法定义与某个软件选项默认值,通常有不同的过期方式。
少抄过程,多留转折点
“试了七种参数,终于好了”可以留在日常里。如果要留下诊断依据,优先记那条让你改变判断的观察。
在坐标案卷中,原点通过、非零方向失败,是一个转折点。它把注意力从平移带到旋转。整个往返都通过,则提醒我们:内部自洽没有覆盖独立路标。
这样的一条差异,比十页命令历史更可能帮助未来的你。当然,如果某个过程本身用于审计或复现,就仍应保存;正文只是选择其中最影响解释的部分。
让页面元素跟随这次编辑
这篇用红笔标出需要改的词,用两张便利贴并排比较原稿与改稿,用折页暂时收起答案。元素各做一件事,读者也就知道该先看什么。
页边批注适合补一个定义或来源;重要前提放在正文。表格适合比较相同维度;连续推理仍用段落讲。交互只有在读者真的需要改变条件、看到后果时,才值得加入。
形式可以帮助你安排注意力,但不能替你补证据。 一页到处标“重点”,通常只是把所有层级抹平。
最后一次删改:这张纸到底给谁用
若只给十分钟后的自己提醒,“保存副本后再试”可能已够用。若用于可复用操作,补上前提、动作与核对结果。若向别人主张方法更可靠,再补比较条件、反例与证据。
标准跟随误用成本。把每条临时提醒都写成实验报告,会让记录变成负担;把一次危险操作压成一行口诀,又让上下文消失得太多。
这两页都不是固定表单。没有需要的字段就删,不必为模板制造内容。
把下一张便条交给一周后的你
下载 可编辑的证据笔记或精简的前后页练习。打开最近一篇写着“有效”“解决了”“更快”的记录,只补三句:
- 当时的输入与现场是什么?
- 怎样判断结果符合预期?
- 哪个条件变化以后,这句话要重新检查?
写不出来时,可以先标为“观察”或“未确认”。这仍然是一张诚实的记录。不要为了使页面完整,把记忆提示改写成一份看似已经验证的证据。