先给结论:产品文档改版后,旧文章里真正需要优先更新的不是所有提到该产品的句子,而是那些把旧文档当作操作依据的引用——包括旧版界面路径、旧字段名、旧参数默认值、旧流程步骤编号,以及指向已删除或已改址文档的链接。判断标准只有一条:如果读者照着旧文章的引用去操作,会不会得到与新版文档不一致的结果。会,就必须更新;不会,可以暂缓。
拿你手上任意一篇旧文章,逐句扫描与产品文档相关的内容,按下面四类归档。这个分类动作本身就是后续排期的依据。
四类里,前两类必须优先处理,因为它们直接导致读者操作失败;第三类影响信任,第四类成本最低。
一个常见的误判是:新版文档改动很大,所以旧文章全都要重写。实际上取舍标准应该反过来——看旧文章的引用是否还能让读者独立完成目标。
假设一篇旧文写的是“在A页面配置B参数即可完成接入”,而新版文档把这个参数拆成了两个,并且默认值不同。此时旧文虽然只涉及一句话,但读者照做会失败,必须改。反过来,新版只是把文档标题从“快速开始”改成“入门指南”,旧文正文没引用标题,那就不需要动。
可执行动作:给每篇文章标注一个状态——引用失效、引用存疑、引用仍有效。只有前两种进入更新队列。这个动作的结果决定了你下一步是改正文还是只改链接,避免把时间花在无差别重写上。
如果你只有三五篇旧文章,人工逐句核对完全可行。但当旧文章数量上升到几十上百篇,同样的方法会出现两个例外。
例外一:同一句引用在不同文章里的上下文不同。比如“点击导出”这句话,在一篇讲数据备份的文章里是关键步骤,在另一篇讲报表分享的文章里只是顺带一提。规模化处理时不能按句子批量替换,必须回到文章目标判断该引用是否承载核心操作。
例外二:部分旧文章本身已经过时,与本次文档改版无关。如果一篇旧文讨论的功能已经下线,那么更新它的引用没有意义,正确动作是标记为待废弃或重定向,而不是修补。
这两个例外说明:小样本下“逐句核对”的结论不能直接放大成“全部逐句核对”。规模化时需要先按文章目标分层,再决定核对粒度。
很多人会先跑一遍链接检查,把返回异常的链接全部替换。这个动作有价值,但不能单独决定哪些引用需要更新。
链接返回异常,可能的解释至少有三种:文档确实迁移了;服务器临时波动;检查工具被目标站点限制。反过来,链接返回正常也不代表引用有效——文档地址没变,但页面里的操作步骤已经改了,这种情况链接检查完全发现不了。
所以正确顺序是:先做内容层面的引用分类,再做链接可达性检查,两者交叉后才形成更新清单。只做链接检查就动手替换,会漏掉最需要改的那部分。
把前面的判断落成一张清单,每行包含:文章地址、引用类型、当前状态、需要执行的动作、动作完成后的验证方式。
验证方式建议用同一条路径:改完后,让一个不了解背景的人只按旧文章操作一次,看是否能在新版文档环境下完成目标。这个动作的结果直接告诉你该段是否可以关闭,而不是靠感觉判断改完了。
把这套流程固定下来,下次文档再改版时,你只需要重新跑一遍分类和交叉检查,就能得到一份有优先级的更新清单,而不是面对几百篇旧文章无从下手。