产品文档改版后,旧文章里最该优先更新的不是正文观点,而是所有指向被合并、被拆分或已改名的文档引用。判断标准只有一条:读者点过去之后,能不能在两步内找到原本想看的答案。如果找不到,这个引用就必须改。
定位型引用指的是读者需要跳转过去才能完成下一步操作的内容,比如“详见某功能配置说明”“按某文档的第三步设置”。解释型引用则是用来补充背景、帮助理解的延伸阅读。文档改版后,这两类引用的处理方式完全不同。
先做这个分类,能避免把大量解释型引用当成必须马上改的负担,也能防止漏掉真正影响操作的定位型引用。
如果旧文章本身还在承担“教人怎么做”的职责,那它里面的每一个操作步骤引用都要重新核对。具体动作是:打开旧文章,逐条点开它引用的文档,记录三件事——目标页面是否还能打开、标题是否还对得上、正文里提到的步骤编号是否还成立。
做完这一步,结果会直接影响下一步:如果三条里有一条不成立,就把这条引用改成新的文档标题和路径;如果三条都不成立,说明这段内容整体已经过期,应该考虑重写这一段,而不是只换一个链接。
这里有一个假设例子:某篇旧文章写“在设置页找到通知选项,详见配置文档第 2 节”。改版后配置文档把通知选项挪到了“消息与提醒”章节。此时只改链接不够,因为读者按旧文章的描述去找“设置页”,仍然会迷路。正确做法是把旧文章里那句操作描述也改成新的入口名称,再指向新章节。
如果旧文章的主要作用是解释概念、补充背景,读者并不需要跟着它操作,那引用更新可以排优先级,而不是一次全改。判断优先级看两点:这个引用是否出现在文章靠前的位置,以及它是否被多个旧文章反复引用。
具体动作是:先列出所有被引用的文档,标出哪些引用出现在三篇以上旧文章里。这些高频引用优先改,因为改一处能减少多处误导。低频、靠后的解释型引用可以放进下一轮处理。
例外情况是:如果目标文档被彻底删除,且没有替代页面,那就不能只改链接,而要在旧文章里补一句简短说明,告诉读者这个内容已经并入哪里,或者建议他们改看哪一类主题。不要留一个打不开的链接让读者自己猜。
更新引用不是改完链接就结束。至少要做一次点击测试:从旧文章出发,点进每一个被改过的引用,确认落点页面里能直接看到旧文章承诺的内容。如果落点页面还需要读者再搜索一次或再点两层,说明这次更新没有真正解决问题。
测试结果会告诉你下一步该做什么:落点准确,就继续处理下一批;落点仍然绕路,就回到旧文章里把引导文字写得更具体,比如直接写出目标章节的标题,而不是只写“详见文档”。
最后要提醒的是,引用更新和正文观点更新是两件事。引用改对了,不代表旧文章里的判断、截图和步骤描述还有效。如果文档改版同时改变了操作流程,那旧文章的相关段落也需要一并检查,否则读者会看到一个能打开的页面,却按旧步骤操作失败。