占位符不统一,代价不是「难看」,是每次复用都要人工改一遍,改的时候还会漏。定一套写法,之后就只改变量值。
占位符:方括号 + 类型前缀
| 写法 | 含义 | 例子 |
|---|---|---|
| 【路径:…】 | 文件或目录 | 【路径:pdfs/】 |
| 【字段:…】 | 表里的列或字段名 | 【字段:金额】 |
| 【范围:…】 | 数量或区间 | 【范围:前5份】 |
| 【输出:…】 | 产物文件名与格式 | 【输出:index.md】 |
| 【约束:…】 | 硬限制 | 【约束:不许改原文件】 |
为什么用中文方括号而不是 {{双花括号}}:因为配方正文里常常要贴代码,双花括号会和模板语法混淆;【】在中英文里都不会被当成语法,一眼能看出是待填项。
「读取失败」的三段式标注
坏数据的处理方式必须统一,否则每次都要重新决定:
【读取失败】文件名:xxx.pdf | 原因:无文本层 | 已尝试:字符抽取
三段缺一不可:哪个文件、为什么失败、做了什么尝试。只写「读取失败」等于没写——别人不知道是不是该换工具再试一次。
配套的两条规则
- 不许猜:凡是正文里的内容,必须来自原文;来自文件名的要显式标注「据文件名推测」。
- 总数等式:产物末尾必须有
总数 = 成功 + 失败,用来抓静默跳过。
这套写法不用做得太漂亮。它的价值在于「每次都不用重新想」,不在于好看。规则一旦定下来,就写进你的配方模板文件,别只记在脑子里。