产品文档改版后,旧文章里最该优先处理的不是所有链接,而是那些引用已失效字段、旧版操作路径和已改变定义的内容。判断标准只有一条:读者照着旧引用操作,会不会得到与新版不一致的结果。会,就必须改;不会,可以延后。
把旧文章里的引用逐条列出来,按性质分成三类,处理优先级完全不同。
很多编辑一看到改版就全部重写,结果把本来还成立的解释也改坏了。先分类,能省掉大半无效工作。
分类之后,对每条结构性引用做一次验证动作:按旧文章描述的操作路径,在新版文档里走一遍。
假设旧文章写的是“在发布设置里勾选允许评论,再填写展示位置”。改版后这个勾选项被移到了“互动权限”分组下,名称也变成了“开放讨论”。那么旧引用失效,必须更新文字和截图说明。
反过来,如果旧文章只是说“发布前确认评论功能已开启”,没有指明具体位置,改版后这句话依然成立,就不需要动。
这个动作的结果会直接影响下一步:验证通过的引用留在原地,验证失败的引用进入待改清单,措辞模糊、无法验证的引用单独标记,等有明确依据再处理。
产品文档改版常伴随页面拆分或合并。旧文章之间的互链,即使还能跳转,也可能跳到了不再对应的段落。
检查时不要只测“链接是否 404”,还要看落点内容是否仍是读者预期的那部分。如果旧文章 A 引用旧文章 B 的“字段说明”一节,而改版后这一节被拆到了新页面,那么即使 B 的地址没变,A 里的锚点或描述也可能指向错误位置。
处理顺序建议是:先修结构性引用,再修互链落点,最后处理示例性引用。原因是前两类直接影响读者能否完成操作,示例性引用影响的是理解体验,优先级相对靠后。
不是所有旧引用都需要在改版后立刻更新。满足以下条件的,可以延后:
延后不等于忽略。建议在旧文章里加一条简短的版本提示,告诉读者“本文部分操作描述基于旧版,最新字段说明请以产品文档为准”。这句话本身不需要精确到某个日期,但能避免读者按旧路径操作后产生困惑。
改版后的引用更新,最容易出问题的地方是改了一半、没有记录。建议每处理一条引用,就在清单里记三样:原引用位置、判断结论、处理动作。
判断结论只有三种:保留、更新、待定。处理动作对应写清楚是改了文字、换了链接,还是加了版本提示。这样下次文档再改版时,你能直接看出哪些引用是上次动过的,不必从头再查一遍。
如果旧文章数量多,优先处理被其他文章引用最多的那几篇。它们的影响面更大,先修这几篇,能减少读者在站内反复遇到同一处失效引用的概率。至于哪些文章被引用最多,可以靠站内搜索或人工抽查确认,不需要依赖某个具体工具的统计数字。