产品文档改版后,旧文章里的引用不是一律要改,也不是一律可以留。真正需要更新的是那些“引用内容已经失效、但读者仍会按旧内容行动”的位置;如果旧引用只是指向一个仍然稳定的概念或入口,保留反而比强行改写更省事。判断顺序建议是:先确认旧引用是否仍能完成它原来的任务,再决定保留、改写还是退出。
同样是“参考文档”四个字,背后的任务可能完全不同。有的引用是让读者完成一个操作,有的引用只是解释一个术语,还有的引用是给读者一个继续阅读的方向。改版后,前两类最容易出问题,第三类往往可以观察一段时间再处理。
可以用一个简单动作来区分:把旧文章里的每条引用单独摘出来,问一句“读者点进去或照着做,能不能得到和写这句话时相同的结果”。如果答案是否定的,这条引用就需要进入更新清单;如果答案仍然是肯定的,先保留,不必因为文档界面变了就重写。
适用条件:旧文章数量不多、引用位置集中,适合逐条判断。如果旧文章有几百篇,逐条判断的成本过高,可以先用“引用目标是否发生结构性变化”做第一轮筛选。
保留不等于偷懒。保留成立的前提是,引用所指向的概念、参数含义或阅读路径没有发生实质变化。例如,某个术语的定义没有变,只是承载它的文档换了排版;或者某个参数名没变,只是所在章节从“配置”移到了“参考”。这种情况下,旧引用仍然能完成解释任务,读者不会因为改版而做出错误操作。
但要注意一种常见遗漏:旧引用本身没变,可是它周围的正文已经过时。比如文章说“详见某文档的参数说明”,文档确实还在,但参数默认值已经改了。这时需要更新的不是引用文字,而是引用前后那句结论。判断方法是把引用和它前后各一句话一起读,看结论是否仍然成立。
实际动作:在旧文章里标记那些“引用目标稳定、但上下文结论可能过时”的位置,先不改链接,先核对结论。核对结果会直接影响下一步:结论仍成立就保留,结论不成立就改写上下文,而不是改引用。
改版后更常见的情况是,文档还在,但读者已经不能按旧路径找到它。比如原来引用的是某个独立页面,现在内容被合并进一个更长的章节;或者原来指向的是操作步骤,现在步骤被拆成了前置条件和主流程两段。这时保留旧引用会让读者多绕一步,改写比保留更合适。
改写时不必追求把新结构完整描述一遍,只需要让读者知道“从哪里开始、下一步做什么”。如果旧引用写的是“参见某文档”,可以改成“先确认前置条件,再按主流程操作”,并指向新的起始位置。这样改的结果是,读者不需要自己判断旧入口是否还有效,下一步动作更明确。
适用条件:引用目标的内容没有消失,只是位置或组织方式变了。如果内容本身已经被删除或替换,就进入退出判断,而不是改写。
有些旧引用需要直接退出,不是改成新链接,而是删掉或替换成自包含的说明。典型情况是:原来引用的文档已经不再维护,或者它描述的行为和当前产品不一致,读者照着做会得到错误结果。这时继续保留一个“看起来还能点”的引用,比没有引用更危险。
退出时有一个容易忽略的条件:如果旧文章本身仍然被读者需要,不能只删引用,还要补上读者原本从引用里获得的信息。否则读者会卡在同一个位置,只是从“点错地方”变成“没有下一步”。
假设例子:某篇旧文章说“具体限制见某文档”,该文档改版后不再列出限制,而是把限制放进了另一个配置页。此时旧引用既不能保留,也不适合简单改写,因为读者需要的是限制值本身。更稳妥的做法是,在旧文章里直接写出限制的适用条件,再指向配置页作为延伸阅读。这个例子的数字和页面名称都是假设,用来说明判断方法,不代表任何真实产品的现状。
不必一次改完所有旧文章。可以先选一组引用密度最高的旧文章,按“保留、改写、退出”三类各处理几条,然后观察读者是否还会在同一个位置反复提问或绕路。如果某类引用处理之后,读者仍然找不到下一步,说明判断条件需要调整,而不是继续批量套用。
这里有一个边界:引用点击量下降或某条路径访问归零,不能单独证明处理正确。它也可能是读者本来就不需要那条引用、入口被其他页面替代,或者统计口径发生了变化。把这类现象和读者提问、操作结果放在一起看,才能判断旧引用是应该继续保留,还是进入下一轮改写或退出。
最终要落到的动作很简单:把旧文章里的引用按任务分类,先处理那些会让读者做错操作的引用,再处理只是绕路的引用,最后处理仍然稳定的引用。这个顺序会让改版后的旧文章逐步恢复可用,而不是一次性重写全部内容。