产品文档改版后,旧文章里真正需要更新的引用,不是所有提到旧版本文档的句子,而是那些让读者点进去后无法完成原动作的链接——路径变了、术语换了、截图过期、参数表被拆到了新页面。判断标准只有一条:读者按旧文章里的引用继续操作,会不会卡住。会卡住的必须改,只是读起来“有点旧”但动作仍能完成的,可以排进后续批次。
不要一页一页通读全文再决定改什么,那样效率低且容易漏。打开你手上的旧文章,只找这四种引用,分别标出来:
拆完你会发现问题分布很不均匀:链接和术语往往占大多数,截图和参数值数量少但破坏力最大。这个分布决定了后面的处理顺序。
链接要分两种结果来处理,两者需要的动作不同。
跳转失败是最好判断的:点开是404或重定向到首页。这类链接必须换成新文档里的对应页面。如果新文档结构里已经没有等价页面,说明该功能可能被合并或下线,此时不能随便链到首页了事,而应改写那句话,让它不再依赖一个具体页面。
跳转后内容错位更隐蔽:链接能打开,但页面讲的是别的东西。常见于文档把长页面拆成多页后,旧锚点还在,指向的位置却偏了。处理动作是逐个点开旧文章里的链接,确认落地页标题和旧文章那句话说的是同一件事。不是同一件事的,换链接或改句子。
这里有一个实际取舍:如果旧文章数量多,可以先用站点爬取工具跑一遍站内链接,把404和重定向的挑出来优先处理;能打开但内容错位的只能人工判断,工具帮不上。跑完链接检查后,你会得到一份确定要改的清单,它比“感觉哪篇该更新”可靠得多,也直接决定你下一步是集中改链接还是先处理术语。
文档改版经常把功能名从A改成B。旧文章里的A不一定都要改成B,要看读者搜的是哪个词。
如果A是用户仍在使用的旧叫法,而文档只在新版里用B,那么旧文章保留A、在首次出现处补一句“现称B”往往比全篇替换更稳,因为搜索旧叫法的读者仍能找到你。反过来,如果A已经被彻底弃用、文档里不再出现,那旧文章继续用A只会让读者对不上号,应改为B。
判断依据是文档自身:查改版说明或版本记录里有没有列出改名对照。没有对照表时,用文档站内搜索分别搜A和B,看哪个还有结果、哪个已经搜不到。这个动作的结果直接决定你是做批量替换还是做逐处补充说明,两者的工作量和风险完全不同。
截图和参数值是旧文章里最容易被低估的部分。文档改版后界面变了,旧截图里的按钮位置、菜单名称都可能对不上,读者照着点会找不到入口。
处理截图有三个可选动作,按成本从低到高:删掉截图只留文字步骤、用新界面重截、在截图下方加一行说明指出差异。选择依据是这张截图承担多少信息——如果文字步骤本身已经说清楚,删图最省事;如果步骤离开图就讲不明白,只能重截。
参数值要单独核对。文档改版常把默认值、上限、配置项挪到新的参数表页面。旧文章里写死的数字如果和新文档不一致,必须改;如果一致但来源页面变了,链接要跟着换。这里要提醒一句:不要因为某篇文章的引用检查归零,就认为整批文章都没问题,链接全通、术语全对,仍可能截图过期或参数值已经变了,这几类要分开查。
假设你手上有一篇讲配置流程的旧文章,里面有一个指向旧版配置页的链接、三处旧功能名、两张旧界面截图、一处默认值。文档改版后,配置页路径变了,功能名从“策略组”改成“规则集”,截图里多了新字段,默认值从10变成20。
按读者卡住点排序:链接跳转失败会让读者第一步就走不下去,优先级最高;默认值写错会让读者配出错误结果,优先级次高;功能名对不上会让读者困惑但通常还能猜,排第三;截图过期影响最小,因为文字步骤还在。
对应的动作顺序是:先换链接,再核对默认值,然后处理功能名的改法,最后决定截图是删是换。这个顺序不是固定规则,但它说明一件事——优先级来自“读者在哪一步会停”,而不是来自引用出现在文章开头还是结尾。
把这套判断落到你手上的旧文章后,你会得到一份按类型和优先级排好的修改清单。下一步不是马上动笔改,而是先确认新文档里那些目标页面确实存在且内容对应,否则改完的链接可能再次失效,白做一轮。