公式源码管理时如何保留上下文
更新于
公式源码单独存成一段字符,过一段时间可能仍然能排成原来的样子,却无法判断它对应哪份报告、采用哪些条件。维护时需要保存的不只是表达式,还包括来源、用途、使用位置和修改理由。这些信息使后续改动有据可查,也能减少替换错对象的情况。
先让每条原式拥有明确的身份
给记录取一个能反映内容的名称,再为它保留稳定的标识。名称便于寻找,标识便于对应材料中的使用位置,两者不必都依赖公式当前的编号,因为文档调整后编号可能变化。记录来源时写明材料名称及章节或页次,来自个人整理的内容也应标注整理依据。
随后补充符号含义和使用前提。外观相近的两条表达式,可能因条件不同而不能互换;仅按字符相似程度合并记录会抹掉这种差异。如果保存的是待完善的草稿,把尚未核实的部分写在说明中,不要让它与已经确认的原式看起来完全一样。身份和状态清楚以后,才有条件讨论它应被用在哪里。
建立从原式到材料位置的对应表
在个人记录中列出使用它的文档名、小节、附近文字和成图名称。页码可以作为辅助,但内容增删后可能改变,因此还应保留不依赖页码的定位线索。例如写“方法部分第二个定义段”通常比只写“第六页”更便于在新版里查找。
同一原式同时进入报告与课件时,分别记录两个位置,并注明是否进行了适应性调整。课件为了讲解拆成了几步,就应指出这些步骤来自哪条原式;报告保留完整表达式,则记下完整式的落点。这样修改一个下标后,能沿记录找到所有受影响对象,不会只更新源码却遗漏已生成的图片。首次建立对应表时,可以反过来从成品查回原式,验证每一个落点是否真能对应,避免目录看似齐全却缺少关键材料。

修改说明应回答为什么发生变化
改动记录可以简短,但要包含具体对象和理由。例如记录某个变量名因正文统一而调整,或者补入原稿遗漏的条件。只写“格式修复”会让后来的人无法判断是否涉及数学含义。若改动只影响换行,也注明未改变的内容范围,便于选择适当的复核重点。

完成修改后对照原来的表达式、当前呈现和使用位置逐一核验。涉及含义的变化应同时检查正文说明;只涉及版面的变化也要看条件有没有被分离。暂时不用的记录可以归档并标注原因,不宜不加说明地删除后,又在另一份材料里留下无法追溯的成图。

编辑时把说明与表达式一起维护
MathTool 提供 LaTeX 模式和预览模式,可用来检查表达式内容与排版呈现,两种模式共享公式。这里的管理重点并非某种语法,而是每次编辑后能说明内容从何而来、服务于什么材料。可将用途与定位信息整理在个人笔记或文档中,与原式配套保留。
交接一组素材时,也应把这份说明一并交代。接收者需要知道哪条记录供继续修改,哪份材料只是展示结果,以及哪些位置尚待核对。能从任意一个成品回查原式,再从原式找到使用处,后续维护才不会只剩下逐个文件猜测。
延伸阅读
常见问题
- 公式源码为什么要同时记录使用位置?
- 同一表达式可能用于多份材料,修改源码后需要知道哪些文档或图片受影响。记录章节、段落和用途,能帮助逐处复核,也能避免把相似但含义不同的表达式误作同一条。