跳转至

技术长文编辑核查清单

一篇 15000+ 字的技术长文写完不是终点,修改才是。本文提炼一套系统化的核查清单,确保长文的计算准确、逻辑自洽、表述规范。

背景

技术长文(尤其是含案例推演、公式计算的策略/教程类文章)最容易出问题的不是结构或立意,而是**细节**——计算抄错、百分比与绝对值不对应、案例前后矛盾、术语在 50 页后换了个叫法。这些错误读者一眼就能看出,但作者自己因沉浸式写作反而视而不见。

本文从实际修改 一篇 1500 行交易系统设计手记 的经验中提炼,形成可复用的六维核查清单。

核查清单

一、计算与数据校验(⚠️ 中等严重度)

含公式和数值推演的文章必须逐行校验,错一个数字就破坏整篇的可信度。

检查项 方法 典型错误
百分比与绝对值是否一致 用绝对值 ÷ 基数反算百分比,双向验证 2,250 ÷ 31,500 = 7.1%,却写了 9.0%
公式推导链是否完整 从原始公式逐步代入,不用心算跳步 跳过中间变量直接给结论
表格行间合计是否准确 逐列求和验证合计行 合计与明细加起来对不上
多案例间数值是否可交叉验证 不同案例若引用同一公式,验算一致性 100 万案例和 10 万案例的公式结果不匹配

经验:计算验证不能靠"看起来差不多",必须用计算器逐项验算。

二、案例逻辑一致性(⚠️ 中等严重度)

案例是技术文章中最有说服力的部分,也是矛盾最容易藏身的地方。

检查项 方法 典型错误
案例行为是否违背预设约束 列出所有预设条件,逐条对比案例中的行为 "只有 2 档资金"但做了 3 轮买卖,未解释资金循环
资金/仓位的流入流出是否可追溯 从起点画一条完整的资金流线,每步核对余额 平仓回收金额与持仓市值的差额无法解释
盈亏计算链路是否透明 拆解"原始投入 → 回收 → 中间盈亏 → 净结果"全链 只给最终亏损额,读者无法从文中数据反推
案例结论是否与改后的数据一致 数据修改后重新评估"对比结论"是否需要重写 百分比修正后,"传统方式更优"的结论反转了

经验:案例修改后必须重读整段结论段落——数据变了,论点可能也需要变。

三、公式与参数边界(🔴 高严重度)

公式写得再漂亮,边界条件不清晰就是埋雷。

检查项 方法 典型错误
公式中的变量是否有歧义 每个变量在系统中找唯一对应值 "总资金"指 100 万还是共享池 50 万?
参数取值范围是否与系统约束一致 代入极端值验证是否落在约束区间内 计算出的仓位金额超出共享池上限
关键阈值是否有确定规则 不只给值,还写清"怎么算出来的" 只说"以 45 元为基准价",没写为什么是 45
参数是否有调参方法论 给出换场景后的调整方向 所有阈值都是定值,换个波动率怎么办

经验:每个"魔术数字"(2%、3:1、30%、3 次)都必须有推导或经验来源说明。

四、表述规范性(🟡 低严重度)

表述问题不影响内容正确性,但累积起来会让文章显得不专业。

检查项 方法 典型错误
术语是否全文统一 全局搜索每个术语的变体,统一为一个 "共享池"和"活跃策略共享池"交替出现
金额单位是否一致 确定主单位(大额用万元/小额用元),全文统一 同一案例中万元和元混用
缩写是否在首次出现时说明 首次全称 + "(以下简称XX)",后续只用简称 简称突然出现,读者不知道指什么

经验:术语统一用全文搜索解决(grep 每个候选词),单位统一用"确定主单位→全局替换"策略。

五、策略/系统的完整性(🔴 高严重度)

对于"设计类"文章,读者看完会问"那我怎么用?"——没回答这个问题就是缺口。

缺口类型 典型缺失 补充方式
标的/对象不明 说了一堆策略,没写选什么标的 添加"底仓标的选择建议"
方向覆盖不全 全多头策略,没提及做空/对冲 标注"本文范围限制",避免读者误以为万能
异常路径未覆盖 只说正常流程,没说失败怎么办 添加"假突破连续处理协议"
启动条件模糊 说"当前价格"启动,但当前价可能在高位/低位 补充基准价的客观确定规则
无量化验证 全是逻辑推导,没有数据支撑 标注"设计手记",列明回测待办

经验:写完用读者视角提问"我拿着这篇文章能直接执行吗?"——每一个答不上来的点就是一个缺口。

六、MkDocs Material 博客维护技巧

操作 方法 前提
置顶文章 Front matter 添加 pin: true MkDocs Material ≥ 9.7.0
多篇置顶排序 date 降序排列(最新的置顶文在最前) 自动处理
折叠长内容 使用 ??? question "标题" 语法创建可折叠块 适合补充说明类内容

修改工作流

对一篇技术长文做系统修改时的执行顺序:

┌─────────────────┐
│ 1. 全局搜索修正   │ → 术语统一、单位统一、全局替换错误值
└────────┬────────┘
┌─────────────────┐
│ 2. 计算校验       │ → 所有含数字的公式、表格、案例逐项验算
└────────┬────────┘
┌─────────────────┐
│ 3. 案例逻辑修复   │ → 补充缺失的推导链、解释矛盾、透明化计算
└────────┬────────┘
┌─────────────────┐
│ 4. 策略缺口补充   │ → 读者视角提问,补充启动条件/异常路径/边界说明
└────────┬────────┘
┌─────────────────┐
│ 5. 结论一致性     │ → 数据改了结论是否也要改?重读所有总结段落
└────────┬────────┘
┌─────────────────┐
│ 6. 前后交叉验证   │ → 前面提到的参数后面是否还在用?规则是否前后矛盾?
└─────────────────┘

注意事项

  • ✅ 优先修计算和数据错误——这些是硬伤,改了内容才可信
  • ✅ 第二个修逻辑断链——读者看不懂时最容易放弃
  • ✅ 策略完整性补充要克制——加太多会让文章臃肿,用 admonition 折叠收纳
  • ⚠️ 不要边改边写新的长段落——先修完原始问题,再决定是否扩写
  • ⚠️ 结论段落最容易遗留旧数据——修改数据后必须全文搜索旧数值

延伸阅读


维护人:yiiewang · 最后更新:2026-07-08

评论